/*
* Copyright (c) 2005, 2011, 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.
*/
/*
* @test
* @bug 4836493
* @summary Socket timeouts for SSLSockets causes data corruption.
* @run main/othervm ClientTimeout
*
* SunJSSE does not support dynamic system properties, no way to re-use
* system properties in samevm/agentvm mode.
*/
import java.io.*;
import java.net.*;
import java.util.*;
import java.security.*;
import javax.net.ssl.*;
public class ClientTimeout {
/*
* =============================================================
* Set the various variables needed for the tests, then
* specify what tests to run on each side.
*/
/*
* 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.
*/
static boolean separateServerThread = true;
/*
* Where do we find the keystores?
*/
static String pathToStores = "/../../../../../../../etc";
static String keyStoreFile = "keystore";
static String trustStoreFile = "truststore";
static String passwd = "passphrase";
/*
* Is the server ready to serve?
*/
volatile static boolean serverReady = false;
/*
* Turn on SSL debugging?
*/
static boolean debug = false;
/*
* define the rhythm of timeout exception
*/
static boolean rhythm = true;
/*
* 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....
*/
/*
* Define the server side of the test.
*
* If the server prematurely exits, serverReady will be set to true
* to avoid infinite hangs.
*/
void doServerSide() throws Exception {
SSLServerSocketFactory sslssf =
(SSLServerSocketFactory) SSLServerSocketFactory.getDefault();
SSLServerSocket sslServerSocket =
(SSLServerSocket) sslssf.createServerSocket(serverPort);
serverPort = sslServerSocket.getLocalPort();
/*
* Signal Client, we're ready for his connect.
*/
serverReady = true;
SSLSocket sslSocket = (SSLSocket) sslServerSocket.accept();
InputStream sslIS = sslSocket.getInputStream();
OutputStream sslOS = sslSocket.getOutputStream();
sslSocket.startHandshake();
// transfer a file to client.
String transFilename =
System.getProperty("test.src", "./") + "/" +
this.getClass().getName() + ".java";
MessageDigest md = MessageDigest.getInstance("SHA");
DigestInputStream transIns = new DigestInputStream(
new FileInputStream(transFilename), md);
byte[] bytes = new byte[2000];
int i = 0;
while (true) {
// reset the cycle
if (i >= bytes.length) {
i = 0;
}
int length = 0;
if ((length = transIns.read(bytes, 0, i++)) == -1) {
break;
} else {
sslOS.write(bytes, 0, length);
sslOS.flush();
if (i % 3 == 0) {
Thread.sleep(300); // Stall past the timeout...
}
}
}
serverDigest = md.digest();
transIns.close();
sslSocket.close();
}
/*
* Define the client side of the test.
*
* If the server prematurely exits, serverReady will be set to true
* to avoid infinite hangs.
*/
void doClientSide() throws Exception {
boolean caught = false;
/*
* Wait for server to get started.
*/
while (!serverReady) {
Thread.sleep(50);
}
Socket baseSocket = new Socket("localhost", serverPort) {
MyInputStream ins = null;
public InputStream getInputStream() throws IOException {
if (ins != null) {
return ins;
} else {
ins = new MyInputStream(super.getInputStream());
return ins;
}
}
};
SSLSocketFactory sslsf =
(SSLSocketFactory) SSLSocketFactory.getDefault();
SSLSocket sslSocket = (SSLSocket)
sslsf.createSocket(baseSocket, "localhost", serverPort, true);
InputStream sslIS = sslSocket.getInputStream();
OutputStream sslOS = sslSocket.getOutputStream();
// handshaking
sslSocket.setSoTimeout(100); // The stall timeout.
while (true) {
try {
rhythm = true;
sslSocket.startHandshake();
break;
} catch (SocketTimeoutException e) {
System.out.println("Handshaker exception: "
+ e.getMessage());
}
}
// read application data from server
MessageDigest md = MessageDigest.getInstance("SHA");
DigestInputStream transIns = new DigestInputStream(sslIS, md);
byte[] bytes = new byte[2000];
while (true) {
try {
rhythm = true;
while (transIns.read(bytes, 0, 17) != -1) {
rhythm = true;
}
break;
} catch (SocketTimeoutException e) {
System.out.println("InputStream Exception: "
+ e.getMessage());
}
}
// Wait for server to get ready.
while (serverDigest == null) {
Thread.sleep(20);
}
byte[] cliDigest = md.digest();
if (!Arrays.equals(cliDigest, serverDigest)) {
throw new Exception("Application data trans error");
}
transIns.close();
sslSocket.close();
}
/*
* =============================================================
* The remainder is just support stuff
*/
static class MyInputStream extends InputStream {
InputStream ins = null;
public MyInputStream(InputStream ins) {
this.ins = ins;
}
public int read() throws IOException {
return read(new byte[1], 0, 1);
}
public int read(byte[] data, int offset, int len) throws IOException {
if (!ClientTimeout.rhythm) {
throw new SocketTimeoutException(
"Throwing a timeout exception");
}
ClientTimeout.rhythm = false;
return ins.read(data, offset, len);
}
}
// use any free port by default
volatile int serverPort = 0;
volatile Exception serverException = null;
volatile Exception clientException = null;
volatile byte[] serverDigest = null;
public static void main(String[] args) throws Exception {
String keyFilename =
System.getProperty("test.src", "./") + "/" + pathToStores +
"/" + keyStoreFile;
String trustFilename =
System.getProperty("test.src", "./") + "/" + pathToStores +
"/" + trustStoreFile;
System.setProperty("javax.net.ssl.keyStore", keyFilename);
System.setProperty("javax.net.ssl.keyStorePassword", passwd);
System.setProperty("javax.net.ssl.trustStore", trustFilename);
System.setProperty("javax.net.ssl.trustStorePassword", passwd);
if (debug)
System.setProperty("javax.net.debug", "all");
/*
* Start the tests.
*/
new ClientTimeout();
}
Thread clientThread = null;
Thread serverThread = null;
/*
* Primary constructor, used to drive remainder of the test.
*
* Fork off the other side, then do your work.
*/
ClientTimeout() throws Exception {
if (separateServerThread) {
startServer(true);
startClient(false);
} else {
startClient(true);
startServer(false);
}
/*
* Wait for other side to close down.
*/
if (separateServerThread) {
serverThread.join();
} else {
clientThread.join();
}
/*
* When we get here, the test is pretty much over.
*
* If the main thread excepted, that propagates back
* immediately. If the other thread threw an exception, we
* should report back.
*/
if (serverException != null) {
System.out.print("Server Exception:");
throw serverException;
}
if (clientException != null) {
System.out.print("Client Exception:");
throw clientException;
}
}
void startServer(boolean newThread) throws Exception {
if (newThread) {
serverThread = new Thread() {
public void run() {
try {
doServerSide();
} catch (Exception e) {
/*
* Our server thread just died.
*
* Release the client, if not active already...
*/
System.err.println("Server died...");
System.err.println(e);
serverReady = true;
serverException = e;
}
}
};
serverThread.start();
} else {
doServerSide();
}
}
void startClient(boolean newThread) throws Exception {
if (newThread) {
clientThread = new Thread() {
public void run() {
try {
doClientSide();
} catch (Exception e) {
/*
* Our client thread just died.
*/
System.err.println("Client died...");
clientException = e;
}
}
};
clientThread.start();
} else {
doClientSide();
}
}
}