Supporting basic authorization for websocket

Usage:
For URI, type ws(s)://username:password@host/path

Also modified extracting hostname / port from address, to use the URI class for help, instead of using substrings (which didn't take userinfo into account).

Signed-off-by: Arve Skogvold <arve@skogvold.org>

Author: askogvold

org.eclipse.paho.client.mqttv3.test/src/test/java/org/eclipse/paho/client/mqttv3/test/WebSocketTest.java

@@ -243,8 +243,27 @@ public void largePayloadTest() throws Exception{
 
   }
 
+  @Test
+  public void testBasicAuth() throws Exception {
+    String methodName = Utility.getMethodName();
+    LoggingUtilities.banner(log, cclass, methodName);
 
+    String userInfo = "username:password";
 
+    String clientId = methodName;
+
+    URI serverURIWithUserInfo = new URI(serverURI.getScheme(),
+            userInfo,
+            serverURI.getHost(),
+            serverURI.getPort(),
+            serverURI.getPath(),
+            serverURI.getQuery(),
+            serverURI.getFragment());
+
+    IMqttClient client = clientFactory.createMqttClient(serverURIWithUserInfo, clientId);
+    client.connect();
+    client.disconnect();
+  }
 
   // -------------------------------------------------------------
   // Helper methods/classes

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttAsyncClient.java

@@ -21,6 +21,8 @@
 
 package org.eclipse.paho.client.mqttv3;
 
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.Hashtable;
 import java.util.Properties;
 import java.util.Timer;
@@ -358,7 +360,7 @@ protected NetworkModule[] createNetworkModules(String address, MqttConnectOption
 	 * supplied address URI.
 	 *
 	 * @param address the URI for the server.
-	 * @param Connect options
+	 * @param options Connect options
 	 * @return a network module appropriate to the specified address.
 	 */
 	private NetworkModule createNetworkModule(String address, MqttConnectOptions options) throws MqttException, MqttSecurityException {
@@ -367,18 +369,25 @@ private NetworkModule createNetworkModule(String address, MqttConnectOptions opt
 		log.fine(CLASS_NAME,methodName, "115", new Object[] {address});
 
 		NetworkModule netModule;
-		String shortAddress;
-		String host;
-		int port;
 		SocketFactory factory = options.getSocketFactory();
 
 		int serverURIType = MqttConnectOptions.validateURI(address);
 
+		URI uri;
+		try {
+			uri = new URI(address);
+		} catch (URISyntaxException e) {
+			throw new IllegalArgumentException("Malformed URI: " + address, e);
+		}
+
+		String host = uri.getHost();
+		int port = uri.getPort(); // -1 if not defined
+
 		switch (serverURIType) {
 		case MqttConnectOptions.URI_TYPE_TCP :
-			shortAddress = address.substring(6);
-			host = getHostName(shortAddress);
-			port = getPort(shortAddress, 1883);
+			if (port == -1) {
+				port = 1883;
+			}
 			if (factory == null) {
 				factory = SocketFactory.getDefault();
 			}
@@ -389,9 +398,9 @@ else if (factory instanceof SSLSocketFactory) {
 			((TCPNetworkModule)netModule).setConnectTimeout(options.getConnectionTimeout());
 			break;
 		case MqttConnectOptions.URI_TYPE_SSL:
-			shortAddress = address.substring(6);
-			host = getHostName(shortAddress);
-			port = getPort(shortAddress, 8883);
+			if (port == -1) {
+				port = 8883;
+			}
 			SSLSocketFactoryFactory factoryFactory = null;
 			if (factory == null) {
 //				try {
@@ -421,9 +430,9 @@ else if ((factory instanceof SSLSocketFactory) == false) {
 			}
 			break;
 		case MqttConnectOptions.URI_TYPE_WS:
-			shortAddress = address.substring(5);
-			host = getHostName(shortAddress);
-			port = getPort(shortAddress, 80);
+			if (port == -1) {
+				port = 80;
+			}
 			if (factory == null) {
 				factory = SocketFactory.getDefault();
 			}
@@ -434,9 +443,9 @@ else if (factory instanceof SSLSocketFactory) {
 			((WebSocketNetworkModule)netModule).setConnectTimeout(options.getConnectionTimeout());
 			break;
 		case MqttConnectOptions.URI_TYPE_WSS:
-			shortAddress = address.substring(6);
-			host = getHostName(shortAddress);
-			port = getPort(shortAddress, 443);
+			if (port == -1) {
+				port = 443;
+			}
 			SSLSocketFactoryFactory wSSFactoryFactory = null;
 			if (factory == null) {
 				wSSFactoryFactory = new SSLSocketFactoryFactory();
@@ -471,33 +480,6 @@ else if ((factory instanceof SSLSocketFactory) == false) {
 		return netModule;
 	}
 
-	private int getPort(String uri, int defaultPort) {
-		int port;
-		int portIndex = uri.lastIndexOf(':');
-		if (portIndex == -1) {
-			port = defaultPort;
-		}
-		else {
-			int slashIndex = uri.indexOf('/');
-			if (slashIndex == -1) {
-				slashIndex = uri.length();
-			}
-		    port = Integer.parseInt(uri.substring(portIndex + 1, slashIndex));
-		}
-		return port;
-	}
-
-	private String getHostName(String uri) {
-		int portIndex = uri.indexOf(':');
-		if (portIndex == -1) {
-			portIndex = uri.indexOf('/');
-		}
-		if (portIndex == -1) {
-			portIndex = uri.length();
-		}
-		return uri.substring(0, portIndex);
-	}
-
 	/* (non-Javadoc)
 	 * @see org.eclipse.paho.client.mqttv3.IMqttAsyncClient#connect(java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)
 	 */

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/websocket/WebSocketHandshake.java

@@ -77,7 +77,7 @@ public void execute() throws IOException {
 	/**
 	 * Builds and sends the HTTP Header GET Request
 	 * for the socket.
-	 * @param Base64 encoded key
+	 * @param key Base64 encoded key
 	 * @throws IOException
 	 */
 	private void sendHandshakeRequest(String key) throws IOException{
@@ -99,6 +99,12 @@ private void sendHandshakeRequest(String key) throws IOException{
 			pw.print("Sec-WebSocket-Key: " + key + LINE_SEPARATOR);
 			pw.print("Sec-WebSocket-Protocol: mqttv3.1" + LINE_SEPARATOR);
 			pw.print("Sec-WebSocket-Version: 13" + LINE_SEPARATOR);
+
+			String userInfo = srvUri.getUserInfo();
+			if(userInfo != null) {
+				pw.print("Authorization: Basic " + Base64.encode(userInfo) + LINE_SEPARATOR);
+			}
+
 			pw.print(LINE_SEPARATOR);
 			pw.flush();
 		} catch (URISyntaxException e) {
@@ -108,7 +114,7 @@ private void sendHandshakeRequest(String key) throws IOException{
 
 	/**
 	 * Receives the Handshake response and verifies that it is valid.
-	 * @param Base64 encoded key
+	 * @param key Base64 encoded key
 	 * @throws IOException
 	 */
 	private void receiveHandshakeResponse(String key) throws IOException {