com.ibm.crypto.fips.provider
Class DHKeyAgreement
- java.lang.Object
javax.crypto.KeyAgreementSpi
com.ibm.crypto.fips.provider.DHKeyAgreement
- public final class DHKeyAgreement
- extends javax.crypto.KeyAgreementSpi
- implements AlgorithmStatus
Constructor Summary
Constructor and Description |
---|
DHKeyAgreement()
Verify the JCE framework in the constructor.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
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.
|
|
engineGenerateSecret()
Generates the shared secret and returns it in a new buffer.
|
|
engineGenerateSecret(byte[] sharedSecret,int offset)
Generates the shared secret, and places it into the buffer
sharedSecret , beginning at offset .
|
|
engineGenerateSecret(java.lang.String algorithm)
Creates the shared secret and returns it as a secret key object
of the requested algorithm type.
|
|
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.
|
|
engineInit(java.security.Key key,java.security.SecureRandom random)
Initializes this key agreement with the given key and source of
randomness.
|
|
internalDoPhase(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.
|
|
internalGenerateSecret()
Generates the shared secret and returns it in a new buffer.
|
|
internalGenerateSecret(byte[] sharedSecret,int offset)
Generates the shared secret, and places it into the buffer
sharedSecret , beginning at offset .
|
|
internalGenerateSecret(java.lang.String algorithm)
Creates the shared secret and returns it as a secret key object
of the requested algorithm type.
|
|
internalInit(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.
|
|
isFipsApproved()
This function allows an application to verify the the algorithm is
FIPS approved.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
DHKeyAgreement
- public DHKeyAgreement()
java.lang.SecurityException
- if fails to verify
the JCE framework. Method Detail
isFipsApproved
- public boolean isFipsApproved()
isFipsApproved
in interface AlgorithmStatus
engineInit
- protected void engineInit(java.security.Key key,
- java.security.SecureRandom random)
- throws java.security.InvalidKeyException
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.
engineInit
in class javax.crypto.KeyAgreementSpi
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 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
engineInit
in class javax.crypto.KeyAgreementSpi
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 parameters random
- the source of randomness 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. internalInit
- protected void internalInit(java.security.Key key,
- java.security.spec.AlgorithmParameterSpec params,
- java.security.SecureRandom random)
- throws java.security.InvalidKeyException
- java.security.InvalidAlgorithmParameterException
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 parameters random
- the source of randomness 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
engineDoPhase
in class javax.crypto.KeyAgreementSpi
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. java.security.InvalidKeyException
- if the given key is inappropriate for
this phase. java.lang.IllegalStateException
- if this key agreement has not been
initialized. internalDoPhase
- protected java.security.Key internalDoPhase( java.security.Key key,
- boolean lastPhase)
- throws java.security.InvalidKeyException
- java.lang.IllegalStateException
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. 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
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 the engineInit
methods, the same
private information and algorithm parameters will be used for
subsequent key agreements.
engineGenerateSecret
in class javax.crypto.KeyAgreementSpi
java.lang.IllegalStateException
- if this key agreement has not been
completed yet internalGenerateSecret
- protected byte[] internalGenerateSecret( )
- throws java.lang.IllegalStateException
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 the engineInit
methods, the same
private information and algorithm parameters will be used for
subsequent key agreements.
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
sharedSecret
, beginning at offset
.
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,
so that it
can be reused for further key agreements. Unless this key agreement is
reinitialized with one of the engineInit
methods, the same
private information and algorithm parameters will be used for
subsequent key agreements.
engineGenerateSecret
in class javax.crypto.KeyAgreementSpi
sharedSecret
- the buffer for the shared secret offset
- the offset in sharedSecret
where the
shared secret will be stored sharedSecret
java.lang.IllegalStateException
- if this key agreement has not been
completed yet javax.crypto.ShortBufferException
- if the given output buffer is too small
to hold the secret internalGenerateSecret
- protected int internalGenerateSecret( byte[] sharedSecret,
- int offset)
- throws java.lang.IllegalStateException
- javax.crypto.ShortBufferException
sharedSecret
, beginning at offset
.
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,
so that it
can be reused for further key agreements. Unless this key agreement is
reinitialized with one of the engineInit
methods, the same
private information and algorithm parameters will be used for
subsequent key agreements.
sharedSecret
- the buffer for the shared secret offset
- the offset in sharedSecret
where the
shared secret will be stored sharedSecret
java.lang.IllegalStateException
- if this key agreement has not been
completed yet javax.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
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 the engineInit
methods, the same
private information and algorithm parameters will be used for
subsequent key agreements.
engineGenerateSecret
in class javax.crypto.KeyAgreementSpi
algorithm
- the requested secret key algorithm java.lang.IllegalStateException
- if this key agreement has not been
completed yet java.security.NoSuchAlgorithmException
- if the requested secret key
algorithm is not available java.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) internalGenerateSecret
- protected javax.crypto.SecretKey internalGenerateSecret( java.lang.String algorithm)
- throws java.lang.IllegalStateException
- java.security.NoSuchAlgorithmException
- java.security.InvalidKeyException
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 the engineInit
methods, the same
private information and algorithm parameters will be used for
subsequent key agreements.
algorithm
- the requested secret key algorithm java.lang.IllegalStateException
- if this key agreement has not been
completed yet java.security.NoSuchAlgorithmException
- if the requested secret key
algorithm is not available java.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)