org.eclipse.californium.scandium.dtls

Class PskSecretResult

java.lang.Object

org.eclipse.californium.scandium.dtls.HandshakeResult

org.eclipse.californium.scandium.dtls.PskSecretResult

public class PskSecretResult
extends HandshakeResult

Result of PSK secret. On success contains the secret and a normalized psk identity. If failed, only psk identity is contained. The secret must either be a master secret (algorithm "MAC"), or a PSK secret key (algorithm "PSK").

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM_MAC
static String	ALGORITHM_PSK

Constructor Summary

Constructors

Constructor and Description
PskSecretResult(ConnectionId cid, PskPublicInformation pskIdentity, SecretKey secret) Create result.
PskSecretResult(ConnectionId cid, PskPublicInformation pskIdentity, SecretKey secret, Object customArgument) Create result with custom argument for AdvancedApplicationLevelInfoSupplier.

Method Summary

Methods

Modifier and Type	Method and Description
PskPublicInformation	getPskPublicInformation() Get PSK identity.
SecretKey	getSecret() Get master secret (algorithm "MAC"), or PSK secret key (algorithm "PSK").

Methods inherited from class org.eclipse.californium.scandium.dtls.HandshakeResult

getConnectionId, getCustomArgument

Methods inherited from class java.lang.Object

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

Field Detail

ALGORITHM_PSK

public static final String ALGORITHM_PSK

See Also:

Constant Field Values

ALGORITHM_MAC

public static final String ALGORITHM_MAC

See Also:

Constant Field Values

Constructor Detail

PskSecretResult

public PskSecretResult(ConnectionId cid,
               PskPublicInformation pskIdentity,
               SecretKey secret)

Create result.

Parameters:

cid - connection id

pskIdentity - PSK identity

secret - secret, null, if generation failed. Algorithm must be "MAC" or "PSK".

Throws:

IllegalArgumentException - if algorithm is neither "MAC" nor "PSK"

NullPointerException - if cid or pskIdentity is null

PskSecretResult

public PskSecretResult(ConnectionId cid,
               PskPublicInformation pskIdentity,
               SecretKey secret,
               Object customArgument)

Create result with custom argument for AdvancedApplicationLevelInfoSupplier.

Parameters:

cid - connection id

pskIdentity - PSK identity

secret - secret, null, if generation failed. Algorithm must be "MAC" or "PSK".

customArgument - custom argument. May be null. Passed to AdvancedApplicationLevelInfoSupplier by the Handshaker, if a AdvancedApplicationLevelInfoSupplier is available.

Throws:

IllegalArgumentException - if algorithm is neither "MAC" nor "PSK"

NullPointerException - if cid or pskIdentity is null

Method Detail

getPskPublicInformation

public PskPublicInformation getPskPublicInformation()

Get PSK identity. On success, normalized.

Returns:

SPK identity.

getSecret

public SecretKey getSecret()

Get master secret (algorithm "MAC"), or PSK secret key (algorithm "PSK").

Returns:

secret, null, if not available.