SOAX relay for remote measurement

transport/socks5/packet_listener.go

@@ -155,7 +155,7 @@ func (c *Client) ListenPacket(ctx context.Context) (net.PacketConn, error) {
 	// https://datatracker.ietf.org/doc/html/rfc1928#section-6
 	// Whoile binding address to specific client address has its advantages, it also creates some
 	// challenges such as NAT traveral if client is behind NAT.
-	sc, bindAddr, err := c.connectAndRequest(ctx, CmdUDPAssociate, "0.0.0.0:0")
+	sc, bindAddr, err := c.ConnectAndRequest(ctx, CmdUDPAssociate, "0.0.0.0:0")
 	if err != nil {
 		return nil, err
 	}

transport/socks5/stream_dialer.go

@@ -209,7 +209,7 @@ func (c *Client) request(conn io.ReadWriter, cmd byte, dstAddr string) (*address
 }
 
 // connectAndRequest manages the connection lifecycle and delegates the SOCKS5 communication to the request function.
-func (c *Client) connectAndRequest(ctx context.Context, cmd byte, dstAddr string) (transport.StreamConn, *address, error) {
+func (c *Client) ConnectAndRequest(ctx context.Context, cmd byte, dstAddr string) (transport.StreamConn, *address, error) {
 	proxyConn, err := c.se.ConnectStream(ctx)
 	if err != nil {
 		return nil, nil, fmt.Errorf("could not connect to SOCKS5 proxy: %w", err)
@@ -230,7 +230,7 @@ func (c *Client) connectAndRequest(ctx context.Context, cmd byte, dstAddr string
 // The returned [error] will be of type [ReplyCode] if the server sends a SOCKS error reply code, which
 // you can check against the error constants in this package using [errors.Is].
 func (c *Client) DialStream(ctx context.Context, dstAddr string) (transport.StreamConn, error) {
-	proxyConn, _, err := c.connectAndRequest(ctx, CmdConnect, dstAddr)
+	proxyConn, _, err := c.ConnectAndRequest(ctx, CmdConnect, dstAddr)
 	if err != nil {
 		return nil, err
 	}

x/examples/soax-relay/README.md

@@ -0,0 +1,89 @@
+# SOCKS5 Proxy Relay for SOAX
+
+This program creates a SOCKS5 proxy relay that allows users to share access to SOAX without sharing their own credentials. It's designed for connectivity testing purposes.
+
+## Design
+
+The proxy relay works as follows:
+
+1. It listens for incoming SOCKS5 connections on a specified local address and port.
+2. It authenticates incoming connections using a custom authentication mechanism.
+3. For authenticated connections, it relays requests to the SOAX proxy server.
+4. It supports both TCP and UDP traffic.
+
+## Usage
+
+### Configuration
+
+The program uses a YAML configuration file (`config.yaml`) for settings. Please refer to the example config file.
+
+### Authentication
+Users connect to the relay using the following format:
+
+<b>Username:</b> 
+
+username-country-{cc_code}-sessionid-{session_id}-sessionlength-{time_in_sec}
+
+where any part that goes after username-country-{cc_code} is optional. For more information on the format refer to [this document](https://helpcenter.soax.com/en/articles/6723733-sticky-sessions) on soax support page.
+
+<b>Password:</b> (as defined in the credentials section of the config file)
+
+<b>Example Username:</b>
+
+`outline-country-ru-sessionid-12-sessionlength-600` where `outline` is the username and parameters that goes after configured the soax proxy
+
+The relay will use the SOAX package ID and password to connect to the SOAX server, appending the country, sessionid, and sessionlength from the user's input.
+
+### Setup and Running
+
+Ensure you have Go installed on your system.
+
+Create a `config.yaml` file in the project directory with your SOAX credentials and desired settings.
+
+```bash
+go run github.com/Jigsaw-Code/outline-sdk/x/examples/soax-relay@latest
+```
+
+The relay will start and listen for incoming connections on the specified address and port.
+
+### SOAX Sticky Sessions
+
+This relay supports SOAX sticky sessions. Users can specify:
+
+1. country
+
+Two-letter country code (e.g., "us" for United States)
+
+2. sessionid
+
+A random string to maintain the same IP across requests
+
+3. sessionlength
+
+Duration of the session in seconds (10 to 3600)
+
+4. city
+
+City name. Example: new+york
+
+5. region
+
+Region name. Example: new+york
+
+6. isp
+
+ISP name. Please use this parameter together with the country information. 
+
+For more information on the format for values please check out [this document](https://helpcenter.soax.com/en/articles/6723733-sticky-sessions) on soax support page.
+
+The relay will forward these parameters to SOAX, allowing users to benefit from sticky sessions without direct access to SOAX credentials.
+
+### Security Considerations
+
+- This relay is intended for testing purposes only.
+- Ensure the relay is run in a secure environment, as it handles sensitive SOAX credentials.
+- Regularly update the credentials in the config file to maintain security.
+- SOCKS5 traffic is not encrypted.
+
+
+

x/examples/soax-relay/config.yaml

@@ -0,0 +1,11 @@
+server:
+  tcp_listen_address: 0.0.0.0:1080
+  udp_listen_address: 0.0.0.0:9000
+
+soax:
+  package_id: 123456
+  package_key: MySoaxPackageKey
+
+credentials:
+  user1: password1
+  user2: password2