OpenJDK 27 · sun.security.ec.ECDHKeyAgreement · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private ECPrivateKey	privateKey
private ECOperations	privateKeyOps
private ECPublicKey	publicKey
private int	secretLen

Access	Constructor and Description
public	ECDHKeyAgreement() Constructs a new ECDHKeyAgreement.

Method Summary

Modifier and Type	Method and Description
private static byte[]	deriveKeyImpl(ECPrivateKey priv, ECOperations ops, ECPublicKey pubKey)
protected Key	engineDoPhase(Key key, boolean 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[] sharedSecret, int 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 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 key, SecureRandom random) Implements abstract javax.crypto.KeyAgreementSpi.engineInit. Initializes this key agreement with the given key and source of randomness.
protected void	engineInit(Key key, AlgorithmParameterSpec params, SecureRandom random) Implements abstract javax.crypto.KeyAgreementSpi.engineInit. Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.
private void	init(Key key)
private static void	validate(ECOperations ops, ECPublicKey key)
private static void	validateCoordinate(BigInteger c, BigInteger mod)

privateKey	back to summary
private ECPrivateKey privateKey

privateKeyOps	back to summary
private ECOperations privateKeyOps

publicKey	back to summary
private ECPublicKey publicKey

secretLen	back to summary
private int secretLen

ECDHKeyAgreement	back to summary
public ECDHKeyAgreement() Constructs a new ECDHKeyAgreement.

Method Detail

deriveKeyImpl	back to summary
private static byte[] deriveKeyImpl(ECPrivateKey priv, ECOperations ops, ECPublicKey pubKey) throws InvalidKeyException

engineDoPhase	back 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. Annotations @Override Exceptions InvalidKeyException: if the given key is inappropriate for this phase. IllegalStateException: if this key agreement has not been initialized.

engineDoPhase

back 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.

Annotations

@Override

Exceptions

InvalidKeyException:: if the given key is inappropriate for this phase.
IllegalStateException:: if this key agreement has not been initialized.

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

Annotations

@Override

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

Annotations

@Override

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 IllegalStateException, NoSuchAlgorithmException, InvalidKeyException 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. Annotations @Override 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 NoSuchAlgorithmException: if the specified secret key algorithm is not supported InvalidKeyException: if the shared secret key material cannot be used to generate a secret key of the requested algorithm type (e.g., the key material is too short)

protected SecretKey engineGenerateSecret(String algorithm) throws IllegalStateException, NoSuchAlgorithmException, InvalidKeyException

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.

Annotations

@Override

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
NoSuchAlgorithmException:: if the specified secret key algorithm is not supported
InvalidKeyException:: if the shared secret key material cannot be used to generate a secret key of the requested algorithm type (e.g., the key material is too short)

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. 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.

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.

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.

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. 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.

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.

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.

init	back to summary
private void init(Key key) throws InvalidKeyException, InvalidAlgorithmParameterException

validate	back to summary
private static void validate(ECOperations ops, ECPublicKey key) throws InvalidKeyException

validateCoordinate	back to summary
private static void validateCoordinate(BigInteger c, BigInteger mod) throws InvalidKeyException

public final Class ECDHKeyAgreement

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail