Bouncy Castle PKIX, CMS, EAC, TSP, PKCS, OCSP, CMP, and CRMF APIs 1.77 · org.bouncycastle.cms.RecipientInformation

Modifier and Type	Field and Description
private AuthAttributesProvider	additionalData
protected AlgorithmIdentifier	keyEncAlg
protected AlgorithmIdentifier	messageAlgorithm
private RecipientOperator	operator
private byte[]	resultMac
protected RecipientId	rid
protected CMSSecureReadable	secureReadable

Access	Constructor and Description
pack-priv	RecipientInformation(AlgorithmIdentifier keyEncAlg, AlgorithmIdentifier messageAlgorithm, CMSSecureReadable secureReadable, AuthAttributesProvider additionalData)

Method Summary

Modifier and Type	Method and Description
private byte[]	encodeObj(ASN1Encodable obj)
public byte[]	Returns: the content inside the EnvelopedData this RecipientInformation is associated with. getContent(Recipient recipient object to use to recover content encryption key recipient) Return the decrypted/encapsulated content in the EnvelopedData after recovering the content encryption/MAC key using the passed in Recipient.
public byte[]	Returns: byte array containing the digest. getContentDigest() Return the content digest calculated during the read of the content if one has been generated.
public CMSTypedStream	Returns: the content inside the EnvelopedData this RecipientInformation is associated with. getContentStream(Recipient recipient object to use to recover content encryption key recipient) Return a CMSTypedStream representing the content in the EnvelopedData after recovering the content encryption/MAC key using the passed in Recipient.
public ASN1ObjectIdentifier	Returns: the content type OID. getContentType() Return the content type of the encapsulated data accessed by this recipient.
public String	Returns: OID for key encryption algorithm. getKeyEncryptionAlgOID() return the object identifier for the key encryption algorithm.
public AlgorithmIdentifier	Returns: AlgorithmIdentifier representing the key encryption algorithm. getKeyEncryptionAlgorithm() Return the key encryption algorithm details for the key in this recipient.
public byte[]	Returns: ASN.1 encoding of key encryption algorithm parameters. getKeyEncryptionAlgParams() return the ASN.1 encoded key encryption algorithm parameters, or null if there aren't any.
public byte[]	Returns: byte array containing the mac. getMac() Return the MAC calculated for the recipient.
protected abstract RecipientOperator	getRecipientOperator(Recipient recipient)
public RecipientId	getRID()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

additionalData	back to summary
private AuthAttributesProvider additionalData

keyEncAlg	back to summary
protected AlgorithmIdentifier keyEncAlg

messageAlgorithm	back to summary
protected AlgorithmIdentifier messageAlgorithm

operator	back to summary
private RecipientOperator operator

resultMac	back to summary
private byte[] resultMac

rid	back to summary
protected RecipientId rid

secureReadable	back to summary
protected CMSSecureReadable secureReadable

RecipientInformation	back to summary
pack-priv RecipientInformation(AlgorithmIdentifier keyEncAlg, AlgorithmIdentifier messageAlgorithm, CMSSecureReadable secureReadable, AuthAttributesProvider additionalData)

Method Detail

encodeObj	back to summary
private byte[] encodeObj(ASN1Encodable obj) throws IOException

getContent	back to summary
public byte[] getContent(Recipient recipient) throws CMSException Return the decrypted/encapsulated content in the EnvelopedData after recovering the content encryption/MAC key using the passed in Recipient. Parameters recipient:Recipient recipient object to use to recover content encryption key Returns:byte[] the content inside the EnvelopedData this RecipientInformation is associated with. Exceptions CMSException: if the content-encryption/MAC key cannot be recovered.

getContent

back to summary

public byte[] getContent(Recipient recipient) throws CMSException

Return the decrypted/encapsulated content in the EnvelopedData after recovering the content encryption/MAC key using the passed in Recipient.

Parameters

recipient:Recipient: recipient object to use to recover content encryption key

Returns:byte[]

