Top Description Fields Constructors Methods
org.bouncycastle.jcajce.provider

pack-priv Class BaseAgreement

extends KeyAgreementSpi
Class Inheritance
Imports
java.math.BigInteger, java.security.InvalidAlgorithmParameterException, .InvalidKeyException, .Key, .NoSuchAlgorithmException, .PrivateKey, .PublicKey, .SecureRandom, java.security.interfaces.ECPrivateKey, java.security.spec.AlgorithmParameterSpec, java.util.HashMap, .Map, javax.crypto.KeyAgreementSpi, .SecretKey, .ShortBufferException, javax.crypto.spec.SecretKeySpec, org.bouncycastle.asn1.ASN1ObjectIdentifier, org.bouncycastle.asn1.cryptopro.CryptoProObjectIdentifiers, org.bouncycastle.asn1.gnu.GNUObjectIdentifiers, org.bouncycastle.asn1.kisa.KISAObjectIdentifiers, org.bouncycastle.asn1.misc.MiscObjectIdentifiers, org.bouncycastle.asn1.nist.NISTObjectIdentifiers, org.bouncycastle.asn1.ntt.NTTObjectIdentifiers, org.bouncycastle.asn1.oiw.OIWObjectIdentifiers, org.bouncycastle.asn1.pkcs.PKCSObjectIdentifiers, org.bouncycastle.crypto.Agreement, .AgreementFactory, .Algorithm, .AsymmetricPrivateKey, .AsymmetricPublicKey, .IllegalKeyException, .KDFCalculator, .KDFOperatorFactory, .Parameters, org.bouncycastle.crypto.asymmetric.AsymmetricDHKey, .AsymmetricDHPublicKey, org.bouncycastle.crypto.fips.FipsDH, .FipsKDF, .FipsUnapprovedOperationError, org.bouncycastle.jcajce.AgreedKeyWithMacKey, org.bouncycastle.jcajce.spec.DHUParameterSpec, .MQVParameterSpec, .UserKeyingMaterialSpec, org.bouncycastle.util.Arrays, .Strings
Diffie-Hellman key agreement using elliptic curve keys, ala IEEE P1363 both the simple one, and the simple one with cofactors are supported. Also, MQV key agreement per SEC-1

Field Summary

Modifier and TypeField and Description
protected Agreement<T extends Parameters>
agreement

private final AgreementFactory<T extends Parameters>
agreementFactory

private static final Map<String, ASN1ObjectIdentifier>
defaultOids

private final FipsKDF.AgreementKDFParametersBuilder
kdfAlgorithm

private final KDFOperatorFactory<T extends Parameters>
kdfOperatorFactory

private static final KeyIvSizeProvider
keySizeProvider

private static final Map<String, String>
nameTable

private Parameters
parameters

private final ParametersCreator<T extends Parameters>
parametersCreator

private final PrivateKeyConverter<T extends AsymmetricPrivateKey>
privateKeyConverter

private final PublicKeyConverter<T extends AsymmetricPublicKey>
publicKeyConverter

protected byte[]
result

private byte[]
userKeyingMaterial

Constructor Summary

AccessConstructor and Description
protected
BaseAgreement(AgreementFactory<T extends Parameters> agreementFactory, PublicKeyConverter<T extends AsymmetricPublicKey> publicKeyConverter, PrivateKeyConverter<T extends AsymmetricPrivateKey> privateKeyConverter, ParametersCreator<T extends Parameters> parametersCreator)

protected
BaseAgreement(AgreementFactory<T extends Parameters> agreementFactory, PublicKeyConverter<T extends AsymmetricPublicKey> publicKeyConverter, PrivateKeyConverter<T extends AsymmetricPrivateKey> privateKeyConverter, ParametersCreator<T extends Parameters> parametersCreator, FipsKDF.AgreementKDFParametersBuilder kdfAlgorithm)

Method Summary

Modifier and TypeMethod and Description
private byte[]
calculateAgreement(AsymmetricPublicKey pubKey)

