/*

 * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

//

// Please run in othervm mode.  SunJSSE does not support dynamic system

// properties, no way to re-use system properties in samevm/agentvm mode.

//

/*

 * @test

 * @bug 8161106 8170329

 * @modules jdk.crypto.ec

 * @summary Improve SSLSocket test template

 * @run main/othervm SSLSocketTemplate

 */

import java.io.ByteArrayInputStream;

import java.io.InputStream;

import java.io.IOException;

import java.io.OutputStream;

import javax.net.ssl.KeyManagerFactory;

import javax.net.ssl.SSLContext;

import javax.net.ssl.SSLServerSocket;

import javax.net.ssl.SSLServerSocketFactory;

import javax.net.ssl.SSLSocket;

import javax.net.ssl.SSLSocketFactory;

import javax.net.ssl.TrustManagerFactory;

import java.net.InetAddress;

import java.net.InetSocketAddress;

import java.net.SocketTimeoutException;

import java.security.KeyStore;

import java.security.PrivateKey;

import java.security.KeyFactory;

import java.security.cert.Certificate;

import java.security.cert.CertificateFactory;

import java.security.spec.PKCS8EncodedKeySpec;

import java.util.Base64;

import java.util.concurrent.CountDownLatch;

import java.util.concurrent.TimeUnit;

/**

 * Template to help speed your client/server tests.

 *

 * Two examples that use this template:

 *    test/sun/security/ssl/ServerHandshaker/AnonCipherWithWantClientAuth.java

 *    test/sun/net/www/protocol/https/HttpsClient/ServerIdentityTest.java

 */

public class SSLSocketTemplate {

    /*

     * ==================

     * Run the test case.

     */

    public static void main(String[] args) throws Exception {

        (new SSLSocketTemplate()).run();

    }

    /*

     * Run the test case.

     */

    public void run() throws Exception {

        bootup();

    }

    /*

     * Define the server side application of the test for the specified socket.

     */

    protected void runServerApplication(SSLSocket socket) throws Exception {

        // here comes the test logic

        InputStream sslIS = socket.getInputStream();

        OutputStream sslOS = socket.getOutputStream();

        sslIS.read();

        sslOS.write(85);

        sslOS.flush();

    }

    /*

     * Define the client side application of the test for the specified socket.

     * This method is used if the returned value of

     * isCustomizedClientConnection() is false.

     *

     * @param socket may be null is no client socket is generated.

     *

     * @see #isCustomizedClientConnection()

     */

    protected void runClientApplication(SSLSocket socket) throws Exception {

        InputStream sslIS = socket.getInputStream();

        OutputStream sslOS = socket.getOutputStream();

        sslOS.write(280);

        sslOS.flush();

        sslIS.read();

    }

    /*

     * Define the client side application of the test for the specified

     * server port.  This method is used if the returned value of

     * isCustomizedClientConnection() is true.

     *

     * Note that the client need to connect to the server port by itself

     * for the actual message exchange.

     *

     * @see #isCustomizedClientConnection()

     */

    protected void runClientApplication(int serverPort) throws Exception {

        // blank

    }

    /*

     * Create an instance of SSLContext for client use.

     */

    protected SSLContext createClientSSLContext() throws Exception {

        return createSSLContext(TRUSTED_CERTS, END_ENTITY_CERTS,

                getClientContextParameters());

    }

    /*

     * Create an instance of SSLContext for server use.

     */

    protected SSLContext createServerSSLContext() throws Exception {

        return createSSLContext(TRUSTED_CERTS, END_ENTITY_CERTS,

                getServerContextParameters());

    }

    /*

     * The parameters used to configure SSLContext.

     */

    protected static final class ContextParameters {

        final String contextProtocol;

        final String tmAlgorithm;

        final String kmAlgorithm;

        ContextParameters(String contextProtocol,

                String tmAlgorithm, String kmAlgorithm) {

            this.contextProtocol = contextProtocol;

            this.tmAlgorithm = tmAlgorithm;

            this.kmAlgorithm = kmAlgorithm;

        }

    }

    /*

     * Get the client side parameters of SSLContext.

     */

    protected ContextParameters getClientContextParameters() {

        return new ContextParameters("TLS", "PKIX", "NewSunX509");

    }

    /*

     * Get the server side parameters of SSLContext.

     */

    protected ContextParameters getServerContextParameters() {

        return new ContextParameters("TLS", "PKIX", "NewSunX509");

    }

    /*

     * Does the client side use customized connection other than

     * explicit Socket.connect(), for example, URL.openConnection()?

     */

    protected boolean isCustomizedClientConnection() {

        return false;

    }

    /*

     * Configure the client side socket.

     */

    protected void configureClientSocket(SSLSocket socket) {

    }

    /*

     * Configure the server side socket.

     */

    protected void configureServerSocket(SSLServerSocket socket) {

    }

    /*

     * =============================================

     * Define the client and server side operations.

     *

     * If the client or server is doing some kind of object creation

     * that the other side depends on, and that thread prematurely

     * exits, you may experience a hang.  The test harness will

     * terminate all hung threads after its timeout has expired,

     * currently 3 minutes by default, but you might try to be

     * smart about it....

     */

    /*

     * Is the server ready to serve?

     */

    private final CountDownLatch serverCondition = new CountDownLatch(1);

    /*

     * Is the client ready to handshake?

     */

    private final CountDownLatch clientCondition = new CountDownLatch(1);

    /*

     * What's the server port?  Use any free port by default

     */

    protected volatile int serverPort = 0;

    /*

     * What's the server address?  null means binding to the wildcard.

     */

    protected volatile InetAddress serverAddress = null;

    /*

     * Define the server side of the test.

     */

    protected void doServerSide() throws Exception {

        // kick start the server side service

        SSLContext context = createServerSSLContext();

        SSLServerSocketFactory sslssf = context.getServerSocketFactory();

        InetAddress serverAddress = this.serverAddress;

        SSLServerSocket sslServerSocket = serverAddress == null ?

                (SSLServerSocket)sslssf.createServerSocket(serverPort)

                : (SSLServerSocket)sslssf.createServerSocket();

        if (serverAddress != null) {

            sslServerSocket.bind(new InetSocketAddress(serverAddress, serverPort));

        }

        configureServerSocket(sslServerSocket);

        serverPort = sslServerSocket.getLocalPort();

        // Signal the client, the server is ready to accept connection.

        serverCondition.countDown();

        // Try to accept a connection in 30 seconds.

        SSLSocket sslSocket;

        try {

            sslServerSocket.setSoTimeout(30000);

            sslSocket = (SSLSocket)sslServerSocket.accept();

        } catch (SocketTimeoutException ste) {

            // Ignore the test case if no connection within 30 seconds.

            System.out.println(

                "No incoming client connection in 30 seconds. " +

                "Ignore in server side.");

            return;

        } finally {

            sslServerSocket.close();

        }

        // handle the connection

        try {

            // Is it the expected client connection?

            //

            // Naughty test cases or third party routines may try to

            // connection to this server port unintentionally.  In

            // order to mitigate the impact of unexpected client

            // connections and avoid intermittent failure, it should

            // be checked that the accepted connection is really linked

            // to the expected client.

            boolean clientIsReady =

                    clientCondition.await(30L, TimeUnit.SECONDS);

            if (clientIsReady) {

                // Run the application in server side.

                runServerApplication(sslSocket);

            } else {    // Otherwise, ignore

                // We don't actually care about plain socket connections

                // for TLS communication testing generally.  Just ignore

                // the test if the accepted connection is not linked to

                // the expected client or the client connection timeout

                // in 30 seconds.

                System.out.println(

                        "The client is not the expected one or timeout. " +

                        "Ignore in server side.");

            }

        } finally {

            sslSocket.close();

        }

    }

    /*

     * Define the client side of the test.

     */

    protected void doClientSide() throws Exception {

        // Wait for server to get started.

        //

        // The server side takes care of the issue if the server cannot

        // get started in 90 seconds.  The client side would just ignore

        // the test case if the serer is not ready.

        boolean serverIsReady =

                serverCondition.await(90L, TimeUnit.SECONDS);

        if (!serverIsReady) {

            System.out.println(

                    "The server is not ready yet in 90 seconds. " +

                    "Ignore in client side.");

            return;

        }

        if (isCustomizedClientConnection()) {

            // Signal the server, the client is ready to communicate.

            clientCondition.countDown();

            // Run the application in client side.

            runClientApplication(serverPort);

            return;

        }

        SSLContext context = createClientSSLContext();

        SSLSocketFactory sslsf = context.getSocketFactory();

        try (SSLSocket sslSocket = (SSLSocket)sslsf.createSocket()) {

            try {

                configureClientSocket(sslSocket);

                InetAddress serverAddress = this.serverAddress;

                InetSocketAddress connectAddress = serverAddress == null

                        ? new InetSocketAddress("localhost", serverPort)

                        : new InetSocketAddress(serverAddress, serverPort);

                sslSocket.connect(connectAddress, 15000);

            } catch (IOException ioe) {

                // The server side may be impacted by naughty test cases or

                // third party routines, and cannot accept connections.

                //

                // Just ignore the test if the connection cannot be

                // established.

                System.out.println(

                        "Cannot make a connection in 15 seconds. " +

                        "Ignore in client side.");

                return;

            }

            // OK, here the client and server get connected.

            // Signal the server, the client is ready to communicate.

            clientCondition.countDown();

            // There is still a chance in theory that the server thread may

            // wait client-ready timeout and then quit.  The chance should

            // be really rare so we don't consider it until it becomes a

            // real problem.

            // Run the application in client side.

            runClientApplication(sslSocket);

        }

    }

    /*

     * =============================================

     * Stuffs to customize the SSLContext instances.

     */

    /*

     * =======================================

     * Certificates and keys used in the test.

     */

    // Trusted certificates.

    protected final static Cert[] TRUSTED_CERTS = {

            Cert.CA_ECDSA_SECP256R1,

            Cert.CA_RSA_2048,

            Cert.CA_DSA_2048 };

    // End entity certificate.

    protected final static Cert[] END_ENTITY_CERTS = {

            Cert.EE_ECDSA_SECP256R1,

            Cert.EE_RSA_2048,

            Cert.EE_EC_RSA_SECP256R1,

            Cert.EE_DSA_2048 };

    /*

     * Create an instance of SSLContext with the specified trust/key materials.

     */

    public static SSLContext createSSLContext(

            Cert[] trustedCerts,

            Cert[] endEntityCerts,

            ContextParameters params) throws Exception {

        KeyStore ts = null;     // trust store

        KeyStore ks = null;     // key store

        char passphrase[] = "passphrase".toCharArray();

        // Generate certificate from cert string.

        CertificateFactory cf = CertificateFactory.getInstance("X.509");

        // Import the trused certs.

        ByteArrayInputStream is;

        if (trustedCerts != null && trustedCerts.length != 0) {

            ts = KeyStore.getInstance("JKS");

            ts.load(null, null);

            Certificate[] trustedCert = new Certificate[trustedCerts.length];

            for (int i = 0; i < trustedCerts.length; i++) {

                is = new ByteArrayInputStream(trustedCerts[i].certStr.getBytes());

                try {

                    trustedCert[i] = cf.generateCertificate(is);

                } finally {

                    is.close();

                }

                ts.setCertificateEntry(

                        "trusted-cert-" + trustedCerts[i].name(), trustedCert[i]);

            }

        }

        // Import the key materials.

        if (endEntityCerts != null && endEntityCerts.length != 0) {

            ks = KeyStore.getInstance("JKS");

            ks.load(null, null);

            for (int i = 0; i < endEntityCerts.length; i++) {

                // generate the private key.

                PKCS8EncodedKeySpec priKeySpec = new PKCS8EncodedKeySpec(

                    Base64.getMimeDecoder().decode(endEntityCerts[i].privKeyStr));

                KeyFactory kf =

                    KeyFactory.getInstance(

                            endEntityCerts[i].keyAlgo);

                PrivateKey priKey = kf.generatePrivate(priKeySpec);

                // generate certificate chain

                is = new ByteArrayInputStream(

                        endEntityCerts[i].certStr.getBytes());

                Certificate keyCert = null;

                try {

                    keyCert = cf.generateCertificate(is);

                } finally {

                    is.close();

                }

                Certificate[] chain = new Certificate[] { keyCert };

                // import the key entry.

                ks.setKeyEntry("cert-" + endEntityCerts[i].name(),

                        priKey, passphrase, chain);

            }

        }

        // Create an SSLContext object.

        TrustManagerFactory tmf =

                TrustManagerFactory.getInstance(params.tmAlgorithm);

        tmf.init(ts);

        SSLContext context = SSLContext.getInstance(params.contextProtocol);

        if (endEntityCerts != null && endEntityCerts.length != 0 && ks != null) {

            KeyManagerFactory kmf =

                    KeyManagerFactory.getInstance(params.kmAlgorithm);

            kmf.init(ks, passphrase);

            context.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null);

        } else {

            context.init(null, tmf.getTrustManagers(), null);

        }

        return context;

    }

    /*

     * =================================================

     * Stuffs to boot up the client-server mode testing.

     */

    private Thread clientThread = null;

    private Thread serverThread = null;

    private volatile Exception serverException = null;

    private volatile Exception clientException = null;

    /*

     * Should we run the client or server in a separate thread?

     * Both sides can throw exceptions, but do you have a preference

     * as to which side should be the main thread.

     */

    private static final boolean separateServerThread = false;

    /*

     * Boot up the testing, used to drive remainder of the test.

     */

    private void bootup() throws Exception {

        Exception startException = null;

        try {

            if (separateServerThread) {

                startServer(true);

                startClient(false);