Built by Maven

Client Properties

Page Contents

SOCKS Server URI Properties

socksServerUri.port

Syntax:

socksServerUri.port=PORT

Description:

The port of the SOCKS server URI (default is 1080)

Value: Port

socksServerUri.host

Syntax:

socksServerUri.host=HOST

Description:

The host name or address of the SOCKS server URI

Value: Host

socksServerUri.scheme

Syntax:

socksServerUri.scheme=SCHEME

Description:

The scheme of the SOCKS server URI

Value: Scheme

General Properties

socksClient.clientBindHost

Syntax:

socksClient.clientBindHost=HOST

Description:

The binding host name or address for the client socket that is used to connect to the SOCKS server (used for the SOCKS5 commands RESOLVE, BIND and UDP ASSOCIATE) (default is 0.0.0.0)

Value: Host

socksClient.clientBindPortRanges

Syntax:

socksClient.clientBindPortRanges=PORT_RANGES

Description:

The comma separated list of binding port ranges for the client socket that is used to connect to the SOCKS server (used for the SOCKS5 commands RESOLVE, BIND and UDP ASSOCIATE) (default is 0)

Value: Port Ranges

socksClient.clientConnectTimeout

Syntax:

socksClient.clientConnectTimeout=POSITIVE_INTEGER

Description:

The timeout in milliseconds on waiting for the client socket to connect to the SOCKS server (used for the SOCKS5 commands RESOLVE, BIND and UDP ASSOCIATE) (default is 60000)

Value: Positive Integer

socksClient.clientSocketSettings

Syntax:

socksClient.clientSocketSettings=SOCKET_SETTINGS

Description:

The comma separated list of socket settings for the client socket that is used to connect to the SOCKS server (used for the SOCKS5 command RESOLVE and UDP ASSOCIATE)

Value: Socket Settings

DTLS Properties

socksClient.dtls.enabled

Syntax:

socksClient.dtls.enabled=true|false

Description:

The boolean value to indicate if DTLS connections to the SOCKS server are enabled (default is false)

Value: java.lang.Boolean

socksClient.dtls.enabledCipherSuites

Syntax:

socksClient.dtls.enabledCipherSuites=COMMA_SEPARATED_VALUES

Description:

The comma separated list of acceptable cipher suites enabled for DTLS connections to the SOCKS server

Value: Comma Separated Values

socksClient.dtls.enabledProtocols

Syntax:

socksClient.dtls.enabledProtocols=COMMA_SEPARATED_VALUES

Description:

The comma separated list of acceptable protocol versions enabled for DTLS connections to the SOCKS server

Value: Comma Separated Values

socksClient.dtls.maxPacketSize

Syntax:

socksClient.dtls.maxPacketSize=POSITIVE_INTEGER

Description:

The maximum packet size for the DTLS connections to the SOCKS server (default is 32768)

Value: Positive Integer

socksClient.dtls.protocol

Syntax:

socksClient.dtls.protocol=PROTOCOL

Description:

The protocol version for the DTLS connections to the SOCKS server (default is DTLSv1.2)

Value: java.lang.String

socksClient.dtls.trustStoreFile

Syntax:

socksClient.dtls.trustStoreFile=FILE

Description:

The trust store file for the DTLS connections to the SOCKS server

Value: java.io.File

socksClient.dtls.trustStorePassword

Syntax:

socksClient.dtls.trustStorePassword=PASSWORD

Description:

The password for the trust store for the DTLS connections to the SOCKS server

Value: java.lang.String

socksClient.dtls.trustStoreType

Syntax:

socksClient.dtls.trustStoreType=TYPE

Description:

The type of trust store file for the DTLS connections to the SOCKS server (default is PKCS12)

Value: java.lang.String

SOCKS5 Properties

socksClient.socks5.clientUdpAddressAndPortUnknown

Syntax:

socksClient.socks5.clientUdpAddressAndPortUnknown=true|false

Description:

The boolean value to indicate that the client UDP address and port for sending UDP datagrams to the SOCKS5 server is unknown (default is false)

Value: java.lang.Boolean

socksClient.socks5.gssapimethod.mechanismOid

Syntax:

socksClient.socks5.gssapimethod.mechanismOid=OID

Description:

