tor.1.in 40.3 KB
Newer Older
1
.TH TOR 1 "January 2006" "TOR"
Roger Dingledine's avatar
Roger Dingledine committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
.SH NAME
tor \- The second-generation onion router
.SH SYNOPSIS
.B tor
[\fIOPTION value\fR]...
.SH DESCRIPTION
.I tor
is a connection-oriented anonymizing communication
service. Users choose a source-routed path through a set of nodes, and
negotiate a "virtual circuit" through the network, in which each node
knows its predecessor and successor, but no others. Traffic flowing down
the circuit is unwrapped by a symmetric key at each node, which reveals
the downstream node.
.PP
Basically \fItor\fR provides a distributed network of servers ("onion
Roger Dingledine's avatar
Roger Dingledine committed
17
routers"). Users bounce their TCP streams -- web traffic, ftp, ssh, etc --
Roger Dingledine's avatar
Roger Dingledine committed
18
19
20
21
22
around the routers, and recipients, observers, and even the routers
themselves have difficulty tracking the source of the stream.
.SH OPTIONS
\fB-h, -help\fP
Display a short help message and exit.
23
.LP
Roger Dingledine's avatar
Roger Dingledine committed
24
25
26
.TP
\fB-f \fR\fIFILE\fP
FILE contains further "option value" pairs. (Default: @CONFDIR@/torrc)
27
.LP
Roger Dingledine's avatar
Roger Dingledine committed
28
.TP
Roger Dingledine's avatar
Roger Dingledine committed
29
Other options can be specified either on the command-line (\fI--option
30
31
value\fR), or in the configuration file (\fIoption value\fR).
Options are case-insensitive.
32
.LP
33
.TP
34
35
\fBBandwidthRate \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
A token bucket limits the average incoming bandwidth on this node to
36
the specified number of bytes per second. (Default: 3 MB)
37
.LP
38
.TP
39
\fBBandwidthBurst \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
40
41
Limit the maximum token bucket size (also known as the burst) to the
given number of bytes. (Default: 6 MB)
42
.LP
43
.TP
44
\fBMaxAdvertisedBandwidth \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
45
46
47
48
49
If set, we will not advertise more than this amount of bandwidth for our
BandwidthRate. Server operators who want to reduce the number of clients
who ask to build circuits through them (since this is proportional to
advertised bandwidth rate) can thus reduce the CPU demands on their
server without impacting network performance.
50
.LP
51
.TP
52
53
54
55
56
57
58
59
\fBConnLimit \fR\fINUM\fP
The minimum number of file descriptors that must be available to
the Tor process before it will start. Tor will ask the OS for as
many file descriptors as the OS will allow (you can find this
by "ulimit -H -n"). If this number is less than ConnLimit, then
Tor will refuse to start.

You probably don't need to adjust this. It has no effect on
60
Windows since that platform lacks getrlimit(). (Default: 1000)
61
62
.LP
.TP
63
\fBControlPort \fR\fIPort\fP
64
If set, Tor will accept connections on
65
66
67
68
69
this port, and allow those connections to control the Tor process using the
Tor Control Protocol (described in control-spec.txt).  Note: unless you also
specify one of \fBHashedControlPassword\fP or \fBCookieAuthentication\fP,
setting this option will cause Tor to allow any process on the local host to
control it.
70
.LP
71
.TP
72
73
74
75
76
77
\fBControlListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
Bind the controller listener to this address. If you specify a port,
bind to this port rather than the one specified in ControlPort. We
strongly recommend that you leave this alone unless you know what you're
doing, since giving attackers access to your control listener is really
dangerous. (Default: 127.0.0.1)
78
79
This directive can be specified multiple times to bind to multiple
addresses/ports.
80
81
.LP
.TP
82
83
84
85
86
\fBHashedControlPassword \fR\fIhashed_password\fP
Don't allow any connections on the control port except when the other process
knows the password whose one-way hash is \fIhashed_password\fP.  You can
compute the hash of a password by running "tor --hash-password
\fIpassword\fP".
87
.LP
88
89
90
91
92
93
94
.TP
\fBCookieAuthentication \fR\fB0\fR|\fB1\fP
If this option is set to 1, don't allow any connections on the control port
except when the connecting process knows the contents of a file named
"control_auth_cookie", which Tor will create in its data directory.  This
authentication methods should only be used on systems with good filesystem
security. (Default: 0)
95
.LP
96
.TP
97
98
\fBDataDirectory \fR\fIDIR\fP
Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
99
.LP
100
.TP
101
\fBDirServer \fR[\fInickname\fR] [\fBflags\fR] \fIaddress\fR\fB:\fIport fingerprint\fP
Nick Mathewson's avatar
Nick Mathewson committed
102
103
104
Use a nonstandard authoritative directory server at the provided
address and port, with the specified key fingerprint.  This option can
be repeated many times, for multiple authoritative directory
105
106
107
servers.  Flags are separated by spaces, and determine what kind of an
authority this directory is.  By default, every authority is authoritative
for current ("v2")-style directories, unless the "no-v2" flag is given.  If the "v1" flags is provided, Tor will use this server as an
108
authority for old-style (v1) directories as well.  (Only directory mirrors
109
110
care about this.)  Tor will use this server as an authority for hidden
service information if the "hs" flag is set, or if the "v1" flag is set and
111
112
113
the "no-hs" flag is \fBnot\fP set.  If a flag "orport=\fBport\fR" is given,
Tor will consider use the given port to open encrypted tunnels to the
dirserver.
114
115
If no \fBdirserver\fP line is given, Tor will use the default
directory servers.  NOTE: this option is intended
116
117
118
for setting up a private Tor network with its own directory authorities.  If
you use it, you will be distinguishable from other users, because you won't
believe the same authorities they do.
119
.LP
Nick Mathewson's avatar
Nick Mathewson committed
120
.TP
121
122
123
124
125
126
127
128
129
130
131
132
133
134
\fBFetchHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
If set to 0, Tor will never fetch any hidden service descriptors from
the rendezvous directories. This option is only useful if you're using
a Tor controller that handles hidserv fetches for you.
(Default: 1)
.LP
.TP
\fBFetchServerDescriptors \fR\fB0\fR|\fB1\fR\fP
If set to 0, Tor will never fetch any network status summaries or server
descriptors from the directory servers. This option is only useful if
you're using a Tor controller that handles directory fetches for you.
(Default: 1)
.LP
.TP
135
136
137
138
139
140
141
142
143
\fBFetchUselessDescriptors \fR\fB0\fR|\fB1\fR\fP
If set to 1, Tor will fetch every non-obsolete descriptor from the
authorities that it hears about. Otherwise, it will avoid fetching
useless descriptors, for example for routers that are not running.
This option is useful if you're using the contributed "exitlist"
script to enumerate Tor nodes that exit to certain addresses.
(Default: 0)
.LP
.TP
144
\fBGroup \fR\fIGID\fP
145
On startup, setgid to this group.
146
.LP
Roger Dingledine's avatar
Roger Dingledine committed
147
.TP
148
\fBHttpProxy\fR \fIhost\fR[:\fIport\fR]\fP
149
150
Tor will make all its directory requests through this host:port
(or host:80 if port is not specified),
151
rather than connecting directly to any directory servers.
152
.LP
153
.TP
154
155
156
157
158
\fBHttpProxyAuthenticator\fR \fIusername:password\fP
If defined, Tor will use this username:password for Basic Http proxy
authentication, as in RFC 2617. This is currently the only form of
Http proxy authentication that Tor supports; feel free to submit a
patch if you want it to support others.
159
.LP
160
.TP
161
\fBHttpsProxy\fR \fIhost\fR[:\fIport\fR]\fP
162
163
164
165
166
Tor will make all its OR (SSL) connections through this host:port
(or host:443 if port is not specified), via HTTP CONNECT rather than
connecting directly to servers.  You may want to set \fBFascistFirewall\fR
to restrict the set of ports you might try to connect to, if your Https
proxy only allows connecting to certain ports.
167
.LP
168
.TP
169
170
171
172
\fBHttpsProxyAuthenticator\fR \fIusername:password\fP
If defined, Tor will use this username:password for Basic Https proxy
authentication, as in RFC 2617. This is currently the only form of
Https proxy authentication that Tor supports; feel free to submit a
173
patch if you want it to support others.
174
.LP
175
.TP
176
\fBKeepalivePeriod \fR\fINUM\fP
177
To keep firewalls from expiring connections, send a padding keepalive
178
179
180
cell every NUM seconds on open connections that are in use. If the
connection has no open circuits, it will instead be closed after NUM
seconds of idleness. (Default: 5 minutes)
181
.LP
Roger Dingledine's avatar
Roger Dingledine committed
182
.TP
183
184
185
186
\fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBstderr\fR|\fBstdout\fR|\fBsyslog\fR\fP
Send all messages between \fIminSeverity\fR and \fImaxSeverity\fR to
the standard output stream, the standard error stream, or to the system
log. (The "syslog" value is only supported on Unix.)  Recognized
187
188
189
severity levels are debug, info, notice, warn, and err.  We advise using
"notice" in most cases, since anything more verbose may provide sensitive
information to an attacker who obtains the logs.  If only one
190
191
severity level is given, all messages of that level or higher will be
sent to the listed destination.
192
.LP
193
194
195
196
197
.TP
\fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBfile\fR \fIFILENAME\fP
As above, but send log messages to the listed filename.  The "Log"
option may appear more than once in a configuration file.  Messages
are sent to all the logs that match their severity level.
198
.LP
199
.TP
200
\fBOutboundBindAddress \fR\fIIP\fP
201
202
203
Make all outbound connections originate from the IP address specified.  This
is only useful when you have multiple network interfaces, and you want all
of Tor's outgoing connections to use a single one.
204
.LP
205
.TP
Thomas Sjögren's avatar
Thomas Sjögren committed
206
\fBPidFile \fR\fIFILE\fP
Roger Dingledine's avatar
Roger Dingledine committed
207
On startup, write our PID to FILE. On clean shutdown, remove FILE.
208
.LP
Roger Dingledine's avatar
Roger Dingledine committed
209
.TP
210
211
212
213
214
215
\fBProtocolWarnings \fR\fB0\fR|\fB1\fR\fP
If 1, Tor will log with severity 'warn' various cases of other parties
not following the Tor specification. Otherwise, they are logged with
severity 'info'. (Default: 0)
.LP
.TP
216
\fBRunAsDaemon \fR\fB0\fR|\fB1\fR\fP
217
218
219
If 1, Tor forks and daemonizes to the background. This option has
no effect on Windows; instead you should use the --service command-line
option. (Default: 0)
220
.LP
Roger Dingledine's avatar
Roger Dingledine committed
221
.TP
222
223
224
225
226
\fBSafeLogging \fR\fB0\fR|\fB1\fP
If 1, Tor replaces potentially sensitive strings in the logs
(e.g. addresses) with the string [scrubbed]. This way logs can still be
useful, but they don't leave behind personally identifying information
about what sites a user might have visited. (Default: 1)
227
.LP
228
.TP
229
230
\fBUser \fR\fIUID\fP
On startup, setuid to this user.
231
.LP
232
.TP
233
\fBHardwareAccel \fR\fB0\fR|\fB1\fP
234
If non-zero, try to use crypto hardware acceleration when
235
available. This is untested and probably buggy. (Default: 0)
236
237
238
239
240
241
242
243
244
245
246
247
.LP
.TP
\fBAvoidDiskWrites \fR\fB0|\fR\fB1\fP
If non-zero, try to write to disk less frequently than we would otherwise.
This is useful when running on flash memory or other media that support only
a limited number of writes.  (Default: 0)
.LP
.TP
\fBTunnelDirConns \fR\fB0|\fR\fB1\fP
If non-zero, try to have all directory info downloaded with encrypted
connections.  (Default: 1)

Roger Dingledine's avatar
Roger Dingledine committed
248
249
250

.SH CLIENT OPTIONS
.PP
251
The following options are useful only for clients (that is, if \fBSocksPort\fP is non-zero):
252
.LP
Roger Dingledine's avatar
Roger Dingledine committed
253
.TP
254
\fBAllowInvalidNodes\fR \fBentry\fR|\fBexit\fR|\fBmiddle\fR|\fBintroduction\fR|\fBrendezvous\fR|...\fP
255
If some Tor servers are obviously not working right, the directory
256
authorities can manually mark them as invalid, meaning that it's not
257
258
259
recommended you use them for entry or exit positions in your circuits. You
can opt to use them in some circuit positions, though. The default is
"middle,rendezvous", and other choices are not advised.
260
.LP
261
.TP
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
\fBCircuitBuildTimeout \fR\fINUM\fP
Try for at most NUM seconds when building circuits. If the circuit
isn't open in that time, give up on it.
(Default: 1 minute.)
.LP
.TP
\fBCircuitIdleTimeout \fR\fINUM\fP
If we have keept a clean (never used) circuit around for NUM seconds,
then close it. This way when the Tor client is entirely idle, it can
expire all of its circuits, and then expire its TLS connections. Also,
if we end up making a circuit that is not useful for exiting any of
the requests we're receiving, it won't forever take up a slot in the
circuit list.
(Default: 1 hour.)
.LP
.TP
278
\fBClientOnly \fR\fB0\fR|\fB1\fR\fP
Thomas Sjögren's avatar
Thomas Sjögren committed
279
If set to 1, Tor will under no circumstances run as a server. The default
Roger Dingledine's avatar
Roger Dingledine committed
280
is to run as a client unless ORPort is configured.  (Usually,
Nick Mathewson's avatar
Nick Mathewson committed
281
you don't need to set this; Tor is pretty smart at figuring out whether
Roger Dingledine's avatar
Roger Dingledine committed
282
you are reliable and high-bandwidth enough to be a useful server.)
283
(Default: 0)
284
.LP
Nick Mathewson's avatar
Nick Mathewson committed
285
.TP
286
287
288
289
\fBExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
A list of nodes to never use when building a circuit.
.LP
.TP
290
\fBEntryNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
291
292
293
A list of preferred nodes to use for the first hop in the circuit.
These are treated only as preferences unless StrictEntryNodes (see
below) is also set.
294
.LP
295
.TP
296
\fBExitNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
297
298
299
A list of preferred nodes to use for the last hop in the circuit.
These are treated only as preferences unless StrictExitNodes (see
below) is also set.
300
.LP
301
.TP
302
303
304
\fBStrictEntryNodes \fR\fB0\fR|\fB1\fR\fP
If 1, Tor will never use any nodes besides those listed in "EntryNodes" for
the first hop of a circuit.
305
.LP
306
.TP
307
\fBStrictExitNodes \fR\fB0\fR|\fB1\fR\fP
308
If 1, Tor will never use any nodes besides those listed in "ExitNodes" for
309
the last hop of a circuit.
310
.LP
311
.TP
312
\fBFascistFirewall \fR\fB0\fR|\fB1\fR\fP
313
If 1, Tor will only create outgoing connections to ORs running on ports that
314
your firewall allows (defaults to 80 and 443; see \fBFirewallPorts\fR).  This will
315
allow you to run Tor as a client behind a firewall with restrictive policies,
Roger Dingledine's avatar
Roger Dingledine committed
316
but will not allow you to run as a server behind such a firewall.
317
318
This option is deprecated; use
ReachableAddresses instead.
319
.LP
320
.TP
321
\fBFirewallPorts \fR\fIPORTS\fP
322
323
324
325
326
A list of ports that your firewall allows you to connect to.  Only
used when \fBFascistFirewall\fR is set. This option is deprecated; use
ReachableAddresses instead. (Default: 80, 443)
.LP
.TP
Thomas Sjögren's avatar
Thomas Sjögren committed
327
\fBReachableAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
328
A comma-separated list of IP addresses and ports that your firewall allows you
329
to connect to. The format is as
330
for the addresses in ExitPolicy, except that "accept" is understood
331
unless "reject" is explicitly provided.  For example, 'ReachableAddresses
332
333
334
335
99.0.0.0/8, reject 18.0.0.0/8:80, accept *:80' means that your
firewall allows connections to everything inside net 99, rejects port
80 connections to net 18, and accepts connections to port 80 otherwise.
(Default: 'accept *:*'.)
336
337
.LP
.TP
338
339
340
\fBReachableDirAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
Like \fBReachableAddresses\fP, a list of addresses and ports.  Tor will obey
these restrictions when fetching directory information, using standard HTTP
341
GET requests. If not set explicitly then the value of \fBReachableAddresses\fP
342
343
344
345
346
347
348
is used.  If \fBHttpProxy\fR is set then these connections will go through that
proxy.
.LP
.TP
\fBReachableORAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
Like \fBReachableAddresses\fP, a list of addresses and ports.  Tor will obey
these restrictions when connecting to Onion Routers, using TLS/SSL.  If not set
349
explicitly then the value of \fBReachableAddresses\fP is used. If
350
351
352
353
354
355
356
357
358
359
\fBHttpsProxy\fR is set then these connections will go through that proxy.

The separation between \fBReachableORAddresses\fP and
\fBReachableDirAddresses\fP is only interesting when you are connecting through
proxies (see \fBHttpProxy\fR and \fBHttpsProxy\fR).  Most proxies limit TLS
connections (which Tor uses to connect to Onion Routers) to port 443, and some
limit HTTP GET requests (which Tor uses for fetching directory information) to
port 80.
.LP
.TP
360
361
362
363
\fBLongLivedPorts \fR\fIPORTS\fP
A list of ports for services that tend to have long-running connections
(e.g. chat and interactive shells). Circuits for streams that use these
ports will contain only high-uptime nodes, to reduce the chance that a
364
node will go down before the stream is finished.
365
(Default: 21, 22, 706, 1863, 5050, 5190, 5222, 5223, 6667, 6697, 8300)
366
.LP
367
.TP
368
\fBMapAddress\fR \fIaddress\fR \fInewaddress\fR
369
370
371
372
When a request for address arrives to Tor, it will rewrite it to
newaddress before processing it. For example, if you always want
connections to www.indymedia.org to exit via \fItorserver\fR (where
\fItorserver\fR is the nickname of the server),
373
use "MapAddress www.indymedia.org www.indymedia.org.torserver.exit".
374
.LP
375
.TP
376
\fBNewCircuitPeriod \fR\fINUM\fP
377
Every NUM seconds consider whether to build a new circuit. (Default: 30 seconds)
378
.LP
Roger Dingledine's avatar
Roger Dingledine committed
379
.TP
380
\fBMaxCircuitDirtiness \fR\fINUM\fP
381
382
383
Feel free to reuse a circuit that was first used at most NUM seconds ago,
but never attach a new stream to a circuit that is too old.
(Default: 10 minutes)
384
.LP
385
.TP
386
\fBNodeFamily \fR\fInickname\fR,\fInickname\fR,\fI...\fP
Roger Dingledine's avatar
Roger Dingledine committed
387
The named Tor servers constitute a "family" of similar or co-administered
388
389
390
servers, so never use any two of them in the same circuit. Defining a
NodeFamily is only needed when a server doesn't list the family itself
(with MyFamily). This option can be used multiple times.
391
.LP
Nick Mathewson's avatar
Nick Mathewson committed
392
.TP
393
\fBEnforceDistinctSubnets \fR\fB0\fR|\fB1\fR\fP
Roger Dingledine's avatar
Roger Dingledine committed
394
395
If 1, Tor will not put two servers whose IP addresses are "too
close" on the same circuit.  Currently, two addresses are
396
397
"too close" if they lie in the same /16 range. (Default: 1)

398
.\" \fBPathlenCoinWeight \fR\fI0.0-1.0\fP
399
.\" Paths are 3 hops plus a geometric distribution centered around this coinweight.
400
.\" Must be >=0.0 and <1.0. (Default: 0.3) NOT USED CURRENTLY
401
.\" .TP
402
403
.LP
.TP
404
\fBRendNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
405
A list of preferred nodes to use for the rendezvous point, if possible.
406
.LP
407
.TP
408
\fBRendExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
409
A list of nodes to never use when choosing a rendezvous point.
410
.LP
411
.TP
412
413
\fBSocksPort \fR\fIPORT\fP
Advertise this port to listen for connections from Socks-speaking
414
415
applications.  Set this to 0 if you don't want to allow application
connections. (Default: 9050)
416
.LP
Roger Dingledine's avatar
Roger Dingledine committed
417
.TP
418
419
\fBSocksListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
Bind to this address to listen for connections from Socks-speaking
420
applications. (Default: 127.0.0.1) You can also specify a port
421
422
423
(e.g. 192.168.0.1:9100).
This directive can be specified multiple times to bind to multiple
addresses/ports.
424
.LP
425
.TP
426
427
428
\fBSocksPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
Set an entrance policy for this server, to limit who can connect to the
Socks ports.
429
The policies have the same form as exit policies below.
430
.LP
431
.TP
432
433
434
435
436
\fBSocksTimeout \fR\fINUM\fP
Let a socks connection wait NUM seconds unattached before we fail it.
(Default: 2 minutes.)
.LP
.TP
Roger Dingledine's avatar
Roger Dingledine committed
437
438
439
440
441
\fBTestVia \fR\fInickname\fR,\fInickname\fR,\fI...\fP
A list of nodes to prefer for your middle hop when building testing
circuits. This option is mainly for debugging reachability problems.
.LP
.TP
442
\fBTrackHostExits \fR\fIhost\fR,\fI.domain\fR,\fI...\fR\fP
443
444
445
446
447
448
449
450
451
452
For each value in the comma separated list, Tor will track recent connections
to hosts that match this value and attempt to
reuse the same exit node for each. If the value is prepended with a '.', it is
treated as matching an entire domain. If one of the values is just a '.', it
means match everything. This option is useful if you frequently connect to
sites that will expire all your authentication cookies (ie log you out) if
your IP address changes. Note that this option does have the disadvantage of
making it more clear that a given history is
associated with a single user. However, most people who would wish to observe
this will observe it through cookies or other protocol-specific means anyhow.
453
.LP
454
455
456
.TP
\fBTrackHostExitsExpire \fR\fINUM\fP
Since exit servers go up and down, it is desirable to expire the association
457
between host and exit server after NUM seconds. The default
458
is 1800 seconds (30 minutes).
Nick Mathewson's avatar
Nick Mathewson committed
459
460
.LP
.TP
461
\fBUseEntryGuards \fR\fB0\fR|\fB1\fR\fP
Roger Dingledine's avatar
Roger Dingledine committed
462
If this option is set to 1, we pick a few long-term entry servers, and
463
try to stick with them.  This is desirable because
Nick Mathewson's avatar
Nick Mathewson committed
464
465
constantly changing servers increases the odds that an adversary who owns
some servers will observe a fraction of your paths.
466
(Defaults to 1.)
Nick Mathewson's avatar
Nick Mathewson committed
467
468
.LP
.TP
469
470
\fBNumEntryGuards \fR\fINUM\fP
If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
Roger Dingledine's avatar
Roger Dingledine committed
471
as long-term entries for our circuits.
Nick Mathewson's avatar
Nick Mathewson committed
472
(Defaults to 3.)
Peter Palfrader's avatar
Peter Palfrader committed
473
474
.LP
.TP
475
\fBSafeSocks \fR\fB0\fR|\fB1\fR\fP
476
477
478
479
480
481
482
When this option is enabled, Tor will reject application connections that
use unsafe variants of the socks protocol -- ones that only provide an
IP address, meaning the application is doing a DNS resolve first.
Specifically, these are socks4 and socks5 when not doing remote DNS.
(Defaults to 0.)
.LP
.TP
Peter Palfrader's avatar
Peter Palfrader committed
483
\fBTestSocks \fR\fB0\fR|\fB1\fR\fP
484
485
When this option is enabled, Tor will make a notice-level log entry for
each connection to the Socks port indicating whether the request used
486
487
488
a safe socks protocol or an unsafe one (see above entry on SafeSocks).
This helps to determine whether an application using Tor is possibly
leaking DNS requests.
Roger Dingledine's avatar
Roger Dingledine committed
489
(Default: 0)
490
491
.LP
.TP
492
\fBVirtualAddrNetwork \fR\fIAddress\fB/\fIbits\fP
493
494
495
When a controller asks for a virtual (unused) address with the
'MAPADDRESS' command, Tor picks an unassigned address from this range.
(Default: 127.192.0.0/10)
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
.LP
.TP
\fBAllowNonRFC953Hostnames \fR\fB0\fR|\fB1\fR\fP
When this option is enabled, Tor blocks hostnames containing illegal
characters (like @ and :) rather than sending them to an exit node to be
resolved.  This helps trap accidental attempts to resolve URLs and so on.
(Default: 1)
.LP
.TP
\fBFastFirstHopPK \fR\fB0\fR|fB1\fR\fP
When this option is enabled and we aren't running as a server, Tor
skips the public key step for the first hop of creating circuits.  This is
safe since we have already used TLS to authenticate the server and to
establish forward-secure keys.  Turning this option off makes circuit
building slower.
(Default: 1)
Roger Dingledine's avatar
Roger Dingledine committed
512
513
514

.SH SERVER OPTIONS
.PP
515
The following options are useful only for servers (that is, if \fBORPort\fP is non-zero):
516
.LP
Roger Dingledine's avatar
Roger Dingledine committed
517
.TP
518
\fBAddress \fR\fIaddress\fP
519
520
The IP or fqdn of this server (e.g. moria.mit.edu). You can leave this
unset, and Tor will guess your IP.
521
.LP
Roger Dingledine's avatar
Roger Dingledine committed
522
.TP
523
524
525
526
527
528
529
530
\fBAssumeReachable \fR\fB0\fR|\fB1\fR\fP
This option is used when bootstrapping a new Tor network. If set to 1,
don't do self-reachability testing; just upload your server descriptor
immediately. If \fBAuthoritativeDirectory\fP is also set, this option
instructs the dirserver to bypass remote reachability testing too and
list all connected servers as running.
.LP
.TP
531
\fBContactInfo \fR\fIemail_address\fP
532
533
534
Administrative contact information for server. This line might get
picked up by spam harvesters, so you may want to obscure the fact
that it's an email address.
535
.LP
Roger Dingledine's avatar
Roger Dingledine committed
536
.TP
537
\fBExitPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
Peter Palfrader's avatar
Peter Palfrader committed
538
Set an exit policy for this server. Each policy is of the form
539
"\fBaccept\fP|\fBreject\fP \fIADDR\fP[\fB/\fP\fIMASK\fP]\fB[:\fP\fIPORT\fP]".
540
If \fB/\fP\fIMASK\fP is omitted then this policy just applies to the host
Peter Palfrader's avatar
Peter Palfrader committed
541
given.  Instead of giving a host or network you can also use "\fB*\fP" to
542
543
denote the universe (0.0.0.0/0).  \fIPORT\fP can be a single port number,
an interval of ports "\fIFROM_PORT\fP\fB-\fP\fITO_PORT\fP", or "\fB*\fP".
Andrew Lewman's avatar
Andrew Lewman committed
544
If \fIPORT\fP is omitted, that means "\fB*\fP".
Peter Palfrader's avatar
Peter Palfrader committed
545

546
547
For example, "accept 18.7.22.69:*,reject 18.0.0.0/8:*,accept *:*" would
reject any traffic destined for MIT except for web.mit.edu, and
Peter Palfrader's avatar
Peter Palfrader committed
548
accept anything else.
549

550
551
552
To specify all internal and link-local networks (including 0.0.0.0/8,
169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
172.16.0.0/12), you can use the "private" alias instead of an address.
553
554
555
556
557
These addresses are rejected by default (at the beginning of your
exit policy) unless you set the ExitPolicyRejectPrivate config option
to 0. For example, once you've done that, you could allow HTTP to
127.0.0.1 and block all other connections to internal networks with
"accept
558
127.0.0.1:80,reject private:*".  See RFC 1918 and RFC 3330 for more
559
560
details about internal and reserved IP address space.

561
562
563
This directive can be specified multiple times so you don't have to put
it all on one line.

564
Policies are considered first to last, and the first match wins. If
565
566
567
you want to _replace_ the default exit policy, end your exit policy with
either a reject *:* or an accept *:*. Otherwise, you're _augmenting_
(prepending to) the default exit policy. The default exit policy is:
568
569
.PD 0
.RS 12
570
571
572
573
.IP "reject *:25"
.IP "reject *:119"
.IP "reject *:135-139"
.IP "reject *:445"
574
.IP "reject *:465"
575
.IP "reject *:563"
576
.IP "reject *:587"
577
.IP "reject *:1214"
578
579
.IP "reject *:4661-4666"
.IP "reject *:6346-6429"
580
.IP "reject *:6699"
581
.IP "reject *:6881-6999"
582
.IP "accept *:*"
583
584
.RE
.PD
585
.LP
Roger Dingledine's avatar
Roger Dingledine committed
586
.TP
587
588
589
590
591
\fBExitPolicyRejectPrivate \fR\fB0\fR|\fB1\fR\fP
Reject all private (local) networks at the beginning of your exit
policy. See above entry on ExitPolicy. (Default: 1)
.LP
.TP
592
\fBMaxOnionsPending \fR\fINUM\fP
Roger Dingledine's avatar
Roger Dingledine committed
593
If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
594
.LP
Roger Dingledine's avatar
Roger Dingledine committed
595
.TP
596
\fBMyFamily \fR\fInickname\fR,\fInickname\fR,\fI...\fP
Nick Mathewson's avatar
Nick Mathewson committed
597
Declare that this Tor server is controlled or administered by a group
Nick Mathewson's avatar
Nick Mathewson committed
598
or organization identical or similar to that of the other named servers.
Nick Mathewson's avatar
Nick Mathewson committed
599
When two servers both declare that they are in the same 'family', Tor clients
Roger Dingledine's avatar
Roger Dingledine committed
600
601
will not use them in the same circuit.  (Each server only needs to list the
other servers in its family; it doesn't need to list itself, but it won't hurt.)
602
.LP
Nick Mathewson's avatar
Nick Mathewson committed
603
.TP
604
\fBNickname \fR\fIname\fP
605
606
607
Set the server's nickname to 'name'. Nicknames must be between 1
and 19 characters inclusive, and must contain only the characters
[a-zA-Z0-9].
608
.LP
Roger Dingledine's avatar
Roger Dingledine committed
609
.TP
610
\fBNumCPUs \fR\fInum\fP
Roger Dingledine's avatar
Roger Dingledine committed
611
How many processes to use at once for decrypting onionskins. (Default: 1)
612
.LP
Roger Dingledine's avatar
Roger Dingledine committed
613
.TP
614
\fBORPort \fR\fIPORT\fP
615
Advertise this port to listen for connections from Tor clients and servers.
616
.LP
Roger Dingledine's avatar
Roger Dingledine committed
617
.TP
618
\fBORListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
619
620
621
Bind to this IP address to listen for connections from Tor clients and
servers. If you specify a port, bind to this port rather than the one
specified in ORPort. (Default: 0.0.0.0)
622
623
This directive can be specified multiple times to bind to multiple
addresses/ports.
624
.LP
Nick Mathewson's avatar
Nick Mathewson committed
625
.TP
626
627
628
629
630
631
632
633
\fBPublishServerDescriptor \fR\fB0\fR|\fB1\fR\fP
If set to 0, Tor will act as a server if you have an ORPort
defined, but it will not publish its descriptor to the dirservers. This
option is useful if you're testing out your server, or if you're using
a Tor controller that handles directory publishing for you.
(Default: 1)
.LP
.TP
634
\fBRedirectExit \fR\fIpattern target\fP
Nick Mathewson's avatar
Nick Mathewson committed
635
Whenever an outgoing connection tries to connect to one of a given set
636
637
of addresses, connect to \fItarget\fP (an \fIaddress:port\fP pair) instead.
The address
Nick Mathewson's avatar
Nick Mathewson committed
638
639
pattern is given in the same format as for an exit policy.  The
address translation applies after exit policies are applied.  Multiple
640
\fBRedirectExit\fP options can be used: once any one has matched
641
642
643
644
successfully, no subsequent rules are considered.  You can specify that no
redirection is to be performed on a given set of addresses by using the
special target string "pass", which prevents subsequent rules from being
considered.
645
.LP
Nick Mathewson's avatar
Nick Mathewson committed
646
.TP
Thomas Sjögren's avatar
Thomas Sjögren committed
647
\fBShutdownWaitLength\fR \fINUM\fP
648
649
650
651
When we get a SIGINT and we're a server, we begin shutting down: we close
listeners and start refusing new circuits. After \fBNUM\fP seconds,
we exit. If we get a second SIGINT, we exit immediately.  (Default:
30 seconds)
652
.LP
653
.TP
654
655
\fBAccountingMax \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
Never send more than the specified number of bytes in a given
656
accounting period, or receive more than that number in the period.
657
658
659
For example, with AccountingMax set to 1 GB, a server could send 900 MB
and receive 800 MB and continue running. It will only hibernate once one
of the two reaches 1 GB.
660
661
662
663
When the number of bytes is exhausted, Tor will hibernate until some
time in the next accounting period.  To prevent all servers from
waking at the same time, Tor will also wait until a random point in
each period before waking up.  If you have bandwidth cost issues,
664
enabling hibernation is preferable to setting a low bandwidth, since it
Nick Mathewson's avatar
Nick Mathewson committed
665
666
667
provides users with a collection of fast servers that are up some of
the time, which is more useful than a set of slow servers that are
always "available".
668
.LP
Nick Mathewson's avatar
Nick Mathewson committed
669
.TP
670
671
672
673
674
675
676
677
678
\fBAccountingStart \fR\fBday\fR|\fBweek\fR|\fBmonth\fR [\fIday\fR] \fIHH:MM\fR\fP
Specify how long accounting periods last.  If \fBmonth\fP is given,
each accounting period runs from the time \fIHH:MM\fR on the
\fIday\fRth day of one month to the same day and time of the next.
(The day must be between 1 and 28.)  If \fBweek\fP is given, each
accounting period runs from the time \fIHH:MM\fR of the \fIday\fRth
day of one week to the same day and time of the next week, with Monday
as day 1 and Sunday as day 7.  If \fBday\fR is given, each accounting
period runs from the time \fIHH:MM\fR each day to the same time on the
679
680
next day.  All times are local, and given in 24-hour time.  (Defaults to
"month 1 0:00".)
681
682
683
684
685
.LP
.TP
\fBServerDNSResolvConfFile \fR\fIfilename\fP
Overrides the default DNS configuration with the configuration in
\fIfilename\fP.  The file format is the same as the standard Unix
686
"\fBresolv.conf\fP" file (7).  This option only affects name lookup for
687
688
689
690
691
692
693
694
695
addresses requested by clients; and only takes effect if Tor was built with
eventdns support.  (Defaults to use the system DNS configuration.)
.LP
.TP
\fBServerDNSSearchDomains \fR\fB0\fR|\fB1\fR\fP
If set to \fB1\fP, then we will search for addresses in the local search
domain.  For example, if this system is configured to believe it is in
"example.com", and a client tries to connect to "www", the client will be
connected to "www.example.com".
696
This option only affects name lookup for addresses requested by clients.
697
(Defaults to "0".)
698
699
700
701
702
703
.LP
.TP
\fBServerDNSDetectHijacking \fR\fB0\fR|\fB1\fR\fP
When this option is set to 1, we will test periodically to determine whether
our local nameservers have been configured to hijack failing DNS requests
(usually to an advertising site).  If they are, we will attempt to correct
704
this.  This option only affects name lookup for addresses requested by
705
706
clients; and only takes effect if Tor was built with eventdns support.
(Defaults to "1".)
707
708
709
710
711
712
713
714
.LP
.TP
\fBServerDNSTestAddresses \fR\fIaddress\fR,\fIaddress\fR,\fI...\fP
When we're detecting DNS hijacking, make sure that these \fIvalid\fP
addresses aren't getting redirected.  If they are, then our DNS is
completely useless, and we'll reset our exit policy to "reject *:*".
(Defaults to "www.google.com, www.mit.edu, www.yahoo.com,
www.slashdot.org".)
Roger Dingledine's avatar
Roger Dingledine committed
715
716
717

.SH DIRECTORY SERVER OPTIONS
.PP
718
The following options are useful only for directory servers (that is, if \fBDirPort\fP is non-zero):
719
.LP
Roger Dingledine's avatar
Roger Dingledine committed
720
.TP
721
\fBAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
722
723
724
725
726
727
When this option is set to 1, Tor operates as an authoritative
directory server.  Instead of caching the directory, it generates its
own list of good servers, signs it, and sends that to the clients.
Unless the clients already have you listed as a trusted directory, you
probably do not want to set this option.  Please coordinate with the other
admins at tor-ops@freehaven.net if you think you should be a directory.
728
.LP
729
.TP
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
\fBV1AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor also
generates a version 1 directory (for Tor clients up to 0.1.0.x).
(As of Tor 0.1.1.12 every (v2) authoritative directory still provides most of
the v1 directory functionality, even without this option set to 1.
This however is expected to change in the future.)
.LP
.TP
\fBVersioningAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
When this option is set to 1, Tor adds information on
which versions of Tor are still believed safe for use to
the published directory.  Each version 1 authority is
automatically a versioning authority; version 2 authorities
provide this service optionally.  See \fBRecommendedVersions\fP,
\fBRecommendedClientVersions\fP, and \fBRecommendedServerVersions\fP.
.LP
.TP
\fBNamingAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
When this option is set to 1, then the server advertises that it has
opinions about nickname-to-fingerprint bindings.  It will include these
opinions in its published network-status pages, by listing servers with
the flag "Named" if a correct binding between that nickname and
fingerprint has been registered with the dirserver.  Naming dirservers
will refuse to accept or publish descriptors that contradict a
registered binding.  See \fBapproved-routers\fP in the \fBFILES\fP
section below.
.LP
.TP
758
759
760
761
762
\fBHSAuthoritativeDir \fR\fB0\fR|\fB1\fR\fP
When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor also
accepts and serves hidden service descriptors. (Default: 0)
.LP
.TP
763
\fBDirPort \fR\fIPORT\fP
764
Advertise the directory service on this port.
765
.LP
Roger Dingledine's avatar
Roger Dingledine committed
766
.TP
767
\fBDirListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
768
769
Bind the directory service to this address. If you specify a port, bind
to this port rather than the one specified in DirPort. (Default: 0.0.0.0)
770
771
This directive can be specified multiple times to bind to multiple
addresses/ports.
772
.LP
Roger Dingledine's avatar
Roger Dingledine committed
773
.TP
774
\fBDirPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
775
776
Set an entrance policy for this server, to limit who can connect to the
directory ports.
777
The policies have the same form as exit policies above.
778
.LP
779
.TP
780
\fBRecommendedVersions \fR\fISTRING\fP
781
STRING is a comma-separated list of Tor versions currently believed
Nick Mathewson's avatar
Nick Mathewson committed
782
783
784
785
to be safe. The list is included in each directory, and nodes which
pull down the directory learn whether they need to upgrade.  This
option can appear multiple times: the values from multiple lines are
spliced together.
786
787
When this is set then
\fBVersioningAuthoritativeDirectory\fP should be set too.
788
.LP
789
.TP
790
\fBRecommendedClientVersions \fR\fISTRING\fP
791
STRING is a comma-separated list of Tor versions currently believed
792
793
794
to be safe for clients to use.  This information is included in version 2
directories.  If this is not set then the value of \fBRecommendedVersions\fR
is used.
795
796
When this is set then
\fBVersioningAuthoritativeDirectory\fP should be set too.
797
798
799
.LP
.TP
\fBRecommendedServerVersions \fR\fISTRING\fP
800
STRING is a comma-separated list of Tor versions currently believed
801
802
803
to be safe for servers to use.  This information is included in version 2
directories.  If this is not set then the value of \fBRecommendedVersions\fR
is used.
804
805
When this is set then
\fBVersioningAuthoritativeDirectory\fP should be set too.
806
807
.LP
.TP
808
809
810
811
\fBDirAllowPrivateAddresses \fR\fB0\fR|\fB1\fR\fP
If set to 1, Tor will accept router descriptors with arbitrary "Address"
elements. Otherwise, if the address is not an IP or is a private IP,
it will reject the router descriptor. Defaults to 0.
812
.LP
813
.TP
814
815
816
817
818
819
\fBAuthDirBadExit \fR\fIAddressPattern\fR...\fP
Authoritative directories only.  A set of address patterns for servers that
will be listed as bad exits in any network status document this authority
publishes, if \fBAuthDirListBadExits\fR is set.
.LP
.TP
820
821
822
823
824
825
826
827
828
829
830
\fBAuthDirInvalid \fR\fIAddressPattern\fR...\fP
Authoritative directories only. A set of address patterns for servers that
will never be listed as "valid" in any network status document that this
authority publishes.
.LP
.TP
\fBAuthDirReject \fR\fIAddressPattern\fR...\fP
Authoritative directories only.  A set of address patterns for servers that
will never be listed at all in any network status document that this
authority publishes, or accepted as an OR address in any descriptor submitted
for publication by this authority.
831
832
.LP
.TP
833
834
835
836
837
838
839
840
\fBAuthDirListBadExits \fR\fB0\fR|\fB1\fR\fP
Authoritative directories only.  If set to 1, this directory has
some opinion about which nodes are unsuitable as exit nodes.  (Do not
set this to 1 unless you plan to list nonfunctioning exits as bad;
otherwise, you are effectively voting in favor of every declared exit
as an exit.)
.LP
.TP
841
842
843
844
845
\fBAuthDirRejectUnlisted \fR\fB0\fR|\fB1\fR\fP
Authoritative directories only.  If set to 1, the directory server
rejects all uploaded server descriptors that aren't explicitly listed
in the fingerprints file. This acts as a "panic button" if we get
Sybiled. (Default: 0)
846

847
.SH HIDDEN SERVICE OPTIONS
848
849
.PP
The following options are used to configure a hidden service.
850
.LP
851
.TP
852
\fBHiddenServiceDir \fR\fIDIRECTORY\fP
853
854
855
Store data files for a hidden service in DIRECTORY.  Every hidden
service must have a separate directory.  You may use this option multiple
times to specify multiple services.
856
.LP
857
.TP
858
\fBHiddenServicePort \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
859
860
861
862
863
Configure a virtual port VIRTPORT for a hidden service.  You may use this
option multiple times; each time applies to the service using the most recent
hiddenservicedir.  By default, this option maps the virtual port to the
same port on 127.0.0.1.  You may override the target port, address, or both
by specifying a target of addr, port, or addr:port.
864
.LP
865
.TP
866
\fBHiddenServiceNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
867
If possible, use the specified nodes as introduction points for the hidden
868
869
service. If this is left unset, Tor will be smart and pick some reasonable
ones; most people can leave this unset.
870
.LP
871
.TP
872
\fBHiddenServiceExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
873
Do not use the specified nodes as introduction points for the hidden
874
service. In normal use there is no reason to set this.
875
.LP
876
.TP
877
878
879
880
881
882
883
\fBPublishHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
If set to 0, Tor will run any hidden services you configure, but it won't
advertise them to the rendezvous directory. This option is only useful
if you're using a Tor controller that handles hidserv publishing for you.
(Default: 1)
.LP
.TP
884
885
886
\fBRendPostPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
Every time the specified period elapses, Tor uploads any rendezvous
service descriptors to the directory servers.  This information is also
887
uploaded whenever it changes.  (Default: 20 minutes)
888

889
890
.\" UNDOCUMENTED
.\" ignoreversion
891

Roger Dingledine's avatar
Roger Dingledine committed
892
893
.SH SIGNALS
Tor catches the following signals:
894
.LP
Roger Dingledine's avatar
Roger Dingledine committed
895
896
897
.TP
\fBSIGTERM\fR
Tor will catch this, clean up and sync to disk if necessary, and exit.
898
.LP
Roger Dingledine's avatar
Roger Dingledine committed
899
900
901
902
.TP
\fBSIGINT\fR
Tor clients behave as with SIGTERM; but Tor servers will do a controlled
slow shutdown, closing listeners and waiting 30 seconds before exiting.
903
(The delay can be configured with the ShutdownWaitLength config option.)
904
.LP
Roger Dingledine's avatar
Roger Dingledine committed
905
906
.TP
\fBSIGHUP\fR
907
908
909
The signal instructs Tor to reload its configuration (including closing
and reopening logs), fetch a new directory, and kill and restart its
helper processes if applicable.
910
.LP
Roger Dingledine's avatar
Roger Dingledine committed
911
912
913
914
.TP
\fBSIGUSR1\fR
Log statistics about current connections, past connections, and
throughput.
915
.LP
Roger Dingledine's avatar
Roger Dingledine committed
916
.TP
917
918
919
\fBSIGUSR2\fR
Switch all logs to loglevel debug. You can go back to the old loglevels
by sending a SIGHUP.
920
.LP
921
.TP
Roger Dingledine's avatar
Roger Dingledine committed
922
923
924
\fBSIGCHLD\fR
Tor receives this signal when one of its helper processes has exited,
so it can clean up.
925
.LP
Roger Dingledine's avatar
Roger Dingledine committed
926
927
928
.TP
\fBSIGPIPE\fR
Tor catches this signal and ignores it.
929
.LP
Roger Dingledine's avatar
Roger Dingledine committed
930
931
932
933
.TP
\fBSIGXFSZ\fR
If this signal exists on your platform, Tor catches and ignores it.

Roger Dingledine's avatar
Roger Dingledine committed
934
.SH FILES
935
.LP
Roger Dingledine's avatar
Roger Dingledine committed
936
.TP
937
.B @CONFDIR@/torrc
Roger Dingledine's avatar
Roger Dingledine committed
938
The configuration file, which contains "option value" pairs.
939
.LP
Roger Dingledine's avatar
Roger Dingledine committed
940
.TP
941
.B @LOCALSTATEDIR@/lib/tor/
942
The tor process stores keys and other data here.
943
944
.LP
.TP
945
946
947
948
.B \fIDataDirectory\fP/cached-status/*
The most recently downloaded network status document for each authority.  Each file holds one such document; the filenames are the hexadecimal identity key fingerprints of the directory authorities.
.LP
.TP
949
.B \fIDataDirectory\fB/cached-routers\fR and \fBcached-routers.new\fR
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
These files hold downloaded router statuses.  Some routers may appear more than once; if so, the most recently published descriptor is used.  The ".new" file is an append-only journal; when it gets too large, all entries are merged into a new cached-routers file.
.LP
.TP
.B \fIDataDirectory\fP/state
A set of persistent key-value mappings.  These are documented in the file.  These include:
.PD 0
.RS 5
.IP "- The current entry guards and their status."
.IP "- The current bandwidth accounting values (unused so far; see below)."
.IP "- When the file was last written"
.IP "- What version of Tor generated the state file"
.IP "- A short history of bandwidth usage, as produced in the router descriptors."
.RE
.PD
.LP
.TP
.B \fIDataDirectory\fP/bw_accounting
Used to track bandwidth accounting values (when the current period starts and ends; how much has been read and written so far this period).  Soon to be obsoleted by state.  Only used when bandwidth accounting is enabled.
.LP
.TP
.B \fIDataDirectory\fP/control_auth_cookie
Used for cookie authentication with the controller. Regenerated on startup.  See control-spec.txt for details.  Only used when cookie authentication is enabled.
.LP
.TP
.B \fIDataDirectory\fP/keys/*
Only used by servers.  Holds identity keys and onion keys.
.LP
.TP
.B \fIDataDirectory\fP/fingerprint
Only used by servers.  Holds the fingerprint of the server's identity key.
.LP
.TP
982
.B \fIDataDirectory\fP/approved-routers
983
Only for naming authoritative directory servers (see \fBNamingAuthoritativeDirectory\fP).  This file lists nickname to identity bindings.  Each line lists a nickname and a fingerprint separated by whitespace.  See your \fBfingerprint\fP file in the \fIDataDirectory\fP for an example line.  If the nickname is \fB!reject\fP then descriptors from the given identity (fingerprint) are rejected by this server. If it is \fB!invalid\fP then descriptors are accepted but marked in the directory as not valid, that is, not recommended.
984
985
986
987
988
989
.LP
.TP
.B \fIHiddenServiceDirectory\fP/hostname 
The <base32-encoded-fingerprint>.onion domain name for this hidden service.
.LP
.TP
990
.B \fIHiddenServiceDirectory\fP/private_key 
991
The private key for this hidden service.
Roger Dingledine's avatar
Roger Dingledine committed
992
993
.SH SEE ALSO
.BR privoxy (1),
994
995
.BR tsocks (1),
.BR torify (1)
Roger Dingledine's avatar
Roger Dingledine committed
996

997
.BR http://tor.eff.org/
Roger Dingledine's avatar
Roger Dingledine committed
998
999

.SH BUGS
1000
Plenty, probably. Tor is still in development. Please report them.