Layered socket factory for TLS/SSL connections, based on JSSE. More...
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 java.security.KeyStore 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 java.security.KeyStore 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 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 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
The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.
/* * Copyright (C) 2006 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */
Public Member Functions | |
SSLSocketFactory (javax.net.ssl.SSLSocketFactory socketfactory) | |
Constructs an HttpClient SSLSocketFactory backed by the given JSSE SSLSocketFactory. | |
Socket | createSocket () throws IOException |
Creates a new, unconnected socket. More... | |
Socket | connectSocket (final Socket sock, final String host, final int port, final InetAddress localAddress, int localPort, final HttpParams params) throws IOException |
Connects a socket to the given host. More... | |
boolean | isSecure (Socket sock) throws IllegalArgumentException |
Checks whether a socket connection is secure. More... | |
Socket | createSocket (final Socket socket, final String host, final int port, final boolean autoClose) throws IOException, UnknownHostException |
Returns a socket connected to the given host that is layered over an existing socket. More... | |
Static Public Member Functions | |
static SSLSocketFactory | getSocketFactory () |
Gets an singleton instance of the SSLProtocolSocketFactory. More... | |
|
static |
Socket createSocket | ( | ) | throws IOException |
IOException | if an I/O error occurs while creating the socket |
Implements SocketFactory.
Socket connectSocket | ( | final Socket | sock, |
final String | host, | ||
final int | port, | ||
final InetAddress | localAddress, | ||
int | localPort, | ||
final HttpParams | params | ||
) | throws IOException |
sock | the socket to connect, as obtained from createSocket . null indicates that a new socket should be created and connected. |
host | the host to connect to |
port | the port to connect to on the host |
localAddress | the local address to bind the socket to, or null for any |
localPort | the port on the local machine, 0 or a negative number for any |
params | additional parameters for connecting |
sock
argument if this factory supports a layered protocol.IOException | if an I/O error occurs |
UnknownHostException | if the IP address of the target host can not be determined |
ConnectTimeoutException | if the socket cannot be connected within the time limit defined in the params |
Implements SocketFactory.
boolean isSecure | ( | Socket | sock | ) | throws IllegalArgumentException |
This factory creates TLS/SSL socket connections which, by default, are considered secure.
Derived classes may override this method to perform runtime checks, for example based on the cypher suite.
sock | the connected socket |
true
IllegalArgumentException | if the argument is invalid |
Implements SocketFactory.
Socket createSocket | ( | final Socket | socket, |
final String | host, | ||
final int | port, | ||
final boolean | autoClose | ||
) | throws IOException, UnknownHostException |
Used primarily for creating secure sockets through proxies.
socket | the existing socket |
host | the host name/IP |
port | the port on the host |
autoClose | a flag for closing the underling socket when the created socket is closed |
IOException | if an I/O error occurs while creating the socket |
UnknownHostException | if the IP address of the host cannot be determined |
Implements LayeredSocketFactory.