Rule Results
Page Contents
- General Rule Results
- bindHost
- bindTcpPortRange
- bindUdpPortRange
- clientSocketSetting
- externalFacingBindHost
- externalFacingBindTcpPortRange
- externalFacingBindUdpPortRange
- externalFacingSocketSetting
- firewallAction
- firewallActionAllowLimit
- firewallActionAllowLimitReachedLogAction
- firewallActionLogAction
- internalFacingBindHost
- internalFacingBindUdpPortRange
- internalFacingSocketSetting
- routeSelectionLogAction
- routeSelectionStrategy
- selectableRouteId
- socketSetting
- SOCKS5 Rule Results
- socks5.desiredDestinationAddressRedirect
- socks5.desiredDestinationPortRedirect
- socks5.desiredDestinationRedirectLogAction
- socks5.onBind.inboundSocketSetting
- socks5.onBind.listenBindHost
- socks5.onBind.listenBindPortRange
- socks5.onBind.listenSocketSetting
- socks5.onBind.relayBufferSize
- socks5.onBind.relayIdleTimeout
- socks5.onBind.relayInboundBandwidthLimit
- socks5.onBind.relayOutboundBandwidthLimit
- socks5.onCommand.bindHost
- socks5.onCommand.bindTcpPortRange
- socks5.onCommand.bindUdpPortRange
- socks5.onCommand.externalFacingBindHost
- socks5.onCommand.externalFacingBindTcpPortRange
- socks5.onCommand.externalFacingBindUdpPortRange
- socks5.onCommand.externalFacingSocketSetting
- socks5.onCommand.internalFacingBindHost
- socks5.onCommand.internalFacingBindUdpPortRange
- socks5.onCommand.internalFacingSocketSetting
- socks5.onCommand.relayBufferSize
- socks5.onCommand.relayIdleTimeout
- socks5.onCommand.relayInboundBandwidthLimit
- socks5.onCommand.relayOutboundBandwidthLimit
- socks5.onCommand.socketSetting
- socks5.onConnect.prepareServerFacingSocket
- socks5.onConnect.relayBufferSize
- socks5.onConnect.relayIdleTimeout
- socks5.onConnect.relayInboundBandwidthLimit
- socks5.onConnect.relayOutboundBandwidthLimit
- socks5.onConnect.serverFacingBindHost
- socks5.onConnect.serverFacingBindPortRange
- socks5.onConnect.serverFacingConnectTimeout
- socks5.onConnect.serverFacingSocketSetting
- socks5.onUdpAssociate.clientFacingBindHost
- socks5.onUdpAssociate.clientFacingBindPortRange
- socks5.onUdpAssociate.clientFacingSocketSetting
- socks5.onUdpAssociate.peerFacingBindHost
- socks5.onUdpAssociate.peerFacingBindPortRange
- socks5.onUdpAssociate.peerFacingSocketSetting
- socks5.onUdpAssociate.relayBufferSize
- socks5.onUdpAssociate.relayIdleTimeout
- socks5.onUdpAssociate.relayInboundBandwidthLimit
- socks5.onUdpAssociate.relayOutboundBandwidthLimit
General Rule Results
bindHost
Syntax:
bindHost=HOST
Description:
Specifies the binding host name or address for all sockets
Value: Host
bindTcpPortRange
Syntax:
bindTcpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all TCP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
bindUdpPortRange
Syntax:
bindUdpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all UDP sockets (can be specified multiple times with each rule result specifying another port ranges)
Value: Port Range
clientSocketSetting
Syntax:
clientSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for the client socket (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
externalFacingBindHost
Syntax:
externalFacingBindHost=HOST
Description:
Specifies the binding host name or address for all external-facing sockets
Value: Host
externalFacingBindTcpPortRange
Syntax:
externalFacingBindTcpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all external-facing TCP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
externalFacingBindUdpPortRange
Syntax:
externalFacingBindUdpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all external-facing UDP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
externalFacingSocketSetting
Syntax:
externalFacingSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for all external-facing sockets (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
firewallAction
Syntax:
firewallAction=FIREWALL_ACTION
Description:
Specifies the firewall action to take
Value: Firewall Action
firewallActionAllowLimit
Syntax:
firewallActionAllowLimit=NON_NEGATIVE_INTEGER
Description:
Specifies the limit on the number of simultaneous instances of the rule's firewall action ALLOW
Value: Non-negative Integer
firewallActionAllowLimitReachedLogAction
Syntax:
firewallActionAllowLimitReachedLogAction=LOG_ACTION
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: Log Action
firewallActionLogAction
Syntax:
firewallActionLogAction=LOG_ACTION
Description:
Specifies the logging action to take if the firewall action is applied
Value: Log Action
internalFacingBindHost
Syntax:
internalFacingBindHost=HOST
Description:
Specifies the binding host name or address for all internal-facing sockets
Value: Host
internalFacingBindUdpPortRange
Syntax:
internalFacingBindUdpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all internal-facing UDP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
internalFacingSocketSetting
Syntax:
internalFacingSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for all internal-facing sockets (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
routeSelectionLogAction
Syntax:
routeSelectionLogAction=LOG_ACTION
Description:
Specifies the logging action to take if a route ID is selected
Value: Log Action
routeSelectionStrategy
Syntax:
routeSelectionStrategy=SELECTION_STRATEGY
Description:
Specifies the selection strategy for the next route ID
Value: Selection Strategy
selectableRouteId
Syntax:
selectableRouteId=ROUTE_ID
Description:
Specifies the ID for a selectable route (can be specified multiple times with each rule result specifying another ID for a selectable route)
Value: java.lang.String
socketSetting
Syntax:
socketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for all sockets (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
SOCKS5 Rule Results
socks5.desiredDestinationAddressRedirect
Syntax:
socks5.desiredDestinationAddressRedirect=SOCKS5_ADDRESS
Description:
Specifies the desired destination address redirect
Value: SOCKS5 Address
socks5.desiredDestinationPortRedirect
Syntax:
socks5.desiredDestinationPortRedirect=PORT
Description:
Specifies the desired destination port redirect
Value: Port
socks5.desiredDestinationRedirectLogAction
Syntax:
socks5.desiredDestinationRedirectLogAction=LOG_ACTION
Description:
Specifies the logging action to take if the desired destination is redirected
Value: Log Action
socks5.onBind.inboundSocketSetting
Syntax:
socks5.onBind.inboundSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for the inbound socket (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onBind.listenBindHost
Syntax:
socks5.onBind.listenBindHost=HOST
Description:
Specifies the binding host name or address for the listen socket if the provided host address is all zeros
Value: Host
socks5.onBind.listenBindPortRange
Syntax:
socks5.onBind.listenBindPortRange=PORT_RANGE
Description:
Specifies a binding port range for the listen socket if the provided port is zero (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onBind.listenSocketSetting
Syntax:
socks5.onBind.listenSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for the listen socket (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onBind.relayBufferSize
Syntax:
socks5.onBind.relayBufferSize=POSITIVE_INTEGER
Description:
Specifies the buffer size in bytes for relaying the data
Value: Positive Integer
socks5.onBind.relayIdleTimeout
Syntax:
socks5.onBind.relayIdleTimeout=POSITIVE_INTEGER
Description:
Specifies the timeout in milliseconds on relaying no data
Value: Positive Integer
socks5.onBind.relayInboundBandwidthLimit
Syntax:
socks5.onBind.relayInboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value: Positive Integer
socks5.onBind.relayOutboundBandwidthLimit
Syntax:
socks5.onBind.relayOutboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value: Positive Integer
socks5.onCommand.bindHost
Syntax:
socks5.onCommand.bindHost=HOST
Description:
Specifies the binding host name or address for all sockets
Value: Host
socks5.onCommand.bindTcpPortRange
Syntax:
socks5.onCommand.bindTcpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all TCP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onCommand.bindUdpPortRange
Syntax:
socks5.onCommand.bindUdpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all UDP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onCommand.externalFacingBindHost
Syntax:
socks5.onCommand.externalFacingBindHost=HOST
Description:
Specifies the binding host name or address for all external-facing sockets
Value: Host
socks5.onCommand.externalFacingBindTcpPortRange
Syntax:
socks5.onCommand.externalFacingBindTcpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all external-facing TCP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onCommand.externalFacingBindUdpPortRange
Syntax:
socks5.onCommand.externalFacingBindUdpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all external-facing UDP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onCommand.externalFacingSocketSetting
Syntax:
socks5.onCommand.externalFacingSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for all external-facing sockets (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onCommand.internalFacingBindHost
Syntax:
socks5.onCommand.internalFacingBindHost=HOST
Description:
Specifies the binding host name or address for all internal-facing sockets
Value: Host
socks5.onCommand.internalFacingBindUdpPortRange
Syntax:
socks5.onCommand.internalFacingBindUdpPortRange=PORT_RANGE
Description:
Specifies a binding port range for all internal-facing UDP sockets (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onCommand.internalFacingSocketSetting
Syntax:
socks5.onCommand.internalFacingSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for all internal-facing sockets (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onCommand.relayBufferSize
Syntax:
socks5.onCommand.relayBufferSize=POSITIVE_INTEGER
Description:
Specifies the buffer size in bytes for relaying the data
Value: Positive Integer
socks5.onCommand.relayIdleTimeout
Syntax:
socks5.onCommand.relayIdleTimeout=POSITIVE_INTEGER
Description:
Specifies the timeout in milliseconds on relaying no data
Value: Positive Integer
socks5.onCommand.relayInboundBandwidthLimit
Syntax:
socks5.onCommand.relayInboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value: Positive Integer
socks5.onCommand.relayOutboundBandwidthLimit
Syntax:
socks5.onCommand.relayOutboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value: Positive Integer
socks5.onCommand.socketSetting
Syntax:
socks5.onCommand.socketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for all sockets (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onConnect.prepareServerFacingSocket
Syntax:
socks5.onConnect.prepareServerFacingSocket=true|false
Description:
Specifies the boolean value to indicate if the server-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: java.lang.Boolean
socks5.onConnect.relayBufferSize
Syntax:
socks5.onConnect.relayBufferSize=POSITIVE_INTEGER
Description:
Specifies the buffer size in bytes for relaying the data
Value: Positive Integer
socks5.onConnect.relayIdleTimeout
Syntax:
socks5.onConnect.relayIdleTimeout=POSITIVE_INTEGER
Description:
Specifies the timeout in milliseconds on relaying no data
Value: Positive Integer
socks5.onConnect.relayInboundBandwidthLimit
Syntax:
socks5.onConnect.relayInboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value: Positive Integer
socks5.onConnect.relayOutboundBandwidthLimit
Syntax:
socks5.onConnect.relayOutboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value: Positive Integer
socks5.onConnect.serverFacingBindHost
Syntax:
socks5.onConnect.serverFacingBindHost=HOST
Description:
Specifies the binding host name or address for the server-facing socket
Value: Host
socks5.onConnect.serverFacingBindPortRange
Syntax:
socks5.onConnect.serverFacingBindPortRange=PORT_RANGE
Description:
Specifies a binding port range for the server-facing socket (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onConnect.serverFacingConnectTimeout
Syntax:
socks5.onConnect.serverFacingConnectTimeout=POSITIVE_INTEGER
Description:
Specifies the timeout in milliseconds on waiting for the server-facing socket to connect
Value: Positive Integer
socks5.onConnect.serverFacingSocketSetting
Syntax:
socks5.onConnect.serverFacingSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for the server-facing socket (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onUdpAssociate.clientFacingBindHost
Syntax:
socks5.onUdpAssociate.clientFacingBindHost=HOST
Description:
Specifies the binding host name or address for the client-facing UDP socket
Value: Host
socks5.onUdpAssociate.clientFacingBindPortRange
Syntax:
socks5.onUdpAssociate.clientFacingBindPortRange=PORT_RANGE
Description:
Specifies a binding port range for the client-facing UDP socket (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onUdpAssociate.clientFacingSocketSetting
Syntax:
socks5.onUdpAssociate.clientFacingSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for the client-facing UDP socket (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onUdpAssociate.peerFacingBindHost
Syntax:
socks5.onUdpAssociate.peerFacingBindHost=HOST
Description:
Specifies the binding host name or address for the peer-facing UDP socket
Value: Host
socks5.onUdpAssociate.peerFacingBindPortRange
Syntax:
socks5.onUdpAssociate.peerFacingBindPortRange=PORT_RANGE
Description:
Specifies a binding port range for the peer-facing UDP socket (can be specified multiple times with each rule result specifying another port range)
Value: Port Range
socks5.onUdpAssociate.peerFacingSocketSetting
Syntax:
socks5.onUdpAssociate.peerFacingSocketSetting=SOCKET_SETTING
Description:
Specifies a socket setting for the peer-facing UDP socket (can be specified multiple times with each rule result specifying another socket setting)
Value: Socket Setting
socks5.onUdpAssociate.relayBufferSize
Syntax:
socks5.onUdpAssociate.relayBufferSize=POSITIVE_INTEGER
Description:
Specifies the buffer size in bytes for relaying the data
Value: Positive Integer
socks5.onUdpAssociate.relayIdleTimeout
Syntax:
socks5.onUdpAssociate.relayIdleTimeout=POSITIVE_INTEGER
Description:
Specifies the timeout in milliseconds on relaying no data
Value: Positive Integer
socks5.onUdpAssociate.relayInboundBandwidthLimit
Syntax:
socks5.onUdpAssociate.relayInboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value: Positive Integer
socks5.onUdpAssociate.relayOutboundBandwidthLimit
Syntax:
socks5.onUdpAssociate.relayOutboundBandwidthLimit=POSITIVE_INTEGER
Description:
Specifies the upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value: Positive Integer