com.infostretch.volydemo.network.volly.ssl.EasySSLSocketFactory.java Source code

Java tutorial

Introduction

Here is the source code for com.infostretch.volydemo.network.volly.ssl.EasySSLSocketFactory.java

Source

package com.infostretch.volydemo.network.volly.ssl;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import java.io.IOException;
import java.io.InputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.Socket;
import java.net.UnknownHostException;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;

import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocket;
import javax.net.ssl.TrustManager;
import javax.net.ssl.TrustManagerFactory;
import javax.net.ssl.X509TrustManager;

import com.infostretch.volydemo.R;

import org.apache.http.conn.ConnectTimeoutException;
import org.apache.http.conn.scheme.LayeredSocketFactory;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;

import com.infostretch.volydemo.DemoApp;

/**
 * 
 * Modified EasySSLSocketFactory class written by olamy. Based on the boolean
 * 'isConnectingYourServer' it decides which Client KeyStore and TrustManagers
 * to use. But this can be improved much better by taking KeyStore and
 * TrustStore as inputs and can be more generic.
 * 
 * @author Mani Selvaraj
 * 
 */

public class EasySSLSocketFactory implements LayeredSocketFactory {

    private SSLContext sslcontext = null;
    private boolean isConnectingYourServer = true;

    public EasySSLSocketFactory(boolean isConnectingToGoinoutServer) {
        this.isConnectingYourServer = isConnectingToGoinoutServer;
    }

    /*
     * In case of self signed certificates on Server. Two things needs to be
     * taken care 1)Authenticate to the HTTPS server using a private key.
     * 2)Validate the identity of the HTTPS server against a list of trusted
     * certificates
     * 
     * Ref - http://developer.android.com/reference/org/apache/http/conn/ssl/
     * SSLSocketFactory.html
     */
    private static SSLContext createEasySSLContext() throws IOException {
        try {

            // Client should authenticate itself with the valid certificate to
            // Server.
            /*
             * InputStream clientStream =
             * VolleySampleApplication.getContext().getResources
             * ().openRawResource(R.raw.production_test_client); char[] password
             * = "XXXXXXXXXXXXX".toCharArray();
             * 
             * KeyStore keyStore = KeyStore.getInstance("PKCS12");
             * keyStore.load(clientStream, password);
             * 
             * KeyManagerFactory keyManagerFactory =
             * KeyManagerFactory.getInstance
             * (KeyManagerFactory.getDefaultAlgorithm());
             * keyManagerFactory.init(keyStore, password);
             */

            // Client should also add the CA certificate obtained from server
            // and create TrustManager from it for the client to validate the
            // identity of the server.
            /*
             * KeyStore trustStore = KeyStore.getInstance("BKS"); InputStream
             * instream = null; instream =
             * MainActivity.getContext().getResources()
             * .openRawResource(R.raw.teststore);
             * 
             * try { trustStore.load(instream, "testpass".toCharArray()); }
             * catch (Exception e) { e.printStackTrace(); } finally { try {
             * instream.close(); } catch (Exception ignore) { } }
             * 
             * String tmfAlgorithm = TrustManagerFactory.getDefaultAlgorithm();
             * TrustManagerFactory tmf = TrustManagerFactory
             * .getInstance(tmfAlgorithm); tmf.init(trustStore);
             */

            // Create an SSLContext that uses our TrustManager & Keystore
            SSLContext context = SSLContext.getInstance("TLS");
            context.init(null, new TrustManager[] { new MyTrustManager(null) }, null);

            return context;
        } catch (Exception e) {
            e.printStackTrace();
            throw new IOException(e.getMessage());
        }
    }

    public static class MyTrustManager implements X509TrustManager {

        private X509TrustManager defaultTrustManager;
        private X509TrustManager localTrustManager;

        private X509Certificate[] acceptedIssuers;

        public MyTrustManager(KeyStore localKeyStore) throws NoSuchAlgorithmException, KeyStoreException {
            KeyStore trustStore = KeyStore.getInstance("BKS");
            InputStream instream = null;
            instream = DemoApp.getDailyUseAppContext().getResources().openRawResource(R.raw.teststore);

            try {
                trustStore.load(instream, "testpass".toCharArray());
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                try {
                    instream.close();
                } catch (Exception ignore) {
                }
            }

            String tmfAlgorithm = TrustManagerFactory.getDefaultAlgorithm();
            TrustManagerFactory tmf = TrustManagerFactory.getInstance(tmfAlgorithm);
            tmf.init((KeyStore) null);
            defaultTrustManager = (X509TrustManager) tmf.getTrustManagers()[0];

            tmf.init(trustStore);

            localTrustManager = (X509TrustManager) tmf.getTrustManagers()[0];
        }

