org.jgroups.protocols

Class SSL_KEY_EXCHANGE

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.KeyExchange

org.jgroups.protocols.SSL_KEY_EXCHANGE

public class SSL_KEY_EXCHANGE
extends KeyExchange

Key exchange based on SSL sockets. The key server creates an SSLServerSocket on a given port and members fetch the secret key by creating a SSLSocket to the key server. The key server authenticates the client (and vice versa) and then sends the secret key over this encrypted channel.
When the key exchange has completed, the secret key requester closes its SSL connection to the key server.
Note that this implementation should prevent man-in-the-middle attacks.

Since:

4.0.5

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SSL_KEY_EXCHANGE.SessionVerifier
protected static class	SSL_KEY_EXCHANGE.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.InetAddress	bind_addr
protected java.security.KeyStore	key_store
protected java.lang.String	keystore_name
protected java.lang.String	keystore_password
protected java.lang.String	keystore_type
protected int	port
protected int	port_range
protected boolean	require_client_authentication
protected java.lang.String	secret_key_algorithm
protected SSL_KEY_EXCHANGE.SessionVerifier	session_verifier
protected java.lang.String	session_verifier_arg
protected java.lang.String	session_verifier_class
protected int	socket_timeout
protected javax.net.ssl.SSLServerSocket	srv_sock
protected Runner	srv_sock_handler
protected View	view

Fields inherited from class org.jgroups.protocols.KeyExchange

local_addr

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, log, name, stack, stats, up_prot

Constructor Summary

Constructors

Constructor and Description
SSL_KEY_EXCHANGE()

Method Summary

Modifier and Type	Method and Description
protected void	accept()
protected void	becomeKeyserver()
protected javax.net.ssl.SSLServerSocket	createServerSocket()
protected javax.net.ssl.SSLSocket	createSocketTo(Address target)
void	destroy() This method is called on a Channel.close().
void	fetchSecretKeyFrom(Address target) Needs to fetch the secret key from a given destination (usually the key server).
protected javax.net.ssl.SSLContext	getContext()
protected void	handleView(View view)
void	init() Called after instance has been created (null constructor) and before protocol is started.
protected static java.lang.String	print16(java.security.PublicKey pub_key)
void	start() This method is called on a Channel.connect(String).
void	stop() This method is called on a Channel.disconnect().
protected void	stopKeyserver()
java.lang.Object	up(Event evt) An event was received from the layer below.

Methods inherited from class org.jgroups.protocols.KeyExchange

down, findProtocolAbove, getSecretKeyFromAbove, providedUpServices, requiredUpServices, setSecretKeyAbove

Methods inherited from class org.jgroups.stack.Protocol

accept, afterCreationHook, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, requiredDownServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, statsEnabled, up

Methods inherited from class java.lang.Object

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

Field Detail

port

protected int port

bind_addr

protected java.net.InetAddress bind_addr

port_range

protected int port_range

keystore_name

protected java.lang.String keystore_name

keystore_type

protected java.lang.String keystore_type

keystore_password

protected java.lang.String keystore_password

secret_key_algorithm

protected java.lang.String secret_key_algorithm

require_client_authentication

protected boolean require_client_authentication

socket_timeout

protected int socket_timeout

session_verifier_class

protected java.lang.String session_verifier_class

session_verifier_arg

protected java.lang.String session_verifier_arg

srv_sock

protected javax.net.ssl.SSLServerSocket srv_sock

srv_sock_handler

protected Runner srv_sock_handler

key_store

protected java.security.KeyStore key_store

view

protected View view

session_verifier

protected SSL_KEY_EXCHANGE.SessionVerifier session_verifier

Constructor Detail

SSL_KEY_EXCHANGE

public SSL_KEY_EXCHANGE()

Method Detail

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.

Overrides:

init in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception

start

public void start()
           throws java.lang.Exception

Description copied from class: Protocol

This method is called on a Channel.connect(String). Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.

Overrides:

start in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so Channel.connect(String) will throw an exception

stop

public void stop()

Description copied from class: Protocol

This method is called on a Channel.disconnect(). Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed

Overrides:

stop in class Protocol

destroy

public void destroy()

Description copied from class: Protocol

This method is called on a Channel.close(). Does some cleanup; after the call the VM will terminate

Overrides:

destroy in class Protocol

up

public java.lang.Object up(Event evt)

Description copied from class: Protocol

An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().

Overrides:

up in class Protocol

fetchSecretKeyFrom

public void fetchSecretKeyFrom(Address target)
                        throws java.lang.Exception

Description copied from class: KeyExchange

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 KeyExchange.setSecretKeyAbove(Tuple).

Specified by:

fetchSecretKeyFrom in class KeyExchange

Parameters:

target - The member from which to fetch the secret key

Throws:

java.lang.Exception

handleView

protected void handleView(View view)

Overrides:

handleView in class KeyExchange

accept

protected void accept()

becomeKeyserver

protected void becomeKeyserver()
                        throws java.lang.Exception

Throws:

java.lang.Exception

stopKeyserver

protected void stopKeyserver()

createServerSocket

protected javax.net.ssl.SSLServerSocket createServerSocket()
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

createSocketTo

protected javax.net.ssl.SSLSocket createSocketTo(Address target)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getContext

protected javax.net.ssl.SSLContext getContext()
                                       throws java.lang.Exception

Throws:

java.lang.Exception

print16

protected static java.lang.String print16(java.security.PublicKey pub_key)