Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.cms.jcajce.JceKEMRecipient

Modifier and Type	Field and Description
protected EnvelopedDataHelper	contentHelper
protected Map<K, V>	extraMappings
protected EnvelopedDataHelper	helper
private PrivateKey	recipientKey
protected boolean	unwrappedKeyMustBeEncodable
protected boolean	validateKeySize

Access	Constructor and Description
public	JceKEMRecipient(PrivateKey recipientKey)

Method Summary

Modifier and Type	Method and Description
protected Key	extractSecretKey(AlgorithmIdentifier keyEncryptionAlgorithm, AlgorithmIdentifier encryptedKeyAlgorithm, byte[] encryptedEncryptionKey)
public JceKEMRecipient	Returns: the current Recipient. setAlgorithmMapping(ASN1ObjectIdentifier OID of algorithm in recipient. algorithm, String JCE algorithm name to use. algorithmName) Internally algorithm ids are converted into cipher names using a lookup table.
public JceKEMRecipient	Returns: this recipient. setContentProvider(Provider the provider to use. provider) Set the provider to use for content processing.
public JceKEMRecipient	Returns: this recipient. setContentProvider(String the name of the provider to use. providerName) Set the provider to use for content processing.
public JceKEMRecipient	Returns: this recipient. setKeySizeValidation(boolean true if unwrapped key's should be validated against the content encryption algorithm, false otherwise. doValidate) Set validation of retrieved key sizes against the algorithm parameters for the encrypted key where possible - default is off.
public JceKEMRecipient	Returns: this recipient. setMustProduceEncodableUnwrappedKey(boolean true if getEncoded() should return key bytes, false if not necessary. unwrappedKeyMustBeEncodable) Flag that unwrapping must produce a key that will return a meaningful value from a call to Key.getEncoded().
public JceKEMRecipient	Returns: this recipient. setProvider(Provider provider to use. provider) Set the provider to use for key recovery and content processing.
public JceKEMRecipient	Returns: this recipient. setProvider(String the name of the provider to use. providerName) Set the provider to use for key recovery and content processing.

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

contentHelper	back to summary
protected EnvelopedDataHelper contentHelper

extraMappings	back to summary
protected Map<K, V> extraMappings

helper	back to summary
protected EnvelopedDataHelper helper

recipientKey	back to summary
private PrivateKey recipientKey

unwrappedKeyMustBeEncodable	back to summary
protected boolean unwrappedKeyMustBeEncodable

validateKeySize	back to summary
protected boolean validateKeySize

JceKEMRecipient	back to summary
public JceKEMRecipient(PrivateKey recipientKey)

Method Detail

extractSecretKey	back to summary
protected Key extractSecretKey(AlgorithmIdentifier keyEncryptionAlgorithm, AlgorithmIdentifier encryptedKeyAlgorithm, byte[] encryptedEncryptionKey) throws CMSException

setAlgorithmMapping	back to summary
public JceKEMRecipient setAlgorithmMapping(ASN1ObjectIdentifier algorithm, String algorithmName) Internally algorithm ids are converted into cipher names using a lookup table. For some providers the standard lookup table won't work. Use this method to establish a specific mapping from an algorithm identifier to a specific algorithm. For example: unwrapper.setAlgorithmMapping(PKCSObjectIdentifiers.rsaEncryption, "RSA"); Parameters algorithm:ASN1ObjectIdentifier OID of algorithm in recipient. algorithmName:String JCE algorithm name to use. Returns:JceKEMRecipient the current Recipient.

setAlgorithmMapping

back to summary

public JceKEMRecipient setAlgorithmMapping(ASN1ObjectIdentifier algorithm, String algorithmName)

Internally algorithm ids are converted into cipher names using a lookup table. For some providers the standard lookup table won't work. Use this method to establish a specific mapping from an algorithm identifier to a specific algorithm.

For example:

    unwrapper.setAlgorithmMapping(PKCSObjectIdentifiers.rsaEncryption, "RSA");

Parameters

algorithm:ASN1ObjectIdentifier: OID of algorithm in recipient.
algorithmName:String: JCE algorithm name to use.

Returns:JceKEMRecipient

the current Recipient.

setContentProvider	back to summary
public JceKEMRecipient setContentProvider(Provider provider) Set the provider to use for content processing. If providerName is null a "no provider" search will be used to satisfy getInstance calls. Parameters provider:Provider the provider to use. Returns:JceKEMRecipient this recipient.

setContentProvider

back to summary

public JceKEMRecipient setContentProvider(Provider provider)

Set the provider to use for content processing. If providerName is null a "no provider" search will be used to satisfy getInstance calls.

Parameters

provider:Provider: the provider to use.

Returns:JceKEMRecipient

this recipient.

setContentProvider	back to summary
public JceKEMRecipient setContentProvider(String providerName) Set the provider to use for content processing. If providerName is null a "no provider" search will be used to satisfy getInstance calls. Parameters providerName:String the name of the provider to use. Returns:JceKEMRecipient this recipient.

setContentProvider

back to summary

public JceKEMRecipient setContentProvider(String providerName)

Set the provider to use for content processing. If providerName is null a "no provider" search will be used to satisfy getInstance calls.

Parameters

providerName:String: the name of the provider to use.

Returns:JceKEMRecipient

this recipient.

setKeySizeValidation	back to summary
public JceKEMRecipient setKeySizeValidation(boolean doValidate) Set validation of retrieved key sizes against the algorithm parameters for the encrypted key where possible - default is off. This setting will not have any affect if the encryption algorithm in the recipient does not specify a particular key size, or if the unwrapper is a HSM and the byte encoding of the unwrapped secret key is not available. Parameters doValidate:boolean true if unwrapped key's should be validated against the content encryption algorithm, false otherwise. Returns:JceKEMRecipient this recipient.

setKeySizeValidation

back to summary

public JceKEMRecipient setKeySizeValidation(boolean doValidate)

Set validation of retrieved key sizes against the algorithm parameters for the encrypted key where possible - default is off.

This setting will not have any affect if the encryption algorithm in the recipient does not specify a particular key size, or if the unwrapper is a HSM and the byte encoding of the unwrapped secret key is not available.

Parameters

doValidate:boolean: true if unwrapped key's should be validated against the content encryption algorithm, false otherwise.

Returns:JceKEMRecipient

this recipient.

setMustProduceEncodableUnwrappedKey	back to summary
public JceKEMRecipient setMustProduceEncodableUnwrappedKey(boolean unwrappedKeyMustBeEncodable) Flag that unwrapping must produce a key that will return a meaningful value from a call to Key.getEncoded(). This is important if you are using a HSM for unwrapping and using a software based provider for decrypting the content. Default value: false. Parameters unwrappedKeyMustBeEncodable:boolean true if getEncoded() should return key bytes, false if not necessary. Returns:JceKEMRecipient this recipient.

setMustProduceEncodableUnwrappedKey

back to summary

public JceKEMRecipient setMustProduceEncodableUnwrappedKey(boolean unwrappedKeyMustBeEncodable)

Flag that unwrapping must produce a key that will return a meaningful value from a call to Key.getEncoded(). This is important if you are using a HSM for unwrapping and using a software based provider for decrypting the content. Default value: false.

Parameters

unwrappedKeyMustBeEncodable:boolean: true if getEncoded() should return key bytes, false if not necessary.

Returns:JceKEMRecipient

this recipient.

setProvider	back to summary
public JceKEMRecipient setProvider(Provider provider) Set the provider to use for key recovery and content processing. Parameters provider:Provider provider to use. Returns:JceKEMRecipient this recipient.

setProvider

back to summary

public JceKEMRecipient setProvider(Provider provider)

Set the provider to use for key recovery and content processing.

Parameters

provider:Provider: provider to use.

Returns:JceKEMRecipient

this recipient.

setProvider	back to summary
public JceKEMRecipient setProvider(String providerName) Set the provider to use for key recovery and content processing. Parameters providerName:String the name of the provider to use. Returns:JceKEMRecipient this recipient.

setProvider

back to summary

public JceKEMRecipient setProvider(String providerName)

Set the provider to use for key recovery and content processing.

Parameters

providerName:String: the name of the provider to use.

Returns:JceKEMRecipient

this recipient.

public abstract Class JceKEMRecipient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail