org.eclipse.californium.scandium.dtls.pskstore

Class StaticPskStore

java.lang.Object

org.eclipse.californium.scandium.dtls.pskstore.StaticPskStore

All Implemented Interfaces:

PskStore

Deprecated.

use AdvancedSinglePskStore instead.

@Deprecated
public class StaticPskStore
extends Object
implements PskStore

A simple in-memory pre-shared-key store.

This implementation always returns the same identity/Key for all peers and is mainly intended for testing and evaluation purposes.

NB Keeping keys in in-memory is not a good idea for production. Instead, keys should be kept in an encrypted store.

Constructor Summary

Constructors

Constructor and Description
StaticPskStore(PskPublicInformation identity, byte[] key) Deprecated. Creates a new store for an identity and key.
StaticPskStore(String identity, byte[] key) Deprecated. Creates a new store for an identity and key.

Method Summary

Methods

Modifier and Type	Method and Description
PskPublicInformation	getIdentity(InetSocketAddress inetAddress) Deprecated. Gets the identity to use for a PSK based handshake with a given peer.
PskPublicInformation	getIdentity(InetSocketAddress peerAddress, ServerNames virtualHost) Deprecated. Gets the identity to use for a PSK based handshake with a given peer.
SecretKey	getKey(PskPublicInformation identity) Deprecated. Gets the pre-shared key for a given identity.
SecretKey	getKey(ServerNames serverNames, PskPublicInformation identity) Deprecated. Gets the pre-shared key for a given identity in the scope of a server name.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticPskStore

public StaticPskStore(String identity,
              byte[] key)

Deprecated.

Creates a new store for an identity and key.

Parameters:

identity - The (single) identity to always use.

key - The (single) key for the identity.

StaticPskStore

public StaticPskStore(PskPublicInformation identity,
              byte[] key)

Deprecated.

Creates a new store for an identity and key.

Parameters:

identity - The (single) identity to always use.

key - The (single) key for the identity.

Method Detail

getIdentity

public PskPublicInformation getIdentity(InetSocketAddress inetAddress)

Deprecated.

Description copied from interface: PskStore

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 PskStore

Parameters:

inetAddress - The IP address of the peer to perform the handshake with.

Returns:

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

getIdentity

public PskPublicInformation getIdentity(InetSocketAddress peerAddress,
                               ServerNames virtualHost)

Deprecated.

Description copied from interface: PskStore

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 PskStore

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, yielding the same result as PskStore.getIdentity(InetSocketAddress).

Returns:

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

getKey

public SecretKey getKey(PskPublicInformation identity)

Deprecated.

Description copied from interface: PskStore

Gets the pre-shared key for a given identity.

A DTLS server can use this method to look up the pre-shared key for an identity provided by the client as part of a PSK key exchange.

The implementation is intended to normalize the identity by a matching entry, if that entry is not UTF-8 compliant encoded.

The returned key is SecretUtil.destroy(javax.crypto.SecretKey)ed after usage.

Specified by:

getKey in interface PskStore

Parameters:

identity - The identity to look up the key for.

Returns:

The key or null if the given identity is unknown.

See Also:

PskPublicInformation.normalize(String)

getKey

public SecretKey getKey(ServerNames serverNames,
               PskPublicInformation identity)

Deprecated.

Description copied from interface: PskStore

Gets the pre-shared key for a given identity in the scope of a server name.

A DTLS server can use this method to look up the pre-shared key for an identity provided by the client as part of a PSK key exchange.

The key is looked up in the context of the virtual host that the client has provided in the Server Name Indication extension contained in its CLIENT_HELLO message.

The implementation is intended to normalize the identity by a matching entry, if that entry is not UTF-8 compliant encoded.

The returned key is intended to be be a copy. If the used SecretKey implements Destroyable, it will be cleaned up by SecretUtil.destroy(javax.crypto.SecretKey)ed after its usage.

Specified by:

getKey in interface PskStore

Parameters:

serverNames - The name of the host that the client wants to connect to as provided in the Server Name Indication HELLO extension during the DTLS handshake. The key returned for the given identity is being looked up in the context of this host name.

identity - The identity to look up the key for.

Returns:

The key or null if no matching identity has been registered for any of the server name types.

See Also:

PskPublicInformation.normalize(String)