File	Doc	Category	Size	Date	Package
SSLSocketFactory.java	API Doc	Android 1.5 API	14230	Wed May 06 22:41:10 BST 2009	org.apache.http.conn.ssl

SSLSocketFactory

• java.lang.Object

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

Fields Summary
public static final String	TLS
public static final String	SSL
public static final String	SSLV2
public static final X509HostnameVerifier	ALLOW_ALL_HOSTNAME_VERIFIER
public static final X509HostnameVerifier	BROWSER_COMPATIBLE_HOSTNAME_VERIFIER
public static final X509HostnameVerifier	STRICT_HOSTNAME_VERIFIER
private static final SSLSocketFactory	DEFAULT_FACTORY The factory using the default JVM settings for secure connections.
private final SSLContext	sslcontext
private final SSLSocketFactory	socketfactory
private final HostNameResolver	nameResolver
private X509HostnameVerifier	hostnameVerifier

Constructors Summary
public SSLSocketFactory(String algorithm, KeyStore keystore, String keystorePassword, KeyStore truststore, SecureRandom random, HostNameResolver nameResolver) super(); if (algorithm == null) { algorithm = TLS; } KeyManager[] keymanagers = null; if (keystore != null) { keymanagers = createKeyManagers(keystore, keystorePassword); } TrustManager[] trustmanagers = null; if (truststore != null) { trustmanagers = createTrustManagers(truststore); } this.sslcontext = SSLContext.getInstance(algorithm); this.sslcontext.init(keymanagers, trustmanagers, random); this.socketfactory = this.sslcontext.getSocketFactory(); this.nameResolver = nameResolver;
public SSLSocketFactory(KeyStore keystore, String keystorePassword, KeyStore truststore) this(TLS, keystore, keystorePassword, truststore, null, null);
public SSLSocketFactory(KeyStore keystore, String keystorePassword) this(TLS, keystore, keystorePassword, null, null, null);
public SSLSocketFactory(KeyStore truststore) this(TLS, null, null, truststore, null, null);
public SSLSocketFactory(SSLSocketFactory socketfactory) Constructs an HttpClient SSLSocketFactory backed by the given JSSE SSLSocketFactory. hide super(); this.sslcontext = null; this.socketfactory = socketfactory; this.nameResolver = null;
private SSLSocketFactory() Creates the default SSL socket factory. This constructor is used exclusively to instantiate the factory for {@link #getSocketFactory getSocketFactory}. super(); this.sslcontext = null; this.socketfactory = HttpsURLConnection.getDefaultSSLSocketFactory(); this.nameResolver = null;

Methods Summary
public java.net.Socket	connectSocket(java.net.Socket sock, java.lang.String host, int port, java.net.InetAddress localAddress, int localPort, org.apache.http.params.HttpParams params) if (host == null) { throw new IllegalArgumentException("Target host may not be null."); } if (params == null) { throw new IllegalArgumentException("Parameters may not be null."); } SSLSocket sslsock = (SSLSocket) ((sock != null) ? sock : createSocket()); if ((localAddress != null) || (localPort > 0)) { // we need to bind explicitly if (localPort < 0) localPort = 0; // indicates "any" InetSocketAddress isa = new InetSocketAddress(localAddress, localPort); sslsock.bind(isa); } int connTimeout = HttpConnectionParams.getConnectionTimeout(params); int soTimeout = HttpConnectionParams.getSoTimeout(params); InetSocketAddress remoteAddress; if (this.nameResolver != null) { remoteAddress = new InetSocketAddress(this.nameResolver.resolve(host), port); } else { remoteAddress = new InetSocketAddress(host, port); } sslsock.connect(remoteAddress, connTimeout); sslsock.setSoTimeout(soTimeout); try { hostnameVerifier.verify(host, sslsock); // verifyHostName() didn't blowup - good! } catch (IOException iox) { // close the socket before re-throwing the exception try { sslsock.close(); } catch (Exception x) { /*ignore*/ } throw iox; } return sslsock;
private static javax.net.ssl.KeyManager[]	createKeyManagers(java.security.KeyStore keystore, java.lang.String password) if (keystore == null) { throw new IllegalArgumentException("Keystore may not be null"); } KeyManagerFactory kmfactory = KeyManagerFactory.getInstance( KeyManagerFactory.getDefaultAlgorithm()); kmfactory.init(keystore, password != null ? password.toCharArray(): null); return kmfactory.getKeyManagers();
public java.net.Socket	createSocket() // the cast makes sure that the factory is working as expected return (SSLSocket) this.socketfactory.createSocket();
public java.net.Socket	createSocket(java.net.Socket socket, java.lang.String host, int port, boolean autoClose) SSLSocket sslSocket = (SSLSocket) this.socketfactory.createSocket( socket, host, port, autoClose ); hostnameVerifier.verify(host, sslSocket); // verifyHostName() didn't blowup - good! return sslSocket;
private static javax.net.ssl.TrustManager[]	createTrustManagers(java.security.KeyStore keystore) if (keystore == null) { throw new IllegalArgumentException("Keystore may not be null"); } TrustManagerFactory tmfactory = TrustManagerFactory.getInstance( TrustManagerFactory.getDefaultAlgorithm()); tmfactory.init(keystore); return tmfactory.getTrustManagers();
public org.apache.http.conn.ssl.X509HostnameVerifier	getHostnameVerifier() return hostnameVerifier;
public static org.apache.http.conn.ssl.SSLSocketFactory	getSocketFactory() Gets an singleton instance of the SSLProtocolSocketFactory. return a SSLProtocolSocketFactory return DEFAULT_FACTORY;
public boolean	isSecure(java.net.Socket sock) Checks whether a socket connection is secure. 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. param sock the connected socket return true throws IllegalArgumentException if the argument is invalid if (sock == null) { throw new IllegalArgumentException("Socket may not be null."); } // This instanceof check is in line with createSocket() above. if (!(sock instanceof SSLSocket)) { throw new IllegalArgumentException ("Socket not created by this factory."); } // This check is performed last since it calls the argument object. if (sock.isClosed()) { throw new IllegalArgumentException("Socket is closed."); } return true;
public void	setHostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier hostnameVerifier) if ( hostnameVerifier == null ) { throw new IllegalArgumentException("Hostname verifier may not be null"); } this.hostnameVerifier = hostnameVerifier;