• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
SSLSocketFactory Class Reference

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

Inheritance diagram for SSLSocketFactory:
LayeredSocketFactory SocketFactory

Description

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

Author
Oleg Kalnichevski
Julius Davies

Notice

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

Member Function Documentation

◆ getSocketFactory()

static SSLSocketFactory getSocketFactory ( )
static
Returns
a SSLProtocolSocketFactory

◆ createSocket() [1/2]

Socket createSocket ( ) throws IOException
Returns
a new socket
Exceptions
IOExceptionif an I/O error occurs while creating the socket

Implements SocketFactory.

◆ connectSocket()

Socket connectSocket ( final Socket  sock,
final String  host,
final int  port,
final InetAddress  localAddress,
int  localPort,
final HttpParams  params 
) throws IOException
Parameters
sockthe socket to connect, as obtained from createSocket . null indicates that a new socket should be created and connected.
hostthe host to connect to
portthe port to connect to on the host
localAddressthe local address to bind the socket to, or null for any
localPortthe port on the local machine, 0 or a negative number for any
paramsadditional parameters for connecting
Returns
the connected socket. The returned object may be different from the sock argument if this factory supports a layered protocol.
Exceptions
IOExceptionif an I/O error occurs
UnknownHostExceptionif the IP address of the target host can not be determined
ConnectTimeoutExceptionif the socket cannot be connected within the time limit defined in the params

Implements SocketFactory.

◆ isSecure()

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.

Parameters
sockthe connected socket
Returns
true
Exceptions
IllegalArgumentExceptionif the argument is invalid

Implements SocketFactory.

◆ createSocket() [2/2]

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.

Parameters
socketthe existing socket
hostthe host name/IP
portthe port on the host
autoClosea flag for closing the underling socket when the created socket is closed
Returns
Socket a new socket
Exceptions
IOExceptionif an I/O error occurs while creating the socket
UnknownHostExceptionif the IP address of the host cannot be determined

Implements LayeredSocketFactory.