NAME

TS-Warp INI-like configuration file format

DESCRIPTION

ts-warp uses INI-like configuration files to identify SOCKS servers for destinations that clients are willing to reach. The format of ts-warp INI-files are almost dentical to the classical INI dialect, with the only main exception, that duplicate names for keys are alloved within the same section.

Each section, a string, enclosed in square brackets ('[', ']'), specifies a name for a SOCKS server block. A section consists of keys (variables) describing SOCKS server attributes, as well, as keys specifying destination targets.

Remarks are specified with: ; and # characters

Key names are case insensitive i.e., target_host is the same as tArGeT_HoSt

SOCKS server keys

socks_server = <IP | Hostname>[:port]

Manadatory variable, specifying a SOCKS server for the section. Optional port number defaults to 1080.

socks_chain = SECTION_1, SECTION_N

Defines a chain of sections with SOCKS servers, that are required to reach first before contacting the server in the current section. Optional variable.

socks_version = 5 | 4

Specifies the server SOCKS version. Optional, defaults to 5.

socks_user = username

A username if the server requires authentication. Only plaintext authentication is supported.

socks_password = plain:PlaintextPassword | tsw01:HEXADECIMALHASH

A user password if the SOCKS-server requires authentication. Can be specified as plaintext if preceded with plain: prefix or encoded by ts-pass(8) with TS-Warp obfuscation algorithm if the tsw01: prefix is set.

Target keys

target_host = <IP | Hostname>:[port_1[-port_n]]

Describes a single target host either with it's IP address or resolveable host name. Optionally a port or a port range can be specified to narrow the band.

target_domain = example.org:[port_1[-port_n]]

Specifies the name of a domain resolveable via DNS. Optionally a port or a port range can be specified to narrow the band.

target_network = IP[:port_1[-port_n]]/Netmask

Specifies an IPv4 or IPv6 subnet. Netmasks are accepted only in dot-decimal notation. Optionally a port or a port range can be specified to narrow the band.

target_range = IP_1[:port_1[-port_n]]/IP_n

Specifies a range of sequential IPv4, IPv6 addresses. Optionally a port or a port range can be specified to narrow the band.

EXAMPLES

[HOME NETWORK]                          ; Section definition
# Target definitions:
; target_host = 192.168.1.1
; target_host = Anvil
; target_network = 192.168.1.0/255.255.255.0
; target_network = 192.168.1.0/24
; target_range = 192.168.1.1/192.168.1.20
target_domain = balmora.lan
# Server definitions:
socks_server = 192.168.1.237
; socks_version = 5
socks_user = socks
; socks_password = plain:TopSecretPass@34
socks_password = tsw01:08415D5F6519633F1D150E08552837506D12383C177C176F7C322E1F562D

SEE ALSO

ts-warp(8), ts-warp.sh(1), ts-pass(1), gui-warp(1)