The object ID for the GSS-API authentication mechanism to the SOCKS5 server (default is 1.2.840.113554.1.2.2)

Value: org.ietf.jgss.Oid

socksClient.socks5.gssapimethod.necReferenceImpl

Syntax:

socksClient.socks5.gssapimethod.necReferenceImpl=true|false

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 (default is false)

Value: java.lang.Boolean

socksClient.socks5.gssapimethod.protectionLevels

Syntax:

socksClient.socks5.gssapimethod.protectionLevels=SOCKS5_GSSAPIMETHOD_PROTECTION_LEVELS

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.) (default is REQUIRED_INTEG_AND_CONF,REQUIRED_INTEG,NONE)

Value: SOCKS5 GSS-API Method Protection Levels

socksClient.socks5.gssapimethod.serviceName

Syntax:

socksClient.socks5.gssapimethod.serviceName=SERVICE_NAME

Description:

The GSS-API service name for the SOCKS5 server

Value: java.lang.String

socksClient.socks5.methods

Syntax:

socksClient.socks5.methods=SOCKS5_METHODS

Description:

The comma separated list of acceptable authentication methods to the SOCKS5 server (default is NO_AUTHENTICATION_REQUIRED)

Value: SOCKS5 Methods

socksClient.socks5.useResolveCommand

Syntax:

socksClient.socks5.useResolveCommand=true|false

Description:

The boolean value to indicate that the RESOLVE command is to be used on the SOCKS5 server for resolving host names (default is false)

Value: java.lang.Boolean

socksClient.socks5.userpassmethod.password

Syntax:

socksClient.socks5.userpassmethod.password=PASSWORD

Description:

The password to be used to access the SOCKS5 server

Value: java.lang.String

socksClient.socks5.userpassmethod.username

Syntax:

socksClient.socks5.userpassmethod.username=USERNAME

Description:

The username to be used to access the SOCKS5 server

Value: java.lang.String

SSL/TLS Properties

socksClient.ssl.enabled

Syntax:

socksClient.ssl.enabled=true|false

Description:

The boolean value to indicate if SSL/TLS connections to the SOCKS server are enabled (default is false)

Value: java.lang.Boolean

socksClient.ssl.enabledCipherSuites

Syntax:

socksClient.ssl.enabledCipherSuites=COMMA_SEPARATED_VALUES

Description:

The comma separated list of acceptable cipher suites enabled for SSL/TLS connections to the SOCKS server

Value: Comma Separated Values

socksClient.ssl.enabledProtocols

Syntax:

socksClient.ssl.enabledProtocols=COMMA_SEPARATED_VALUES

Description:

The comma separated list of acceptable protocol versions enabled for SSL/TLS connections to the SOCKS server

Value: Comma Separated Values

socksClient.ssl.keyStoreFile

Syntax:

socksClient.ssl.keyStoreFile=FILE

Description:

The key store file for the SSL/TLS connections to the SOCKS server

Value: java.io.File

socksClient.ssl.keyStorePassword

Syntax:

socksClient.ssl.keyStorePassword=PASSWORD

Description:

The password for the key store for the SSL/TLS connections to the SOCKS server

Value: java.lang.String

socksClient.ssl.keyStoreType

Syntax:

socksClient.ssl.keyStoreType=TYPE

Description:

The type of key store file for the SSL/TLS connections to the SOCKS server (default is PKCS12)

Value: java.lang.String

socksClient.ssl.protocol

Syntax:

socksClient.ssl.protocol=PROTOCOL

Description:

The protocol version for the SSL/TLS connections to the SOCKS server (default is TLSv1.2)

Value: java.lang.String

socksClient.ssl.trustStoreFile

Syntax:

socksClient.ssl.trustStoreFile=FILE

Description:

The trust store file for the SSL/TLS connections to the SOCKS server

Value: java.io.File

socksClient.ssl.trustStorePassword

Syntax:

socksClient.ssl.trustStorePassword=PASSWORD

Description:

The password for the trust store for the SSL/TLS connections to the SOCKS server

Value: java.lang.String

socksClient.ssl.trustStoreType

Syntax:

socksClient.ssl.trustStoreType=TYPE

Description:

The type of trust store file for the SSL/TLS connections to the SOCKS server (default is PKCS12)

Value: java.lang.String