Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.jcajce.provider.asymmetric.util.BaseAgreementSpi

Modifier and Type	Field and Description
private static final Map<String, ASN1ObjectIdentifier>	defaultOids
private static final Hashtable<K, V>	des
private HybridValueParameterSpec	hybridSpec
protected final String	kaAlgorithm
protected final DerivationFunction	kdf
private static final Map<String, Integer>	keySizes
private static final Map<String, String>	nameTable
private static final Hashtable<K, V>	oids
protected byte[]	ukmParameters
protected byte[]	ukmParametersSalt

Access	Constructor and Description
public	BaseAgreementSpi(String kaAlgorithm, DerivationFunction kdf)

Method Summary

Modifier and Type	Method and Description
private byte[]	calcSecret()
protected abstract byte[]	doCalcSecret()
protected abstract void	doInitFromKey(Key key, AlgorithmParameterSpec parameterSpec, SecureRandom random)
protected byte[]	engineGenerateSecret() Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret. Generates the shared secret and returns it in a new buffer.
protected int	engineGenerateSecret(byte[] the buffer for the shared secret sharedSecret, int the offset in `sharedSecret` where the shared secret will be stored offset) Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret. Generates the shared secret, and places it into the buffer `sharedSecret`, beginning at `offset` inclusive.
protected SecretKey	engineGenerateSecret(String the requested secret key algorithm algorithm) Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret. Creates the shared secret and returns it as a secret key object of the requested algorithm type.
protected void	engineInit(Key the party's private information. For example, in the case of the Diffie-Hellman key agreement, this would be the party's own Diffie-Hellman private key. key, SecureRandom the source of randomness random) Implements abstract javax.crypto.KeyAgreementSpi.engineInit. Initializes this key agreement with the given key and source of randomness.
protected void	engineInit(Key the party's private information. For example, in the case of the Diffie-Hellman key agreement, this would be the party's own Diffie-Hellman private key. key, AlgorithmParameterSpec the key agreement parameters params, SecureRandom the source of randomness random) Implements abstract javax.crypto.KeyAgreementSpi.engineInit. Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.
protected static String	getAlgorithm(String algDetails)
protected static int	getKeySize(String algDetails)
private byte[]	getSharedSecretBytes(byte[] secret, String oidAlgorithm, int keySize)
protected static byte[]	trimZeroes(byte[] secret)

Inherited from javax.crypto.KeyAgreementSpi:: engineDoPhase

defaultOids	back to summary
private static final Map<String, ASN1ObjectIdentifier> defaultOids

des	back to summary
private static final Hashtable<K, V> des

hybridSpec	back to summary
private HybridValueParameterSpec hybridSpec

kaAlgorithm	back to summary
protected final String kaAlgorithm

kdf	back to summary
protected final DerivationFunction kdf

keySizes	back to summary
private static final Map<String, Integer> keySizes

nameTable	back to summary
private static final Map<String, String> nameTable

oids	back to summary
private static final Hashtable<K, V> oids

ukmParameters	back to summary
protected byte[] ukmParameters

ukmParametersSalt	back to summary
protected byte[] ukmParametersSalt

BaseAgreementSpi	back to summary
public BaseAgreementSpi(String kaAlgorithm, DerivationFunction kdf)

Method Detail

calcSecret	back to summary
private byte[] calcSecret()

doCalcSecret	back to summary
protected abstract byte[] doCalcSecret()

