org.eclipse.californium.scandium.dtls.pskstore

Class InMemoryPskStore

java.lang.Object

org.eclipse.californium.scandium.dtls.pskstore.InMemoryPskStore

All Implemented Interfaces:

PskStore

Deprecated.

use AdvancedMultiPskStore instead.

@Deprecated
public class InMemoryPskStore
extends Object
implements PskStore

An in-memory pre-shared key storage.

If you don't need to initiate handshake/connection, you could just add identity/key with setKey(String, byte[]) or setKey(PskPublicInformation, byte[]). If you need to initiate connection, you should add known peers with addKnownPeer(InetSocketAddress, String, byte[]) or addKnownPeer(InetSocketAddress, PskPublicInformation, byte[]).

If non-compliant encoded identities are used, please provide PskPublicInformation.PskPublicInformation(String, byte[]) identities with the non-compliant encoded bytes and the intended string.

To be used only for testing and evaluation. You are supposed to store your key in a secure way: keeping them in-memory is not a good idea.

Constructor Summary

Constructors

Constructor and Description
InMemoryPskStore() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addKnownPeer(InetSocketAddress peerAddress, PskPublicInformation identity, byte[] key) Deprecated. Adds a shared key for a peer.
void	addKnownPeer(InetSocketAddress peerAddress, String identity, byte[] key) Deprecated. Adds a shared key for a peer.
void	addKnownPeer(InetSocketAddress peerAddress, String virtualHost, PskPublicInformation identity, byte[] key) Deprecated. Adds a shared key for a virtual host on a peer.
void	addKnownPeer(InetSocketAddress peerAddress, String virtualHost, String identity, byte[] key) Deprecated. Adds a shared key for a virtual host on a peer.
PskPublicInformation	getIdentity(InetSocketAddress peerAddress) 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.
void	removeKey(PskPublicInformation identity) Deprecated. Removes a key value for a given identity.
void	removeKey(PskPublicInformation identity, ServerName virtualHost) Deprecated. Removes a key for an identity scoped to a virtual host.
void	removeKey(PskPublicInformation identity, String virtualHost) Deprecated. Removes a key for an identity scoped to a virtual host.
void	removeKey(String identity) Deprecated. Removes a key value for a given identity.
void	removeKey(String identity, ServerName virtualHost) Deprecated. Removes a key for an identity scoped to a virtual host.
void	removeKey(String identity, String virtualHost) Deprecated. Removes a key for an identity scoped to a virtual host.
void	setKey(PskPublicInformation identity, byte[] key) Deprecated. Sets a key value for a given identity.
void	setKey(PskPublicInformation identity, byte[] key, ServerName virtualHost) Deprecated. Sets a key for an identity scoped to a virtual host.
void	setKey(PskPublicInformation identity, byte[] key, String virtualHost) Deprecated. Sets a key for an identity scoped to a virtual host.
void	setKey(String identity, byte[] key) Deprecated. Sets a key value for a given identity.
void	setKey(String identity, byte[] key, ServerName virtualHost) Deprecated. Sets a key for an identity scoped to a virtual host.
void	setKey(String identity, byte[] key, String virtualHost) Deprecated. Sets a key for an identity scoped to a virtual host.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryPskStore

public InMemoryPskStore()

Deprecated.

Method Detail

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)

setKey

public void setKey(String identity,
          byte[] key)

Deprecated.

Sets a key value for a given identity.

If the key already exists, it will be replaced.

Parameters:

identity - the identity associated with the key

key - the key used to authenticate the identity

See Also:

setKey(PskPublicInformation, byte[], ServerName)

setKey

public void setKey(PskPublicInformation identity,
          byte[] key)

Deprecated.

Sets a key value for a given identity.

If the key already exists, it will be replaced.

Parameters:

identity - the identity associated with the key

key - the key used to authenticate the identity

See Also:

setKey(PskPublicInformation, byte[], ServerName)

setKey

public void setKey(String identity,
          byte[] key,
          String virtualHost)

Deprecated.

Sets a key for an identity scoped to a virtual host.

If the key already exists, it will be replaced.

Parameters:

identity - The identity to set the key for.

key - The key to set for the identity.

virtualHost - The virtual host to associate the identity and key with.

See Also:

setKey(PskPublicInformation, byte[], ServerName)

setKey

public void setKey(PskPublicInformation identity,
          byte[] key,
          String virtualHost)

Deprecated.

Sets a key for an identity scoped to a virtual host.

If the key already exists, it will be replaced.

Parameters:

identity - The identity to set the key for.

key - The key to set for the identity.

virtualHost - The virtual host to associate the identity and key with.

