org.bouncycastle.asn1.cmp

Class PKIHeader

java.lang.Object

org.bouncycastle.asn1.ASN1Object

org.bouncycastle.asn1.cmp.PKIHeader

All Implemented Interfaces:

org.bouncycastle.asn1.ASN1Encodable, org.bouncycastle.util.Encodable

public class PKIHeader
extends org.bouncycastle.asn1.ASN1Object

PKIHeader ::= SEQUENCE { pvno INTEGER { cmp1999(1), cmp2000(2) }, sender GeneralName, -- identifies the sender recipient GeneralName, -- identifies the intended recipient messageTime [0] GeneralizedTime OPTIONAL, -- time of production of this message (used when sender -- believes that the transport will be "suitable"; i.e., -- that the time will still be meaningful upon receipt) protectionAlg [1] AlgorithmIdentifier OPTIONAL, -- algorithm used for calculation of protection bits senderKID [2] KeyIdentifier OPTIONAL, recipKID [3] KeyIdentifier OPTIONAL, -- to identify specific keys used for protection transactionID [4] OCTET STRING OPTIONAL, -- identifies the transaction; i.e., this will be the same in -- corresponding request, response, certConf, and PKIConf -- messages senderNonce [5] OCTET STRING OPTIONAL, recipNonce [6] OCTET STRING OPTIONAL, -- nonces used to provide replay protection, senderNonce -- is inserted by the creator of this message; recipNonce -- is a nonce previously inserted in a related message by -- the intended recipient of this message freeText [7] PKIFreeText OPTIONAL, -- this may be used to indicate context-specific instructions -- (this field is intended for human consumption) generalInfo [8] SEQUENCE SIZE (1..MAX) OF InfoTypeAndValue OPTIONAL -- this may be used to convey context-specific information -- (this field not primarily intended for human consumption) }

Field Summary

Fields

Modifier and Type	Field and Description
static int	CMP_1999
static int	CMP_2000
static int	CMP_2021
static org.bouncycastle.asn1.x509.GeneralName	NULL_NAME Value for a "null" recipient or sender.

Constructor Summary

Constructors

Constructor and Description
PKIHeader(int pvno, org.bouncycastle.asn1.x509.GeneralName sender, org.bouncycastle.asn1.x509.GeneralName recipient)

Method Summary

Modifier and Type	Method and Description
PKIFreeText	getFreeText()
InfoTypeAndValue[]	getGeneralInfo()
static PKIHeader	getInstance(java.lang.Object o)
org.bouncycastle.asn1.ASN1GeneralizedTime	getMessageTime()
org.bouncycastle.asn1.x509.AlgorithmIdentifier	getProtectionAlg()
org.bouncycastle.asn1.ASN1Integer	getPvno()
org.bouncycastle.asn1.x509.GeneralName	getRecipient()
org.bouncycastle.asn1.ASN1OctetString	getRecipKID()
org.bouncycastle.asn1.ASN1OctetString	getRecipNonce()
org.bouncycastle.asn1.x509.GeneralName	getSender()
org.bouncycastle.asn1.ASN1OctetString	getSenderKID()
org.bouncycastle.asn1.ASN1OctetString	getSenderNonce()
org.bouncycastle.asn1.ASN1OctetString	getTransactionID()
org.bouncycastle.asn1.ASN1Primitive	toASN1Primitive() PKIHeader ::= SEQUENCE { pvno INTEGER { cmp1999(1), cmp2000(2) }, sender GeneralName, -- identifies the sender recipient GeneralName, -- identifies the intended recipient messageTime [0] GeneralizedTime OPTIONAL, -- time of production of this message (used when sender -- believes that the transport will be "suitable"; i.e., -- that the time will still be meaningful upon receipt) protectionAlg [1] AlgorithmIdentifier OPTIONAL, -- algorithm used for calculation of protection bits senderKID [2] KeyIdentifier OPTIONAL, recipKID [3] KeyIdentifier OPTIONAL, -- to identify specific keys used for protection transactionID [4] OCTET STRING OPTIONAL, -- identifies the transaction; i.e., this will be the same in -- corresponding request, response, certConf, and PKIConf -- messages senderNonce [5] OCTET STRING OPTIONAL, recipNonce [6] OCTET STRING OPTIONAL, -- nonces used to provide replay protection, senderNonce -- is inserted by the creator of this message; recipNonce -- is a nonce previously inserted in a related message by -- the intended recipient of this message freeText [7] PKIFreeText OPTIONAL, -- this may be used to indicate context-specific instructions -- (this field is intended for human consumption) generalInfo [8] SEQUENCE SIZE (1..MAX) OF InfoTypeAndValue OPTIONAL -- this may be used to convey context-specific information -- (this field not primarily intended for human consumption) }

