com.entrust.toolkit.archive

Class PemParsedHeader

java.lang.Object

com.entrust.toolkit.archive.PemParsedHeader

public class PemParsedHeader
extends java.lang.Object

This class represents the header read from a stream used for a PEM protected message. It does no cryptographic operations, it just parses the fields from the PEM header and makes them available to callers. There is no public constructor for this object. This object is created internally when reading a PEM stream, and can be retrieved by the method PemInputStream.getHeader().

Since:

7.0

Method Summary

Modifier and Type	Method and Description
PemOptions	getOptions() Returns the options used to protect the message.
X509Certificate	getOriginatorCertificate() Returns an object containing the encryption certificate of the message encryptor.
java.security.spec.AlgorithmParameterSpec	getParams() Returns the algorithm parameters.
java.util.Map	getRecipientKeyInfo() Returns a Map which contains (KeyIdentifier, EncryptedKey) pairs for all message recipients.
byte[]	getSignature() Returns the message digest of the original data.
X509Certificate	getVerificationCertificate() Returns an object containing the verification certificate of the message signer.

Methods inherited from class java.lang.Object

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

Method Detail

getOriginatorCertificate

public X509Certificate getOriginatorCertificate()

Returns an object containing the encryption certificate of the message encryptor.

Returns:

A certificate object containing the certificate of the person who encrypted the PEM message. Returns null if the message was not encrypted

getVerificationCertificate

public X509Certificate getVerificationCertificate()

Returns an object containing the verification certificate of the message signer.

Returns:

A copy of the verification certificate used by the signer of the PEM message. Returns null if the message was not signed.

getOptions

public PemOptions getOptions()

Returns the options used to protect the message.

Returns:

An object that can be used to query the options used to create the PEM message

getParams

public java.security.spec.AlgorithmParameterSpec getParams()

Returns the algorithm parameters.

Returns:

An AlgorithmParameterSpec containing the parameters used for the PEM message's symmetric encryption key. Returns null if the message was not encrypted.

getRecipientKeyInfo

public java.util.Map getRecipientKeyInfo()

Returns a Map which contains (KeyIdentifier, EncryptedKey) pairs for all message recipients.

Returns:

A Map which contains (KeyIdentifier, EncryptedKey) pairs for all message recipients. KeyIdentifier is a String containing the key identifier for the public key used to protect the symmetric key - the value of the "Recipient-ID-Asymmetric" field. EncryptedKey is a byte[] array containing symmetric key encrypted by the identified public key. It is the Base64 decoding of the value of the "Key-Info" field associated with the "Recipient-ID-Asymmetric field. Note that this map also includes a pair for the originator of the message, even though there is no explicit "Key-Info" and "Recipient-ID-Asymmetric" field associated with the originator.

getSignature

public byte[] getSignature()

Returns the message digest of the original data.

Returns:

A byte[] array containing the message digest of the original data.