Skip to content

Commit

Permalink
API for SSLParameters
Browse files Browse the repository at this point in the history
Enabled hostname validation by default
  • Loading branch information
marci4 committed Apr 13, 2020
1 parent 455d09e commit 2dbe2d3
Show file tree
Hide file tree
Showing 4 changed files with 212 additions and 3 deletions.
18 changes: 16 additions & 2 deletions src/main/java/org/java_websocket/client/WebSocketClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,6 @@ public void run() {
} else if( socket == null ) {
socket = new Socket( proxy );
isNewSocket = true;

} else if( socket.isClosed() ) {
throw new IOException();
}
Expand All @@ -464,13 +463,19 @@ public void run() {

// if the socket is set by others we don't apply any TLS wrapper
if (isNewSocket && "wss".equals( uri.getScheme())) {

SSLContext sslContext = SSLContext.getInstance("TLSv1.2");
sslContext.init(null, null, null);
SSLSocketFactory factory = sslContext.getSocketFactory();
socket = factory.createSocket(socket, uri.getHost(), getPort(), true);
}

if (socket instanceof SSLSocket) {
SSLSocket sslSocket = (SSLSocket)socket;
SSLParameters sslParameters = sslSocket.getSSLParameters();
onSetSSLParameters(sslParameters);
sslSocket.setSSLParameters(sslParameters);
}

istream = socket.getInputStream();
ostream = socket.getOutputStream();

Expand Down Expand Up @@ -511,6 +516,15 @@ public void run() {
connectReadThread = null;
}

/**
* Apply specific
* @param sslParameters the SSLParameters which will be used for the SSLSocket
*/
protected void onSetSSLParameters(SSLParameters sslParameters) {
// Make sure we perform hostname validation
sslParameters.setEndpointIdentificationAlgorithm("HTTPS");
}

/**
* Extract the specified port
* @return the specified port or the default port for the specific scheme
Expand Down
174 changes: 174 additions & 0 deletions src/test/java/org/java_websocket/issues/Issue997Test.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
package org.java_websocket.issues;

/*
* Copyright (c) 2010-2020 Nathan Rajlich
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
*/


import org.java_websocket.WebSocket;
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.handshake.ClientHandshake;
import org.java_websocket.handshake.ServerHandshake;
import org.java_websocket.server.DefaultSSLWebSocketServerFactory;
import org.java_websocket.server.WebSocketServer;
import org.java_websocket.util.SSLContextUtil;
import org.java_websocket.util.SocketUtil;
import org.junit.Test;

import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLHandshakeException;
import javax.net.ssl.SSLParameters;
import java.io.IOException;
import java.net.*;
import java.security.KeyManagementException;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.UnrecoverableKeyException;
import java.security.cert.CertificateException;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

import static org.junit.Assert.*;

public class Issue997Test {

@Test(timeout=2000)
public void test_localServer_ServerLocalhost_Client127_CheckActive() throws CertificateException, UnrecoverableKeyException, NoSuchAlgorithmException, KeyManagementException, KeyStoreException, IOException, URISyntaxException, InterruptedException {
SSLWebSocketClient client = testIssueWithLocalServer("127.0.0.1", SocketUtil.getAvailablePort(), SSLContextUtil.getLocalhostOnlyContext(), SSLContextUtil.getLocalhostOnlyContext(), "HTTPS");
assertFalse(client.onOpen);
assertTrue(client.onSSLError);
}
@Test(timeout=2000)
public void test_localServer_ServerLocalhost_Client127_CheckInactive() throws CertificateException, UnrecoverableKeyException, NoSuchAlgorithmException, KeyManagementException, KeyStoreException, IOException, URISyntaxException, InterruptedException {
SSLWebSocketClient client = testIssueWithLocalServer("127.0.0.1", SocketUtil.getAvailablePort(), SSLContextUtil.getLocalhostOnlyContext(), SSLContextUtil.getLocalhostOnlyContext(), "");
assertTrue(client.onOpen);
assertFalse(client.onSSLError);
}

@Test(timeout=2000)
public void test_localServer_ServerLocalhost_ClientLocalhost_CheckActive() throws CertificateException, UnrecoverableKeyException, NoSuchAlgorithmException, KeyManagementException, KeyStoreException, IOException, URISyntaxException, InterruptedException {
SSLWebSocketClient client = testIssueWithLocalServer("localhost", SocketUtil.getAvailablePort(), SSLContextUtil.getLocalhostOnlyContext(), SSLContextUtil.getLocalhostOnlyContext(), "HTTPS");
assertTrue(client.onOpen);
assertFalse(client.onSSLError);
}
@Test(timeout=2000)
public void test_localServer_ServerLocalhost_ClientLocalhost_CheckInactive() throws CertificateException, UnrecoverableKeyException, NoSuchAlgorithmException, KeyManagementException, KeyStoreException, IOException, URISyntaxException, InterruptedException {
SSLWebSocketClient client = testIssueWithLocalServer("localhost", SocketUtil.getAvailablePort(), SSLContextUtil.getLocalhostOnlyContext(), SSLContextUtil.getLocalhostOnlyContext(), "");
assertTrue(client.onOpen);
assertFalse(client.onSSLError);
}


public SSLWebSocketClient testIssueWithLocalServer(String address, int port, SSLContext serverContext, SSLContext clientContext, String endpointIdentificationAlgorithm) throws IOException, URISyntaxException, InterruptedException {
CountDownLatch countServerDownLatch = new CountDownLatch(1);
SSLWebSocketClient client = new SSLWebSocketClient(address, port, endpointIdentificationAlgorithm);
WebSocketServer server = new SSLWebSocketServer(port, countServerDownLatch);

server.setWebSocketFactory(new DefaultSSLWebSocketServerFactory(serverContext));
if (clientContext != null) {
client.setSocketFactory(clientContext.getSocketFactory());
}
server.start();
countServerDownLatch.await();
client.connectBlocking(1, TimeUnit.SECONDS);
return client;
}


private static class SSLWebSocketClient extends WebSocketClient {
private final String endpointIdentificationAlgorithm;
public boolean onSSLError = false;
public boolean onOpen = false;

public SSLWebSocketClient(String address, int port, String endpointIdentificationAlgorithm) throws URISyntaxException {
super(new URI("wss://"+ address + ':' +port));
this.endpointIdentificationAlgorithm = endpointIdentificationAlgorithm;
}

@Override
public void onOpen(ServerHandshake handshakedata) {
this.onOpen = true;
}

@Override
public void onMessage(String message) {
}

@Override
public void onClose(int code, String reason, boolean remote) {
}

@Override
public void onError(Exception ex) {
if (ex instanceof SSLHandshakeException) {
this.onSSLError = true;
}
}

@Override
protected void onSetSSLParameters(SSLParameters sslParameters) {
if (endpointIdentificationAlgorithm == null) {
super.onSetSSLParameters(sslParameters);
} else {
sslParameters.setEndpointIdentificationAlgorithm(endpointIdentificationAlgorithm);
}
}

};


private static class SSLWebSocketServer extends WebSocketServer {
private final CountDownLatch countServerDownLatch;


public SSLWebSocketServer(int port, CountDownLatch countServerDownLatch) {
super(new InetSocketAddress(port));
this.countServerDownLatch = countServerDownLatch;
}

@Override
public void onOpen(WebSocket conn, ClientHandshake handshake) {
}

@Override
public void onClose(WebSocket conn, int code, String reason, boolean remote) {
}

@Override
public void onMessage(WebSocket conn, String message) {

}

@Override
public void onError(WebSocket conn, Exception ex) {
ex.printStackTrace();
}

@Override
public void onStart() {
countServerDownLatch.countDown();
}
}
}
Binary file not shown.
23 changes: 22 additions & 1 deletion src/test/java/org/java_websocket/util/SSLContextUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
import javax.net.ssl.TrustManagerFactory;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.security.*;
import java.security.cert.CertificateException;
Expand Down Expand Up @@ -59,4 +58,26 @@ public static SSLContext getContext() throws NoSuchAlgorithmException, KeyManage
sslContext.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null);
return sslContext;
}

public static SSLContext getLocalhostOnlyContext() throws NoSuchAlgorithmException, KeyManagementException, KeyStoreException, IOException, CertificateException, UnrecoverableKeyException {
// load up the key store
String STORETYPE = "JKS";
String KEYSTORE = String.format("src%1$stest%1$1sjava%1$1sorg%1$1sjava_websocket%1$1skeystore_localhost_only.jks", File.separator);
String STOREPASSWORD = "storepassword";
String KEYPASSWORD = "keypassword";

KeyStore ks = KeyStore.getInstance(STORETYPE);
File kf = new File(KEYSTORE);
ks.load(new FileInputStream(kf), STOREPASSWORD.toCharArray());

KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509");
kmf.init(ks, KEYPASSWORD.toCharArray());
TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509");
tmf.init(ks);

SSLContext sslContext = null;
sslContext = SSLContext.getInstance("TLS");
sslContext.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null);
return sslContext;
}
}

0 comments on commit 2dbe2d3

Please sign in to comment.