gnu.crypto.key
Interface IKeyAgreementParty
- BaseKeyAgreementParty, DiffieHellmanKeyAgreement, DiffieHellmanReceiver, DiffieHellmanSender, ElGamalKeyAgreement, ElGamalReceiver, ElGamalSender, SRP6Host, SRP6KeyAgreement, SRP6SaslClient, SRP6SaslServer, SRP6TLSClient, SRP6TLSServer, SRP6User
public interface IKeyAgreementParty
The visible methods of an key agreement protocol participating party.
Version:
byte[] | getSharedSecret() - Returns the byte array containing the shared secret as generated by
this party.
|
void | init(Map attributes) - Sets up the instance to operate with specific attributes.
|
boolean | isComplete() - Returns
true if the party in the key agreement protocol
exchange has completed its part of the exchange.
|
String | name() - Returns the canonical name of the key agreement protocol.
|
OutgoingMessage | processMessage(IncomingMessage in) - Processes an incoming message at one end, generating a message that
will be processed by the other party(ies).
|
void | reset() - Resets this instance for re-use with another set of attributes.
|
getSharedSecret
public byte[] getSharedSecret()
throws KeyAgreementException
Returns the byte array containing the shared secret as generated by
this party.
- the generated shared secret.
KeyAgreementException
- if the key agreement is not yet initialised,
or is initialised but the exchange is still in progress.
init
public void init(Map attributes)
throws KeyAgreementException
Sets up the instance to operate with specific attributes.
attributes
- a map of name-values used by concrete implementations.
KeyAgreementException
- if an exception occurs during the setup.
isComplete
public boolean isComplete()
Returns true
if the party in the key agreement protocol
exchange has completed its part of the exchange. If this is the case an
IllegalStateException
is thrown for any method invocation except
init()
or reset()
.
true
if this party has completed its part of the key
agreement protocol exchange; false
otherwise.
name
public String name()
Returns the canonical name of the key agreement protocol.
- the canonical name of the key agreement protocol.
processMessage
public OutgoingMessage processMessage(IncomingMessage in)
throws KeyAgreementException
Processes an incoming message at one end, generating a message that
will be processed by the other party(ies).
in
- the incoming message.
- an outgoing message, or
null
if this is an
intermediary step that does not cause any output.
KeyAgreementException
- if an exception occurs during the processing
of the incoming message, or during the generation of the outgoing message.
reset
public void reset()
Resets this instance for re-use with another set of attributes.
Copyright © 2001, 2002, 2003
Free Software Foundation,
Inc. All Rights Reserved.