org.apache.commons.httpclient.contrib.ssl
Class AuthSSLProtocolSocketFactory

public class AuthSSLProtocolSocketFactory
implements SecureProtocolSocketFactory

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

AuthSSLProtocolSocketFactory 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
    

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

Example of using custom protocol socket factory for a specific host:

     Protocol authhttps = new Protocol("https",  
          new AuthSSLProtocolSocketFactory(
              new URL("file:my.keystore"), "mypassword",
              new URL("file:my.truststore"), "mypassword"), 443); 

     HttpClient client = new HttpClient();
     client.getHostConfiguration().setHost("localhost", 443, authhttps);
     // use relative url only
     GetMethod httpget = new GetMethod("/");
     client.executeMethod(httpget);
     

Example of using custom protocol socket factory per default instead of the standard one:

     Protocol authhttps = new Protocol("https",  
          new AuthSSLProtocolSocketFactory(
              new URL("file:my.keystore"), "mypassword",
              new URL("file:my.truststore"), "mypassword"), 443); 
     Protocol.registerProtocol("https", authhttps);

     HttpClient client = new HttpClient();
     GetMethod httpget = new GetMethod("https://localhost/");
     client.executeMethod(httpget);
     

SinceNot specified.
VersionNot specified.
Author<a href="mailto:oleg -at- ural.ru">Oleg Kalnichevski</a> <p> DISCLAIMER: HttpClient developers DO NOT actively support this component. The component is provided as a reference material, which may be inappropriate to be used without additional custom
Wiki javadoc Use textile entry format.
Add your comments here.
Constructor Summary
AuthSSLProtocolSocketFactory( URL keystoreUrl, String keystorePassword, URL truststoreUrl, String truststorePassword )
Constructor for AuthSSLProtocolSocketFactory.
Method Summary
Socket createSocket( String host, int port, InetAddress localAddress, int localPort, HttpConnectionParams params )
Attempts to get a new socket connection to the given host within the given time limit.
Socket createSocket( String host, int port, InetAddress clientHost, int clientPort )
No description provided.
Socket createSocket( String host, int port )
No description provided.
Socket createSocket( Socket socket, String host, int port, boolean autoClose )
No description provided.
AuthSSLProtocolSocketFactory
public AuthSSLProtocolSocketFactory ( URL keystoreUrl, String keystorePassword, URL truststoreUrl, String truststorePassword )
Constructor for AuthSSLProtocolSocketFactory. Either a keystore or truststore file must be given. Otherwise SSL context initialization error will result.
Parameters
TypeNameDescription
URL keystoreUrl URL of the keystore file. May be null if HTTPS client authentication is not to be used.
String keystorePassword Password to unlock the keystore. IMPORTANT: this implementation assumes that the same password is used to protect the key and the keystore itself.
URL truststoreUrl URL of the truststore file. May be null if HTTPS server authentication is not to be used.
String truststorePassword Password to unlock the truststore.
Wiki javadoc Use textile entry format.
Add your comments here.
createSocket
public Socket createSocket ( String host, int port, InetAddress localAddress, int localPort, HttpConnectionParams params )
Attempts to get a new socket connection to the given host within the given time limit.

To circumvent the limitations of older JREs that do not support connect timeout a controller thread is executed. The controller thread attempts to create a new socket within the given limit of time. If socket constructor does not return until the timeout expires, the controller terminates and throws an ConnectTimeoutException

Implements method in ProtocolSocketFactory
Parameters
TypeNameDescription
String host the host name/IP
int port the port on the host
InetAddress localAddress No description provided.
int localPort No description provided.
HttpConnectionParams params Http connection parameters
Exceptions
IOException if an I/O error occurs while creating the socket
UnknownHostException if the IP address of the host cannot be determined
ConnectTimeoutException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
createSocket
public Socket createSocket ( String host, int port, InetAddress clientHost, int clientPort )
No description provided.
Implements method in ProtocolSocketFactory
Parameters
TypeNameDescription
String host No description provided.
int port No description provided.
InetAddress clientHost No description provided.
int clientPort No description provided.
Exceptions
IOException No description provided.
UnknownHostException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
createSocket
public Socket createSocket ( String host, int port )
No description provided.
Implements method in ProtocolSocketFactory
Parameters
TypeNameDescription
String host No description provided.
int port No description provided.
Exceptions
IOException No description provided.
UnknownHostException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
createSocket
public Socket createSocket ( Socket socket, String host, int port, boolean autoClose )
No description provided.
Implements method in SecureProtocolSocketFactory
Parameters
TypeNameDescription
Socket socket No description provided.
String host No description provided.
int port No description provided.
boolean autoClose No description provided.
Exceptions
IOException No description provided.
UnknownHostException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.