org.eclipse.californium.scandium

Class DtlsManagedClusterConnector

java.lang.Object

org.eclipse.californium.scandium.DTLSConnector

org.eclipse.californium.scandium.DtlsClusterConnector

org.eclipse.californium.scandium.DtlsManagedClusterConnector

All Implemented Interfaces:

org.eclipse.californium.elements.Connector, RecordLayer

public class DtlsManagedClusterConnector
extends DtlsClusterConnector

DTLS managed cluster connector. Enables access to the cluster internal communication to exchange additional management messages and enable encryption for that internal communication. If encryption is enabled, that header for the forwarded tls-cid records maybe protected by a MAC, see DtlsClusterConnectorConfig.

Since:

2.5

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.californium.scandium.DtlsClusterConnector

DtlsClusterConnector.ClusterNodesProvider

Nested classes/interfaces inherited from class org.eclipse.californium.scandium.DTLSConnector

DTLSConnector.Worker

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTOCOL_MANAGEMENT_DTLS Protocol identifier for DTLS management communication.
static String	PROTOCOL_MANAGEMENT_DTLS_MAC Protocol identifier for DTLS management communication.
static String	PROTOCOL_MANAGEMENT_UDP Protocol identifier for plain UDP management communication.

Fields inherited from class org.eclipse.californium.scandium.DtlsClusterConnector

CLUSTER_ADDRESS_LENGTH_OFFSET, CLUSTER_ADDRESS_OFFSET, CLUSTER_MAC_LENGTH, CLUSTER_PORT_OFFSET, CLUSTER_RECORD_TYPE_OFFSET, clusterHealth, clusterInternalSocket, MAX_ADDRESS_LENGTH, MAX_DATAGRAM_OFFSET, MIN_ADDRESS_LENGTH, RECORD_TYPE_INCOMING, RECORD_TYPE_OUTGOING

Fields inherited from class org.eclipse.californium.scandium.DTLSConnector

config, connectionIdGenerator, health, inboundDatagramBufferSize, KEY_TLS_SERVER_HOST_NAME, timer

Fields inherited from interface org.eclipse.californium.scandium.dtls.RecordLayer

DEFAULT_ETH_MTU, DEFAULT_IPV4_MTU, DEFAULT_IPV6_MTU, IPV4_HEADER_LENGTH, IPV6_HEADER_LENGTH, MAX_MTU

Constructor Summary

Constructors

Modifier	Constructor and Description
	DtlsManagedClusterConnector(DtlsConnectorConfig configuration, DtlsClusterConnectorConfig clusterConfiguration) Create dtls connector with cluster management communication.
protected	DtlsManagedClusterConnector(DtlsConnectorConfig configuration, DtlsClusterConnectorConfig clusterConfiguration, ResumptionSupportingConnectionStore connectionStore) Create dtls connector with dynamic cluster support.
	DtlsManagedClusterConnector(DtlsConnectorConfig configuration, DtlsClusterConnectorConfig clusterConfiguration, SessionCache sessionCache) Create dtls connector with dynamic cluster support.

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	calculateClusterMac(Mac mac, DatagramPacket clusterPacket) Calculates MAC for forwarded and backwarded messages.
void	destroy() Destroys the connector.
protected int	getClusterMacLength() Get cluster MAC length.
org.eclipse.californium.elements.ExtendedConnector	getClusterManagementConnector() Get cluster management connector.
String	getManagementProtocol() Get protocol for management connector.
protected void	init(InetSocketAddress bindAddress, DatagramSocket socket, Integer mtu) Initialize socket ad start connector.
protected void	processDatagramFromClusterNetwork(Byte type, DatagramPacket clusterPacket) Process received cluster internal message.
protected void	processManagementDatagramFromClusterNetwork(DatagramPacket clusterPacket) Process cluster internal management message.
protected void	sendDatagramToClusterNetwork(DatagramPacket clusterPacket) Send cluster internal message.
static void	setClusterMac(Mac mac, DatagramPacket clusterPacket) Set cluster MAC in packet.
void	stop() Stop also socket and threads for cluster internal communication.
static boolean	validateClusterMac(Mac mac, DatagramPacket clusterPacket) Validate cluster MAC in packet.

