public class

PKIHeader

extends ASN1Encodable
java.lang.Object
   ↳ org.bouncycastle.asn1.ASN1Encodable
     ↳ org.bouncycastle.asn1.cmp.PKIHeader

Summary

Constants
int CMP_1999
int CMP_2000
[Expand]
Inherited Constants
From class org.bouncycastle.asn1.ASN1Encodable
Fields
public static final GeneralName NULL_NAME Value for a "null" recipient or sender.
Public Constructors
PKIHeader(int pvno, GeneralName sender, GeneralName recipient)
Public Methods
PKIFreeText getFreeText()
InfoTypeAndValue[] getGeneralInfo()
static PKIHeader getInstance(Object o)
DERGeneralizedTime getMessageTime()
AlgorithmIdentifier getProtectionAlg()
DERInteger getPvno()
ASN1OctetString getRecipKID()
ASN1OctetString getRecipNonce()
GeneralName getRecipient()
GeneralName getSender()
ASN1OctetString getSenderKID()
ASN1OctetString getSenderNonce()
ASN1OctetString getTransactionID()
DERObject toASN1Object()
  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)
 }
 
[Expand]
Inherited Methods
From class org.bouncycastle.asn1.ASN1Encodable
From class java.lang.Object
From interface org.bouncycastle.asn1.DEREncodable

Constants

public static final int CMP_1999

Constant Value: 1 (0x00000001)

public static final int CMP_2000

Constant Value: 2 (0x00000002)

Fields

public static final GeneralName NULL_NAME

Value for a "null" recipient or sender.

Public Constructors

public PKIHeader (int pvno, GeneralName sender, GeneralName recipient)

Public Methods

public PKIFreeText getFreeText ()

public InfoTypeAndValue[] getGeneralInfo ()

public static PKIHeader getInstance (Object o)

public DERGeneralizedTime getMessageTime ()

public AlgorithmIdentifier getProtectionAlg ()

public DERInteger getPvno ()

public ASN1OctetString getRecipKID ()

public ASN1OctetString getRecipNonce ()

public GeneralName getRecipient ()

public GeneralName getSender ()

public ASN1OctetString getSenderKID ()

public ASN1OctetString getSenderNonce ()

public ASN1OctetString getTransactionID ()

public DERObject toASN1Object ()

  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)
 }
 

Returns
  • a basic ASN.1 object representation.