Top Description Fields Constructors Methods
org.conscrypt

public final Class OpenSSLECDHKeyAgreement

extends KeyAgreementSpi
Class Inheritance
Annotations
@Internal
Imports
java.security.InvalidAlgorithmParameterException, .InvalidKeyException, .Key, .PrivateKey, .PublicKey, .SecureRandom, java.security.spec.AlgorithmParameterSpec, javax.crypto.KeyAgreementSpi, .SecretKey, .ShortBufferException, javax.crypto.spec.SecretKeySpec
Elliptic Curve Diffie-Hellman key agreement backed by the OpenSSL engine.

Field Summary

Modifier and TypeField and Description
private int
mExpectedResultLength

Expected length (in bytes) of the agreed key (mResult).

private OpenSSLKey
mOpenSslPrivateKey

OpenSSL handle of the private key.

private byte[]
mResult

Agreed key.

Constructor Summary

AccessConstructor and Description
public
OpenSSLECDHKeyAgreement()

Method Summary

Modifier and TypeMethod and Description
private void
checkCompleted()

public 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 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 byte[]
engineGenerateSecret()

Implements abstract javax.crypto.KeyAgreementSpi.engineGenerateSecret.

Generates the shared secret and returns it in a new buffer.
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.

Field Detail

mExpectedResultLengthback to summary
private int mExpectedResultLength

Expected length (in bytes) of the agreed key (mResult). Only available after the engine has been initialized.

mOpenSslPrivateKeyback to summary
private OpenSSLKey mOpenSslPrivateKey

OpenSSL handle of the private key. Only available after the engine has been initialized.

mResultback to summary
private byte[] mResult

Agreed key. Only available after engineDoPhase(Key, boolean) completes.

Constructor Detail

OpenSSLECDHKeyAgreementback to summary
public OpenSSLECDHKeyAgreement()

Method Detail

checkCompletedback to summary
private void checkCompleted()
engineDoPhaseback to summary
public Key engineDoPhase(Key key, boolean lastPhase) throws InvalidKeyException

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

Annotations
@Override
Exceptions
InvalidKeyException:
if the given key is inappropriate for this phase.
engineGenerateSecretback to summary
protected int engineGenerateSecret(byte[] sharedSecret, int offset) throws 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

Annotations
@Override
Exceptions
ShortBufferException:
if the given output buffer is too small to hold the secret
engineGenerateSecretback to summary
protected byte[] engineGenerateSecret()

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

Annotations
@Override
engineGenerateSecretback to summary
protected SecretKey engineGenerateSecret(String algorithm)

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

Annotations
@Override
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

Annotations
@Override
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.
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

Annotations
@Override
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.