1TORSOCKS.CONF(5) TORSOCKS.CONF(5)
2
6 torsocks.conf — Configuration file for torsocks(8)
7
10 By default, torsocks will assume that it should connect to the Tor
11 SOCKS proxy running at 127.0.0.1 on port 9050. This is the default
12 address and port for Tor's socks server on most installations. If you
13 are running a normal Tor installation and have no special requirements,
14 then you should not need to create, edit or invoke a configuration file
15 when using torsocks.
16 Your installation of torsocks includes a default configuration file
18 that contains values sensible for use with most Tor installations. The
19 installation location for your default configuration file is:
20 /etc/tor/torsocks.conf
22 In order to use a configuration file, you must set the environment
24 variable TORSOCKS_CONF_FILE with the location of the file.
25 If TORSOCKS_CONF_FILE is not set, torsocks will attempt to read the
27 configuration file at /etc/tor/torsocks.conf. If that file cannot be
28 read, torsocks will use sensible defaults for most Tor installations,
29 i.e. it will assume that you want to use a SOCKS proxy running at
30 127.0.0.1 (localhost) on port 9050.
31
34 SYNTAX
35 The basic structure of all lines in the configuration file is:
36 <directive> <parameters>
38 Empty lines are ignored and all input on a line after a '#' character
40 is ignored.
41 DIRECTIVES
44 The following directives are used in the torsocks configuration file:
45 TorAddress ip_addr
48 The IP address of the Tor SOCKS server (e.g "server =
49 10.1.4.253"). Only one server may be specified. Currently, tor‐
50 socks does NOT support hostname. (default: 127.0.0.1)
51 TorPort port
54 The port on which the Tor SOCKS server receives requests.
55 (default: 9050)
56 OnionAddrRange subnet/mask
59 Tor hidden sites do not have real IP addresses. This specifies
60 what range of IP addresses will be handed to the application as
61 "cookies" for .onion names. Of course, you should pick a block
62 of addresses which you aren't going to ever need to actually
63 connect to. This is similar to the MapAddress feature of the
64 main tor daemon. (default: 127.42.42.0/24)
65 SOCKS5Username username
68 Username to use for SOCKS5 authentication method that makes the
69 connections to Tor to use a different circuit from other exist‐
70 ing streams. If set, the SOCKS5Password must be specified also.
71 (Default: none).
72 SOCKS5Password password
75 Password to use for SOCKS5 authentication method that makes the
76 connections to Tor to use a different circuit from other exist‐
77 ing streams. If set, the SOCKS5Username must be specified also.
78 (Default: none).
79 AllowInbound 0|1
82 Allow inbound connections meaning that listen() and
83 accept()/accept4() will be allowed for non localhost address so
84 the applicaton can handle incoming connection. Note that Unix
85 socket are allowed. (Default: 0)
86 AllowOutboundLocalhost 0|1|2
89 Allow outbound connections to the loopback interface meaning
90 that connect() will be allowed to connect to localhost addresses
91 bypassing Tor. If set to 1, TCP connections will be allowed.
92 If set to 2, both TCP/IP and UDP connections will be allowed.
93 This option should not be used by most users. (Default: 0)
94 IsolatePID 0|1
97 Set Torsocks to use an automatically generated SOCKS5 user‐
98 name/password based on the process ID and current time, that
99 makes the connections to Tor use a different circuit from other
100 existing streams in Tor on a per-process basis. If set, the
101 SOCKS5Username and SOCKS5Password options must not be set.
102 (Default: 0)
103
106 $ export TORSOCKS_CONF_FILE=$PWD/torsocks.conf
107 $ torsocks ssh account@sshserver.com
108
111 torsocks(1), torsocks(8),
112
115 David Goulet <dgoulet@ev0ke.net>
116 August 24th, 2013 TORSOCKS.CONF(5)