Package org.conscrypt

Class DuckTypedPSKKeyManager

java.lang.Object

org.conscrypt.DuckTypedPSKKeyManager

All Implemented Interfaces:

KeyManager, PSKKeyManager

public class DuckTypedPSKKeyManager
extends Object
implements PSKKeyManager

Reflection-based PSKKeyManager adaptor for objects which expose all the methods of the PSKKeyManager interface but do not implement the interface.

This is expected to be useful on platforms where there are multiple instances of the PSKKeyManager interface.

Field Summary

Fields inherited from interface org.conscrypt.PSKKeyManager

MAX_IDENTITY_HINT_LENGTH_BYTES, MAX_IDENTITY_LENGTH_BYTES, MAX_KEY_LENGTH_BYTES

Method Summary

Modifier and Type	Method	Description
String	chooseClientKeyIdentity(String identityHint, Socket socket)	Gets the PSK identity to report to the server to help agree on the PSK for the provided socket.
String	chooseClientKeyIdentity(String identityHint, SSLEngine engine)	Gets the PSK identity to report to the server to help agree on the PSK for the provided engine.
String	chooseServerKeyIdentityHint(Socket socket)	Gets the PSK identity hint to report to the client to help agree on the PSK for the provided socket.
String	chooseServerKeyIdentityHint(SSLEngine engine)	Gets the PSK identity hint to report to the client to help agree on the PSK for the provided engine.
static DuckTypedPSKKeyManager	getInstance(Object obj)	Gets an instance of DuckTypedPSKKeyManager which delegates all invocations of methods of the PSKKeyManager interface to the same methods of the provided object.
SecretKey	getKey(String identityHint, String identity, Socket socket)	Gets the PSK to use for the provided socket.
SecretKey	getKey(String identityHint, String identity, SSLEngine engine)	Gets the PSK to use for the provided engine.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DuckTypedPSKKeyManager getInstance(Object obj)
                                          throws NoSuchMethodException

Gets an instance of DuckTypedPSKKeyManager which delegates all invocations of methods of the PSKKeyManager interface to the same methods of the provided object.

Throws:

NoSuchMethodException - if obj does not implement a method of the PSKKeyManager interface.

chooseServerKeyIdentityHint

public String chooseServerKeyIdentityHint(Socket socket)

Description copied from interface: PSKKeyManager

Gets the PSK identity hint to report to the client to help agree on the PSK for the provided socket.

Specified by:

chooseServerKeyIdentityHint in interface PSKKeyManager

Returns:

PSK identity hint to be provided to the client or null to provide no hint.

chooseServerKeyIdentityHint

public String chooseServerKeyIdentityHint(SSLEngine engine)

Description copied from interface: PSKKeyManager

Gets the PSK identity hint to report to the client to help agree on the PSK for the provided engine.

Specified by:

chooseServerKeyIdentityHint in interface PSKKeyManager

Returns:

PSK identity hint to be provided to the client or null to provide no hint.

chooseClientKeyIdentity

public String chooseClientKeyIdentity(String identityHint,
                                      Socket socket)

Description copied from interface: PSKKeyManager

Gets the PSK identity to report to the server to help agree on the PSK for the provided socket.

Specified by:

chooseClientKeyIdentity in interface PSKKeyManager

Parameters:

identityHint - identity hint provided by the server or null if none provided.

Returns:

PSK identity to provide to the server. null is permitted but will be converted into an empty string.

chooseClientKeyIdentity

public String chooseClientKeyIdentity(String identityHint,
                                      SSLEngine engine)

Description copied from interface: PSKKeyManager

Gets the PSK identity to report to the server to help agree on the PSK for the provided engine.

Specified by:

chooseClientKeyIdentity in interface PSKKeyManager

Parameters:

identityHint - identity hint provided by the server or null if none provided.

Returns:

PSK identity to provide to the server. null is permitted but will be converted into an empty string.

getKey

public SecretKey getKey(String identityHint,
                        String identity,
                        Socket socket)

Description copied from interface: PSKKeyManager

Gets the PSK to use for the provided socket.

Specified by:

getKey in interface PSKKeyManager

Parameters:

identityHint - identity hint provided by the server to help select the key or null if none provided.

identity - identity provided by the client to help select the key.

Returns:

key or null to signal to peer that no suitable key is available and to abort the handshake.

getKey

public SecretKey getKey(String identityHint,
                        String identity,
                        SSLEngine engine)

Description copied from interface: PSKKeyManager

Gets the PSK to use for the provided engine.

Specified by:

getKey in interface PSKKeyManager

Parameters:

identityHint - identity hint provided by the server to help select the key or null if none provided.

identity - identity provided by the client to help select the key.

Returns:

key or null to signal to peer that no suitable key is available and to abort the handshake.