public class SSLCertificateSocketFactory extends SSLSocketFactory
SSLSessionCache
createSocket()
and Socket.connect(SocketAddress, int), after which you
must verify the identity of the server you are connected to.
Most SSLSocketFactory implementations do not
verify the server's identity, allowing man-in-the-middle attacks.
This implementation does check the server's certificate hostname, but only
for createSocket variants that specify a hostname. When using methods that
use InetAddress or which return an unconnected socket, you MUST
verify the server's identity yourself to ensure a secure connection.
One way to verify the server's identity is to use
HttpsURLConnection.getDefaultHostnameVerifier() to get a
HostnameVerifier to verify the certificate hostname.
On development devices, "setprop socket.relaxsslcheck yes" bypasses all SSL certificate and hostname checks for testing purposes. This setting requires root access.
| Constructor and Description |
|---|
SSLCertificateSocketFactory(int handshakeTimeoutMillis)
Deprecated.
Use
getDefault(int) instead. |
| Modifier and Type | Method and Description |
|---|---|
Socket |
createSocket()
Creates a new socket which is not connected to any remote host.
|
Socket |
createSocket(InetAddress addr,
int port)
Creates a new socket which is connected to the remote host specified by
the InetAddress
host. |
Socket |
createSocket(InetAddress addr,
int port,
InetAddress localAddr,
int localPort)
Creates a new socket which is connected to the remote host specified by
the InetAddress
address. |
Socket |
createSocket(Socket k,
String host,
int port,
boolean close)
Creates an
SSLSocket over the specified socket that is connected
to the specified host at the specified port. |
Socket |
createSocket(String host,
int port)
Creates a new socket which is connected to the remote host specified by
the parameters
host and port. |
Socket |
createSocket(String host,
int port,
InetAddress localAddr,
int localPort)
Creates a new socket which is connected to the remote host specified by
the parameters
host and port. |
static SocketFactory |
getDefault(int handshakeTimeoutMillis)
Returns a new socket factory instance with an optional handshake timeout.
|
static SSLSocketFactory |
getDefault(int handshakeTimeoutMillis,
SSLSessionCache cache)
Returns a new socket factory instance with an optional handshake timeout
and SSL session cache.
|
String[] |
getDefaultCipherSuites()
Returns the names of the cipher suites that are enabled by default.
|
static org.apache.http.conn.ssl.SSLSocketFactory |
getHttpSocketFactory(int handshakeTimeoutMillis,
SSLSessionCache cache)
Returns a socket factory (also named SSLSocketFactory, but in a different
namespace) for use with the Apache HTTP stack.
|
static SSLSocketFactory |
getInsecure(int handshakeTimeoutMillis,
SSLSessionCache cache)
Returns a new instance of a socket factory with all SSL security checks
disabled, using an optional handshake timeout and SSL session cache.
|
byte[] |
getNpnSelectedProtocol(Socket socket)
Returns the Next
Protocol Negotiation (NPN) protocol selected by client and server, or
null if no protocol was negotiated.
|
String[] |
getSupportedCipherSuites()
Returns the names of the cipher suites that are supported and could be
enabled for an SSL connection.
|
void |
setHostname(Socket socket,
String hostName)
Turns on Server
Name Indication (SNI) on a given socket.
|
void |
setKeyManagers(KeyManager[] keyManagers)
Sets the
KeyManagers to be used for connections made by this factory. |
void |
setNpnProtocols(byte[][] npnProtocols)
Sets the Next
Protocol Negotiation (NPN) protocols that this peer is interested in.
|
void |
setSoWriteTimeout(Socket socket,
int writeTimeoutMilliseconds)
Sets this socket's SO_SNDTIMEO write timeout in milliseconds.
|
void |
setTrustManagers(TrustManager[] trustManager)
Sets the
TrustManagers to be used for connections made by this factory. |
void |
setUseSessionTickets(Socket socket,
boolean useSessionTickets)
Enables session ticket
support on the given socket.
|
static void |
verifyHostname(Socket socket,
String hostname)
Verify the hostname of the certificate used by the other end of a
connected socket.
|
getDefault@Deprecated public SSLCertificateSocketFactory(int handshakeTimeoutMillis)
getDefault(int) instead.public static SocketFactory getDefault(int handshakeTimeoutMillis)
handshakeTimeoutMillis - to use for SSL connection handshake, or 0
for none. The socket timeout is reset to 0 after the handshake.public static SSLSocketFactory getDefault(int handshakeTimeoutMillis, SSLSessionCache cache)
handshakeTimeoutMillis - to use for SSL connection handshake, or 0
for none. The socket timeout is reset to 0 after the handshake.cache - The SSLSessionCache to use, or null for no cache.public static SSLSocketFactory getInsecure(int handshakeTimeoutMillis, SSLSessionCache cache)
Warning: Sockets created using this factory are vulnerable to man-in-the-middle attacks!
handshakeTimeoutMillis - to use for SSL connection handshake, or 0
for none. The socket timeout is reset to 0 after the handshake.cache - The SSLSessionCache to use, or null for no cache.public static org.apache.http.conn.ssl.SSLSocketFactory getHttpSocketFactory(int handshakeTimeoutMillis,
SSLSessionCache cache)
handshakeTimeoutMillis - to use for SSL connection handshake, or 0
for none. The socket timeout is reset to 0 after the handshake.cache - The SSLSessionCache to use, or null for no cache.public static void verifyHostname(Socket socket, String hostname) throws IOException
createSocket(). It is harmless to call this method
redundantly if the hostname has already been verified.
Wildcard certificates are allowed to verify any matching hostname, so "foo.bar.example.com" is verified if the peer has a certificate for "*.example.com".
socket - An SSL socket which has been connected to a serverhostname - The expected hostname of the remote serverIOException - if something goes wrong handshaking with the serverSSLPeerUnverifiedException - if the server cannot prove its identitypublic void setTrustManagers(TrustManager[] trustManager)
TrustManagers to be used for connections made by this factory.public void setNpnProtocols(byte[][] npnProtocols)
For servers this is the sequence of protocols to advertise as supported, in order of preference. This list is sent unencrypted to all clients that support NPN.
For clients this is a list of supported protocols to match against the server's list. If there is no protocol supported by both client and server then the first protocol in the client's list will be selected. The order of the client's protocols is otherwise insignificant.
npnProtocols - a non-empty list of protocol byte arrays. All arrays
must be non-empty and of length less than 256.public byte[] getNpnSelectedProtocol(Socket socket)
socket - a socket created by this factory.IllegalArgumentException - if the socket was not created by this factory.public void setKeyManagers(KeyManager[] keyManagers)
KeyManagers to be used for connections made by this factory.public void setUseSessionTickets(Socket socket, boolean useSessionTickets)
socket - a socket created by this factoryuseSessionTickets - true to enable session ticket support on this socket.IllegalArgumentException - if the socket was not created by this factory.public void setHostname(Socket socket, String hostName)
socket - a socket created by this factory.hostName - the desired SNI hostname, null to disable.IllegalArgumentException - if the socket was not created by this factory.public void setSoWriteTimeout(Socket socket, int writeTimeoutMilliseconds) throws SocketException
socket - a socket created by this factory.timeout - the desired write timeout in milliseconds.IllegalArgumentException - if the socket was not created by this factory.SocketExceptionpublic Socket createSocket(Socket k, String host, int port, boolean close) throws IOException
SSLSocket over the specified socket that is connected
to the specified host at the specified port.
This method verifies the peer's certificate hostname after connecting
(unless created with getInsecure(int, SSLSessionCache)).
createSocket in class SSLSocketFactoryk - the socket.host - the host.port - the port number.close - true if socket s should be closed when the
created socket is closed, false if the socket
s should be left open.IOException - if creating the socket fails.UnknownHostException - if the host is unknown.public Socket createSocket() throws IOException
Socket.connect(java.net.SocketAddress) to connect the socket.
Warning: Hostname verification is not performed with this method. You MUST verify the server's identity after connecting the socket to avoid man-in-the-middle attacks.
createSocket in class SocketFactoryIOException - if an error occurs while creating a new socket.public Socket createSocket(InetAddress addr, int port, InetAddress localAddr, int localPort) throws IOException
address. The socket is bound to the local network
interface specified by the InetAddress localHost on port localPort.
Warning: Hostname verification is not performed with this method. You MUST verify the server's identity after connecting the socket to avoid man-in-the-middle attacks.
createSocket in class SocketFactoryaddr - the remote host address the socket has to be connected to.port - the port number of the remote host at which the socket is
connected.localAddr - the local host address the socket is bound to.localPort - the port number of the local host at which the socket is
bound.IOException - if an error occurs while creating a new socket.public Socket createSocket(InetAddress addr, int port) throws IOException
host. The socket is bound to any available local
address and port.
Warning: Hostname verification is not performed with this method. You MUST verify the server's identity after connecting the socket to avoid man-in-the-middle attacks.
createSocket in class SocketFactoryaddr - the host address the socket has to be connected to.port - the port number of the remote host at which the socket is
connected.IOException - if an error occurs while creating a new socket.public Socket createSocket(String host, int port, InetAddress localAddr, int localPort) throws IOException
host and port. The socket is bound to the
local network interface specified by the InetAddress localHost on
port localPort.
This method verifies the peer's certificate hostname after connecting
(unless created with getInsecure(int, SSLSessionCache)).
createSocket in class SocketFactoryhost - the remote host address the socket has to be connected to.port - the port number of the remote host at which the socket is
connected.localAddr - the local host address the socket is bound to.localPort - the port number of the local host at which the socket is
bound.IOException - if an error occurs while creating a new socket.UnknownHostException - if the specified host is unknown or the IP address could not
be resolved.public Socket createSocket(String host, int port) throws IOException
host and port. The socket is bound to any
available local address and port.
This method verifies the peer's certificate hostname after connecting
(unless created with getInsecure(int, SSLSessionCache)).
createSocket in class SocketFactoryhost - the remote host address the socket has to be connected to.port - the port number of the remote host at which the socket is
connected.IOException - if an error occurs while creating a new socket.UnknownHostException - if the specified host is unknown or the IP address could not
be resolved.public String[] getDefaultCipherSuites()
SSLSocketFactorygetDefaultCipherSuites in class SSLSocketFactorypublic String[] getSupportedCipherSuites()
SSLSocketFactorygetSupportedCipherSuites in class SSLSocketFactory