Rule Actions
General Rule Actions
| Name | Value Type | Description |
|---|---|---|
bindHost |
Host | Specifies the binding host name or address for all sockets |
bindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for all sockets (can be specified multiple times with each rule action specifying another host address type) |
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 |
externalFacingBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for all external-facing sockets (can be specified multiple times with each rule action specifying another host address type) |
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) |
externalFacingNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for all external-facing sockets |
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 |
internalFacingBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for all internal-facing sockets (can be specified multiple times with each rule action specifying another host address type) |
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) |
internalFacingNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for all internal-facing sockets |
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) |
netInterface |
Network Interface | Specifies the network interface that provides a binding host address for all sockets |
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 |
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 Type | 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.listenBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for the listen socket if the provided host address is all zeros (can be specified multiple times with each rule specifying another host address type) |
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.listenNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for the listen socket if the provided host address is all zeros |
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 |
Boolean | 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.targetFacingBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for the target-facing socket (can be specified multiple times with each rule action specifying another host address type) |
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.targetFacingNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for the target-facing socket |
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.externalFacingBindHost |
Host | Specifies the binding host name or address for all external-facing sockets |
socks5.onRequest.externalFacingBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for all external-facing sockets (can be specified multiple times with each rule action specifying another host address type) |
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.externalFacingNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for all external-facing sockets |
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.internalFacingBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for all internal-facing sockets (can be specified multiple times with each rule action specifying another host address type) |
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.internalFacingNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for all internal-facing sockets |
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.onUdpAssociateRequest.clientFacingBindHost |
Host | Specifies the binding host name or address for the client-facing UDP socket |
socks5.onUdpAssociateRequest.clientFacingBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for the client-facing UDP socket (can be specified multiple times with each rule action specifying another host address type) |
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.clientFacingNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for the client-facing UDP socket |
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.peerFacingBindHostAddressType |
Host Address Type | Specifies an acceptable binding host address type for the peer-facing UDP socket (can be specified multiple times with each rule action specifying another host address type) |
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.peerFacingNetInterface |
Network Interface | Specifies the network interface that provides a binding host address for the peer-facing UDP socket |
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 |
bindHost
Description: Specifies the binding host name or address for all sockets
Value Type: Host
bindHostAddressType
Description: Specifies an acceptable binding host address type for all sockets (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
bindTcpPortRange
Description: Specifies a binding port range for all TCP sockets (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
bindUdpPortRange
Description: Specifies a binding port range for all UDP sockets (can be specified multiple times with each rule action specifying another port ranges)
Value Type: Port Range
clientSocketSetting
Description: Specifies a socket setting for the client socket (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
externalFacingBindHost
Description: Specifies the binding host name or address for all external-facing sockets
Value Type: Host
externalFacingBindHostAddressType
Description: Specifies an acceptable binding host address type for all external-facing sockets (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
externalFacingBindTcpPortRange
Description: Specifies a binding port range for all external-facing TCP sockets (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
externalFacingBindUdpPortRange
Description: Specifies a binding port range for all external-facing UDP sockets (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
externalFacingNetInterface
Description: Specifies the network interface that provides a binding host address for all external-facing sockets
Value Type: Network Interface
externalFacingSocketSetting
Description: Specifies a socket setting for all external-facing sockets (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
firewallAction
Description: Specifies the firewall action to take
Value Type: Firewall Action
firewallActionAllowLimit
Description: Specifies the limit on the number of simultaneous instances of the rule's firewall action ALLOW
Value Type: Non-negative Integer
firewallActionAllowLimitReachedLogAction
Description: 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
Value Type: Log Action
firewallActionLogAction
Description: Specifies the logging action to take if the firewall action is applied
Value Type: Log Action
internalFacingBindHost
Description: Specifies the binding host name or address for all internal-facing sockets
Value Type: Host
internalFacingBindHostAddressType
Description: Specifies an acceptable binding host address type for all internal-facing sockets (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
internalFacingBindUdpPortRange
Description: Specifies a binding port range for all internal-facing UDP sockets (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
internalFacingNetInterface
Description: Specifies the network interface that provides a binding host address for all internal-facing sockets
Value Type: Network Interface
internalFacingSocketSetting
Description: Specifies a socket setting for all internal-facing sockets (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
netInterface
Description: Specifies the network interface that provides a binding host address for all sockets
Value Type: Network Interface
routeSelectionLogAction
Description: Specifies the logging action to take if a route ID is selected
Value Type: Log Action
routeSelectionStrategy
Description: Specifies the selection strategy for the next route ID
Value Type: Selection Strategy
selectableRouteId
Description: Specifies the ID for a selectable route (can be specified multiple times with each rule action specifying another ID for a selectable route)
Value Type: String
socketSetting
Description: Specifies a socket setting for all sockets (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onBindRequest.inboundSocketSetting
Description: Specifies a socket setting for the inbound socket (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onBindRequest.listenBindHost
Description: Specifies the binding host name or address for the listen socket if the provided host address is all zeros
Value Type: Host
socks5.onBindRequest.listenBindHostAddressType
Description: Specifies an acceptable binding host address type for the listen socket if the provided host address is all zeros (can be specified multiple times with each rule specifying another host address type)
Value Type: Host Address Type
socks5.onBindRequest.listenBindPortRange
Description: 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)
Value Type: Port Range
socks5.onBindRequest.listenNetInterface
Description: Specifies the network interface that provides a binding host address for the listen socket if the provided host address is all zeros
Value Type: Network Interface
socks5.onBindRequest.listenSocketSetting
Description: Specifies a socket setting for the listen socket (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onBindRequest.relayBufferSize
Description: Specifies the buffer size in bytes for relaying the data
Value Type: Positive Integer
socks5.onBindRequest.relayIdleTimeout
Description: Specifies the timeout in milliseconds on relaying no data
Value Type: Positive Integer
socks5.onBindRequest.relayInboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onBindRequest.relayOutboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.onConnectRequest.prepareTargetFacingSocket
Description: 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)
Value Type: Boolean
socks5.onConnectRequest.relayBufferSize
Description: Specifies the buffer size in bytes for relaying the data
Value Type: Positive Integer
socks5.onConnectRequest.relayIdleTimeout
Description: Specifies the timeout in milliseconds on relaying no data
Value Type: Positive Integer
socks5.onConnectRequest.relayInboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onConnectRequest.relayOutboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.onConnectRequest.targetFacingBindHost
Description: Specifies the binding host name or address for the target-facing socket
Value Type: Host
socks5.onConnectRequest.targetFacingBindHostAddressType
Description: Specifies an acceptable binding host address type for the target-facing socket (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
socks5.onConnectRequest.targetFacingBindPortRange
Description: Specifies a binding port range for the target-facing socket (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
socks5.onConnectRequest.targetFacingConnectTimeout
Description: Specifies the timeout in milliseconds on waiting for the target-facing socket to connect
Value Type: Positive Integer
socks5.onConnectRequest.targetFacingNetInterface
Description: Specifies the network interface that provides a binding host address for the target-facing socket
Value Type: Network Interface
socks5.onConnectRequest.targetFacingSocketSetting
Description: Specifies a socket setting for the target-facing socket (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onRequest.externalFacingBindHost
Description: Specifies the binding host name or address for all external-facing sockets
Value Type: Host
socks5.onRequest.externalFacingBindHostAddressType
Description: Specifies an acceptable binding host address type for all external-facing sockets (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
socks5.onRequest.externalFacingBindTcpPortRange
Description: Specifies a binding port range for all external-facing TCP sockets (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
socks5.onRequest.externalFacingBindUdpPortRange
Description: Specifies a binding port range for all external-facing UDP sockets (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
socks5.onRequest.externalFacingNetInterface
Description: Specifies the network interface that provides a binding host address for all external-facing sockets
Value Type: Network Interface
socks5.onRequest.externalFacingSocketSetting
Description: Specifies a socket setting for all external-facing sockets (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onRequest.internalFacingBindHost
Description: Specifies the binding host name or address for all internal-facing sockets
Value Type: Host
socks5.onRequest.internalFacingBindHostAddressType
Description: Specifies an acceptable binding host address type for all internal-facing sockets (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
socks5.onRequest.internalFacingBindUdpPortRange
Description: Specifies a binding port range for all internal-facing UDP sockets (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
socks5.onRequest.internalFacingNetInterface
Description: Specifies the network interface that provides a binding host address for all internal-facing sockets
Value Type: Network Interface
socks5.onRequest.internalFacingSocketSetting
Description: Specifies a socket setting for all internal-facing sockets (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onRequest.relayBufferSize
Description: Specifies the buffer size in bytes for relaying the data
Value Type: Positive Integer
socks5.onRequest.relayIdleTimeout
Description: Specifies the timeout in milliseconds on relaying no data
Value Type: Positive Integer
socks5.onRequest.relayInboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onRequest.relayOutboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.onUdpAssociateRequest.clientFacingBindHost
Description: Specifies the binding host name or address for the client-facing UDP socket
Value Type: Host
socks5.onUdpAssociateRequest.clientFacingBindHostAddressType
Description: Specifies an acceptable binding host address type for the client-facing UDP socket (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
socks5.onUdpAssociateRequest.clientFacingBindPortRange
Description: Specifies a binding port range for the client-facing UDP socket (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
socks5.onUdpAssociateRequest.clientFacingNetInterface
Description: Specifies the network interface that provides a binding host address for the client-facing UDP socket
Value Type: Network Interface
socks5.onUdpAssociateRequest.clientFacingSocketSetting
Description: Specifies a socket setting for the client-facing UDP socket (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onUdpAssociateRequest.peerFacingBindHost
Description: Specifies the binding host name or address for the peer-facing UDP socket
Value Type: Host
socks5.onUdpAssociateRequest.peerFacingBindHostAddressType
Description: Specifies an acceptable binding host address type for the peer-facing UDP socket (can be specified multiple times with each rule action specifying another host address type)
Value Type: Host Address Type
socks5.onUdpAssociateRequest.peerFacingBindPortRange
Description: Specifies a binding port range for the peer-facing UDP socket (can be specified multiple times with each rule action specifying another port range)
Value Type: Port Range
socks5.onUdpAssociateRequest.peerFacingNetInterface
Description: Specifies the network interface that provides a binding host address for the peer-facing UDP socket
Value Type: Network Interface
socks5.onUdpAssociateRequest.peerFacingSocketSetting
Description: Specifies a socket setting for the peer-facing UDP socket (can be specified multiple times with each rule action specifying another socket setting)
Value Type: Socket Setting
socks5.onUdpAssociateRequest.relayBufferSize
Description: Specifies the buffer size in bytes for relaying the data
Value Type: Positive Integer
socks5.onUdpAssociateRequest.relayIdleTimeout
Description: Specifies the timeout in milliseconds on relaying no data
Value Type: Positive Integer
socks5.onUdpAssociateRequest.relayInboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onUdpAssociateRequest.relayOutboundBandwidthLimit
Description: Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.request.desiredDestinationAddressRedirect
Description: Specifies the desired destination address redirect for the request
Value Type: SOCKS5 Address
socks5.request.desiredDestinationPortRedirect
Description: Specifies the desired destination port redirect for the request
Value Type: Port
socks5.request.desiredDestinationRedirectLogAction
Description: Specifies the logging action to take if the desired destination of the request is redirected
Value Type: Log Action