socks Binding

Defines a binding with SOCKS5 protocol support, with server, client, remote_server, or remote_client behavior.

The server and client kinds handle local SOCKS5 proxy connections. The remote_server and remote_client kinds enable remote port binding scenarios, allowing a client to request the SOCKS5 proxy server bind to a specific address and forward inbound connections back to the client.

server

Full config

The server kind socks binding decodes inbound SOCKS5 proxy connections, producing higher level application streams for each request.

socks_server:
  type: socks
  kind: server
  exit: tcp_client

client

Full config

The client kind socks binding encodes outbound application streams as SOCKS5 proxy connections to a remote server.

socks_client:
  type: socks
  kind: client
  options:
    address: proxy.example.com:1080
  exit: tcp_client

remote_server

Full config

The remote_server kind socks binding accepts inbound streams from a remote_client and forwards them to the appropriate exit based on the bound address.

socks_remote_server:
  type: socks
  kind: remote_server
  entry: socks_server
  routes:
    - exit: app_server
      when:
        - bind: 0.0.0.0:0

remote_client

Full config

The remote_client kind socks binding initiates a SOCKS5 remote bind request and forwards inbound streams from the proxy server to the appropriate exit.

socks_remote_client:
  type: socks
  kind: remote_client
  entry: socks_client
  routes:
    - when:
        - bind: 0.0.0.0:0