Client Properties
General Properties
| Name | Value Type | Description |
|---|---|---|
socksClient.clientBindHost |
Host | The binding host name or address for the client socket that is used to connect to the SOCKS server Default Value: 0.0.0.0 |
socksClient.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 SOCKS server Default Value: HOST_IPV4_ADDRESS,HOST_IPV6_ADDRESS |
socksClient.clientBindPortRanges |
Port Ranges | The comma separated list of binding port ranges for the client socket that is used to connect to the SOCKS server Default Value: 0 |
socksClient.clientConnectTimeout |
Non-negative Integer | The timeout in milliseconds on waiting for the client socket to connect to the SOCKS server (a timeout of 0 is interpreted as an infinite timeout) Default Value: 60000 |
socksClient.clientNetInterface |
Network Interface | The network interface that provides a binding host address for the client socket that is used to connect to the SOCKS server |
socksClient.clientSocketSettings |
Socket Settings | The comma separated list of socket settings for the client socket that is used to connect to the SOCKS server |
socksClient.socksServerUri |
SOCKS Server URI | The URI of the SOCKS server |
DTLS Properties
| Name | Value Type | Description |
|---|---|---|
socksClient.dtls.enabled |
Boolean | The boolean value to indicate if DTLS connections to the SOCKS server are enabled Default Value: false |
socksClient.dtls.enabledCipherSuites |
Comma Separated Values | The comma separated list of acceptable cipher suites enabled for DTLS connections to the SOCKS server |
socksClient.dtls.enabledProtocols |
Comma Separated Values | The comma separated list of acceptable protocol versions enabled for DTLS connections to the SOCKS server |
socksClient.dtls.protocol |
String | The protocol version for the DTLS connections to the SOCKS server Default Value: DTLSv1.2 |
socksClient.dtls.trustStoreFile |
File | The trust store file for the DTLS connections to the SOCKS server |
socksClient.dtls.trustStorePassword |
String | The password for the trust store for the DTLS connections to the SOCKS server |
socksClient.dtls.trustStoreType |
String | The type of trust store for the DTLS connections to the SOCKS server Default Value: PKCS12 |
socksClient.dtls.wrappedReceiveBufferSize |
Positive Integer | The buffer size for receiving DTLS wrapped datagrams for the DTLS connections to the SOCKS server |
SOCKS5 Properties
| Name | Value Type | Description |
|---|---|---|
socksClient.socks5.gssapimethod.mechanismOid |
Oid | The object ID for the GSS-API authentication mechanism to the SOCKS5 server Default Value: 1.2.840.113554.1.2.2 |
socksClient.socks5.gssapimethod.necReferenceImpl |
Boolean | The boolean value to indicate if the exchange of the GSS-API protection level negotiation must be unprotected should the SOCKS5 server use the NEC reference implementation Default Value: false |
socksClient.socks5.gssapimethod.protectionLevels |
SOCKS5 GSS-API Method Protection Levels | The comma separated list of acceptable protection levels after GSS-API authentication with the 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 |
socksClient.socks5.gssapimethod.serviceName |
String | The GSS-API service name for the SOCKS5 server |
socksClient.socks5.gssapimethod.suggestedConf |
Boolean | The suggested privacy (i.e. confidentiality) state for GSS-API messages sent after GSS-API authentication with the SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF) Default Value: true |
socksClient.socks5.gssapimethod.suggestedInteg |
Integer | The suggested quality-of-protection (i.e. integrity) value for GSS-API messages sent after GSS-API authentication with the SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF) Default Value: 0 |
socksClient.socks5.methods |
SOCKS5 Methods | The comma separated list of acceptable authentication methods to the SOCKS5 server Default Value: NO_AUTHENTICATION_REQUIRED |
socksClient.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 SOCKS5 server (an address and port of all zeros is sent instead) Default Value: false |
socksClient.socks5.socks5HostResolver.resolveFromSocks5Server |
Boolean | The boolean value to indicate if host names are to be resolved from the SOCKS5 server Default Value: false |
socksClient.socks5.userpassmethod.password |
String | The password to be used to access the SOCKS5 server |
socksClient.socks5.userpassmethod.username |
String | The username to be used to access the SOCKS5 server |
SSL/TLS Properties
| Name | Value Type | Description |
|---|---|---|
socksClient.ssl.enabled |
Boolean | The boolean value to indicate if SSL/TLS connections to the SOCKS server are enabled Default Value: false |
socksClient.ssl.enabledCipherSuites |
Comma Separated Values | The comma separated list of acceptable cipher suites enabled for SSL/TLS connections to the SOCKS server |
socksClient.ssl.enabledProtocols |
Comma Separated Values | The comma separated list of acceptable protocol versions enabled for SSL/TLS connections to the SOCKS server |
socksClient.ssl.keyStoreFile |
File | The key store file for the SSL/TLS connections to the SOCKS server |
socksClient.ssl.keyStorePassword |
String | The password for the key store for the SSL/TLS connections to the SOCKS server |
socksClient.ssl.keyStoreType |
String | The type of key store for the SSL/TLS connections to the SOCKS server Default Value: PKCS12 |
socksClient.ssl.protocol |
String | The protocol version for the SSL/TLS connections to the SOCKS server Default Value: TLSv1.2 |
socksClient.ssl.trustStoreFile |
File | The trust store file for the SSL/TLS connections to the SOCKS server |
socksClient.ssl.trustStorePassword |
String | The password for the trust store for the SSL/TLS connections to the SOCKS server |
socksClient.ssl.trustStoreType |
String | The type of trust store for the SSL/TLS connections to the SOCKS server Default Value: PKCS12 |
socksClient.clientBindHost
Description: The binding host name or address for the client socket that is used to connect to the SOCKS server
Value Type: Host
Default Value: 0.0.0.0
socksClient.clientBindHostAddressTypes
Description: The comma separated list of acceptable binding host address types for the client socket that is used to connect to the SOCKS server
Value Type: Host Address Types
Default Value: HOST_IPV4_ADDRESS,HOST_IPV6_ADDRESS
socksClient.clientBindPortRanges
Description: The comma separated list of binding port ranges for the client socket that is used to connect to the SOCKS server
Value Type: Port Ranges
Default Value: 0
socksClient.clientConnectTimeout
Description: The timeout in milliseconds on waiting for the client socket to connect to the SOCKS server (a timeout of 0 is interpreted as an infinite timeout)
Value Type: Non-negative Integer
Default Value: 60000
socksClient.clientNetInterface
Description: The network interface that provides a binding host address for the client socket that is used to connect to the SOCKS server
Value Type: Network Interface
socksClient.clientSocketSettings
Description: The comma separated list of socket settings for the client socket that is used to connect to the SOCKS server
Value Type: Socket Settings
socksClient.dtls.enabled
Description: The boolean value to indicate if DTLS connections to the SOCKS server are enabled
Value Type: Boolean
Default Value: false
socksClient.dtls.enabledCipherSuites
Description: The comma separated list of acceptable cipher suites enabled for DTLS connections to the SOCKS server
Value Type: Comma Separated Values
socksClient.dtls.enabledProtocols
Description: The comma separated list of acceptable protocol versions enabled for DTLS connections to the SOCKS server
Value Type: Comma Separated Values
socksClient.dtls.protocol
Description: The protocol version for the DTLS connections to the SOCKS server
Value Type: String
Default Value: DTLSv1.2
socksClient.dtls.trustStoreFile
Description: The trust store file for the DTLS connections to the SOCKS server
Value Type: File
socksClient.dtls.trustStorePassword
Description: The password for the trust store for the DTLS connections to the SOCKS server
Value Type: String
socksClient.dtls.trustStoreType
Description: The type of trust store for the DTLS connections to the SOCKS server
Value Type: String
Default Value: PKCS12
socksClient.dtls.wrappedReceiveBufferSize
Description: The buffer size for receiving DTLS wrapped datagrams for the DTLS connections to the SOCKS server
Value Type: Positive Integer
socksClient.socks5.gssapimethod.mechanismOid
Description: The object ID for the GSS-API authentication mechanism to the SOCKS5 server
Value Type: Oid
Default Value: 1.2.840.113554.1.2.2
socksClient.socks5.gssapimethod.necReferenceImpl
Description: The boolean value to indicate if the exchange of the GSS-API protection level negotiation must be unprotected should the SOCKS5 server use the NEC reference implementation
Value Type: Boolean
Default Value: false
socksClient.socks5.gssapimethod.protectionLevels
Description: The comma separated list of acceptable protection levels after GSS-API authentication with the 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
socksClient.socks5.gssapimethod.serviceName
Description: The GSS-API service name for the SOCKS5 server
Value Type: String
socksClient.socks5.gssapimethod.suggestedConf
Description: The suggested privacy (i.e. confidentiality) state for GSS-API messages sent after GSS-API authentication with the SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF)
Value Type: Boolean
Default Value: true
socksClient.socks5.gssapimethod.suggestedInteg
Description: The suggested quality-of-protection (i.e. integrity) value for GSS-API messages sent after GSS-API authentication with the SOCKS5 server (applicable if the negotiated protection level is SELECTIVE_INTEG_OR_CONF)
Value Type: Integer
Default Value: 0
socksClient.socks5.methods
Description: The comma separated list of acceptable authentication methods to the SOCKS5 server
Value Type: SOCKS5 Methods
Default Value: NO_AUTHENTICATION_REQUIRED
socksClient.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 SOCKS5 server (an address and port of all zeros is sent instead)
Value Type: Boolean
Default Value: false
socksClient.socks5.socks5HostResolver.resolveFromSocks5Server
Description: The boolean value to indicate if host names are to be resolved from the SOCKS5 server
Value Type: Boolean
Default Value: false
socksClient.socks5.userpassmethod.password
Description: The password to be used to access the SOCKS5 server
Value Type: String
socksClient.socks5.userpassmethod.username
Description: The username to be used to access the SOCKS5 server
Value Type: String
socksClient.socksServerUri
Description: The URI of the SOCKS server
Value Type: SOCKS Server URI
socksClient.ssl.enabled
Description: The boolean value to indicate if SSL/TLS connections to the SOCKS server are enabled
Value Type: Boolean
Default Value: false
socksClient.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
socksClient.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
socksClient.ssl.keyStoreFile
Description: The key store file for the SSL/TLS connections to the SOCKS server
Value Type: File
socksClient.ssl.keyStorePassword
Description: The password for the key store for the SSL/TLS connections to the SOCKS server
Value Type: String
socksClient.ssl.keyStoreType
Description: The type of key store for the SSL/TLS connections to the SOCKS server
Value Type: String
Default Value: PKCS12
socksClient.ssl.protocol
Description: The protocol version for the SSL/TLS connections to the SOCKS server
Value Type: String
Default Value: TLSv1.2
socksClient.ssl.trustStoreFile
Description: The trust store file for the SSL/TLS connections to the SOCKS server
Value Type: File
socksClient.ssl.trustStorePassword
Description: The password for the trust store for the SSL/TLS connections to the SOCKS server
Value Type: String
socksClient.ssl.trustStoreType
Description: The type of trust store for the SSL/TLS connections to the SOCKS server
Value Type: String
Default Value: PKCS12