com.motorola.iden.crypto
Class KeyAgreementSpi

java.lang.Object
  |
  +--com.motorola.iden.crypto.KeyAgreementSpi

Direct Known Subclasses:

DH, ECDH

public abstract class KeyAgreementSpi

extends java.lang.Object

This class defines the Service Provider Interface (SPI) for the KeyAgreement class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a particular key agreement algorithm.

The keys involved in establishing a shared secret are created by one of the key generators (KeyPairGenerator or KeyGenerator), a KeyFactory, or as a result from an intermediate phase of the key agreement protocol (@see #engineDoPhase(java.security.Key, boolean) engineDoPhase).

For each of the correspondents in the key exchange, engineDoPhase needs to be called. For example, if the key exchange is with one other party, engineDoPhase needs to be called once, with the lastPhase flag set to true. If the key exchange is with two other parties, engineDoPhase needs to be called twice, the first time setting the lastPhase flag to false, and the second time setting it to true. There may be any number of parties involved in a key exchange.

MOTOROLA and the Stylized M Logo are registered trademarks of Motorola, Inc. Reg. U.S. Pat. & Tm. Off.
© Copyright 2002 - 2004 Motorola, Inc. All Rights Reserved.

See Also:

[KeyAgreement]

Constructor Summary

KeyAgreementSpi()

Method Summary

protected abstract Key	engineDoPhase(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 abstract byte[]	engineGenerateSecret() Generates the shared secret and returns it in a new buffer.
protected abstract void	engineInit(Key key, AlgorithmParameterSpec params) Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyAgreementSpi

public KeyAgreementSpi()

Method Detail

engineInit

protected abstract void engineInit(Key key,
                                   AlgorithmParameterSpec params)
                            throws InvalidKeyException,
                                   InvalidAlgorithmParameterException

Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.

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 parameters

Throws:

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.

engineDoPhase

protected abstract Key engineDoPhase(Key key,
                                     boolean lastPhase)
                              throws InvalidKeyException

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

InvalidKeyException - if the given key is inappropriate for this phase.

engineGenerateSecret

protected abstract byte[] engineGenerateSecret()

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 the engineInit methods, the same private information and algorithm parameters will be used for subsequent key agreements.

Returns:

the new buffer with the shared secret