Server Configuration Settings
General Settings
| Name | Value Type | Description |
|---|---|---|
backlog |
Non-negative Integer | The maximum length of the queue of incoming client connections to the SOCKS server Default Value: 50 |
bindHost |
Host | The default binding host name or address for all sockets Default Value: 0.0.0.0 |
bindHostAddressTypes |
Host Address Types | The comma separated list of default acceptable binding host address types for all sockets Default Value: HOST_IPV4_ADDRESS,HOST_IPV6_ADDRESS |
bindTcpPortRanges |
Port Ranges | The comma separated list of default binding port ranges for all TCP sockets Default Value: 0 |
bindUdpPortRanges |
Port Ranges | The comma separated list of default binding port ranges for all UDP sockets Default Value: 0 |
clientSocketSettings |
Socket Settings | The comma separated list of socket settings for the client socket |
doc |
String | A documentation setting |
externalFacingBindHost |
Host | The default binding host name or address for all external-facing sockets |
externalFacingBindHostAddressTypes |
Host Address Types | The comma separated list of default acceptable binding host address types for all external-facing sockets |
externalFacingBindTcpPortRanges |
Port Ranges | The comma separated list of default binding port ranges for all external-facing TCP sockets |
externalFacingBindUdpPortRanges |
Port Ranges | The comma separated list of default binding port ranges for all external-facing UDP sockets |
externalFacingNetInterface |
Network Interface | The default network interface that provides a binding host address for all external-facing sockets |
externalFacingSocketSettings |
Socket Settings | The comma separated list of default socket settings for all external-facing sockets |
internalFacingBindHost |
Host | The default binding host name or address for all internal-facing sockets |
internalFacingBindHostAddressTypes |
Host Address Types | The comma separated list of default acceptable binding host address types for all internal-facing sockets |
internalFacingBindTcpPortRanges |
Port Ranges | The comma separated list of default binding port ranges for all internal-facing TCP sockets |
internalFacingBindUdpPortRanges |
Port Ranges | The comma separated list of default binding port ranges for all internal-facing UDP sockets |
internalFacingNetInterface |
Network Interface | The default network interface that provides a binding host address for all internal-facing sockets |
internalFacingSocketSettings |
Socket Settings | The comma separated list of default socket settings for all internal-facing sockets |
lastRouteId |
String | The ID for the last and unassigned route Default Value: lastRoute |
netInterface |
Network Interface | The default network interface that provides a binding host address for all sockets |
port |
Port | The port for the SOCKS server Default Value: 1080 |
routeSelectionLogAction |
Log Action | The logging action to take if a route is selected |
routeSelectionStrategy |
Selection Strategy | The selection strategy for the next route Default Value: CYCLICAL |
rule |
Rule | A rule for the SOCKS server Default Value: firewallAction=ALLOW |
socketSettings |
Socket Settings | The comma separated list of default socket settings for all sockets |
socksServerBindHost |
Host | The binding host name or address for the SOCKS server socket |
socksServerBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for the SOCKS server socket |
socksServerBindPortRanges |
Port Ranges | The comma separated list of binding port ranges for the SOCKS server socket |
socksServerNetInterface |
Network Interface | The network interface that provides a binding host address for the SOCKS server socket |
socksServerSocketSettings |
Socket Settings | The comma separated list of socket settings for the SOCKS server socket |
Chaining General Settings
| Name | Value Type | Description |
|---|---|---|
chaining.clientBindHost |
Host | The binding host name or address for the client socket that is used to connect to the other SOCKS server Default Value: 0.0.0.0 |
chaining.clientBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for the client socket that is used to connect to the other SOCKS server Default Value: HOST_IPV4_ADDRESS,HOST_IPV6_ADDRESS |
chaining.clientBindPortRanges |
Port Ranges | The comma separated list of binding port ranges for the client socket that is used to connect to the other SOCKS server Default Value: 0 |
chaining.clientConnectTimeout |
Non-negative Integer | The timeout in milliseconds on waiting for the client socket to connect to the other SOCKS server (a timeout of 0 is interpreted as an infinite timeout) Default Value: 60000 |
chaining.clientNetInterface |
Network Interface | The network interface that provides a binding host address for the client socket that is used to connect to the other SOCKS server |
chaining.clientSocketSettings |
Socket Settings | The comma separated list of socket settings for the client socket that is used to connect to the other SOCKS server |
chaining.routeId |
String | The ID for a route through a chain of other SOCKS servers. This setting also marks the current other SOCKS server as the last SOCKS server in the chain of other SOCKS servers |
chaining.socksServerUri |
SOCKS Server URI | The URI of the other SOCKS server |
Chaining DTLS Settings
| Name | Value Type | Description |
|---|---|---|
chaining.dtls.enabled |
Boolean | The boolean value to indicate if DTLS connections to the other SOCKS server are enabled Default Value: false |
chaining.dtls.enabledCipherSuites |
Comma Separated Values | The comma separated list of acceptable cipher suites enabled for DTLS connections to the other SOCKS server |
chaining.dtls.enabledProtocols |
Comma Separated Values | The comma separated list of acceptable protocol versions enabled for DTLS connections to the other SOCKS server |
chaining.dtls.protocol |
String | The protocol version for the DTLS connections to the other SOCKS server Default Value: DTLSv1.2 |
chaining.dtls.trustStoreFile |
File | The trust store file for the DTLS connections to the other SOCKS server |
chaining.dtls.trustStorePassword |
String | The password for the trust store for the DTLS connections to the other SOCKS server |
chaining.dtls.trustStoreType |
String | The type of trust store for the DTLS connections to the other SOCKS server Default Value: PKCS12 |
chaining.dtls.wrappedReceiveBufferSize |
Positive Integer | The buffer size for receiving DTLS wrapped datagrams for the DTLS connections to the other SOCKS server |
Chaining SOCKS5 Settings
| Name | Value Type | Description |
|---|---|---|
chaining.socks5.gssapimethod.mechanismOid |
Oid | The object ID for the GSS-API authentication mechanism to the other SOCKS5 server Default Value: 1.2.840.113554.1.2.2 |
chaining.socks5.gssapimethod.necReferenceImpl |
Boolean | The boolean value to indicate if the exchange of the GSS-API protection level negotiation must be unprotected should the other SOCKS5 server use the NEC reference implementation Default Value: false |
chaining.socks5.gssapimethod.protectionLevels |
SOCKS5 GSS-API Method Protection Levels | The comma separated list of acceptable protection levels after GSS-API authentication with the other SOCKS5 server (The first is preferred. The remaining are acceptable if the server does not accept the first.) Default Value: REQUIRED_INTEG_AND_CONF,REQUIRED_INTEG,NONE |
chaining.socks5.gssapimethod.serviceName |
String | The GSS-API service name for the other SOCKS5 server |
chaining.socks5.gssapimethod.suggestedConf |
Boolean | The suggested privacy (i.e. confidentiality) state for GSS-API messages sent after GSS-API authentication with the other SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF) Default Value: true |
chaining.socks5.gssapimethod.suggestedInteg |
Integer | The suggested quality-of-protection (i.e. integrity) value for GSS-API messages sent after GSS-API authentication with the other SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF) Default Value: 0 |
chaining.socks5.methods |
SOCKS5 Methods | The comma separated list of acceptable authentication methods to the other SOCKS5 server Default Value: NO_AUTHENTICATION_REQUIRED |
chaining.socks5.socks5DatagramSocket.clientInfoUnavailable |
Boolean | The boolean value to indicate if the client information expected to be used to send UDP datagrams (address and port) is unavailable to be sent to the other SOCKS5 server (an address and port of all zeros is sent instead) Default Value: false |
chaining.socks5.socks5HostResolver.resolveFromSocks5Server |
Boolean | The boolean value to indicate if host names are to be resolved from the other SOCKS5 server Default Value: false |
chaining.socks5.userpassmethod.password |
String | The password to be used to access the other SOCKS5 server |
chaining.socks5.userpassmethod.username |
String | The username to be used to access the other SOCKS5 server |
Chaining SSL/TLS Settings
| Name | Value Type | Description |
|---|---|---|
chaining.ssl.enabled |
Boolean | The boolean value to indicate if SSL/TLS connections to the other SOCKS server are enabled Default Value: false |
chaining.ssl.enabledCipherSuites |
Comma Separated Values | The comma separated list of acceptable cipher suites enabled for SSL/TLS connections to the other SOCKS server |
chaining.ssl.enabledProtocols |
Comma Separated Values | The comma separated list of acceptable protocol versions enabled for SSL/TLS connections to the other SOCKS server |
chaining.ssl.keyStoreFile |
File | The key store file for the SSL/TLS connections to the other SOCKS server |
chaining.ssl.keyStorePassword |
String | The password for the key store for the SSL/TLS connections to the other SOCKS server |
chaining.ssl.keyStoreType |
String | The type of key store for the SSL/TLS connections to the other SOCKS server Default Value: PKCS12 |
chaining.ssl.protocol |
String | The protocol version for the SSL/TLS connections to the other SOCKS server Default Value: TLSv1.2 |
chaining.ssl.trustStoreFile |
File | The trust store file for the SSL/TLS connections to the other SOCKS server |
chaining.ssl.trustStorePassword |
String | The password for the trust store for the SSL/TLS connections to the other SOCKS server |
chaining.ssl.trustStoreType |
String | The type of trust store for the SSL/TLS connections to the other SOCKS server Default Value: PKCS12 |
DTLS Settings
| Name | Value Type | Description |
|---|---|---|
dtls.enabled |
Boolean | The boolean value to indicate if DTLS connections to the SOCKS server are enabled Default Value: false |
dtls.enabledCipherSuites |
Comma Separated Values | The comma separated list of acceptable cipher suites enabled for DTLS connections to the SOCKS server |
dtls.enabledProtocols |
Comma Separated Values | The comma separated list of acceptable protocol versions enabled for DTLS connections to the SOCKS server |
dtls.keyStoreFile |
File | The key store file for the DTLS connections to the SOCKS server |
dtls.keyStorePassword |
String | The password for the key store for the DTLS connections to the SOCKS server |
dtls.keyStoreType |
String | The type of key store for the DTLS connections to the SOCKS server Default Value: PKCS12 |
dtls.protocol |
String | The protocol version for the DTLS connections to the SOCKS server Default Value: DTLSv1.2 |
dtls.wrappedReceiveBufferSize |
Positive Integer | The buffer size for receiving DTLS wrapped datagrams for the DTLS connections to the SOCKS server |
SOCKS5 Settings
| Name | Value Type | Description |
|---|---|---|
socks5.gssapimethod.necReferenceImpl |
Boolean | The boolean value to indicate if the exchange of the GSS-API protection level negotiation must be unprotected according to the NEC reference implementation Default Value: false |
socks5.gssapimethod.protectionLevels |
SOCKS5 GSS-API Method Protection Levels | The comma separated list of acceptable protection levels after GSS-API authentication (The first is preferred if the client does not provide a protection level that is acceptable.) Default Value: REQUIRED_INTEG_AND_CONF,REQUIRED_INTEG,NONE |
socks5.gssapimethod.suggestedConf |
Boolean | The suggested privacy (i.e. confidentiality) state for GSS-API messages sent after GSS-API authentication (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF) Default Value: true |
socks5.gssapimethod.suggestedInteg |
Integer | The suggested quality-of-protection (i.e. integrity) value for GSS-API messages sent after GSS-API authentication (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF) Default Value: 0 |
socks5.methods |
SOCKS5 Methods | The comma separated list of acceptable authentication methods in order of preference Default Value: NO_AUTHENTICATION_REQUIRED |
socks5.onBindRequest.inboundSocketSettings |
Socket Settings | The comma separated list of socket settings for the inbound socket |
socks5.onBindRequest.listenBindHost |
Host | The binding host name or address for the listen socket if the provided host address is all zeros |
socks5.onBindRequest.listenBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for the listen socket if the provided host address is all zeros |
socks5.onBindRequest.listenBindPortRanges |
Port Ranges | The comma separated list of binding port ranges for the listen socket if the provided port is zero |
socks5.onBindRequest.listenNetInterface |
Network Interface | The network interface that provides a binding host address for the listen socket if the provided host address is all zeros |
socks5.onBindRequest.listenSocketSettings |
Socket Settings | The comma separated list of socket settings for the listen socket |
socks5.onBindRequest.relayBufferSize |
Positive Integer | The buffer size in bytes for relaying the data |
socks5.onBindRequest.relayIdleTimeout |
Positive Integer | The timeout in milliseconds on relaying no data |
socks5.onBindRequest.relayInboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onBindRequest.relayOutboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.onConnectRequest.prepareTargetFacingSocket |
Boolean | 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) Default Value: false |
socks5.onConnectRequest.relayBufferSize |
Positive Integer | The buffer size in bytes for relaying the data |
socks5.onConnectRequest.relayIdleTimeout |
Positive Integer | The timeout in milliseconds on relaying no data |
socks5.onConnectRequest.relayInboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onConnectRequest.relayOutboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.onConnectRequest.targetFacingBindHost |
Host | The binding host name or address for the target-facing socket |
socks5.onConnectRequest.targetFacingBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for the target-facing socket |
socks5.onConnectRequest.targetFacingBindPortRanges |
Port Ranges | The comma separated list of binding port ranges for the target-facing socket |
socks5.onConnectRequest.targetFacingConnectTimeout |
Positive Integer | The timeout in milliseconds on waiting for the target-facing socket to connect Default Value: 60000 |
socks5.onConnectRequest.targetFacingNetInterface |
Network Interface | The network interface that provides a binding host address for the target-facing socket |
socks5.onConnectRequest.targetFacingSocketSettings |
Socket Settings | The comma separated list of socket settings for the target-facing socket |
socks5.onRequest.externalFacingBindHost |
Host | The binding host name or address for all external-facing sockets |
socks5.onRequest.externalFacingBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for all external-facing sockets |
socks5.onRequest.externalFacingBindTcpPortRanges |
Port Ranges | The comma separated list of binding port ranges for all external-facing TCP sockets |
socks5.onRequest.externalFacingBindUdpPortRanges |
Port Ranges | The comma separated list of binding port ranges for all external-facing UDP sockets |
socks5.onRequest.externalFacingNetInterface |
Network Interface | The network interface that provides a binding host address for all external-facing sockets |
socks5.onRequest.externalFacingSocketSettings |
Socket Settings | The comma separated list of socket settings for all external-facing sockets |
socks5.onRequest.internalFacingBindHost |
Host | The binding host name or address for all internal-facing sockets |
socks5.onRequest.internalFacingBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for all internal-facing sockets |
socks5.onRequest.internalFacingBindUdpPortRanges |
Port Ranges | The comma separated list of binding port ranges for all internal-facing UDP sockets |
socks5.onRequest.internalFacingNetInterface |
Network Interface | The network interface that provides a binding host address for all internal-facing sockets |
socks5.onRequest.internalFacingSocketSettings |
Socket Settings | The comma separated list of socket settings for all internal-facing sockets |
socks5.onRequest.relayBufferSize |
Positive Integer | The buffer size in bytes for relaying the data Default Value: 1024 |
socks5.onRequest.relayIdleTimeout |
Positive Integer | The timeout in milliseconds on relaying no data Default Value: 60000 |
socks5.onRequest.relayInboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onRequest.relayOutboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.onUdpAssociateRequest.clientFacingBindHost |
Host | The binding host name or address for the client-facing UDP socket |
socks5.onUdpAssociateRequest.clientFacingBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for the client-facing UDP socket |
socks5.onUdpAssociateRequest.clientFacingBindPortRanges |
Port Ranges | The comma separated list of binding port ranges for the client-facing UDP socket |
socks5.onUdpAssociateRequest.clientFacingNetInterface |
Network Interface | The network interface that provides a binding host address for the client-facing UDP socket |
socks5.onUdpAssociateRequest.clientFacingSocketSettings |
Socket Settings | The comma separated list of socket settings for the client-facing UDP socket |
socks5.onUdpAssociateRequest.peerFacingBindHost |
Host | The binding host name or address for the peer-facing UDP socket |
socks5.onUdpAssociateRequest.peerFacingBindHostAddressTypes |
Host Address Types | The comma separated list of acceptable binding host address types for the peer-facing UDP socket |
socks5.onUdpAssociateRequest.peerFacingBindPortRanges |
Port Ranges | The comma separated list of binding port ranges for the peer-facing UDP socket |
socks5.onUdpAssociateRequest.peerFacingNetInterface |
Network Interface | The network interface that provides a binding host address for the peer-facing UDP socket |
socks5.onUdpAssociateRequest.peerFacingSocketSettings |
Socket Settings | The comma separated list of socket settings for the peer-facing UDP socket |
socks5.onUdpAssociateRequest.relayBufferSize |
Positive Integer | The buffer size in bytes for relaying the data |
socks5.onUdpAssociateRequest.relayIdleTimeout |
Positive Integer | The timeout in milliseconds on relaying no data |
socks5.onUdpAssociateRequest.relayInboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed |
socks5.onUdpAssociateRequest.relayOutboundBandwidthLimit |
Positive Integer | The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed |
socks5.userpassmethod.userRepository |
SOCKS5 Username Password Method User Repository | The user repository used for username password authentication Default Value: StringSourceUserRepository: |
SSL/TLS Settings
| Name | Value Type | Description |
|---|---|---|
ssl.enabled |
Boolean | The boolean value to indicate if SSL/TLS connections to the SOCKS server are enabled Default Value: false |
ssl.enabledCipherSuites |
Comma Separated Values | The comma separated list of acceptable cipher suites enabled for SSL/TLS connections to the SOCKS server |
ssl.enabledProtocols |
Comma Separated Values | The comma separated list of acceptable protocol versions enabled for SSL/TLS connections to the SOCKS server |
ssl.keyStoreFile |
File | The key store file for the SSL/TLS connections to the SOCKS server |
ssl.keyStorePassword |
String | The password for the key store for the SSL/TLS connections to the SOCKS server |
ssl.keyStoreType |
String | The type of key store for the SSL/TLS connections to the SOCKS server Default Value: PKCS12 |
ssl.needClientAuth |
Boolean | The boolean value to indicate that client authentication is required for SSL/TLS connections to the SOCKS server Default Value: false |
ssl.protocol |
String | The protocol version for the SSL/TLS connections to the SOCKS server Default Value: TLSv1.2 |
ssl.trustStoreFile |
File | The trust store file for the SSL/TLS connections to the SOCKS server |
ssl.trustStorePassword |
String | The password for the trust store for the SSL/TLS connections to the SOCKS server |
ssl.trustStoreType |
String | The type of trust store for the SSL/TLS connections to the SOCKS server Default Value: PKCS12 |
ssl.wantClientAuth |
Boolean | The boolean value to indicate that client authentication is requested for SSL/TLS connections to the SOCKS server Default Value: false |
backlog
Description: The maximum length of the queue of incoming client connections to the SOCKS server
Value Type: Non-negative Integer
Default Value: 50
bindHost
Description: The default binding host name or address for all sockets
Value Type: Host
Default Value: 0.0.0.0
bindHostAddressTypes
Description: The comma separated list of default acceptable binding host address types for all sockets
Value Type: Host Address Types
Default Value: HOST_IPV4_ADDRESS,HOST_IPV6_ADDRESS
bindTcpPortRanges
Description: The comma separated list of default binding port ranges for all TCP sockets
Value Type: Port Ranges
Default Value: 0
bindUdpPortRanges
Description: The comma separated list of default binding port ranges for all UDP sockets
Value Type: Port Ranges
Default Value: 0
chaining.clientBindHost
Description: The binding host name or address for the client socket that is used to connect to the other SOCKS server
Value Type: Host
Default Value: 0.0.0.0
chaining.clientBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for the client socket that is used to connect to the other SOCKS server
Value Type: Host Address Types
Default Value: HOST_IPV4_ADDRESS,HOST_IPV6_ADDRESS
chaining.clientBindPortRanges
Description: The comma separated list of binding port ranges for the client socket that is used to connect to the other SOCKS server
Value Type: Port Ranges
Default Value: 0
chaining.clientConnectTimeout
Description: The timeout in milliseconds on waiting for the client socket to connect to the other SOCKS server (a timeout of 0 is interpreted as an infinite timeout)
Value Type: Non-negative Integer
Default Value: 60000
chaining.clientNetInterface
Description: The network interface that provides a binding host address for the client socket that is used to connect to the other SOCKS server
Value Type: Network Interface
chaining.clientSocketSettings
Description: The comma separated list of socket settings for the client socket that is used to connect to the other SOCKS server
Value Type: Socket Settings
chaining.dtls.enabled
Description: The boolean value to indicate if DTLS connections to the other SOCKS server are enabled
Value Type: Boolean
Default Value: false
chaining.dtls.enabledCipherSuites
Description: The comma separated list of acceptable cipher suites enabled for DTLS connections to the other SOCKS server
Value Type: Comma Separated Values
chaining.dtls.enabledProtocols
Description: The comma separated list of acceptable protocol versions enabled for DTLS connections to the other SOCKS server
Value Type: Comma Separated Values
chaining.dtls.protocol
Description: The protocol version for the DTLS connections to the other SOCKS server
Value Type: String
Default Value: DTLSv1.2
chaining.dtls.trustStoreFile
Description: The trust store file for the DTLS connections to the other SOCKS server
Value Type: File
chaining.dtls.trustStorePassword
Description: The password for the trust store for the DTLS connections to the other SOCKS server
Value Type: String
chaining.dtls.trustStoreType
Description: The type of trust store for the DTLS connections to the other SOCKS server
Value Type: String
Default Value: PKCS12
chaining.dtls.wrappedReceiveBufferSize
Description: The buffer size for receiving DTLS wrapped datagrams for the DTLS connections to the other SOCKS server
Value Type: Positive Integer
chaining.routeId
Description: The ID for a route through a chain of other SOCKS servers. This setting also marks the current other SOCKS server as the last SOCKS server in the chain of other SOCKS servers
Value Type: String
chaining.socks5.gssapimethod.mechanismOid
Description: The object ID for the GSS-API authentication mechanism to the other SOCKS5 server
Value Type: Oid
Default Value: 1.2.840.113554.1.2.2
chaining.socks5.gssapimethod.necReferenceImpl
Description: The boolean value to indicate if the exchange of the GSS-API protection level negotiation must be unprotected should the other SOCKS5 server use the NEC reference implementation
Value Type: Boolean
Default Value: false
chaining.socks5.gssapimethod.protectionLevels
Description: The comma separated list of acceptable protection levels after GSS-API authentication with the other SOCKS5 server (The first is preferred. The remaining are acceptable if the server does not accept the first.)
Value Type: SOCKS5 GSS-API Method Protection Levels
Default Value: REQUIRED_INTEG_AND_CONF,REQUIRED_INTEG,NONE
chaining.socks5.gssapimethod.serviceName
Description: The GSS-API service name for the other SOCKS5 server
Value Type: String
chaining.socks5.gssapimethod.suggestedConf
Description: The suggested privacy (i.e. confidentiality) state for GSS-API messages sent after GSS-API authentication with the other SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF)
Value Type: Boolean
Default Value: true
chaining.socks5.gssapimethod.suggestedInteg
Description: The suggested quality-of-protection (i.e. integrity) value for GSS-API messages sent after GSS-API authentication with the other SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF)
Value Type: Integer
Default Value: 0
chaining.socks5.methods
Description: The comma separated list of acceptable authentication methods to the other SOCKS5 server
Value Type: SOCKS5 Methods
Default Value: NO_AUTHENTICATION_REQUIRED
chaining.socks5.socks5DatagramSocket.clientInfoUnavailable
Description: The boolean value to indicate if the client information expected to be used to send UDP datagrams (address and port) is unavailable to be sent to the other SOCKS5 server (an address and port of all zeros is sent instead)
Value Type: Boolean
Default Value: false
chaining.socks5.socks5HostResolver.resolveFromSocks5Server
Description: The boolean value to indicate if host names are to be resolved from the other SOCKS5 server
Value Type: Boolean
Default Value: false
chaining.socks5.userpassmethod.password
Description: The password to be used to access the other SOCKS5 server
Value Type: String
chaining.socks5.userpassmethod.username
Description: The username to be used to access the other SOCKS5 server
Value Type: String
chaining.socksServerUri
Description: The URI of the other SOCKS server
Value Type: SOCKS Server URI
chaining.ssl.enabled
Description: The boolean value to indicate if SSL/TLS connections to the other SOCKS server are enabled
Value Type: Boolean
Default Value: false
chaining.ssl.enabledCipherSuites
Description: The comma separated list of acceptable cipher suites enabled for SSL/TLS connections to the other SOCKS server
Value Type: Comma Separated Values
chaining.ssl.enabledProtocols
Description: The comma separated list of acceptable protocol versions enabled for SSL/TLS connections to the other SOCKS server
Value Type: Comma Separated Values
chaining.ssl.keyStoreFile
Description: The key store file for the SSL/TLS connections to the other SOCKS server
Value Type: File
chaining.ssl.keyStorePassword
Description: The password for the key store for the SSL/TLS connections to the other SOCKS server
Value Type: String
chaining.ssl.keyStoreType
Description: The type of key store for the SSL/TLS connections to the other SOCKS server
Value Type: String
Default Value: PKCS12
chaining.ssl.protocol
Description: The protocol version for the SSL/TLS connections to the other SOCKS server
Value Type: String
Default Value: TLSv1.2
chaining.ssl.trustStoreFile
Description: The trust store file for the SSL/TLS connections to the other SOCKS server
Value Type: File
chaining.ssl.trustStorePassword
Description: The password for the trust store for the SSL/TLS connections to the other SOCKS server
Value Type: String
chaining.ssl.trustStoreType
Description: The type of trust store for the SSL/TLS connections to the other SOCKS server
Value Type: String
Default Value: PKCS12
clientSocketSettings
Description: The comma separated list of socket settings for the client socket
Value Type: Socket Settings
doc
Description: A documentation setting
Value Type: String
dtls.enabled
Description: The boolean value to indicate if DTLS connections to the SOCKS server are enabled
Value Type: Boolean
Default Value: false
dtls.enabledCipherSuites
Description: The comma separated list of acceptable cipher suites enabled for DTLS connections to the SOCKS server
Value Type: Comma Separated Values
dtls.enabledProtocols
Description: The comma separated list of acceptable protocol versions enabled for DTLS connections to the SOCKS server
Value Type: Comma Separated Values
dtls.keyStoreFile
Description: The key store file for the DTLS connections to the SOCKS server
Value Type: File
dtls.keyStorePassword
Description: The password for the key store for the DTLS connections to the SOCKS server
Value Type: String
dtls.keyStoreType
Description: The type of key store for the DTLS connections to the SOCKS server
Value Type: String
Default Value: PKCS12
dtls.protocol
Description: The protocol version for the DTLS connections to the SOCKS server
Value Type: String
Default Value: DTLSv1.2
dtls.wrappedReceiveBufferSize
Description: The buffer size for receiving DTLS wrapped datagrams for the DTLS connections to the SOCKS server
Value Type: Positive Integer
externalFacingBindHost
Description: The default binding host name or address for all external-facing sockets
Value Type: Host
externalFacingBindHostAddressTypes
Description: The comma separated list of default acceptable binding host address types for all external-facing sockets
Value Type: Host Address Types
externalFacingBindTcpPortRanges
Description: The comma separated list of default binding port ranges for all external-facing TCP sockets
Value Type: Port Ranges
externalFacingBindUdpPortRanges
Description: The comma separated list of default binding port ranges for all external-facing UDP sockets
Value Type: Port Ranges
externalFacingNetInterface
Description: The default network interface that provides a binding host address for all external-facing sockets
Value Type: Network Interface
externalFacingSocketSettings
Description: The comma separated list of default socket settings for all external-facing sockets
Value Type: Socket Settings
internalFacingBindHost
Description: The default binding host name or address for all internal-facing sockets
Value Type: Host
internalFacingBindHostAddressTypes
Description: The comma separated list of default acceptable binding host address types for all internal-facing sockets
Value Type: Host Address Types
internalFacingBindTcpPortRanges
Description: The comma separated list of default binding port ranges for all internal-facing TCP sockets
Value Type: Port Ranges
internalFacingBindUdpPortRanges
Description: The comma separated list of default binding port ranges for all internal-facing UDP sockets
Value Type: Port Ranges
internalFacingNetInterface
Description: The default network interface that provides a binding host address for all internal-facing sockets
Value Type: Network Interface
internalFacingSocketSettings
Description: The comma separated list of default socket settings for all internal-facing sockets
Value Type: Socket Settings
lastRouteId
Description: The ID for the last and unassigned route
Value Type: String
Default Value: lastRoute
netInterface
Description: The default network interface that provides a binding host address for all sockets
Value Type: Network Interface
port
Description: The port for the SOCKS server
Value Type: Port
Default Value: 1080
routeSelectionLogAction
Description: The logging action to take if a route is selected
Value Type: Log Action
routeSelectionStrategy
Description: The selection strategy for the next route
Value Type: Selection Strategy
Default Value: CYCLICAL
rule
Description: A rule for the SOCKS server
Value Type: Rule
Default Value: firewallAction=ALLOW
socketSettings
Description: The comma separated list of default socket settings for all sockets
Value Type: Socket Settings
socks5.gssapimethod.necReferenceImpl
Description: The boolean value to indicate if the exchange of the GSS-API protection level negotiation must be unprotected according to the NEC reference implementation
Value Type: Boolean
Default Value: false
socks5.gssapimethod.protectionLevels
Description: The comma separated list of acceptable protection levels after GSS-API authentication (The first is preferred if the client does not provide a protection level that is acceptable.)
Value Type: SOCKS5 GSS-API Method Protection Levels
Default Value: REQUIRED_INTEG_AND_CONF,REQUIRED_INTEG,NONE
socks5.gssapimethod.suggestedConf
Description: The suggested privacy (i.e. confidentiality) state for GSS-API messages sent after GSS-API authentication (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF)
Value Type: Boolean
Default Value: true
socks5.gssapimethod.suggestedInteg
Description: The suggested quality-of-protection (i.e. integrity) value for GSS-API messages sent after GSS-API authentication (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF)
Value Type: Integer
Default Value: 0
socks5.methods
Description: The comma separated list of acceptable authentication methods in order of preference
Value Type: SOCKS5 Methods
Default Value: NO_AUTHENTICATION_REQUIRED
socks5.onBindRequest.inboundSocketSettings
Description: The comma separated list of socket settings for the inbound socket
Value Type: Socket Settings
socks5.onBindRequest.listenBindHost
Description: The binding host name or address for the listen socket if the provided host address is all zeros
Value Type: Host
socks5.onBindRequest.listenBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for the listen socket if the provided host address is all zeros
Value Type: Host Address Types
socks5.onBindRequest.listenBindPortRanges
Description: The comma separated list of binding port ranges for the listen socket if the provided port is zero
Value Type: Port Ranges
socks5.onBindRequest.listenNetInterface
Description: 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.listenSocketSettings
Description: The comma separated list of socket settings for the listen socket
Value Type: Socket Settings
socks5.onBindRequest.relayBufferSize
Description: The buffer size in bytes for relaying the data
Value Type: Positive Integer
socks5.onBindRequest.relayIdleTimeout
Description: The timeout in milliseconds on relaying no data
Value Type: Positive Integer
socks5.onBindRequest.relayInboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onBindRequest.relayOutboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.onConnectRequest.prepareTargetFacingSocket
Description: 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
Default Value: false
socks5.onConnectRequest.relayBufferSize
Description: The buffer size in bytes for relaying the data
Value Type: Positive Integer
socks5.onConnectRequest.relayIdleTimeout
Description: The timeout in milliseconds on relaying no data
Value Type: Positive Integer
socks5.onConnectRequest.relayInboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onConnectRequest.relayOutboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.onConnectRequest.targetFacingBindHost
Description: The binding host name or address for the target-facing socket
Value Type: Host
socks5.onConnectRequest.targetFacingBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for the target-facing socket
Value Type: Host Address Types
socks5.onConnectRequest.targetFacingBindPortRanges
Description: The comma separated list of binding port ranges for the target-facing socket
Value Type: Port Ranges
socks5.onConnectRequest.targetFacingConnectTimeout
Description: The timeout in milliseconds on waiting for the target-facing socket to connect
Value Type: Positive Integer
Default Value: 60000
socks5.onConnectRequest.targetFacingNetInterface
Description: The network interface that provides a binding host address for the target-facing socket
Value Type: Network Interface
socks5.onConnectRequest.targetFacingSocketSettings
Description: The comma separated list of socket settings for the target-facing socket
Value Type: Socket Settings
socks5.onRequest.externalFacingBindHost
Description: The binding host name or address for all external-facing sockets
Value Type: Host
socks5.onRequest.externalFacingBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for all external-facing sockets
Value Type: Host Address Types
socks5.onRequest.externalFacingBindTcpPortRanges
Description: The comma separated list of binding port ranges for all external-facing TCP sockets
Value Type: Port Ranges
socks5.onRequest.externalFacingBindUdpPortRanges
Description: The comma separated list of binding port ranges for all external-facing UDP sockets
Value Type: Port Ranges
socks5.onRequest.externalFacingNetInterface
Description: The network interface that provides a binding host address for all external-facing sockets
Value Type: Network Interface
socks5.onRequest.externalFacingSocketSettings
Description: The comma separated list of socket settings for all external-facing sockets
Value Type: Socket Settings
socks5.onRequest.internalFacingBindHost
Description: The binding host name or address for all internal-facing sockets
Value Type: Host
socks5.onRequest.internalFacingBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for all internal-facing sockets
Value Type: Host Address Types
socks5.onRequest.internalFacingBindUdpPortRanges
Description: The comma separated list of binding port ranges for all internal-facing UDP sockets
Value Type: Port Ranges
socks5.onRequest.internalFacingNetInterface
Description: The network interface that provides a binding host address for all internal-facing sockets
Value Type: Network Interface
socks5.onRequest.internalFacingSocketSettings
Description: The comma separated list of socket settings for all internal-facing sockets
Value Type: Socket Settings
socks5.onRequest.relayBufferSize
Description: The buffer size in bytes for relaying the data
Value Type: Positive Integer
Default Value: 1024
socks5.onRequest.relayIdleTimeout
Description: The timeout in milliseconds on relaying no data
Value Type: Positive Integer
Default Value: 60000
socks5.onRequest.relayInboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onRequest.relayOutboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.onUdpAssociateRequest.clientFacingBindHost
Description: The binding host name or address for the client-facing UDP socket
Value Type: Host
socks5.onUdpAssociateRequest.clientFacingBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for the client-facing UDP socket
Value Type: Host Address Types
socks5.onUdpAssociateRequest.clientFacingBindPortRanges
Description: The comma separated list of binding port ranges for the client-facing UDP socket
Value Type: Port Ranges
socks5.onUdpAssociateRequest.clientFacingNetInterface
Description: The network interface that provides a binding host address for the client-facing UDP socket
Value Type: Network Interface
socks5.onUdpAssociateRequest.clientFacingSocketSettings
Description: The comma separated list of socket settings for the client-facing UDP socket
Value Type: Socket Settings
socks5.onUdpAssociateRequest.peerFacingBindHost
Description: The binding host name or address for the peer-facing UDP socket
Value Type: Host
socks5.onUdpAssociateRequest.peerFacingBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for the peer-facing UDP socket
Value Type: Host Address Types
socks5.onUdpAssociateRequest.peerFacingBindPortRanges
Description: The comma separated list of binding port ranges for the peer-facing UDP socket
Value Type: Port Ranges
socks5.onUdpAssociateRequest.peerFacingNetInterface
Description: The network interface that provides a binding host address for the peer-facing UDP socket
Value Type: Network Interface
socks5.onUdpAssociateRequest.peerFacingSocketSettings
Description: The comma separated list of socket settings for the peer-facing UDP socket
Value Type: Socket Settings
socks5.onUdpAssociateRequest.relayBufferSize
Description: The buffer size in bytes for relaying the data
Value Type: Positive Integer
socks5.onUdpAssociateRequest.relayIdleTimeout
Description: The timeout in milliseconds on relaying no data
Value Type: Positive Integer
socks5.onUdpAssociateRequest.relayInboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving inbound data to be relayed
Value Type: Positive Integer
socks5.onUdpAssociateRequest.relayOutboundBandwidthLimit
Description: The upper limit on bandwidth in bytes per second of receiving outbound data to be relayed
Value Type: Positive Integer
socks5.userpassmethod.userRepository
Description: The user repository used for username password authentication
Value Type: SOCKS5 Username Password Method User Repository
Default Value: StringSourceUserRepository:
socksServerBindHost
Description: The binding host name or address for the SOCKS server socket
Value Type: Host
socksServerBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for the SOCKS server socket
Value Type: Host Address Types
socksServerBindPortRanges
Description: The comma separated list of binding port ranges for the SOCKS server socket
Value Type: Port Ranges
socksServerNetInterface
Description: The network interface that provides a binding host address for the SOCKS server socket
Value Type: Network Interface
socksServerSocketSettings
Description: The comma separated list of socket settings for the SOCKS server socket
Value Type: Socket Settings
ssl.enabled
Description: The boolean value to indicate if SSL/TLS connections to the SOCKS server are enabled
Value Type: Boolean
Default Value: false
ssl.enabledCipherSuites
Description: The comma separated list of acceptable cipher suites enabled for SSL/TLS connections to the SOCKS server
Value Type: Comma Separated Values
ssl.enabledProtocols
Description: The comma separated list of acceptable protocol versions enabled for SSL/TLS connections to the SOCKS server
Value Type: Comma Separated Values
ssl.keyStoreFile
Description: The key store file for the SSL/TLS connections to the SOCKS server
Value Type: File
ssl.keyStorePassword
Description: The password for the key store for the SSL/TLS connections to the SOCKS server
Value Type: String
ssl.keyStoreType
Description: The type of key store for the SSL/TLS connections to the SOCKS server
Value Type: String
Default Value: PKCS12
ssl.needClientAuth
Description: The boolean value to indicate that client authentication is required for SSL/TLS connections to the SOCKS server
Value Type: Boolean
Default Value: false
ssl.protocol
Description: The protocol version for the SSL/TLS connections to the SOCKS server
Value Type: String
Default Value: TLSv1.2
ssl.trustStoreFile
Description: The trust store file for the SSL/TLS connections to the SOCKS server
Value Type: File
ssl.trustStorePassword
Description: The password for the trust store for the SSL/TLS connections to the SOCKS server
Value Type: String
ssl.trustStoreType
Description: The type of trust store for the SSL/TLS connections to the SOCKS server
Value Type: String
Default Value: PKCS12
ssl.wantClientAuth
Description: The boolean value to indicate that client authentication is requested for SSL/TLS connections to the SOCKS server
Value Type: Boolean
Default Value: false