Package org.conscrypt

Class OpenSSLSocketImpl

java.lang.Object

java.net.Socket

javax.net.ssl.SSLSocket

org.conscrypt.AbstractConscryptSocket

org.conscrypt.OpenSSLSocketImpl

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ConscryptEngineSocket, ConscryptFileDescriptorSocket

@Internal
public abstract class OpenSSLSocketImpl
extends AbstractConscryptSocket

Public shim allowing us to stay backward-compatible with legacy applications which were using Conscrypt's extended socket API before the introduction of the Conscrypt class.

Field Summary

Fields inherited from class org.conscrypt.AbstractConscryptSocket

socket

Constructor Summary

Constructors

Constructor	Description
OpenSSLSocketImpl()
OpenSSLSocketImpl(java.lang.String hostname, int port)
OpenSSLSocketImpl(java.lang.String hostname, int port, java.net.InetAddress clientAddress, int clientPort)
OpenSSLSocketImpl(java.net.InetAddress address, int port)
OpenSSLSocketImpl(java.net.InetAddress address, int port, java.net.InetAddress clientAddress, int clientPort)
OpenSSLSocketImpl(java.net.Socket socket, java.lang.String hostname, int port, boolean autoClose)

Method Summary

Modifier and Type	Method	Description
byte[]	getAlpnSelectedProtocol()	Deprecated. use AbstractConscryptSocket.getApplicationProtocol() instead.
abstract byte[]	getChannelId()	Gets the TLS Channel ID for this server socket.
java.io.FileDescriptor	getFileDescriptor$()
abstract javax.net.ssl.SSLSession	getHandshakeSession()
java.lang.String	getHostname()	Returns the hostname that was supplied during socket creation.
java.lang.String	getHostnameOrIP()	For the purposes of an SSLSession, we want a way to represent the supplied hostname or the IP address in a textual representation.
byte[]	getNpnSelectedProtocol()	Deprecated. NPN is not supported
int	getSoWriteTimeout()	Note write timeouts are not part of the javax.net.ssl.SSLSocket API
void	setAlpnProtocols(byte[] protocols)	Deprecated. Use setAlpnProtocols(String[]) instead.
void	setAlpnProtocols(java.lang.String[] alpnProtocols)	Deprecated. use AbstractConscryptSocket.setApplicationProtocols(String[]) instead.
abstract void	setChannelIdEnabled(boolean enabled)	Enables/disables TLS Channel ID for this server socket.
abstract void	setChannelIdPrivateKey(java.security.PrivateKey privateKey)	Sets the PrivateKey to be used for TLS Channel ID by this client socket.
void	setHandshakeTimeout(int handshakeTimeoutMilliseconds)	Set the handshake timeout on this socket.
void	setHostname(java.lang.String hostname)	This method enables Server Name Indication
void	setNpnProtocols(byte[] npnProtocols)	Deprecated. NPN is not supported
void	setSoWriteTimeout(int writeTimeoutMilliseconds)	Note write timeouts are not part of the javax.net.ssl.SSLSocket API
abstract void	setUseSessionTickets(boolean useSessionTickets)	This method enables session ticket support.

Methods inherited from class org.conscrypt.AbstractConscryptSocket

addHandshakeCompletedListener, bind, checkOpen, close, connect, connect, exportKeyingMaterial, getActiveSession, getApplicationProtocol, getApplicationProtocols, getChannel, getHandshakeApplicationProtocol, getInetAddress, getInputStream, getKeepAlive, getLocalAddress, getLocalPort, getLocalSocketAddress, getOOBInline, getOutputStream, getPort, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTcpNoDelay, getTlsUnique, getTrafficClass, isBound, isClosed, isConnected, isInputShutdown, isOutputShutdown, notifyHandshakeCompletedListeners, peerInfoProvider, removeHandshakeCompletedListener, sendUrgentData, setApplicationProtocols, setApplicationProtocolSelector, setApplicationProtocolSelector, setKeepAlive, setOOBInline, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSoLinger, setSoTimeout, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, toString

Methods inherited from class javax.net.ssl.SSLSocket

getEnabledCipherSuites, getEnabledProtocols, getEnableSessionCreation, getHandshakeApplicationProtocolSelector, getNeedClientAuth, getSession, getSSLParameters, getSupportedCipherSuites, getSupportedProtocols, getUseClientMode, getWantClientAuth, setEnabledCipherSuites, setEnabledProtocols, setEnableSessionCreation, setHandshakeApplicationProtocolSelector, setNeedClientAuth, setSSLParameters, setUseClientMode, setWantClientAuth, startHandshake

Methods inherited from class java.net.Socket

getOption, setOption, setSocketImplFactory, supportedOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSSLSocketImpl

OpenSSLSocketImpl()
           throws java.io.IOException

Throws:

java.io.IOException

OpenSSLSocketImpl

OpenSSLSocketImpl(java.lang.String hostname,
                  int port)
           throws java.io.IOException

Throws:

java.io.IOException

OpenSSLSocketImpl

OpenSSLSocketImpl(java.net.InetAddress address,
                  int port)
           throws java.io.IOException

Throws:

java.io.IOException

OpenSSLSocketImpl

OpenSSLSocketImpl(java.lang.String hostname,
                  int port,
                  java.net.InetAddress clientAddress,
                  int clientPort)
           throws java.io.IOException

Throws:

java.io.IOException

OpenSSLSocketImpl

OpenSSLSocketImpl(java.net.InetAddress address,
                  int port,
                  java.net.InetAddress clientAddress,
                  int clientPort)
           throws java.io.IOException

Throws:

java.io.IOException

OpenSSLSocketImpl

