Merge pull request #20 from hummingbird-project/server-name

Add WebSocketClientConfiguration.sniHostname

Author: Joannis

Sources/WSClient/WebSocketClient.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Hummingbird server framework project
 //
-// Copyright (c) 2024 the Hummingbird authors
+// Copyright (c) 2024-2025 the Hummingbird authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -134,7 +134,7 @@ public struct WebSocketClient {
                     TLSClientChannel(
                         WebSocketClientChannel(handler: handler, url: url, configuration: self.configuration),
                         tlsConfiguration: tlsConfiguration,
-                        serverHostname: host
+                        serverHostname: self.configuration.sniHostname ?? host
                     ),
                     address: .hostname(host, port: port),
                     eventLoopGroup: self.eventLoopGroup,

Sources/WSClient/WebSocketClientConfiguration.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Hummingbird server framework project
 //
-// Copyright (c) 2023-2024 the Hummingbird authors
+// Copyright (c) 2023-2025 the Hummingbird authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -29,6 +29,8 @@ public struct WebSocketClientConfiguration: Sendable {
     public var autoPing: AutoPingSetup
     /// Should text be validated to be UTF8
     public var validateUTF8: Bool
+    /// Hostname used during TLS handshake
+    public var sniHostname: String?
 
     /// Initialize WebSocketClient configuration
     ///   - Paramters
@@ -37,19 +39,23 @@ public struct WebSocketClientConfiguration: Sendable {
     ///     - extensions: WebSocket extensions
     ///     - autoPing: Automatic Ping configuration
     ///     - validateUTF8: Should text be checked to see if it is valid UTF8
+    ///     - sniHostname: Hostname used during TLS handshake
+    @_disfavoredOverload
     public init(
         maxFrameSize: Int = (1 << 14),
         additionalHeaders: HTTPFields = .init(),
         extensions: [WebSocketExtensionFactory] = [],
         closeTimeout: Duration = .seconds(15),
         autoPing: AutoPingSetup = .disabled,
-        validateUTF8: Bool = false
+        validateUTF8: Bool = false,
+        sniHostname: String? = nil
     ) {
         self.maxFrameSize = maxFrameSize
         self.additionalHeaders = additionalHeaders
         self.extensions = extensions.map { $0.build() }
         self.closeTimeout = closeTimeout
         self.autoPing = autoPing
         self.validateUTF8 = validateUTF8
+        self.sniHostname = nil
     }
 }

Tests/WebSocketTests/ClientTests.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Hummingbird server framework project
 //
-// Copyright (c) 2024 the Hummingbird authors
+// Copyright (c) 2024-2025 the Hummingbird authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -39,4 +39,24 @@ final class WebSocketClientTests: XCTestCase {
             }
         }
     }
+
+    func testEchoServerWithSNIHostname() async throws {
+        let clientLogger = {
+            var logger = Logger(label: "client")
+            logger.logLevel = .trace
+            return logger
+        }()
+        try await WebSocketClient.connect(
+            url: "wss://echo.websocket.org/",
+            configuration: .init(sniHostname: "echo.websocket.org"),
+            tlsConfiguration: TLSConfiguration.makeClientConfiguration(),
+            logger: clientLogger
+        ) { inbound, outbound, _ in
+            var inboundIterator = inbound.messages(maxSize: .max).makeAsyncIterator()
+            try await outbound.write(.text("hello"))
+            if let msg = try await inboundIterator.next() {
+                print(msg)
+            }
+        }
+    }
 }