com.entrust.toolkit.asn1.crmf

Class ProofOfPossession

java.lang.Object

com.entrust.toolkit.asn1.crmf.ProofOfPossession

All Implemented Interfaces:

ASN1Type

public class ProofOfPossession
extends java.lang.Object
implements ASN1Type

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

 ProofOfPossession ::= CHOICE {
     raVerified        [0] IMPLICIT NULL,
     -- used if the RA has already verified that the requester is in
     -- possession of the private key
     signature         [1] IMPLICIT POPOSigningKey,
     keyEncipherment   [2] POPOPrivKey,
     keyAgreement      [3] POPOPrivKey
 }
 

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static byte	keyAgreement ProofOfPossession type 'keyAgreement'.
static byte	keyEncipherment ProofOfPossession type 'keyEncipherment'.
static byte	raVerified ProofOfPossession type 'raVerified'.
static byte	signature ProofOfPossession type 'signature'.
static java.lang.String[]	typeName Names of each ProofOfPossession type.

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

raVerified

public static final byte raVerified

ProofOfPossession type 'raVerified'.

See Also:

Constant Field Values

signature

public static final byte signature

ProofOfPossession type 'signature'.

See Also:

Constant Field Values

keyEncipherment

public static final byte keyEncipherment

ProofOfPossession type 'keyEncipherment'.

See Also:

Constant Field Values

keyAgreement

public static final byte keyAgreement

ProofOfPossession type 'keyAgreement'.

See Also:

Constant Field Values

typeName

public static final java.lang.String[] typeName

Names of each ProofOfPossession type.

Constructor Detail

ProofOfPossession

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

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

• type = 0, value is null
• type = 1, value is a POPOSigningKey
• type = 2, value is a POPOPrivKey
• type = 3, value is a POPOPrivKey

Parameters:

type - the type of ProofOfPossession

value - the value of ProofOfPossession

ProofOfPossession

public ProofOfPossession(ASN1Object obj)
                  throws CodingException

Creates a ProofOfPossession object from an ASN1Object.

Parameters:

obj - the ASN.1 representation of a ProofOfPossession structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getType

public int getType()

Returns the type of ProofOfPossession.

Returns:

the type component

getValue

public java.lang.Object getValue()

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

• type = 0, value is null
• type = 1, value is a POPOSigningKey
• type = 2, value is a POPOPrivKey
• type = 3, value is a POPOPrivKey

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

Returns:

the value component

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes a ProofOfPossession structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of a ProofOfPossession structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this ProofOfPossession 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 ProofOfPossession object.

Overrides:

toString in class java.lang.Object

Returns:

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