OpenSSLSocketImpl(java.net.Socket socket,
                  java.lang.String hostname,
                  int port,
                  boolean autoClose)
           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getHostname

public java.lang.String getHostname()

Description copied from class: AbstractConscryptSocket

Returns the hostname that was supplied during socket creation. No DNS resolution is attempted before returning the hostname.

Overrides:

getHostname in class AbstractConscryptSocket

setHostname

public void setHostname(java.lang.String hostname)

Description copied from class: AbstractConscryptSocket

This method enables Server Name Indication

Overrides:

setHostname in class AbstractConscryptSocket

Parameters:

hostname - the desired SNI hostname, or null to disable

getHostnameOrIP

public java.lang.String getHostnameOrIP()

Description copied from class: AbstractConscryptSocket

For the purposes of an SSLSession, we want a way to represent the supplied hostname or the IP address in a textual representation. We do not want to perform reverse DNS lookups on this address.

Overrides:

getHostnameOrIP in class AbstractConscryptSocket

getFileDescriptor$

public java.io.FileDescriptor getFileDescriptor$()

Overrides:

getFileDescriptor$ in class AbstractConscryptSocket

setSoWriteTimeout

public void setSoWriteTimeout(int writeTimeoutMilliseconds)
                       throws java.net.SocketException

Description copied from class: AbstractConscryptSocket

Note write timeouts are not part of the javax.net.ssl.SSLSocket API

Overrides:

setSoWriteTimeout in class AbstractConscryptSocket

Throws:

java.net.SocketException

getSoWriteTimeout

public int getSoWriteTimeout()
                      throws java.net.SocketException

Description copied from class: AbstractConscryptSocket

Note write timeouts are not part of the javax.net.ssl.SSLSocket API

Overrides:

getSoWriteTimeout in class AbstractConscryptSocket

Throws:

java.net.SocketException

setHandshakeTimeout

public void setHandshakeTimeout(int handshakeTimeoutMilliseconds)
                         throws java.net.SocketException

Description copied from class: AbstractConscryptSocket

Set the handshake timeout on this socket. This timeout is specified in milliseconds and will be used only during the handshake process.

Overrides:

setHandshakeTimeout in class AbstractConscryptSocket

Throws:

java.net.SocketException

getHandshakeSession

public abstract javax.net.ssl.SSLSession getHandshakeSession()

Specified by:

getHandshakeSession in class AbstractConscryptSocket

setUseSessionTickets

public abstract void setUseSessionTickets(boolean useSessionTickets)

Description copied from class: AbstractConscryptSocket

This method enables session ticket support.

Specified by:

setUseSessionTickets in class AbstractConscryptSocket

Parameters:

useSessionTickets - True to enable session tickets

setChannelIdEnabled

public abstract void setChannelIdEnabled(boolean enabled)

Description copied from class: AbstractConscryptSocket

Enables/disables TLS Channel ID for this server socket.

This method needs to be invoked before the handshake starts.

Specified by:

setChannelIdEnabled in class AbstractConscryptSocket

getChannelId

public abstract byte[] getChannelId()
                             throws javax.net.ssl.SSLException

Description copied from class: AbstractConscryptSocket

Gets the TLS Channel ID for this server socket. Channel ID is only available once the handshake completes.

Specified by:

getChannelId in class AbstractConscryptSocket

Returns:

channel ID or null if not available.

Throws:

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

setChannelIdPrivateKey

public abstract void setChannelIdPrivateKey(java.security.PrivateKey privateKey)

Description copied from class: AbstractConscryptSocket

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

This method needs to be invoked before the handshake starts.

Specified by:

setChannelIdPrivateKey in class AbstractConscryptSocket

Parameters:

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).

getNpnSelectedProtocol

@Deprecated
public final byte[] getNpnSelectedProtocol()

Deprecated.

NPN is not supported

Description copied from class: AbstractConscryptSocket

Returns null always for backward compatibility.

Overrides:

getNpnSelectedProtocol in class AbstractConscryptSocket

setNpnProtocols

@Deprecated
public final void setNpnProtocols(byte[] npnProtocols)

Deprecated.

NPN is not supported

Description copied from class: AbstractConscryptSocket

This method does nothing and is kept for backward compatibility.

Overrides:

setNpnProtocols in class AbstractConscryptSocket

setAlpnProtocols

@Deprecated
public final void setAlpnProtocols(java.lang.String[] alpnProtocols)

Deprecated.

use AbstractConscryptSocket.setApplicationProtocols(String[]) instead.

Description copied from class: AbstractConscryptSocket

Sets the list of ALPN protocols. This method internally converts the protocols to their wire-format form.

Specified by:

setAlpnProtocols in class AbstractConscryptSocket

Parameters:

alpnProtocols - the list of ALPN protocols

getAlpnSelectedProtocol

@Deprecated
public final byte[] getAlpnSelectedProtocol()

Deprecated.

use AbstractConscryptSocket.getApplicationProtocol() instead.

Description copied from class: AbstractConscryptSocket

Returns the protocol agreed upon by client and server, or null if no protocol was agreed upon.

Specified by:

getAlpnSelectedProtocol in class AbstractConscryptSocket

setAlpnProtocols

@Deprecated
public final void setAlpnProtocols(byte[] protocols)

Deprecated.

Use setAlpnProtocols(String[]) instead.

Description copied from class: AbstractConscryptSocket

Alternate version of AbstractConscryptSocket.setAlpnProtocols(String[]) that directly sets the list of ALPN in the wire-format form used by BoringSSL (length-prefixed 8-bit strings). Requires that all strings be encoded with US-ASCII.

Specified by:

setAlpnProtocols in class AbstractConscryptSocket

Parameters:

protocols - the encoded form of the ALPN protocol list