Manual - Section 5: socks.conf

NAME

socks.conf - socks client configuration file syntax

DESCRIPTION

The configuration file for the socks client library allow control over logging and server selection. It is divided into two parts, miscellaneous settings and routes. A line can be commented using the standard comment character #.

FORMAT

The miscellaneous settings have a keyword followed by a colon and the value.

debug Setting this field to 1 turns on debugging.

logoutput

This value controls where the sends logoutput. It can be either syslog, stdout, stderr, a filename, or a combination.

resolveprotocol The protocol used to resolve hostnames. Valid values are udp (default), tcp and fake.

ROUTES

The routes are specified with a route keyword. Inside a pair of parens ({}) a set of keywords control the behavior of the route. Each route can contain three address specifications; from, to and via. A route is selected for a connection based on the values within the route block. The route block can contain the following:

ADDRESSES

Each address field can consist of a ipaddress (and where meaningful, a netmask, separated from the ipaddress by a ’/’ sign.), a hostname, or a domainname (designated by the leading ’.’). Each address can be followed by a optional port specifier.

from The route is used only by requests coming from the address given as value.

to The route is used only by requests going to the address given as value.

via Address of socks server to be used for the connection.

port Parameter to from, to and via. Accepts the keywords eq/=, neq/!=, ge/>=, le/<=, gt/>, lt/< followed by a number. A portrange can also be given as "port <start #> - <end #>", which will match all port numbers within the range <start #> and <end #>.

command The server supports the given commands. Valid commands are bind, bindreply, connect, udpassociate and udpreply. and udpreply. Can be used instead of, or to complement, protocol.

method List of authentication methods the client supports and which to offer the server. Currently supported values are none and username.

protocol The protocols the server supports. Supported values are tcp and udp.

proxyprotocol The proxy protocols the server supports. Currently supported values are socks_v4, socks_v5, and http_v1.0.

EXAMPLES

See the example directory in the distribution.

ENVIRONMENT

SOCKS_USERNAME

Use SOCKS_USERNAME as the username when doing username authentication.

SOCKS_PASSWORD

Use SOCKS_PASSWORD as the password when doing username authentication. Not recommended as other users on the system might be able to see your password.

FILES

/etc/socks.conf

AUTHORS

For Inferno Nettverk A/S, Norway: Michael Shuldman <michaels@inet.no>: Design and implementation. Karl-Andre’ Skevik <karls@inet.no>: Autoconf and porting.

BUGS

See the accompanying BUGS file. New ones should be reported to dante-bugs@inet.no.