Methods inherited from class org.eclipse.californium.scandium.DtlsClusterConnector

createDefaultHealthHandler, ensureLength, getClusterRecordType, getNodeID, processDatagram, sendRecord, setClusterNodesProvider, startReceiver

Methods inherited from class org.eclipse.californium.scandium.DTLSConnector

clearConnectionState, close, createConnectionStore, dropReceivedRecord, forceResumeAllSessions, forceResumeSessionFor, getAddress, getMaxDatagramSize, getMaximumFragmentLength, getMaximumTransmissionUnit, getProtocol, getSessionByAddress, isRunning, onInitializeHandshaker, processDatagram, processRecord, receiveNextDatagramFromNetwork, send, sendFlight, sendNextDatagramOverNetwork, setAlertHandler, setEndpointContextMatcher, setExecutor, setRawDataReceiver, start, start, startDropConnectionsForPrincipal, startForEach, startTerminateConnectionsForPrincipal, startTerminateConnectionsForPrincipal, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_MANAGEMENT_UDP

public static final String PROTOCOL_MANAGEMENT_UDP

Protocol identifier for plain UDP management communication.

See Also:

protocol, getManagementProtocol(), Constant Field Values

PROTOCOL_MANAGEMENT_DTLS

public static final String PROTOCOL_MANAGEMENT_DTLS

Protocol identifier for DTLS management communication. The additional source header for forwarded tls_cid records is not protected by a MAC.

See Also:

protocol, getManagementProtocol(), Constant Field Values

PROTOCOL_MANAGEMENT_DTLS_MAC

public static final String PROTOCOL_MANAGEMENT_DTLS_MAC

Protocol identifier for DTLS management communication. The additional source header for forwarded tls_cid records is protected by a MAC.

See Also:

protocol, getManagementProtocol(), Constant Field Values

Constructor Detail

DtlsManagedClusterConnector

public DtlsManagedClusterConnector(DtlsConnectorConfig configuration,
                           DtlsClusterConnectorConfig clusterConfiguration)

Create dtls connector with cluster management communication.

Parameters:

configuration - dtls configuration

clusterConfiguration - cluster internal connector configuration

Throws:

IllegalArgumentException - if the configuration doesn't provide a cid generator, or the cid generator only supports, but doesn't use cids, or the cid generator is no NodeConnectionIdGenerator.

DtlsManagedClusterConnector

public DtlsManagedClusterConnector(DtlsConnectorConfig configuration,
                           DtlsClusterConnectorConfig clusterConfiguration,
                           SessionCache sessionCache)

Create dtls connector with dynamic cluster support.

Parameters:

configuration - dtls configuration

clusterConfiguration - cluster internal connector configuration

sessionCache - session cache. May be null.

Throws:

IllegalArgumentException - if the configuration doesn't provide a cid generator, or the cid generator only supports, but doesn't use cids, or the cid generator is no NodeConnectionIdGenerator.

DtlsManagedClusterConnector

protected DtlsManagedClusterConnector(DtlsConnectorConfig configuration,
                           DtlsClusterConnectorConfig clusterConfiguration,
                           ResumptionSupportingConnectionStore connectionStore)

Create dtls connector with dynamic cluster support.

Parameters:

configuration - dtls configuration

clusterConfiguration - cluster internal connector configuration

connectionStore - connection store

Throws:

IllegalArgumentException - if the configuration doesn't provide a cid generator, or the cid generator only supports, but doesn't use cids, or the cid generator is no NodeConnectionIdGenerator.

Method Detail

init

protected void init(InetSocketAddress bindAddress,
        DatagramSocket socket,
        Integer mtu)
             throws IOException

Initialize socket ad start connector. Creates also socket and threads for cluster internal communication. The threads are only create, if DtlsClusterConnector.startReceiver is true. Creates socket and threads for cluster internal communication.

Overrides:

init in class DtlsClusterConnector

Parameters:

bindAddress - address to bind socket

socket - socket

mtu - mtu of socket, or null, if socket implementation doesn't use a special mtu.

