org.bouncycastle.operator.jcajce

Class JceAsymmetricKeyUnwrapper

java.lang.Object

org.bouncycastle.operator.AsymmetricKeyUnwrapper

org.bouncycastle.operator.jcajce.JceAsymmetricKeyUnwrapper

All Implemented Interfaces:

KeyUnwrapper

public class JceAsymmetricKeyUnwrapper
extends AsymmetricKeyUnwrapper

Constructor Summary

Constructors

Constructor and Description
JceAsymmetricKeyUnwrapper(AlgorithmIdentifier algorithmIdentifier, PrivateKey privKey)

Method Summary

Methods

Modifier and Type	Method and Description
GenericKey	generateUnwrappedKey(AlgorithmIdentifier encryptedKeyAlgorithm, byte[] encryptedKey)
JceAsymmetricKeyUnwrapper	setAlgorithmMapping(ASN1ObjectIdentifier algorithm, String algorithmName) Internally algorithm ids are converted into cipher names using a lookup table.
JceAsymmetricKeyUnwrapper	setMustProduceEncodableUnwrappedKey(boolean unwrappedKeyMustBeEncodable) Flag that unwrapping must produce a key that will return a meaningful value from a call to Key.getEncoded().
JceAsymmetricKeyUnwrapper	setProvider(Provider provider)
JceAsymmetricKeyUnwrapper	setProvider(String providerName)

Methods inherited from class org.bouncycastle.operator.AsymmetricKeyUnwrapper

getAlgorithmIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

JceAsymmetricKeyUnwrapper

public JceAsymmetricKeyUnwrapper(AlgorithmIdentifier algorithmIdentifier,
                         PrivateKey privKey)

Method Detail

setProvider

public JceAsymmetricKeyUnwrapper setProvider(Provider provider)

setProvider

public JceAsymmetricKeyUnwrapper setProvider(String providerName)

setMustProduceEncodableUnwrappedKey

public JceAsymmetricKeyUnwrapper 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 with the unwrapped key. Default value: false.

Parameters:

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

Returns:

this recipient.

setAlgorithmMapping

public JceAsymmetricKeyUnwrapper 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 - OID of algorithm in recipient.

algorithmName - JCE algorithm name to use.

Returns:

the current Unwrapper.

generateUnwrappedKey

public GenericKey generateUnwrappedKey(AlgorithmIdentifier encryptedKeyAlgorithm,
                              byte[] encryptedKey)
                                throws OperatorException

Throws:

OperatorException