Added in API level 1
Deprecated in API level 22

Summary: Constants | Fields | Ctors | Methods | Inherited Methods

SSLSocketFactory

public class SSLSocketFactory
extends Object implements LayeredSocketFactory

java.lang.Object
↳	org.apache.http.conn.ssl.SSLSocketFactory

This class was deprecated in API level 22.
Please use URL.openConnection() instead. Please visit this webpage for further details.

Layered socket factory for TLS/SSL connections, based on JSSE. .

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 truststore file containg 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 truststore file:

     keytool -import -alias "my server cert" -file server.crt -keystore my.truststore

SSLSocketFactory will enable client authentication when supplied with a keystore file containg 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 keystore 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 keystore

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 their 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 containg the complete certificate chain

keytool -import -alias "my client key" -file mycert.p7 -keystore my.keystore

Verify the content the resultant keystore file
```
keytool -list -v -keystore my.keystore
```

Summary

Constants
`String`	`SSL`
`String`	`SSLV2`
`String`	`TLS`

Fields
`public static final X509HostnameVerifier`	`ALLOW_ALL_HOSTNAME_VERIFIER`
`public static final X509HostnameVerifier`	`BROWSER_COMPATIBLE_HOSTNAME_VERIFIER`
`public static final X509HostnameVerifier`	`STRICT_HOSTNAME_VERIFIER`

Public constructors
`SSLSocketFactory(String algorithm, KeyStore keystore, String keystorePassword, KeyStore truststore, SecureRandom random, HostNameResolver nameResolver)`
`SSLSocketFactory(KeyStore truststore)`
`SSLSocketFactory(KeyStore keystore, String keystorePassword)`
`SSLSocketFactory(KeyStore keystore, String keystorePassword, KeyStore truststore)`

Public methods
`Socket`	`connectSocket(Socket sock, String host, int port, InetAddress localAddress, int localPort, HttpParams params)` Connects a socket to the given host.
`Socket`	`createSocket(Socket socket, String host, int port, boolean autoClose)` Returns a socket connected to the given host that is layered over an existing socket.
`Socket`	`createSocket()` Creates a new, unconnected socket.
`X509HostnameVerifier`	`getHostnameVerifier()`
`static SSLSocketFactory`	`getSocketFactory()` Gets an singleton instance of the SSLProtocolSocketFactory.
`boolean`	`isSecure(Socket sock)` Checks whether a socket connection is secure.
`void`	`setHostnameVerifier(X509HostnameVerifier hostnameVerifier)`

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          org.apache.http.conn.scheme.LayeredSocketFactory


        abstract
        
        
        
        
        Socket


      createSocket(Socket socket, String host, int port, boolean autoClose)

Returns a socket connected to the given host that is layered over an existing socket.

From interface


        
          org.apache.http.conn.scheme.SocketFactory

`abstract Socket`	`connectSocket(Socket sock, String host, int port, InetAddress localAddress, int localPort, HttpParams params)` Connects a socket to the given host.
`abstract Socket`	`createSocket()` Creates a new, unconnected socket.
`abstract boolean`	`isSecure(Socket sock)` Checks whether a socket provides a secure connection.

Constants

SSL

Added in API level 1

public static final String SSL

Constant Value: "SSL"

SSLV2

Added in API level 1

public static final String SSLV2

Constant Value: "SSLv2"

TLS

Added in API level 1

public static final String TLS

Constant Value: "TLS"

Fields

ALLOW_ALL_HOSTNAME_VERIFIER

Added in API level 1

public static final X509HostnameVerifier ALLOW_ALL_HOSTNAME_VERIFIER

BROWSER_COMPATIBLE_HOSTNAME_VERIFIER

Added in API level 1

public static final X509HostnameVerifier BROWSER_COMPATIBLE_HOSTNAME_VERIFIER

STRICT_HOSTNAME_VERIFIER

Added in API level 1

public static final X509HostnameVerifier STRICT_HOSTNAME_VERIFIER

Public constructors