socks server

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

socks_server:
  type: socks
  kind: server
  exit: tcp_client

Configuration (* required)

options

object

The socks server specific options.

options.authorization

object as map of named object properties

Guard-based authorization for SOCKS5 username/password authentication. Maps a guard name to its credential extraction pattern.

options:
  authorization:
    my_guard:
      credentials: "{username}/{password}"

authorization.credentials

string

Credential extraction pattern using SOCKS5 username and password fields.

routes

array

Conditional socks specific routes.

routes[].guarded

object as map of named array of string

List of roles required by each named guard to authorize this route.

routes[].when

array

List of conditions (any match) to match this route. Read more: When a route matches

when[].connect

string

Target address to connect to via the SOCKS5 proxy.

routes[].with

object

Route with override configuration.

routes[].exit

string

Next binding when following this route.

exit

string

Default exit binding when no conditional routes are viable.

exit: echo_server

telemetry

object

Defines the desired telemetry for the binding.

telemetry.metrics

array

Telemetry metrics to track

telemetry:
  metrics:
    - stream.*

telemetry.attributes

object as map of named string properties

Telemetry attributes to add to the binding metrics.

telemetry.attributes

object as map of named string properties

Telemetry attributes for this binding.