com.entrust.toolkit.asn1.crmf.regCtrl

Class ProtocolEncrKey

java.lang.Object

com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

com.entrust.toolkit.asn1.crmf.regCtrl.ProtocolEncrKey

All Implemented Interfaces:

ASN1Type

public class ProtocolEncrKey
extends AttributeTypeAndValue
implements ASN1Type

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

 id-regCtrl-protocolEncrKey    OBJECT IDENTIFIER ::= { id-regCtrl 6 }
 --with syntax:

 ProtocolEncrKey ::= SubjectPublicKeyInfo

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

If present, the protocolEncrKey regCtrl specifies a key the CA is to use in encrypting a response to CertReqMessages. This regCtrl can be used when a CA has information to send to the subscriber that needs to be encrypted. Such information includes a private key generated by the CA for use by the subscriber.

Since:

7.0

Field Summary

Fields

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

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

m_type, m_value

Constructor Summary

Constructors

Constructor and Description
ProtocolEncrKey(ASN1Object obj) Creates a new ProtocolEncrKey regCtrl object from an ASN1Object.
ProtocolEncrKey(java.security.PublicKey protocolEncrKey) Creates a new ProtocolEncrKey regCtrl object with the specified component.

Method Summary

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an ProtocolEncrKey regCtrl structure from an ASN1Object.
java.security.PublicKey	getProtocolEncrKey() Returns the protocol encryption key.
ASN1Object	toASN1Object() Encodes this ProtocolEncrKey regCtrl object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this ProtocolEncrKey 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 ProtocolEncrKey regCtrl.

Constructor Detail

ProtocolEncrKey

public ProtocolEncrKey(java.security.PublicKey protocolEncrKey)

Creates a new ProtocolEncrKey regCtrl object with the specified component.

Parameters:

protocolEncrKey - the protocol encryption key

ProtocolEncrKey

public ProtocolEncrKey(ASN1Object obj)
                throws CodingException

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

Parameters:

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

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getProtocolEncrKey

public java.security.PublicKey getProtocolEncrKey()

Returns the protocol encryption key.

Returns:

the protocolEncrKey component

decode

public void decode(ASN1Object obj)
            throws CodingException

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

Specified by:

decode in interface ASN1Type

Overrides:

decode in class AttributeTypeAndValue

Parameters:

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

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

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

Overrides:

toString in class AttributeTypeAndValue

Returns:

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