| General Rule Actions |
| Name |
Value |
Description |
bindHost |
Host |
Specifies the binding host name or address for all sockets |
bindTcpPortRange |
Port Range |
Specifies a binding port range for all TCP sockets (can be specified multiple times with each rule action specifying another port range) |
bindUdpPortRange |
Port Range |
Specifies a binding port range for all UDP sockets (can be specified multiple times with each rule action specifying another port ranges) |
clientSocketSetting |
Socket Setting |
Specifies a socket setting for the client socket (can be specified multiple times with each rule action specifying another socket setting) |
externalFacingBindHost |
Host |
Specifies the binding host name or address for all external-facing sockets |
externalFacingBindTcpPortRange |
Port Range |
Specifies a binding port range for all external-facing TCP sockets (can be specified multiple times with each rule action specifying another port range) |
externalFacingBindUdpPortRange |
Port Range |
Specifies a binding port range for all external-facing UDP sockets (can be specified multiple times with each rule action specifying another port range) |
externalFacingSocketSetting |
Socket Setting |
Specifies a socket setting for all external-facing sockets (can be specified multiple times with each rule action specifying another socket setting) |
firewallAction |
Firewall Action |
Specifies the firewall action to take |
firewallActionAllowLimit |
Non-negative Integer |
Specifies the limit on the number of simultaneous instances of the rule's firewall action ALLOW |
firewallActionAllowLimitReachedLogAction |
Log Action |
Specifies the logging action to take if the limit on the number of simultaneous instances of the rule's firewall action ALLOW has been reached |
firewallActionLogAction |
Log Action |
Specifies the logging action to take if the firewall action is applied |
internalFacingBindHost |
Host |
Specifies the binding host name or address for all internal-facing sockets |
internalFacingBindUdpPortRange |
Port Range |
Specifies a binding port range for all internal-facing UDP sockets (can be specified multiple times with each rule action specifying another port range) |
internalFacingSocketSetting |
Socket Setting |
Specifies a socket setting for all internal-facing sockets (can be specified multiple times with each rule action specifying another socket setting) |
routeSelectionLogAction |
Log Action |
Specifies the logging action to take if a route ID is selected |
routeSelectionStrategy |
Selection Strategy |
Specifies the selection strategy for the next route ID |
selectableRouteId |
java.lang.String |
Specifies the ID for a selectable route (can be specified multiple times with each rule action specifying another ID for a selectable route) |
socketSetting |
Socket Setting |
Specifies a socket setting for all sockets (can be specified multiple times with each rule action specifying another socket setting) |
| SOCKS5 Rule Actions |
| Name |
Value |
Description |
socks5.onBindRequest.inboundSocketSetting |
Socket Setting |
Specifies a socket setting for the inbound socket (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onBindRequest.listenBindHost |
Host |
Specifies the binding host name or address for the listen socket if the provided host address is all zeros |
socks5.onBindRequest.listenBindPortRange |
Port Range |
Specifies a binding port range for the listen socket if the provided port is zero (can be specified multiple times with each rule action specifying another port range) |
socks5.onBindRequest.listenSocketSetting |
Socket Setting |
Specifies a socket setting for the listen socket (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onBindRequest.relayBufferSize |
Positive Integer |
Specifies the buffer size in bytes for relaying the data |
socks5.onBindRequest.relayIdleTimeout |
Positive Integer |
Specifies the timeout in milliseconds on relaying no data |
socks5.onBindRequest.relayInboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onBindRequest.relayOutboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.onConnectRequest.prepareTargetFacingSocket |
java.lang.Boolean.toString() |
Specifies the boolean value to indicate if the target-facing socket is to be prepared before connecting (involves applying the specified socket settings, resolving the target host name, and setting the specified timeout on waiting to connect) |
socks5.onConnectRequest.relayBufferSize |
Positive Integer |
Specifies the buffer size in bytes for relaying the data |
socks5.onConnectRequest.relayIdleTimeout |
Positive Integer |
Specifies the timeout in milliseconds on relaying no data |
socks5.onConnectRequest.relayInboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onConnectRequest.relayOutboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.onConnectRequest.targetFacingBindHost |
Host |
Specifies the binding host name or address for the target-facing socket |
socks5.onConnectRequest.targetFacingBindPortRange |
Port Range |
Specifies a binding port range for the target-facing socket (can be specified multiple times with each rule action specifying another port range) |
socks5.onConnectRequest.targetFacingConnectTimeout |
Positive Integer |
Specifies the timeout in milliseconds on waiting for the target-facing socket to connect |
socks5.onConnectRequest.targetFacingSocketSetting |
Socket Setting |
Specifies a socket setting for the target-facing socket (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onRequest.bindHost |
Host |
Specifies the binding host name or address for all sockets |
socks5.onRequest.bindTcpPortRange |
Port Range |
Specifies a binding port range for all TCP sockets (can be specified multiple times with each rule action specifying another port range) |
socks5.onRequest.bindUdpPortRange |
Port Range |
Specifies a binding port range for all UDP sockets (can be specified multiple times with each rule action specifying another port range) |
socks5.onRequest.externalFacingBindHost |
Host |
Specifies the binding host name or address for all external-facing sockets |
socks5.onRequest.externalFacingBindTcpPortRange |
Port Range |
Specifies a binding port range for all external-facing TCP sockets (can be specified multiple times with each rule action specifying another port range) |
socks5.onRequest.externalFacingBindUdpPortRange |
Port Range |
Specifies a binding port range for all external-facing UDP sockets (can be specified multiple times with each rule action specifying another port range) |
socks5.onRequest.externalFacingSocketSetting |
Socket Setting |
Specifies a socket setting for all external-facing sockets (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onRequest.internalFacingBindHost |
Host |
Specifies the binding host name or address for all internal-facing sockets |
socks5.onRequest.internalFacingBindUdpPortRange |
Port Range |
Specifies a binding port range for all internal-facing UDP sockets (can be specified multiple times with each rule action specifying another port range) |
socks5.onRequest.internalFacingSocketSetting |
Socket Setting |
Specifies a socket setting for all internal-facing sockets (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onRequest.relayBufferSize |
Positive Integer |
Specifies the buffer size in bytes for relaying the data |
socks5.onRequest.relayIdleTimeout |
Positive Integer |
Specifies the timeout in milliseconds on relaying no data |
socks5.onRequest.relayInboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onRequest.relayOutboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.onRequest.socketSetting |
Socket Setting |
Specifies a socket setting for all sockets (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onUdpAssociateRequest.clientFacingBindHost |
Host |
Specifies the binding host name or address for the client-facing UDP socket |
socks5.onUdpAssociateRequest.clientFacingBindPortRange |
Port Range |
Specifies a binding port range for the client-facing UDP socket (can be specified multiple times with each rule action specifying another port range) |
socks5.onUdpAssociateRequest.clientFacingSocketSetting |
Socket Setting |
Specifies a socket setting for the client-facing UDP socket (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onUdpAssociateRequest.peerFacingBindHost |
Host |
Specifies the binding host name or address for the peer-facing UDP socket |
socks5.onUdpAssociateRequest.peerFacingBindPortRange |
Port Range |
Specifies a binding port range for the peer-facing UDP socket (can be specified multiple times with each rule action specifying another port range) |
socks5.onUdpAssociateRequest.peerFacingSocketSetting |
Socket Setting |
Specifies a socket setting for the peer-facing UDP socket (can be specified multiple times with each rule action specifying another socket setting) |
socks5.onUdpAssociateRequest.relayBufferSize |
Positive Integer |
Specifies the buffer size in bytes for relaying the data |
socks5.onUdpAssociateRequest.relayIdleTimeout |
Positive Integer |
Specifies the timeout in milliseconds on relaying no data |
socks5.onUdpAssociateRequest.relayInboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onUdpAssociateRequest.relayOutboundBandwidthLimit |
Positive Integer |
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.request.desiredDestinationAddressRedirect |
SOCKS5 Address |
Specifies the desired destination address redirect for the request |
socks5.request.desiredDestinationPortRedirect |
Port |
Specifies the desired destination port redirect for the request |
socks5.request.desiredDestinationRedirectLogAction |
Log Action |
Specifies the logging action to take if the desired destination of the request is redirected |
