1 // Copyright (c) The Tor Project, Inc.
2 // See LICENSE for licensing information
3 // This is an asciidoc file used to generate the manpage/html reference.
4 // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
10 tor - The second-generation onion router
15 **tor** [__OPTION__ __value__]...
19 __tor__ is a connection-oriented anonymizing communication
20 service. Users choose a source-routed path through a set of nodes, and
21 negotiate a "virtual circuit" through the network, in which each node
22 knows its predecessor and successor, but no others. Traffic flowing down
23 the circuit is unwrapped by a symmetric key at each node, which reveals
24 the downstream node. +
26 Basically __tor__ provides a distributed network of servers ("onion routers").
27 Users bounce their TCP streams -- web traffic, ftp, ssh, etc -- around the
28 routers, and recipients, observers, and even the routers themselves have
29 difficulty tracking the source of the stream.
34 Display a short help message and exit.
37 FILE contains further "option value" pairs. (Default: @CONFDIR@/torrc)
40 Generates a hashed password for control port access.
42 **--list-fingerprint**::
43 Generate your keys and output your nickname and fingerprint.
46 Verify the configuration file is valid.
49 **--service [install|remove|start|stop]** Manage the Tor Windows
50 NT/2000/XP service. Current instructions can be found at
51 https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ#WinNTService
53 **--list-torrc-options**::
54 List all valid options.
57 Display Tor version and exit.
60 Do not start Tor with a console log unless explicitly requested to do so.
61 (By default, Tor starts out logging messages at level "notice" or higher to
62 the console, until it has parsed its configuration.)
64 Other options can be specified either on the command-line (--option
65 value), or in the configuration file (option value or option "value").
66 Options are case-insensitive. C-style escaped characters are allowed inside
67 quoted values. Options on the command line take precedence over
68 options found in the configuration file, except indicated otherwise. To
69 split one configuration entry into multiple lines, use a single \ before
70 the end of the line. Comments can be used in such multiline entries, but
71 they must start at the beginning of a line.
73 **BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
74 A token bucket limits the average incoming bandwidth usage on this node to
75 the specified number of bytes per second, and the average outgoing
76 bandwidth usage to that same value. If you want to run a relay in the
77 public network, this needs to be _at the very least_ 20 KB (that is,
78 20480 bytes). (Default: 5 MB)
80 **BandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
81 Limit the maximum token bucket size (also known as the burst) to the given
82 number of bytes in each direction. (Default: 10 MB)
84 **MaxAdvertisedBandwidth** __N__ **bytes**|**KB**|**MB**|**GB**::
85 If set, we will not advertise more than this amount of bandwidth for our
86 BandwidthRate. Server operators who want to reduce the number of clients
87 who ask to build circuits through them (since this is proportional to
88 advertised bandwidth rate) can thus reduce the CPU demands on their server
89 without impacting network performance.
91 **RelayBandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
92 If not 0, a separate token bucket limits the average incoming bandwidth
93 usage for \_relayed traffic_ on this node to the specified number of bytes
94 per second, and the average outgoing bandwidth usage to that same value.
95 Relayed traffic currently is calculated to include answers to directory
96 requests, but that may change in future versions. (Default: 0)
98 **RelayBandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
99 If not 0, limit the maximum token bucket size (also known as the burst) for
100 \_relayed traffic_ to the given number of bytes in each direction.
103 **PerConnBWRate** __N__ **bytes**|**KB**|**MB**|**GB**::
104 If set, do separate rate limiting for each connection from a non-relay.
105 You should never need to change this value, since a network-wide value is
106 published in the consensus and your relay will use that value. (Default: 0)
108 **PerConnBWBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
109 If set, do separate rate limiting for each connection from a non-relay.
110 You should never need to change this value, since a network-wide value is
111 published in the consensus and your relay will use that value. (Default: 0)
113 **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
114 When set along with a corresponding Bridge line, the Tor client
115 forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's
116 the duty of that proxy to properly forward the traffic to the
119 **ConnLimit** __NUM__::
120 The minimum number of file descriptors that must be available to the Tor
121 process before it will start. Tor will ask the OS for as many file
122 descriptors as the OS will allow (you can find this by "ulimit -H -n").
123 If this number is less than ConnLimit, then Tor will refuse to start. +
125 You probably don't need to adjust this. It has no effect on Windows
126 since that platform lacks getrlimit(). (Default: 1000)
128 **ConstrainedSockets** **0**|**1**::
129 If set, Tor will tell the kernel to attempt to shrink the buffers for all
130 sockets to the size specified in **ConstrainedSockSize**. This is useful for
131 virtual servers and other environments where system level TCP buffers may
132 be limited. If you're on a virtual server, and you encounter the "Error
133 creating network socket: No buffer space available" message, you are
134 likely experiencing this problem. +
136 The preferred solution is to have the admin increase the buffer pool for
137 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
138 this configuration option is a second-resort. +
140 The DirPort option should also not be used if TCP buffers are scarce. The
141 cached directory requests consume additional sockets which exacerbates
144 You should **not** enable this feature unless you encounter the "no buffer
145 space available" issue. Reducing the TCP buffers affects window size for
146 the TCP stream and will reduce throughput in proportion to round trip
147 time on long paths. (Default: 0.)
149 **ConstrainedSockSize** __N__ **bytes**|**KB**::
150 When **ConstrainedSockets** is enabled the receive and transmit buffers for
151 all sockets will be set to this limit. Must be a value between 2048 and
152 262144, in 1024 byte increments. Default of 8192 is recommended.
154 **ControlPort** __PORT__|**auto**::
155 If set, Tor will accept connections on this port and allow those
156 connections to control the Tor process using the Tor Control Protocol
157 (described in control-spec.txt). Note: unless you also specify one or
158 more of **HashedControlPassword** or **CookieAuthentication**,
159 setting this option will cause Tor to allow any process on the local
160 host to control it. (Setting both authentication methods means either
161 method is sufficient to authenticate to Tor.) This
162 option is required for many Tor controllers; most use the value of 9051.
163 Set it to "auto" to have Tor pick a port for you. (Default: 0).
165 **ControlListenAddress** __IP__[:__PORT__]::
166 Bind the controller listener to this address. If you specify a port, bind
167 to this port rather than the one specified in ControlPort. We strongly
168 recommend that you leave this alone unless you know what you're doing,
169 since giving attackers access to your control listener is really
170 dangerous. (Default: 127.0.0.1) This directive can be specified multiple
171 times to bind to multiple addresses/ports.
173 **ControlSocket** __Path__::
174 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
175 socket. (Unix and Unix-like systems only.)
177 **ControlSocketsGroupWritable** **0**|**1**::
178 If this option is set to 0, don't allow the filesystem group to read and
179 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
180 the control socket readable and writable by the default GID. (Default: 0)
182 **HashedControlPassword** __hashed_password__::
183 Allow connections on the control port if they present
184 the password whose one-way hash is __hashed_password__. You
185 can compute the hash of a password by running "tor --hash-password
186 __password__". You can provide several acceptable passwords by using more
187 than one HashedControlPassword line.
189 **CookieAuthentication** **0**|**1**::
190 If this option is set to 1, allow connections on the control port
191 when the connecting process knows the contents of a file named
192 "control_auth_cookie", which Tor will create in its data directory. This
193 authentication method should only be used on systems with good filesystem
194 security. (Default: 0)
196 **CookieAuthFile** __Path__::
197 If set, this option overrides the default location and file name
198 for Tor's cookie file. (See CookieAuthentication above.)
200 **CookieAuthFileGroupReadable** **0**|**1**|__Groupname__::
201 If this option is set to 0, don't allow the filesystem group to read the
202 cookie file. If the option is set to 1, make the cookie file readable by
203 the default GID. [Making the file readable by other groups is not yet
204 implemented; let us know if you need this for some reason.] (Default: 0).
206 **ControlPortWriteToFile** __Path__::
207 If set, Tor writes the address and port of any control port it opens to
208 this address. Usable by controllers to learn the actual control port
209 when ControlPort is set to "auto".
211 **ControlPortFileGroupReadable** **0**|**1**::
212 If this option is set to 0, don't allow the filesystem group to read the
213 control port file. If the option is set to 1, make the control port
214 file readable by the default GID. (Default: 0).
216 **DataDirectory** __DIR__::
217 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
219 **DirServer** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
220 Use a nonstandard authoritative directory server at the provided address
221 and port, with the specified key fingerprint. This option can be repeated
222 many times, for multiple authoritative directory servers. Flags are
223 separated by spaces, and determine what kind of an authority this directory
224 is. By default, every authority is authoritative for current ("v2")-style
225 directories, unless the "no-v2" flag is given. If the "v1" flags is
226 provided, Tor will use this server as an authority for old-style (v1)
227 directories as well. (Only directory mirrors care about this.) Tor will
228 use this server as an authority for hidden service information if the "hs"
229 flag is set, or if the "v1" flag is set and the "no-hs" flag is **not** set.
230 Tor will use this authority as a bridge authoritative directory if the
231 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
232 given port when opening encrypted tunnels to the dirserver. Lastly, if a
233 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
234 whose v3 long-term signing key has the fingerprint **fp**. +
236 If no **dirserver** line is given, Tor will use the default directory
237 servers. NOTE: this option is intended for setting up a private Tor
238 network with its own directory authorities. If you use it, you will be
239 distinguishable from other users, because you won't believe the same
242 **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
244 **AlternateHSAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
246 **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
247 As DirServer, but replaces less of the default directory authorities. Using
248 AlternateDirAuthority replaces the default Tor directory authorities, but
249 leaves the hidden service authorities and bridge authorities in place.
250 Similarly, Using AlternateHSAuthority replaces the default hidden service
251 authorities, but not the directory or bridge authorities.
253 **DisableAllSwap** **0**|**1**::
254 If set to 1, Tor will attempt to lock all current and future memory pages,
255 so that memory cannot be paged out. Windows, OS X and Solaris are currently
256 not supported. We believe that this feature works on modern Gnu/Linux
257 distributions, and that it should work on *BSD systems (untested). This
258 option requires that you start your Tor as root, and you should use the
259 **User** option to properly reduce Tor's privileges. (Default: 0)
261 **FetchDirInfoEarly** **0**|**1**::
262 If set to 1, Tor will always fetch directory information like other
263 directory caches, even if you don't meet the normal criteria for fetching
264 early. Normal users should leave it off. (Default: 0)
266 **FetchDirInfoExtraEarly** **0**|**1**::
267 If set to 1, Tor will fetch directory information before other directory
268 caches. It will attempt to download directory information closer to the
269 start of the consensus period. Normal users should leave it off.
272 **FetchHidServDescriptors** **0**|**1**::
273 If set to 0, Tor will never fetch any hidden service descriptors from the
274 rendezvous directories. This option is only useful if you're using a Tor
275 controller that handles hidden service fetches for you. (Default: 1)
277 **FetchServerDescriptors** **0**|**1**::
278 If set to 0, Tor will never fetch any network status summaries or server
279 descriptors from the directory servers. This option is only useful if
280 you're using a Tor controller that handles directory fetches for you.
283 **FetchUselessDescriptors** **0**|**1**::
284 If set to 1, Tor will fetch every non-obsolete descriptor from the
285 authorities that it hears about. Otherwise, it will avoid fetching useless
286 descriptors, for example for routers that are not running. This option is
287 useful if you're using the contributed "exitlist" script to enumerate Tor
288 nodes that exit to certain addresses. (Default: 0)
290 **HTTPProxy** __host__[:__port__]::
291 Tor will make all its directory requests through this host:port (or host:80
292 if port is not specified), rather than connecting directly to any directory
295 **HTTPProxyAuthenticator** __username:password__::
296 If defined, Tor will use this username:password for Basic HTTP proxy
297 authentication, as in RFC 2617. This is currently the only form of HTTP
298 proxy authentication that Tor supports; feel free to submit a patch if you
299 want it to support others.
301 **HTTPSProxy** __host__[:__port__]::
302 Tor will make all its OR (SSL) connections through this host:port (or
303 host:443 if port is not specified), via HTTP CONNECT rather than connecting
304 directly to servers. You may want to set **FascistFirewall** to restrict
305 the set of ports you might try to connect to, if your HTTPS proxy only
306 allows connecting to certain ports.
308 **HTTPSProxyAuthenticator** __username:password__::
309 If defined, Tor will use this username:password for Basic HTTPS proxy
310 authentication, as in RFC 2617. This is currently the only form of HTTPS
311 proxy authentication that Tor supports; feel free to submit a patch if you
312 want it to support others.
314 **Socks4Proxy** __host__[:__port__]::
315 Tor will make all OR connections through the SOCKS 4 proxy at host:port
316 (or host:1080 if port is not specified).
318 **Socks5Proxy** __host__[:__port__]::
319 Tor will make all OR connections through the SOCKS 5 proxy at host:port
320 (or host:1080 if port is not specified).
322 **Socks5ProxyUsername** __username__ +
324 **Socks5ProxyPassword** __password__::
325 If defined, authenticate to the SOCKS 5 server using username and password
326 in accordance to RFC 1929. Both username and password must be between 1 and
329 **KeepalivePeriod** __NUM__::
330 To keep firewalls from expiring connections, send a padding keepalive cell
331 every NUM seconds on open connections that are in use. If the connection
332 has no open circuits, it will instead be closed after NUM seconds of
333 idleness. (Default: 5 minutes)
335 **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
336 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
337 output stream, the standard error stream, or to the system log. (The
338 "syslog" value is only supported on Unix.) Recognized severity levels are
339 debug, info, notice, warn, and err. We advise using "notice" in most cases,
340 since anything more verbose may provide sensitive information to an
341 attacker who obtains the logs. If only one severity level is given, all
342 messages of that level or higher will be sent to the listed destination.
344 **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
345 As above, but send log messages to the listed filename. The
346 "Log" option may appear more than once in a configuration file.
347 Messages are sent to all the logs that match their severity
350 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
352 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
353 As above, but select messages by range of log severity __and__ by a
354 set of "logging domains". Each logging domain corresponds to an area of
355 functionality inside Tor. You can specify any number of severity ranges
356 for a single log statement, each of them prefixed by a comma-separated
357 list of logging domains. You can prefix a domain with $$~$$ to indicate
358 negation, and use * to indicate "all domains". If you specify a severity
359 range without a list of domains, it matches all domains. +
361 This is an advanced feature which is most useful for debugging one or two
362 of Tor's subsystems at a time. +
364 The currently recognized domains are: general, crypto, net, config, fs,
365 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
366 acct, hist, and handshake. Domain names are case-insensitive. +
368 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
369 to stdout: all handshake messages of any severity, all info-and-higher
370 messages from domains other than networking and memory management, and all
371 messages of severity notice or higher.
373 **LogMessageDomains** **0**|**1**::
374 If 1, Tor includes message domains with each log message. Every log
375 message currently has at least one domain; most currently have exactly
376 one. This doesn't affect controller log messages. (Default: 0)
378 **OutboundBindAddress** __IP__::
379 Make all outbound connections originate from the IP address specified. This
380 is only useful when you have multiple network interfaces, and you want all
381 of Tor's outgoing connections to use a single one. This setting will be
382 ignored for connections to the loopback addresses (127.0.0.0/8 and ::1).
384 **PidFile** __FILE__::
385 On startup, write our PID to FILE. On clean shutdown, remove
388 **ProtocolWarnings** **0**|**1**::
389 If 1, Tor will log with severity \'warn' various cases of other parties not
390 following the Tor specification. Otherwise, they are logged with severity
391 \'info'. (Default: 0)
393 **RunAsDaemon** **0**|**1**::
394 If 1, Tor forks and daemonizes to the background. This option has no effect
395 on Windows; instead you should use the --service command-line option.
398 **LogTimeGranularity** __NUM__::
399 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
400 NUM must be positive and either a divisor or a multiple of 1 second.
401 Note that this option only controls the granularity written by Tor to
402 a file or console log. Tor does not (for example) "batch up" log
403 messages to affect times logged by a controller, times attached to
404 syslog messages, or the mtime fields on log files. (Default: 1 second)
406 **SafeLogging** **0**|**1**|**relay**::
407 Tor can scrub potentially sensitive strings from log messages (e.g.
408 addresses) by replacing them with the string [scrubbed]. This way logs can
409 still be useful, but they don't leave behind personally identifying
410 information about what sites a user might have visited. +
412 If this option is set to 0, Tor will not perform any scrubbing, if it is
413 set to 1, all potentially sensitive strings are replaced. If it is set to
414 relay, all log messages generated when acting as a relay are sanitized, but
415 all messages generated when acting as a client are not. (Default: 1)
418 On startup, setuid to this user and setgid to their primary group.
420 **HardwareAccel** **0**|**1**::
421 If non-zero, try to use built-in (static) crypto hardware acceleration when
422 available. (Default: 0)
424 **AccelName** __NAME__::
425 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
426 engine of this name. This must be used for any dynamic hardware engine.
427 Names can be verified with the openssl engine command.
429 **AccelDir** __DIR__::
430 Specify this option if using dynamic hardware acceleration and the engine
431 implementation library resides somewhere other than the OpenSSL default.
433 **AvoidDiskWrites** **0**|**1**::
434 If non-zero, try to write to disk less frequently than we would otherwise.
435 This is useful when running on flash memory or other media that support
436 only a limited number of writes. (Default: 0)
438 **TunnelDirConns** **0**|**1**::
439 If non-zero, when a directory server we contact supports it, we will build
440 a one-hop circuit and make an encrypted connection via its ORPort.
443 **PreferTunneledDirConns** **0**|**1**::
444 If non-zero, we will avoid directory servers that don't support tunneled
445 directory connections, when possible. (Default: 1)
447 **CircuitPriorityHalflife** __NUM1__::
448 If this value is set, we override the default algorithm for choosing which
449 circuit's cell to deliver or relay next. When the value is 0, we
450 round-robin between the active circuits on a connection, delivering one
451 cell from each in turn. When the value is positive, we prefer delivering
452 cells from whichever connection has the lowest weighted cell count, where
453 cells are weighted exponentially according to the supplied
454 CircuitPriorityHalflife value (in seconds). If this option is not set at
455 all, we use the behavior recommended in the current consensus
456 networkstatus. This is an advanced option; you generally shouldn't have
457 to mess with it. (Default: not set.)
459 **DisableIOCP** **0**|**1**::
460 If Tor was built to use the Libevent's "bufferevents" networking code
461 and you're running on Windows, setting this option to 1 will tell Libevent
462 not to use the Windows IOCP networking API. (Default: 1)
464 **CountPrivateBandwidth** **0**|**1**::
465 If this option is set, then Tor's rate-limiting applies not only to
466 remote connections, but also to connections to private addresses like
467 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
468 rate-limiting. (Default: 0)
473 The following options are useful only for clients (that is, if
474 **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
476 **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
477 If some Tor servers are obviously not working right, the directory
478 authorities can manually mark them as invalid, meaning that it's not
479 recommended you use them for entry or exit positions in your circuits. You
480 can opt to use them in some circuit positions, though. The default is
481 "middle,rendezvous", and other choices are not advised.
483 **ExcludeSingleHopRelays** **0**|**1**::
484 This option controls whether circuits built by Tor will include relays with
485 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
486 to 0, these relays will be included. Note that these relays might be at
487 higher risk of being seized or observed, so they are not normally
488 included. Also note that relatively few clients turn off this option,
489 so using these relays might make your client stand out.
492 **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
493 When set along with UseBridges, instructs Tor to use the relay at
494 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
495 is provided (using the same format as for DirServer), we will verify that
496 the relay running at that location has the right fingerprint. We also use
497 fingerprint to look up the bridge descriptor at the bridge authority, if
498 it's provided and if UpdateBridgesFromAuthority is set too. +
500 If "transport" is provided, and matches to a ClientTransportPlugin
501 line, we use that pluggable transports proxy to transfer data to
504 **LearnCircuitBuildTimeout** **0**|**1**::
505 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
507 **CircuitBuildTimeout** __NUM__::
509 Try for at most NUM seconds when building circuits. If the circuit isn't
510 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
511 value serves as the initial value to use before a timeout is learned. If
512 LearnCircuitBuildTimeout is 0, this value is the only value used.
513 (Default: 60 seconds.)
515 **CircuitIdleTimeout** __NUM__::
516 If we have kept a clean (never used) circuit around for NUM seconds, then
517 close it. This way when the Tor client is entirely idle, it can expire all
518 of its circuits, and then expire its TLS connections. Also, if we end up
519 making a circuit that is not useful for exiting any of the requests we're
520 receiving, it won't forever take up a slot in the circuit list. (Default: 1
523 **CircuitStreamTimeout** __NUM__::
524 If non-zero, this option overrides our internal timeout schedule for how
525 many seconds until we detach a stream from a circuit and try a new circuit.
526 If your network is particularly slow, you might want to set this to a
527 number like 60. (Default: 0)
529 **ClientOnly** **0**|**1**::
530 If set to 1, Tor will under no circumstances run as a server or serve
531 directory requests. The default is to run as a client unless ORPort is
532 configured. (Usually, you don't need to set this; Tor is pretty smart at
533 figuring out whether you are reliable and high-bandwidth enough to be a
534 useful server.) (Default: 0)
536 **ExcludeNodes** __node__,__node__,__...__::
537 A list of identity fingerprints, nicknames, country codes and address
538 patterns of nodes to avoid when building a circuit.
540 ExcludeNodes SlowServer, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
542 By default, this option is treated as a preference that Tor is allowed
543 to override in order to keep working.
544 For example, if you try to connect to a hidden service,
545 but you have excluded all of the hidden service's introduction points,
546 Tor will connect to one of them anyway. If you do not want this
547 behavior, set the StrictNodes option (documented below). +
549 Note also that if you are a relay, this (and the other node selection
550 options below) only affects your own circuits that Tor builds for you.
551 Clients can still build circuits through you to any node. Controllers
552 can tell Tor to build circuits through any node.
555 **ExcludeExitNodes** __node__,__node__,__...__::
556 A list of identity fingerprints, nicknames, country codes and address
557 patterns of nodes to never use when picking an exit node---that is, a
558 node that delivers traffic for you outside the Tor network. Note that any
559 node listed in ExcludeNodes is automatically considered to be part of this
560 list too. See also the caveats on the "ExitNodes" option below.
562 **ExitNodes** __node__,__node__,__...__::
563 A list of identity fingerprints, nicknames, country codes and address
564 patterns of nodes to use as exit node---that is, a
565 node that delivers traffic for you outside the Tor network. +
567 Note that if you list too few nodes here, or if you exclude too many exit
568 nodes with ExcludeExitNodes, you can degrade functionality. For example,
569 if none of the exits you list allows traffic on port 80 or 443, you won't
570 be able to browse the web. +
572 Note also that not every circuit is used to deliver traffic outside of
573 the Tor network. It is normal to see non-exit circuits (such as those
574 used to connect to hidden services, those that do directory fetches,
575 those used for relay reachability self-tests, and so on) that end
576 at a non-exit node. To
577 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
579 The ExcludeNodes option overrides this option: any node listed in both
580 ExitNodes and ExcludeNodes is treated as excluded. +
582 The .exit address notation, if enabled via AllowDotExit, overrides
585 **EntryNodes** __node__,__node__,__...__::
586 A list of identity fingerprints, nicknames, and country codes of nodes
587 to use for the first hop in your normal circuits.
588 Normal circuits include all
589 circuits except for direct connections to directory servers. The Bridge
590 option overrides this option; if you have configured bridges and
591 UseBridges is 1, the Bridges are used as your entry nodes. +
593 The ExcludeNodes option overrides this option: any node listed in both
594 EntryNodes and ExcludeNodes is treated as excluded.
596 **StrictNodes** **0**|**1**::
597 If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a
598 requirement to follow for all the circuits you generate, even if doing so
599 will break functionality for you. If StrictNodes is set to 0, Tor will
600 still try to avoid nodes in the ExcludeNodes list, but it will err on the
601 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells
602 Tor that it is okay to use an excluded node when it is *necessary* to
603 perform relay reachability self-tests, connect to
604 a hidden service, provide a hidden service to a client, fulfill a .exit
605 request, upload directory information, or download directory information.
608 **FascistFirewall** **0**|**1**::
609 If 1, Tor will only create outgoing connections to ORs running on ports
610 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
611 This will allow you to run Tor as a client behind a firewall with
612 restrictive policies, but will not allow you to run as a server behind such
613 a firewall. If you prefer more fine-grained control, use
614 ReachableAddresses instead.
616 **FirewallPorts** __PORTS__::
617 A list of ports that your firewall allows you to connect to. Only used when
618 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
619 instead. (Default: 80, 443)
621 **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
622 Client authorization for a hidden service. Valid onion addresses contain 16
623 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
624 characters in A-Za-z0-9+/. The service name is only used for internal
625 purposes, e.g., for Tor controllers. This option may be used multiple times
626 for different hidden services. If a hidden service uses authorization and
627 this option is not set, the hidden service is not accessible. Hidden
628 services can be configured to require authorization using the
629 **HiddenServiceAuthorizeClient** option.
631 **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
632 A comma-separated list of IP addresses and ports that your firewall allows
633 you to connect to. The format is as for the addresses in ExitPolicy, except
634 that "accept" is understood unless "reject" is explicitly provided. For
635 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
636 \*:80' means that your firewall allows connections to everything inside net
637 99, rejects port 80 connections to net 18, and accepts connections to port
638 80 otherwise. (Default: \'accept \*:*'.)
640 **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
641 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
642 these restrictions when fetching directory information, using standard HTTP
643 GET requests. If not set explicitly then the value of
644 **ReachableAddresses** is used. If **HTTPProxy** is set then these
645 connections will go through that proxy.
647 **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
648 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
649 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
650 set explicitly then the value of **ReachableAddresses** is used. If
651 **HTTPSProxy** is set then these connections will go through that proxy. +
653 The separation between **ReachableORAddresses** and
654 **ReachableDirAddresses** is only interesting when you are connecting
655 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
656 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
657 and some limit HTTP GET requests (which Tor uses for fetching directory
658 information) to port 80.
660 **LongLivedPorts** __PORTS__::
661 A list of ports for services that tend to have long-running connections
662 (e.g. chat and interactive shells). Circuits for streams that use these
663 ports will contain only high-uptime nodes, to reduce the chance that a node
664 will go down before the stream is finished. (Default: 21, 22, 706, 1863,
665 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
667 **MapAddress** __address__ __newaddress__::
668 When a request for address arrives to Tor, it will rewrite it to newaddress
669 before processing it. For example, if you always want connections to
670 www.indymedia.org to exit via __torserver__ (where __torserver__ is the
671 nickname of the server), use "MapAddress www.indymedia.org
672 www.indymedia.org.torserver.exit".
674 **NewCircuitPeriod** __NUM__::
675 Every NUM seconds consider whether to build a new circuit. (Default: 30
678 **MaxCircuitDirtiness** __NUM__::
679 Feel free to reuse a circuit that was first used at most NUM seconds ago,
680 but never attach a new stream to a circuit that is too old. (Default: 10
683 **NodeFamily** __node__,__node__,__...__::
684 The Tor servers, defined by their identity fingerprints or nicknames,
685 constitute a "family" of similar or co-administered servers, so never use
686 any two of them in the same circuit. Defining a NodeFamily is only needed
687 when a server doesn't list the family itself (with MyFamily). This option
688 can be used multiple times. In addition to nodes, you can also list
689 IP address and ranges and country codes in {curly braces}.
691 **EnforceDistinctSubnets** **0**|**1**::
692 If 1, Tor will not put two servers whose IP addresses are "too close" on
693 the same circuit. Currently, two addresses are "too close" if they lie in
694 the same /16 range. (Default: 1)
696 **SOCKSPort** \['address':]__port__|**auto** [_isolation flags_]::
697 Open this port to listen for connections from SOCKS-speaking
698 applications. Set this to 0 if you don't want to allow application
699 connections via SOCKS. Set it to "auto" to have Tor pick a port for
700 you. This directive can be specified multiple times to bind
701 to multiple addresses/ports. (Default: 9050) +
703 The _isolation flags_ arguments give Tor rules for which streams
704 received on this SOCKSPort are allowed to share circuits with one
705 another. Recognized isolation flags are:
706 **IsolateClientAddr**;;
707 Don't share a circuits with streams from a different
708 client address. (On by default and strongly recommended;
709 you can disable it with **NoIsolateClientAddr**.)
710 **IsolateSOCKSAuth**;;
711 Don't share a circuits with streams for which different
712 SOCKS authentication was provided. (On by default;
713 you can disable it with **NoIsolateSOCKSAuth**.)
714 **IsolateClientProtocol**;;
715 Don't share circuits with streams using a different protocol.
716 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
717 and DNSPort requests are all considered to be different protocols.)
718 **IsolateDestPort**;;
719 Don't share a circuits with streams targetting a different
721 **IsolateDestAddr**;;
722 Don't share a circuits with streams targetting a different
724 **SessionGroup=**__INT__;;
725 If no other isolation rules would prevent it, allow streams
726 on this port to share circuits with streams from every other
727 port with the same session group. (By default, streams received
728 on different ports are always isolated from one another.)
730 **SOCKSListenAddress** __IP__[:__PORT__]::
731 Bind to this address to listen for connections from Socks-speaking
732 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
733 192.168.0.1:9100). This directive can be specified multiple times to bind
734 to multiple addresses/ports. (DEPRECATED: As of 0.2.3.x-alpha, you can
735 now use multiple SOCKSPort entries, and provide addresses for SOCKSPort
736 entries, so SOCKSListenAddress no longer has a purpose. For backward
737 compatibility, SOCKSListenAddress is only allowed when SOCKSPort is just
740 **SocksPolicy** __policy__,__policy__,__...__::
741 Set an entrance policy for this server, to limit who can connect to the
742 SocksPort and DNSPort ports. The policies have the same form as exit
745 **SocksTimeout** __NUM__::
746 Let a socks connection wait NUM seconds handshaking, and NUM seconds
747 unattached waiting for an appropriate circuit, before we fail it. (Default:
750 **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
751 Set the refill interval of Tor's token bucket to NUM milliseconds.
752 NUM must be between 1 and 1000, inclusive. Note that the configured
753 bandwidth limits are still expressed in bytes per second: this
754 option only affects the frequency with which Tor checks to see whether
755 previously exhausted connections may read again. (Default: 100 msec.)
757 **TrackHostExits** __host__,__.domain__,__...__::
758 For each value in the comma separated list, Tor will track recent
759 connections to hosts that match this value and attempt to reuse the same
760 exit node for each. If the value is prepended with a \'.\', it is treated as
761 matching an entire domain. If one of the values is just a \'.', it means
762 match everything. This option is useful if you frequently connect to sites
763 that will expire all your authentication cookies (i.e. log you out) if
764 your IP address changes. Note that this option does have the disadvantage
765 of making it more clear that a given history is associated with a single
766 user. However, most people who would wish to observe this will observe it
767 through cookies or other protocol-specific means anyhow.
769 **TrackHostExitsExpire** __NUM__::
770 Since exit servers go up and down, it is desirable to expire the
771 association between host and exit server after NUM seconds. The default is
772 1800 seconds (30 minutes).
774 **UpdateBridgesFromAuthority** **0**|**1**::
775 When set (along with UseBridges), Tor will try to fetch bridge descriptors
776 from the configured bridge authorities when feasible. It will fall back to
777 a direct request if the authority responds with a 404. (Default: 0)
779 **UseBridges** **0**|**1**::
780 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
781 config lines, and use these relays as both entry guards and directory
784 **UseEntryGuards** **0**|**1**::
785 If this option is set to 1, we pick a few long-term entry servers, and try
786 to stick with them. This is desirable because constantly changing servers
787 increases the odds that an adversary who owns some servers will observe a
788 fraction of your paths. (Defaults to 1.)
790 **NumEntryGuards** __NUM__::
791 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
792 as long-term entries for our circuits. (Defaults to 3.)
794 **SafeSocks** **0**|**1**::
795 When this option is enabled, Tor will reject application connections that
796 use unsafe variants of the socks protocol -- ones that only provide an IP
797 address, meaning the application is doing a DNS resolve first.
798 Specifically, these are socks4 and socks5 when not doing remote DNS.
801 **TestSocks** **0**|**1**::
802 When this option is enabled, Tor will make a notice-level log entry for
803 each connection to the Socks port indicating whether the request used a
804 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
805 helps to determine whether an application using Tor is possibly leaking
806 DNS requests. (Default: 0)
808 **WarnUnsafeSocks** **0**|**1**::
809 When this option is enabled, Tor will warn whenever a request is
810 received that only contains an IP address instead of a hostname. Allowing
811 applications to do DNS resolves themselves is usually a bad idea and
812 can leak your location to attackers. (Default: 1)
814 **VirtualAddrNetwork** __Address__/__bits__::
815 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
816 command from the controller or the AutomapHostsOnResolve feature, Tor
817 picks an unassigned address from this range. (Default:
820 When providing proxy server service to a network of computers using a tool
821 like dns-proxy-tor, change this address to "10.192.0.0/10" or
822 "172.16.0.0/12". The default **VirtualAddrNetwork** address range on a
823 properly configured machine will route to the loopback interface. For
824 local use, no change to the default VirtualAddrNetwork setting is needed.
826 **AllowNonRFC953Hostnames** **0**|**1**::
827 When this option is disabled, Tor blocks hostnames containing illegal
828 characters (like @ and :) rather than sending them to an exit node to be
829 resolved. This helps trap accidental attempts to resolve URLs and so on.
832 **AllowDotExit** **0**|**1**::
833 If enabled, we convert "www.google.com.foo.exit" addresses on the
834 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
835 the node "foo". Disabled by default since attacking websites and exit
836 relays can use it to manipulate your path selection. (Default: 0)
838 **FastFirstHopPK** **0**|**1**::
839 When this option is disabled, Tor uses the public key step for the first
840 hop of creating circuits. Skipping it is generally safe since we have
841 already used TLS to authenticate the relay and to establish forward-secure
842 keys. Turning this option off makes circuit building slower. +
844 Note that Tor will always use the public key step for the first hop if it's
845 operating as a relay, and it will never use the public key step if it
846 doesn't yet know the onion key of the first hop. (Default: 1)
848 **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
849 Open this port to listen for transparent proxy connections. Set this to
850 0 if you don't want to allow transparent proxy connections. Set the port
851 to "auto" to have Tor pick a port for you. This directive can be
852 specified multiple times to bind to multiple addresses/ports. See
853 SOCKSPort for an explanation of isolation flags. +
855 TransPort requires OS support for transparent proxies, such as BSDs' pf or
856 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
857 a network, you'll want to examine and change VirtualAddrNetwork from the
858 default setting. You'll also want to set the TransListenAddress option for
859 the network you'd like to proxy. (Default: 0).
861 **TransListenAddress** __IP__[:__PORT__]::
862 Bind to this address to listen for transparent proxy connections. (Default:
863 127.0.0.1). This is useful for exporting a transparent proxy server to an
864 entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
865 now use multiple TransPort entries, and provide addresses for TransPort
866 entries, so TransListenAddress no longer has a purpose. For backward
867 compatibility, TransListenAddress is only allowed when TransPort is just
870 **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
871 Open this port to listen for connections from old versions of ipfw (as
872 included in old versions of FreeBSD, etc) using the NATD protocol.
873 Use 0 if you don't want to allow NATD connections. Set the port
874 to "auto" to have Tor pick a port for you. This directive can be
875 specified multiple times to bind to multiple addresses/ports. See
876 SOCKSPort for an explanation of isolation flags. +
878 This option is only for people who cannot use TransPort. (Default: 0)
880 **NATDListenAddress** __IP__[:__PORT__]::
881 Bind to this address to listen for NATD connections. (DEPRECATED: As of
882 0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
883 addresses for NATDPort entries, so NATDListenAddress no longer has a
884 purpose. For backward compatibility, NATDListenAddress is only allowed
885 when NATDPort is just a port number.)
887 **AutomapHostsOnResolve** **0**|**1**::
888 When this option is enabled, and we get a request to resolve an address
889 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
890 unused virtual address to that address, and return the new virtual address.
891 This is handy for making ".onion" addresses work with applications that
892 resolve an address and then connect to it. (Default: 0).
894 **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
895 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
896 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
898 **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
899 If non-zero, open this port to listen for UDP DNS requests, and resolve
900 them anonymously. Set the port to "auto" to have Tor pick a port for
901 you. This directive can be specified multiple times to bind to multiple
902 addresses/ports. See SOCKSPort for an explanation of isolation
905 **DNSListenAddress** __IP__[:__PORT__]::
906 Bind to this address to listen for DNS connections. (DEPRECATED: As of
907 0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
908 addresses for DNSPort entries, so DNSListenAddress no longer has a
909 purpose. For backward compatibility, DNSListenAddress is only allowed
910 when DNSPort is just a port number.)
912 **ClientDNSRejectInternalAddresses** **0**|**1**::
913 If true, Tor does not believe any anonymously retrieved DNS answer that
914 tells it that an address resolves to an internal address (like 127.0.0.1 or
915 192.168.0.1). This option prevents certain browser-based attacks; don't
916 turn it off unless you know what you're doing. (Default: 1).
918 **ClientRejectInternalAddresses** **0**|**1**::
919 If true, Tor does not try to fulfill requests to connect to an internal
920 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
921 specifically requested__ (for example, via a .exit hostname, or a
922 controller request). (Default: 1).
924 **DownloadExtraInfo** **0**|**1**::
925 If true, Tor downloads and caches "extra-info" documents. These documents
926 contain information about servers other than the information in their
927 regular router descriptors. Tor does not use this information for anything
928 itself; to save bandwidth, leave this option turned off. (Default: 0).
930 **FallbackNetworkstatusFile** __FILENAME__::
931 If Tor doesn't have a cached networkstatus file, it starts out using this
932 one instead. Even if this file is out of date, Tor can still use it to
933 learn about directory mirrors, so it doesn't need to put load on the
934 authorities. (Default: None).
936 **WarnPlaintextPorts** __port__,__port__,__...__::
937 Tells Tor to issue a warnings whenever the user tries to make an anonymous
938 connection to one of these ports. This option is designed to alert users
939 to services that risk sending passwords in the clear. (Default:
942 **RejectPlaintextPorts** __port__,__port__,__...__::
943 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
944 will instead refuse to make the connection. (Default: None).
946 **AllowSingleHopCircuits** **0**|**1**::
947 When this option is set, the attached Tor controller can use relays
948 that have the **AllowSingleHopExits** option turned on to build
949 one-hop Tor connections. (Default: 0)
951 **OptimisticData** **0**|**1**|**auto**::
952 When this option is set, and Tor is using an exit node that supports
953 the feature, it will try optimistically to send data to the exit node
954 without waiting for the exit node to report whether the connection
955 succeeded. This can save a round-trip time for protocols like HTTP
956 where the client talks first. If OptimisticData is set to **auto**,
957 Tor will look at the UseOptimisticData parameter in the networkstatus.
964 The following options are useful only for servers (that is, if ORPort
967 **Address** __address__::
968 The IP address or fully qualified domain name of this server (e.g.
969 moria.mit.edu). You can leave this unset, and Tor will guess your IP
970 address. This IP address is the one used to tell clients and other
971 servers where to find your Tor server; it doesn't affect the IP that your
972 Tor client binds to. To bind to a different address, use the
973 *ListenAddress and OutboundBindAddress options.
975 **AllowSingleHopExits** **0**|**1**::
976 This option controls whether clients can use this server as a single hop
977 proxy. If set to 1, clients can use this server as an exit even if it is
978 the only hop in the circuit. Note that most clients will refuse to use
979 servers that set this option, since most clients have
980 ExcludeSingleHopRelays set. (Default: 0)
982 **AssumeReachable** **0**|**1**::
983 This option is used when bootstrapping a new Tor network. If set to 1,
984 don't do self-reachability testing; just upload your server descriptor
985 immediately. If **AuthoritativeDirectory** is also set, this option
986 instructs the dirserver to bypass remote reachability testing too and list
987 all connected servers as running.
989 **BridgeRelay** **0**|**1**::
990 Sets the relay to act as a "bridge" with respect to relaying connections
991 from bridge users to the Tor network. It mainly causes Tor to publish a
992 server descriptor to the bridge database, rather than publishing a relay
993 descriptor to the public directory authorities.
995 **ContactInfo** __email_address__::
996 Administrative contact information for server. This line might get picked
997 up by spam harvesters, so you may want to obscure the fact that it's an
1000 **ExitPolicy** __policy__,__policy__,__...__::
1001 Set an exit policy for this server. Each policy is of the form
1002 "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1003 omitted then this policy just applies to the host given. Instead of giving
1004 a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
1005 __PORT__ can be a single port number, an interval of ports
1006 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1009 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1010 reject any traffic destined for MIT except for web.mit.edu, and accept
1013 To specify all internal and link-local networks (including 0.0.0.0/8,
1014 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
1015 172.16.0.0/12), you can use the "private" alias instead of an address.
1016 These addresses are rejected by default (at the beginning of your exit
1017 policy), along with your public IP address, unless you set the
1018 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1019 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1020 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1021 may also allow connections to your own computer that are addressed to its
1022 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1023 about internal and reserved IP address space. +
1025 This directive can be specified multiple times so you don't have to put it
1028 Policies are considered first to last, and the first match wins. If you
1029 want to \_replace_ the default exit policy, end your exit policy with
1030 either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
1031 (prepending to) the default exit policy. The default exit policy is: +
1045 **ExitPolicyRejectPrivate** **0**|**1**::
1046 Reject all private (local) networks, along with your own public IP address,
1047 at the beginning of your exit policy. See above entry on ExitPolicy.
1050 **MaxOnionsPending** __NUM__::
1051 If you have more than this number of onionskins queued for decrypt, reject
1052 new ones. (Default: 100)
1054 **MyFamily** __node__,__node__,__...__::
1055 Declare that this Tor server is controlled or administered by a group or
1056 organization identical or similar to that of the other servers, defined by
1057 their identity fingerprints or nicknames. When two servers both declare
1058 that they are in the same \'family', Tor clients will not use them in the
1059 same circuit. (Each server only needs to list the other servers in its
1060 family; it doesn't need to list itself, but it won't hurt.)
1062 **Nickname** __name__::
1063 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1064 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1066 **NumCPUs** __num__::
1067 How many processes to use at once for decrypting onionskins and other
1068 parallelizable operations. If this is set to 0, Tor will try to detect
1069 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1071 **ORPort** __PORT__|**auto**::
1072 Advertise this port to listen for connections from Tor clients and
1073 servers. This option is required to be a Tor server.
1074 Set it to "auto" to have Tor pick a port for you. (Default: 0).
1076 **ORListenAddress** __IP__[:__PORT__]::
1077 Bind to this IP address to listen for connections from Tor clients and
1078 servers. If you specify a port, bind to this port rather than the one
1079 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
1080 multiple times to bind to multiple addresses/ports.
1082 **PortForwarding** **0**|**1**::
1083 Attempt to automatically forward the DirPort and ORPort on a NAT router
1084 connecting this Tor server to the Internet. If set, Tor will try both
1085 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1086 manufacturers). (Default: 0)
1088 **PortForwardingHelper** __filename__|__pathname__::
1089 If PortForwarding is set, use this executable to configure the forwarding.
1090 If set to a filename, the system path will be searched for the executable.
1091 If set to a path, only the specified path will be executed.
1092 (Default: tor-fw-helper)
1094 **PublishServerDescriptor** **0**|**1**|**v1**|**v2**|**v3**|**bridge**,**...**::
1095 This option specifies which descriptors Tor will publish when acting as
1097 choose multiple arguments, separated by commas.
1099 If this option is set to 0, Tor will not publish its
1100 descriptors to any directories. (This is useful if you're testing
1101 out your server, or if you're using a Tor controller that handles directory
1102 publishing for you.) Otherwise, Tor will publish its descriptors of all
1103 type(s) specified. The default is "1",
1104 which means "if running as a server, publish the
1105 appropriate descriptors to the authorities".
1107 **ShutdownWaitLength** __NUM__::
1108 When we get a SIGINT and we're a server, we begin shutting down:
1109 we close listeners and start refusing new circuits. After **NUM**
1110 seconds, we exit. If we get a second SIGINT, we exit immedi-
1111 ately. (Default: 30 seconds)
1113 **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1114 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1115 a log level __info__ message, designed to let you know your Tor
1116 server is still alive and doing useful things. Settings this
1117 to 0 will disable the heartbeat. (Default: 6 hours)
1119 **AccountingMax** __N__ **bytes**|**KB**|**MB**|**GB**|**TB**::
1120 Never send more than the specified number of bytes in a given accounting
1121 period, or receive more than that number in the period. For example, with
1122 AccountingMax set to 1 GB, a server could send 900 MB and receive 800 MB
1123 and continue running. It will only hibernate once one of the two reaches 1
1124 GB. When the number of bytes gets low, Tor will stop accepting new
1125 connections and circuits. When the number of bytes
1126 is exhausted, Tor will hibernate until some
1127 time in the next accounting period. To prevent all servers from waking at
1128 the same time, Tor will also wait until a random point in each period
1129 before waking up. If you have bandwidth cost issues, enabling hibernation
1130 is preferable to setting a low bandwidth, since it provides users with a
1131 collection of fast servers that are up some of the time, which is more
1132 useful than a set of slow servers that are always "available".
1134 **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1135 Specify how long accounting periods last. If **month** is given, each
1136 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1137 month to the same day and time of the next. (The day must be between 1 and
1138 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1139 of the __dayth__ day of one week to the same day and time of the next week,
1140 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1141 accounting period runs from the time __HH:MM__ each day to the same time on
1142 the next day. All times are local, and given in 24-hour time. (Defaults to
1145 **RefuseUnknownExits** **0**|**1**|**auto**::
1146 Prevent nodes that don't appear in the consensus from exiting using this
1147 relay. If the option is 1, we always block exit attempts from such
1148 nodes; if it's 0, we never do, and if the option is "auto", then we do
1149 whatever the authorities suggest in the consensus. (Defaults to auto.)
1151 **ServerDNSResolvConfFile** __filename__::
1152 Overrides the default DNS configuration with the configuration in
1153 __filename__. The file format is the same as the standard Unix
1154 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1155 only affects name lookups that your server does on behalf of clients.
1156 (Defaults to use the system DNS configuration.)
1158 **ServerDNSAllowBrokenConfig** **0**|**1**::
1159 If this option is false, Tor exits immediately if there are problems
1160 parsing the system DNS configuration or connecting to nameservers.
1161 Otherwise, Tor continues to periodically retry the system nameservers until
1162 it eventually succeeds. (Defaults to "1".)
1164 **ServerDNSSearchDomains** **0**|**1**::
1165 If set to 1, then we will search for addresses in the local search domain.
1166 For example, if this system is configured to believe it is in
1167 "example.com", and a client tries to connect to "www", the client will be
1168 connected to "www.example.com". This option only affects name lookups that
1169 your server does on behalf of clients. (Defaults to "0".)
1171 **ServerDNSDetectHijacking** **0**|**1**::
1172 When this option is set to 1, we will test periodically to determine
1173 whether our local nameservers have been configured to hijack failing DNS
1174 requests (usually to an advertising site). If they are, we will attempt to
1175 correct this. This option only affects name lookups that your server does
1176 on behalf of clients. (Defaults to "1".)
1178 **ServerDNSTestAddresses** __address__,__address__,__...__::
1179 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1180 aren't getting redirected. If they are, then our DNS is completely useless,
1181 and we'll reset our exit policy to "reject *:*". This option only affects
1182 name lookups that your server does on behalf of clients. (Defaults to
1183 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org".)
1185 **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1186 When this option is disabled, Tor does not try to resolve hostnames
1187 containing illegal characters (like @ and :) rather than sending them to an
1188 exit node to be resolved. This helps trap accidental attempts to resolve
1189 URLs and so on. This option only affects name lookups that your server does
1190 on behalf of clients. (Default: 0)
1192 **BridgeRecordUsageByCountry** **0**|**1**::
1193 When this option is enabled and BridgeRelay is also enabled, and we have
1194 GeoIP data, Tor keeps a keep a per-country count of how many client
1195 addresses have contacted it so that it can help the bridge authority guess
1196 which countries have blocked access to it. (Default: 1)
1198 **ServerDNSRandomizeCase** **0**|**1**::
1199 When this option is set, Tor sets the case of each character randomly in
1200 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1201 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1202 For more information, see "Increased DNS Forgery Resistance through
1203 0x20-Bit Encoding". This option only affects name lookups that your server
1204 does on behalf of clients. (Default: 1)
1206 **GeoIPFile** __filename__::
1207 A filename containing GeoIP data, for use with BridgeRecordUsageByCountry.
1209 **CellStatistics** **0**|**1**::
1210 When this option is enabled, Tor writes statistics on the mean time that
1211 cells spend in circuit queues to disk every 24 hours. (Default: 0)
1213 **DirReqStatistics** **0**|**1**::
1214 When this option is enabled, Tor writes statistics on the number and
1215 response time of network status requests to disk every 24 hours.
1218 **EntryStatistics** **0**|**1**::
1219 When this option is enabled, Tor writes statistics on the number of
1220 directly connecting clients to disk every 24 hours. (Default: 0)
1222 **ExitPortStatistics** **0**|**1**::
1223 When this option is enabled, Tor writes statistics on the number of relayed
1224 bytes and opened stream per exit port to disk every 24 hours. (Default: 0)
1226 **ConnDirectionStatistics** **0**|**1**::
1227 When this option is enabled, Tor writes statistics on the bidirectional use
1228 of connections to disk every 24 hours. (Default: 0)
1230 **ExtraInfoStatistics** **0**|**1**::
1231 When this option is enabled, Tor includes previously gathered statistics in
1232 its extra-info documents that it uploads to the directory authorities.
1235 DIRECTORY SERVER OPTIONS
1236 ------------------------
1238 The following options are useful only for directory servers (that is,
1239 if DirPort is non-zero):
1241 **AuthoritativeDirectory** **0**|**1**::
1242 When this option is set to 1, Tor operates as an authoritative directory
1243 server. Instead of caching the directory, it generates its own list of
1244 good servers, signs it, and sends that to the clients. Unless the clients
1245 already have you listed as a trusted directory, you probably do not want
1246 to set this option. Please coordinate with the other admins at
1247 tor-ops@torproject.org if you think you should be a directory.
1249 **DirPortFrontPage** __FILENAME__::
1250 When this option is set, it takes an HTML file and publishes it as "/" on
1251 the DirPort. Now relay operators can provide a disclaimer without needing
1252 to set up a separate webserver. There's a sample disclaimer in
1253 contrib/tor-exit-notice.html.
1255 **V1AuthoritativeDirectory** **0**|**1**::
1256 When this option is set in addition to **AuthoritativeDirectory**, Tor
1257 generates version 1 directory and running-routers documents (for legacy
1258 Tor clients up to 0.1.0.x).
1260 **V2AuthoritativeDirectory** **0**|**1**::
1261 When this option is set in addition to **AuthoritativeDirectory**, Tor
1262 generates version 2 network statuses and serves descriptors, etc as
1263 described in doc/spec/dir-spec-v2.txt (for Tor clients and servers running
1264 0.1.1.x and 0.1.2.x).
1266 **V3AuthoritativeDirectory** **0**|**1**::
1267 When this option is set in addition to **AuthoritativeDirectory**, Tor
1268 generates version 3 network statuses and serves descriptors, etc as
1269 described in doc/spec/dir-spec.txt (for Tor clients and servers running at
1272 **VersioningAuthoritativeDirectory** **0**|**1**::
1273 When this option is set to 1, Tor adds information on which versions of
1274 Tor are still believed safe for use to the published directory. Each
1275 version 1 authority is automatically a versioning authority; version 2
1276 authorities provide this service optionally. See **RecommendedVersions**,
1277 **RecommendedClientVersions**, and **RecommendedServerVersions**.
1279 **NamingAuthoritativeDirectory** **0**|**1**::
1280 When this option is set to 1, then the server advertises that it has
1281 opinions about nickname-to-fingerprint bindings. It will include these
1282 opinions in its published network-status pages, by listing servers with
1283 the flag "Named" if a correct binding between that nickname and fingerprint
1284 has been registered with the dirserver. Naming dirservers will refuse to
1285 accept or publish descriptors that contradict a registered binding. See
1286 **approved-routers** in the **FILES** section below.
1288 **HSAuthoritativeDir** **0**|**1**::
1289 When this option is set in addition to **AuthoritativeDirectory**, Tor also
1290 accepts and serves v0 hidden service descriptors,
1291 which are produced and used by Tor 0.2.1.x and older. (Default: 0)
1293 **HidServDirectoryV2** **0**|**1**::
1294 When this option is set, Tor accepts and serves v2 hidden service
1295 descriptors. Setting DirPort is not required for this, because clients
1296 connect via the ORPort by default. (Default: 1)
1298 **BridgeAuthoritativeDir** **0**|**1**::
1299 When this option is set in addition to **AuthoritativeDirectory**, Tor
1300 accepts and serves router descriptors, but it caches and serves the main
1301 networkstatus documents rather than generating its own. (Default: 0)
1303 **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1304 Minimum uptime of a v2 hidden service directory to be accepted as such by
1305 authoritative directories. (Default: 25 hours)
1307 **DirPort** __PORT__|**auto**::
1308 If this option is nonzero, advertise the directory service on this port.
1309 Set it to "auto" to have Tor pick a port for you. (Default: 0)
1311 **DirListenAddress** __IP__[:__PORT__]::
1312 Bind the directory service to this address. If you specify a port, bind to
1313 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
1314 This directive can be specified multiple times to bind to multiple
1317 **DirPolicy** __policy__,__policy__,__...__::
1318 Set an entrance policy for this server, to limit who can connect to the
1319 directory ports. The policies have the same form as exit policies above.
1321 **FetchV2Networkstatus** **0**|**1**::
1322 If set, we try to fetch the (obsolete, unused) version 2 network status
1323 consensus documents from the directory authorities. No currently
1324 supported Tor version uses them. (Default: 0.)
1327 DIRECTORY AUTHORITY SERVER OPTIONS
1328 ----------------------------------
1330 **RecommendedVersions** __STRING__::
1331 STRING is a comma-separated list of Tor versions currently believed to be
1332 safe. The list is included in each directory, and nodes which pull down the
1333 directory learn whether they need to upgrade. This option can appear
1334 multiple times: the values from multiple lines are spliced together. When
1335 this is set then **VersioningAuthoritativeDirectory** should be set too.
1337 **RecommendedClientVersions** __STRING__::
1338 STRING is a comma-separated list of Tor versions currently believed to be
1339 safe for clients to use. This information is included in version 2
1340 directories. If this is not set then the value of **RecommendedVersions**
1341 is used. When this is set then **VersioningAuthoritativeDirectory** should
1344 **RecommendedServerVersions** __STRING__::
1345 STRING is a comma-separated list of Tor versions currently believed to be
1346 safe for servers to use. This information is included in version 2
1347 directories. If this is not set then the value of **RecommendedVersions**
1348 is used. When this is set then **VersioningAuthoritativeDirectory** should
1351 **ConsensusParams** __STRING__::
1352 STRING is a space-separated list of key=value pairs that Tor will include
1353 in the "params" line of its networkstatus vote.
1355 **DirAllowPrivateAddresses** **0**|**1**::
1356 If set to 1, Tor will accept router descriptors with arbitrary "Address"
1357 elements. Otherwise, if the address is not an IP address or is a private IP
1358 address, it will reject the router descriptor. Defaults to 0.
1360 **AuthDirBadDir** __AddressPattern...__::
1361 Authoritative directories only. A set of address patterns for servers that
1362 will be listed as bad directories in any network status document this
1363 authority publishes, if **AuthDirListBadDirs** is set.
1365 **AuthDirBadExit** __AddressPattern...__::
1366 Authoritative directories only. A set of address patterns for servers that
1367 will be listed as bad exits in any network status document this authority
1368 publishes, if **AuthDirListBadExits** is set.
1370 **AuthDirInvalid** __AddressPattern...__::
1371 Authoritative directories only. A set of address patterns for servers that
1372 will never be listed as "valid" in any network status document that this
1373 authority publishes.
1375 **AuthDirReject** __AddressPattern__...::
1376 Authoritative directories only. A set of address patterns for servers that
1377 will never be listed at all in any network status document that this
1378 authority publishes, or accepted as an OR address in any descriptor
1379 submitted for publication by this authority.
1381 **AuthDirListBadDirs** **0**|**1**::
1382 Authoritative directories only. If set to 1, this directory has some
1383 opinion about which nodes are unsuitable as directory caches. (Do not set
1384 this to 1 unless you plan to list non-functioning directories as bad;
1385 otherwise, you are effectively voting in favor of every declared
1388 **AuthDirListBadExits** **0**|**1**::
1389 Authoritative directories only. If set to 1, this directory has some
1390 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
1391 1 unless you plan to list non-functioning exits as bad; otherwise, you are
1392 effectively voting in favor of every declared exit as an exit.)
1394 **AuthDirRejectUnlisted** **0**|**1**::
1395 Authoritative directories only. If set to 1, the directory server rejects
1396 all uploaded server descriptors that aren't explicitly listed in the
1397 fingerprints file. This acts as a "panic button" if we get hit with a Sybil
1398 attack. (Default: 0)
1400 **AuthDirMaxServersPerAddr** __NUM__::
1401 Authoritative directories only. The maximum number of servers that we will
1402 list as acceptable on a single IP address. Set this to "0" for "no limit".
1405 **AuthDirMaxServersPerAuthAddr** __NUM__::
1406 Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
1407 to addresses shared with directory authorities. (Default: 5)
1409 **BridgePassword** __Password__::
1410 If set, contains an HTTP authenticator that tells a bridge authority to
1411 serve all requested bridge information. Used for debugging. (Default:
1414 **V3AuthVotingInterval** __N__ **minutes**|**hours**::
1415 V3 authoritative directories only. Configures the server's preferred voting
1416 interval. Note that voting will __actually__ happen at an interval chosen
1417 by consensus from all the authorities' preferred intervals. This time
1418 SHOULD divide evenly into a day. (Default: 1 hour)
1420 **V3AuthVoteDelay** __N__ **minutes**|**hours**::
1421 V3 authoritative directories only. Configures the server's preferred delay
1422 between publishing its vote and assuming it has all the votes from all the
1423 other authorities. Note that the actual time used is not the server's
1424 preferred time, but the consensus of all preferences. (Default: 5 minutes.)
1426 **V3AuthDistDelay** __N__ **minutes**|**hours**::
1427 V3 authoritative directories only. Configures the server's preferred delay
1428 between publishing its consensus and signature and assuming it has all the
1429 signatures from all the other authorities. Note that the actual time used
1430 is not the server's preferred time, but the consensus of all preferences.
1431 (Default: 5 minutes.)
1433 **V3AuthNIntervalsValid** __NUM__::
1434 V3 authoritative directories only. Configures the number of VotingIntervals
1435 for which each consensus should be valid for. Choosing high numbers
1436 increases network partitioning risks; choosing low numbers increases
1437 directory traffic. Note that the actual number of intervals used is not the
1438 server's preferred number, but the consensus of all preferences. Must be at
1439 least 2. (Default: 3.)
1441 **V3BandwidthsFile** __FILENAME__::
1442 V3 authoritative directories only. Configures the location of the
1443 bandiwdth-authority generated file storing information on relays' measured
1444 bandwidth capacities. (Default: unset.)
1446 **V3AuthUseLegacyKey** **0**|**1**::
1447 If set, the directory authority will sign consensuses not only with its
1448 own signing key, but also with a "legacy" key and certificate with a
1449 different identity. This feature is used to migrate directory authority
1450 keys in the event of a compromise. (Default: 0.)
1452 **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1453 Tells an authority, or other node tracking node reliability and history,
1454 that fine-grained information about nodes can be discarded when it hasn't
1455 changed for a given amount of time. (Default: 24 hours)
1457 **VoteOnHidServDirectoriesV2** **0**|**1**::
1458 When this option is set in addition to **AuthoritativeDirectory**, Tor
1459 votes on whether to accept relays as hidden service directories.
1462 HIDDEN SERVICE OPTIONS
1463 ----------------------
1465 The following options are used to configure a hidden service.
1467 **HiddenServiceDir** __DIRECTORY__::
1468 Store data files for a hidden service in DIRECTORY. Every hidden service
1469 must have a separate directory. You may use this option multiple times to
1470 specify multiple services. DIRECTORY must be an existing directory.
1472 **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
1473 Configure a virtual port VIRTPORT for a hidden service. You may use this
1474 option multiple times; each time applies to the service using the most
1475 recent hiddenservicedir. By default, this option maps the virtual port to
1476 the same port on 127.0.0.1. You may override the target port, address, or
1477 both by specifying a target of addr, port, or addr:port. You may also have
1478 multiple lines with the same VIRTPORT: when a user connects to that
1479 VIRTPORT, one of the TARGETs from those lines will be chosen at random.
1481 **PublishHidServDescriptors** **0**|**1**::
1482 If set to 0, Tor will run any hidden services you configure, but it won't
1483 advertise them to the rendezvous directory. This option is only useful if
1484 you're using a Tor controller that handles hidserv publishing for you.
1487 **HiddenServiceVersion** __version__,__version__,__...__::
1488 A list of rendezvous service descriptor versions to publish for the hidden
1489 service. Currently, only version 2 is supported. (Default: 2)
1491 **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
1492 If configured, the hidden service is accessible for authorized clients
1493 only. The auth-type can either be \'basic' for a general-purpose
1494 authorization protocol or \'stealth' for a less scalable protocol that also
1495 hides service activity from unauthorized clients. Only clients that are
1496 listed here are authorized to access the hidden service. Valid client names
1497 are 1 to 19 characters long and only use characters in A-Za-z0-9+-_ (no
1498 spaces). If this option is set, the hidden service is not accessible for
1499 clients without authorization any more. Generated authorization data can be
1500 found in the hostname file. Clients need to put this authorization data in
1501 their configuration file using **HidServAuth**.
1503 **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1504 Every time the specified period elapses, Tor uploads any rendezvous
1505 service descriptors to the directory servers. This information is also
1506 uploaded whenever it changes. (Default: 1 hour)
1508 TESTING NETWORK OPTIONS
1509 -----------------------
1511 The following options are used for running a testing Tor network.
1513 **TestingTorNetwork** **0**|**1**::
1514 If set to 1, Tor adjusts default values of the configuration options below,
1515 so that it is easier to set up a testing Tor network. May only be set if
1516 non-default set of DirServers is set. Cannot be unset while Tor is running.
1519 ServerDNSAllowBrokenConfig 1
1520 DirAllowPrivateAddresses 1
1521 EnforceDistinctSubnets 0
1523 AuthDirMaxServersPerAddr 0
1524 AuthDirMaxServersPerAuthAddr 0
1525 ClientDNSRejectInternalAddresses 0
1526 ClientRejectInternalAddresses 0
1527 CountPrivateBandwidth 1
1528 ExitPolicyRejectPrivate 0
1529 V3AuthVotingInterval 5 minutes
1530 V3AuthVoteDelay 20 seconds
1531 V3AuthDistDelay 20 seconds
1532 MinUptimeHidServDirectoryV2 0 seconds
1533 TestingV3AuthInitialVotingInterval 5 minutes
1534 TestingV3AuthInitialVoteDelay 20 seconds
1535 TestingV3AuthInitialDistDelay 20 seconds
1536 TestingAuthDirTimeToLearnReachability 0 minutes
1537 TestingEstimatedDescriptorPropagationTime 0 minutes
1539 **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
1540 Like V3AuthVotingInterval, but for initial voting interval before the first
1541 consensus has been created. Changing this requires that
1542 **TestingTorNetwork** is set. (Default: 30 minutes)
1544 **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
1545 Like TestingV3AuthInitialVoteDelay, but for initial voting interval before
1546 the first consensus has been created. Changing this requires that
1547 **TestingTorNetwork** is set. (Default: 5 minutes)
1549 **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
1550 Like TestingV3AuthInitialDistDelay, but for initial voting interval before
1551 the first consensus has been created. Changing this requires that
1552 **TestingTorNetwork** is set. (Default: 5 minutes)
1554 **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
1555 After starting as an authority, do not make claims about whether routers
1556 are Running until this much time has passed. Changing this requires
1557 that **TestingTorNetwork** is set. (Default: 30 minutes)
1559 **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
1560 Clients try downloading router descriptors from directory caches after this
1561 time. Changing this requires that **TestingTorNetwork** is set. (Default:
1567 Tor catches the following signals:
1570 Tor will catch this, clean up and sync to disk if necessary, and exit.
1573 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
1574 slow shutdown, closing listeners and waiting 30 seconds before exiting.
1575 (The delay can be configured with the ShutdownWaitLength config option.)
1578 The signal instructs Tor to reload its configuration (including closing and
1579 reopening logs), and kill and restart its helper processes if applicable.
1582 Log statistics about current connections, past connections, and throughput.
1585 Switch all logs to loglevel debug. You can go back to the old loglevels by
1589 Tor receives this signal when one of its helper processes has exited, so it
1593 Tor catches this signal and ignores it.
1596 If this signal exists on your platform, Tor catches and ignores it.
1601 **@CONFDIR@/torrc**::
1602 The configuration file, which contains "option value" pairs.
1604 **@LOCALSTATEDIR@/lib/tor/**::
1605 The tor process stores keys and other data here.
1607 __DataDirectory__**/cached-status/**::
1608 The most recently downloaded network status document for each authority.
1609 Each file holds one such document; the filenames are the hexadecimal
1610 identity key fingerprints of the directory authorities.
1612 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
1613 These files hold downloaded router statuses. Some routers may appear more
1614 than once; if so, the most recently published descriptor is used. Lines
1615 beginning with @-signs are annotations that contain more information about
1616 a given router. The ".new" file is an append-only journal; when it gets
1617 too large, all entries are merged into a new cached-descriptors file.
1619 __DataDirectory__**/cached-routers** and **cached-routers.new**::
1620 Obsolete versions of cached-descriptors and cached-descriptors.new. When
1621 Tor can't find the newer files, it looks here instead.
1623 __DataDirectory__**/state**::
1624 A set of persistent key-value mappings. These are documented in
1625 the file. These include:
1626 - The current entry guards and their status.
1627 - The current bandwidth accounting values (unused so far; see
1629 - When the file was last written
1630 - What version of Tor generated the state file
1631 - A short history of bandwidth usage, as produced in the router
1634 __DataDirectory__**/bw_accounting**::
1635 Used to track bandwidth accounting values (when the current period starts
1636 and ends; how much has been read and written so far this period). This file
1637 is obsolete, and the data is now stored in the \'state' file as well. Only
1638 used when bandwidth accounting is enabled.
1640 __DataDirectory__**/control_auth_cookie**::
1641 Used for cookie authentication with the controller. Location can be
1642 overridden by the CookieAuthFile config option. Regenerated on startup. See
1643 control-spec.txt for details. Only used when cookie authentication is
1646 __DataDirectory__**/keys/***::
1647 Only used by servers. Holds identity keys and onion keys.
1649 __DataDirectory__**/fingerprint**::
1650 Only used by servers. Holds the fingerprint of the server's identity key.
1652 __DataDirectory__**/approved-routers**::
1653 Only for naming authoritative directory servers (see
1654 **NamingAuthoritativeDirectory**). This file lists nickname to identity
1655 bindings. Each line lists a nickname and a fingerprint separated by
1656 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
1657 example line. If the nickname is **!reject** then descriptors from the
1658 given identity (fingerprint) are rejected by this server. If it is
1659 **!invalid** then descriptors are accepted but marked in the directory as
1660 not valid, that is, not recommended.
1662 __DataDirectory__**/router-stability**::
1663 Only used by authoritative directory servers. Tracks measurements for
1664 router mean-time-between-failures so that authorities have a good idea of
1665 how to set their Stable flags.
1667 __HiddenServiceDirectory__**/hostname**::
1668 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
1669 If the hidden service is restricted to authorized clients only, this file
1670 also contains authorization data for all clients.
1672 __HiddenServiceDirectory__**/private_key**::
1673 The private key for this hidden service.
1675 __HiddenServiceDirectory__**/client_keys**::
1676 Authorization data for a hidden service that is only accessible by
1681 **privoxy**(1), **tsocks**(1), **torify**(1) +
1683 **https://www.torproject.org/**
1689 Plenty, probably. Tor is still in development. Please report them.
1693 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].