tor.1.in 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516
  1. .TH TOR 1 "February 2008" "TOR"
  2. .SH NAME
  3. tor \- The second-generation onion router
  4. .SH SYNOPSIS
  5. .B tor
  6. [\fIOPTION value\fR]...
  7. .SH DESCRIPTION
  8. .I tor
  9. is a connection-oriented anonymizing communication
  10. service. Users choose a source-routed path through a set of nodes, and
  11. negotiate a "virtual circuit" through the network, in which each node
  12. knows its predecessor and successor, but no others. Traffic flowing down
  13. the circuit is unwrapped by a symmetric key at each node, which reveals
  14. the downstream node.
  15. .PP
  16. Basically \fItor\fR provides a distributed network of servers ("onion
  17. routers"). Users bounce their TCP streams -- web traffic, ftp, ssh, etc --
  18. around the routers, and recipients, observers, and even the routers
  19. themselves have difficulty tracking the source of the stream.
  20. .SH OPTIONS
  21. \fB-h, -help\fP
  22. Display a short help message and exit.
  23. .LP
  24. .TP
  25. \fB-f \fR\fIFILE\fP
  26. FILE contains further "option value" pairs. (Default: @CONFDIR@/torrc)
  27. .LP
  28. .TP
  29. \fB--hash-password\fP
  30. Generates a hashed password for control port access.
  31. .LP
  32. .TP
  33. \fB--list-fingerprint\fP
  34. Generate your keys and output your nickname and fingerprint.
  35. .LP
  36. .TP
  37. \fB--verify-config\fP
  38. Verify the configuration file is valid.
  39. .LP
  40. .TP
  41. \fB--nt-service\fP
  42. \fB--service [install|remove|start|stop]\fP
  43. Manage the Tor Windows NT/2000/XP service. Current instructions can
  44. be found at http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#WinNTService
  45. .LP
  46. .TP
  47. \fB--list-torrc-options\fP
  48. List all valid options.
  49. .LP
  50. .TP
  51. \fB--version\fP
  52. Display Tor version and exit.
  53. .LP
  54. .TP
  55. \fB--quiet\fP
  56. Do not start Tor with a console log unless explicitly requested to do
  57. so. (By default, Tor starts out logging messages at level "notice" or
  58. higher to the console, until it has parsed its configuration.)
  59. .LP
  60. .TP
  61. Other options can be specified either on the command-line (\fI--option
  62. value\fR), or in the configuration file (\fIoption value\fR or
  63. \fIoption "value"\fR). Options are case-insensitive. C-style escaped
  64. characters are allowed inside quoted values.
  65. .LP
  66. .TP
  67. \fBBandwidthRate \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  68. A token bucket limits the average incoming bandwidth usage on this node
  69. to the specified number of bytes per second, and the average outgoing
  70. bandwidth usage to that same value. (Default: 5 MB)
  71. .LP
  72. .TP
  73. \fBBandwidthBurst \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  74. Limit the maximum token bucket size (also known as the burst) to the
  75. given number of bytes in each direction. (Default: 10 MB)
  76. .LP
  77. .TP
  78. \fBMaxAdvertisedBandwidth \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  79. If set, we will not advertise more than this amount of bandwidth for our
  80. BandwidthRate. Server operators who want to reduce the number of clients
  81. who ask to build circuits through them (since this is proportional to
  82. advertised bandwidth rate) can thus reduce the CPU demands on their
  83. server without impacting network performance.
  84. .LP
  85. .TP
  86. \fBRelayBandwidthRate \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  87. If defined, a separate token bucket limits the average incoming bandwidth
  88. usage for _relayed traffic_ on this node to the specified number of
  89. bytes per second, and the average outgoing bandwidth usage to that same
  90. value. Relayed traffic currently is calculated to include answers to directory
  91. requests, but that may change in future versions. (Default: 0)
  92. .LP
  93. .TP
  94. \fBRelayBandwidthBurst \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  95. Limit the maximum token bucket size (also known as the burst) for
  96. _relayed traffic_ to the
  97. given number of bytes in each direction. (Default: 0)
  98. .LP
  99. .TP
  100. \fBConnLimit \fR\fINUM\fP
  101. The minimum number of file descriptors that must be available to
  102. the Tor process before it will start. Tor will ask the OS for as
  103. many file descriptors as the OS will allow (you can find this
  104. by "ulimit -H -n"). If this number is less than ConnLimit, then
  105. Tor will refuse to start.
  106. You probably don't need to adjust this. It has no effect on
  107. Windows since that platform lacks getrlimit(). (Default: 1000)
  108. .LP
  109. .TP
  110. \fBConstrainedSockets \fR\fB0\fR|\fB1\fR\fP
  111. If set, Tor will tell the kernel to attempt to shrink the buffers for all
  112. sockets to the size specified in \fBConstrainedSockSize\fP. This is useful
  113. for virtual servers and other environments where system level TCP
  114. buffers may be limited. If you're on a virtual server, and you
  115. encounter the "Error creating network
  116. socket: No buffer space available" message, you are likely experiencing
  117. this problem.
  118. The preferred solution is to have the admin increase the buffer pool for
  119. the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility; this
  120. configuration option is a second-resort.
  121. The DirPort option should also not be used if TCP buffers are scarce. The
  122. cached directory requests consume additional sockets which exacerbates the
  123. problem.
  124. You should \fBnot\fP enable this feature unless you encounter the "no buffer
  125. space available" issue. Reducing the TCP buffers affects window size for
  126. the TCP stream and will reduce throughput in proportion to round trip
  127. time on long paths. (Default: 0.)
  128. .LP
  129. .TP
  130. \fBConstrainedSockSize \fR\fIN\fR \fBbytes\fR|\fBKB\fP
  131. When \fBConstrainedSockets\fP is enabled the receive and transmit buffers for
  132. all sockets will be set to this limit. Must be a value between 2048
  133. and 262144, in 1024 byte increments. Default of 8192 is recommended.
  134. .LP
  135. .TP
  136. \fBControlPort \fR\fIPort\fP
  137. If set, Tor will accept connections on this port and allow those
  138. connections to control the Tor process using the Tor Control Protocol
  139. (described in control-spec.txt). Note: unless you also specify one of
  140. \fBHashedControlPassword\fP or \fBCookieAuthentication\fP, setting
  141. this option will cause Tor to allow any process on the local host to
  142. control it. This option is required for many Tor controllers; most use
  143. the value of 9051.
  144. .LP
  145. .TP
  146. \fBControlListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  147. Bind the controller listener to this address. If you specify a port,
  148. bind to this port rather than the one specified in ControlPort. We
  149. strongly recommend that you leave this alone unless you know what you're
  150. doing, since giving attackers access to your control listener is really
  151. dangerous. (Default: 127.0.0.1)
  152. This directive can be specified multiple times to bind to multiple
  153. addresses/ports.
  154. .LP
  155. .TP
  156. \fBControlSocket \fR\fIPath\fP
  157. Like ControlPort, but listens on a Unix domain socket, rather than a TCP
  158. socket. (Unix and Unix-like systems only.)
  159. .LP
  160. .TP
  161. \fBHashedControlPassword \fR\fIhashed_password\fP
  162. Don't allow any connections on the control port except when the other process
  163. knows the password whose one-way hash is \fIhashed_password\fP. You can
  164. compute the hash of a password by running "tor --hash-password
  165. \fIpassword\fP". You can provide several acceptable passwords by using
  166. more than HashedControlPassword line.
  167. .LP
  168. .TP
  169. \fBCookieAuthentication \fR\fB0\fR|\fB1\fP
  170. If this option is set to 1, don't allow any connections on the control port
  171. except when the connecting process knows the contents of a file named
  172. "control_auth_cookie", which Tor will create in its data directory. This
  173. authentication method should only be used on systems with good filesystem
  174. security. (Default: 0)
  175. .LP
  176. .TP
  177. \fBCookieAuthFile \fR\fIPath\fP
  178. If set, this option overrides the default location and file name for Tor's
  179. cookie file. (See CookieAuthentication above.)
  180. .LP
  181. .TP
  182. \fBCookieAuthFileGroupReadable \fR\fB0\fR|\fB1\fR|\fIGroupName\fP
  183. If this option is set to 0, don't allow the filesystem group to read
  184. the cookie file. If the option is set to 1, make the cookie file
  185. readable by the default GID. [Making the file readable by other
  186. groups is not yet implemented; let us know if you need this for some
  187. reason.] (Default: 0).
  188. .LP
  189. .TP
  190. \fBDataDirectory \fR\fIDIR\fP
  191. Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
  192. .LP
  193. .TP
  194. \fBDirServer \fR[\fInickname\fR] [\fBflags\fR] \fIaddress\fR\fB:\fIport fingerprint\fP
  195. Use a nonstandard authoritative directory server at the provided
  196. address and port, with the specified key fingerprint. This option can
  197. be repeated many times, for multiple authoritative directory
  198. servers. Flags are separated by spaces, and determine what kind of an
  199. authority this directory is. By default, every authority is authoritative
  200. 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
  201. authority for old-style (v1) directories as well. (Only directory mirrors
  202. care about this.) Tor will use this server as an authority for hidden
  203. service information if the "hs" flag is set, or if the "v1" flag is set and
  204. the "no-hs" flag is \fBnot\fP set. Tor will use this authority as a bridge
  205. authoritative directory if the "bridge" flag is set. If a flag
  206. "orport=\fBport\fR" is given, Tor will use the given port when opening
  207. encrypted tunnels to the dirserver. Lastly, if a flag "v3ident=\fBfp\fR" is
  208. given, the dirserver is a v3 directory authority whose v3 long-term
  209. signing key has the fingerprint \fBfp\fR.
  210. If no \fBdirserver\fP line is given, Tor will use the default
  211. directory servers. NOTE: this option is intended
  212. for setting up a private Tor network with its own directory authorities. If
  213. you use it, you will be distinguishable from other users, because you won't
  214. believe the same authorities they do.
  215. .LP
  216. .TP
  217. \fBAlternateDirAuthority \fR[\fInickname\fR] [\fBflags\fR] \fIaddress\fR\fB:\fIport fingerprint\fP
  218. .LP
  219. .TP
  220. \fBAlternateHSAuthority \fR[\fInickname\fR] [\fBflags\fR] \fIaddress\fR\fB:\fIport fingerprint\fP
  221. .LP
  222. .TP
  223. \fBAlternateBridgeAuthority \fR[\fInickname\fR] [\fBflags\fR] \fIaddress\fR\fB:\fIport fingerprint\fP
  224. As DirServer, but replaces less of the default directory authorities.
  225. Using AlternateDirAuthority replaces the default Tor directory
  226. authorities, but leaves the hidden service authorities and bridge
  227. authorities in place. Similarly, Using AlternateHSAuthority replaces
  228. the default hidden service authorities, but not the directory or
  229. bridge authorities.
  230. .LP
  231. .TP
  232. \fBFetchDirInfoEarly \fR\fB0\fR|\fB1\fR\fP
  233. If set to 1, Tor will always fetch directory information like other
  234. directory caches, even if you don't meet the normal criteria for
  235. fetching early. Normal users should leave it off.
  236. (Default: 0)
  237. .LP
  238. .TP
  239. \fBFetchHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
  240. If set to 0, Tor will never fetch any hidden service descriptors from
  241. the rendezvous directories. This option is only useful if you're using
  242. a Tor controller that handles hidserv fetches for you.
  243. (Default: 1)
  244. .LP
  245. .TP
  246. \fBFetchServerDescriptors \fR\fB0\fR|\fB1\fR\fP
  247. If set to 0, Tor will never fetch any network status summaries or server
  248. descriptors from the directory servers. This option is only useful if
  249. you're using a Tor controller that handles directory fetches for you.
  250. (Default: 1)
  251. .LP
  252. .TP
  253. \fBFetchUselessDescriptors \fR\fB0\fR|\fB1\fR\fP
  254. If set to 1, Tor will fetch every non-obsolete descriptor from the
  255. authorities that it hears about. Otherwise, it will avoid fetching
  256. useless descriptors, for example for routers that are not running.
  257. This option is useful if you're using the contributed "exitlist"
  258. script to enumerate Tor nodes that exit to certain addresses.
  259. (Default: 0)
  260. .LP
  261. .TP
  262. \fBHttpProxy\fR \fIhost\fR[:\fIport\fR]\fP
  263. Tor will make all its directory requests through this host:port
  264. (or host:80 if port is not specified),
  265. rather than connecting directly to any directory servers.
  266. .LP
  267. .TP
  268. \fBHttpProxyAuthenticator\fR \fIusername:password\fP
  269. If defined, Tor will use this username:password for Basic Http proxy
  270. authentication, as in RFC 2617. This is currently the only form of
  271. Http proxy authentication that Tor supports; feel free to submit a
  272. patch if you want it to support others.
  273. .LP
  274. .TP
  275. \fBHttpsProxy\fR \fIhost\fR[:\fIport\fR]\fP
  276. Tor will make all its OR (SSL) connections through this host:port
  277. (or host:443 if port is not specified), via HTTP CONNECT rather than
  278. connecting directly to servers. You may want to set \fBFascistFirewall\fR
  279. to restrict the set of ports you might try to connect to, if your Https
  280. proxy only allows connecting to certain ports.
  281. .LP
  282. .TP
  283. \fBHttpsProxyAuthenticator\fR \fIusername:password\fP
  284. If defined, Tor will use this username:password for Basic Https proxy
  285. authentication, as in RFC 2617. This is currently the only form of
  286. Https proxy authentication that Tor supports; feel free to submit a
  287. patch if you want it to support others.
  288. .LP
  289. .TP
  290. \fBKeepalivePeriod \fR\fINUM\fP
  291. To keep firewalls from expiring connections, send a padding keepalive
  292. cell every NUM seconds on open connections that are in use. If the
  293. connection has no open circuits, it will instead be closed after NUM
  294. seconds of idleness. (Default: 5 minutes)
  295. .LP
  296. .TP
  297. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBstderr\fR|\fBstdout\fR|\fBsyslog\fR\fP
  298. Send all messages between \fIminSeverity\fR and \fImaxSeverity\fR to
  299. the standard output stream, the standard error stream, or to the system
  300. log. (The "syslog" value is only supported on Unix.) Recognized
  301. severity levels are debug, info, notice, warn, and err. We advise using
  302. "notice" in most cases, since anything more verbose may provide sensitive
  303. information to an attacker who obtains the logs. If only one
  304. severity level is given, all messages of that level or higher will be
  305. sent to the listed destination.
  306. .LP
  307. .TP
  308. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBfile\fR \fIFILENAME\fP
  309. As above, but send log messages to the listed filename. The "Log"
  310. option may appear more than once in a configuration file. Messages
  311. are sent to all the logs that match their severity level.
  312. .LP
  313. .TP
  314. \fBOutboundBindAddress \fR\fIIP\fP
  315. Make all outbound connections originate from the IP address specified. This
  316. is only useful when you have multiple network interfaces, and you want all
  317. of Tor's outgoing connections to use a single one.
  318. .LP
  319. .TP
  320. \fBPidFile \fR\fIFILE\fP
  321. On startup, write our PID to FILE. On clean shutdown, remove FILE.
  322. .LP
  323. .TP
  324. \fBProtocolWarnings \fR\fB0\fR|\fB1\fR\fP
  325. If 1, Tor will log with severity 'warn' various cases of other parties
  326. not following the Tor specification. Otherwise, they are logged with
  327. severity 'info'. (Default: 0)
  328. .LP
  329. .TP
  330. \fBRunAsDaemon \fR\fB0\fR|\fB1\fR\fP
  331. If 1, Tor forks and daemonizes to the background. This option has
  332. no effect on Windows; instead you should use the --service command-line
  333. option. (Default: 0)
  334. .LP
  335. .TP
  336. \fBSafeLogging \fR\fB0\fR|\fB1\fP
  337. If 1, Tor replaces potentially sensitive strings in the logs
  338. (e.g. addresses) with the string [scrubbed]. This way logs can still be
  339. useful, but they don't leave behind personally identifying information
  340. about what sites a user might have visited. (Default: 1)
  341. .LP
  342. .TP
  343. \fBUser \fR\fIUID\fP
  344. On startup, setuid to this user and setgid to their primary group.
  345. .LP
  346. .TP
  347. \fBHardwareAccel \fR\fB0\fR|\fB1\fP
  348. If non-zero, try to use crypto hardware acceleration when
  349. available. This is untested and probably buggy. (Default: 0)
  350. .LP
  351. .TP
  352. \fBAvoidDiskWrites \fR\fB0\fR|\fB1\fP
  353. If non-zero, try to write to disk less frequently than we would otherwise.
  354. This is useful when running on flash memory or other media that support only
  355. a limited number of writes. (Default: 0)
  356. .LP
  357. .TP
  358. \fBTunnelDirConns \fR\fB0\fR|\fB1\fP
  359. If non-zero, when a directory server we contact supports it, we will
  360. build a one-hop circuit and make an encrypted connection via its
  361. ORPort. (Default: 0)
  362. .LP
  363. .TP
  364. \fBPreferTunneledDirConns \fR\fB0\fR|\fB1\fP
  365. If non-zero, we will avoid directory servers that don't support tunneled
  366. directory connections, when possible. (Default: 0)
  367. .SH CLIENT OPTIONS
  368. .PP
  369. The following options are useful only for clients (that is, if \fBSocksPort\fP is non-zero):
  370. .LP
  371. .TP
  372. \fBAllowInvalidNodes\fR \fBentry\fR|\fBexit\fR|\fBmiddle\fR|\fBintroduction\fR|\fBrendezvous\fR|...\fP
  373. If some Tor servers are obviously not working right, the directory
  374. authorities can manually mark them as invalid, meaning that it's not
  375. recommended you use them for entry or exit positions in your circuits. You
  376. can opt to use them in some circuit positions, though. The default is
  377. "middle,rendezvous", and other choices are not advised.
  378. .LP
  379. .TP
  380. \fBExcludeSingleHopRelays \fR\fB0\fR|\fB1\fR\fP
  381. This option controls whether circuits built by Tor will include relays with
  382. the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set to
  383. 0, these relays will be included. Note that these relays might be at higher
  384. risk of being seized or observed, so they are not normally included.
  385. (Default: 1)
  386. .LP
  387. .TP
  388. \fBBridge \fR\fIIP:ORPort\fR [fingerprint]\fP
  389. When set along with UseBridges, instructs Tor to use the relay at
  390. "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
  391. is provided (using the same format as for DirServer), we will verify that
  392. the relay running at that location has the right fingerprint. We also use
  393. fingerprint to look up the bridge descriptor at the bridge authority, if
  394. it's provided and if UpdateBridgesFromAuthority is set too.
  395. .LP
  396. .TP
  397. \fBCircuitBuildTimeout \fR\fINUM\fP
  398. Try for at most NUM seconds when building circuits. If the circuit
  399. isn't open in that time, give up on it.
  400. (Default: 1 minute.)
  401. .LP
  402. .TP
  403. \fBCircuitIdleTimeout \fR\fINUM\fP
  404. If we have kept a clean (never used) circuit around for NUM seconds,
  405. then close it. This way when the Tor client is entirely idle, it can
  406. expire all of its circuits, and then expire its TLS connections. Also,
  407. if we end up making a circuit that is not useful for exiting any of
  408. the requests we're receiving, it won't forever take up a slot in the
  409. circuit list.
  410. (Default: 1 hour.)
  411. .LP
  412. .TP
  413. \fBClientOnly \fR\fB0\fR|\fB1\fR\fP
  414. If set to 1, Tor will under no circumstances run as a server or serve
  415. directory requests. The default
  416. is to run as a client unless ORPort is configured. (Usually,
  417. you don't need to set this; Tor is pretty smart at figuring out whether
  418. you are reliable and high-bandwidth enough to be a useful server.)
  419. (Default: 0)
  420. .LP
  421. .TP
  422. \fBExcludeNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  423. A list of identity fingerprints, nicknames, country codes and address patterns
  424. of nodes to never use when building a circuit. (Example: ExcludeNodes
  425. SlowServer, $ABCDEFFFFFFFFFFFFFFF, {cc}, 255.254.0.0/8)
  426. .LP
  427. .TP
  428. \fBExcludeExitNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  429. A list of identity fingerprints, nicknames, country codes and address patterns
  430. of nodes to never use when picking an exit node. Note that any node
  431. listed in ExcludeNodes is automatically considered to be part of this
  432. list.
  433. .LP
  434. .TP
  435. \fBEntryNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  436. A list of identity fingerprints, nicknames, country codes and address patterns
  437. of nodes to use for the first hop in the circuit.
  438. These are treated only as preferences unless StrictEntryNodes (see
  439. below) is also set.
  440. .LP
  441. .TP
  442. \fBExitNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  443. A list of identity fingerprints, nicknames, country codes and address patterns
  444. of nodes to use for the last hop in the circuit.
  445. These are treated only as preferences unless StrictExitNodes (see
  446. below) is also set.
  447. .LP
  448. .TP
  449. \fBStrictEntryNodes \fR\fB0\fR|\fB1\fR\fP
  450. If 1, Tor will never use any nodes besides those listed in "EntryNodes" for
  451. the first hop of a circuit.
  452. .LP
  453. .TP
  454. \fBStrictExitNodes \fR\fB0\fR|\fB1\fR\fP
  455. If 1, Tor will never use any nodes besides those listed in "ExitNodes" for
  456. the last hop of a circuit.
  457. .LP
  458. .TP
  459. \fBFascistFirewall \fR\fB0\fR|\fB1\fR\fP
  460. If 1, Tor will only create outgoing connections to ORs running on ports that
  461. your firewall allows (defaults to 80 and 443; see \fBFirewallPorts\fR). This will
  462. allow you to run Tor as a client behind a firewall with restrictive policies,
  463. but will not allow you to run as a server behind such a firewall.
  464. If you prefer more fine-grained control, use ReachableAddresses instead.
  465. .LP
  466. .TP
  467. \fBFirewallPorts \fR\fIPORTS\fP
  468. A list of ports that your firewall allows you to connect to. Only
  469. used when \fBFascistFirewall\fR is set. This option is deprecated; use
  470. ReachableAddresses instead. (Default: 80, 443)
  471. .LP
  472. .TP
  473. \fBHidServAuth \fR\fIonion-address\fR \fIauth-cookie\fP \fIservice-name\fR
  474. Client authorization for a hidden service. Valid onion addresses contain 16
  475. characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
  476. characters in A-Za-z0-9+/. The service name is only used for internal
  477. purposes, e.g., for Tor controllers. This option may be used multiple times
  478. for different hidden services. If a hidden service uses authorization and
  479. this option is not set, the hidden service is not accessible.
  480. .LP
  481. .TP
  482. \fBReachableAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  483. A comma-separated list of IP addresses and ports that your firewall allows you
  484. to connect to. The format is as
  485. for the addresses in ExitPolicy, except that "accept" is understood
  486. unless "reject" is explicitly provided. For example, 'ReachableAddresses
  487. 99.0.0.0/8, reject 18.0.0.0/8:80, accept *:80' means that your
  488. firewall allows connections to everything inside net 99, rejects port
  489. 80 connections to net 18, and accepts connections to port 80 otherwise.
  490. (Default: 'accept *:*'.)
  491. .LP
  492. .TP
  493. \fBReachableDirAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  494. Like \fBReachableAddresses\fP, a list of addresses and ports. Tor will obey
  495. these restrictions when fetching directory information, using standard HTTP
  496. GET requests. If not set explicitly then the value of \fBReachableAddresses\fP
  497. is used. If \fBHttpProxy\fR is set then these connections will go through that
  498. proxy.
  499. .LP
  500. .TP
  501. \fBReachableORAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  502. Like \fBReachableAddresses\fP, a list of addresses and ports. Tor will obey
  503. these restrictions when connecting to Onion Routers, using TLS/SSL. If not set
  504. explicitly then the value of \fBReachableAddresses\fP is used. If
  505. \fBHttpsProxy\fR is set then these connections will go through that proxy.
  506. The separation between \fBReachableORAddresses\fP and
  507. \fBReachableDirAddresses\fP is only interesting when you are connecting through
  508. proxies (see \fBHttpProxy\fR and \fBHttpsProxy\fR). Most proxies limit TLS
  509. connections (which Tor uses to connect to Onion Routers) to port 443, and some
  510. limit HTTP GET requests (which Tor uses for fetching directory information) to
  511. port 80.
  512. .LP
  513. .TP
  514. \fBLongLivedPorts \fR\fIPORTS\fP
  515. A list of ports for services that tend to have long-running connections
  516. (e.g. chat and interactive shells). Circuits for streams that use these
  517. ports will contain only high-uptime nodes, to reduce the chance that a
  518. node will go down before the stream is finished.
  519. (Default: 21, 22, 706, 1863, 5050, 5190, 5222, 5223, 6667, 6697, 8300)
  520. .LP
  521. .TP
  522. \fBMapAddress\fR \fIaddress\fR \fInewaddress\fR
  523. When a request for address arrives to Tor, it will rewrite it to
  524. newaddress before processing it. For example, if you always want
  525. connections to www.indymedia.org to exit via \fItorserver\fR (where
  526. \fItorserver\fR is the nickname of the server),
  527. use "MapAddress www.indymedia.org www.indymedia.org.torserver.exit".
  528. .LP
  529. .TP
  530. \fBNewCircuitPeriod \fR\fINUM\fP
  531. Every NUM seconds consider whether to build a new circuit. (Default: 30 seconds)
  532. .LP
  533. .TP
  534. \fBMaxCircuitDirtiness \fR\fINUM\fP
  535. Feel free to reuse a circuit that was first used at most NUM seconds ago,
  536. but never attach a new stream to a circuit that is too old.
  537. (Default: 10 minutes)
  538. .LP
  539. .TP
  540. \fBNodeFamily \fR\fInode\fR,\fInode\fR,\fI...\fP
  541. The Tor servers, defined by their identity fingerprints or nicknames,
  542. constitute a "family" of similar or co-administered
  543. servers, so never use any two of them in the same circuit. Defining a
  544. NodeFamily is only needed when a server doesn't list the family itself
  545. (with MyFamily). This option can be used multiple times.
  546. .LP
  547. .TP
  548. \fBEnforceDistinctSubnets \fR\fB0\fR|\fB1\fR\fP
  549. If 1, Tor will not put two servers whose IP addresses are "too
  550. close" on the same circuit. Currently, two addresses are
  551. "too close" if they lie in the same /16 range. (Default: 1)
  552. .\" \fBPathlenCoinWeight \fR\fI0.0-1.0\fP
  553. .\" Paths are 3 hops plus a geometric distribution centered around this coinweight.
  554. .\" Must be >=0.0 and <1.0. (Default: 0.3) NOT USED CURRENTLY
  555. .\" .TP
  556. .LP
  557. .TP
  558. \fBSocksPort \fR\fIPORT\fP
  559. Advertise this port to listen for connections from Socks-speaking
  560. applications. Set this to 0 if you don't want to allow application
  561. connections. (Default: 9050)
  562. .LP
  563. .TP
  564. \fBSocksListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  565. Bind to this address to listen for connections from Socks-speaking
  566. applications. (Default: 127.0.0.1) You can also specify a port
  567. (e.g. 192.168.0.1:9100).
  568. This directive can be specified multiple times to bind to multiple
  569. addresses/ports.
  570. .LP
  571. .TP
  572. \fBSocksPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  573. Set an entrance policy for this server, to limit who can connect to the
  574. SocksPort and DNSPort ports.
  575. The policies have the same form as exit policies below.
  576. .LP
  577. .TP
  578. \fBSocksTimeout \fR\fINUM\fP
  579. Let a socks connection wait NUM seconds handshaking, and NUM seconds
  580. unattached waiting for an appropriate circuit, before we fail it.
  581. (Default: 2 minutes.)
  582. .LP
  583. .TP
  584. \fBTrackHostExits \fR\fIhost\fR,\fI.domain\fR,\fI...\fR\fP
  585. For each value in the comma separated list, Tor will track recent connections
  586. to hosts that match this value and attempt to
  587. reuse the same exit node for each. If the value is prepended with a '.', it is
  588. treated as matching an entire domain. If one of the values is just a '.', it
  589. means match everything. This option is useful if you frequently connect to
  590. sites that will expire all your authentication cookies (ie log you out) if
  591. your IP address changes. Note that this option does have the disadvantage of
  592. making it more clear that a given history is
  593. associated with a single user. However, most people who would wish to observe
  594. this will observe it through cookies or other protocol-specific means anyhow.
  595. .LP
  596. .TP
  597. \fBTrackHostExitsExpire \fR\fINUM\fP
  598. Since exit servers go up and down, it is desirable to expire the association
  599. between host and exit server after NUM seconds. The default
  600. is 1800 seconds (30 minutes).
  601. .LP
  602. .TP
  603. \fBUpdateBridgesFromAuthority \fR\fB0\fR|\fB1\fR\fP
  604. When set (along with UseBridges), Tor will try to fetch bridge descriptors
  605. from the configured bridge authorities when feasible. It will fall back
  606. to a direct request if the authority responds with a 404. (Default: 0)
  607. .LP
  608. .TP
  609. \fBUseBridges \fR\fB0\fR|\fB1\fR\fP
  610. When set, Tor will fetch descriptors for each bridge listed in the
  611. "Bridge" config lines, and use these relays as both entry guards and
  612. directory guards. (Default: 0)
  613. .LP
  614. .TP
  615. \fBUseEntryGuards \fR\fB0\fR|\fB1\fR\fP
  616. If this option is set to 1, we pick a few long-term entry servers, and
  617. try to stick with them. This is desirable because
  618. constantly changing servers increases the odds that an adversary who owns
  619. some servers will observe a fraction of your paths.
  620. (Defaults to 1.)
  621. .LP
  622. .TP
  623. \fBNumEntryGuards \fR\fINUM\fP
  624. If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
  625. as long-term entries for our circuits.
  626. (Defaults to 3.)
  627. .LP
  628. .TP
  629. \fBSafeSocks \fR\fB0\fR|\fB1\fR\fP
  630. When this option is enabled, Tor will reject application connections that
  631. use unsafe variants of the socks protocol -- ones that only provide an
  632. IP address, meaning the application is doing a DNS resolve first.
  633. Specifically, these are socks4 and socks5 when not doing remote DNS.
  634. (Defaults to 0.)
  635. .LP
  636. .TP
  637. \fBTestSocks \fR\fB0\fR|\fB1\fR\fP
  638. When this option is enabled, Tor will make a notice-level log entry for
  639. each connection to the Socks port indicating whether the request used
  640. a safe socks protocol or an unsafe one (see above entry on SafeSocks).
  641. This helps to determine whether an application using Tor is possibly
  642. leaking DNS requests.
  643. (Default: 0)
  644. .LP
  645. .TP
  646. \fBVirtualAddrNetwork \fR\fIAddress\fB/\fIbits\fP
  647. When a controller asks for a virtual (unused) address with the
  648. MAPADDRESS command, Tor picks an unassigned address from this range.
  649. (Default: 127.192.0.0/10)
  650. When providing proxy server service to a network of computers using a tool like
  651. dns-proxy-tor,
  652. change this address to "10.192.0.0/10" or "172.16.0.0/12".
  653. The default \fBVirtualAddrNetwork\fP address range on a
  654. properly configured machine will route to the loopback interface.
  655. For local use, no change to the
  656. default \fBVirtualAddrNetwork\fP setting is needed.
  657. .LP
  658. .TP
  659. \fBAllowNonRFC953Hostnames \fR\fB0\fR|\fB1\fR\fP
  660. When this option is disabled, Tor blocks hostnames containing illegal
  661. characters (like @ and :) rather than sending them to an exit node to be
  662. resolved. This helps trap accidental attempts to resolve URLs and so on.
  663. (Default: 0)
  664. .LP
  665. .TP
  666. \fBFastFirstHopPK \fR\fB0\fR|\fB1\fR\fP
  667. When this option is disabled, Tor uses the public key step for the first
  668. hop of creating circuits. Skipping it is generally safe since we have
  669. already used TLS to authenticate the relay and to establish forward-secure
  670. keys. Turning this option off makes circuit building slower.
  671. Note that Tor will always use the public key step for the first hop if
  672. it's operating as a relay, and it will never use the public key step if
  673. it doesn't yet know the onion key of the first hop.
  674. (Default: 1)
  675. .LP
  676. .TP
  677. \fBTransPort\fP \fR\fIPORT\fP
  678. If non-zero, enables transparent proxy support on \fR\fIPORT\fP (by
  679. convention, 9040).
  680. .\" This is required to enable support for \fBdns-proxy-tor\fP.
  681. .\" ControlPort must be set when using \fBTransPort\fP.
  682. Requires OS support for transparent proxies, such as BSDs' pf or
  683. Linux's IPTables.
  684. If you're planning
  685. to use Tor as a transparent proxy for a network, you'll want to examine
  686. and change VirtualAddrNetwork from the default setting. You'll also want
  687. to set the TransListenAddress option for the network you'd like to proxy.
  688. (Default: 0).
  689. .LP
  690. .TP
  691. \fBTransListenAddress\fP \fR\fIIP\fR[:\fIPORT\fR]\fP
  692. Bind to this address to listen for transparent proxy connections.
  693. (Default: 127.0.0.1).
  694. This is useful for exporting a transparent proxy server
  695. to an entire network.
  696. .LP
  697. .TP
  698. \fBNATDPort\fP \fR\fIPORT\fP
  699. Allow old versions of ipfw (as included in old versions of FreeBSD,
  700. etc.) to send connections through Tor using the NATD protocol.
  701. This option is only for people who cannot
  702. use TransPort.
  703. .LP
  704. .TP
  705. \fBNATDListenAddress\fP \fR\fIIP\fR[:\fIPORT\fR]\fP
  706. Bind to this address to listen for NATD connections.
  707. (Default: 127.0.0.1).
  708. .LP
  709. .TP
  710. \fBAutomapHostsOnResolve\fP \fR\fB0\fR|\fB1\fR\fP
  711. When this option is enabled, and we get a request to resolve an
  712. address that ends with one of the suffixes in
  713. \fBAutomapHostsSuffixes\fP, we map an unused virtual address to that
  714. address, and return the new virtual address. This is handy for making
  715. ".onion" addresses work with applications that resolve an address and
  716. then connect to it.
  717. (Default: 0).
  718. .LP
  719. .TP
  720. \fBAutomapHostsSuffixes\fP \fR\fISUFFIX\fR,\fISUFFIX\fR,...\fP
  721. A comma-separated list of suffixes to use with \fBAutomapHostsOnResolve\fP.
  722. The "." suffix is equivalent to "all addresses."
  723. (Default: .exit,.onion).
  724. .LP
  725. .TP
  726. \fBDNSPort\fP \fR\fIPORT\fP
  727. If non-zero, Tor listens for UDP DNS requests on this port and resolves them
  728. anonymously.
  729. (Default: 0).
  730. .LP
  731. .TP
  732. \fBDNSListenAddress\fP \fR\fIIP\fR[:\fIPORT\fR]\fP
  733. Bind to this address to listen for DNS connections.
  734. (Default: 127.0.0.1).
  735. .LP
  736. .TP
  737. \fBClientDNSRejectInternalAddresses\fP \fR\fB0\fR|\fB1\fR\fP
  738. If true, Tor does not believe any anonymously retrieved DNS answer that tells
  739. it that an address resolves to an internal address (like 127.0.0.1 or
  740. 192.168.0.1). This option prevents certain browser-based attacks; don't turn
  741. it off unless you know what you're doing. (Default: 1).
  742. .LP
  743. .TP
  744. \fBDownloadExtraInfo\fP \fR\fB0\fR|\fB1\fR\fP
  745. If true, Tor downloads and caches "extra-info" documents. These
  746. documents contain information about servers other than the information
  747. in their regular router descriptors. Tor does not use this information for
  748. anything itself; to save bandwidth, leave this option turned off.
  749. (Default: 0).
  750. .LP
  751. .TP
  752. \fBFallbackNetworkstatusFile\fP \fIFILENAME\fP
  753. If Tor doesn't have a cached networkstatus file, it starts out using
  754. this one instead. Even if this file is out of date, Tor can still use
  755. it to learn about directory mirrors, so it doesn't need to put load on
  756. the authorities. (Default: None).
  757. .LP
  758. .TP
  759. \fBWarnPlaintextPorts\fP \fR\fIport\fR,\fIport\fR,\fI...\fP
  760. Tells Tor to issue a warnings whenever the user tries to make an
  761. anonymous connection to one of these ports. This option is designed
  762. to alert users to services that risk sending passwords in the clear.
  763. (Default: 23,109,110,143).
  764. .LP
  765. .TP
  766. \fBRejectPlaintextPorts\fP \fR\fIport\fR,\fIport\fR,\fI...\fP
  767. Like WarnPlaintextPorts, but instead of warning about risky port uses,
  768. Tor will instead refuse to make the connection.
  769. (Default: None).
  770. .SH SERVER OPTIONS
  771. .PP
  772. The following options are useful only for servers (that is, if \fBORPort\fP is non-zero):
  773. .LP
  774. .TP
  775. \fBAddress \fR\fIaddress\fP
  776. The IP address or fqdn of this server (e.g. moria.mit.edu). You can
  777. leave this unset, and Tor will guess your IP address.
  778. .LP
  779. .TP
  780. \fBAllowSingleHopExits \fR\fB0\fR|\fB1\fR\fP
  781. This option controls whether clients can use this server as a single hop
  782. proxy. If set to 1, clients can use this server as an exit even if it is
  783. the only hop in the circuit. (Default: 0)
  784. .LP
  785. .TP
  786. \fBAssumeReachable \fR\fB0\fR|\fB1\fR\fP
  787. This option is used when bootstrapping a new Tor network. If set to 1,
  788. don't do self-reachability testing; just upload your server descriptor
  789. immediately. If \fBAuthoritativeDirectory\fP is also set, this option
  790. instructs the dirserver to bypass remote reachability testing too and
  791. list all connected servers as running.
  792. .LP
  793. .TP
  794. \fBBridgeRelay \fR\fB0\fR|\fB1\fR\fP
  795. Sets the relay to act as a "bridge" with respect to relaying connections
  796. from bridge users to the Tor network. Mainly it influences how the relay
  797. will cache and serve directory information. Usually used in combination
  798. with PublishServerDescriptor.
  799. .LP
  800. .TP
  801. \fBContactInfo \fR\fIemail_address\fP
  802. Administrative contact information for server. This line might get
  803. picked up by spam harvesters, so you may want to obscure the fact
  804. that it's an email address.
  805. .LP
  806. .TP
  807. \fBExitPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  808. Set an exit policy for this server. Each policy is of the form
  809. "\fBaccept\fP|\fBreject\fP \fIADDR\fP[\fB/\fP\fIMASK\fP]\fB[:\fP\fIPORT\fP]".
  810. If \fB/\fP\fIMASK\fP is omitted then this policy just applies to the host
  811. given. Instead of giving a host or network you can also use "\fB*\fP" to
  812. denote the universe (0.0.0.0/0). \fIPORT\fP can be a single port number,
  813. an interval of ports "\fIFROM_PORT\fP\fB-\fP\fITO_PORT\fP", or "\fB*\fP".
  814. If \fIPORT\fP is omitted, that means "\fB*\fP".
  815. For example, "accept 18.7.22.69:*,reject 18.0.0.0/8:*,accept *:*" would
  816. reject any traffic destined for MIT except for web.mit.edu, and
  817. accept anything else.
  818. To specify all internal and link-local networks (including 0.0.0.0/8,
  819. 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
  820. 172.16.0.0/12), you can use the "private" alias instead of an address.
  821. These addresses are rejected by default (at the beginning of your
  822. exit policy), along with your public IP address, unless you set the
  823. ExitPolicyRejectPrivate config option
  824. to 0. For example, once you've done that, you could allow HTTP to
  825. 127.0.0.1 and block all other connections to internal networks with
  826. "accept 127.0.0.1:80,reject private:*", though that may also allow
  827. connections to your own computer that are addressed to its public
  828. (external) IP address. See RFC 1918 and RFC 3330 for more
  829. details about internal and reserved IP address space.
  830. This directive can be specified multiple times so you don't have to put
  831. it all on one line.
  832. Policies are considered first to last, and the first match wins. If
  833. you want to _replace_ the default exit policy, end your exit policy with
  834. either a reject *:* or an accept *:*. Otherwise, you're _augmenting_
  835. (prepending to) the default exit policy. The default exit policy is:
  836. .PD 0
  837. .RS 12
  838. .IP "reject *:25"
  839. .IP "reject *:119"
  840. .IP "reject *:135-139"
  841. .IP "reject *:445"
  842. .IP "reject *:563"
  843. .IP "reject *:1214"
  844. .IP "reject *:4661-4666"
  845. .IP "reject *:6346-6429"
  846. .IP "reject *:6699"
  847. .IP "reject *:6881-6999"
  848. .IP "accept *:*"
  849. .RE
  850. .PD
  851. .LP
  852. .TP
  853. \fBExitPolicyRejectPrivate \fR\fB0\fR|\fB1\fR\fP
  854. Reject all private (local) networks, along with your own public IP
  855. address, at the beginning of your exit
  856. policy. See above entry on ExitPolicy. (Default: 1)
  857. .LP
  858. .TP
  859. \fBMaxOnionsPending \fR\fINUM\fP
  860. If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
  861. .LP
  862. .TP
  863. \fBMyFamily \fR\fInode\fR,\fInode\fR,\fI...\fP
  864. Declare that this Tor server is controlled or administered by a group
  865. or organization identical or similar to that of the other servers, defined by their identity fingerprints or nicknames.
  866. When two servers both declare that they are in the same 'family', Tor clients
  867. will not use them in the same circuit. (Each server only needs to list the
  868. other servers in its family; it doesn't need to list itself, but it won't hurt.)
  869. .LP
  870. .TP
  871. \fBNickname \fR\fIname\fP
  872. Set the server's nickname to 'name'. Nicknames must be between 1
  873. and 19 characters inclusive, and must contain only the characters
  874. [a-zA-Z0-9].
  875. .LP
  876. .TP
  877. \fBNumCPUs \fR\fInum\fP
  878. How many processes to use at once for decrypting onionskins. (Default: 1)
  879. .LP
  880. .TP
  881. \fBORPort \fR\fIPORT\fP
  882. Advertise this port to listen for connections from Tor clients and servers.
  883. .LP
  884. .TP
  885. \fBORListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  886. Bind to this IP address to listen for connections from Tor clients and
  887. servers. If you specify a port, bind to this port rather than the one
  888. specified in ORPort. (Default: 0.0.0.0)
  889. This directive can be specified multiple times to bind to multiple
  890. addresses/ports.
  891. .LP
  892. .TP
  893. \fBPublishServerDescriptor \fR\fB0\fR|\fB1\fR|\fBv1\fR|\fBv2\fR|\fBv3\fR|\fBbridge\fR|\fBhidserv\fR, ...\fP
  894. This option is only considered if you have an ORPort defined. You can
  895. choose multiple arguments, separated by commas.
  896. If set to 0, Tor will act as a server but it will not publish its
  897. descriptor to the directory authorities. (This is useful if you're
  898. testing out your server, or if you're using a Tor controller that handles
  899. directory publishing for you.) Otherwise, Tor will publish its descriptor
  900. to all directory authorities of the type(s) specified. The value "1" is
  901. treated as a synonym for the default, which is currently "v2,v3".
  902. .LP
  903. .TP
  904. \fBRedirectExit \fR\fIpattern target\fP
  905. THIS OPTION IS DEPRECATED. It will go away in a future version of Tor.
  906. Whenever an outgoing connection tries to connect to one of a given set
  907. of addresses, connect to \fItarget\fP (an \fIaddress:port\fP pair) instead.
  908. The address
  909. pattern is given in the same format as for an exit policy. The
  910. address translation applies after exit policies are applied. Multiple
  911. \fBRedirectExit\fP options can be used: once any one has matched
  912. successfully, no subsequent rules are considered. You can specify that no
  913. redirection is to be performed on a given set of addresses by using the
  914. special target string "pass", which prevents subsequent rules from being
  915. considered.
  916. .LP
  917. .TP
  918. \fBShutdownWaitLength\fR \fINUM\fP
  919. When we get a SIGINT and we're a server, we begin shutting down: we close
  920. listeners and start refusing new circuits. After \fBNUM\fP seconds,
  921. we exit. If we get a second SIGINT, we exit immediately. (Default:
  922. 30 seconds)
  923. .LP
  924. .TP
  925. \fBAccountingMax \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  926. Never send more than the specified number of bytes in a given
  927. accounting period, or receive more than that number in the period.
  928. For example, with AccountingMax set to 1 GB, a server could send 900 MB
  929. and receive 800 MB and continue running. It will only hibernate once one
  930. of the two reaches 1 GB.
  931. When the number of bytes is exhausted, Tor will hibernate until some
  932. time in the next accounting period. To prevent all servers from
  933. waking at the same time, Tor will also wait until a random point in
  934. each period before waking up. If you have bandwidth cost issues,
  935. enabling hibernation is preferable to setting a low bandwidth, since it
  936. provides users with a collection of fast servers that are up some of
  937. the time, which is more useful than a set of slow servers that are
  938. always "available".
  939. .LP
  940. .TP
  941. \fBAccountingStart \fR\fBday\fR|\fBweek\fR|\fBmonth\fR [\fIday\fR] \fIHH:MM\fR\fP
  942. Specify how long accounting periods last. If \fBmonth\fP is given,
  943. each accounting period runs from the time \fIHH:MM\fR on the
  944. \fIday\fRth day of one month to the same day and time of the next.
  945. (The day must be between 1 and 28.) If \fBweek\fP is given, each
  946. accounting period runs from the time \fIHH:MM\fR of the \fIday\fRth
  947. day of one week to the same day and time of the next week, with Monday
  948. as day 1 and Sunday as day 7. If \fBday\fR is given, each accounting
  949. period runs from the time \fIHH:MM\fR each day to the same time on the
  950. next day. All times are local, and given in 24-hour time. (Defaults to
  951. "month 1 0:00".)
  952. .LP
  953. .TP
  954. \fBServerDNSResolvConfFile \fR\fIfilename\fP
  955. Overrides the default DNS configuration with the configuration in
  956. \fIfilename\fP. The file format is the same as the standard Unix
  957. "\fBresolv.conf\fP" file (7). This option, like all other
  958. ServerDNS options, only affects name lookups that your server does on
  959. behalf of clients. Also, it only takes effect if Tor was built with
  960. eventdns support. (Defaults to use the system DNS configuration.)
  961. .LP
  962. .TP
  963. \fBServerDNSSearchDomains \fR\fB0\fR|\fB1\fR\fP
  964. If set to \fB1\fP, then we will search for addresses in the local search
  965. domain. For example, if this system is configured to believe it is in
  966. "example.com", and a client tries to connect to "www", the client will be
  967. connected to "www.example.com".
  968. This option only affects name lookups that your server does on
  969. behalf of clients, and only takes effect if Tor was built with
  970. eventdns support.
  971. (Defaults to "0".)
  972. .LP
  973. .TP
  974. \fBServerDNSDetectHijacking \fR\fB0\fR|\fB1\fR\fP
  975. When this option is set to 1, we will test periodically to determine whether
  976. our local nameservers have been configured to hijack failing DNS requests
  977. (usually to an advertising site). If they are, we will attempt to correct
  978. this.
  979. This option only affects name lookups that your server does on
  980. behalf of clients, and only takes effect if Tor was built with
  981. eventdns support.
  982. (Defaults to "1".)
  983. .LP
  984. .TP
  985. \fBServerDNSTestAddresses \fR\fIaddress\fR,\fIaddress\fR,\fI...\fP
  986. When we're detecting DNS hijacking, make sure that these \fIvalid\fP
  987. addresses aren't getting redirected. If they are, then our DNS is
  988. completely useless, and we'll reset our exit policy to "reject *:*".
  989. This option only affects name lookups that your server does on
  990. behalf of clients, and only takes effect if Tor was built with
  991. eventdns support.
  992. (Defaults to "www.google.com, www.mit.edu, www.yahoo.com,
  993. www.slashdot.org".)
  994. .LP
  995. .TP
  996. \fBServerDNSAllowNonRFC953Hostnames \fR\fB0\fR|\fB1\fR\fP
  997. When this option is disabled, Tor does not try to resolve hostnames
  998. containing illegal characters (like @ and :) rather than sending them to an
  999. exit node to be resolved. This helps trap accidental attempts to resolve
  1000. URLs and so on.
  1001. This option only affects name lookups that your server does on
  1002. behalf of clients, and only takes effect if Tor was built with
  1003. eventdns support.
  1004. (Default: 0)
  1005. .LP
  1006. .TP
  1007. \fBBridgeRecordUsageByCountry \fR\fB0\fR|\fB1\fR\fP
  1008. When this option is enabled and BridgeRelay is also enabled, and we
  1009. have GeoIP data, Tor keeps a keep a per-country count of how many
  1010. client addresses have contacted it so that it can help the bridge
  1011. authority guess which countries have blocked access to it.
  1012. .LP
  1013. .TP
  1014. \fBGeoIPFile \fR\fIfilename\fP
  1015. A filename containing GeoIP data, for use with BridgeRecordUsageByCountry.
  1016. .SH DIRECTORY SERVER OPTIONS
  1017. .PP
  1018. The following options are useful only for directory servers (that is, if \fBDirPort\fP is non-zero):
  1019. .LP
  1020. .TP
  1021. \fBAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1022. When this option is set to 1, Tor operates as an authoritative
  1023. directory server. Instead of caching the directory, it generates its
  1024. own list of good servers, signs it, and sends that to the clients.
  1025. Unless the clients already have you listed as a trusted directory, you
  1026. probably do not want to set this option. Please coordinate with the other
  1027. admins at tor-ops@freehaven.net if you think you should be a directory.
  1028. .LP
  1029. .TP
  1030. \fBDirPortFrontPage \fIFILENAME\fP
  1031. When this option is set, it takes an html file and publishes it as "/" on
  1032. the DirPort. Now relay operators can provide a disclaimer without needing
  1033. to set up a separate webserver. There's a sample disclaimer in
  1034. contrib/tor-exit-notice.html.
  1035. .LP
  1036. .TP
  1037. \fBV1AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1038. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  1039. generates version 1 directory and running-routers documents (for legacy
  1040. Tor clients up to 0.1.0.x).
  1041. .LP
  1042. .TP
  1043. \fBV2AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1044. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  1045. generates version 2 network statuses and serves descriptors, etc as
  1046. described in doc/spec/dir-spec-v2.txt (for Tor clients and servers
  1047. running 0.1.1.x and 0.1.2.x).
  1048. .LP
  1049. .TP
  1050. \fBV3AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1051. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  1052. generates version 3 network statuses and serves descriptors, etc as
  1053. described in doc/spec/dir-spec.txt (for Tor clients and servers
  1054. running at least 0.2.0.x).
  1055. .LP
  1056. .TP
  1057. \fBVersioningAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1058. When this option is set to 1, Tor adds information on
  1059. which versions of Tor are still believed safe for use to
  1060. the published directory. Each version 1 authority is
  1061. automatically a versioning authority; version 2 authorities
  1062. provide this service optionally. See \fBRecommendedVersions\fP,
  1063. \fBRecommendedClientVersions\fP, and \fBRecommendedServerVersions\fP.
  1064. .LP
  1065. .TP
  1066. \fBNamingAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1067. When this option is set to 1, then the server advertises that it has
  1068. opinions about nickname-to-fingerprint bindings. It will include these
  1069. opinions in its published network-status pages, by listing servers with
  1070. the flag "Named" if a correct binding between that nickname and
  1071. fingerprint has been registered with the dirserver. Naming dirservers
  1072. will refuse to accept or publish descriptors that contradict a
  1073. registered binding. See \fBapproved-routers\fP in the \fBFILES\fP
  1074. section below.
  1075. .LP
  1076. .TP
  1077. \fBHSAuthoritativeDir \fR\fB0\fR|\fB1\fR\fP
  1078. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor also
  1079. accepts and serves hidden service descriptors. (Default: 0)
  1080. .LP
  1081. .TP
  1082. \fBHSAuthorityRecordStats \fR\fB0\fR|\fB1\fR\fP
  1083. When this option is set in addition to \fBHSAuthoritativeDir\fP, Tor
  1084. periodically (every 15 minutes) writes statistics about hidden service
  1085. usage to a file \fBhsusage\fP in its data directory. (Default: 0)
  1086. .LP
  1087. .TP
  1088. \fBHidServDirectoryV2 \fR\fB0\fR|\fB1\fR\fP
  1089. When this option is set, Tor accepts and serves v2 hidden service
  1090. descriptors. Setting DirPort is not required for this, because clients
  1091. connect via the ORPort by default. (Default: 1)
  1092. .LP
  1093. .TP
  1094. \fBBridgeAuthoritativeDir \fR\fB0\fR|\fB1\fR\fP
  1095. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  1096. accepts and serves router descriptors, but it caches and serves the main
  1097. networkstatus documents rather than generating its own. (Default: 0)
  1098. .LP
  1099. .TP
  1100. \fBMinUptimeHidServDirectoryV2 \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  1101. Minimum uptime of a v2 hidden service directory to be accepted as such by
  1102. authoritative directories. (Default: 24 hours)
  1103. .LP
  1104. .TP
  1105. \fBDirPort \fR\fIPORT\fP
  1106. Advertise the directory service on this port.
  1107. .LP
  1108. .TP
  1109. \fBDirListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  1110. Bind the directory service to this address. If you specify a port, bind
  1111. to this port rather than the one specified in DirPort. (Default: 0.0.0.0)
  1112. This directive can be specified multiple times to bind to multiple
  1113. addresses/ports.
  1114. .LP
  1115. .TP
  1116. \fBDirPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  1117. Set an entrance policy for this server, to limit who can connect to the
  1118. directory ports.
  1119. The policies have the same form as exit policies above.
  1120. .SH DIRECTORY AUTHORITY SERVER OPTIONS
  1121. .PP
  1122. .LP
  1123. .TP
  1124. \fBRecommendedVersions \fR\fISTRING\fP
  1125. STRING is a comma-separated list of Tor versions currently believed
  1126. to be safe. The list is included in each directory, and nodes which
  1127. pull down the directory learn whether they need to upgrade. This
  1128. option can appear multiple times: the values from multiple lines are
  1129. spliced together.
  1130. When this is set then
  1131. \fBVersioningAuthoritativeDirectory\fP should be set too.
  1132. .LP
  1133. .TP
  1134. \fBRecommendedClientVersions \fR\fISTRING\fP
  1135. STRING is a comma-separated list of Tor versions currently believed
  1136. to be safe for clients to use. This information is included in version 2
  1137. directories. If this is not set then the value of \fBRecommendedVersions\fR
  1138. is used.
  1139. When this is set then
  1140. \fBVersioningAuthoritativeDirectory\fP should be set too.
  1141. .LP
  1142. .TP
  1143. \fBRecommendedServerVersions \fR\fISTRING\fP
  1144. STRING is a comma-separated list of Tor versions currently believed
  1145. to be safe for servers to use. This information is included in version 2
  1146. directories. If this is not set then the value of \fBRecommendedVersions\fR
  1147. is used.
  1148. When this is set then
  1149. \fBVersioningAuthoritativeDirectory\fP should be set too.
  1150. .LP
  1151. .TP
  1152. \fBDirAllowPrivateAddresses \fR\fB0\fR|\fB1\fR\fP
  1153. If set to 1, Tor will accept router descriptors with arbitrary "Address"
  1154. elements. Otherwise, if the address is not an IP address or is a private
  1155. IP address, it will reject the router descriptor. Defaults to 0.
  1156. .LP
  1157. .TP
  1158. \fBAuthDirBadDir \fR\fIAddressPattern\fR...\fP
  1159. Authoritative directories only. A set of address patterns for servers that
  1160. will be listed as bad directories in any network status document this authority
  1161. publishes, if \fBAuthDirListBadDirs\fR is set.
  1162. .LP
  1163. .TP
  1164. \fBAuthDirBadExit \fR\fIAddressPattern\fR...\fP
  1165. Authoritative directories only. A set of address patterns for servers that
  1166. will be listed as bad exits in any network status document this authority
  1167. publishes, if \fBAuthDirListBadExits\fR is set.
  1168. .LP
  1169. .TP
  1170. \fBAuthDirInvalid \fR\fIAddressPattern\fR...\fP
  1171. Authoritative directories only. A set of address patterns for servers that
  1172. will never be listed as "valid" in any network status document that this
  1173. authority publishes.
  1174. .LP
  1175. .TP
  1176. \fBAuthDirReject \fR\fIAddressPattern\fR...\fP
  1177. Authoritative directories only. A set of address patterns for servers that
  1178. will never be listed at all in any network status document that this
  1179. authority publishes, or accepted as an OR address in any descriptor submitted
  1180. for publication by this authority.
  1181. .LP
  1182. .TP
  1183. \fBAuthDirListBadDirs \fR\fB0\fR|\fB1\fR\fP
  1184. Authoritative directories only. If set to 1, this directory has
  1185. some opinion about which nodes are unsuitable as directory caches. (Do not
  1186. set this to 1 unless you plan to list nonfunctioning directories as bad;
  1187. otherwise, you are effectively voting in favor of every declared directory.)
  1188. .LP
  1189. .TP
  1190. \fBAuthDirListBadExits \fR\fB0\fR|\fB1\fR\fP
  1191. Authoritative directories only. If set to 1, this directory has
  1192. some opinion about which nodes are unsuitable as exit nodes. (Do not
  1193. set this to 1 unless you plan to list nonfunctioning exits as bad;
  1194. otherwise, you are effectively voting in favor of every declared exit
  1195. as an exit.)
  1196. .LP
  1197. .TP
  1198. \fBAuthDirRejectUnlisted \fR\fB0\fR|\fB1\fR\fP
  1199. Authoritative directories only. If set to 1, the directory server
  1200. rejects all uploaded server descriptors that aren't explicitly listed
  1201. in the fingerprints file. This acts as a "panic button" if we get
  1202. Sybiled. (Default: 0)
  1203. .LP
  1204. .TP
  1205. \fBAuthDirMaxServersPerAddr\fR \fINUM\fP
  1206. Authoritative directories only. The maximum number of servers that we
  1207. will list as acceptable on a single IP address. Set this to "0" for
  1208. "no limit". (Default: 2)
  1209. .LP
  1210. .TP
  1211. \fBAuthDirMaxServersPerAuthAddr\fR \fINUM\fP
  1212. Authoritative directories only. Like AuthDirMaxServersPerAddr, but
  1213. applies to addresses shared with directory authorities. (Default: 5)
  1214. .LP
  1215. .TP
  1216. \fBV3AuthVotingInterval\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1217. V3 authoritative directories only. Configures the server's preferred
  1218. voting interval. Note that voting will \fIactually\fP happen at an
  1219. interval chosen by consensus from all the authorities' preferred
  1220. intervals. This time SHOULD divide evenly into a day. (Default: 1 hour)
  1221. .LP
  1222. .TP
  1223. \fBV3AuthVoteDelay\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1224. V3 authoritative directories only. Configures the server's preferred
  1225. delay between publishing its vote and assuming it has all the votes
  1226. from all the other authorities. Note that the actual time used is not
  1227. the server's preferred time, but the consensus of all preferences.
  1228. (Default: 5 minutes.)
  1229. .LP
  1230. .TP
  1231. \fBV3AuthDistDelay\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1232. V3 authoritative directories only. Configures the server's preferred
  1233. delay between publishing its consensus and signature and assuming it
  1234. has all the signatures from all the other authorities. Note that the
  1235. actual time used is not the server's preferred time, but the consensus
  1236. of all preferences. (Default: 5 minutes.)
  1237. .LP
  1238. .TP
  1239. \fBV3AuthNIntervalsValid\fR \fINUM\fP
  1240. V3 authoritative directories only. Configures the number of
  1241. VotingIntervals for which each consensus should be valid for.
  1242. Choosing high numbers increases network partitioning risks; choosing
  1243. low numbers increases directory traffic. Note that the actual number
  1244. of intervals used is not the server's preferred number, but the
  1245. consensus of all preferences. Must be at least 2. (Default: 3.)
  1246. .SH HIDDEN SERVICE OPTIONS
  1247. .PP
  1248. The following options are used to configure a hidden service.
  1249. .LP
  1250. .TP
  1251. \fBHiddenServiceDir \fR\fIDIRECTORY\fP
  1252. Store data files for a hidden service in DIRECTORY. Every hidden
  1253. service must have a separate directory. You may use this option multiple
  1254. times to specify multiple services.
  1255. .LP
  1256. .TP
  1257. \fBHiddenServicePort \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
  1258. Configure a virtual port VIRTPORT for a hidden service. You may use this
  1259. option multiple times; each time applies to the service using the most recent
  1260. hiddenservicedir. By default, this option maps the virtual port to the
  1261. same port on 127.0.0.1. You may override the target port, address, or both
  1262. by specifying a target of addr, port, or addr:port. You may also have
  1263. multiple lines with the same VIRTPORT: when a user connects to that VIRTPORT,
  1264. one of the TARGETs from those lines will be chosen at random.
  1265. .LP
  1266. .TP
  1267. \fBPublishHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
  1268. If set to 0, Tor will run any hidden services you configure, but it won't
  1269. advertise them to the rendezvous directory. This option is only useful
  1270. if you're using a Tor controller that handles hidserv publishing for you.
  1271. (Default: 1)
  1272. .LP
  1273. .TP
  1274. \fBHiddenServiceVersion \fR\fIversion\fR,\fIversion\fR,\fI...\fP
  1275. A list of rendezvous service descriptor versions to publish for the hidden
  1276. service. Possible version numbers are 0 and 2. (Default: 0, 2)
  1277. .LP
  1278. .TP
  1279. \fBHiddenServiceAuthorizeClient \fR\fIauth-type\fR \fR\fIclient-name\fR,\fIclient-name\fR,\fI...\fP
  1280. If configured, the hidden service is accessible for authorized clients
  1281. only. The auth-type can either be 'basic' for a general-purpose
  1282. authorization protocol or 'stealth' for a less scalable protocol that also
  1283. hides service activity from unauthorized clients. Only clients that are
  1284. listed here are authorized to access the hidden service. Valid client names
  1285. are 1 to 19 characters long and only use characters in A-Za-z0-9+-_
  1286. (no spaces). If this option is set, the hidden service is not accessible
  1287. for clients without authorization any more. Generated authorization data
  1288. can be found in the hostname file.
  1289. .LP
  1290. .TP
  1291. \fBRendPostPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  1292. Every time the specified period elapses, Tor uploads any rendezvous
  1293. service descriptors to the directory servers. This information is also
  1294. uploaded whenever it changes. (Default: 20 minutes)
  1295. .SH TESTING NETWORK OPTIONS
  1296. .PP
  1297. The following options are used for running a testing Tor network.
  1298. .LP
  1299. .TP
  1300. \fBTestingTorNetwork \fR\fB0\fR|\fB1\fR\fP
  1301. If set to 1, Tor adjusts default values of the configuration options below,
  1302. so that it is easier to set up a testing Tor network. May only be set if
  1303. non-default set of DirServers is set. Cannot be unset while Tor is running.
  1304. (Default: 0)
  1305. .PD 0
  1306. .RS 12
  1307. .IP "ServerDNSAllowBrokenResolvConf 1"
  1308. .IP "DirAllowPrivateAddresses 1"
  1309. .IP "EnforceDistinctSubnets 0"
  1310. .IP "AssumeReachable 1"
  1311. .IP "AuthDirMaxServersPerAddr 0"
  1312. .IP "AuthDirMaxServersPerAuthAddr 0"
  1313. .IP "ClientDNSRejectInternalAddresses 0"
  1314. .IP "ExitPolicyRejectPrivate 0"
  1315. .IP "V3AuthVotingInterval 5 minutes"
  1316. .IP "V3AuthVoteDelay 20 seconds"
  1317. .IP "V3AuthDistDelay 20 seconds"
  1318. .IP "TestingV3AuthInitialVotingInterval 5 minutes"
  1319. .IP "TestingV3AuthInitialVoteDelay 20 seconds"
  1320. .IP "TestingV3AuthInitialDistDelay 20 seconds"
  1321. .IP "TestingAuthDirTimeToLearnReachability 0 minutes"
  1322. .IP "TestingEstimatedDescriptorPropagationTime 0 minutes"
  1323. .RE
  1324. .PD
  1325. .LP
  1326. .TP
  1327. \fBTestingV3AuthInitialVotingInterval\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1328. Like \fBV3AuthVotingInterval\fR, but for initial voting interval before the
  1329. first consensus has been created. Changing this requires that
  1330. \fBTestingTorNetwork\fR is set. (Default: 30 minutes)
  1331. .LP
  1332. .TP
  1333. \fBTestingV3AuthInitialVoteDelay\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1334. Like \fBTestingV3AuthInitialVoteDelay\fR, but for initial voting interval
  1335. before the first consensus has been created. Changing this requires that
  1336. \fBTestingTorNetwork\fR is set. (Default: 5 minutes)
  1337. .LP
  1338. .TP
  1339. \fBTestingV3AuthInitialDistDelay\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1340. Like \fBTestingV3AuthInitialDistDelay\fR, but for initial voting interval
  1341. before the first consensus has been created. Changing this requires that
  1342. \fBTestingTorNetwork\fR is set. (Default: 5 minutes)
  1343. .LP
  1344. .TP
  1345. \fBTestingAuthDirTimeToLearnReachability\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1346. After starting as an authority, do not make claims about whether routers are
  1347. Running until this much time has passed.
  1348. Changing this requires that\fBTestingTorNetwork\fR is set.
  1349. (Default: 30 minutes)
  1350. .LP
  1351. .TP
  1352. \fBTestingEstimatedDescriptorPropagationTime\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
  1353. Clients try downloading router descriptors from directory caches after this
  1354. time. Changing this requires that \fBTestingTorNetwork\fR is set.
  1355. (Default: 10 minutes)
  1356. .\" UNDOCUMENTED
  1357. .\" ignoreversion
  1358. .SH SIGNALS
  1359. Tor catches the following signals:
  1360. .LP
  1361. .TP
  1362. \fBSIGTERM\fR
  1363. Tor will catch this, clean up and sync to disk if necessary, and exit.
  1364. .LP
  1365. .TP
  1366. \fBSIGINT\fR
  1367. Tor clients behave as with SIGTERM; but Tor servers will do a controlled
  1368. slow shutdown, closing listeners and waiting 30 seconds before exiting.
  1369. (The delay can be configured with the ShutdownWaitLength config option.)
  1370. .LP
  1371. .TP
  1372. \fBSIGHUP\fR
  1373. The signal instructs Tor to reload its configuration (including closing
  1374. and reopening logs), fetch a new directory, and kill and restart its
  1375. helper processes if applicable.
  1376. .LP
  1377. .TP
  1378. \fBSIGUSR1\fR
  1379. Log statistics about current connections, past connections, and
  1380. throughput.
  1381. .LP
  1382. .TP
  1383. \fBSIGUSR2\fR
  1384. Switch all logs to loglevel debug. You can go back to the old loglevels
  1385. by sending a SIGHUP.
  1386. .LP
  1387. .TP
  1388. \fBSIGCHLD\fR
  1389. Tor receives this signal when one of its helper processes has exited,
  1390. so it can clean up.
  1391. .LP
  1392. .TP
  1393. \fBSIGPIPE\fR
  1394. Tor catches this signal and ignores it.
  1395. .LP
  1396. .TP
  1397. \fBSIGXFSZ\fR
  1398. If this signal exists on your platform, Tor catches and ignores it.
  1399. .SH FILES
  1400. .LP
  1401. .TP
  1402. .B @CONFDIR@/torrc
  1403. The configuration file, which contains "option value" pairs.
  1404. .LP
  1405. .TP
  1406. .B @LOCALSTATEDIR@/lib/tor/
  1407. The tor process stores keys and other data here.
  1408. .LP
  1409. .TP
  1410. .B \fIDataDirectory\fP/cached-status/*
  1411. 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.
  1412. .LP
  1413. .TP
  1414. .B \fIDataDirectory\fB/cached-descriptors\fR and \fBcached-descriptors.new\fR
  1415. These files hold downloaded router statuses. Some routers may appear more than once; if so, the most recently published descriptor is used. Lines beginning with @-signs are annotations that contain more information about a given router. The ".new" file is an append-only journal; when it gets too large, all entries are merged into a new cached-routers file.
  1416. .LP
  1417. .TP
  1418. .B \fIDataDirectory\fB/cached-routers\fR and \fBcached-routers.new\fR
  1419. Obsolete versions of cached-descriptors and cached-descriptors.new. When Tor can't find the newer files, it looks here instead.
  1420. .LP
  1421. .TP
  1422. .B \fIDataDirectory\fP/state
  1423. A set of persistent key-value mappings. These are documented in the file. These include:
  1424. .PD 0
  1425. .RS 5
  1426. .IP "- The current entry guards and their status."
  1427. .IP "- The current bandwidth accounting values (unused so far; see below)."
  1428. .IP "- When the file was last written"
  1429. .IP "- What version of Tor generated the state file"
  1430. .IP "- A short history of bandwidth usage, as produced in the router descriptors."
  1431. .RE
  1432. .PD
  1433. .LP
  1434. .TP
  1435. .B \fIDataDirectory\fP/bw_accounting
  1436. Used to track bandwidth accounting values (when the current period starts and ends; how much has been read and written so far this period). This file is obsolete, and the data is now stored in the 'state' file as well. Only used when bandwidth accounting is enabled.
  1437. .LP
  1438. .TP
  1439. .B \fIDataDirectory\fP/hsusage
  1440. Used to track hidden service usage in terms of fetch and publish
  1441. requests to this hidden service authoritative directory. Only used when
  1442. recording of statistics is enabled.
  1443. .LP
  1444. .TP
  1445. .B \fIDataDirectory\fP/control_auth_cookie
  1446. Used for cookie authentication with the controller. Location can be
  1447. overridden by the CookieAuthFile config option. Regenerated on startup.
  1448. See control-spec.txt for details. Only used when cookie authentication
  1449. is enabled.
  1450. .LP
  1451. .TP
  1452. .B \fIDataDirectory\fP/keys/*
  1453. Only used by servers. Holds identity keys and onion keys.
  1454. .LP
  1455. .TP
  1456. .B \fIDataDirectory\fP/fingerprint
  1457. Only used by servers. Holds the fingerprint of the server's identity key.
  1458. .LP
  1459. .TP
  1460. .B \fIDataDirectory\fP/approved-routers
  1461. 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.
  1462. .LP
  1463. .TP
  1464. .B \fIDataDirectory\fP/router-stability
  1465. Only used by authoritative directory servers. Tracks measurements for router mean-time-between-failures so that authorities have a good idea of how to set their Stable flags.
  1466. .LP
  1467. .TP
  1468. .B \fIHiddenServiceDirectory\fP/hostname
  1469. The <base32-encoded-fingerprint>.onion domain name for this hidden service.
  1470. If the hidden service is restricted to authorized clients only, this file
  1471. also contains authorization data for all clients.
  1472. .LP
  1473. .TP
  1474. .B \fIHiddenServiceDirectory\fP/private_key
  1475. The private key for this hidden service.
  1476. .LP
  1477. .TP
  1478. .B \fIHiddenServiceDirectory\fP/client_keys
  1479. Authorization data for a hidden service that is only accessible by authorized
  1480. clients.
  1481. .SH SEE ALSO
  1482. .BR privoxy (1),
  1483. .BR tsocks (1),
  1484. .BR torify (1)
  1485. .BR https://www.torproject.org/
  1486. .SH BUGS
  1487. Plenty, probably. Tor is still in development. Please report them.
  1488. .SH AUTHORS
  1489. Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.