org.conscrypt

Class Conscrypt.Sockets

java.lang.Object

org.conscrypt.Conscrypt.Sockets

Enclosing class:

Conscrypt

public static final class Conscrypt.Sockets
extends Object

Utility methods for configuring Conscrypt sockets.

Method Summary

Modifier and Type	Method and Description
static String	getAlpnSelectedProtocol(SSLSocket socket) Returns the ALPN protocol agreed upon by client and server.
static byte[]	getChannelId(SSLSocket socket) Gets the TLS Channel ID for the given server-side socket.
static String	getHostname(SSLSocket socket) Returns either the hostname supplied during socket creation or via Conscrypt.Sockets.setHostname(SSLSocket, String).
static String	getHostnameOrIP(SSLSocket socket) This method attempts to create a textual representation of the peer host or IP.
static boolean	isConscrypt(SSLSocket socket) Indicates whether the given socket is a Conscrypt socket.
static void	setAlpnProtocols(SSLSocket socket, String[] alpnProtocols) Sets the list of ALPN protocols supported by the socket.
static void	setChannelIdEnabled(SSLSocket socket, boolean enabled) Enables/disables TLS Channel ID for the given server-side socket.
static void	setChannelIdPrivateKey(SSLSocket socket, PrivateKey privateKey) Sets the PrivateKey to be used for TLS Channel ID by this client socket.
static void	setHostname(SSLSocket socket, String hostname) This method enables Server Name Indication (SNI) and overrides the hostname supplied during socket creation.
static void	setUseSessionTickets(SSLSocket socket, boolean useSessionTickets) This method enables session ticket support.

Methods inherited from class java.lang.Object

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

Method Detail

isConscrypt

public static boolean isConscrypt(SSLSocket socket)

Indicates whether the given socket is a Conscrypt socket.

setHostname

public static void setHostname(SSLSocket socket,
                               String hostname)

This method enables Server Name Indication (SNI) and overrides the hostname supplied during socket creation.

Parameters:

socket - the socket

hostname - the desired SNI hostname, or null to disable

getHostname

public static String getHostname(SSLSocket socket)

Returns either the hostname supplied during socket creation or via Conscrypt.Sockets.setHostname(SSLSocket, String). No DNS resolution is attempted before returning the hostname.

getHostnameOrIP

public static String getHostnameOrIP(SSLSocket socket)

This method attempts to create a textual representation of the peer host or IP. Does not perform a reverse DNS lookup. This is typically used during session creation.

setUseSessionTickets

public static void setUseSessionTickets(SSLSocket socket,
                                        boolean useSessionTickets)

This method enables session ticket support.

Parameters:

socket - the socket

useSessionTickets - True to enable session tickets

setChannelIdEnabled

public static void setChannelIdEnabled(SSLSocket socket,
                                       boolean enabled)

Enables/disables TLS Channel ID for the given server-side socket.

This method needs to be invoked before the handshake starts.

Parameters:

socket - the socket

enabled - Whether to enable channel ID.

Throws:

IllegalStateException - if this is a client socket or if the handshake has already started.

getChannelId

public static byte[] getChannelId(SSLSocket socket)
                           throws SSLException

Gets the TLS Channel ID for the given server-side socket. Channel ID is only available once the handshake completes.

Parameters:

socket - the socket

Returns:

channel ID or null if not available.

Throws:

IllegalStateException - if this is a client socket or if the handshake has not yet completed.

SSLException - if channel ID is available but could not be obtained.

setChannelIdPrivateKey

public static void setChannelIdPrivateKey(SSLSocket socket,
                                          PrivateKey privateKey)

Sets the PrivateKey to be used for TLS Channel ID by this client socket.

This method needs to be invoked before the handshake starts.

Parameters:

socket - the socket

privateKey - private key (enables TLS Channel ID) or null for no key (disables TLS Channel ID). The private key must be an Elliptic Curve (EC) key based on the NIST P-256 curve (aka SECG secp256r1 or ANSI X9.62 prime256v1).

Throws:

IllegalStateException - if this is a server socket or if the handshake has already started.

getAlpnSelectedProtocol

public static String getAlpnSelectedProtocol(SSLSocket socket)

Returns the ALPN protocol agreed upon by client and server.

Parameters:

socket - the socket

Returns:

the selected protocol or null if no protocol was agreed upon.

setAlpnProtocols

public static void setAlpnProtocols(SSLSocket socket,
                                    String[] alpnProtocols)

Sets the list of ALPN protocols supported by the socket.

Parameters:

socket - the socket

alpnProtocols - the list of ALPN protocols