com.entrust.toolkit.asn1.crmf.regCtrl

Class RegToken

java.lang.Object

com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

com.entrust.toolkit.asn1.crmf.regCtrl.RegToken

All Implemented Interfaces:

ASN1Type

public class RegToken
extends AttributeTypeAndValue
implements ASN1Type

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

 id-regCtrl-regToken OBJECT IDENTIFIER ::= { id-regCtrl 1 }
 --with syntax:

 RegToken ::= UTF8String

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

A regToken regCtrl contains one-time information (either based on a secret value or on knowledge) intended to be used by the CA to verify the identity of the subject prior to issuing a certificate. Upon receipt of a certification request containing a value for regToken, the receiving CA verifies the information in order to confirm the identity claimed in the certification request.

The value for regToken may be generated by the CA and provided out of band to the subscriber, or may otherwise be available to both the CA and the subscriber. The security of any out-of-band exchange should be commensurate with the risk of the CA accepting an intercepted value from someone other than the intended subscriber.

The regToken regCtrl would typically be used only for initialization of an end entity into the PKI, whereas the authenticator regCtrl (see Authenticator) would typically be used for initial as well as subsequent certification requests.

In some instances of use the value for regToken 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 regToken SHALL be UTF8.

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectID	oid The object identifier for a RegToken regCtrl.

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

m_type, m_value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an RegToken regCtrl structure from an ASN1Object.
java.lang.String	getRegToken() Returns the registration token.
ASN1Object	toASN1Object() Encodes this RegToken regCtrl object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this RegToken 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 a RegToken regCtrl.

Constructor Detail

RegToken

public RegToken(java.lang.String regToken)

Creates a new RegToken regCtrl object with the specified component.

Parameters:

regToken - the registration value

RegToken

public RegToken(ASN1Object obj)
         throws CodingException

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

Parameters:

obj - the ASN.1 representation of a RegToken regCtrl structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getRegToken

public java.lang.String getRegToken()

Returns the registration token.

Returns:

the regToken component

decode

public void decode(ASN1Object obj)
            throws CodingException

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

Specified by:

decode in interface ASN1Type

Overrides:

decode in class AttributeTypeAndValue

Parameters:

obj - an ASN.1 representation of a RegToken regCtrl structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this RegToken regCtrl object as an ASN1Object. The encoding produces a complete ASN.1 AttributeTypeAndValue structure, not simply an ASN.1 RegToken structure. To retrieve only the RegToken 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 RegToken regCtrl object.

Overrides:

toString in class AttributeTypeAndValue

Returns:

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