Methods inherited from class org.bouncycastle.asn1.ASN1Object

encodeTo, encodeTo, equals, getEncoded, getEncoded, hasEncodedTagValue, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL_NAME

public static final org.bouncycastle.asn1.x509.GeneralName NULL_NAME

Value for a "null" recipient or sender.

CMP_1999

public static final int CMP_1999

See Also:

Constant Field Values

CMP_2000

public static final int CMP_2000

See Also:

Constant Field Values

CMP_2021

public static final int CMP_2021

See Also:

Constant Field Values

Constructor Detail

PKIHeader

public PKIHeader(int pvno,
                 org.bouncycastle.asn1.x509.GeneralName sender,
                 org.bouncycastle.asn1.x509.GeneralName recipient)

Method Detail

getInstance

public static PKIHeader getInstance(java.lang.Object o)

getPvno

public org.bouncycastle.asn1.ASN1Integer getPvno()

getSender

public org.bouncycastle.asn1.x509.GeneralName getSender()

getRecipient

public org.bouncycastle.asn1.x509.GeneralName getRecipient()

getMessageTime

public org.bouncycastle.asn1.ASN1GeneralizedTime getMessageTime()

getProtectionAlg

public org.bouncycastle.asn1.x509.AlgorithmIdentifier getProtectionAlg()

getSenderKID

public org.bouncycastle.asn1.ASN1OctetString getSenderKID()

getRecipKID

public org.bouncycastle.asn1.ASN1OctetString getRecipKID()

getTransactionID

public org.bouncycastle.asn1.ASN1OctetString getTransactionID()

getSenderNonce

public org.bouncycastle.asn1.ASN1OctetString getSenderNonce()

getRecipNonce

public org.bouncycastle.asn1.ASN1OctetString getRecipNonce()

getFreeText

public PKIFreeText getFreeText()

getGeneralInfo

public InfoTypeAndValue[] getGeneralInfo()

toASN1Primitive

public org.bouncycastle.asn1.ASN1Primitive toASN1Primitive()

  PKIHeader ::= SEQUENCE {
            pvno                INTEGER     { cmp1999(1), cmp2000(2) },
            sender              GeneralName,
            -- identifies the sender
            recipient           GeneralName,
            -- identifies the intended recipient
            messageTime     [0] GeneralizedTime         OPTIONAL,
            -- time of production of this message (used when sender
            -- believes that the transport will be "suitable"; i.e.,
            -- that the time will still be meaningful upon receipt)
            protectionAlg   [1] AlgorithmIdentifier     OPTIONAL,
            -- algorithm used for calculation of protection bits
            senderKID       [2] KeyIdentifier           OPTIONAL,
            recipKID        [3] KeyIdentifier           OPTIONAL,
            -- to identify specific keys used for protection
            transactionID   [4] OCTET STRING            OPTIONAL,
            -- identifies the transaction; i.e., this will be the same in
            -- corresponding request, response, certConf, and PKIConf
            -- messages
            senderNonce     [5] OCTET STRING            OPTIONAL,
            recipNonce      [6] OCTET STRING            OPTIONAL,
            -- nonces used to provide replay protection, senderNonce
            -- is inserted by the creator of this message; recipNonce
            -- is a nonce previously inserted in a related message by
            -- the intended recipient of this message
            freeText        [7] PKIFreeText             OPTIONAL,
            -- this may be used to indicate context-specific instructions
            -- (this field is intended for human consumption)
            generalInfo     [8] SEQUENCE SIZE (1..MAX) OF
                                 InfoTypeAndValue     OPTIONAL
            -- this may be used to convey context-specific information
            -- (this field not primarily intended for human consumption)
 }
 

Specified by:

toASN1Primitive in interface org.bouncycastle.asn1.ASN1Encodable

Specified by:

toASN1Primitive in class org.bouncycastle.asn1.ASN1Object

Returns:

a basic ASN.1 object representation.