feat: add wasm support

Author: asciimoth

.golangci.yml

@@ -95,4 +95,6 @@ linters:
     - contextcheck
     - tparallel
     - dupword
-
+  exclusions:
+    paths:
+      - webdemo

client_config.go

@@ -472,67 +472,6 @@ func (c *Client) GetHandshakeTimeout() time.Duration {
 
 // GetWsDialer builds the WebSocket dialer options for SOCKS over WS.
 //
-// GetWsDialer creates coder/websocket.DialOptions configured from WebSocketConfig,
-// GetDialer, and GetTLSConfig. Returns nil if WebSocketURL is empty.
-//
-// # Configuration
-//
-// The dialer is configured with:
-//   - HTTPClient: Uses custom Dialer via Transport for TCP connections
-//   - Subprotocols: From WebSocketConfig
-//   - CompressionMode: From WebSocketConfig.EnableCompression
-//   - HTTPHeader: From WebSocketConfig.RequestHeader
-//
-// # Returns
-//
-// *websocket.DialOptions for WebSocket connections, or nil if WebSocketURL is empty.
-//
-// # See Also
-//
-//   - WebSocketConfig: WebSocket configuration options
-//   - github.com/coder/websocket: Underlying WebSocket library
-func (c *Client) GetWsDialer() *websocket.DialOptions {
-	if c.WebSocketURL == "" {
-		return nil
-	}
-
-	httpClient := &http.Client{
-		Jar: c.WebSocketConfig.jar(),
-	}
-	tlsConfig := c.GetTLSConfig()
-
-	if tlsConfig != nil || c.Dialer != nil {
-		transport := &http.Transport{}
-		if c.Dialer != nil {
-			transport.DialContext = c.Dialer
-		}
-		if tlsConfig != nil {
-			transport.TLSClientConfig = tlsConfig
-		}
-		httpClient.Transport = transport
-	}
-
-	// Configure compression
-	compressionMode := websocket.CompressionDisabled
-	var httpHeader http.Header
-	var subprotocols []string
-
-	if c.WebSocketConfig != nil {
-		if c.WebSocketConfig.enableCompression() {
-			compressionMode = websocket.CompressionContextTakeover
-		}
-		httpHeader = c.WebSocketConfig.RequestHeader
-		subprotocols = c.WebSocketConfig.subprotocols()
-	}
-
-	return &websocket.DialOptions{
-		HTTPClient:      httpClient,
-		HTTPHeader:      httpHeader,
-		Subprotocols:    subprotocols,
-		CompressionMode: compressionMode,
-	}
-}
-
 // connectWebSocket establishes a WebSocket connection to the proxy.
 //
 // connectWebSocket dials the WebSocket URL and wraps the connection

client_config_js.go

@@ -0,0 +1,41 @@
+//go:build js
+
+package socksgo
+
+import (
+	"github.com/coder/websocket"
+)
+
+// GetWsDialer creates coder/websocket.DialOptions configured from WebSocketConfig,
+// GetDialer, and GetTLSConfig. Returns nil if WebSocketURL is empty.
+//
+// # Configuration
+//
+// The dialer is configured with:
+//   - Subprotocols: From WebSocketConfig
+//
+// Note: HTTPClient, HTTPHeader, and CompressionMode are not supported in WASM builds
+// due to browser WebSocket API limitations.
+//
+// # Returns
+//
+// *websocket.DialOptions for WebSocket connections, or nil if WebSocketURL is empty.
+//
+// # See Also
+//
+//   - WebSocketConfig: WebSocket configuration options
+//   - github.com/coder/websocket: Underlying WebSocket library
+func (c *Client) GetWsDialer() *websocket.DialOptions {
+	if c.WebSocketURL == "" {
+		return nil
+	}
+
+	var subprotocols []string
+	if c.WebSocketConfig != nil {
+		subprotocols = c.WebSocketConfig.subprotocols()
+	}
+
+	return &websocket.DialOptions{
+		Subprotocols: subprotocols,
+	}
+}

client_config_notjs.go

@@ -0,0 +1,70 @@
+//go:build !js
+
+package socksgo
+
+import (
+	"net/http"
+
+	"github.com/coder/websocket"
+)
+
+// GetWsDialer creates coder/websocket.DialOptions configured from WebSocketConfig,
+// GetDialer, and GetTLSConfig. Returns nil if WebSocketURL is empty.
+//
+// # Configuration
+//
+// The dialer is configured with:
+//   - HTTPClient: Uses custom Dialer via Transport for TCP connections
+//   - Subprotocols: From WebSocketConfig
+//   - CompressionMode: From WebSocketConfig.EnableCompression
+//   - HTTPHeader: From WebSocketConfig.RequestHeader
+//
+// # Returns
+//
+// *websocket.DialOptions for WebSocket connections, or nil if WebSocketURL is empty.
+//
+// # See Also
+//
+//   - WebSocketConfig: WebSocket configuration options
+//   - github.com/coder/websocket: Underlying WebSocket library
+func (c *Client) GetWsDialer() *websocket.DialOptions {
+	if c.WebSocketURL == "" {
+		return nil
+	}
+
+	httpClient := &http.Client{
+		Jar: c.WebSocketConfig.jar(),
+	}
+	tlsConfig := c.GetTLSConfig()
+
+	if tlsConfig != nil || c.Dialer != nil {
+		transport := &http.Transport{}
+		if c.Dialer != nil {
+			transport.DialContext = c.Dialer
+		}
+		if tlsConfig != nil {
+			transport.TLSClientConfig = tlsConfig
+		}
+		httpClient.Transport = transport
+	}
+
+	// Configure compression
+	compressionMode := websocket.CompressionDisabled
+	var httpHeader http.Header
+	var subprotocols []string
+
+	if c.WebSocketConfig != nil {
+		if c.WebSocketConfig.enableCompression() {
+			compressionMode = websocket.CompressionContextTakeover
+		}
+		httpHeader = c.WebSocketConfig.RequestHeader
+		subprotocols = c.WebSocketConfig.subprotocols()
+	}
+
+	return &websocket.DialOptions{
+		HTTPClient:      httpClient,
+		HTTPHeader:      httpHeader,
+		Subprotocols:    subprotocols,
+		CompressionMode: compressionMode,
+	}
+}

flake.nix

@@ -62,6 +62,10 @@
           gopls
           pkgsite
 
+          #nodejs # for wasm builds testing
+          python3 # for local dev http server
+          just
+
           gost
           curl
           tor

scripts/filter_coverage.sh

@@ -34,6 +34,7 @@ trap 'rm -f "$TEMP_FILE"' EXIT
 grep -v "client_testhooks.go" "$INPUT_FILE" | \
   grep -v "client5_testhooks.go" | \
   grep -v "_internal_test.go" | \
+  grep -v "webdemo/" | \
   grep -v "examples/" > "$TEMP_FILE"
 
 mv "$TEMP_FILE" "$OUTPUT_FILE"

webdemo/.gitignore

@@ -0,0 +1,14 @@
+# Build artifacts
+main.wasm
+wasm_exec.js
+
+# Editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS files
+.DS_Store
+Thumbs.db

webdemo/README.md

@@ -0,0 +1,75 @@
+# SOCKS WebSocket WASM Demo
+
+A WebAssembly demo that demonstrates using socksgo library to make HTTP requests through a SOCKS proxy over WebSocket connections.
+
+## Features
+
+- Runs entirely in browser using WebAssembly
+- Connects to SOCKS proxy servers over WebSocket (socks5+ws:// or socks5+wss://)
+- Makes HTTP requests through the proxy
+- Uses [coder/websocket](https://github.com/coder/websocket) library for WebSocket support
+
+## Prerequisites
+
+1. Go 1.25.5 or later
+2. [gost](https://github.com/ginuerzh/gost) proxy tool (for SOCKS-over-WebSocket server)
+3. Python 3 (for HTTP server)
+4. [Just](https://just.systems) (optional, for build automation)
+
+## Quick Start
+
+### With Just (Recommended)
+
+```bash
+# Terminal 1: Start gost SOCKS-over-WebSocket server
+just start-proxy
+
+# Terminal 2: Build and serve the demo
+just serve
+
+# Open your browser to
+# http://localhost:8000
+```
+
+### Without Just (Manual)
+
+```bash
+# Terminal 1: Start gost SOCKS-over-WebSocket server
+gost -L socks5+ws://localhost:1080
+
+# Terminal 2: Build WASM module
+GOOS=js GOARCH=wasm go build -o main.wasm main.go
+cp "$(go env GOROOT)/lib/wasm/wasm_exec.js" .
+
+# Terminal 2 (continued): Start HTTP server
+python3 -m http.server 8000
+
+# Open your browser to
+# http://localhost:8000
+```
+
+## Browser Compatibility
+
+This demo requires a browser that supports:
+- WebAssembly (all modern browsers)
+- WebSocket API (all modern browsers)
+- ES6+ JavaScript (all modern browsers)
+
+## How It Works
+
+1. **WASM Module**: The `main.go` file compiles to WebAssembly and contains:
+   - socksgo client configured for WebSocket transport
+   - HTTP client that routes requests through the SOCKS proxy
+   - JavaScript bridge functions for DOM interaction
+
+2. **WebSocket Connection**: The client connects to the gost SOCKS5-over-WebSocket server
+
+3. **HTTP Request**: HTTP requests are made through the SOCKS connection, appearing to originate from the gost server
+
+## References
+
+- [socksgo Documentation](../README.md)
+- [coder/websocket](https://github.com/coder/websocket)
+- [gost Proxy Tool](https://github.com/go-gost/gost)
+- [Go WebAssembly](https://go.dev/wiki/WebAssembly)
+- [SOCKS Protocol](https://en.wikipedia.org/wiki/SOCKS)