Merge pull request quarkusio#49915 from gamliela/handshake-peer-address

WebSockets Next: Expose localAddress and remoteAddress in HandshakeRequest

Author: gastaldi

extensions/websockets-next/deployment/src/test/java/io/quarkus/websockets/next/test/client/BasicConnectorTest.java

@@ -91,6 +91,8 @@ void testClient() throws InterruptedException {
                 })
                 .onClose((c, s) -> closedLatch.countDown())
                 .connectAndAwait();
+        assertTrue(connection1.handshakeRequest().localAddress().matches("127\\.0\\.0\\.1:\\d+"));
+        assertEquals("127.0.0.1:8081", connection1.handshakeRequest().remoteAddress());
         assertEquals("Lu", connection1.pathParam("name"));
         assertTrue(connection1.userData().get(TypedKey.forBoolean("boolean")));
         assertEquals(Integer.MAX_VALUE, connection1.userData().get(TypedKey.forInt("int")));
@@ -131,6 +133,8 @@ void testClient() throws InterruptedException {
                 })
                 .connectAndAwait();
         assertNotNull(connection2);
+        assertTrue(connection2.handshakeRequest().localAddress().matches("127\\.0\\.0\\.1:\\d+"));
+        assertEquals("127.0.0.1:8081", connection2.handshakeRequest().remoteAddress());
         assertTrue(conn2Latch.await(5, TimeUnit.SECONDS));
     }
 

extensions/websockets-next/deployment/src/test/java/io/quarkus/websockets/next/test/handshake/HandshakeRequestTest.java

@@ -1,6 +1,7 @@
 package io.quarkus.websockets.next.test.handshake;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.net.URI;
 
@@ -48,6 +49,8 @@ void testHandshake() {
         assertEquals(baseUri.getPort(), reply.getInteger("port"));
         assertEquals("/head", reply.getString("path"));
         assertEquals(query, reply.getString("query"));
+        assertEquals("127.0.0.1:8081", reply.getString("localAddress"));
+        assertTrue(reply.getString("remoteAddress").matches("127\\.0\\.0\\.1:\\d+"));
     }
 
     @WebSocket(path = "/head")
@@ -67,7 +70,9 @@ JsonObject process(String message) throws InterruptedException {
                     .put("host", connection.handshakeRequest().host())
                     .put("port", connection.handshakeRequest().port())
                     .put("path", connection.handshakeRequest().path())
-                    .put("query", connection.handshakeRequest().query());
+                    .put("query", connection.handshakeRequest().query())
+                    .put("localAddress", connection.handshakeRequest().localAddress().toString())
+                    .put("remoteAddress", connection.handshakeRequest().remoteAddress().toString());
         }
 
     }

extensions/websockets-next/runtime/src/main/java/io/quarkus/websockets/next/HandshakeRequest.java

@@ -43,34 +43,44 @@ public interface HandshakeRequest {
 
     /**
      *
-     * @return the scheme
+     * @return the scheme component of the server endpoint URL
      */
     String scheme();
 
     /**
      *
-     * @return the host
+     * @return the host component of the server endpoint URL
      */
     String host();
 
     /**
      *
-     * @return the port
+     * @return the port number of the server endpoint URL
      */
     int port();
 
     /**
      *
-     * @return the path
+     * @return the path component of the server endpoint URL
      */
     String path();
 
     /**
-     *
-     * @return the query string
+     * @return the query string of the server endpoint URL
      */
     String query();
 
+    /**
+     *
+     * @return the local IP address and port for this connection, or {@code null} if not available
+     */
+    String localAddress();
+
+    /**
+     * @return the remote IP address and port for this connection, or {@code null} if not available
+     */
+    String remoteAddress();
+
     /**
      * See <a href="https://datatracker.ietf.org/doc/html/rfc6455#section-11.3.1">Sec-WebSocket-Key</a>.
      */
@@ -96,4 +106,4 @@ public interface HandshakeRequest {
      */
     String SEC_WEBSOCKET_VERSION = "Sec-WebSocket-Version";
 
-}
+}

extensions/websockets-next/runtime/src/main/java/io/quarkus/websockets/next/runtime/WebSocketClientConnectionImpl.java

