Value Syntaxes
Page Contents
- Address Range
- Comma Separated Values
- Digit
- Firewall Action
- Host
- Log Action
- Non-negative Integer
- Performance Preferences
- Port
- Port Range
- Port Ranges
- Positive Integer
- Rule
- Scheme
- Selection Strategy
- Socket Setting
- Socket Settings
- SOCKS5 Address
- SOCKS5 Command
- SOCKS5 GSS-API Method Protection Level
- SOCKS5 GSS-API Method Protection Levels
- SOCKS5 Method
- SOCKS5 Methods
- SOCKS5 Username Password Method User Repository
- SOCKS Server URI
- Unsigned Byte
Address Range
Syntax:
ADDRESS|IP_ADDRESS1-IP_ADDRESS2|regex:REGULAR_EXPRESSION
Comma Separated Values
Syntax:
[VALUE1[,VALUE2[...]]]
Description:
A comma separated list of values
Element value: java.lang.String
Digit
Syntax:
0-9
Description:
An integer between 0 and 9 (inclusive)
Firewall Action
Syntax:
ALLOW|DENY
Values:
-
ALLOW -
DENY
Host
Syntax:
HOST_NAME|HOST_ADDRESS
Description:
A name or address of a node of a network
Log Action
Syntax:
LOG_AS_WARNING|LOG_AS_INFO
Values:
-
LOG_AS_WARNING: Log message as a warning message -
LOG_AS_INFO: Log message as an informational message
Non-negative Integer
Syntax:
0-2147483647
Description:
An integer between 0 and 2147483647 (inclusive)
Performance Preferences
Syntax:
DIGITDIGITDIGIT
Description:
Performance preferences for a TCP socket described by three digits whose values indicate the relative importance of short connection time, low latency, and high bandwidth
Element value: Digit
Port
Syntax:
0-65535
Description:
An integer between 0 and 65535 (inclusive) that is assigned to uniquely identify a connection endpoint and to direct data to a host
Port Range
Syntax:
PORT|PORT1-PORT2
Description:
A range of port numbers between the provided minimum port number and the maximum port number (inclusive). A port range can also be one port number.
Element value: Port
Port Ranges
Syntax:
[PORT_RANGE1[,PORT_RANGE2[...]]]
Description:
A comma separated list of port ranges.
Element value: Port Range
Positive Integer
Syntax:
1-2147483647
Description:
An integer between 1 and 2147483647 (inclusive)
Rule
Syntax:
[RULE_CONDITION1,[RULE_CONDITION2,[...]]]RULE_RESULT1[,RULE_RESULT2[...]]
Scheme
Syntax:
socks5
Values:
socks5: SOCKS5 protocol version 5
Selection Strategy
Syntax:
CYCLICAL|RANDOM
Selection Strategies
CYCLICAL
Syntax:
CYCLICAL
Description:
Select the next in the cycle
RANDOM
Syntax:
RANDOM
Description:
Select the next at random
Socket Setting
Syntax:
NAME=VALUE
Description:
A setting to be applied to a socket
Standard Socket Settings
Description:
Standard settings applied to a socket
IP_TOS
Syntax:
IP_TOS=UNSIGNED_BYTE
Description:
The type-of-service or traffic class field in the IP header for a TCP or UDP socket
Value: Unsigned Byte
PERF_PREFS
Syntax:
PERF_PREFS=PERFORMANCE_PREFERENCES
Description:
Performance preferences for a TCP socket described by three digits whose values indicate the relative importance of short connection time, low latency, and high bandwidth
Value: Performance Preferences
SO_BROADCAST
Syntax:
SO_BROADCAST=true|false
Description:
Can send broadcast datagrams
Value: java.lang.Boolean
SO_KEEPALIVE
Syntax:
SO_KEEPALIVE=true|false
Description:
Keeps a TCP socket alive when no data has been exchanged in either direction
Value: java.lang.Boolean
SO_LINGER
Syntax:
SO_LINGER=NON_NEGATIVE_INTEGER
Description:
Linger on closing the TCP socket in seconds
Value: Non-negative Integer
SO_RCVBUF
Syntax:
SO_RCVBUF=POSITIVE_INTEGER
Description:
The receive buffer size
Value: Positive Integer
SO_REUSEADDR
Syntax:
SO_REUSEADDR=true|false
Description:
Can reuse socket address and port
Value: java.lang.Boolean
SO_SNDBUF
Syntax:
SO_SNDBUF=POSITIVE_INTEGER
Description:
The send buffer size
Value: Positive Integer
SO_TIMEOUT
Syntax:
SO_TIMEOUT=NON_NEGATIVE_INTEGER
Description:
The timeout in milliseconds on waiting for an idle socket
Value: Non-negative Integer
TCP_NODELAY
Syntax:
TCP_NODELAY=true|false
Description:
Disables Nagle's algorithm
Value: java.lang.Boolean
Socket Settings
Syntax:
[SOCKET_SETTING1[,SOCKET_SETTING2[...]]]
Description:
A comma separated list of socket settings.
Element value: Socket Setting
SOCKS5 Address
Syntax:
DOMAINNAME|IPV4_ADDRESS|IPV6_ADDRESS
SOCKS5 Command
Syntax:
CONNECT|BIND|UDP_ASSOCIATE|RESOLVE
Values:
-
CONNECT: A request to the SOCKS server to connect to another server -
BIND: A request to the SOCKS server to bind to another address and port in order to receive an inbound connection -
UDP_ASSOCIATE: A request to the SOCKS server to associate a UDP socket for sending and receiving datagrams -
RESOLVE: A request to the SOCKS server to resolve a host name
SOCKS5 GSS-API Method Protection Level
Syntax:
NONE|REQUIRED_INTEG|REQUIRED_INTEG_AND_CONF
Values:
-
NONE: No protection -
REQUIRED_INTEG: Required per-message integrity -
REQUIRED_INTEG_AND_CONF: Required per-message integrity and confidentiality
SOCKS5 GSS-API Method Protection Levels
Syntax:
SOCKS5_GSSAPIMETHOD_PROTECTION_LEVEL1[,SOCKS5_GSSAPIMETHOD_PROTECTION_LEVEL2[...]]
Element value: SOCKS5 GSS-API Method Protection Level
SOCKS5 Method
Syntax:
NO_AUTHENTICATION_REQUIRED|GSSAPI|USERNAME_PASSWORD
Values:
-
NO_AUTHENTICATION_REQUIRED: No authentication required -
GSSAPI: GSS-API authentication -
USERNAME_PASSWORD: Username password authentication
SOCKS5 Methods
Syntax:
[SOCKS5_METHOD1[,SOCKS5_METHOD2[...]]]
Element value: SOCKS5 Method
SOCKS5 Username Password Method User Repository
Syntax:
TYPE_NAME:INITIALIZATION_STRING
SOCKS5 Username Password Method User Repositories
FileSourceUserRepository
Syntax:
FileSourceUserRepository:FILE
Description:
User repository that handles the storage of the users from a provided file of a list of URL encoded username and hashed password pairs (If the file does not exist, it will be created and used.)
Value: java.io.File
StringSourceUserRepository
Syntax:
StringSourceUserRepository:[USERNAME1:PASSWORD1[,USERNAME2:PASSWORD2[...]]]
Description:
User repository that handles the storage of the users from a provided string of a comma separated list of URL encoded username and password pairs
Value: java.lang.String
SOCKS Server URI
Syntax:
SCHEME://HOST[:PORT]
Unsigned Byte
Syntax:
0-255
Description:
An integer between 0 and 255 (inclusive)