com.entrust.toolkit.asn1.crmf

Class POPOPrivKey

java.lang.Object

com.entrust.toolkit.asn1.crmf.POPOPrivKey

All Implemented Interfaces:

ASN1Type

public class POPOPrivKey
extends java.lang.Object
implements ASN1Type

This class implements the POPOPrivKey structure as defined in the CRMF specification.

 POPOPrivKey ::= CHOICE {
     thisMessage       [0] IMPLICIT BIT STRING,
     -- posession is proven in this message (which contains the private
     -- key itself (encrypted for the CA))
     subsequentMessage [1] IMPLICIT SubsequentMessage,
     -- possession will be proven in a subsequent message
     dhMAC             [2] IMPLICIT BIT STRING }
     -- for keyAgreement (only), possession is proven in this message
     -- (which contains a MAC (over the DER-encoded value of the
     -- certReq parameter in CertReqMsg, which MUST include both subject
     -- and publicKey) based on a key derived from the end entity's
     -- private DH key and the CA's public DH key);
     -- the dhMAC value MUST be calculated as per the directions given
     -- in RFC 2511 Appendix A.
 }

 SubsequentMessage ::= INTEGER {
     encrCert (0),
     -- requests that resulting certificate be encrypted for the
     -- end entity (following which, POP will be proven in a
     -- confirmation message)
     challengeResp (1) }
     -- requests that CA engage in challenge-response exchange with
     -- end entity in order to prove private key possession
 }
 

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static byte	dhMAC POPOPrivKey type 'dhMAC'.
static byte	subsequentMessage POPOPrivKey type 'subsequentMessage'.
static java.lang.Integer	subsequentMessage_challengeResp SubsequentMessage value - challengeResp.
static java.lang.Integer	subsequentMessage_encrCert SubsequentMessage value - encrCert.
static byte	thisMessage POPOPrivKey type 'thisMessage'.
static java.lang.String[]	typeName Names of each POPOPrivKey type.

Constructor Summary

Constructors

Constructor and Description
POPOPrivKey(ASN1Object obj) Creates a POPOPrivKey object from an ASN1Object.
POPOPrivKey(int type, java.lang.Object value) Creates a new POPOPrivKey object with the specified type and value.

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes a POPOPrivKey structure from an ASN1Object.
int	getType() Returns the type of POPOPrivKey.
java.lang.Object	getValue() Returns the value of POPOPrivKey.
ASN1Object	toASN1Object() Encodes this POPOPrivKey as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this POPOPrivKey object.

Methods inherited from class java.lang.Object

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

Field Detail

thisMessage

public static final byte thisMessage

POPOPrivKey type 'thisMessage'.

See Also:

Constant Field Values

subsequentMessage

public static final byte subsequentMessage

POPOPrivKey type 'subsequentMessage'.

See Also:

Constant Field Values

dhMAC

public static final byte dhMAC

POPOPrivKey type 'dhMAC'.

See Also:

Constant Field Values

subsequentMessage_encrCert

public static final java.lang.Integer subsequentMessage_encrCert

SubsequentMessage value - encrCert. Requests that the resulting certificate be encrypted for the end entity (following which, POP will be proven in a confirmation message.

subsequentMessage_challengeResp

public static final java.lang.Integer subsequentMessage_challengeResp

SubsequentMessage value - challengeResp. Requests that the CA engage in challenge-response exchange with the end entity in order to prove private key possession.

typeName

public static final java.lang.String[] typeName

Names of each POPOPrivKey type.

Constructor Detail

POPOPrivKey

public POPOPrivKey(int type,
           java.lang.Object value)

Creates a new POPOPrivKey object with the specified type and value. Only the following combinations of type and value are supported:

• type = 0, value is a byte []
• type = 1, value is an Integer
• type = 2, value is a byte []

Parameters:

type - the type of POPOPrivKey

value - the value of POPOPrivKey

POPOPrivKey

public POPOPrivKey(ASN1Object obj)
            throws CodingException

Creates a POPOPrivKey object from an ASN1Object.

Parameters:

obj - the ASN.1 representation of a POPOPrivKey structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getType

public int getType()

Returns the type of POPOPrivKey.

Returns:

the type component

getValue

public java.lang.Object getValue()

Returns the value of POPOPrivKey. Only the following object-types can be returned based on the type of POPOPrivKey:

• type = 0, value is a byte []
• type = 1, value is an Integer
• type = 2, value is a byte []

The value is returned as an Object, which can then cast to the appropriate object-type based on the type of POPOPrivKey.

Returns:

the value component

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes a POPOPrivKey structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of a POPOPrivKey structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this POPOPrivKey as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

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 POPOPrivKey object.

Overrides:

toString in class java.lang.Object

Returns:

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