org.eclipse.californium.scandium.dtls.pskstore

Class AsyncAdvancedPskStore

java.lang.Object

org.eclipse.californium.scandium.dtls.pskstore.AsyncAdvancedPskStore

All Implemented Interfaces:

AdvancedPskStore

public class AsyncAdvancedPskStore
extends Object
implements AdvancedPskStore

Asynchronous test implementation using a provided AdvancedPskStore. Use 0 or negative delays for test with synchronous blocking behaviour. And positive delays for test with asynchronous none-blocking behaviour.

Since:

2.5

Field Summary

Fields

Modifier and Type	Field and Description
protected static ThreadLocalCryptoMap<ThreadLocalMac>	MAC

Constructor Summary

Constructors

Constructor and Description
AsyncAdvancedPskStore(AdvancedPskStore pskStore) Create an asynchronous advanced pskstore from PskStore.

Method Summary

Methods

Modifier and Type	Method and Description
protected SecretKey	generateMasterSecret(String hmacAlgorithm, SecretKey pskSecret, SecretKey otherSecret, byte[] seed)
int	getDelay() Get delay milliseconds.
PskPublicInformation	getIdentity(InetSocketAddress peerAddress, ServerNames virtualHost) Gets the identity to use for a PSK based handshake with a given peer.
boolean	hasEcdhePskSupported() Check, if ECDHE PSK cipher suites are supported.
PskSecretResult	requestPskSecretResult(ConnectionId cid, ServerNames serverNames, PskPublicInformation identity, String hmacAlgorithm, SecretKey otherSecret, byte[] seed) Request psk secret result.
AsyncAdvancedPskStore	setDelay(int delayMillis) Set delay milliseconds.
void	setResultHandler(PskSecretResultHandler resultHandler) Set the handler for asynchronous master secret results.
AsyncAdvancedPskStore	setSecretMode(boolean enableGenerateMasterSecret) Set secret mode.
void	shutdown() Shutdown.

Methods inherited from class java.lang.Object

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

Field Detail

MAC

protected static final ThreadLocalCryptoMap<ThreadLocalMac> MAC

Constructor Detail

AsyncAdvancedPskStore

public AsyncAdvancedPskStore(AdvancedPskStore pskStore)

Create an asynchronous advanced pskstore from PskStore. A call to shutdown() is required to cleanup the used resources (executor).

Parameters:

pskStore - advanced psk store

Method Detail

setSecretMode

public AsyncAdvancedPskStore setSecretMode(boolean enableGenerateMasterSecret)

Set secret mode.

Parameters:

enableGenerateMasterSecret - true to return generated master secret, false for PSK secret key.

Returns:

this psk store for command chaining

setDelay

public AsyncAdvancedPskStore setDelay(int delayMillis)

Set delay milliseconds.

Parameters:

delayMillis - delay in milliseconds to report result. 0 or negative delays using synchronous blocking behaviour. Positive delays using asynchronous none-blocking behaviour.

Returns:

this psk store for command chaining

getDelay

public int getDelay()

Get delay milliseconds.

Returns:

delay milliseconds. 0 or negative delays using synchronous blocking behaviour. Positive delays using asynchronous none-blocking behaviour.

shutdown

public void shutdown()

Shutdown. Cleanup resources.

requestPskSecretResult

public PskSecretResult requestPskSecretResult(ConnectionId cid,
                                     ServerNames serverNames,
                                     PskPublicInformation identity,
                                     String hmacAlgorithm,
                                     SecretKey otherSecret,
                                     byte[] seed)

Description copied from interface: AdvancedPskStore

Request psk secret result. Either return the result, or null and process the request asynchronously. The PskSecretResult must contain the CID, the normalized identity and master secret or PSK secret key, if available. If the result is not returned, it is passed asynchronously to the result handler, provided during DTLSConnector initialization by AdvancedPskStore.setResultHandler(PskSecretResultHandler).

Specified by:

requestPskSecretResult in interface AdvancedPskStore

Parameters:

cid - connection id for stateless asynchronous implementations.

serverNames - server names. Maybe null, if SNI is not enabled or not used by the client.

identity - psk identity. Maybe normalized, if identity is available in the store.

hmacAlgorithm - HMAC algorithm name for PRF.

otherSecret - other secret from ECDHE, or null. Must be cloned for asynchronous use. See RFC 5489, other secret

seed - seed for PRF.

Returns:

psk secret result, or null, if result is provided asynchronous.

generateMasterSecret

protected SecretKey generateMasterSecret(String hmacAlgorithm,
                             SecretKey pskSecret,
                             SecretKey otherSecret,
                             byte[] seed)

setResultHandler

public void setResultHandler(PskSecretResultHandler resultHandler)

Description copied from interface: AdvancedPskStore

Set the handler for asynchronous master secret results. Called during initialization of the DTLSConnector. Synchronous implementations may just ignore this using an empty implementation. Note: the type of the handler will change to HandshakeResultHandler with 3.0.

Specified by:

setResultHandler in interface AdvancedPskStore

Parameters:

resultHandler - handler for asynchronous master secret results. This handler MUST NOT be called from the thread calling AdvancedPskStore.requestPskSecretResult(ConnectionId, ServerNames, PskPublicInformation, String, SecretKey, byte[]), instead just return the result there.

hasEcdhePskSupported

public boolean hasEcdhePskSupported()

Description copied from interface: AdvancedPskStore

Check, if ECDHE PSK cipher suites are supported.

Specified by:

hasEcdhePskSupported in interface AdvancedPskStore

Returns:

true, if ECDHE PSK cipher suites are supported, false, if not.

getIdentity

public PskPublicInformation getIdentity(InetSocketAddress peerAddress,
                               ServerNames virtualHost)

Description copied from interface: AdvancedPskStore

Gets the identity to use for a PSK based handshake with a given peer.

A DTLS client uses this method to determine the identity to include in its CLIENT_KEY_EXCHANGE message during a PSK based DTLS handshake with the peer.

Specified by:

getIdentity in interface AdvancedPskStore

Parameters:

peerAddress - The IP address and port of the peer to perform the handshake with.

virtualHost - The virtual host at the peer to connect to. If null, the identity will be looked up in the global scope.

Returns:

The identity to use or null if no peer with the given address and virtual host is registered.