public class SSLConnectionSocketFactory
extends java.lang.Object
implements cz.msebera.android.httpclient.conn.socket.LayeredConnectionSocketFactory
SSLSocketFactory can be used to validate the identity of the HTTPS server against a list of trusted certificates and to authenticate to the HTTPS server using a private key.
SSLSocketFactory will enable server authentication when supplied with
a trust-store file containing one or several trusted certificates. The client
secure socket will reject the connection during the SSL session handshake if the target HTTPS
server attempts to authenticate itself with a non-trusted certificate.
Use JDK keytool utility to import a trusted certificate and generate a trust-store file:
keytool -import -alias "my server cert" -file server.crt -keystore my.truststore
In special cases the standard trust verification process can be bypassed by using a custom
org.apache.http.conn.ssl.TrustStrategy. This interface is primarily intended for allowing self-signed
certificates to be accepted as trusted without having to add them to the trust-store file.
SSLSocketFactory will enable client authentication when supplied with
a key-store file containing a private key/public certificate
pair. The client secure socket will use the private key to authenticate
itself to the target HTTPS server during the SSL session handshake if
requested to do so by the server.
The target HTTPS server will in its turn verify the certificate presented
by the client in order to establish client's authenticity.
Use the following sequence of actions to generate a key-store file
Use JDK keytool utility to generate a new key
keytool -genkey -v -alias "my client key" -validity 365 -keystore my.keystore
For simplicity use the same password for the key as that of the key-store
Issue a certificate signing request (CSR)
keytool -certreq -alias "my client key" -file mycertreq.csr -keystore my.keystore
Send the certificate request to the trusted Certificate Authority for signature. One may choose to act as her own CA and sign the certificate request using a PKI tool, such as OpenSSL.
Import the trusted CA root certificate
keytool -import -alias "my trusted ca" -file caroot.crt -keystore my.keystore
Import the PKCS#7 file containing the complete certificate chain
keytool -import -alias "my client key" -file mycert.p7 -keystore my.keystore
Verify the content of the resultant keystore file
keytool -list -v -keystore my.keystore
| Constructor and Description |
|---|
SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext) |
SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
javax.net.ssl.HostnameVerifier hostnameVerifier) |
SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
javax.net.ssl.HostnameVerifier hostnameVerifier) |
SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
Deprecated.
|
SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
Deprecated.
|
SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
javax.net.ssl.HostnameVerifier hostnameVerifier) |
SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
javax.net.ssl.HostnameVerifier hostnameVerifier) |
SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
|
SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
java.net.Socket |
connectSocket(int connectTimeout,
java.net.Socket socket,
cz.msebera.android.httpclient.HttpHost host,
java.net.InetSocketAddress remoteAddress,
java.net.InetSocketAddress localAddress,
cz.msebera.android.httpclient.protocol.HttpContext context) |
java.net.Socket |
createLayeredSocket(java.net.Socket socket,
java.lang.String target,
int port,
cz.msebera.android.httpclient.protocol.HttpContext context) |
java.net.Socket |
createSocket(cz.msebera.android.httpclient.protocol.HttpContext context) |
static javax.net.ssl.HostnameVerifier |
getDefaultHostnameVerifier() |
static SSLConnectionSocketFactory |
getSocketFactory()
Obtains default SSL socket factory with an SSL context based on the standard JSSE
trust material (
cacerts file in the security properties directory). |
static SSLConnectionSocketFactory |
getSystemSocketFactory()
Obtains default SSL socket factory with an SSL context based on system properties
as described in
Java™ Secure Socket Extension (JSSE) Reference Guide.
|
protected void |
prepareSocket(javax.net.ssl.SSLSocket socket)
Performs any custom initialization for a newly created SSLSocket
(before the SSL handshake happens).
|
public SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext)
@Deprecated
public SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
SSLConnectionSocketFactory(SSLContext,
HostnameVerifier)@Deprecated
public SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
SSLConnectionSocketFactory(SSLContext,
String[], String[], HostnameVerifier)@Deprecated
public SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory,
HostnameVerifier)@Deprecated
public SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
cz.msebera.android.httpclient.conn.ssl.X509HostnameVerifier hostnameVerifier)
public SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
javax.net.ssl.HostnameVerifier hostnameVerifier)
public SSLConnectionSocketFactory(javax.net.ssl.SSLContext sslContext,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
javax.net.ssl.HostnameVerifier hostnameVerifier)
public SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
javax.net.ssl.HostnameVerifier hostnameVerifier)
public SSLConnectionSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory,
java.lang.String[] supportedProtocols,
java.lang.String[] supportedCipherSuites,
javax.net.ssl.HostnameVerifier hostnameVerifier)
public static javax.net.ssl.HostnameVerifier getDefaultHostnameVerifier()
public static SSLConnectionSocketFactory getSocketFactory() throws cz.msebera.android.httpclient.conn.ssl.SSLInitializationException
cacerts file in the security properties directory).
System properties are not taken into consideration.cz.msebera.android.httpclient.conn.ssl.SSLInitializationExceptionpublic static SSLConnectionSocketFactory getSystemSocketFactory() throws cz.msebera.android.httpclient.conn.ssl.SSLInitializationException
cz.msebera.android.httpclient.conn.ssl.SSLInitializationExceptionprotected void prepareSocket(javax.net.ssl.SSLSocket socket)
throws java.io.IOException
The default implementation is a no-op, but could be overridden to, e.g.,
call SSLSocket.setEnabledCipherSuites(String[]).
java.io.IOException - may be thrown if overriddenpublic java.net.Socket createSocket(cz.msebera.android.httpclient.protocol.HttpContext context)
throws java.io.IOException
createSocket in interface cz.msebera.android.httpclient.conn.socket.ConnectionSocketFactoryjava.io.IOExceptionpublic java.net.Socket connectSocket(int connectTimeout,
java.net.Socket socket,
cz.msebera.android.httpclient.HttpHost host,
java.net.InetSocketAddress remoteAddress,
java.net.InetSocketAddress localAddress,
cz.msebera.android.httpclient.protocol.HttpContext context)
throws java.io.IOException
connectSocket in interface cz.msebera.android.httpclient.conn.socket.ConnectionSocketFactoryjava.io.IOExceptionpublic java.net.Socket createLayeredSocket(java.net.Socket socket,
java.lang.String target,
int port,
cz.msebera.android.httpclient.protocol.HttpContext context)
throws java.io.IOException
createLayeredSocket in interface cz.msebera.android.httpclient.conn.socket.LayeredConnectionSocketFactoryjava.io.IOException