/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *    Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Axis" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.axis.components.net;

import org.apache.axis.components.logger.LogFactory;
import org.apache.axis.utils.Messages;
import org.apache.axis.utils.XMLUtils;
import org.apache.commons.logging.Log;

import javax.net.ssl.SSLSocket;
import javax.net.ssl.SSLSocketFactory;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.Hashtable;


/**
 * SSL socket factory. It _requires_ a valid RSA key and
 * JSSE. (borrowed code from tomcat)
 * <p/>
 * THIS CODE STILL HAS DEPENDENCIES ON sun.* and com.sun.*
 *
 * @author Davanum Srinivas (dims@yahoo.com)
 */
public class JSSESocketFactory extends DefaultSocketFactory implements SecureSocketFactory
{

   private static Log log = LogFactory.getLog(JSSESocketFactory.class.getName());

   /**
    * Field sslFactory
    */
   protected SSLSocketFactory sslFactory = null;

   /**
    * Constructor JSSESocketFactory
    *
    * @param attributes
    */
   public JSSESocketFactory(Hashtable attributes)
   {
      super(attributes);
   }

   /**
    * Initialize the SSLSocketFactory
    *
    * @throws IOException
    */
   protected void initFactory() throws IOException
   {
      sslFactory = (SSLSocketFactory)SSLSocketFactory.getDefault();
   }

   /**
    * creates a secure socket
    *
    * @param host
    * @param port
    * @param otherHeaders
    * @param useFullURL
    * @return Socket
    * @throws Exception
    */
   public Socket create(String host, int port, StringBuffer otherHeaders, BooleanHolder useFullURL)
           throws Exception
   {
      if (sslFactory == null)
      {
         initFactory();
      }
      if (port == -1)
      {
         port = 443;
      }

      TransportClientProperties tcp = TransportClientPropertiesFactory.create("https");

      boolean hostInNonProxyList = isHostInNonProxyList(host, tcp.getNonProxyHosts());

      Socket sslSocket = null;
      if (tcp.getProxyHost().length() == 0 || hostInNonProxyList)
      {
         // direct SSL connection
         sslSocket = sslFactory.createSocket(host, port);
      }
      else
      {

         // Default proxy port is 80, even for https
         int tunnelPort = (tcp.getProxyPort().length() != 0)
                 ? Integer.parseInt(tcp.getProxyPort())
                 : 80;
         if (tunnelPort < 0)
            tunnelPort = 80;

         // Create the regular socket connection to the proxy
         Socket tunnel = new Socket(tcp.getProxyHost(), tunnelPort);

         // The tunnel handshake method (condensed and made reflexive)
         OutputStream tunnelOutputStream = tunnel.getOutputStream();
         PrintWriter out = new PrintWriter(new BufferedWriter(new OutputStreamWriter(tunnelOutputStream)));

         // More secure version... engage later?
         // PasswordAuthentication pa =
         // Authenticator.requestPasswordAuthentication(
         // InetAddress.getByName(tunnelHost),
         // tunnelPort, "SOCK", "Proxy","HTTP");
         // if(pa == null){
         // printDebug("No Authenticator set.");
         // }else{
         // printDebug("Using Authenticator.");
         // tunnelUser = pa.getUserName();
         // tunnelPassword = new String(pa.getPassword());
         // }
         out.print("CONNECT " + host + ":" + port + " HTTP/1.0\r\n"
                 + "User-Agent: AxisClient");
         if (tcp.getProxyUser().length() != 0 &&
                 tcp.getProxyPassword().length() != 0)
         {

            // add basic authentication header for the proxy
            String encodedPassword = XMLUtils.base64encode((tcp.getProxyUser()
                    + ":"
                    + tcp.getProxyPassword()).getBytes());

            out.print("\nProxy-Authorization: Basic " + encodedPassword);
         }
         out.print("\nContent-Length: 0");
         out.print("\nPragma: no-cache");
         out.print("\r\n\r\n");
         out.flush();
         InputStream tunnelInputStream = tunnel.getInputStream();

         if (log.isDebugEnabled())
         {
            log.debug(Messages.getMessage("isNull00", "tunnelInputStream",
                    "" + (tunnelInputStream
                    == null)));
         }
         String replyStr = "";

         // Make sure to read all the response from the proxy to prevent SSL negotiation failure
         // Response message terminated by two sequential newlines
         int newlinesSeen = 0;
         boolean headerDone = false;    /* Done on first newline */

         while (newlinesSeen < 2)
         {
            int i = tunnelInputStream.read();

            if (i < 0)
            {
               throw new IOException("Unexpected EOF from proxy");
            }
            if (i == '\n')
            {
               headerDone = true;
               ++newlinesSeen;
            }
            else if (i != '\r')
            {
               newlinesSeen = 0;
               if (!headerDone)
               {
                  replyStr += String.valueOf((char)i);
               }
            }
         }
         if (!replyStr.startsWith("HTTP/1.0 200")
                 && !replyStr.startsWith("HTTP/1.1 200"))
         {
            throw new IOException(Messages.getMessage("cantTunnel00",
                    new String[]{
                       tcp.getProxyHost(),
                       "" + tunnelPort,
                       replyStr}));
         }

         // End of condensed reflective tunnel handshake method
         sslSocket = sslFactory.createSocket(tunnel, host, port, true);
         if (log.isDebugEnabled())
         {
            log.debug(Messages.getMessage("setupTunnel00",
                    tcp.getProxyHost(),
                    "" + tunnelPort));
         }
      }

      ((SSLSocket)sslSocket).startHandshake();
      if (log.isDebugEnabled())
      {
         log.debug(Messages.getMessage("createdSSL00"));
      }
      return sslSocket;
   }
}