protected Key
engineDoPhase(Key
the key for this phase. For example, in the case of Diffie-Hellman between 2 parties, this would be the other party's Diffie-Hellman public key.
key, boolean
flag which indicates whether this is the last phase of this key agreement.
lastPhase)

Implements abstract javax.crypto.KeyAgreementSpi.engineDoPhase.

Executes the next phase of this key agreement with the given key that was received from one of the other parties involved in this key agreement.
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, 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 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.
private static String
getAlgorithm(String algDetails)

private static int
getKeySize(String algDetails)

private static String
getSimpleName(Class<?> clazz)

private void
initFromKey(Key key, AlgorithmParameterSpec params, SecureRandom random)

private static byte[]
trimZeroes(byte[] secret)

Field Detail

agreementback to summary
protected Agreement<T extends Parameters> agreement
agreementFactoryback to summary
private final AgreementFactory<T extends Parameters> agreementFactory
defaultOidsback to summary
private static final Map<String, ASN1ObjectIdentifier> defaultOids
kdfAlgorithmback to summary
private final FipsKDF.AgreementKDFParametersBuilder kdfAlgorithm
kdfOperatorFactoryback to summary
private final KDFOperatorFactory<T extends Parameters> kdfOperatorFactory
keySizeProviderback to summary
private static final KeyIvSizeProvider keySizeProvider
nameTableback to summary
private static final Map<String, String> nameTable
parametersback to summary
private Parameters parameters
parametersCreatorback to summary
private final ParametersCreator<T extends Parameters> parametersCreator
privateKeyConverterback to summary
private final PrivateKeyConverter<T extends AsymmetricPrivateKey> privateKeyConverter
publicKeyConverterback to summary
private final PublicKeyConverter<T extends AsymmetricPublicKey> publicKeyConverter
resultback to summary
protected byte[] result
userKeyingMaterialback to summary
private byte[] userKeyingMaterial

Constructor Detail

BaseAgreementback to summary
protected BaseAgreement(AgreementFactory<T extends Parameters> agreementFactory, PublicKeyConverter<T extends AsymmetricPublicKey> publicKeyConverter, PrivateKeyConverter<T extends AsymmetricPrivateKey> privateKeyConverter, ParametersCreator<T extends Parameters> parametersCreator)
BaseAgreementback to summary
protected BaseAgreement(AgreementFactory<T extends Parameters> agreementFactory, PublicKeyConverter<T extends AsymmetricPublicKey> publicKeyConverter, PrivateKeyConverter<T extends AsymmetricPrivateKey> privateKeyConverter, ParametersCreator<T extends Parameters> parametersCreator, FipsKDF.AgreementKDFParametersBuilder kdfAlgorithm)

Method Detail

calculateAgreementback to summary
private byte[] calculateAgreement(AsymmetricPublicKey pubKey) throws InvalidKeyException
engineDoPhaseback to summary
protected Key engineDoPhase(Key key, boolean lastPhase) throws InvalidKeyException, IllegalStateException

Implements abstract javax.crypto.KeyAgreementSpi.engineDoPhase.

Doc from javax.crypto.KeyAgreementSpi.engineDoPhase.

Executes the next phase of this key agreement with the given key that was received from one of the other parties involved in this key agreement.

Parameters
key:Key

the key for this phase. For example, in the case of Diffie-Hellman between 2 parties, this would be the other party's Diffie-Hellman public key.

lastPhase:boolean

flag which indicates whether this is the last phase of this key agreement.

Returns:Key

the (intermediate) key resulting from this phase, or null if this phase does not yield a key

Exceptions
InvalidKeyException:
if the given key is inappropriate for this phase.
IllegalStateException:
if this key agreement has not been initialized.
engineGenerateSecretback 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
engineGenerateSecretback 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
engineGenerateSecretback 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
engineInitback 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.
engineInitback 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.
getAlgorithmback to summary
private static String getAlgorithm(String algDetails)
getKeySizeback to summary
private static int getKeySize(String algDetails)
getSimpleNameback to summary
private static String getSimpleName(Class<?> clazz)
initFromKeyback to summary
private void initFromKey(Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException
trimZeroesback to summary
private static byte[] trimZeroes(byte[] secret)