| /* | |
| * Copyright (c) 2011, 2020, 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. | |
| */ | |
| // | |
| // SunJSSE does not support dynamic system properties, no way to re-use | |
| // system properties in samevm/agentvm mode. | |
| // | |
| /* | |
| * @test | |
| * @bug 7031830 | |
| * @summary bad_record_mac failure on TLSv1.2 enabled connection with SSLEngine | |
| * @library /test/lib /javax/net/ssl/templates | |
| * @run main/othervm SSLEngineBadBufferArrayAccess | |
| */ | |
| /** | |
| * A SSLSocket/SSLEngine interop test case. This is not the way to | |
| * code SSLEngine-based servers, but works for what we need to do here, | |
| * which is to make sure that SSLEngine/SSLSockets can talk to each other. | |
| * SSLEngines can use direct or indirect buffers, and different code | |
| * is used to get at the buffer contents internally, so we test that here. | |
| * | |
| * The test creates one SSLSocket (client) and one SSLEngine (server). | |
| * The SSLSocket talks to a raw ServerSocket, and the server code | |
| * does the translation between byte [] and ByteBuffers that the SSLEngine | |
| * can use. The "transport" layer consists of a Socket Input/OutputStream | |
| * and two byte buffers for the SSLEngines: think of them | |
| * as directly connected pipes. | |
| * | |
| * Again, this is a *very* simple example: real code will be much more | |
| * involved. For example, different threading and I/O models could be | |
| * used, transport mechanisms could close unexpectedly, and so on. | |
| * | |
| * When this application runs, notice that several messages | |
| * (wrap/unwrap) pass before any application data is consumed or | |
| * produced. (For more information, please see the SSL/TLS | |
| * specifications.) There may several steps for a successful handshake, | |
| * so it's typical to see the following series of operations: | |
| * | |
| * client server message | |
| * ====== ====== ======= | |
| * write() ... ClientHello | |
| * ... unwrap() ClientHello | |
| * ... wrap() ServerHello/Certificate | |
| * read() ... ServerHello/Certificate | |
| * write() ... ClientKeyExchange | |
| * write() ... ChangeCipherSpec | |
| * write() ... Finished | |
| * ... unwrap() ClientKeyExchange | |
| * ... unwrap() ChangeCipherSpec | |
| * ... unwrap() Finished | |
| * ... wrap() ChangeCipherSpec | |
| * ... wrap() Finished | |
| * read() ... ChangeCipherSpec | |
| * read() ... Finished | |
| * | |
| * This particular bug had a problem where byte buffers backed by an | |
| * array didn't offset correctly, and we got bad MAC errors. | |
| */ | |
| import javax.net.ssl.*; | |
| import javax.net.ssl.SSLEngineResult.*; | |
| import java.io.*; | |
| import java.net.*; | |
| import java.nio.*; | |
| import java.util.concurrent.CountDownLatch; | |
| import java.util.concurrent.TimeUnit; | |
| import jdk.test.lib.security.SecurityUtils; | |
| public class SSLEngineBadBufferArrayAccess extends SSLContextTemplate { | |
| /* | |
| * Enables logging of the SSL/TLS operations. | |
| */ | |
| private final static boolean logging = Boolean.parseBoolean( | |
| System.getProperty("test.logging", "true")); | |
| /* | |
| * Enables the JSSE system debugging system property: | |
| * | |
| * -Djavax.net.debug=all | |
| * | |
| * This gives a lot of low-level information about operations underway, | |
| * including specific handshake messages, and might be best examined | |
| * after gaining some familiarity with this application. | |
| */ | |
| private final static boolean debug = Boolean.getBoolean("test.debug"); | |
| private final String PROTOCOL; | |
| private SSLEngine serverEngine; // server-side SSLEngine | |
| private final byte[] serverMsg = "Hi there Client, I'm a Server".getBytes(); | |
| private final byte[] clientMsg = "Hello Server, I'm a Client".getBytes(); | |
| private ByteBuffer serverOut; // write side of serverEngine | |
| private ByteBuffer serverIn; // read side of serverEngine | |
| private volatile Exception clientException; | |
| private volatile Exception serverException; | |
| /* | |
| * For data transport, this example uses local ByteBuffers. | |
| */ | |
| private ByteBuffer cTOs; // "reliable" transport client->server | |
| private ByteBuffer sTOc; // "reliable" transport server->client | |
| /* | |
| * Is the server ready to serve? | |
| */ | |
| private static final CountDownLatch serverCondition = new CountDownLatch(1); | |
| /* | |
| * Is the client ready to handshake? | |
| */ | |
| private static final CountDownLatch clientCondition = new CountDownLatch(1); | |
| /* | |
| * What's the server port? Use any free port by default | |
| */ | |
| private volatile int serverPort = 0; | |
| /* | |
| * Main entry point for this test. | |
| */ | |
| public static void main(String[] args) throws Exception { | |
| if (debug) { | |
| System.setProperty("javax.net.debug", "all"); | |
| } | |
| // Re-enable TLSv1 and TLSv1.1 since test depends on them. | |
| SecurityUtils.removeFromDisabledTlsAlgs("TLSv1", "TLSv1.1"); | |
| String [] protocols = new String [] { | |
| "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3"}; | |
| for (String protocol : protocols) { | |
| /* | |
| * Run the tests with direct and indirect buffers. | |
| */ | |
| log("Testing " + protocol + ":true"); | |
| new SSLEngineBadBufferArrayAccess(protocol).runTest(true); | |
| log("Testing " + protocol + ":false"); | |
| new SSLEngineBadBufferArrayAccess(protocol).runTest(false); | |
| } | |
| System.out.println("Test Passed."); | |
| } | |
| /* | |
| * Create an initialized SSLContext to use for these tests. | |
| */ | |
| public SSLEngineBadBufferArrayAccess(String protocol) { | |
| PROTOCOL = protocol; | |
| } | |
| @Override | |
| protected ContextParameters getServerContextParameters() { | |
| return new ContextParameters(PROTOCOL, "PKIX", "NewSunX509"); | |
| } | |
| @Override | |
| protected ContextParameters getClientContextParameters() { | |
| return new ContextParameters(PROTOCOL, "PKIX", "NewSunX509"); | |
| } | |
| /* | |
| * Run the test. | |
| * | |
| * Sit in a tight loop, with the server engine calling wrap/unwrap | |
| * regardless of whether data is available or not. We do this until | |
| * we get the application data. Then we shutdown and go to the next one. | |
| * | |
| * The main loop handles all of the I/O phases of the SSLEngine's | |
| * lifetime: | |
| * | |
| * initial handshaking | |
| * application data transfer | |
| * engine closing | |
| * | |
| * One could easily separate these phases into separate | |
| * sections of code. | |
| */ | |
| private void runTest(boolean direct) throws Exception { | |
| boolean serverClose = direct; | |
| System.out.println("Running test serverClose = " + serverClose); | |
| ServerSocket serverSocket = new ServerSocket(0); | |
| serverPort = serverSocket.getLocalPort(); | |
| // Signal the client, the server is ready to accept connection. | |
| serverCondition.countDown(); | |
| Thread clientThread = runClient(serverClose); | |
| // Try to accept a connection in 30 seconds. | |
| Socket socket; | |
| try { | |
| serverSocket.setSoTimeout(30000); | |
| socket = serverSocket.accept(); | |
| } catch (SocketTimeoutException ste) { | |
| serverSocket.close(); | |
| // 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; | |
| } | |
| // 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(socket, direct, serverClose); | |
| } 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."); | |
| } | |
| } catch (Exception e) { | |
| System.out.println("Server died ..."); | |
| e.printStackTrace(System.out); | |
| serverException = e; | |
| } finally { | |
| socket.close(); | |
| serverSocket.close(); | |
| } | |
| clientThread.join(); | |
| if (clientException != null || serverException != null) { | |
| throw new RuntimeException("Test failed"); | |
| } | |
| } | |
| /* | |
| * Define the server side application of the test for the specified socket. | |
| */ | |
| void runServerApplication(Socket socket, boolean direct, | |
| boolean serverClose) throws Exception { | |
| socket.setSoTimeout(500); | |
| createSSLEngine(); | |
| createBuffers(direct); | |
| boolean closed = false; | |
| InputStream is = socket.getInputStream(); | |
| OutputStream os = socket.getOutputStream(); | |
| SSLEngineResult serverResult; // results from last operation | |
| /* | |
| * Examining the SSLEngineResults could be much more involved, | |
| * and may alter the overall flow of the application. | |
| * | |
| * For example, if we received a BUFFER_OVERFLOW when trying | |
| * to write to the output pipe, we could reallocate a larger | |
| * pipe, but instead we wait for the peer to drain it. | |
| */ | |
| byte[] inbound = new byte[8192]; | |
| byte[] outbound = new byte[8192]; | |
| while (!isEngineClosed(serverEngine)) { | |
| int len; | |
| // Inbound data | |
| log("================"); | |
| // Read from the Client side. | |
| try { | |
| len = is.read(inbound); | |
| if (len == -1) { | |
| logSocketStatus(socket); | |
| if (socket.isClosed() | |
| || socket.isOutputShutdown()) { | |
| log("Client socket was closed or shutdown output"); | |
| break; | |
| } else { | |
| throw new Exception("Unexpected EOF"); | |
| } | |
| } | |
| cTOs.put(inbound, 0, len); | |
| } catch (SocketTimeoutException ste) { | |
| // swallow. Nothing yet, probably waiting on us. | |
| System.out.println("Warning: " + ste); | |
| } | |
| cTOs.flip(); | |
| serverResult = serverEngine.unwrap(cTOs, serverIn); | |
| log("server unwrap: ", serverResult); | |
| runDelegatedTasks(serverResult, serverEngine); | |
| cTOs.compact(); | |
| // Outbound data | |
| log("----"); | |
| serverResult = serverEngine.wrap(serverOut, sTOc); | |
| log("server wrap: ", serverResult); | |
| runDelegatedTasks(serverResult, serverEngine); | |
| sTOc.flip(); | |
| if ((len = sTOc.remaining()) != 0) { | |
| sTOc.get(outbound, 0, len); | |
| os.write(outbound, 0, len); | |
| // Give the other side a chance to process | |
| } | |
| sTOc.compact(); | |
| if (!closed && (serverOut.remaining() == 0)) { | |
| closed = true; | |
| /* | |
| * We'll alternate initiating the shutdown. | |
| * When the server initiates, it will take one more | |
| * loop, but tests the orderly shutdown. | |
| */ | |
| if (serverClose) { | |
| serverEngine.closeOutbound(); | |
| } | |
| serverIn.flip(); | |
| /* | |
| * A sanity check to ensure we got what was sent. | |
| */ | |
| if (serverIn.remaining() != clientMsg.length) { | |
| throw new Exception("Client: Data length error -" + | |
| " IF THIS FAILS, PLEASE REPORT THIS TO THE" + | |
| " SECURITY TEAM. WE HAVE BEEN UNABLE TO" + | |
| " RELIABLY DUPLICATE."); | |
| } | |
| for (int i = 0; i < clientMsg.length; i++) { | |
| if (clientMsg[i] != serverIn.get()) { | |
| throw new Exception("Client: Data content error -" + | |
| " IF THIS FAILS, PLEASE REPORT THIS TO THE" + | |
| " SECURITY TEAM. WE HAVE BEEN UNABLE TO" + | |
| " RELIABLY DUPLICATE."); | |
| } | |
| } | |
| serverIn.compact(); | |
| break; | |
| } | |
| } | |
| } | |
| /* | |
| * Create a client thread which does simple SSLSocket operations. | |
| * We'll write and read one data packet. | |
| */ | |
| private Thread runClient(final boolean serverClose) | |
| throws Exception { | |
| Thread t = new Thread("ClientThread") { | |
| @Override | |
| public void run() { | |
| try { | |
| doClientSide(serverClose); | |
| } catch (Exception e) { | |
| System.out.println("Client died ..."); | |
| e.printStackTrace(System.out); | |
| clientException = e; | |
| } | |
| } | |
| }; | |
| t.start(); | |
| return t; | |
| } | |
| /* | |
| * Define the client side of the test. | |
| */ | |
| void doClientSide(boolean serverClose) 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; | |
| } | |
| SSLSocketFactory sslsf = createClientSSLContext().getSocketFactory(); | |
| try (SSLSocket sslSocket = (SSLSocket)sslsf.createSocket()) { | |
| try { | |
| sslSocket.connect( | |
| new InetSocketAddress("localhost", serverPort), 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, serverClose); | |
| } | |
| } | |
| /* | |
| * Define the server side application of the test for the specified socket. | |
| */ | |
| void runClientApplication(SSLSocket sslSocket, boolean serverClose) | |
| throws Exception { | |
| OutputStream os = sslSocket.getOutputStream(); | |
| InputStream is = sslSocket.getInputStream(); | |
| // write(byte[]) goes in one shot. | |
| System.out.println("writing message to server."); | |
| os.write(clientMsg); | |
| byte[] inbound = new byte[2048]; | |
| int pos = 0; | |
| int len; | |
| while ((len = is.read(inbound, pos, 2048 - pos)) != -1) { | |
| System.out.printf("Client read %d bytes. Waiting for %d from server.%n", len, serverMsg.length); | |
| pos += len; | |
| // Let the client do the closing. | |
| if ((pos == serverMsg.length) && !serverClose) { | |
| System.out.println("Closing the socket"); | |
| sslSocket.close(); | |
| break; | |
| } | |
| } | |
| System.out.println("Read everything we're going to, I guess."); | |
| if (pos != serverMsg.length) { | |
| throw new Exception("Client: Data length error"); | |
| } | |
| for (int i = 0; i < serverMsg.length; i++) { | |
| if (inbound[i] != serverMsg[i]) { | |
| throw new Exception("Client: Data content error"); | |
| } | |
| } | |
| } | |
| /* | |
| * Using the SSLContext created during object creation, | |
| * create/configure the SSLEngines we'll use for this test. | |
| */ | |
| private void createSSLEngine() throws Exception { | |
| /* | |
| * Configure the serverEngine to act as a server in the SSL/TLS | |
| * handshake. | |
| */ | |
| serverEngine = createServerSSLContext().createSSLEngine(); | |
| serverEngine.setUseClientMode(false); | |
| serverEngine.getNeedClientAuth(); | |
| } | |
| /* | |
| * Create and size the buffers appropriately. | |
| */ | |
| private void createBuffers(boolean direct) { | |
| SSLSession session = serverEngine.getSession(); | |
| int appBufferMax = session.getApplicationBufferSize(); | |
| int netBufferMax = session.getPacketBufferSize(); | |
| /* | |
| * We'll make the input buffers a bit bigger than the max needed | |
| * size, so that unwrap()s following a successful data transfer | |
| * won't generate BUFFER_OVERFLOWS. | |
| * | |
| * We'll use a mix of direct and indirect ByteBuffers for | |
| * tutorial purposes only. In reality, only use direct | |
| * ByteBuffers when they give a clear performance enhancement. | |
| */ | |
| if (direct) { | |
| serverIn = ByteBuffer.allocateDirect(appBufferMax + 50); | |
| cTOs = ByteBuffer.allocateDirect(netBufferMax); | |
| sTOc = ByteBuffer.allocateDirect(netBufferMax); | |
| } else { | |
| serverIn = ByteBuffer.allocate(appBufferMax + 50); | |
| cTOs = ByteBuffer.allocate(netBufferMax); | |
| sTOc = ByteBuffer.allocate(netBufferMax); | |
| } | |
| serverOut = ByteBuffer.wrap(serverMsg); | |
| } | |
| /* | |
| * If the result indicates that we have outstanding tasks to do, | |
| * go ahead and run them in this thread. | |
| */ | |
| private static void runDelegatedTasks(SSLEngineResult result, | |
| SSLEngine engine) throws Exception { | |
| if (result.getHandshakeStatus() == HandshakeStatus.NEED_TASK) { | |
| Runnable runnable; | |
| while ((runnable = engine.getDelegatedTask()) != null) { | |
| log("\trunning delegated task..."); | |
| runnable.run(); | |
| } | |
| HandshakeStatus hsStatus = engine.getHandshakeStatus(); | |
| if (hsStatus == HandshakeStatus.NEED_TASK) { | |
| throw new Exception( | |
| "handshake shouldn't need additional tasks"); | |
| } | |
| log("\tnew HandshakeStatus: " + hsStatus); | |
| } | |
| } | |
| private static boolean isEngineClosed(SSLEngine engine) { | |
| return (engine.isOutboundDone() && engine.isInboundDone()); | |
| } | |
| private static void logSocketStatus(Socket socket) { | |
| log("##### " + socket + " #####"); | |
| log("isBound: " + socket.isBound()); | |
| log("isConnected: " + socket.isConnected()); | |
| log("isClosed: " + socket.isClosed()); | |
| log("isInputShutdown: " + socket.isInputShutdown()); | |
| log("isOutputShutdown: " + socket.isOutputShutdown()); | |
| } | |
| /* | |
| * Logging code | |
| */ | |
| private static boolean resultOnce = true; | |
| private static void log(String str, SSLEngineResult result) { | |
| if (!logging) { | |
| return; | |
| } | |
| if (resultOnce) { | |
| resultOnce = false; | |
| System.out.println("The format of the SSLEngineResult is: \n" | |
| + "\t\"getStatus() / getHandshakeStatus()\" +\n" | |
| + "\t\"bytesConsumed() / bytesProduced()\"\n"); | |
| } | |
| HandshakeStatus hsStatus = result.getHandshakeStatus(); | |
| log(str | |
| + result.getStatus() + "/" + hsStatus + ", " | |
| + result.bytesConsumed() + "/" + result.bytesProduced() | |
| + " bytes"); | |
| if (hsStatus == HandshakeStatus.FINISHED) { | |
| log("\t...ready for application data"); | |
| } | |
| } | |
| private static void log(String str) { | |
| if (logging) { | |
| System.out.println(str); | |
| } | |
| } | |
| } |