        public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {
            try {
                defaultTrustManager.checkServerTrusted(chain, authType);
            } catch (CertificateException ce) {
                localTrustManager.checkServerTrusted(chain, authType);
            }
        }

        @Override
        public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {
            try {
                defaultTrustManager.checkClientTrusted(chain, authType);
            } catch (CertificateException ce) {
                localTrustManager.checkClientTrusted(chain, authType);
            }

        }

        @Override
        public X509Certificate[] getAcceptedIssuers() {
            if (null == acceptedIssuers) {
                X509Certificate[] acceptedIssuersDefault = defaultTrustManager.getAcceptedIssuers();
                X509Certificate[] acceptedIssuersLocal = localTrustManager.getAcceptedIssuers();
                acceptedIssuers = new X509Certificate[acceptedIssuersDefault.length + acceptedIssuersLocal.length];

                System.arraycopy(acceptedIssuersDefault, 0, acceptedIssuers, 0, acceptedIssuersDefault.length);
                System.arraycopy(acceptedIssuersLocal, 0, acceptedIssuers, acceptedIssuersDefault.length,
                        acceptedIssuersLocal.length);
            }
            return acceptedIssuers;
        }

        // ...
    }

    /*
     * Creates SSLContext and initialises with the IgnoreTrustManager to trust
     * all secured server. Basically ignoring the trust to connect to server.
     */
    private static SSLContext createIgnoreSSLContext() throws IOException {
        try {
            SSLContext context = SSLContext.getInstance("TLS");
            context.init(null, new TrustManager[] { new IgnoreCertTrustManager() }, null);
            return context;
        } catch (Exception e) {
            e.printStackTrace();
            throw new IOException(e.getMessage());
        }
    }

    /**
     * If you want to add more trusted certificates ( if self signed) for
     * different sites, you should use EasyX509TrustManager and create a
     * instance with corresponding KeyStore and then add to the SSLContext.
     * 
     * @return
     * @throws IOException
     */
    private SSLContext getSSLContext() throws IOException {
        if (this.sslcontext == null) {
            if (isConnectingYourServer) {
                this.sslcontext = createEasySSLContext();
            } else {
                // Ignore the Certificate Authority check if not connecting to
                // your server.
                this.sslcontext = createIgnoreSSLContext();
            }
        }

        return this.sslcontext;
    }

    /**
     * @see org.apache.http.conn.scheme.SocketFactory#connectSocket(java.net.Socket,
     *      java.lang.String, int, java.net.InetAddress, int,
     *      org.apache.http.params.HttpParams)
     */
    public Socket connectSocket(Socket sock, String host, int port, InetAddress localAddress, int localPort,
            HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException {
        int connTimeout = HttpConnectionParams.getConnectionTimeout(params);
        int soTimeout = HttpConnectionParams.getSoTimeout(params);

        InetSocketAddress remoteAddress = new InetSocketAddress(host, port);
        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);
        }

        sslsock.connect(remoteAddress, connTimeout);
        sslsock.setSoTimeout(soTimeout);
        return sslsock;

    }

    /**
     * @see org.apache.http.conn.scheme.SocketFactory#createSocket()
     */
    public Socket createSocket() throws IOException {
        return getSSLContext().getSocketFactory().createSocket();
    }

    /**
     * @see org.apache.http.conn.scheme.SocketFactory#isSecure(java.net.Socket)
     */
    public boolean isSecure(Socket socket) throws IllegalArgumentException {
        return true;
    }

    /**
     * @see org.apache.http.conn.scheme.LayeredSocketFactory#createSocket(java.net.Socket,
     *      java.lang.String, int, boolean)
     */
    public Socket createSocket(Socket socket, String host, int port, boolean autoClose)
            throws IOException, UnknownHostException {
        return getSSLContext().getSocketFactory().createSocket(socket, host, port, autoClose);
    }

    // -------------------------------------------------------------------
    // javadoc in org.apache.http.conn.scheme.SocketFactory says :
    // Both Object.equals() and Object.hashCode() must be overridden
    // for the correct operation of some connection managers
    // -------------------------------------------------------------------

    public boolean equals(Object obj) {
        return ((obj != null) && obj.getClass().equals(EasySSLSocketFactory.class));
    }

    public int hashCode() {
        return EasySSLSocketFactory.class.hashCode();
    }

}