Value Types
Page Contents
- Address Range
- Boolean
- Comma Separated Values
- File
- Firewall Action
- Host
- Host Address Type
- Host Address Types
- Integer
- Log Action
- Network Interface
- Non-negative Integer
- Oid
- Port
- Port Range
- Port Ranges
- Positive Integer
- Rule
- Scheme
- Selection Strategy
- Socket Setting
- Socket Settings
- SOCKS Server URI
- SOCKS5 Address
- SOCKS5 GSS-API Method Protection Level
- SOCKS5 GSS-API Method Protection Levels
- SOCKS5 Method
- SOCKS5 Methods
- SOCKS5 Request Command
- SOCKS5 Username Password Method User Repository
- String
- Unsigned Byte
- User Info
Address Range
Syntax:
ADDRESS|IP_ADDRESS1-IP_ADDRESS2|regex:REGULAR_EXPRESSION
Description:
Class: com.github.jh3nd3rs0n.jargyle.server.AddressRange
Boolean
Syntax:
true|false
Description: A value of either of the following: true or false
Class: java.lang.Boolean
Comma Separated Values
Syntax:
[VALUE1[,VALUE2[...]]]
Description: A comma separated list of values
Element Value Type: String
Class: com.github.jh3nd3rs0n.jargyle.common.string.CommaSeparatedValues
File
Syntax:
ABSOLUTE_OR_RELATIVE_PATH_TO_FILE
Description: An absolute or relative path to a file
Class: java.io.File
Firewall Action
Syntax:
ALLOW|DENY
Description:
Values:
ALLOW:DENY:
Class: com.github.jh3nd3rs0n.jargyle.server.FirewallAction
Host
Syntax:
HOST_NAME|HOST_ADDRESS
Description: A name or address of a node of a network
Class: com.github.jh3nd3rs0n.jargyle.common.net.Host
Host Address Type
Syntax:
HOST_IPV4_ADDRESS|HOST_IPV6_ADDRESS
Description: Type of host address
Values:
HOST_IPV4_ADDRESS: Host IPv4 addressHOST_IPV6_ADDRESS: Host IPv6 address
Class: com.github.jh3nd3rs0n.jargyle.common.net.HostAddressType
Host Address Types
Syntax:
[HOST_ADDRESS_TYPE1[,HOST_ADDRESS_TYPE2[...]]]
Description: A comma separated list of host address types
Element Value Type: Host Address Type
Class: com.github.jh3nd3rs0n.jargyle.common.net.HostAddressTypes
Integer
Syntax:
-2147483648-2147483647
Description: An integer between -2147483648 and 2147483647 (inclusive)
Class: java.lang.Integer
Log Action
Syntax:
LOG_AS_WARNING|LOG_AS_INFO
Description:
Values:
LOG_AS_WARNING: Log message as a warning messageLOG_AS_INFO: Log message as an informational message
Class: com.github.jh3nd3rs0n.jargyle.server.LogAction
Network Interface
Syntax:
NETWORK_INTERFACE_NAME
Description: A name of an interface between the local system and a network (for example, “le0”)
Class: com.github.jh3nd3rs0n.jargyle.common.net.NetInterface
Non-negative Integer
Syntax:
0-2147483647
Description: An integer between 0 and 2147483647 (inclusive)
Class: com.github.jh3nd3rs0n.jargyle.common.number.NonNegativeInteger
Oid
Syntax:
Please see the Javadocs for the following member(s) for the possible syntax for the String parameter:
public org.ietf.jgss.Oid(java.lang.String) throws org.ietf.jgss.GSSException
Description: Please see the Javadocs for the following class for its description: org.ietf.jgss.Oid
Class: org.ietf.jgss.Oid
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 node of a network
Class: com.github.jh3nd3rs0n.jargyle.common.net.Port
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 Type: Port
Class: com.github.jh3nd3rs0n.jargyle.common.net.PortRange
Port Ranges
Syntax:
[PORT_RANGE1[,PORT_RANGE2[...]]]
Description: A comma separated list of port ranges.
Element Value Type: Port Range
Class: com.github.jh3nd3rs0n.jargyle.common.net.PortRanges
Positive Integer
Syntax:
1-2147483647
Description: An integer between 1 and 2147483647 (inclusive)
Class: com.github.jh3nd3rs0n.jargyle.common.number.PositiveInteger
Rule
Syntax:
[RULE_CONDITION1,[RULE_CONDITION2,[...]]]RULE_ACTION1[,RULE_ACTION2[...]]
Description:
Class: com.github.jh3nd3rs0n.jargyle.server.Rule
Scheme
Syntax:
socks5
Description: Specifies what SOCKS protocol is to be used to access the SOCKS server
Values:
socks5: SOCKS protocol version 5
Class: com.github.jh3nd3rs0n.jargyle.client.Scheme
Selection Strategy
Syntax:
CYCLICAL|RANDOM
Description:
Class: com.github.jh3nd3rs0n.jargyle.server.SelectionStrategy
Selection Strategies
Description:
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
Class: com.github.jh3nd3rs0n.jargyle.common.net.SocketSetting
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 Type: Unsigned Byte
SO_BROADCAST
Syntax:
SO_BROADCAST=true|false
Description: Can send broadcast datagrams
Value Type: Boolean
SO_KEEPALIVE
Syntax:
SO_KEEPALIVE=true|false
Description: Keeps a TCP socket alive when no data has been exchanged in either direction
Value Type: Boolean
SO_LINGER
Syntax:
SO_LINGER=-2147483648-2147483647
Description: Linger on closing the TCP socket in seconds (disabled if the number of seconds is negative)
Value Type: Integer
SO_RCVBUF
Syntax:
SO_RCVBUF=POSITIVE_INTEGER
Description: The receive buffer size
Value Type: Positive Integer
SO_REUSEADDR
Syntax:
SO_REUSEADDR=true|false
Description: Can reuse socket address and port
Value Type: Boolean
SO_SNDBUF
Syntax:
SO_SNDBUF=POSITIVE_INTEGER
Description: The send buffer size
Value Type: Positive Integer
SO_TIMEOUT
Syntax:
SO_TIMEOUT=NON_NEGATIVE_INTEGER
Description: The timeout in milliseconds on waiting for an idle socket
Value Type: Non-negative Integer
TCP_NODELAY
Syntax:
TCP_NODELAY=true|false
Description: Disables Nagle's algorithm
Value Type: Boolean
Socket Settings
Syntax:
[SOCKET_SETTING1[,SOCKET_SETTING2[...]]]
Description: A comma separated list of socket settings.
Element Value Type: Socket Setting
Class: com.github.jh3nd3rs0n.jargyle.common.net.SocketSettings
SOCKS Server URI
Syntax:
SCHEME://[USER_INFO@]HOST[:PORT]
Description: The URI of the SOCKS server
Class: com.github.jh3nd3rs0n.jargyle.client.SocksServerUri
SOCKS5 Address
Syntax:
DOMAIN_NAME|IPV4_ADDRESS|IPV6_ADDRESS
Description: An identifier or a virtual location of a node of a network
Class: com.github.jh3nd3rs0n.jargyle.protocolbase.socks5.Address
SOCKS5 GSS-API Method Protection Level
Syntax:
NONE|REQUIRED_INTEG|REQUIRED_INTEG_AND_CONF|SELECTIVE_INTEG_OR_CONF
Description: Security context protection level
Values:
NONE: No per-message protectionREQUIRED_INTEG: Required per-message integrityREQUIRED_INTEG_AND_CONF: Required per-message integrity and confidentialitySELECTIVE_INTEG_OR_CONF: Selective per-message integrity or confidentiality based on local client and server configurations
Class: com.github.jh3nd3rs0n.jargyle.protocolbase.socks5.gssapimethod.ProtectionLevel
SOCKS5 GSS-API Method Protection Levels
Syntax:
SOCKS5_GSSAPIMETHOD_PROTECTION_LEVEL1[,SOCKS5_GSSAPIMETHOD_PROTECTION_LEVEL2[...]]
Description: A comma separated list of security context protection levels
Element Value Type: SOCKS5 GSS-API Method Protection Level
Class: com.github.jh3nd3rs0n.jargyle.protocolbase.socks5.gssapimethod.ProtectionLevels
SOCKS5 Method
Syntax:
NO_AUTHENTICATION_REQUIRED|GSSAPI|USERNAME_PASSWORD
Description: Authentication method
Values:
NO_AUTHENTICATION_REQUIRED: No authentication requiredGSSAPI: GSS-API authenticationUSERNAME_PASSWORD: Username password authentication
Class: com.github.jh3nd3rs0n.jargyle.protocolbase.socks5.Method
SOCKS5 Methods
Syntax:
[SOCKS5_METHOD1[,SOCKS5_METHOD2[...]]]
Description: A comma-separated list of SOCKS5 authentication methods
Element Value Type: SOCKS5 Method
Class: com.github.jh3nd3rs0n.jargyle.protocolbase.socks5.Methods
SOCKS5 Request Command
Syntax:
CONNECT|BIND|UDP_ASSOCIATE|RESOLVE
Description: Type of request to the SOCKS server
Values:
CONNECT: A request to the SOCKS server to connect to another serverBIND: A request to the SOCKS server to bind to another address and port in order to receive an inbound connectionUDP_ASSOCIATE: A request to the SOCKS server to establish an association within the UDP relay process to handle UDP datagramsRESOLVE: A request to the SOCKS server to resolve a host name
Class: com.github.jh3nd3rs0n.jargyle.protocolbase.socks5.Command
SOCKS5 Username Password Method User Repository
Syntax:
TYPE_NAME:INITIALIZATION_STRING
Description:
Class: com.github.jh3nd3rs0n.jargyle.server.socks5.userpassmethod.UserRepository
SOCKS5 Username Password Method User Repositories
Description:
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 Type: 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 Type: String
String
Syntax:
[CHARACTER1[CHARACTER2[...]]]
Description: A list of characters
Class: java.lang.String
Unsigned Byte
Syntax:
0-255
Description: An integer between 0 and 255 (inclusive)
Class: com.github.jh3nd3rs0n.jargyle.common.number.UnsignedByte
User Info
Syntax:
(See https://www.ietf.org/rfc/rfc2396.txt 3.2.2. Server-based Naming Authority)
Description: Specifies the user information to be used to access the SOCKS server
Class: com.github.jh3nd3rs0n.jargyle.client.UserInfo