doInitFromKey	back to summary
protected abstract void doInitFromKey(Key key, AlgorithmParameterSpec parameterSpec, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

engineGenerateSecret back to summary

engineGenerateSecret	back to summary
protected byte[] engineGenerateSecret() throws IllegalStateException Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret. Doc from javax.crypto.KeyAgreementSpi.engineGenerateSecret. Generates the shared secret and returns it in a new buffer. This method resets this `KeyAgreementSpi` object to the state that it was in after the most recent call to one of the `init` methods. After a call to `generateSecret`, the object can be reused for further key agreement operations by calling `doPhase` to supply new keys, and then calling `generateSecret` to produce a new secret. In this case, the private information and algorithm parameters supplied to `init` will be used for multiple key agreement operations. The `init` method can be called after `generateSecret` to change the private information used in subsequent operations. Returns:byte[] the new buffer with the shared secret Exceptions IllegalStateException: if this key agreement has not been initialized or if `doPhase` has not been called to supply the keys for all parties in the agreement

protected byte[] engineGenerateSecret() throws IllegalStateException

Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret.

Doc from javax.crypto.KeyAgreementSpi.engineGenerateSecret.

Generates the shared secret and returns it in a new buffer.

This method resets this KeyAgreementSpi object to the state that it was in after the most recent call to one of the init methods. After a call to generateSecret, the object can be reused for further key agreement operations by calling doPhase to supply new keys, and then calling generateSecret to produce a new secret. In this case, the private information and algorithm parameters supplied to init will be used for multiple key agreement operations. The init method can be called after generateSecret to change the private information used in subsequent operations.

Returns:byte[]

the new buffer with the shared secret

Exceptions

IllegalStateException:: if this key agreement has not been initialized or if doPhase has not been called to supply the keys for all parties in the agreement

engineGenerateSecret back to summary

engineGenerateSecret	back to summary
protected int engineGenerateSecret(byte[] sharedSecret, int offset) throws IllegalStateException, ShortBufferException Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret. Doc from javax.crypto.KeyAgreementSpi.engineGenerateSecret. Generates the shared secret, and places it into the buffer `sharedSecret`, beginning at `offset` inclusive. If the `sharedSecret` buffer is too small to hold the result, a `ShortBufferException` is thrown. In this case, this call should be repeated with a larger output buffer. This method resets this `KeyAgreementSpi` object to the state that it was in after the most recent call to one of the `init` methods. After a call to `generateSecret`, the object can be reused for further key agreement operations by calling `doPhase` to supply new keys, and then calling `generateSecret` to produce a new secret. In this case, the private information and algorithm parameters supplied to `init` will be used for multiple key agreement operations. The `init` method can be called after `generateSecret` to change the private information used in subsequent operations. Parameters sharedSecret:byte[] the buffer for the shared secret offset:int the offset in `sharedSecret` where the shared secret will be stored Returns:int the number of bytes placed into `sharedSecret` Exceptions IllegalStateException: if this key agreement has not been initialized or if `doPhase` has not been called to supply the keys for all parties in the agreement ShortBufferException: if the given output buffer is too small to hold the secret

protected int engineGenerateSecret(byte[] sharedSecret, int offset) throws IllegalStateException, ShortBufferException

Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret.

Doc from javax.crypto.KeyAgreementSpi.engineGenerateSecret.

Generates the shared secret, and places it into the buffer sharedSecret, beginning at offset inclusive.

If the sharedSecret buffer is too small to hold the result, a ShortBufferException is thrown. In this case, this call should be repeated with a larger output buffer.

Parameters

sharedSecret:byte[]: the buffer for the shared secret
offset:int: the offset in sharedSecret where the shared secret will be stored

Returns:int

the number of bytes placed into sharedSecret

Exceptions

IllegalStateException:: if this key agreement has not been initialized or if doPhase has not been called to supply the keys for all parties in the agreement
ShortBufferException:: if the given output buffer is too small to hold the secret

engineGenerateSecret back to summary

engineGenerateSecret	back to summary
protected SecretKey engineGenerateSecret(String algorithm) throws NoSuchAlgorithmException Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret. Doc from javax.crypto.KeyAgreementSpi.engineGenerateSecret. Creates the shared secret and returns it as a secret key object of the requested algorithm type. This method resets this `KeyAgreementSpi` object to the state that it was in after the most recent call to one of the `init` methods. After a call to `generateSecret`, the object can be reused for further key agreement operations by calling `doPhase` to supply new keys, and then calling `generateSecret` to produce a new secret. In this case, the private information and algorithm parameters supplied to `init` will be used for multiple key agreement operations. The `init` method can be called after `generateSecret` to change the private information used in subsequent operations. Parameters algorithm:String the requested secret key algorithm Returns:SecretKey the shared secret key Exceptions NoSuchAlgorithmException: if the requested secret key algorithm is not available

protected SecretKey engineGenerateSecret(String algorithm) throws NoSuchAlgorithmException

Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret.

Doc from javax.crypto.KeyAgreementSpi.engineGenerateSecret.

Creates the shared secret and returns it as a secret key object of the requested algorithm type.

Parameters

algorithm:String: the requested secret key algorithm

Returns:SecretKey

the shared secret key

Exceptions

NoSuchAlgorithmException:: if the requested secret key algorithm is not available

engineInit back to summary

engineInit	back to summary
protected void engineInit(Key key, SecureRandom random) throws InvalidKeyException Implements abstract javax.crypto.KeyAgreementSpi.engineInit. Doc from javax.crypto.KeyAgreementSpi.engineInit. Initializes this key agreement with the given key and source of randomness. The given key is required to contain all the algorithm parameters required for this key agreement. If the key agreement algorithm requires random bytes, it gets them from the given source of randomness, `random`. However, if the underlying algorithm implementation does not require any random bytes, `random` is ignored. Parameters key:Key the party's private information. For example, in the case of the Diffie-Hellman key agreement, this would be the party's own Diffie-Hellman private key. random:SecureRandom the source of randomness Exceptions InvalidKeyException: if the given key is inappropriate for this key agreement, e.g., is of the wrong type or has an incompatible algorithm type.

protected void engineInit(Key key, SecureRandom random) throws InvalidKeyException

Implements abstract javax.crypto.KeyAgreementSpi.engineInit.

Doc from javax.crypto.KeyAgreementSpi.engineInit.

Initializes this key agreement with the given key and source of randomness. The given key is required to contain all the algorithm parameters required for this key agreement.

If the key agreement algorithm requires random bytes, it gets them from the given source of randomness, random. However, if the underlying algorithm implementation does not require any random bytes, random is ignored.

Parameters

key:Key: the party's private information. For example, in the case of the Diffie-Hellman key agreement, this would be the party's own Diffie-Hellman private key.
random:SecureRandom: the source of randomness

Exceptions

InvalidKeyException:: if the given key is inappropriate for this key agreement, e.g., is of the wrong type or has an incompatible algorithm type.

engineInit	back to summary
protected void engineInit(Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException Implements abstract javax.crypto.KeyAgreementSpi.engineInit. Doc from javax.crypto.KeyAgreementSpi.engineInit. Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness. Parameters key:Key the party's private information. For example, in the case of the Diffie-Hellman key agreement, this would be the party's own Diffie-Hellman private key. params:AlgorithmParameterSpec the key agreement parameters random:SecureRandom the source of randomness Exceptions InvalidKeyException: if the given key is inappropriate for this key agreement, e.g., is of the wrong type or has an incompatible algorithm type. InvalidAlgorithmParameterException: if the given parameters are inappropriate for this key agreement.

engineInit

back to summary

protected void engineInit(Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

Implements abstract javax.crypto.KeyAgreementSpi.engineInit.

Doc from javax.crypto.KeyAgreementSpi.engineInit.

Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.

Parameters

key:Key: the party's private information. For example, in the case of the Diffie-Hellman key agreement, this would be the party's own Diffie-Hellman private key.
params:AlgorithmParameterSpec: the key agreement parameters
random:SecureRandom: the source of randomness

Exceptions

InvalidKeyException:: if the given key is inappropriate for this key agreement, e.g., is of the wrong type or has an incompatible algorithm type.
InvalidAlgorithmParameterException:: if the given parameters are inappropriate for this key agreement.

getAlgorithm	back to summary
protected static String getAlgorithm(String algDetails)

getKeySize	back to summary
protected static int getKeySize(String algDetails)

getSharedSecretBytes	back to summary
private byte[] getSharedSecretBytes(byte[] secret, String oidAlgorithm, int keySize) throws NoSuchAlgorithmException

trimZeroes	back to summary
protected static byte[] trimZeroes(byte[] secret)

public abstract Class BaseAgreementSpi

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail