org.eclipse.californium.scandium.dtls

Class PskPublicInformation

java.lang.Object

org.eclipse.californium.elements.util.Bytes

org.eclipse.californium.scandium.dtls.PskPublicInformation

public final class PskPublicInformation
extends org.eclipse.californium.elements.util.Bytes

Implementation of byte array based PSK public information (hint or identity). Note: RFC 4279, Section 5.1 defines to use UTF-8 to encode the identities. However, some peers seems to use non UTF-8 encoded identities. This byte array based implementation allows to support such non-compliant clients. The string based identity is used for PreSharedKeyIdentity, therefore it's required to use PskPublicInformation(String, byte[]) to setup a proper name for such non-compliant peers in the AdvancedPskStore. During the lookup of the secret key in the handshake, such a non-compliant identity is normalized with the identity provided by the store.

Field Summary

Fields

Modifier and Type	Field and Description
static PskPublicInformation	EMPTY

Constructor Summary

Constructors

Constructor and Description
PskPublicInformation(String publicInfo) Create PSK public information from string (identity or hint).
PskPublicInformation(String publicInfo, byte[] publicInfoBytes) Create PSK public information from string and bytes (identity or hint).

Method Summary

Methods

Modifier and Type	Method and Description
static PskPublicInformation	fromByteArray(byte[] byteArray) Create public information from received byte array.
String	getPublicInfoAsString() Get public information as string.
boolean	isCompliantEncoding() Check, if string is compliant encoded as bytes.
void	normalize(String publicInfo) Normalize public information.
String	toString()

Methods inherited from class org.eclipse.californium.elements.util.Bytes

clear, concatenate, concatenate, createBytes, equals, getAsString, getBytes, hashCode, isEmpty, length

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final PskPublicInformation EMPTY

Constructor Detail

PskPublicInformation

public PskPublicInformation(String publicInfo)

Create PSK public information from string (identity or hint).

Parameters:

publicInfo - PSK public information as string. Identity or hint.

Throws:

NullPointerException - if public information is null

IllegalArgumentException - if public information encoded in UTF-8 is larger than MAX_LENGTH.

PskPublicInformation

public PskPublicInformation(String publicInfo,
                    byte[] publicInfoBytes)

Create PSK public information from string and bytes (identity or hint). Enables to create public information for none-compliant encodings! Note: Please use this with care! Prefer to fix the clients and use it only as temporary work around!

Parameters:

publicInfo - PSK public information as string. Identity or hint.

publicInfoBytes - PSK public information encoded as bytes. Identity or hint.

Throws:

NullPointerException - if one of the parameters are null

IllegalArgumentException - if public information encoded as bytes is larger than MAX_LENGTH.

Method Detail

normalize

public void normalize(String publicInfo)

Normalize public information. Overwrite the decoded string with the intended string. Intended to be used during the PSK lookup and called, if a bytes-matching entry was found. The normalized string could then be used to create a PreSharedKeyIdentity.

Parameters:

publicInfo - PSK public information as string. Identity or hint.

Throws:

NullPointerException - if public information is null

IllegalArgumentException - if public information is empty.

See Also:

AdvancedPskStore.getIdentity(java.net.InetSocketAddress, org.eclipse.californium.scandium.util.ServerNames)

isCompliantEncoding

public boolean isCompliantEncoding()

Check, if string is compliant encoded as bytes.

Returns:

true, if encoding is compliant.

getPublicInfoAsString

public String getPublicInfoAsString()

Get public information as string.

Returns:

public information as string

toString

public String toString()

Overrides:

toString in class org.eclipse.californium.elements.util.Bytes

fromByteArray

public static PskPublicInformation fromByteArray(byte[] byteArray)

Create public information from received byte array.

Parameters:

byteArray - received byte array

Returns:

public information

Throws:

IllegalArgumentException - if public information length is larger than MAX_LENGTH.