proxy_socks5

This escaper reaches the target through an upstream SOCKS5 proxy.

The following interfaces are supported:

• tcp connect

• udp relay

• udp connect

• http(s) forward

The following egress path selection value is supported:

• egress upstream

  If matched, the addr field overrides proxy_addr for this request.

  Added in version 1.13.0.

The following common keys are supported:

• shared_logger

• resolver, required only if proxy_addr is domain

• resolve_strategy

• tcp_sock_speed_limit

• udp_sock_speed_limit

• udp_socket_buffer

• bind_interface

• no_ipv4

• no_ipv6

• tcp_connect

• happy eyeballs

• tcp_misc_opts

• udp_misc_opts

• peer negotiation timeout

• extra_metrics_tags

proxy_addr

required, type: upstream str | seq

Set the target proxy address. The default port is 1080 and may be omitted.

If a seq is used, each element must be a weighted upstream addr.

If any configured proxy address uses a domain name, resolver becomes required.

proxy_addr_pick_policy

optional, type: selective pick policy

Set the policy used to select the next proxy address.

The key for ketama/rendezvous/jump hash is <client-ip>[-<username>]-<upstream-host>.

default: random

proxy_username

optional, type: username

Set the proxy username. The SOCKS5 username/password method is used by default.

alias: proxy_user

proxy_password

optional, type: password

Set the proxy password. Required if username is present.

alias: proxy_passwd

bind_ipv4

optional, type: ipv4 addr str

Set the bind IP address for IPv4 sockets.

default: not set

bind_ipv6

optional, type: ipv6 addr str

Set the bind IP address for IPv6 sockets.

default: not set

tcp_keepalive

optional, type: tcp keepalive

Configure TCP keepalive.

User-level TCP keepalive settings are not applied.

default: 60s

transmute_udp_peer_ip

optional, type: map | bool

Rewrite the UDP peer IP returned by the remote proxy when needed.

For a map value, each key is the returned IP and each value is the real IP to use. If the map is empty, the peer IP from the TCP connection is used.

For a boolean value, true behaves like an empty map and false disables this feature.

When the feature is disabled, an unspecified UDP peer IP returned by the proxy is still rewritten to the TCP peer IP.

default: false

Added in version 1.7.19.

Example:

- name: corp-socks
  type: proxy_socks5
  proxy_addr: socks.example.net:1080
  resolver: local-dns
  proxy_user: service-user
  proxy_passwd: secret
  transmute_udp_peer_ip: true

end_on_control_closed

optional, type: bool

End the UDP ASSOCIATE session whenever the peer closes the control TCP connection.

By default the session will be ended if:

• Any error occurs on the TCP control connection

• The TCP control connection closes cleanly after at least one UDP packet has been received

default: false

Added in version 1.9.9.