Throws:

IOException - I/O error

stop

public void stop()

Description copied from class: DtlsClusterConnector

Stop also socket and threads for cluster internal communication.

Specified by:

stop in interface org.eclipse.californium.elements.Connector

Overrides:

stop in class DtlsClusterConnector

destroy

public void destroy()

Description copied from class: DTLSConnector

Destroys the connector.

This method invokes DTLSConnector.stop() and clears the ConnectionStore used to manage connections to peers. Thus, contrary to the behavior specified for Connector.destroy(), this connector can be re-started using the DTLSConnector.start() method but subsequent invocations of the DTLSConnector.send(RawData) method will trigger the establishment of a new connection to the corresponding peer.

Specified by:

destroy in interface org.eclipse.californium.elements.Connector

Overrides:

destroy in class DTLSConnector

getClusterMacLength

protected int getClusterMacLength()

Get cluster MAC length. Returns DtlsClusterConnector.CLUSTER_MAC_LENGTH, if useClusterMac is true, 0, otherwise.

Overrides:

getClusterMacLength in class DtlsClusterConnector

Returns:

cluster MAC length. 0, if cluster MAC is not used.

getManagementProtocol

public String getManagementProtocol()

Get protocol for management connector.

Returns:

PROTOCOL_MANAGEMENT_UDP, PROTOCOL_MANAGEMENT_DTLS, or PROTOCOL_MANAGEMENT_DTLS_MAC.

See Also:

protocol

getClusterManagementConnector

public org.eclipse.californium.elements.ExtendedConnector getClusterManagementConnector()

Get cluster management connector.

Returns:

cluster management connector

processDatagramFromClusterNetwork

protected void processDatagramFromClusterNetwork(Byte type,
                                     DatagramPacket clusterPacket)
                                          throws IOException

Process received cluster internal message. Check cluster MAC for source header of forwarded or backwarded tls_cid records, if useClusterMac is enabled.

Overrides:

processDatagramFromClusterNetwork in class DtlsClusterConnector

Parameters:

type - cluster record type. DtlsClusterConnector.RECORD_TYPE_INCOMING or DtlsClusterConnector.RECORD_TYPE_OUTGOING.

clusterPacket - cluster internal message

Throws:

IOException - if an io-error occurred.

sendDatagramToClusterNetwork

protected void sendDatagramToClusterNetwork(DatagramPacket clusterPacket)
                                     throws IOException

Send cluster internal message. Used for forwarded or backwarded tls_cid records. Fill in cluster MAC for source header of forwarded or backwarded tls_cid records, if useClusterMac is enabled.

Overrides:

sendDatagramToClusterNetwork in class DtlsClusterConnector

Parameters:

clusterPacket - cluster internal message

Throws:

IOException - if an i/o-error occurred.

validateClusterMac

public static boolean validateClusterMac(Mac mac,
                         DatagramPacket clusterPacket)

Validate cluster MAC in packet.

Parameters:

mac - initialized Mac

clusterPacket - packet

Returns:

true, if MAC is valid, false, otherwise.

setClusterMac

public static void setClusterMac(Mac mac,
                 DatagramPacket clusterPacket)

Set cluster MAC in packet.

Parameters:

mac - initialized Mac

clusterPacket - packet

calculateClusterMac

public static byte[] calculateClusterMac(Mac mac,
                         DatagramPacket clusterPacket)

Calculates MAC for forwarded and backwarded messages. Used to protect the original address from modifications.

Parameters:

mac - initialized MAC.

clusterPacket - forwarded and backwarded messages

Returns:

calculated MAC

Throws:

IllegalArgumentException - if message is too small

processManagementDatagramFromClusterNetwork

protected void processManagementDatagramFromClusterNetwork(DatagramPacket clusterPacket)
                                                    throws IOException

Description copied from class: DtlsClusterConnector

Process cluster internal management message. Not used for forwarded or backwarded tls_cid records.

Overrides:

processManagementDatagramFromClusterNetwork in class DtlsClusterConnector

Parameters:

clusterPacket - cluster internal management message.

Throws:

IOException - if an i/o-error occurred