com.oracle.ssl

Interface PSKCredentials

public interface PSKCredentials

This interface should be implemented by application to provide PSK credentials for use with pre-shared key based cipher suites (RFC 4279). PSK credentials associates pre-shared key with remote peer id: - Identity hint is used by server side to help the client in selecting which identity to use - Identity is used to uniquely identify the pre-shared key Cipher suites that use symmetric keys, shared in advance among the communicating parties, to establish a TLS connection: TLS_PSK_WITH_3DES_EDE_CBC_SHA, TLS_PSK_WITH_AES_128_CBC_SHA, TLS_PSK_WITH_AES_256_CBC_SHA

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIdentity(java.lang.String identityHint, java.lang.String peerAddress, int peerPort) Set Identity of the client to identify pre-shared key This method is called by runtime during TLS/DTLS handshake on the client side to ask application about PSK identity to use for this connection.
java.lang.String	getIdentityHint(java.lang.String peerAddress, int peerPort) Set identity hint to help the client in selecting which identity to use.
byte[]	getPSK(java.lang.String identity) Set pre-shared key This method is called by runtime during TLS/DTLS handshake on the client and server side to ask application about pre-shared key to use for this connection.

Method Detail

getIdentityHint

java.lang.String getIdentityHint(java.lang.String peerAddress,
                                 int peerPort)
                          throws java.net.UnknownHostException

Set identity hint to help the client in selecting which identity to use. This method is called by runtime during TLS/DTLS handshake on the server side to ask application about identity hint to use for this connection. Application can use peerAddress, peerPort to calculate appropriate identity hint

Parameters:

peerAddress - - the address of the client to which this server connection is bound

peerPort - - the port number of the client to which this server connection is bound

Returns:

UTF-8 encoded string representing identity hint or NULL if no identity hint should be used

Throws:

java.net.UnknownHostException - to decline connection from specified peer address

getIdentity

java.lang.String getIdentity(java.lang.String identityHint,
                             java.lang.String peerAddress,
                             int peerPort)
                      throws java.net.UnknownHostException

Set Identity of the client to identify pre-shared key This method is called by runtime during TLS/DTLS handshake on the client side to ask application about PSK identity to use for this connection. Application can use peerAddress, peerPort and identity hint from the server to calculate appropriate PSK identity

Parameters:

identityHint - - identity hint from the server or null

peerAddress - - the address of the server to which this connection is bound

peerPort - - the port number of the server to which this connection is bound

Returns:

UTF-8 encoded string representing psk identity up to 128 octets in length

Throws:

java.net.UnknownHostException - to decline connection from specified peer address

getPSK

byte[] getPSK(java.lang.String identity)

Set pre-shared key This method is called by runtime during TLS/DTLS handshake on the client and server side to ask application about pre-shared key to use for this connection. Application can use identity value to calculate appropriate pre-shared key

Parameters:

identity - - psk identity for requested pre-shared key

Returns:

pre-shared key up to 64 octets in length or NULL for unknown identity