the content inside the EnvelopedData this RecipientInformation is associated with.

Exceptions

CMSException:: if the content-encryption/MAC key cannot be recovered.

getContentDigest	back to summary
public byte[] getContentDigest() Return the content digest calculated during the read of the content if one has been generated. This will only happen if we are dealing with authenticated data and authenticated attributes are present. Returns:byte[] byte array containing the digest.

getContentDigest

back to summary

public byte[] getContentDigest()

Return the content digest calculated during the read of the content if one has been generated. This will only happen if we are dealing with authenticated data and authenticated attributes are present.

Returns:byte[]: byte array containing the digest.

getContentStream	back to summary
public CMSTypedStream getContentStream(Recipient recipient) throws CMSException, IOException Return a CMSTypedStream representing the content in the EnvelopedData after recovering the content encryption/MAC key using the passed in Recipient. Parameters recipient:Recipient recipient object to use to recover content encryption key Returns:CMSTypedStream the content inside the EnvelopedData this RecipientInformation is associated with. Exceptions CMSException: if the content-encryption/MAC key cannot be recovered.

getContentStream

back to summary

public CMSTypedStream getContentStream(Recipient recipient) throws CMSException, IOException

Return a CMSTypedStream representing the content in the EnvelopedData after recovering the content encryption/MAC key using the passed in Recipient.

Parameters

recipient:Recipient: recipient object to use to recover content encryption key

Returns:CMSTypedStream

the content inside the EnvelopedData this RecipientInformation is associated with.

Exceptions

CMSException:: if the content-encryption/MAC key cannot be recovered.

getContentType	back to summary
public ASN1ObjectIdentifier getContentType() Return the content type of the encapsulated data accessed by this recipient. Returns:ASN1ObjectIdentifier the content type OID.

getContentType

back to summary

public ASN1ObjectIdentifier getContentType()

Return the content type of the encapsulated data accessed by this recipient.

Returns:ASN1ObjectIdentifier: the content type OID.

getKeyEncryptionAlgOID	back to summary
public String getKeyEncryptionAlgOID() return the object identifier for the key encryption algorithm. Returns:String OID for key encryption algorithm.

getKeyEncryptionAlgOID

back to summary

public String getKeyEncryptionAlgOID()

return the object identifier for the key encryption algorithm.

Returns:String: OID for key encryption algorithm.

getKeyEncryptionAlgorithm	back to summary
public AlgorithmIdentifier getKeyEncryptionAlgorithm() Return the key encryption algorithm details for the key in this recipient. Returns:AlgorithmIdentifier AlgorithmIdentifier representing the key encryption algorithm.

getKeyEncryptionAlgorithm

back to summary

public AlgorithmIdentifier getKeyEncryptionAlgorithm()

Return the key encryption algorithm details for the key in this recipient.

Returns:AlgorithmIdentifier: AlgorithmIdentifier representing the key encryption algorithm.

getKeyEncryptionAlgParams	back to summary
public byte[] getKeyEncryptionAlgParams() return the ASN.1 encoded key encryption algorithm parameters, or null if there aren't any. Returns:byte[] ASN.1 encoding of key encryption algorithm parameters.

getKeyEncryptionAlgParams

back to summary

public byte[] getKeyEncryptionAlgParams()

return the ASN.1 encoded key encryption algorithm parameters, or null if there aren't any.

Returns:byte[]: ASN.1 encoding of key encryption algorithm parameters.

getMac	back to summary
public byte[] getMac() Return the MAC calculated for the recipient. Note this call is only meaningful once all the content has been read. Returns:byte[] byte array containing the mac.

getMac

back to summary

public byte[] getMac()

Return the MAC calculated for the recipient.

Note

this call is only meaningful once all the content has been read.

Returns:byte[]: byte array containing the mac.

getRecipientOperator	back to summary
protected abstract RecipientOperator getRecipientOperator(Recipient recipient) throws CMSException, IOException

getRID	back to summary
public RecipientId getRID()

public abstract Class RecipientInformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail