8206355: SSLSessionImpl.getLocalPrincipal() throws NPE
authorssahoo
Wed, 04 Jul 2018 11:49:46 -0700
changeset 50987 e4a92c455d1c
parent 50986 b289815d0db3
child 50988 e5e3e2c1b2e5
8206355: SSLSessionImpl.getLocalPrincipal() throws NPE Summary: Fixed SSLSessionImpl.getLocalPrincipal() implementation when client side authentication is not enabled. Reviewed-by: xuelei
src/java.base/share/classes/sun/security/ssl/SSLSessionImpl.java
test/jdk/javax/net/ssl/TLSCommon/TestSessionLocalPrincipal.java
--- a/src/java.base/share/classes/sun/security/ssl/SSLSessionImpl.java	Wed Jul 04 18:39:26 2018 +0200
+++ b/src/java.base/share/classes/sun/security/ssl/SSLSessionImpl.java	Wed Jul 04 11:49:46 2018 -0700
@@ -658,7 +658,7 @@
      */
     @Override
     public Principal getLocalPrincipal() {
-        return ((localCerts == null && localCerts.length != 0) ? null :
+        return ((localCerts == null || localCerts.length == 0) ? null :
                 localCerts[0].getSubjectX500Principal());
     }
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/javax/net/ssl/TLSCommon/TestSessionLocalPrincipal.java	Wed Jul 04 11:49:46 2018 -0700
@@ -0,0 +1,344 @@
+/*
+ * Copyright (c) 2018, 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.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * 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.
+ */
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.security.KeyFactory;
+import java.security.KeyStore;
+import java.security.Principal;
+import java.security.PrivateKey;
+import java.security.Security;
+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.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ThreadFactory;
+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;
+
+/*
+ * @test
+ * @bug 8206355
+ * @summary Test principal that was sent to the peer during handshake.
+ * @run main/othervm TestSessionLocalPrincipal
+ */
+public class TestSessionLocalPrincipal {
+
+    public static void main(String[] args) throws Exception {
+
+        Security.setProperty("jdk.tls.disabledAlgorithms", "");
+        for (String tlsProtocol : new String[]{
+            "TLSv1.3", "TLSv1.2", "TLSv1.1", "TLSv1"}) {
+            for (boolean clientAuth : new boolean[]{true, false}) {
+                System.out.printf("Protocol %s: Client side auth enabled: %s%n",
+                        tlsProtocol, clientAuth);
+                CountDownLatch serverReady = new CountDownLatch(1);
+                Server server = new Server(tlsProtocol, clientAuth,
+                        serverReady);
+                server.start();
+
+                // Wait till server is ready to accept connection.
+                serverReady.await();
+                new Client(tlsProtocol, clientAuth, server.port).doClientSide();
+                if (server.serverExc != null) {
+                    throw new RuntimeException(server.serverExc);
+                }
+            }
+        }
+    }
+
+    public static class Server implements Runnable {
+
+        private volatile int port = 0;
+        private final String tlsProtocol;
+        private final boolean clientAuth;
+        private final CountDownLatch latch;
+        private volatile Exception serverExc;
+
+        public Server(String tlsProtocol, boolean clientAuth,
+                CountDownLatch latch) {
+            this.tlsProtocol = tlsProtocol;
+            this.clientAuth = clientAuth;
+            this.latch = latch;
+        }
+
+        public void start() {
+
+            ExecutorService executor = null;
+            try {
+                executor = Executors.newCachedThreadPool(new ThreadFactory() {
+                    @Override
+                    public Thread newThread(Runnable r) {
+                        Thread t = Executors.defaultThreadFactory()
+                                .newThread(r);
+                        t.setDaemon(true);
+                        return t;
+                    }
+                });
+                executor.execute(this);
+            } finally {
+                if (executor != null) {
+                    executor.shutdown();
+                }
+            }
+        }
+
+        /*
+         * Define the server side operation.
+         */
+        void doServerSide() throws Exception {
+
+            SSLContext ctx = getSSLContext(tlsProtocol);
+            SSLServerSocketFactory sslssf = ctx.getServerSocketFactory();
+            SSLServerSocket sslServerSocket
+                    = (SSLServerSocket) sslssf.createServerSocket(port);
+            port = sslServerSocket.getLocalPort();
+            System.out.println("Server listining on port: " + port);
+            sslServerSocket.setEnabledProtocols(new String[]{tlsProtocol});
+            /*
+             * Signal Client, the server is ready to accept client request.
+             */
+            latch.countDown();
+            try (SSLSocket sslSocket = (SSLSocket) sslServerSocket.accept()) {
+                sslSocket.setNeedClientAuth(this.clientAuth);
+                sslSocket.setSoTimeout(5000);
+                try (InputStream sslIS = sslSocket.getInputStream();
+                        OutputStream sslOS = sslSocket.getOutputStream();) {
+                    sslIS.read();
+                    sslOS.write(85);
+                    sslOS.flush();
+                }
+            } finally {
+                sslServerSocket.close();
+            }
+        }
+
+        @Override
+        public void run() {
+            try {
+                doServerSide();
+            } catch (Exception e) {
+                // Print the exception for debug purpose.
+                e.printStackTrace(System.out);
+                serverExc = e;
+            }
+        }
+    }
+
+    /*
+     * Define the client side of the test.
+     */
+    public static class Client {
+
+        private final int serverPort;
+        private final String tlsProtocol;
+        private final boolean clientAuth;
+
+        public Client(String tlsProtocol, boolean clientAuth, int serverPort) {
+            this.tlsProtocol = tlsProtocol;
+            this.clientAuth = clientAuth;
+            this.serverPort = serverPort;
+        }
+
+        void doClientSide() throws Exception {
+
+            SSLContext ctx = getSSLContext(this.tlsProtocol);
+            SSLSocketFactory sslsf = ctx.getSocketFactory();
+            try (SSLSocket sslSocket
+                    = (SSLSocket) sslsf.createSocket("localhost", serverPort)) {
+                sslSocket.setEnabledProtocols(new String[]{this.tlsProtocol});
+                Principal principal = sslSocket.getSession().getLocalPrincipal();
+                if (this.clientAuth && principal == null) {
+                    throw new RuntimeException("Principal can not be null");
+                }
+                if (!this.clientAuth && principal != null) {
+                    throw new RuntimeException("Principal should be null");
+                }
+                try (InputStream sslIS = sslSocket.getInputStream();
+                        OutputStream sslOS = sslSocket.getOutputStream()) {
+                    sslOS.write(86);
+                    sslOS.flush();
+                    sslIS.read();
+                }
+            }
+        }
+    }
+
+    // get the ssl context
+    protected static SSLContext getSSLContext(String tlsProtocol)
+            throws Exception {
+
+        // Generate certificate from cert string
+        CertificateFactory cf = CertificateFactory.getInstance("X.509");
+
+        // Create a key store
+        KeyStore ts = KeyStore.getInstance("PKCS12");
+        KeyStore ks = KeyStore.getInstance("PKCS12");
+        ts.load(null, null);
+        ks.load(null, null);
+        char passphrase[] = "passphrase".toCharArray();
+
+        // Import the trusted cert
+        ts.setCertificateEntry("trusted-cert-"
+                + KeyType.rsa_pkcs1_sha256.getKeyType(),
+                cf.generateCertificate(new ByteArrayInputStream(
+                        KeyType.rsa_pkcs1_sha256.getTrustedCert().getBytes())));
+
+        boolean hasKeyMaterials = KeyType.rsa_pkcs1_sha256.getEndCert() != null
+                && KeyType.rsa_pkcs1_sha256.getPrivateKey() != null;
+        if (hasKeyMaterials) {
+
+            // Generate the private key.
+            PKCS8EncodedKeySpec priKeySpec = new PKCS8EncodedKeySpec(
+                    Base64.getMimeDecoder().decode(
+                            KeyType.rsa_pkcs1_sha256.getPrivateKey()));
+            KeyFactory kf = KeyFactory.getInstance(
+                    KeyType.rsa_pkcs1_sha256.getKeyType());
+            PrivateKey priKey = kf.generatePrivate(priKeySpec);
+
+            // Generate certificate chain
+            Certificate keyCert = cf.generateCertificate(
+                    new ByteArrayInputStream(
+                            KeyType.rsa_pkcs1_sha256.getEndCert().getBytes()));
+            Certificate[] chain = new Certificate[]{keyCert};
+
+            // Import the key entry.
+            ks.setKeyEntry("cert-" + KeyType.rsa_pkcs1_sha256.getKeyType(),
+                    priKey, passphrase, chain);
+        }
+
+        // Create SSL context
+        TrustManagerFactory tmf = TrustManagerFactory.getInstance("PKIX");
+        tmf.init(ts);
+
+        SSLContext context = SSLContext.getInstance(tlsProtocol);
+        if (hasKeyMaterials) {
+            KeyManagerFactory kmf = KeyManagerFactory.getInstance("NewSunX509");
+            kmf.init(ks, passphrase);
+            context.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null);
+        } else {
+            context.init(null, tmf.getTrustManagers(), null);
+        }
+        return context;
+    }
+}
+
+enum KeyType {
+
+    rsa_pkcs1_sha256(
+            "RSA",
+            /**
+             * Signature Algorithm: sha256WithRSAEncryption
+             * Issuer: CN = localhost
+             * Validity Not Before: Jun 4 15:22:04 2018 GMT
+             * Not After: May 30 15:22:04 2038 GMT
+             * Subject: CN = localhost
+             * Public Key Algorithm: rsaEncryption
+             */
+            "-----BEGIN CERTIFICATE-----\n"
+            + "MIIDBjCCAe6gAwIBAgIUc8yTYekR2LuXkkCJYqWlS/pBMKIwDQYJKoZIhvcNAQEL\n"
+            + "BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTE4MDYwNDE1MjIwNFoXDTM4MDUz\n"
+            + "MDE1MjIwNFowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF\n"
+            + "AAOCAQ8AMIIBCgKCAQEA2jDPGMogc9dq2w5b+FHqbfaGPokRmyObiU8y/l/dqkM5\n"
+            + "9IV+qj8VQUI4NtpdCTWr16812z4AjXrk5HIBrECfQbHPUcm1rme5YVZ0WxV0+Ufy\n"
+            + "hDmrGwDLhkxGqc3hOhRrlF2wdXeUfjIzhvS9+S/401++t/jvq+cqFF1BHnzYOu+l\n"
+            + "nbi/o95Oqo8MlwiRqg3xy3fNRfqXk7DWy+QT8s+Vc3Pcj1EW6K0iJJ23BVTdv6YT\n"
+            + "Ja5IKiWL4XsLht3fWvZwF+PoYfKb+JYflt0rafpxg9xkowe7GnGh2SpV7bJaH/QN\n"
+            + "3PTFEKQWgWHjWwjR171GOzSaEgaklvKde6+zNWeYKwIDAQABo1AwTjAdBgNVHQ4E\n"
+            + "FgQUqCtGe8/Ky4O6pH7xeTUy9yrv4n0wHwYDVR0jBBgwFoAUqCtGe8/Ky4O6pH7x\n"
+            + "eTUy9yrv4n0wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAuqch30im\n"
+            + "M09sARarbfK3OExqYK2xoyuUscgTqQNDpNL2gMdXY9e0lTmGVgw9pVYtNZPZRxem\n"
+            + "jR5an2XegvG9qVU6vLENDwLCqZgsTb2gvmXngiG8NVcYd81GNqD228mkgBosNJku\n"
+            + "6BR+C8zlURzsNEt657eVvIp9ObGomdAbWhpdqihBD180PP18DIBWopyfHfJtT5FA\n"
+            + "U2kSPBp+P1EtdceW0zfwv3rF8hwRbnQBzuoYrZfn2PiMYaGUqOgbqUltCMD/Dp9G\n"
+            + "xK0nfAXEwIqHWWnijGwAd6YrszMjBUcSGmlehdF+XZK6jHNlw64RB4WTfavr+rY0\n"
+            + "dTe6g4o5GYr9nQ==\n"
+            + "-----END CERTIFICATE-----\n",
+            //
+            // Private key.
+            //
+            "MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDaMM8YyiBz12rb\n"
+            + "Dlv4Uept9oY+iRGbI5uJTzL+X92qQzn0hX6qPxVBQjg22l0JNavXrzXbPgCNeuTk\n"
+            + "cgGsQJ9Bsc9RybWuZ7lhVnRbFXT5R/KEOasbAMuGTEapzeE6FGuUXbB1d5R+MjOG\n"
+            + "9L35L/jTX763+O+r5yoUXUEefNg676WduL+j3k6qjwyXCJGqDfHLd81F+peTsNbL\n"
+            + "5BPyz5Vzc9yPURborSIknbcFVN2/phMlrkgqJYvhewuG3d9a9nAX4+hh8pv4lh+W\n"
+            + "3Stp+nGD3GSjB7sacaHZKlXtslof9A3c9MUQpBaBYeNbCNHXvUY7NJoSBqSW8p17\n"
+            + "r7M1Z5grAgMBAAECggEAHs/7vw10TcejEHJTrJqs14CT7qresKDzqw1jLycMn6nE\n"
+            + "unJLs/EaqE+Yrq5hqxZIQTo+CcsUuuYbAuPStqedleJtW6h3nryJImTaI67BCR8O\n"
+            + "8XtPXY3cMAf/hqVLZC9UDey5Ka2Ma9HdEvbnCRSsN/VycnqWJhmMCLouowaQZqoE\n"
+            + "VopscUix8GqELv0vEo2CszZfUjtSVbNTlNgwDf5U7eSKXMuFsnSn/LE7AMvHsEyo\n"
+            + "HatxogwlM/WjpTnf/WIeJY3VhaK10IsP6OEgUn/p4VtI2DQ/TJdgYrvD5vhjY8ip\n"
+            + "XuUPuPILRvJWo8dRXJqa4diXB12q5YhP8iiOp4BgkQKBgQD1GtlOR+JVgOzpQ11h\n"
+            + "s5/iJOsczee80pQscbSRJnzSsIaP9WM8CyJgvbPxIQxLUQeYnxM/bxNKkpJtzxRK\n"
+            + "pob+v4NoRn8PTpqbOp1obmWJT7uHTaoeavQo7r7uZI4i3eEgHCCQkMzpqzz7UFTY\n"
+            + "2Yst7bBTPUivlSVQQBEc8bLpeQKBgQDj47EjpAlh8DmJRTElg58t+XJehXGTqmlx\n"
+            + "nYu8DQLSzGbOQ/Z4srakC1mkM0LHCmULIIWk3KhV1GBCeArv7DlZ9A1SkI95bsq9\n"
+            + "GBeQpovL0PXKkOOWMJBklP/CTECO4eyA8r6c1d8wytBb6MrJ8bi74DdT+JlFjK5A\n"
+            + "zNoeNx6JwwKBgQCehIPABeuSYvRVlDTDqFkh98B6+4wBaatc5xjhuyOFW5dbaVeJ\n"
+            + "kKXmLSpAK6B44WnpQhA/uUWfuBWtoPy9nt+1yARjnxwzuSFyfUEqNiPC32coBYmd\n"
+            + "bIyGIIopQa1PTXJ4wtgoxw1PnmitHHITYPaLeKrN2te0fuAH+7dVodeU+QKBgAct\n"
+            + "VJbaw7Dh7+3yz+lui8TW5lMzwK/13fxGCfCSOFSLO3Gjkk+a0UW5VclmE+RQ333K\n"
+            + "OGtIx8RsO9vcC/wiZGwA06qWAu7AHoJ2D8fudtikbBlFFuXUAbgpOSTVYfMeCmTF\n"
+            + "QFuQIMdYm9dJLZnOkxLXrOZoHeui0poX2Ya6FawhAoGAAI/QCyDbuvnJzGmjSbvl\n"
+            + "5Ndr9lNAansCXaUzXuVLp6dD6PnB8HVCE8tdETZrcXseyTBeltaxAhj+tCybJvDO\n"
+            + "sV8UmPR0w9ibExmUIVGX5BpoRlB/KWxEG3ar/wJbUZVZ2oSdIAZvCvdbN956SLDg\n"
+            + "Pg5M5wrRqs71s2EiIJd0HrU="
+    );
+    private final String keyType;
+    private final String trustedCert;
+    private final String endCert;
+    private final String privateKey;
+
+    private KeyType(String keyType, String selfCert, String privateKey) {
+        this.keyType = keyType;
+        this.trustedCert = selfCert;
+        this.endCert = selfCert;
+        this.privateKey = privateKey;
+    }
+
+    public String getKeyType() {
+        return keyType;
+    }
+
+    public String getTrustedCert() {
+        return trustedCert;
+    }
+
+    public String getEndCert() {
+        return endCert;
+    }
+
+    public String getPrivateKey() {
+        return privateKey;
+    }
+}