com.entrust.toolkit.asn1.crmf.regCtrl

Class Authenticator

java.lang.Object

com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

com.entrust.toolkit.asn1.crmf.regCtrl.Authenticator

All Implemented Interfaces:

ASN1Type

public class Authenticator
extends AttributeTypeAndValue
implements ASN1Type

This class implements the ASN.1 structure for the Authenticator regCtrl as defined in the CRMF specification. Authenticator is a regCtrl, which exists as the AttributeTypeAndValue structure.

 id-regCtrl-authenticator OBJECT IDENTIFIER ::= { id-regCtrl 2 }
 --with syntax:

 Authenticator ::= UTF8String

 AttributeTypeAndValue ::= SEQUENCE {
     type         OBJECT IDENTIFIER,
     value        ANY DEFINED BY type
 }
 

An authenticator regCtrl contains information used in an ongoing basis to establish a non-cryptographic check of identity in communication with the CA. Examples include: mother's maiden name, last four digits of social security number, or other knowledge-based information shared with the subscriber's CA; a hash of such information; or other information produced for this purpose. The value for an authenticator regCtrl may be generated by the subscriber or by the CA.

In some instances of use the value for authenticator could be a text string or a numeric quantity such as a random number. The value in the latter case could be encoded either as a binary quantity or as a text string representation of the binary quantity. To ensure a uniform encoding of values regardless of the nature of the quantity, the encoding of authenticator SHALL be UTF8.

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectID	oid The object identifier for an Authenticator regCtrl.

Fields inherited from class com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

m_type, m_value

Constructor Summary

Constructors

Constructor and Description
Authenticator(ASN1Object obj) Creates a new Authenticator regCtrl object from an ASN1Object.
Authenticator(java.lang.String authenticator) Creates a new Authenticator regCtrl object with the specified component.

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an Authenticator regCtrl structure from an ASN1Object.
java.lang.String	getAuthenticator() Returns the authenticator.
ASN1Object	toASN1Object() Encodes this Authenticator regCtrl object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this Authenticator regCtrl object.

Methods inherited from class com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

getType, getValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

oid

public static final ObjectID oid

The object identifier for an Authenticator regCtrl.

Constructor Detail

Authenticator

public Authenticator(java.lang.String authenticator)

Creates a new Authenticator regCtrl object with the specified component.

Parameters:

authenticator - the authentication value

Authenticator

public Authenticator(ASN1Object obj)
              throws CodingException

Creates a new Authenticator regCtrl object from an ASN1Object. The ASN1Object must be a complete ASN.1 AttributeTypeAndValue structure, not simply an ASN.1 Authenticator structure.

Parameters:

obj - the ASN.1 representation of an Authenticator regCtrl structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getAuthenticator

public java.lang.String getAuthenticator()

Returns the authenticator.

Returns:

the authenticator component

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an Authenticator regCtrl structure from an ASN1Object. The ASN1Object must be a complete ASN.1 AttributeTypeAndValue structure, not simply an ASN.1 Authenticator structure.

Specified by:

decode in interface ASN1Type

Overrides:

decode in class AttributeTypeAndValue

Parameters:

obj - an ASN.1 representation of an Authenticator regCtrl structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this Authenticator regCtrl object as an ASN1Object. The encoding produces a complete ASN.1 AttributeTypeAndValue structure, not simply an ASN.1 Authenticator structure. To retrieve only the Authenticator structure use getValue().

Specified by:

toASN1Object in interface ASN1Type

Overrides:

toASN1Object in class AttributeTypeAndValue

Returns:

an ASN.1 representation of this object

toString

public java.lang.String toString()

Creates a text representation of the ASN.1 structure of this Authenticator regCtrl object.

Overrides:

toString in class AttributeTypeAndValue

Returns:

a text representation of the ASN.1 structure of this object