Package org.jgroups.protocols

Class KeyExchange

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.KeyExchange

All Implemented Interfaces:

Lifecycle

Direct Known Subclasses:

DH_KEY_EXCHANGE, SSL_KEY_EXCHANGE

public abstract class KeyExchange
extends Protocol

Base class for protocols implementing key exchange: a secret key to be used for encryption is exchanged between 2 parties (usually the key server and a new cluster member) securely; ie. without the possibility of man-in-the-middle attacks, compromising the key and (optional) perfect forward secrecy.

This protocol has to be placed somewhere below ASYM_ENCRYPT.

Since:

4.0.5

Field Summary

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
KeyExchange()

Method Summary

Modifier and Type	Method	Description
Object	down(Event evt)	An event is to be sent down the stack.
abstract void	fetchSecretKeyFrom(Address target)	Needs to fetch the secret key from a given destination (usually the key server).
protected <T extends Protocol> T	findProtocolAbove(Class<? extends Protocol> clazz)
protected Tuple<SecretKey,byte[]>	getSecretKeyFromAbove()	Fetches the secret key from a protocol above us
abstract Address	getServerLocation()	Returns the address of the server, e.g.
protected void	handleView(View view)
List<Integer>	requiredUpServices()	List of events that are required to be answered by some layer above
protected void	setSecretKeyAbove(Tuple<SecretKey,byte[]> key)	Sets the secret key in a protocol above us

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, destroy, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, resetStatistics, resetStats, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, stop, toString, up, up, up

Methods inherited from class java.lang.Object

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

Constructor Details

KeyExchange

public KeyExchange()

Method Details

requiredUpServices

public List<Integer> requiredUpServices()

Description copied from class: Protocol

List of events that are required to be answered by some layer above

Overrides:

requiredUpServices in class Protocol

fetchSecretKeyFrom

public abstract void fetchSecretKeyFrom(Address target)
                                 throws Exception

Needs to fetch the secret key from a given destination (usually the key server). When received, the secret key (and version) needs to be installed in a protocol above using setSecretKeyAbove(Tuple).

Parameters:

target - The member from which to fetch the secret key

Throws:

Exception

getServerLocation

public abstract Address getServerLocation()

Returns the address of the server, e.g. server socket (if any)

down

public Object down(Event evt)

Description copied from class: Protocol

An event is to be sent down the stack. A protocol may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the protocol may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down().

Overrides:

down in class Protocol

handleView

protected void handleView(View view)

getSecretKeyFromAbove

protected Tuple<SecretKey,byte[]> getSecretKeyFromAbove()

Fetches the secret key from a protocol above us

Returns:

The secret key and its version

setSecretKeyAbove

protected void setSecretKeyAbove(Tuple<SecretKey,byte[]> key)

Sets the secret key in a protocol above us

Parameters:

key - The secret key and its version

findProtocolAbove

protected <T extends Protocol> T findProtocolAbove(Class<? extends Protocol> clazz)