@@ -26,10 +26,11 @@ class WebSocketClientConnectionImpl extends WebSocketConnectionBase implements W
             Map<String, String> pathParams, URI serverEndpointUri, Map<String, List<String>> headers,
             TrafficLogger trafficLogger, Map<String, Object> userData, SendingInterceptor sendingInterceptor,
             Consumer<WebSocketClientConnection> cleanup) {
-        super(Map.copyOf(pathParams), codecs, new ClientHandshakeRequestImpl(serverEndpointUri, headers), trafficLogger,
+        super(Map.copyOf(pathParams), codecs,
+                new ClientHandshakeRequestImpl(serverEndpointUri, Objects.requireNonNull(webSocket), headers), trafficLogger,
                 new UserDataImpl(userData), sendingInterceptor);
         this.clientId = clientId;
-        this.webSocket = Objects.requireNonNull(webSocket);
+        this.webSocket = webSocket;
         this.cleanup = cleanup;
     }
 
@@ -71,13 +72,15 @@ public boolean equals(Object obj) {
         return Objects.equals(identifier, other.identifier);
     }
 
-    private static class ClientHandshakeRequestImpl implements HandshakeRequest {
+    private static class ClientHandshakeRequestImpl extends HandshakeRequestBase implements HandshakeRequest {
 
         private final URI serverEndpointUrl;
+        private final WebSocket webSocket;
         private final Map<String, List<String>> headers;
 
-        ClientHandshakeRequestImpl(URI serverEndpointUrl, Map<String, List<String>> headers) {
+        ClientHandshakeRequestImpl(URI serverEndpointUrl, WebSocket webSocket, Map<String, List<String>> headers) {
             this.serverEndpointUrl = serverEndpointUrl;
+            this.webSocket = webSocket;
             Map<String, List<String>> copy = new HashMap<>();
             for (Entry<String, List<String>> e : headers.entrySet()) {
                 copy.put(e.getKey().toLowerCase(), List.copyOf(e.getValue()));
@@ -126,6 +129,16 @@ public String query() {
             return serverEndpointUrl.getQuery();
         }
 
+        @Override
+        public String localAddress() {
+            return formatSocketAddress(webSocket.localAddress());
+        }
+
+        @Override
+        public String remoteAddress() {
+            return formatSocketAddress(webSocket.remoteAddress());
+        }
+
     }
 
 }

extensions/websockets-next/runtime/src/main/java/io/quarkus/websockets/next/runtime/WebSocketConnectionBase.java

@@ -22,6 +22,7 @@
 import io.vertx.core.http.WebSocketBase;
 import io.vertx.core.json.JsonArray;
 import io.vertx.core.json.JsonObject;
+import io.vertx.core.net.SocketAddress;
 
 public abstract class WebSocketConnectionBase implements Connection {
 
@@ -192,4 +193,23 @@ public UserData userData() {
         return userData;
     }
 
+    protected static class HandshakeRequestBase {
+
+        protected String formatSocketAddress(SocketAddress socketAddress) {
+            if (socketAddress == null) {
+                return null;
+            }
+            if (socketAddress.isInetSocket() && socketAddress.hostAddress() != null) {
+                return socketAddress.hostAddress() + ":" + socketAddress.port();
+            }
+            if (socketAddress.isInetSocket() && socketAddress.hostName() != null) {
+                return socketAddress.hostName() + ":" + socketAddress.port();
+            }
+            if (socketAddress.isDomainSocket()) {
+                return socketAddress.path();
+            }
+            return null;
+        }
+    }
+
 }

extensions/websockets-next/runtime/src/main/java/io/quarkus/websockets/next/runtime/WebSocketConnectionImpl.java

@@ -97,7 +97,7 @@ public boolean equals(Object obj) {
         return Objects.equals(identifier, other.identifier);
     }
 
-    private static class HandshakeRequestImpl implements HandshakeRequest {
+    private static class HandshakeRequestImpl extends HandshakeRequestBase implements HandshakeRequest {
 
         private final ServerWebSocket webSocket;
 
@@ -149,6 +149,16 @@ public String query() {
             return webSocket.query();
         }
 
+        @Override
+        public String localAddress() {
+            return formatSocketAddress(webSocket.localAddress());
+        }
+
+        @Override
+        public String remoteAddress() {
+            return formatSocketAddress(webSocket.remoteAddress());
+        }
+
         static Map<String, List<String>> initHeaders(RoutingContext ctx) {
             Map<String, List<String>> headers = new HashMap<>();
             for (Entry<String, String> e : ctx.request().headers()) {