Class ECDHKeyAgreementHybrid
- java.lang.Object
-
- javax.crypto.KeyAgreementSpi
-
- com.ibm.crypto.ibmjcehybrid.provider.ECDHKeyAgreementHybrid
-
public final class ECDHKeyAgreementHybrid extends javax.crypto.KeyAgreementSpi
-
-
Constructor Summary
Constructors Constructor Description ECDHKeyAgreementHybrid()
Creates an instance of the ECKeyAgreementHybrid class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.security.Key
engineDoPhase(java.security.Key key, boolean lastPhase)
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()
Generates the shared secret and returns it in a new buffer.protected int
engineGenerateSecret(byte[] sharedSecret, int offset)
Generates the shared secret, and places it into the buffersharedSecret
, beginning atoffset
.protected javax.crypto.SecretKey
engineGenerateSecret(java.lang.String algorithm)
Creates the shared secret and returns it as a secret key object of the requested algorithm type.protected void
engineInit(java.security.Key key, java.security.SecureRandom random)
Initializes this key agreement with the given key and source of randomness.protected void
engineInit(java.security.Key key, java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random)
Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.
-
-
-
Method Detail
-
engineInit
protected void engineInit(java.security.Key key, java.security.SecureRandom random) throws java.security.InvalidKeyException
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.- Specified by:
engineInit
in classjavax.crypto.KeyAgreementSpi
- Parameters:
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
- the source of randomness- Throws:
java.security.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
protected void engineInit(java.security.Key key, java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random) throws java.security.InvalidKeyException, java.security.InvalidAlgorithmParameterException
Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.- Specified by:
engineInit
in classjavax.crypto.KeyAgreementSpi
- Parameters:
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
- the key agreement parametersrandom
- the source of randomness- Throws:
java.security.InvalidKeyException
- if the given key is inappropriate for this key agreement, e.g., is of the wrong type or has an incompatible algorithm type.java.security.InvalidAlgorithmParameterException
- if the given parameters are inappropriate for this key agreement.
-
engineDoPhase
protected java.security.Key engineDoPhase(java.security.Key key, boolean lastPhase) throws java.security.InvalidKeyException, java.lang.IllegalStateException
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.- Specified by:
engineDoPhase
in classjavax.crypto.KeyAgreementSpi
- Parameters:
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
- flag which indicates whether or not this is the last phase of this key agreement.- Returns:
- the (intermediate) key resulting from this phase, or null if this phase does not yield a key
- Throws:
java.security.InvalidKeyException
- if the given key is inappropriate for this phase.java.lang.IllegalStateException
- if this key agreement has not been initialized.
-
engineGenerateSecret
protected byte[] engineGenerateSecret() throws java.lang.IllegalStateException
Generates the shared secret and returns it in a new buffer.This method resets this
KeyAgreementSpi
object, so that it can be reused for further key agreements. Unless this key agreement is reinitialized with one of theengineInit
methods, the same private information and algorithm parameters will be used for subsequent key agreements.- Specified by:
engineGenerateSecret
in classjavax.crypto.KeyAgreementSpi
- Returns:
- the new buffer with the shared secret
- Throws:
java.lang.IllegalStateException
- if this key agreement has not been completed yet
-
engineGenerateSecret
protected int engineGenerateSecret(byte[] sharedSecret, int offset) throws java.lang.IllegalStateException, javax.crypto.ShortBufferException
Generates the shared secret, and places it into the buffersharedSecret
, beginning atoffset
.If the
sharedSecret
buffer is too small to hold the result, aShortBufferException
is thrown. In this case, this call should be repeated with a larger output buffer.This method resets this
KeyAgreementSpi
object, so that it can be reused for further key agreements. Unless this key agreement is reinitialized with one of theengineInit
methods, the same private information and algorithm parameters will be used for subsequent key agreements.- Specified by:
engineGenerateSecret
in classjavax.crypto.KeyAgreementSpi
- Parameters:
sharedSecret
- the buffer for the shared secretoffset
- the offset insharedSecret
where the shared secret will be stored- Returns:
- the number of bytes placed into
sharedSecret
- Throws:
java.lang.IllegalStateException
- if this key agreement has not been completed yetjavax.crypto.ShortBufferException
- if the given output buffer is too small to hold the secret
-
engineGenerateSecret
protected javax.crypto.SecretKey engineGenerateSecret(java.lang.String algorithm) throws java.lang.IllegalStateException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException
Creates the shared secret and returns it as a secret key object of the requested algorithm type.This method resets this
KeyAgreementSpi
object, so that it can be reused for further key agreements. Unless this key agreement is reinitialized with one of theengineInit
methods, the same private information and algorithm parameters will be used for subsequent key agreements.- Specified by:
engineGenerateSecret
in classjavax.crypto.KeyAgreementSpi
- Parameters:
algorithm
- the requested secret key algorithm- Returns:
- the shared secret key
- Throws:
java.lang.IllegalStateException
- if this key agreement has not been completed yetjava.security.NoSuchAlgorithmException
- if the requested secret key algorithm is not availablejava.security.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)
-
-