See Also:

setKey(PskPublicInformation, byte[], ServerName)

setKey

public void setKey(String identity,
          byte[] key,
          ServerName virtualHost)

Deprecated.

Sets a key for an identity scoped to a virtual host.

If the key already exists, it will be replaced.

Parameters:

identity - The identity to set the key for.

key - The key to set for the identity.

virtualHost - The virtual host to associate the identity and key with.

See Also:

setKey(PskPublicInformation, byte[], ServerName)

setKey

public void setKey(PskPublicInformation identity,
          byte[] key,
          ServerName virtualHost)

Deprecated.

Sets a key for an identity scoped to a virtual host.

If the key already exists, it will be replaced.

Parameters:

identity - The identity to set the key for.

key - The key to set for the identity.

virtualHost - The virtual host to associate the identity and key with.

See Also:

setKey(String, byte[], ServerName)

addKnownPeer

public void addKnownPeer(InetSocketAddress peerAddress,
                String identity,
                byte[] key)

Deprecated.

Adds a shared key for a peer.

If the key already exists, it will be replaced.

Parameters:

peerAddress - the IP address and port to use the key for

identity - the PSK identity

key - the shared key

Throws:

NullPointerException - if any of the parameters are null.

See Also:

addKnownPeer(InetSocketAddress, PskPublicInformation, byte[])

addKnownPeer

public void addKnownPeer(InetSocketAddress peerAddress,
                PskPublicInformation identity,
                byte[] key)

Deprecated.

Adds a shared key for a peer.

If the key already exists, it will be replaced.

Parameters:

peerAddress - the IP address and port to use the key for

identity - the PSK identity

key - the shared key

Throws:

NullPointerException - if any of the parameters are null.

See Also:

addKnownPeer(InetSocketAddress, String, byte[])

addKnownPeer

public void addKnownPeer(InetSocketAddress peerAddress,
                String virtualHost,
                String identity,
                byte[] key)

Deprecated.

Adds a shared key for a virtual host on a peer.

If the key already exists, it will be replaced. serverNames

Parameters:

peerAddress - the IP address and port to use the key for

virtualHost - the virtual host to use the key for

identity - the PSK identity

key - the shared key

Throws:

NullPointerException - if any of the parameters are null.

See Also:

addKnownPeer(InetSocketAddress, String, PskPublicInformation, byte[])

addKnownPeer

public void addKnownPeer(InetSocketAddress peerAddress,
                String virtualHost,
                PskPublicInformation identity,
                byte[] key)

Deprecated.

Adds a shared key for a virtual host on a peer.

If the key already exists, it will be replaced. serverNames

Parameters:

peerAddress - the IP address and port to use the key for

virtualHost - the virtual host to use the key for

identity - the PSK identity

key - the shared key

Throws:

NullPointerException - if any of the parameters are null.

See Also:

addKnownPeer(InetSocketAddress, String, String, byte[])

removeKey

public void removeKey(String identity)

Deprecated.

Removes a key value for a given identity.

Parameters:

identity - The identity to remove the key for.

See Also:

removeKey(PskPublicInformation, ServerName)

removeKey

public void removeKey(PskPublicInformation identity)

Deprecated.

Removes a key value for a given identity.

Parameters:

identity - The identity to remove the key for.

See Also:

removeKey(PskPublicInformation, ServerName)

removeKey

public void removeKey(String identity,
             String virtualHost)

Deprecated.

Removes a key for an identity scoped to a virtual host.

Parameters:

identity - The identity to remove the key for.

virtualHost - The virtual host to associate the identity and key with.

See Also:

removeKey(PskPublicInformation, ServerName)

removeKey

public void removeKey(PskPublicInformation identity,
             String virtualHost)

Deprecated.

Removes a key for an identity scoped to a virtual host.

Parameters:

identity - The identity to remove the key for.

virtualHost - The virtual host to associate the identity and key with.

See Also:

removeKey(PskPublicInformation, ServerName)

removeKey

public void removeKey(String identity,
             ServerName virtualHost)

Deprecated.

Removes a key for an identity scoped to a virtual host.

Parameters:

identity - The identity to remove the key for.

virtualHost - The virtual host to associate the identity with.

See Also:

removeKey(PskPublicInformation, ServerName)

removeKey

public void removeKey(PskPublicInformation identity,
             ServerName virtualHost)

Deprecated.

Removes a key for an identity scoped to a virtual host.

Parameters:

identity - The identity to remove the key for.

virtualHost - The virtual host to associate the identity with.

getIdentity

public PskPublicInformation getIdentity(InetSocketAddress peerAddress)

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 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.