tor.1.in 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850
  1. .TH TOR 1 "January 2006" "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. Other options can be specified either on the command-line (\fI--option
  30. value\fR), or in the configuration file (\fIoption value\fR).
  31. Options are case-insensitive.
  32. .LP
  33. .TP
  34. \fBBandwidthRate \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  35. A token bucket limits the average incoming bandwidth on this node to
  36. the specified number of bytes per second. (Default: 3 MB)
  37. .LP
  38. .TP
  39. \fBBandwidthBurst \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  40. Limit the maximum token bucket size (also known as the burst) to the
  41. given number of bytes. (Default: 6 MB)
  42. .LP
  43. .TP
  44. \fBMaxAdvertisedBandwidth \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  45. If set, we will not advertise more than this amount of bandwidth for our
  46. BandwidthRate. Server operators who want to reduce the number of clients
  47. who ask to build circuits through them (since this is proportional to
  48. advertised bandwidth rate) can thus reduce the CPU demands on their
  49. server without impacting network performance.
  50. .LP
  51. .TP
  52. \fBConnLimit \fR\fINUM\fP
  53. The minimum number of file descriptors that must be available to
  54. the Tor process before it will start. Tor will ask the OS for as
  55. many file descriptors as the OS will allow (you can find this
  56. by "ulimit -H -n"). If this number is less than ConnLimit, then
  57. Tor will refuse to start.
  58. You probably don't need to adjust this. It has no effect on
  59. Windows since that platform lacks getrlimit(). (Default: 1000)
  60. .LP
  61. .TP
  62. \fBControlPort \fR\fIPort\fP
  63. If set, Tor will accept connections on
  64. this port, and allow those connections to control the Tor process using the
  65. Tor Control Protocol (described in control-spec.txt). Note: unless you also
  66. specify one of \fBHashedControlPassword\fP or \fBCookieAuthentication\fP,
  67. setting this option will cause Tor to allow any process on the local host to
  68. control it.
  69. .LP
  70. .TP
  71. \fBControlListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  72. Bind the controller listener to this address. If you specify a port,
  73. bind to this port rather than the one specified in ControlPort. We
  74. strongly recommend that you leave this alone unless you know what you're
  75. doing, since giving attackers access to your control listener is really
  76. dangerous. (Default: 127.0.0.1)
  77. .LP
  78. .TP
  79. \fBHashedControlPassword \fR\fIhashed_password\fP
  80. Don't allow any connections on the control port except when the other process
  81. knows the password whose one-way hash is \fIhashed_password\fP. You can
  82. compute the hash of a password by running "tor --hash-password
  83. \fIpassword\fP".
  84. .LP
  85. .TP
  86. \fBCookieAuthentication \fR\fB0\fR|\fB1\fP
  87. If this option is set to 1, don't allow any connections on the control port
  88. except when the connecting process knows the contents of a file named
  89. "control_auth_cookie", which Tor will create in its data directory. This
  90. authentication methods should only be used on systems with good filesystem
  91. security. (Default: 0)
  92. .LP
  93. .TP
  94. \fBDataDirectory \fR\fIDIR\fP
  95. Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
  96. .LP
  97. .TP
  98. \fBDirServer \fR[\fInickname\fR] [\fBv1\fR] \fIaddress\fR\fB:\fIport fingerprint\fP
  99. Use a nonstandard authoritative directory server at the provided
  100. address and port, with the specified key fingerprint. This option can
  101. be repeated many times, for multiple authoritative directory
  102. servers. If the "v1" option is provided, Tor will use this server as an
  103. authority for old-style (v1) directories as well. (Only directory mirrors
  104. care about this.) If no \fBdirserver\fP line is given, Tor will use the default
  105. directory servers: moria1, moria2, and tor26. NOTE: this option is intended
  106. for setting up a private Tor network with its own directory authorities. If
  107. you use it, you will be distinguishable from other users, because you won't
  108. believe the same authorities they do.
  109. .LP
  110. .TP
  111. \fBFetchHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
  112. If set to 0, Tor will never fetch any hidden service descriptors from
  113. the rendezvous directories. This option is only useful if you're using
  114. a Tor controller that handles hidserv fetches for you.
  115. (Default: 1)
  116. .LP
  117. .TP
  118. \fBFetchServerDescriptors \fR\fB0\fR|\fB1\fR\fP
  119. If set to 0, Tor will never fetch any network status summaries or server
  120. descriptors from the directory servers. This option is only useful if
  121. you're using a Tor controller that handles directory fetches for you.
  122. (Default: 1)
  123. .LP
  124. .TP
  125. \fBFetchUselessDescriptors \fR\fB0\fR|\fB1\fR\fP
  126. If set to 1, Tor will fetch every non-obsolete descriptor from the
  127. authorities that it hears about. Otherwise, it will avoid fetching
  128. useless descriptors, for example for routers that are not running.
  129. This option is useful if you're using the contributed "exitlist"
  130. script to enumerate Tor nodes that exit to certain addresses.
  131. (Default: 0)
  132. .LP
  133. .TP
  134. \fBGroup \fR\fIGID\fP
  135. On startup, setgid to this user.
  136. .LP
  137. .TP
  138. \fBHttpProxy\fR \fIhost\fR[:\fIport\fR]\fP
  139. Tor will make all its directory requests through this host:port
  140. (or host:80 if port is not specified),
  141. rather than connecting directly to any directory servers.
  142. .LP
  143. .TP
  144. \fBHttpProxyAuthenticator\fR \fIusername:password\fP
  145. If defined, Tor will use this username:password for Basic Http proxy
  146. authentication, as in RFC 2617. This is currently the only form of
  147. Http proxy authentication that Tor supports; feel free to submit a
  148. patch if you want it to support others.
  149. .LP
  150. .TP
  151. \fBHttpsProxy\fR \fIhost\fR[:\fIport\fR]\fP
  152. Tor will make all its OR (SSL) connections through this host:port
  153. (or host:443 if port is not specified), via HTTP CONNECT rather than
  154. connecting directly to servers. You may want to set \fBFascistFirewall\fR
  155. to restrict the set of ports you might try to connect to, if your Https
  156. proxy only allows connecting to certain ports.
  157. .LP
  158. .TP
  159. \fBHttpsProxyAuthenticator\fR \fIusername:password\fP
  160. If defined, Tor will use this username:password for Basic Https proxy
  161. authentication, as in RFC 2617. This is currently the only form of
  162. Https proxy authentication that Tor supports; feel free to submit a
  163. patch if you want it to support others.
  164. .LP
  165. .TP
  166. \fBKeepalivePeriod \fR\fINUM\fP
  167. To keep firewalls from expiring connections, send a padding keepalive
  168. cell every NUM seconds on open connections that are in use. If the
  169. connection has no open circuits, it will instead be closed after NUM
  170. seconds of idleness. (Default: 5 minutes)
  171. .LP
  172. .TP
  173. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBstderr\fR|\fBstdout\fR|\fBsyslog\fR\fP
  174. Send all messages between \fIminSeverity\fR and \fImaxSeverity\fR to
  175. the standard output stream, the standard error stream, or to the system
  176. log. (The "syslog" value is only supported on Unix.) Recognized
  177. severity levels are debug, info, notice, warn, and err. We advise using
  178. "notice" in most cases, since anything more verbose may provide sensitive
  179. information to an attacker who obtains the logs. If only one
  180. severity level is given, all messages of that level or higher will be
  181. sent to the listed destination.
  182. .LP
  183. .TP
  184. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBfile\fR \fIFILENAME\fP
  185. As above, but send log messages to the listed filename. The "Log"
  186. option may appear more than once in a configuration file. Messages
  187. are sent to all the logs that match their severity level.
  188. .LP
  189. .TP
  190. \fBOutboundBindAddress \fR\fIIP\fP
  191. Make all outbound connections originate from the IP address specified. This
  192. is only useful when you have multiple network interfaces, and you want all
  193. of Tor's outgoing connections to use a single one.
  194. .LP
  195. .TP
  196. \fBPidFile \fR\fIFILE\fP
  197. On startup, write our PID to FILE. On clean shutdown, remove FILE.
  198. .LP
  199. .TP
  200. \fBRunAsDaemon \fR\fB0\fR|\fB1\fR\fP
  201. If 1, Tor forks and daemonizes to the background. (Default: 0)
  202. .LP
  203. .TP
  204. \fBSafeLogging \fR\fB0\fR|\fB1\fP
  205. If 1, Tor replaces potentially sensitive strings in the logs
  206. (e.g. addresses) with the string [scrubbed]. This way logs can still be
  207. useful, but they don't leave behind personally identifying information
  208. about what sites a user might have visited. (Default: 1)
  209. .LP
  210. .TP
  211. \fBUser \fR\fIUID\fP
  212. On startup, setuid to this user.
  213. .LP
  214. .TP
  215. \fBHardwareAccel \fR\fI0|1\fP
  216. If non-zero, try to use crypto hardware acceleration when
  217. available. This is untested and probably buggy. (Default: 0)
  218. .SH CLIENT OPTIONS
  219. .PP
  220. The following options are useful only for clients (that is, if \fBSocksPort\fP is non-zero):
  221. .LP
  222. .TP
  223. \fBAllowInvalidNodes\fR \fBentry\fR|\fBexit\fR|\fBmiddle\fR|\fBintroduction\fR|\fBrendezvous\fR|...\fP
  224. Allow routers that the dirserver operators consider invalid (not
  225. trustworthy or otherwise not working right) in only these positions in
  226. your circuits.
  227. The default is "middle,rendezvous", and other choices are not advised.
  228. .LP
  229. .TP
  230. \fBCircuitBuildTimeout \fR\fINUM\fP
  231. Try for at most NUM seconds when building circuits. If the circuit
  232. isn't open in that time, give up on it.
  233. (Default: 1 minute.)
  234. .LP
  235. .TP
  236. \fBCircuitIdleTimeout \fR\fINUM\fP
  237. If we have keept a clean (never used) circuit around for NUM seconds,
  238. then close it. This way when the Tor client is entirely idle, it can
  239. expire all of its circuits, and then expire its TLS connections. Also,
  240. if we end up making a circuit that is not useful for exiting any of
  241. the requests we're receiving, it won't forever take up a slot in the
  242. circuit list.
  243. (Default: 1 hour.)
  244. .LP
  245. .TP
  246. \fBClientOnly \fR\fB0\fR|\fB1\fR\fP
  247. If set to 1, Tor will under no circumstances run as a server. The default
  248. is to run as a client unless ORPort is configured. (Usually,
  249. you don't need to set this; Tor is pretty smart at figuring out whether
  250. you are reliable and high-bandwidth enough to be a useful server.)
  251. (Default: 0)
  252. .LP
  253. .TP
  254. \fBExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  255. A list of nodes to never use when building a circuit.
  256. .LP
  257. .TP
  258. \fBEntryNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  259. A list of preferred nodes to use for the first hop in the circuit.
  260. These are treated only as preferences unless StrictEntryNodes (see
  261. below) is also set.
  262. .LP
  263. .TP
  264. \fBExitNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  265. A list of preferred nodes to use for the last hop in the circuit.
  266. These are treated only as preferences unless StrictExitNodes (see
  267. below) is also set.
  268. .LP
  269. .TP
  270. \fBStrictEntryNodes \fR\fB0\fR|\fB1\fR\fP
  271. If 1, Tor will never use any nodes besides those listed in "EntryNodes" for
  272. the first hop of a circuit.
  273. .LP
  274. .TP
  275. \fBStrictExitNodes \fR\fB0\fR|\fB1\fR\fP
  276. If 1, Tor will never use any nodes besides those listed in "ExitNodes" for
  277. the last hop of a circuit.
  278. .LP
  279. .TP
  280. \fBFascistFirewall \fR\fB0\fR|\fB1\fR\fP
  281. If 1, Tor will only create outgoing connections to ORs running on ports that
  282. your firewall allows (defaults to 80 and 443; see \fBFirewallPorts\fR). This will
  283. allow you to run Tor as a client behind a firewall with restrictive policies,
  284. but will not allow you to run as a server behind such a firewall.
  285. This option is deprecated; use
  286. ReachableAddresses instead.
  287. .LP
  288. .TP
  289. \fBFirewallPorts \fR\fIPORTS\fP
  290. A list of ports that your firewall allows you to connect to. Only
  291. used when \fBFascistFirewall\fR is set. This option is deprecated; use
  292. ReachableAddresses instead. (Default: 80, 443)
  293. .LP
  294. .TP
  295. \fBReachableAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  296. A comma-separated list of IP addresses and ports that your firewall allows you
  297. to connect to. The format is as
  298. for the addresses in ExitPolicy, except that "accept" is understood
  299. unless "reject" is explicitly provided. For example, 'ReachableAddresses
  300. 99.0.0.0/8, reject 18.0.0.0/8:80, accept *:80' means that your
  301. firewall allows connections to everything inside net 99, rejects port
  302. 80 connections to net 18, and accepts connections to port 80 otherwise.
  303. (Default: 'accept *:*'.)
  304. .LP
  305. .TP
  306. \fBReachableDirAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  307. Like \fBReachableAddresses\fP, a list of addresses and ports. Tor will obey
  308. these restrictions when fetching directory information, using standard HTTP
  309. GET requests. If not set explicitly then the value of \fBfBReachableAddresses\fP
  310. is used. If \fBHttpProxy\fR is set then these connections will go through that
  311. proxy.
  312. .LP
  313. .TP
  314. \fBReachableORAddresses \fR\fIADDR\fP[\fB/\fP\fIMASK\fP][:\fIPORT\fP]...\fP
  315. Like \fBReachableAddresses\fP, a list of addresses and ports. Tor will obey
  316. these restrictions when connecting to Onion Routers, using TLS/SSL. If not set
  317. explicitly then the value of \fBfBReachableAddresses\fP is used. If
  318. \fBHttpsProxy\fR is set then these connections will go through that proxy.
  319. The separation between \fBReachableORAddresses\fP and
  320. \fBReachableDirAddresses\fP is only interesting when you are connecting through
  321. proxies (see \fBHttpProxy\fR and \fBHttpsProxy\fR). Most proxies limit TLS
  322. connections (which Tor uses to connect to Onion Routers) to port 443, and some
  323. limit HTTP GET requests (which Tor uses for fetching directory information) to
  324. port 80.
  325. .LP
  326. .TP
  327. \fBLongLivedPorts \fR\fIPORTS\fP
  328. A list of ports for services that tend to have long-running connections
  329. (e.g. chat and interactive shells). Circuits for streams that use these
  330. ports will contain only high-uptime nodes, to reduce the chance that a
  331. node will go down before the stream is finished. (Default: 21, 22, 706, 1863, 5050,
  332. 5190, 5222, 5223, 6667, 8300, 8888)
  333. .LP
  334. .TP
  335. \fBMapAddress\fR \fIaddress\fR \fInewaddress\fR
  336. When a request for address arrives to Tor, it will rewrite it to newaddress before
  337. processing it. For example, if you always want connections to www.indymedia.org to
  338. exit via \fItorserver\fR (where \fItorserver\fR is the nickname of the server),
  339. use "MapAddress www.indymedia.org www.indymedia.org.torserver.exit".
  340. .LP
  341. .TP
  342. \fBNewCircuitPeriod \fR\fINUM\fP
  343. Every NUM seconds consider whether to build a new circuit. (Default: 30 seconds)
  344. .LP
  345. .TP
  346. \fBMaxCircuitDirtiness \fR\fINUM\fP
  347. Feel free to reuse a circuit that was first used at most NUM seconds
  348. ago, but never attach a new stream to a circuit that is too old. (Default: 10 minutes)
  349. .LP
  350. .TP
  351. \fBNodeFamily \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  352. The named Tor servers constitute a "family" of similar or co-administered
  353. servers, so never use any two of them in the same circuit. Defining a
  354. NodeFamily is only needed when a server doesn't list the family itself
  355. (with MyFamily). This option can be used multiple times.
  356. .LP
  357. .TP
  358. .\" \fBPathlenCoinWeight \fR\fI0.0-1.0\fP
  359. .\" Paths are 3 hops plus a geometric distribution centered around this coinweight.
  360. .\" Must be >=0.0 and <1.0. (Default: 0.3) NOT USED CURRENTLY
  361. .\" .TP
  362. \fBRendNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  363. A list of preferred nodes to use for the rendezvous point, if possible.
  364. .LP
  365. .TP
  366. \fBRendExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  367. A list of nodes to never use when choosing a rendezvous point.
  368. .LP
  369. .TP
  370. \fBSocksPort \fR\fIPORT\fP
  371. Advertise this port to listen for connections from Socks-speaking
  372. applications. Set this to 0 if you don't want to allow application
  373. connections. (Default: 9050)
  374. .LP
  375. .TP
  376. \fBSocksListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  377. Bind to this address to listen for connections from Socks-speaking
  378. applications. (Default: 127.0.0.1) You can also specify a port
  379. (e.g. 192.168.0.1:9100). This directive can be specified multiple times
  380. to bind to multiple addresses/ports.
  381. .LP
  382. .TP
  383. \fBSocksPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  384. Set an entrance policy for this server, to limit who can connect to the
  385. Socks ports.
  386. The policies have the same form as exit policies below.
  387. .LP
  388. .TP
  389. \fBSocksTimeout \fR\fINUM\fP
  390. Let a socks connection wait NUM seconds unattached before we fail it.
  391. (Default: 2 minutes.)
  392. .LP
  393. .TP
  394. \fBTrackHostExits \fR\fIhost\fR,\fI.domain\fR,\fI...\fR\fP
  395. For each value in the comma separated list, Tor will track recent connections
  396. to hosts that match this value and attempt to
  397. reuse the same exit node for each. If the value is prepended with a '.', it is
  398. treated as matching an entire domain. If one of the values is just a '.', it
  399. means match everything. This option is useful if you frequently connect to
  400. sites that will expire all your authentication cookies (ie log you out) if
  401. your IP address changes. Note that this option does have the disadvantage of
  402. making it more clear that a given history is
  403. associated with a single user. However, most people who would wish to observe
  404. this will observe it through cookies or other protocol-specific means anyhow.
  405. .LP
  406. .TP
  407. \fBTrackHostExitsExpire \fR\fINUM\fP
  408. Since exit servers go up and down, it is desirable to expire the association
  409. between host and exit server after NUM seconds. The default
  410. is 1800 seconds (30 minutes).
  411. .LP
  412. .TP
  413. \fBUseEntryGuards \fR\fI0|1\fP
  414. If this option is set to 1, we pick a few long-term entry servers, and
  415. try to stick with them. This is desirable because
  416. constantly changing servers increases the odds that an adversary who owns
  417. some servers will observe a fraction of your paths.
  418. (Defaults to 1.)
  419. .LP
  420. .TP
  421. \fBNumEntryGuards \fR\fINUM\fP
  422. If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
  423. as long-term entries for our circuits.
  424. (Defaults to 3.)
  425. .LP
  426. .TP
  427. \fBSafeSocks \fR\fI0|1\fP
  428. When this option is enabled, Tor will reject application connections that
  429. use unsafe variants of the socks protocol -- ones that only provide an
  430. IP address, meaning the application is doing a DNS resolve first.
  431. Specifically, these are socks4 and socks5 when not doing remote DNS.
  432. (Defaults to 0.)
  433. .LP
  434. .TP
  435. \fBTestSocks \fR\fB0\fR|\fB1\fR\fP
  436. When this option is enabled, Tor will make a notice-level log entry for
  437. each connection to the Socks port indicating whether the request used
  438. a safe socks protocol or an unsafe one (see above entry on SafeSocks).
  439. This helps to determine whether an application using Tor is possibly
  440. leaking DNS requests.
  441. (Default: 0)
  442. .LP
  443. .TP
  444. \fBVirutalAddrNetwork \fR\fIAddress\fB/\fIbits\fP
  445. When a controller asks for a virtual (unused) address with the
  446. 'MAPADDRESS' command, Tor picks an unassigned address from this range.
  447. (Default: 127.192.0.0/10)
  448. .SH SERVER OPTIONS
  449. .PP
  450. The following options are useful only for servers (that is, if \fBORPort\fP is non-zero):
  451. .LP
  452. .TP
  453. \fBAddress \fR\fIaddress\fP
  454. The IP or fqdn of this server (e.g. moria.mit.edu). You can leave this
  455. unset, and Tor will guess your IP.
  456. .LP
  457. .TP
  458. \fBAssumeReachable \fR\fB0\fR|\fB1\fR\fP
  459. This option is used when bootstrapping a new Tor network. If set to 1,
  460. don't do self-reachability testing; just upload your server descriptor
  461. immediately. If \fBAuthoritativeDirectory\fP is also set, this option
  462. instructs the dirserver to bypass remote reachability testing too and
  463. list all connected servers as running.
  464. .LP
  465. .TP
  466. \fBContactInfo \fR\fIemail_address\fP
  467. Administrative contact information for server.
  468. .LP
  469. .TP
  470. \fBExitPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  471. Set an exit policy for this server. Each policy is of the form
  472. "\fBaccept\fP|\fBreject\fP \fIADDR\fP[\fB/\fP\fIMASK\fP]\fB[:\fP\fIPORT\fP]".
  473. If \fB/\fP\fIMASK\fP is omitted then this policy just applies to the host
  474. given. Instead of giving a host or network you can also use "\fB*\fP" to
  475. denote the universe (0.0.0.0/0). \fIPORT\fP can be a single port number,
  476. an interval of ports "\fIFROM_PORT\fP\fB-\fP\fITO_PORT\fP", or "\fB*\fP".
  477. If \fIPORT\fP is omitted, that means "\fB*\fP".
  478. For example, "accept 18.7.22.69:*,reject 18.0.0.0/8:*,accept *:*" would
  479. reject any traffic destined for MIT except for web.mit.edu, and
  480. accept anything else.
  481. To specify all internal and link-local networks (including 0.0.0.0/8,
  482. 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
  483. 172.16.0.0/12), you can use the "private" alias instead of an address.
  484. These addresses are rejected by default (at the beginning of your
  485. exit policy) unless you set the ExitPolicyRejectPrivate config option
  486. to 0. For example, once you've done that, you could allow HTTP to
  487. 127.0.0.1 and block all other connections to internal networks with
  488. "accept
  489. 127.0.0.1:80,reject private:*". See RFC 1918 and RFC 3330 for more
  490. details about internal and reserved IP address space.
  491. This directive can be specified multiple times so you don't have to put
  492. it all on one line.
  493. Policies are considered first to last, and the first match wins. If
  494. you want to _replace_ the default exit policy, end your exit policy with
  495. either a reject *:* or an accept *:*. Otherwise, you're _augmenting_
  496. (prepending to) the default exit policy. The default exit policy is:
  497. .PD 0
  498. .RS 12
  499. .IP "reject *:25"
  500. .IP "reject *:119"
  501. .IP "reject *:135-139"
  502. .IP "reject *:445"
  503. .IP "reject *:465"
  504. .IP "reject *:587"
  505. .IP "reject *:1214"
  506. .IP "reject *:4661-4666"
  507. .IP "reject *:6346-6429"
  508. .IP "reject *:6699"
  509. .IP "reject *:6881-6999"
  510. .IP "accept *:*"
  511. .RE
  512. .PD
  513. .LP
  514. .TP
  515. \fBExitPolicyRejectPrivate \fR\fB0\fR|\fB1\fR\fP
  516. Reject all private (local) networks at the beginning of your exit
  517. policy. See above entry on ExitPolicy. (Default: 1)
  518. .LP
  519. .TP
  520. \fBMaxOnionsPending \fR\fINUM\fP
  521. If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
  522. .LP
  523. .TP
  524. \fBMyFamily \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  525. Declare that this Tor server is controlled or administered by a group
  526. or organization identical or similar to that of the other named servers.
  527. When two servers both declare that they are in the same 'family', Tor clients
  528. will not use them in the same circuit. (Each server only needs to list the
  529. other servers in its family; it doesn't need to list itself, but it won't hurt.)
  530. .LP
  531. .TP
  532. \fBNickname \fR\fIname\fP
  533. Set the server's nickname to 'name'. Nicknames must be between 1
  534. and 19 characters inclusive, and must contain only the characters
  535. [a-zA-Z0-9].
  536. .LP
  537. .TP
  538. \fBNumCPUs \fR\fInum\fP
  539. How many processes to use at once for decrypting onionskins. (Default: 1)
  540. .LP
  541. .TP
  542. \fBORPort \fR\fIPORT\fP
  543. Advertise this port to listen for connections from Tor clients and servers.
  544. .LP
  545. .TP
  546. \fBORListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  547. Bind to this IP address to listen for connections from Tor clients and
  548. servers. If you specify a port, bind to this port rather than the one
  549. specified in ORPort. (Default: 0.0.0.0)
  550. .LP
  551. .TP
  552. \fBPublishServerDescriptor \fR\fB0\fR|\fB1\fR\fP
  553. If set to 0, Tor will act as a server if you have an ORPort
  554. defined, but it will not publish its descriptor to the dirservers. This
  555. option is useful if you're testing out your server, or if you're using
  556. a Tor controller that handles directory publishing for you.
  557. (Default: 1)
  558. .LP
  559. .TP
  560. \fBRedirectExit \fR\fIpattern target\fP
  561. Whenever an outgoing connection tries to connect to one of a given set
  562. of addresses, connect to \fItarget\fP (an \fIaddress:port\fP pair) instead.
  563. The address
  564. pattern is given in the same format as for an exit policy. The
  565. address translation applies after exit policies are applied. Multiple
  566. \fBRedirectExit\fP options can be used: once any one has matched
  567. successfully, no subsequent rules are considered. You can specify that no
  568. redirection is to be performed on a given set of addresses by using the
  569. special target string "pass", which prevents subsequent rules from being
  570. considered.
  571. .LP
  572. .TP
  573. \fBShutdownWaitLength\fR \fINUM\fP
  574. When we get a SIGINT and we're a server, we begin shutting down: we close
  575. listeners and start refusing new circuits. After \fBNUM\fP seconds,
  576. we exit. If we get a second SIGINT, we exit immediately. (Default:
  577. 30 seconds)
  578. .LP
  579. .TP
  580. \fBAccountingMax \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  581. Never send more than the specified number of bytes in a given
  582. accounting period, or receive more than that number in the period.
  583. For example, with AccountingMax set to 1 GB, a server could send 900 MB
  584. and receive 800 MB and continue running. It will only hibernate once one
  585. of the two reaches 1 GB.
  586. When the number of bytes is exhausted, Tor will hibernate until some
  587. time in the next accounting period. To prevent all servers from
  588. waking at the same time, Tor will also wait until a random point in
  589. each period before waking up. If you have bandwidth cost issues,
  590. enabling hibernation is preferable to setting a low bandwidth, since it
  591. provides users with a collection of fast servers that are up some of
  592. the time, which is more useful than a set of slow servers that are
  593. always "available".
  594. .LP
  595. .TP
  596. \fBAccountingStart \fR\fBday\fR|\fBweek\fR|\fBmonth\fR [\fIday\fR] \fIHH:MM\fR\fP
  597. Specify how long accounting periods last. If \fBmonth\fP is given,
  598. each accounting period runs from the time \fIHH:MM\fR on the
  599. \fIday\fRth day of one month to the same day and time of the next.
  600. (The day must be between 1 and 28.) If \fBweek\fP is given, each
  601. accounting period runs from the time \fIHH:MM\fR of the \fIday\fRth
  602. day of one week to the same day and time of the next week, with Monday
  603. as day 1 and Sunday as day 7. If \fBday\fR is given, each accounting
  604. period runs from the time \fIHH:MM\fR each day to the same time on the
  605. next day. All times are local, and given in 24-hour time. (Defaults to
  606. "month 1 0:00".)
  607. .SH DIRECTORY SERVER OPTIONS
  608. .PP
  609. The following options are useful only for directory servers (that is, if \fBDirPort\fP is non-zero):
  610. .LP
  611. .TP
  612. \fBAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  613. When this option is set to 1, Tor operates as an authoritative
  614. directory server. Instead of caching the directory, it generates its
  615. own list of good servers, signs it, and sends that to the clients.
  616. Unless the clients already have you listed as a trusted directory, you
  617. probably do not want to set this option. Please coordinate with the other
  618. admins at tor-ops@freehaven.net if you think you should be a directory.
  619. .LP
  620. .TP
  621. \fBV1AuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  622. When this option is set in addition to \fBAuthoritativeDirectory\fP, Tor also
  623. generates a version 1 directory (for Tor clients up to 0.1.0.x).
  624. (As of Tor 0.1.1.12 every (v2) authoritative directory still provides most of
  625. the v1 directory functionality, even without this option set to 1.
  626. This however is expected to change in the future.)
  627. .LP
  628. .TP
  629. \fBVersioningAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  630. When this option is set to 1, Tor adds information on
  631. which versions of Tor are still believed safe for use to
  632. the published directory. Each version 1 authority is
  633. automatically a versioning authority; version 2 authorities
  634. provide this service optionally. See \fBRecommendedVersions\fP,
  635. \fBRecommendedClientVersions\fP, and \fBRecommendedServerVersions\fP.
  636. .LP
  637. .TP
  638. \fBNamingAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  639. When this option is set to 1, then the server advertises that it has
  640. opinions about nickname-to-fingerprint bindings. It will include these
  641. opinions in its published network-status pages, by listing servers with
  642. the flag "Named" if a correct binding between that nickname and
  643. fingerprint has been registered with the dirserver. Naming dirservers
  644. will refuse to accept or publish descriptors that contradict a
  645. registered binding. See \fBapproved-routers\fP in the \fBFILES\fP
  646. section below.
  647. .LP
  648. .TP
  649. \fBDirPort \fR\fIPORT\fP
  650. Advertise the directory service on this port.
  651. .LP
  652. .TP
  653. \fBDirListenAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  654. Bind the directory service to this address. If you specify a port, bind
  655. to this port rather than the one specified in DirPort. (Default: 0.0.0.0)
  656. .LP
  657. .TP
  658. \fBDirPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  659. Set an entrance policy for this server, to limit who can connect to the directory ports.
  660. The policies have the same form as exit policies above.
  661. .LP
  662. .TP
  663. \fBRecommendedVersions \fR\fISTRING\fP
  664. STRING is a comma-separated list of Tor versions currently believed
  665. to be safe. The list is included in each directory, and nodes which
  666. pull down the directory learn whether they need to upgrade. This
  667. option can appear multiple times: the values from multiple lines are
  668. spliced together.
  669. When this is set then
  670. \fBVersioningAuthoritativeDirectory\fP should be set too.
  671. .LP
  672. .TP
  673. \fBRecommendedClientVersions \fR\fISTRING\fP
  674. STRING is a comma-separated list of Tor versions currently believed
  675. to be safe for clients to use. This information is included in version 2
  676. directories. If this is not set then the value of \fBRecommendedVersions\fR
  677. is used.
  678. When this is set then
  679. \fBVersioningAuthoritativeDirectory\fP should be set too.
  680. .LP
  681. .TP
  682. \fBRecommendedServerVersions \fR\fISTRING\fP
  683. STRING is a comma-separated list of Tor versions currently believed
  684. to be safe for servers to use. This information is included in version 2
  685. directories. If this is not set then the value of \fBRecommendedVersions\fR
  686. is used.
  687. When this is set then
  688. \fBVersioningAuthoritativeDirectory\fP should be set too.
  689. .LP
  690. .TP
  691. \fBDirAllowPrivateAddresses \fR\fB0\fR|\fB1\fR\fP
  692. If set to 1, Tor will accept router descriptors with arbitrary "Address"
  693. elements. Otherwise, if the address is not an IP or is a private IP,
  694. it will reject the router descriptor. Defaults to 0.
  695. .LP
  696. .TP
  697. \fBRunTesting \fR\fB0\fR|\fB1\fR\fP
  698. If set to 1, Tor tries to build circuits through all of the servers it
  699. knows about, so it can tell which are up and which are down. This
  700. option is only useful for authoritative directories, so you probably
  701. don't want to use it.
  702. .LP
  703. .TP
  704. \fBAuthDirInvalid \fR\fIAddressPattern\fR...\fP
  705. Authoritative directories only. A set of address patterns for servers that
  706. will never be listed as "valid" in any network status document that this
  707. authority publishes.
  708. .LP
  709. .TP
  710. \fBAuthDirReject \fR\fIAddressPattern\fR...\fP
  711. Authoritative directories only. A set of address patterns for servers that
  712. will never be listed at all in any network status document that this
  713. authority publishes, or accepted as an OR address in any descriptor submitted
  714. for publication by this authority.
  715. .LP
  716. .TP
  717. \fBAuthDirRejectUnlisted \fR\fB0\fR|\fB1\fR\fP
  718. Authoritative directories only. If set to 1, the directory server
  719. rejects all uploaded server descriptors that aren't explicitly listed
  720. in the fingerprints file. This acts as a "panic button" if we get
  721. Sybiled. (Default: 0)
  722. .SH HIDDEN SERVICE OPTIONS
  723. .PP
  724. The following options are used to configure a hidden service.
  725. .LP
  726. .TP
  727. \fBHiddenServiceDir \fR\fIDIRECTORY\fP
  728. Store data files for a hidden service in DIRECTORY. Every hidden
  729. service must have a separate directory. You may use this option multiple
  730. times to specify multiple services.
  731. .LP
  732. .TP
  733. \fBHiddenServicePort \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
  734. Configure a virtual port VIRTPORT for a hidden service. You may use this
  735. option multiple times; each time applies to the service using the most recent
  736. hiddenservicedir. By default, this option maps the virtual port to the
  737. same port on 127.0.0.1. You may override the target port, address, or both
  738. by specifying a target of addr, port, or addr:port.
  739. .LP
  740. .TP
  741. \fBHiddenServiceNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  742. If possible, use the specified nodes as introduction points for the hidden
  743. service. If this is left unset, Tor will be smart and pick some reasonable
  744. ones; most people can leave this unset.
  745. .LP
  746. .TP
  747. \fBHiddenServiceExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  748. Do not use the specified nodes as introduction points for the hidden
  749. service. In normal use there is no reason to set this.
  750. .LP
  751. .TP
  752. \fBPublishHidServDescriptors \fR\fB0\fR|\fB1\fR\fP
  753. If set to 0, Tor will run any hidden services you configure, but it won't
  754. advertise them to the rendezvous directory. This option is only useful
  755. if you're using a Tor controller that handles hidserv publishing for you.
  756. (Default: 1)
  757. .LP
  758. .TP
  759. \fBRendPostPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  760. Every time the specified period elapses, Tor uploads any rendezvous
  761. service descriptors to the directory servers. This information is also
  762. uploaded whenever it changes. (Default: 20 minutes)
  763. .\" UNDOCUMENTED
  764. .\" ignoreversion
  765. .SH SIGNALS
  766. Tor catches the following signals:
  767. .LP
  768. .TP
  769. \fBSIGTERM\fR
  770. Tor will catch this, clean up and sync to disk if necessary, and exit.
  771. .LP
  772. .TP
  773. \fBSIGINT\fR
  774. Tor clients behave as with SIGTERM; but Tor servers will do a controlled
  775. slow shutdown, closing listeners and waiting 30 seconds before exiting.
  776. (The delay can be configured with the ShutdownWaitLength config option.)
  777. .LP
  778. .TP
  779. \fBSIGHUP\fR
  780. The signal instructs Tor to reload its configuration (including closing
  781. and reopening logs), fetch a new directory, and kill and restart its
  782. helper processes if applicable.
  783. .LP
  784. .TP
  785. \fBSIGUSR1\fR
  786. Log statistics about current connections, past connections, and
  787. throughput.
  788. .LP
  789. .TP
  790. \fBSIGUSR2\fR
  791. Switch all logs to loglevel debug. You can go back to the old loglevels
  792. by sending a SIGHUP.
  793. .LP
  794. .TP
  795. \fBSIGCHLD\fR
  796. Tor receives this signal when one of its helper processes has exited,
  797. so it can clean up.
  798. .LP
  799. .TP
  800. \fBSIGPIPE\fR
  801. Tor catches this signal and ignores it.
  802. .LP
  803. .TP
  804. \fBSIGXFSZ\fR
  805. If this signal exists on your platform, Tor catches and ignores it.
  806. .SH FILES
  807. .LP
  808. .TP
  809. .B @CONFDIR@/torrc
  810. The configuration file, which contains "option value" pairs.
  811. .LP
  812. .TP
  813. .B @LOCALSTATEDIR@/lib/tor/
  814. The tor process stores keys and other data here.
  815. .LP
  816. .TP
  817. .B \fIDataDirectory\fP/approved-routers
  818. Only for naming authoritative directory servers
  819. (see \fBNamingAuthoritativeDirectory\fP).
  820. This file lists nickname to identity bindings. Each line lists a
  821. nickname and a fingerprint seperated by whitespace. See your
  822. \fBfingerprint\fP file in the \fIDataDirectory\fP for an example line.
  823. If the nickname is \fB!reject\fP then descriptors from the given
  824. identity (fingerprint) are rejected by the authoritative directory
  825. server. If it is \fB!invalid\fP then descriptors are accepted but marked
  826. in the directory as not valid, that is, not recommended.
  827. .SH SEE ALSO
  828. .BR privoxy (1),
  829. .BR tsocks (1),
  830. .BR torify (1)
  831. .BR http://tor.eff.org/
  832. .SH BUGS
  833. Plenty, probably. Tor is still in development. Please report them.
  834. .SH AUTHORS
  835. Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.