tor.1.in 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351
  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 is currently defined as answers to directory
  91. requests, but that may change. (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. Lastly, if a flag
  206. "orport=\fBport\fR" is given, Tor will use the given port when opening
  207. encrypted tunnels to the dirserver.
  208. [XXX020 also mention v3ident= flag here]
  209. If no \fBdirserver\fP line is given, Tor will use the default
  210. directory servers. NOTE: this option is intended
  211. for setting up a private Tor network with its own directory authorities. If
  212. you use it, you will be distinguishable from other users, because you won't
  213. believe the same authorities they do.
  214. .LP
  215. .TP
  216. \fBFetchDirInfoEarly \fR\fB0\fR|\fB1\fR\fP
  217. If set to 1, Tor will always fetch directory information like other
  218. directory caches, even if you don't meet the normal criteria for
  219. fetching early. Normal users should leave it off.
  220. (Default: 0)
  221. .LP
  222. .TP
  223. \fBFetchHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
  224. If set to 0, Tor will never fetch any hidden service descriptors from
  225. the rendezvous directories. This option is only useful if you're using
  226. a Tor controller that handles hidserv fetches for you.
  227. (Default: 1)
  228. .LP
  229. .TP
  230. \fBFetchServerDescriptors \fR\fB0\fR|\fB1\fR\fP
  231. If set to 0, Tor will never fetch any network status summaries or server
  232. descriptors from the directory servers. This option is only useful if
  233. you're using a Tor controller that handles directory fetches for you.
  234. (Default: 1)
  235. .LP
  236. .TP
  237. \fBFetchUselessDescriptors \fR\fB0\fR|\fB1\fR\fP
  238. If set to 1, Tor will fetch every non-obsolete descriptor from the
  239. authorities that it hears about. Otherwise, it will avoid fetching
  240. useless descriptors, for example for routers that are not running.
  241. This option is useful if you're using the contributed "exitlist"
  242. script to enumerate Tor nodes that exit to certain addresses.
  243. (Default: 0)
  244. .LP
  245. .TP
  246. \fBGroup \fR\fIGID\fP
  247. On startup, setgid to this group.
  248. .LP
  249. .TP
  250. \fBHttpProxy\fR \fIhost\fR[:\fIport\fR]\fP
  251. Tor will make all its directory requests through this host:port
  252. (or host:80 if port is not specified),
  253. rather than connecting directly to any directory servers.
  254. .LP
  255. .TP
  256. \fBHttpProxyAuthenticator\fR \fIusername:password\fP
  257. If defined, Tor will use this username:password for Basic Http proxy
  258. authentication, as in RFC 2617. This is currently the only form of
  259. Http proxy authentication that Tor supports; feel free to submit a
  260. patch if you want it to support others.
  261. .LP
  262. .TP
  263. \fBHttpsProxy\fR \fIhost\fR[:\fIport\fR]\fP
  264. Tor will make all its OR (SSL) connections through this host:port
  265. (or host:443 if port is not specified), via HTTP CONNECT rather than
  266. connecting directly to servers. You may want to set \fBFascistFirewall\fR
  267. to restrict the set of ports you might try to connect to, if your Https
  268. proxy only allows connecting to certain ports.
  269. .LP
  270. .TP
  271. \fBHttpsProxyAuthenticator\fR \fIusername:password\fP
  272. If defined, Tor will use this username:password for Basic Https proxy
  273. authentication, as in RFC 2617. This is currently the only form of
  274. Https proxy authentication that Tor supports; feel free to submit a
  275. patch if you want it to support others.
  276. .LP
  277. .TP
  278. \fBKeepalivePeriod \fR\fINUM\fP
  279. To keep firewalls from expiring connections, send a padding keepalive
  280. cell every NUM seconds on open connections that are in use. If the
  281. connection has no open circuits, it will instead be closed after NUM
  282. seconds of idleness. (Default: 5 minutes)
  283. .LP
  284. .TP
  285. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBstderr\fR|\fBstdout\fR|\fBsyslog\fR\fP
  286. Send all messages between \fIminSeverity\fR and \fImaxSeverity\fR to
  287. the standard output stream, the standard error stream, or to the system
  288. log. (The "syslog" value is only supported on Unix.) Recognized
  289. severity levels are debug, info, notice, warn, and err. We advise using
  290. "notice" in most cases, since anything more verbose may provide sensitive
  291. information to an attacker who obtains the logs. If only one
  292. severity level is given, all messages of that level or higher will be
  293. sent to the listed destination.
  294. .LP
  295. .TP
  296. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBfile\fR \fIFILENAME\fP
  297. As above, but send log messages to the listed filename. The "Log"
  298. option may appear more than once in a configuration file. Messages
  299. are sent to all the logs that match their severity level.
  300. .LP
  301. .TP
  302. \fBOutboundBindAddress \fR\fIIP\fP
  303. Make all outbound connections originate from the IP address specified. This
  304. is only useful when you have multiple network interfaces, and you want all
  305. of Tor's outgoing connections to use a single one.
  306. .LP
  307. .TP
  308. \fBPidFile \fR\fIFILE\fP
  309. On startup, write our PID to FILE. On clean shutdown, remove FILE.
  310. .LP
  311. .TP
  312. \fBProtocolWarnings \fR\fB0\fR|\fB1\fR\fP
  313. If 1, Tor will log with severity 'warn' various cases of other parties
  314. not following the Tor specification. Otherwise, they are logged with
  315. severity 'info'. (Default: 0)
  316. .LP
  317. .TP
  318. \fBRunAsDaemon \fR\fB0\fR|\fB1\fR\fP
  319. If 1, Tor forks and daemonizes to the background. This option has
  320. no effect on Windows; instead you should use the --service command-line
  321. option. (Default: 0)
  322. .LP
  323. .TP
  324. \fBSafeLogging \fR\fB0\fR|\fB1\fP
  325. If 1, Tor replaces potentially sensitive strings in the logs
  326. (e.g. addresses) with the string [scrubbed]. This way logs can still be
  327. useful, but they don't leave behind personally identifying information
  328. about what sites a user might have visited. (Default: 1)
  329. .LP
  330. .TP
  331. \fBUser \fR\fIUID\fP
  332. On startup, setuid to this user.
  333. .LP
  334. .TP
  335. \fBHardwareAccel \fR\fB0\fR|\fB1\fP
  336. If non-zero, try to use crypto hardware acceleration when
  337. available. This is untested and probably buggy. (Default: 0)
  338. .LP
  339. .TP
  340. \fBAvoidDiskWrites \fR\fB0\fR|\fB1\fP
  341. If non-zero, try to write to disk less frequently than we would otherwise.
  342. This is useful when running on flash memory or other media that support only
  343. a limited number of writes. (Default: 0)
  344. .LP
  345. .TP
  346. \fBTunnelDirConns \fR\fB0\fR|\fB1\fP
  347. If non-zero, when a directory server we contact supports it, we will
  348. build a one-hop circuit and make an encrypted connection via its
  349. ORPort. (Default: 0)
  350. .LP
  351. .TP
  352. \fBPreferTunneledDirConns \fR\fB0\fR|\fB1\fP
  353. If non-zero, we will avoid directory servers that don't support tunneled
  354. directory connections, when possible. (Default: 0)
  355. .SH CLIENT OPTIONS
  356. .PP
  357. The following options are useful only for clients (that is, if \fBSocksPort\fP is non-zero):
  358. .LP
  359. .TP
  360. \fBAllowInvalidNodes\fR \fBentry\fR|\fBexit\fR|\fBmiddle\fR|\fBintroduction\fR|\fBrendezvous\fR|...\fP
  361. If some Tor servers are obviously not working right, the directory
  362. authorities can manually mark them as invalid, meaning that it's not
  363. recommended you use them for entry or exit positions in your circuits. You
  364. can opt to use them in some circuit positions, though. The default is
  365. "middle,rendezvous", and other choices are not advised.
  366. .LP
  367. .TP
  368. \fBBridge \fR\fIIP:ORPort\fR [fingerprint]\fP
  369. When set along with UseBridges, instructs Tor to use the relay at
  370. "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
  371. is provided (using the same format as for DirServer), we will verify that
  372. the relay running at that location has the right fingerprint. We also use
  373. fingerprint to look up the bridge descriptor at the bridge authority, if
  374. it's provided and if UpdateBridgesFromAuthority is set too.
  375. .LP
  376. .TP
  377. \fBCircuitBuildTimeout \fR\fINUM\fP
  378. Try for at most NUM seconds when building circuits. If the circuit
  379. isn't open in that time, give up on it.
  380. (Default: 1 minute.)
  381. .LP
  382. .TP
  383. \fBCircuitIdleTimeout \fR\fINUM\fP
  384. If we have kept a clean (never used) circuit around for NUM seconds,
  385. then close it. This way when the Tor client is entirely idle, it can
  386. expire all of its circuits, and then expire its TLS connections. Also,
  387. if we end up making a circuit that is not useful for exiting any of
  388. the requests we're receiving, it won't forever take up a slot in the
  389. circuit list.
  390. (Default: 1 hour.)
  391. .LP
  392. .TP
  393. \fBClientOnly \fR\fB0\fR|\fB1\fR\fP
  394. If set to 1, Tor will under no circumstances run as a server or serve
  395. directory requests. The default
  396. is to run as a client unless ORPort is configured. (Usually,
  397. you don't need to set this; Tor is pretty smart at figuring out whether
  398. you are reliable and high-bandwidth enough to be a useful server.)
  399. (Default: 0)
  400. .LP
  401. .TP
  402. \fBExcludeNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  403. A list of identity fingerprints or nicknames of nodes to never use when
  404. building a circuit.
  405. .LP
  406. .TP
  407. \fBEntryNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  408. A list of identity fingerprints or nicknames of preferred nodes to use for the
  409. first hop in the circuit.
  410. These are treated only as preferences unless StrictEntryNodes (see
  411. below) is also set.
  412. .LP
  413. .TP
  414. \fBExitNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  415. A list of identity fingerprints or nicknames of preferred nodes to use for the
  416. last hop in the circuit.
  417. These are treated only as preferences unless StrictExitNodes (see
  418. below) is also set.
  419. .LP
  420. .TP
  421. \fBStrictEntryNodes \fR\fB0\fR|\fB1\fR\fP
  422. If 1, Tor will never use any nodes besides those listed in "EntryNodes" for
  423. the first hop of a circuit.
  424. .LP
  425. .TP
  426. \fBStrictExitNodes \fR\fB0\fR|\fB1\fR\fP
  427. If 1, Tor will never use any nodes besides those listed in "ExitNodes" for
  428. the last hop of a circuit.
  429. .LP
  430. .TP
  431. \fBFascistFirewall \fR\fB0\fR|\fB1\fR\fP
  432. If 1, Tor will only create outgoing connections to ORs running on ports that
  433. your firewall allows (defaults to 80 and 443; see \fBFirewallPorts\fR). This will
  434. allow you to run Tor as a client behind a firewall with restrictive policies,
  435. but will not allow you to run as a server behind such a firewall.
  436. If you prefer more fine-grained control, use ReachableAddresses instead.
  437. .LP
  438. .TP
  439. \fBFirewallPorts \fR\fIPORTS\fP
  440. A list of ports that your firewall allows you to connect to. Only
  441. used when \fBFascistFirewall\fR is set. This option is deprecated; use
  442. ReachableAddresses instead. (Default: 80, 443)
  443. .LP
  444. .TP
  445. \fBReachableAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  446. A comma-separated list of IP addresses and ports that your firewall allows you
  447. to connect to. The format is as
  448. for the addresses in ExitPolicy, except that "accept" is understood
  449. unless "reject" is explicitly provided. For example, 'ReachableAddresses
  450. 99.0.0.0/8, reject 18.0.0.0/8:80, accept *:80' means that your
  451. firewall allows connections to everything inside net 99, rejects port
  452. 80 connections to net 18, and accepts connections to port 80 otherwise.
  453. (Default: 'accept *:*'.)
  454. .LP
  455. .TP
  456. \fBReachableDirAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  457. Like \fBReachableAddresses\fP, a list of addresses and ports. Tor will obey
  458. these restrictions when fetching directory information, using standard HTTP
  459. GET requests. If not set explicitly then the value of \fBReachableAddresses\fP
  460. is used. If \fBHttpProxy\fR is set then these connections will go through that
  461. proxy.
  462. .LP
  463. .TP
  464. \fBReachableORAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  465. Like \fBReachableAddresses\fP, a list of addresses and ports. Tor will obey
  466. these restrictions when connecting to Onion Routers, using TLS/SSL. If not set
  467. explicitly then the value of \fBReachableAddresses\fP is used. If
  468. \fBHttpsProxy\fR is set then these connections will go through that proxy.
  469. The separation between \fBReachableORAddresses\fP and
  470. \fBReachableDirAddresses\fP is only interesting when you are connecting through
  471. proxies (see \fBHttpProxy\fR and \fBHttpsProxy\fR). Most proxies limit TLS
  472. connections (which Tor uses to connect to Onion Routers) to port 443, and some
  473. limit HTTP GET requests (which Tor uses for fetching directory information) to
  474. port 80.
  475. .LP
  476. .TP
  477. \fBLongLivedPorts \fR\fIPORTS\fP
  478. A list of ports for services that tend to have long-running connections
  479. (e.g. chat and interactive shells). Circuits for streams that use these
  480. ports will contain only high-uptime nodes, to reduce the chance that a
  481. node will go down before the stream is finished.
  482. (Default: 21, 22, 706, 1863, 5050, 5190, 5222, 5223, 6667, 6697, 8300)
  483. .LP
  484. .TP
  485. \fBMapAddress\fR \fIaddress\fR \fInewaddress\fR
  486. When a request for address arrives to Tor, it will rewrite it to
  487. newaddress before processing it. For example, if you always want
  488. connections to www.indymedia.org to exit via \fItorserver\fR (where
  489. \fItorserver\fR is the nickname of the server),
  490. use "MapAddress www.indymedia.org www.indymedia.org.torserver.exit".
  491. .LP
  492. .TP
  493. \fBNewCircuitPeriod \fR\fINUM\fP
  494. Every NUM seconds consider whether to build a new circuit. (Default: 30 seconds)
  495. .LP
  496. .TP
  497. \fBMaxCircuitDirtiness \fR\fINUM\fP
  498. Feel free to reuse a circuit that was first used at most NUM seconds ago,
  499. but never attach a new stream to a circuit that is too old.
  500. (Default: 10 minutes)
  501. .LP
  502. .TP
  503. \fBNodeFamily \fR\fInode\fR,\fInode\fR,\fI...\fP
  504. The Tor servers, defined by their identity fingerprints or nicknames,
  505. constitute a "family" of similar or co-administered
  506. servers, so never use any two of them in the same circuit. Defining a
  507. NodeFamily is only needed when a server doesn't list the family itself
  508. (with MyFamily). This option can be used multiple times.
  509. .LP
  510. .TP
  511. \fBEnforceDistinctSubnets \fR\fB0\fR|\fB1\fR\fP
  512. If 1, Tor will not put two servers whose IP addresses are "too
  513. close" on the same circuit. Currently, two addresses are
  514. "too close" if they lie in the same /16 range. (Default: 1)
  515. .\" \fBPathlenCoinWeight \fR\fI0.0-1.0\fP
  516. .\" Paths are 3 hops plus a geometric distribution centered around this coinweight.
  517. .\" Must be >=0.0 and <1.0. (Default: 0.3) NOT USED CURRENTLY
  518. .\" .TP
  519. .LP
  520. .TP
  521. \fBRendNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  522. A list of identity fingerprints or nicknames of preferred nodes to use for the
  523. rendezvous point, if possible.
  524. .LP
  525. .TP
  526. \fBRendExcludeNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  527. A list of identity fingerprints or nicknames of nodes to never use when
  528. choosing a rendezvous point.
  529. .LP
  530. .TP
  531. \fBSocksPort \fR\fIPORT\fP
  532. Advertise this port to listen for connections from Socks-speaking
  533. applications. Set this to 0 if you don't want to allow application
  534. connections. (Default: 9050)
  535. .LP
  536. .TP
  537. \fBSocksListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  538. Bind to this address to listen for connections from Socks-speaking
  539. applications. (Default: 127.0.0.1) You can also specify a port
  540. (e.g. 192.168.0.1:9100).
  541. This directive can be specified multiple times to bind to multiple
  542. addresses/ports.
  543. .LP
  544. .TP
  545. \fBSocksPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  546. Set an entrance policy for this server, to limit who can connect to the
  547. SocksPort and DNSPort ports.
  548. The policies have the same form as exit policies below.
  549. .LP
  550. .TP
  551. \fBSocksTimeout \fR\fINUM\fP
  552. Let a socks connection wait NUM seconds handshaking, and NUM seconds
  553. unattached waiting for an appropriate circuit, before we fail it.
  554. (Default: 2 minutes.)
  555. .LP
  556. .TP
  557. \fBTestVia \fR\fInode\fR,\fInode\fR,\fI...\fP
  558. A list of identity fingerprints or nicknames of nodes to prefer for your middle
  559. hop when building testing circuits. This option is mainly for debugging
  560. reachability problems.
  561. .LP
  562. .TP
  563. \fBTrackHostExits \fR\fIhost\fR,\fI.domain\fR,\fI...\fR\fP
  564. For each value in the comma separated list, Tor will track recent connections
  565. to hosts that match this value and attempt to
  566. reuse the same exit node for each. If the value is prepended with a '.', it is
  567. treated as matching an entire domain. If one of the values is just a '.', it
  568. means match everything. This option is useful if you frequently connect to
  569. sites that will expire all your authentication cookies (ie log you out) if
  570. your IP address changes. Note that this option does have the disadvantage of
  571. making it more clear that a given history is
  572. associated with a single user. However, most people who would wish to observe
  573. this will observe it through cookies or other protocol-specific means anyhow.
  574. .LP
  575. .TP
  576. \fBTrackHostExitsExpire \fR\fINUM\fP
  577. Since exit servers go up and down, it is desirable to expire the association
  578. between host and exit server after NUM seconds. The default
  579. is 1800 seconds (30 minutes).
  580. .LP
  581. .TP
  582. \fBUpdateBridgesFromAuthority \fR\fB0\fR|\fB1\fR\fP
  583. When set (along with UseBridges), Tor will try to fetch bridge descriptors
  584. from the configured bridge authorities when feasible. It will fall back
  585. to a direct request if the authority responds with a 404. (Default: 0)
  586. .LP
  587. .TP
  588. \fBUseBridges \fR\fB0\fR|\fB1\fR\fP
  589. When set, Tor will fetch descriptors for each bridge listed in the
  590. "Bridge" config lines, and use these relays as both entry guards and
  591. directory guards. (Default: 0)
  592. .LP
  593. .TP
  594. \fBUseEntryGuards \fR\fB0\fR|\fB1\fR\fP
  595. If this option is set to 1, we pick a few long-term entry servers, and
  596. try to stick with them. This is desirable because
  597. constantly changing servers increases the odds that an adversary who owns
  598. some servers will observe a fraction of your paths.
  599. (Defaults to 1.)
  600. .LP
  601. .TP
  602. \fBNumEntryGuards \fR\fINUM\fP
  603. If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
  604. as long-term entries for our circuits.
  605. (Defaults to 3.)
  606. .LP
  607. .TP
  608. \fBSafeSocks \fR\fB0\fR|\fB1\fR\fP
  609. When this option is enabled, Tor will reject application connections that
  610. use unsafe variants of the socks protocol -- ones that only provide an
  611. IP address, meaning the application is doing a DNS resolve first.
  612. Specifically, these are socks4 and socks5 when not doing remote DNS.
  613. (Defaults to 0.)
  614. .LP
  615. .TP
  616. \fBTestSocks \fR\fB0\fR|\fB1\fR\fP
  617. When this option is enabled, Tor will make a notice-level log entry for
  618. each connection to the Socks port indicating whether the request used
  619. a safe socks protocol or an unsafe one (see above entry on SafeSocks).
  620. This helps to determine whether an application using Tor is possibly
  621. leaking DNS requests.
  622. (Default: 0)
  623. .LP
  624. .TP
  625. \fBVirtualAddrNetwork \fR\fIAddress\fB/\fIbits\fP
  626. When a controller asks for a virtual (unused) address with the
  627. MAPADDRESS command, Tor picks an unassigned address from this range.
  628. (Default: 127.192.0.0/10)
  629. When providing proxy server service to a network of computers using a tool like
  630. dns-proxy-tor,
  631. change this address to "10.192.0.0/10" or "172.16.0.0/12".
  632. The default \fBVirtualAddrNetwork\fP address range on a
  633. properly configured machine will route to the loopback interface.
  634. For local use, no change to the
  635. default \fBVirtualAddrNetwork\fP setting is needed.
  636. .LP
  637. .TP
  638. \fBAllowNonRFC953Hostnames \fR\fB0\fR|\fB1\fR\fP
  639. When this option is disabled, Tor blocks hostnames containing illegal
  640. characters (like @ and :) rather than sending them to an exit node to be
  641. resolved. This helps trap accidental attempts to resolve URLs and so on.
  642. (Default: 0)
  643. .LP
  644. .TP
  645. \fBFastFirstHopPK \fR\fB0\fR|\fB1\fR\fP
  646. When this option is enabled and we aren't running as a server, Tor
  647. skips the public key step for the first hop of creating circuits. This is
  648. safe since we have already used TLS to authenticate the server and to
  649. establish forward-secure keys. Turning this option off makes circuit
  650. building slower.
  651. (Default: 1)
  652. .LP
  653. .TP
  654. \fBTransPort\fP \fR\fIPORT\fP
  655. If non-zero, enables transparent proxy support on \fR\fIPORT\fP (by
  656. convention, 9040).
  657. .\" This is required to enable support for \fBdns-proxy-tor\fP.
  658. .\" ControlPort must be set when using \fBTransPort\fP.
  659. Requires OS support for transparent proxies, such as BSDs' pf or
  660. Linux's IPTables.
  661. If you're planning
  662. to use Tor as a transparent proxy for a network, you'll want to examine
  663. and change VirtualAddrNetwork from the default setting. You'll also want
  664. to set the TransListenAddress option for the network you'd like to proxy.
  665. (Default: 0).
  666. .LP
  667. .TP
  668. \fBTransListenAddress\fP \fR\fIIP\fR[:\fIPORT\fR]\fP
  669. Bind to this address to listen for transparent proxy connections.
  670. (Default: 127.0.0.1).
  671. This is useful for exporting a transparent proxy server
  672. to an entire network.
  673. .LP
  674. .TP
  675. \fBNATDPort\fP \fR\fIPORT\fP
  676. Allow old versions of ipfw (as included in old versions of FreeBSD,
  677. etc.) to send connections through Tor using the NATD protocol.
  678. This option is only for people who cannot
  679. use TransPort.
  680. .LP
  681. .TP
  682. \fBNATDListenAddress\fP \fR\fIIP\fR[:\fIPORT\fR]\fP
  683. Bind to this address to listen for NATD connections.
  684. (Default: 127.0.0.1).
  685. .LP
  686. .TP
  687. \fBAutomapHostsOnResolve\fP \fR\fB0\fR|\fB1\fR\fP
  688. When this option is enabled, and we get a request to resolve an
  689. address that ends with one of the suffixes in
  690. \fBAutomapHostsSuffixes\fP, we map an unused virtual address to that
  691. address, and return the new virtual address. This is handy for making
  692. .onion addresses work with applications that resolve an address and
  693. then connect to it.
  694. (Default: 0).
  695. .LP
  696. .TP
  697. \fBAutomapHostsSuffixes\fP \fR\fISUFFIX\fR,\fISUFFIX\fR,...\fP
  698. A comma-separated list of suffixes to use with \fBAutomapHostsOnResolve\fP.
  699. The "." suffix is equivalent to "all addresses."
  700. (Default: .exit,.onion).
  701. .LP
  702. .TP
  703. \fBDNSPort\fP \fR\fIPORT\fP
  704. If non-zero, Tor listens for UDP DNS requests on this port and resolves them
  705. anonymously.
  706. (Default: 0).
  707. .LP
  708. .TP
  709. \fBDNSListenAddress\fP \fR\fIIP\fR[:\fIPORT\fR]\fP
  710. Bind to this address to listen for DNS connections.
  711. (Default: 127.0.0.1).
  712. .LP
  713. .TP
  714. \fBClientDNSRejectInternalAddresses\fP \fR\fB0\fR|\fB1\fR\fP
  715. If true, Tor does not believe any anonymously retrieved DNS answer that tells
  716. it that an address resolves to an internal address (like 127.0.0.1 or
  717. 192.168.0.1). This option prevents certain browser-based attacks; don't turn
  718. it off unless you know what you're doing. (Default: 1).
  719. .LP
  720. .TP
  721. \fBDownloadExtraInfo\fP \fR\fB0\fR|\fB1\fR\fP
  722. If true, Tor downloads and caches "extra-info" documents. These
  723. documents contain information about servers other than the information
  724. in their regular router descriptors. Tor does not use this information for
  725. anything itself; to save bandwidth, leave this option turned off.
  726. (Default: 0).
  727. .LP
  728. .TP
  729. \fBFallbackNetworkstatusFile\fP \fIFILENAME\fP
  730. If Tor doesn't have a cached networkstatus file, it starts out using
  731. this one instead. Even if this file is out of date, Tor can still use
  732. it to learn about directory mirrors, so it doesn't need to put load on
  733. the authorities. (Default: None).
  734. .LP
  735. .TP
  736. .SH SERVER OPTIONS
  737. .PP
  738. The following options are useful only for servers (that is, if \fBORPort\fP is non-zero):
  739. .LP
  740. .TP
  741. \fBAddress \fR\fIaddress\fP
  742. The IP address or fqdn of this server (e.g. moria.mit.edu). You can
  743. leave this unset, and Tor will guess your IP address.
  744. .LP
  745. .TP
  746. \fBAssumeReachable \fR\fB0\fR|\fB1\fR\fP
  747. This option is used when bootstrapping a new Tor network. If set to 1,
  748. don't do self-reachability testing; just upload your server descriptor
  749. immediately. If \fBAuthoritativeDirectory\fP is also set, this option
  750. instructs the dirserver to bypass remote reachability testing too and
  751. list all connected servers as running.
  752. .LP
  753. .TP
  754. \fBBridgeRelay \fR\fB0\fR|\fB1\fR\fP
  755. Sets the relay to act as a "bridge" with respect to relaying connections
  756. from bridge users to the Tor network. Mainly it influences how the relay
  757. will cache and serve directory information. Usually used in combination
  758. with PublishServerDescriptor.
  759. .LP
  760. .TP
  761. \fBContactInfo \fR\fIemail_address\fP
  762. Administrative contact information for server. This line might get
  763. picked up by spam harvesters, so you may want to obscure the fact
  764. that it's an email address.
  765. .LP
  766. .TP
  767. \fBExitPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  768. Set an exit policy for this server. Each policy is of the form
  769. "\fBaccept\fP|\fBreject\fP \fIADDR\fP[\fB/\fP\fIMASK\fP]\fB[:\fP\fIPORT\fP]".
  770. If \fB/\fP\fIMASK\fP is omitted then this policy just applies to the host
  771. given. Instead of giving a host or network you can also use "\fB*\fP" to
  772. denote the universe (0.0.0.0/0). \fIPORT\fP can be a single port number,
  773. an interval of ports "\fIFROM_PORT\fP\fB-\fP\fITO_PORT\fP", or "\fB*\fP".
  774. If \fIPORT\fP is omitted, that means "\fB*\fP".
  775. For example, "accept 18.7.22.69:*,reject 18.0.0.0/8:*,accept *:*" would
  776. reject any traffic destined for MIT except for web.mit.edu, and
  777. accept anything else.
  778. To specify all internal and link-local networks (including 0.0.0.0/8,
  779. 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
  780. 172.16.0.0/12), you can use the "private" alias instead of an address.
  781. These addresses are rejected by default (at the beginning of your
  782. exit policy), along with your public IP address, unless you set the
  783. ExitPolicyRejectPrivate config option
  784. to 0. For example, once you've done that, you could allow HTTP to
  785. 127.0.0.1 and block all other connections to internal networks with
  786. "accept 127.0.0.1:80,reject private:*", though that may also allow
  787. connections to your own computer that are addressed to its public
  788. (external) IP address. See RFC 1918 and RFC 3330 for more
  789. details about internal and reserved IP address space.
  790. This directive can be specified multiple times so you don't have to put
  791. it all on one line.
  792. Policies are considered first to last, and the first match wins. If
  793. you want to _replace_ the default exit policy, end your exit policy with
  794. either a reject *:* or an accept *:*. Otherwise, you're _augmenting_
  795. (prepending to) the default exit policy. The default exit policy is:
  796. .PD 0
  797. .RS 12
  798. .IP "reject *:25"
  799. .IP "reject *:119"
  800. .IP "reject *:135-139"
  801. .IP "reject *:445"
  802. .IP "reject *:465"
  803. .IP "reject *:563"
  804. .IP "reject *:587"
  805. .IP "reject *:1214"
  806. .IP "reject *:4661-4666"
  807. .IP "reject *:6346-6429"
  808. .IP "reject *:6699"
  809. .IP "reject *:6881-6999"
  810. .IP "accept *:*"
  811. .RE
  812. .PD
  813. .LP
  814. .TP
  815. \fBExitPolicyRejectPrivate \fR\fB0\fR|\fB1\fR\fP
  816. Reject all private (local) networks, along with your own public IP
  817. address, at the beginning of your exit
  818. policy. See above entry on ExitPolicy. (Default: 1)
  819. .LP
  820. .TP
  821. \fBMaxOnionsPending \fR\fINUM\fP
  822. If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
  823. .LP
  824. .TP
  825. \fBMyFamily \fR\fInode\fR,\fInode\fR,\fI...\fP
  826. Declare that this Tor server is controlled or administered by a group
  827. or organization identical or similar to that of the other servers, defined by their identity fingerprints or nicknames.
  828. When two servers both declare that they are in the same 'family', Tor clients
  829. will not use them in the same circuit. (Each server only needs to list the
  830. other servers in its family; it doesn't need to list itself, but it won't hurt.)
  831. .LP
  832. .TP
  833. \fBNickname \fR\fIname\fP
  834. Set the server's nickname to 'name'. Nicknames must be between 1
  835. and 19 characters inclusive, and must contain only the characters
  836. [a-zA-Z0-9].
  837. .LP
  838. .TP
  839. \fBNumCPUs \fR\fInum\fP
  840. How many processes to use at once for decrypting onionskins. (Default: 1)
  841. .LP
  842. .TP
  843. \fBORPort \fR\fIPORT\fP
  844. Advertise this port to listen for connections from Tor clients and servers.
  845. .LP
  846. .TP
  847. \fBORListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  848. Bind to this IP address to listen for connections from Tor clients and
  849. servers. If you specify a port, bind to this port rather than the one
  850. specified in ORPort. (Default: 0.0.0.0)
  851. This directive can be specified multiple times to bind to multiple
  852. addresses/ports.
  853. .LP
  854. .TP
  855. \fBPublishServerDescriptor \fR\fB0\fR|\fB1\fR|\fBv1\fR|\fBv2\fR|\fBv3\fR|\fBbridge\fR|\fBhidserv\fR, ...\fP
  856. This option is only considered if you have an ORPort defined. You can
  857. choose multiple arguments, separated by commas.
  858. If set to 0, Tor will act as a server but it will not publish its
  859. descriptor to the directory authorities. (This is useful if you're
  860. testing out your server, or if you're using a Tor controller that handles
  861. directory publishing for you.) Otherwise, Tor will publish its descriptor
  862. to all directory authorities of the type(s) specified. The value "1" is
  863. treated as a synonym for the default, which is currently "v2,v3".
  864. .LP
  865. .TP
  866. \fBRedirectExit \fR\fIpattern target\fP
  867. THIS OPTION IS DEPRECATED. It will go away in a future version of Tor.
  868. Whenever an outgoing connection tries to connect to one of a given set
  869. of addresses, connect to \fItarget\fP (an \fIaddress:port\fP pair) instead.
  870. The address
  871. pattern is given in the same format as for an exit policy. The
  872. address translation applies after exit policies are applied. Multiple
  873. \fBRedirectExit\fP options can be used: once any one has matched
  874. successfully, no subsequent rules are considered. You can specify that no
  875. redirection is to be performed on a given set of addresses by using the
  876. special target string "pass", which prevents subsequent rules from being
  877. considered.
  878. .LP
  879. .TP
  880. \fBShutdownWaitLength\fR \fINUM\fP
  881. When we get a SIGINT and we're a server, we begin shutting down: we close
  882. listeners and start refusing new circuits. After \fBNUM\fP seconds,
  883. we exit. If we get a second SIGINT, we exit immediately. (Default:
  884. 30 seconds)
  885. .LP
  886. .TP
  887. \fBAccountingMax \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  888. Never send more than the specified number of bytes in a given
  889. accounting period, or receive more than that number in the period.
  890. For example, with AccountingMax set to 1 GB, a server could send 900 MB
  891. and receive 800 MB and continue running. It will only hibernate once one
  892. of the two reaches 1 GB.
  893. When the number of bytes is exhausted, Tor will hibernate until some
  894. time in the next accounting period. To prevent all servers from
  895. waking at the same time, Tor will also wait until a random point in
  896. each period before waking up. If you have bandwidth cost issues,
  897. enabling hibernation is preferable to setting a low bandwidth, since it
  898. provides users with a collection of fast servers that are up some of
  899. the time, which is more useful than a set of slow servers that are
  900. always "available".
  901. .LP
  902. .TP
  903. \fBAccountingStart \fR\fBday\fR|\fBweek\fR|\fBmonth\fR [\fIday\fR] \fIHH:MM\fR\fP
  904. Specify how long accounting periods last. If \fBmonth\fP is given,
  905. each accounting period runs from the time \fIHH:MM\fR on the
  906. \fIday\fRth day of one month to the same day and time of the next.
  907. (The day must be between 1 and 28.) If \fBweek\fP is given, each
  908. accounting period runs from the time \fIHH:MM\fR of the \fIday\fRth
  909. day of one week to the same day and time of the next week, with Monday
  910. as day 1 and Sunday as day 7. If \fBday\fR is given, each accounting
  911. period runs from the time \fIHH:MM\fR each day to the same time on the
  912. next day. All times are local, and given in 24-hour time. (Defaults to
  913. "month 1 0:00".)
  914. .LP
  915. .TP
  916. \fBServerDNSResolvConfFile \fR\fIfilename\fP
  917. Overrides the default DNS configuration with the configuration in
  918. \fIfilename\fP. The file format is the same as the standard Unix
  919. "\fBresolv.conf\fP" file (7). This option, like all other
  920. ServerDNS options, only affects name lookups that your server does on
  921. behalf of clients. Also, it only takes effect if Tor was built with
  922. eventdns support. (Defaults to use the system DNS configuration.)
  923. .LP
  924. .TP
  925. \fBServerDNSSearchDomains \fR\fB0\fR|\fB1\fR\fP
  926. If set to \fB1\fP, then we will search for addresses in the local search
  927. domain. For example, if this system is configured to believe it is in
  928. "example.com", and a client tries to connect to "www", the client will be
  929. connected to "www.example.com".
  930. This option only affects name lookups that your server does on
  931. behalf of clients, and only takes effect if Tor was built with
  932. eventdns support.
  933. (Defaults to "0".)
  934. .LP
  935. .TP
  936. \fBServerDNSDetectHijacking \fR\fB0\fR|\fB1\fR\fP
  937. When this option is set to 1, we will test periodically to determine whether
  938. our local nameservers have been configured to hijack failing DNS requests
  939. (usually to an advertising site). If they are, we will attempt to correct
  940. this.
  941. This option only affects name lookups that your server does on
  942. behalf of clients, and only takes effect if Tor was built with
  943. eventdns support.
  944. (Defaults to "1".)
  945. .LP
  946. .TP
  947. \fBServerDNSTestAddresses \fR\fIaddress\fR,\fIaddress\fR,\fI...\fP
  948. When we're detecting DNS hijacking, make sure that these \fIvalid\fP
  949. addresses aren't getting redirected. If they are, then our DNS is
  950. completely useless, and we'll reset our exit policy to "reject *:*".
  951. This option only affects name lookups that your server does on
  952. behalf of clients, and only takes effect if Tor was built with
  953. eventdns support.
  954. (Defaults to "www.google.com, www.mit.edu, www.yahoo.com,
  955. www.slashdot.org".)
  956. .LP
  957. .TP
  958. \fBServerDNSAllowNonRFC953Hostnames \fR\fB0\fR|\fB1\fR\fP
  959. When this option is disabled, Tor does not try to resolve hostnames
  960. containing illegal characters (like @ and :) rather than sending them to an
  961. exit node to be resolved. This helps trap accidental attempts to resolve
  962. URLs and so on.
  963. This option only affects name lookups that your server does on
  964. behalf of clients, and only takes effect if Tor was built with
  965. eventdns support.
  966. (Default: 0)
  967. .LP
  968. .TP
  969. \fBBridgeRecordUsageByCountry \fR\fB0\fR|\fB1\fR\fP
  970. When this option is enabled and BridgeRelay is also enabled, and we
  971. have GeoIP data, Tor keeps a keep a per-country count of how many
  972. client addresses have contacted it so that it can help the bridge
  973. authority guess which countries have blocked access to it.
  974. .LP
  975. .TP
  976. \fBGeoIPFile \fR\fIfilename\fP
  977. A filename containing GeoIP data, for use with BridgeRecordUsageByCountry.
  978. .SH DIRECTORY SERVER OPTIONS
  979. .PP
  980. The following options are useful only for directory servers (that is, if \fBDirPort\fP is non-zero):
  981. .LP
  982. .TP
  983. \fBAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  984. When this option is set to 1, Tor operates as an authoritative
  985. directory server. Instead of caching the directory, it generates its
  986. own list of good servers, signs it, and sends that to the clients.
  987. Unless the clients already have you listed as a trusted directory, you
  988. probably do not want to set this option. Please coordinate with the other
  989. admins at tor-ops@freehaven.net if you think you should be a directory.
  990. .LP
  991. .TP
  992. \fBV1AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  993. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  994. generates version 1 directory and running-routers documents (for legacy
  995. Tor clients up to 0.1.0.x).
  996. .LP
  997. .TP
  998. \fBV2AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  999. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  1000. generates version 2 network statuses and serves descriptors, etc as
  1001. described in doc/spec/dir-spec-v2.txt (for Tor clients and servers
  1002. running 0.1.1.x and 0.1.2.x).
  1003. .LP
  1004. .TP
  1005. \fBV3AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1006. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  1007. generates version 3 network statuses and serves descriptors, etc as
  1008. described in doc/spec/dir-spec.txt (for Tor clients and servers
  1009. running at least 0.2.0.x).
  1010. .LP
  1011. .TP
  1012. \fBVersioningAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1013. When this option is set to 1, Tor adds information on
  1014. which versions of Tor are still believed safe for use to
  1015. the published directory. Each version 1 authority is
  1016. automatically a versioning authority; version 2 authorities
  1017. provide this service optionally. See \fBRecommendedVersions\fP,
  1018. \fBRecommendedClientVersions\fP, and \fBRecommendedServerVersions\fP.
  1019. .LP
  1020. .TP
  1021. \fBNamingAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  1022. When this option is set to 1, then the server advertises that it has
  1023. opinions about nickname-to-fingerprint bindings. It will include these
  1024. opinions in its published network-status pages, by listing servers with
  1025. the flag "Named" if a correct binding between that nickname and
  1026. fingerprint has been registered with the dirserver. Naming dirservers
  1027. will refuse to accept or publish descriptors that contradict a
  1028. registered binding. See \fBapproved-routers\fP in the \fBFILES\fP
  1029. section below.
  1030. .LP
  1031. .TP
  1032. \fBHSAuthoritativeDir \fR\fB0\fR|\fB1\fR\fP
  1033. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor also
  1034. accepts and serves hidden service descriptors. (Default: 0)
  1035. .LP
  1036. .TP
  1037. \fBHSAuthorityRecordStats \fR\fB0\fR|\fB1\fR\fP
  1038. When this option is set in addition to \fBHSAuthoritativeDir\fP, Tor
  1039. periodically (every 15 minutes) writes statistics about hidden service
  1040. usage to a file \fBhsusage\fP in its data directory. (Default: 0)
  1041. .LP
  1042. .TP
  1043. \fBHidServDirectoryV2 \fR\fB0\fR|\fB1\fR\fP
  1044. When this option is set, Tor accepts and serves v2 hidden service
  1045. descriptors. (Default: 0)
  1046. .LP
  1047. .TP
  1048. \fBBridgeAuthoritativeDir \fR\fB0\fR|\fB1\fR\fP
  1049. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor
  1050. accepts and serves router descriptors, but it caches and serves the main
  1051. networkstatus documents rather than generating its own. (Default: 0)
  1052. .LP
  1053. .TP
  1054. \fBMinUptimeHidServDirectoryV2 \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  1055. Minimum uptime of a v2 hidden service directory to be accepted as such by
  1056. authoritative directories. (Default: 24 hours)
  1057. .LP
  1058. .TP
  1059. \fBDirPort \fR\fIPORT\fP
  1060. Advertise the directory service on this port.
  1061. .LP
  1062. .TP
  1063. \fBDirListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  1064. Bind the directory service to this address. If you specify a port, bind
  1065. to this port rather than the one specified in DirPort. (Default: 0.0.0.0)
  1066. This directive can be specified multiple times to bind to multiple
  1067. addresses/ports.
  1068. .LP
  1069. .TP
  1070. \fBDirPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  1071. Set an entrance policy for this server, to limit who can connect to the
  1072. directory ports.
  1073. The policies have the same form as exit policies above.
  1074. .LP
  1075. .TP
  1076. \fBRecommendedVersions \fR\fISTRING\fP
  1077. STRING is a comma-separated list of Tor versions currently believed
  1078. to be safe. The list is included in each directory, and nodes which
  1079. pull down the directory learn whether they need to upgrade. This
  1080. option can appear multiple times: the values from multiple lines are
  1081. spliced together.
  1082. When this is set then
  1083. \fBVersioningAuthoritativeDirectory\fP should be set too.
  1084. .LP
  1085. .TP
  1086. \fBRecommendedClientVersions \fR\fISTRING\fP
  1087. STRING is a comma-separated list of Tor versions currently believed
  1088. to be safe for clients to use. This information is included in version 2
  1089. directories. If this is not set then the value of \fBRecommendedVersions\fR
  1090. is used.
  1091. When this is set then
  1092. \fBVersioningAuthoritativeDirectory\fP should be set too.
  1093. .LP
  1094. .TP
  1095. \fBRecommendedServerVersions \fR\fISTRING\fP
  1096. STRING is a comma-separated list of Tor versions currently believed
  1097. to be safe for servers to use. This information is included in version 2
  1098. directories. If this is not set then the value of \fBRecommendedVersions\fR
  1099. is used.
  1100. When this is set then
  1101. \fBVersioningAuthoritativeDirectory\fP should be set too.
  1102. .LP
  1103. .TP
  1104. \fBDirAllowPrivateAddresses \fR\fB0\fR|\fB1\fR\fP
  1105. If set to 1, Tor will accept router descriptors with arbitrary "Address"
  1106. elements. Otherwise, if the address is not an IP address or is a private
  1107. IP address, it will reject the router descriptor. Defaults to 0.
  1108. .LP
  1109. .TP
  1110. \fBAuthDirBadExit \fR\fIAddressPattern\fR...\fP
  1111. Authoritative directories only. A set of address patterns for servers that
  1112. will be listed as bad exits in any network status document this authority
  1113. publishes, if \fBAuthDirListBadExits\fR is set.
  1114. .LP
  1115. .TP
  1116. \fBAuthDirInvalid \fR\fIAddressPattern\fR...\fP
  1117. Authoritative directories only. A set of address patterns for servers that
  1118. will never be listed as "valid" in any network status document that this
  1119. authority publishes.
  1120. .LP
  1121. .TP
  1122. \fBAuthDirReject \fR\fIAddressPattern\fR...\fP
  1123. Authoritative directories only. A set of address patterns for servers that
  1124. will never be listed at all in any network status document that this
  1125. authority publishes, or accepted as an OR address in any descriptor submitted
  1126. for publication by this authority.
  1127. .LP
  1128. .TP
  1129. \fBAuthDirListBadExits \fR\fB0\fR|\fB1\fR\fP
  1130. Authoritative directories only. If set to 1, this directory has
  1131. some opinion about which nodes are unsuitable as exit nodes. (Do not
  1132. set this to 1 unless you plan to list nonfunctioning exits as bad;
  1133. otherwise, you are effectively voting in favor of every declared exit
  1134. as an exit.)
  1135. .LP
  1136. .TP
  1137. \fBAuthDirRejectUnlisted \fR\fB0\fR|\fB1\fR\fP
  1138. Authoritative directories only. If set to 1, the directory server
  1139. rejects all uploaded server descriptors that aren't explicitly listed
  1140. in the fingerprints file. This acts as a "panic button" if we get
  1141. Sybiled. (Default: 0)
  1142. .LP
  1143. .TP
  1144. \fBAuthDirMaxServersPerAddr\fR \fINUM\fP
  1145. Authoritative directories only. The maximum number of servers that we
  1146. will list as acceptable on a single IP address. Set this to "0" for
  1147. "no limit". (Default: 2)
  1148. .LP
  1149. .TP
  1150. \fBAuthDirMaxServersPerAuthAddr\fR \fINUM\fP
  1151. Authoritative directories only. Like AuthDirMaxServersPerAddr, but
  1152. applies to addresses shared with directory authorities. (Default: 5)
  1153. .SH HIDDEN SERVICE OPTIONS
  1154. .PP
  1155. The following options are used to configure a hidden service.
  1156. .LP
  1157. .TP
  1158. \fBHiddenServiceDir \fR\fIDIRECTORY\fP
  1159. Store data files for a hidden service in DIRECTORY. Every hidden
  1160. service must have a separate directory. You may use this option multiple
  1161. times to specify multiple services.
  1162. .LP
  1163. .TP
  1164. \fBHiddenServicePort \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
  1165. Configure a virtual port VIRTPORT for a hidden service. You may use this
  1166. option multiple times; each time applies to the service using the most recent
  1167. hiddenservicedir. By default, this option maps the virtual port to the
  1168. same port on 127.0.0.1. You may override the target port, address, or both
  1169. by specifying a target of addr, port, or addr:port. You may also have
  1170. multiple lines with the same VIRTPORT: when a user connects to that VIRTPORT,
  1171. one of the TARGETs from those lines will be chosen at random.
  1172. .LP
  1173. .TP
  1174. \fBHiddenServiceNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  1175. If possible, use the specified nodes, defined by their identity fingerprints or
  1176. nicknames, as introduction points for the hidden service. If this is left
  1177. unset, Tor will be smart and pick some reasonable ones; most people can leave
  1178. this unset.
  1179. .LP
  1180. .TP
  1181. \fBHiddenServiceExcludeNodes \fR\fInode\fR,\fInode\fR,\fI...\fP
  1182. Do not use the specified nodes, defined by their identity fingerprints or
  1183. nicknames, as introduction points for the hidden service. In normal use there
  1184. is no reason to set this.
  1185. .LP
  1186. .TP
  1187. \fBPublishHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
  1188. If set to 0, Tor will run any hidden services you configure, but it won't
  1189. advertise them to the rendezvous directory. This option is only useful
  1190. if you're using a Tor controller that handles hidserv publishing for you.
  1191. (Default: 1)
  1192. .LP
  1193. .TP
  1194. \fBHiddenServiceVersion \fR\fIversion\fR,\fIversion\fR,\fI...\fP
  1195. A list of rendezvous service descriptor versions to publish for the hidden
  1196. service. Possible version numbers are 0 and 2. (Default: 0, 2)
  1197. .LP
  1198. .TP
  1199. \fBRendPostPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  1200. Every time the specified period elapses, Tor uploads any rendezvous
  1201. service descriptors to the directory servers. This information is also
  1202. uploaded whenever it changes. (Default: 20 minutes)
  1203. .\" UNDOCUMENTED
  1204. .\" ignoreversion
  1205. .SH SIGNALS
  1206. Tor catches the following signals:
  1207. .LP
  1208. .TP
  1209. \fBSIGTERM\fR
  1210. Tor will catch this, clean up and sync to disk if necessary, and exit.
  1211. .LP
  1212. .TP
  1213. \fBSIGINT\fR
  1214. Tor clients behave as with SIGTERM; but Tor servers will do a controlled
  1215. slow shutdown, closing listeners and waiting 30 seconds before exiting.
  1216. (The delay can be configured with the ShutdownWaitLength config option.)
  1217. .LP
  1218. .TP
  1219. \fBSIGHUP\fR
  1220. The signal instructs Tor to reload its configuration (including closing
  1221. and reopening logs), fetch a new directory, and kill and restart its
  1222. helper processes if applicable.
  1223. .LP
  1224. .TP
  1225. \fBSIGUSR1\fR
  1226. Log statistics about current connections, past connections, and
  1227. throughput.
  1228. .LP
  1229. .TP
  1230. \fBSIGUSR2\fR
  1231. Switch all logs to loglevel debug. You can go back to the old loglevels
  1232. by sending a SIGHUP.
  1233. .LP
  1234. .TP
  1235. \fBSIGCHLD\fR
  1236. Tor receives this signal when one of its helper processes has exited,
  1237. so it can clean up.
  1238. .LP
  1239. .TP
  1240. \fBSIGPIPE\fR
  1241. Tor catches this signal and ignores it.
  1242. .LP
  1243. .TP
  1244. \fBSIGXFSZ\fR
  1245. If this signal exists on your platform, Tor catches and ignores it.
  1246. .SH FILES
  1247. .LP
  1248. .TP
  1249. .B @CONFDIR@/torrc
  1250. The configuration file, which contains "option value" pairs.
  1251. .LP
  1252. .TP
  1253. .B @LOCALSTATEDIR@/lib/tor/
  1254. The tor process stores keys and other data here.
  1255. .LP
  1256. .TP
  1257. .B \fIDataDirectory\fP/cached-status/*
  1258. 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.
  1259. .LP
  1260. .TP
  1261. .B \fIDataDirectory\fB/cached-descriptors\fR and \fBcached-descriptors.new\fR
  1262. 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.
  1263. .LP
  1264. .TP
  1265. .B \fIDataDirectory\fB/cached-routers\fR and \fBcached-routers.new\fR
  1266. Obsolete versions of cached-descriptors and cached-descriptors.new. When Tor can't find the newer files, it looks here instead.
  1267. .LP
  1268. .TP
  1269. .B \fIDataDirectory\fP/state
  1270. A set of persistent key-value mappings. These are documented in the file. These include:
  1271. .PD 0
  1272. .RS 5
  1273. .IP "- The current entry guards and their status."
  1274. .IP "- The current bandwidth accounting values (unused so far; see below)."
  1275. .IP "- When the file was last written"
  1276. .IP "- What version of Tor generated the state file"
  1277. .IP "- A short history of bandwidth usage, as produced in the router descriptors."
  1278. .RE
  1279. .PD
  1280. .LP
  1281. .TP
  1282. .B \fIDataDirectory\fP/bw_accounting
  1283. 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.
  1284. .LP
  1285. .TP
  1286. .B \fIDataDirectory\fP/hsusage
  1287. Used to track hidden service usage in terms of fetch and publish
  1288. requests to this hidden service authoritative directory. Only used when
  1289. recording of statistics is enabled.
  1290. .LP
  1291. .TP
  1292. .B \fIDataDirectory\fP/control_auth_cookie
  1293. Used for cookie authentication with the controller. Location can be
  1294. overridden by the CookieAuthFile config option. Regenerated on startup.
  1295. See control-spec.txt for details. Only used when cookie authentication
  1296. is enabled.
  1297. .LP
  1298. .TP
  1299. .B \fIDataDirectory\fP/keys/*
  1300. Only used by servers. Holds identity keys and onion keys.
  1301. .LP
  1302. .TP
  1303. .B \fIDataDirectory\fP/fingerprint
  1304. Only used by servers. Holds the fingerprint of the server's identity key.
  1305. .LP
  1306. .TP
  1307. .B \fIDataDirectory\fP/approved-routers
  1308. 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.
  1309. .LP
  1310. .TP
  1311. .B \fIDataDirectory\fP/router-stability
  1312. 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.
  1313. .LP
  1314. .TP
  1315. .B \fIHiddenServiceDirectory\fP/hostname
  1316. The <base32-encoded-fingerprint>.onion domain name for this hidden service.
  1317. .LP
  1318. .TP
  1319. .B \fIHiddenServiceDirectory\fP/private_key
  1320. The private key for this hidden service.
  1321. .SH SEE ALSO
  1322. .BR privoxy (1),
  1323. .BR tsocks (1),
  1324. .BR torify (1)
  1325. .BR https://www.torproject.org/
  1326. .SH BUGS
  1327. Plenty, probably. Tor is still in development. Please report them.
  1328. .SH AUTHORS
  1329. Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.