tor.1.txt 68 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410
  1. // Copyright (c) The Tor Project, Inc.
  2. // See LICENSE for licensing information
  3. // This is an asciidoc file used to generate the manpage/html reference.
  4. // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
  5. TOR(1)
  6. ======
  7. NAME
  8. ----
  9. tor - The second-generation onion router
  10. SYNOPSIS
  11. --------
  12. **tor** [__OPTION__ __value__]...
  13. DESCRIPTION
  14. -----------
  15. __tor__ is a connection-oriented anonymizing communication
  16. service. Users choose a source-routed path through a set of nodes, and
  17. negotiate a "virtual circuit" through the network, in which each node
  18. knows its predecessor and successor, but no others. Traffic flowing down
  19. the circuit is unwrapped by a symmetric key at each node, which reveals
  20. the downstream node. +
  21. Basically __tor__ provides a distributed network of servers ("onion routers").
  22. Users bounce their TCP streams -- web traffic, ftp, ssh, etc -- around the
  23. routers, and recipients, observers, and even the routers themselves have
  24. difficulty tracking the source of the stream.
  25. OPTIONS
  26. -------
  27. **-h**, **-help**::
  28. Display a short help message and exit.
  29. **-f** __FILE__::
  30. FILE contains further "option value" paris. (Default: @CONFDIR@/torrc)
  31. **--hash-password**::
  32. Generates a hashed password for control port access.
  33. **--list-fingerprint**::
  34. Generate your keys and output your nickname and fingerprint.
  35. **--verify-config**::
  36. Verify the configuration file is valid.
  37. **--nt-service**::
  38. **--service [install|remove|start|stop]** Manage the Tor Windows
  39. NT/2000/XP service. Current instructions can be found at
  40. https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ#WinNTService
  41. **--list-torrc-options**::
  42. List all valid options.
  43. **--version**::
  44. Display Tor version and exit.
  45. **--quiet**::
  46. Do not start Tor with a console log unless explicitly requested to do so.
  47. (By default, Tor starts out logging messages at level "notice" or higher to
  48. the console, until it has parsed its configuration.)
  49. Other options can be specified either on the command-line (--option
  50. value), or in the configuration file (option value or option "value").
  51. Options are case-insensitive. C-style escaped characters are allowed inside
  52. quoted values.
  53. **BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
  54. A token bucket limits the average incoming bandwidth usage on this node to
  55. the specified number of bytes per second, and the average outgoing
  56. bandwidth usage to that same value. (Default: 5 MB)
  57. **BandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
  58. Limit the maximum token bucket size (also known as the burst) to the given
  59. number of bytes in each direction. (Default: 10 MB)
  60. **MaxAdvertisedBandwidth** __N__ **bytes**|**KB**|**MB**|**GB**::
  61. If set, we will not advertise more than this amount of bandwidth for our
  62. BandwidthRate. Server operators who want to reduce the number of clients
  63. who ask to build circuits through them (since this is proportional to
  64. advertised bandwidth rate) can thus reduce the CPU demands on their server
  65. without impacting network performance.
  66. **RelayBandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
  67. If defined, a separate token bucket limits the average incoming bandwidth
  68. usage for \_relayed traffic_ on this node to the specified number of bytes
  69. per second, and the average outgoing bandwidth usage to that same value.
  70. Relayed traffic currently is calculated to include answers to directory
  71. requests, but that may change in future versions. (Default: 0)
  72. **RelayBandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
  73. Limit the maximum token bucket size (also known as the burst) for
  74. \_relayed traffic_ to the given number of bytes in each direction.
  75. (Default: 0)
  76. **PerConnBWRate** __N__ **bytes**|**KB**|**MB**|**GB**::
  77. If set, do separate rate limiting for each connection from a non-relay.
  78. You should never need to change this value, since a network-wide value is
  79. published in the consensus and your relay will use that value. (Default: 0)
  80. **PerConnBWBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
  81. If set, do separate rate limiting for each connection from a non-relay.
  82. You should never need to change this value, since a network-wide value is
  83. published in the consensus and your relay will use that value. (Default: 0)
  84. **ConLimit** __NUM__::
  85. The minimum number of file descriptors that must be available to the Tor
  86. process before it will start. Tor will ask the OS for as many file
  87. descriptors as the OS will allow (you can find this by "ulimit -H -n").
  88. If this number is less than ConnLimit, then Tor will refuse to start. +
  89. +
  90. You probably don't need to adjust this. It has no effect on Windows
  91. since that platform lacks getrlimit(). (Default: 1000)
  92. **ConstrainedSockets** **0**|**1**::
  93. If set, Tor will tell the kernel to attempt to shrink the buffers for all
  94. sockets to the size specified in **ConstrainedSockSize**. This is useful for
  95. virtual servers and other environments where system level TCP buffers may
  96. be limited. If you're on a virtual server, and you encounter the "Error
  97. creating network socket: No buffer space available" message, you are
  98. likely experiencing this problem. +
  99. +
  100. The preferred solution is to have the admin increase the buffer pool for
  101. the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
  102. this configuration option is a second-resort. +
  103. +
  104. The DirPort option should also not be used if TCP buffers are scarce. The
  105. cached directory requests consume additional sockets which exacerbates
  106. the problem. +
  107. +
  108. You should **not** enable this feature unless you encounter the "no buffer
  109. space available" issue. Reducing the TCP buffers affects window size for
  110. the TCP stream and will reduce throughput in proportion to round trip
  111. time on long paths. (Default: 0.)
  112. **ConstrainedSockSize** __N__ **bytes**|**KB**::
  113. When **ConstrainedSockets** is enabled the receive and transmit buffers for
  114. all sockets will be set to this limit. Must be a value between 2048 and
  115. 262144, in 1024 byte increments. Default of 8192 is recommended.
  116. **ControlPort** __Port__::
  117. If set, Tor will accept connections on this port and allow those
  118. connections to control the Tor process using the Tor Control Protocol
  119. (described in control-spec.txt). Note: unless you also specify one of
  120. **HashedControlPassword** or **CookieAuthentication**, setting this option will
  121. cause Tor to allow any process on the local host to control it. This
  122. option is required for many Tor controllers; most use the value of 9051.
  123. **ControlListenAddress** __IP__[:__PORT__]::
  124. Bind the controller listener to this address. If you specify a port, bind
  125. to this port rather than the one specified in ControlPort. We strongly
  126. recommend that you leave this alone unless you know what you're doing,
  127. since giving attackers access to your control listener is really
  128. dangerous. (Default: 127.0.0.1) This directive can be specified multiple
  129. times to bind to multiple addresses/ports.
  130. **ControlSocket** __Path__::
  131. Like ControlPort, but listens on a Unix domain socket, rather than a TCP
  132. socket. (Unix and Unix-like systems only.)
  133. **HashedControlPassword** __hashed_password__::
  134. Don't allow any connections on the control port except when the other
  135. process knows the password whose one-way hash is __hashed_password__. You
  136. can compute the hash of a password by running "tor --hash-password
  137. __password__". You can provide several acceptable passwords by using more
  138. than one HashedControlPassword line.
  139. **CookieAuthentication** **0**|**1**::
  140. If this option is set to 1, don't allow any connections on the control port
  141. except when the connecting process knows the contents of a file named
  142. "control_auth_cookie", which Tor will create in its data directory. This
  143. authentication method should only be used on systems with good filesystem
  144. security. (Default: 0)
  145. **CookieAuthFile** __Path__::
  146. If set, this option overrides the default location and file name
  147. for Tor's cookie file. (See CookieAuthentication above.)
  148. **CookieAuthFileGroupReadable** **0**|**1**|__Groupname__::
  149. If this option is set to 0, don't allow the filesystem group to read the
  150. cookie file. If the option is set to 1, make the cookie file readable by
  151. the default GID. [Making the file readable by other groups is not yet
  152. implemented; let us know if you need this for some reason.] (Default: 0).
  153. **DataDirectory** __DIR__::
  154. Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
  155. **DirServer** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
  156. Use a nonstandard authoritative directory server at the provided address
  157. and port, with the specified key fingerprint. This option can be repeated
  158. many times, for multiple authoritative directory servers. Flags are
  159. separated by spaces, and determine what kind of an authority this directory
  160. is. By default, every authority is authoritative for current ("v2")-style
  161. directories, unless the "no-v2" flag is given. If the "v1" flags is
  162. provided, Tor will use this server as an authority for old-style (v1)
  163. directories as well. (Only directory mirrors care about this.) Tor will
  164. use this server as an authority for hidden service information if the "hs"
  165. flag is set, or if the "v1" flag is set and the "no-hs" flag is **not** set.
  166. Tor will use this authority as a bridge authoritative directory if the
  167. "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
  168. given port when opening encrypted tunnels to the dirserver. Lastly, if a
  169. flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
  170. whose v3 long-term signing key has the fingerprint **fp**. +
  171. +
  172. If no **dirserver** line is given, Tor will use the default directory
  173. servers. NOTE: this option is intended for setting up a private Tor
  174. network with its own directory authorities. If you use it, you will be
  175. distinguishable from other users, because you won't believe the same
  176. authorities they do.
  177. **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
  178. **AlternateHSAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
  179. **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
  180. As DirServer, but replaces less of the default directory authorities. Using
  181. AlternateDirAuthority replaces the default Tor directory authorities, but
  182. leaves the hidden service authorities and bridge authorities in place.
  183. Similarly, Using AlternateHSAuthority replaces the default hidden service
  184. authorities, but not the directory or bridge authorities.
  185. **DisableAllSwap** **0**|**1**::
  186. If set to 1, Tor will attempt to lock all current and future memory pages,
  187. so that memory cannot be paged out. Windows, OS X and Solaris are currently
  188. not supported. We believe that this feature works on modern Gnu/Linux
  189. distributions, and that it should work on *BSD systems (untested). This
  190. option requires that you start your Tor as root, and you should use the
  191. **User** option to properly reduce Tor's privileges. (Default: 0)
  192. **FetchDirInfoEarly** **0**|**1**::
  193. If set to 1, Tor will always fetch directory information like other
  194. directory caches, even if you don't meet the normal criteria for fetching
  195. early. Normal users should leave it off. (Default: 0)
  196. **FetchDirInfoExtraEarly** **0**|**1**::
  197. If set to 1, Tor will fetch directory information before other directory
  198. caches. It will attempt to download directory information closer to the
  199. start of the consensus period. Normal users should leave it off.
  200. (Default: 0)
  201. **FetchHidServDescriptors** **0**|**1**::
  202. If set to 0, Tor will never fetch any hidden service descriptors from the
  203. rendezvous directories. This option is only useful if you're using a Tor
  204. controller that handles hidden service fetches for you. (Default: 1)
  205. **FetchServerDescriptors** **0**|**1**::
  206. If set to 0, Tor will never fetch any network status summaries or server
  207. descriptors from the directory servers. This option is only useful if
  208. you're using a Tor controller that handles directory fetches for you.
  209. (Default: 1)
  210. **FetchUselessDescriptors** **0**|**1**::
  211. If set to 1, Tor will fetch every non-obsolete descriptor from the
  212. authorities that it hears about. Otherwise, it will avoid fetching useless
  213. descriptors, for example for routers that are not running. This option is
  214. useful if you're using the contributed "exitlist" script to enumerate Tor
  215. nodes that exit to certain addresses. (Default: 0)
  216. **HTTPProxy** __host__[:__port__]::
  217. Tor will make all its directory requests through this host:port (or host:80
  218. if port is not specified), rather than connecting directly to any directory
  219. servers.
  220. **HTTPProxyAuthenticator** __username:password__::
  221. If defined, Tor will use this username:password for Basic HTTP proxy
  222. authentication, as in RFC 2617. This is currently the only form of HTTP
  223. proxy authentication that Tor supports; feel free to submit a patch if you
  224. want it to support others.
  225. **HTTPSProxy** __host__[:__port__]::
  226. Tor will make all its OR (SSL) connections through this host:port (or
  227. host:443 if port is not specified), via HTTP CONNECT rather than connecting
  228. directly to servers. You may want to set **FascistFirewall** to restrict
  229. the set of ports you might try to connect to, if your HTTPS proxy only
  230. allows connecting to certain ports.
  231. **HTTPSProxyAuthenticator** __username:password__::
  232. If defined, Tor will use this username:password for Basic HTTPS proxy
  233. authentication, as in RFC 2617. This is currently the only form of HTTPS
  234. proxy authentication that Tor supports; feel free to submit a patch if you
  235. want it to support others.
  236. **Socks4Proxy** __host__[:__port__]::
  237. Tor will make all OR connections through the SOCKS 4 proxy at host:port
  238. (or host:1080 if port is not specified).
  239. **Socks5Proxy** __host__[:__port__]::
  240. Tor will make all OR connections through the SOCKS 5 proxy at host:port
  241. (or host:1080 if port is not specified).
  242. **Socks5ProxyUsername** __username__ +
  243. **Socks5ProxyPassword** __password__::
  244. If defined, authenticate to the SOCKS 5 server using username and password
  245. in accordance to RFC 1929. Both username and password must be between 1 and
  246. 255 characters.
  247. **KeepalivePeriod** __NUM__::
  248. To keep firewalls from expiring connections, send a padding keepalive cell
  249. every NUM seconds on open connections that are in use. If the connection
  250. has no open circuits, it will instead be closed after NUM seconds of
  251. idleness. (Default: 5 minutes)
  252. **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
  253. Send all messages between __minSeverity__ and __maxSeverity__ to the standard
  254. output stream, the standard error stream, or to the system log. (The
  255. "syslog" value is only supported on Unix.) Recognized severity levels are
  256. debug, info, notice, warn, and err. We advise using "notice" in most cases,
  257. since anything more verbose may provide sensitive information to an
  258. attacker who obtains the logs. If only one severity level is given, all
  259. messages of that level or higher will be sent to the listed destination.
  260. **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
  261. As above, but send log messages to the listed filename. The
  262. "Log" option may appear more than once in a configuration file.
  263. Messages are sent to all the logs that match their severity
  264. level.
  265. **OutboundBindAddress** __IP__::
  266. Make all outbound connections originate from the IP address specified. This
  267. is only useful when you have multiple network interfaces, and you want all
  268. of Tor's outgoing connections to use a single one. This setting will be
  269. ignored for connections to the loopback addresses (127.0.0.0/8 and ::1).
  270. **PidFile** __FILE__::
  271. On startup, write our PID to FILE. On clean shutdown, remove
  272. FILE.
  273. **ProtocolWarnings** **0**|**1**::
  274. If 1, Tor will log with severity \'warn' various cases of other parties not
  275. following the Tor specification. Otherwise, they are logged with severity
  276. \'info'. (Default: 0)
  277. **RunAsDaemon** **0**|**1**::
  278. If 1, Tor forks and daemonizes to the background. This option has no effect
  279. on Windows; instead you should use the --service command-line option.
  280. (Default: 0)
  281. **SafeLogging** **0**|**1**|**relay**::
  282. Tor can scrub potentially sensitive strings from log messages (e.g.
  283. addresses) by replacing them with the string [scrubbed]. This way logs can
  284. still be useful, but they don't leave behind personally identifying
  285. information about what sites a user might have visited. +
  286. +
  287. If this option is set to 0, Tor will not perform any scrubbing, if it is
  288. set to 1, all potentially sensitive strings are replaced. If it is set to
  289. relay, all log messages generated when acting as a relay are sanitized, but
  290. all messages generated when acting as a client are not. (Default: 1)
  291. **User** __UID__::
  292. On startup, setuid to this user and setgid to their primary group.
  293. **HardwareAccel** **0**|**1**::
  294. If non-zero, try to use built-in (static) crypto hardware acceleration when
  295. available. (Default: 0)
  296. **AccelName** __NAME__::
  297. When using OpenSSL hardware crypto acceleration attempt to load the dynamic
  298. engine of this name. This must be used for any dynamic hardware engine.
  299. Names can be verified with the openssl engine command.
  300. **AccelDir** __DIR__::
  301. Specify this option if using dynamic hardware acceleration and the engine
  302. implementation library resides somewhere other than the OpenSSL default.
  303. **AvoidDiskWrites** **0**|**1**::
  304. If non-zero, try to write to disk less frequently than we would otherwise.
  305. This is useful when running on flash memory or other media that support
  306. only a limited number of writes. (Default: 0)
  307. **TunnelDirConns** **0**|**1**::
  308. If non-zero, when a directory server we contact supports it, we will build
  309. a one-hop circuit and make an encrypted connection via its ORPort.
  310. (Default: 1)
  311. **PreferTunneledDirConns** **0**|**1**::
  312. If non-zero, we will avoid directory servers that don't support tunneled
  313. directory connections, when possible. (Default: 1)
  314. **CircuitPriorityHalflife** __NUM1__::
  315. If this value is set, we override the default algorithm for choosing which
  316. circuit's cell to deliver or relay next. When the value is 0, we
  317. round-robin between the active circuits on a connection, delivering one
  318. cell from each in turn. When the value is positive, we prefer delivering
  319. cells from whichever connection has the lowest weighted cell count, where
  320. cells are weighted exponentially according to the supplied
  321. CircuitPriorityHalflife value (in seconds). If this option is not set at
  322. all, we use the behavior recommended in the current consensus
  323. networkstatus. This is an advanced option; you generally shouldn't have
  324. to mess with it. (Default: not set.)
  325. CLIENT OPTIONS
  326. --------------
  327. The following options are useful only for clients (that is, if
  328. **SocksPort** is non-zero):
  329. **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
  330. If some Tor servers are obviously not working right, the directory
  331. authorities can manually mark them as invalid, meaning that it's not
  332. recommended you use them for entry or exit positions in your circuits. You
  333. can opt to use them in some circuit positions, though. The default is
  334. "middle,rendezvous", and other choices are not advised.
  335. **ExcludeSingleHopRelays** **0**|**1**::
  336. This option controls whether circuits built by Tor will include relays with
  337. the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
  338. to 0, these relays will be included. Note that these relays might be at
  339. higher risk of being seized or observed, so they are not normally included.
  340. (Default: 1)
  341. **Bridge** __IP__:__ORPort__ [fingerprint]::
  342. When set along with UseBridges, instructs Tor to use the relay at
  343. "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
  344. is provided (using the same format as for DirServer), we will verify that
  345. the relay running at that location has the right fingerprint. We also use
  346. fingerprint to look up the bridge descriptor at the bridge authority, if
  347. it's provided and if UpdateBridgesFromAuthority is set too.
  348. **LearnCircuitBuildTimeout** **0**|**1**::
  349. If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
  350. **CircuitBuildTimeout** __NUM__::
  351. Try for at most NUM seconds when building circuits. If the circuit isn't
  352. open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
  353. value serves as the initial value to use before a timeout is learned. If
  354. LearnCircuitBuildTimeout is 0, this value is the only value used.
  355. (Default: 60 seconds.)
  356. **CircuitIdleTimeout** __NUM__::
  357. If we have kept a clean (never used) circuit around for NUM seconds, then
  358. close it. This way when the Tor client is entirely idle, it can expire all
  359. of its circuits, and then expire its TLS connections. Also, if we end up
  360. making a circuit that is not useful for exiting any of the requests we're
  361. receiving, it won't forever take up a slot in the circuit list. (Default: 1
  362. hour.)
  363. **CircuitStreamTimeout** __NUM__::
  364. If non-zero, this option overrides our internal timeout schedule for how
  365. many seconds until we detach a stream from a circuit and try a new circuit.
  366. If your network is particularly slow, you might want to set this to a
  367. number like 60. (Default: 0)
  368. **ClientOnly** **0**|**1**::
  369. If set to 1, Tor will under no circumstances run as a server or serve
  370. directory requests. The default is to run as a client unless ORPort is
  371. configured. (Usually, you don't need to set this; Tor is pretty smart at
  372. figuring out whether you are reliable and high-bandwidth enough to be a
  373. useful server.) (Default: 0)
  374. **ExcludeNodes** __node__,__node__,__...__::
  375. A list of identity fingerprints, nicknames, country codes and address
  376. patterns of nodes to never use when building a circuit. (Example:
  377. ExcludeNodes SlowServer, $ EFFFFFFFFFFFFFFF, \{cc}, 255.254.0.0/8)
  378. **ExcludeExitNodes** __node__,__node__,__...__::
  379. A list of identity fingerprints, nicknames, country codes and address
  380. patterns of nodes to never use when picking an exit node. Note that any
  381. node listed in ExcludeNodes is automatically considered to be part of this
  382. list.
  383. **EntryNodes** __node__,__node__,__...__::
  384. A list of identity fingerprints, nicknames, country codes and address
  385. patterns of nodes to use for the first hop in normal circuits. These are
  386. treated only as preferences unless StrictNodes (see below) is also set.
  387. **ExitNodes** __node__,__node__,__...__::
  388. A list of identity fingerprints, nicknames, country codes and address
  389. patterns of nodes to use for the last hop in normal exit circuits. These
  390. are treated only as preferences unless StrictNodes (see below) is also set.
  391. **StrictNodes** **0**|**1**::
  392. If 1 and EntryNodes config option is set, Tor will never use any nodes
  393. besides those listed in EntryNodes for the first hop of a normal circuit.
  394. If 1 and ExitNodes config option is set, Tor will never use any nodes
  395. besides those listed in ExitNodes for the last hop of a normal exit
  396. circuit. Note that Tor might still use these nodes for non-exit circuits
  397. such as one-hop directory fetches or hidden service support circuits.
  398. **FascistFirewall** **0**|**1**::
  399. If 1, Tor will only create outgoing connections to ORs running on ports
  400. that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
  401. This will allow you to run Tor as a client behind a firewall with
  402. restrictive policies, but will not allow you to run as a server behind such
  403. a firewall. If you prefer more fine-grained control, use
  404. ReachableAddresses instead.
  405. **FirewallPorts** __PORTS__::
  406. A list of ports that your firewall allows you to connect to. Only used when
  407. **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
  408. instead. (Default: 80, 443)
  409. **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
  410. Client authorization for a hidden service. Valid onion addresses contain 16
  411. characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
  412. characters in A-Za-z0-9+/. The service name is only used for internal
  413. purposes, e.g., for Tor controllers. This option may be used multiple times
  414. for different hidden services. If a hidden service uses authorization and
  415. this option is not set, the hidden service is not accessible. Hidden
  416. services can be configured to require authorization using the
  417. **HiddenServiceAuthorizeClient** option.
  418. **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
  419. A comma-separated list of IP addresses and ports that your firewall allows
  420. you to connect to. The format is as for the addresses in ExitPolicy, except
  421. that "accept" is understood unless "reject" is explicitly provided. For
  422. example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
  423. \*:80' means that your firewall allows connections to everything inside net
  424. 99, rejects port 80 connections to net 18, and accepts connections to port
  425. 80 otherwise. (Default: \'accept \*:*'.)
  426. **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
  427. Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
  428. these restrictions when fetching directory information, using standard HTTP
  429. GET requests. If not set explicitly then the value of
  430. **ReachableAddresses** is used. If **HTTPProxy** is set then these
  431. connections will go through that proxy.
  432. **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
  433. Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
  434. these restrictions when connecting to Onion Routers, using TLS/SSL. If not
  435. set explicitly then the value of **ReachableAddresses** is used. If
  436. **HTTPSProxy** is set then these connections will go through that proxy. +
  437. +
  438. The separation between **ReachableORAddresses** and
  439. **ReachableDirAddresses** is only interesting when you are connecting
  440. through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
  441. TLS connections (which Tor uses to connect to Onion Routers) to port 443,
  442. and some limit HTTP GET requests (which Tor uses for fetching directory
  443. information) to port 80.
  444. **LongLivedPorts** __PORTS__::
  445. A list of ports for services that tend to have long-running connections
  446. (e.g. chat and interactive shells). Circuits for streams that use these
  447. ports will contain only high-uptime nodes, to reduce the chance that a node
  448. will go down before the stream is finished. (Default: 21, 22, 706, 1863,
  449. 5050, 5190, 5222, 5223, 6667, 6697, 8300)
  450. **MapAddress** __address__ __newaddress__::
  451. When a request for address arrives to Tor, it will rewrite it to newaddress
  452. before processing it. For example, if you always want connections to
  453. www.indymedia.org to exit via __torserver__ (where __torserver__ is the
  454. nickname of the server), use "MapAddress www.indymedia.org
  455. www.indymedia.org.torserver.exit".
  456. **NewCircuitPeriod** __NUM__::
  457. Every NUM seconds consider whether to build a new circuit. (Default: 30
  458. seconds)
  459. **MaxCircuitDirtiness** __NUM__::
  460. Feel free to reuse a circuit that was first used at most NUM seconds ago,
  461. but never attach a new stream to a circuit that is too old. (Default: 10
  462. minutes)
  463. **NodeFamily** __node__,__node__,__...__::
  464. The Tor servers, defined by their identity fingerprints or nicknames,
  465. constitute a "family" of similar or co-administered servers, so never use
  466. any two of them in the same circuit. Defining a NodeFamily is only needed
  467. when a server doesn't list the family itself (with MyFamily). This option
  468. can be used multiple times.
  469. **EnforceDistinctSubnets** **0**|**1**::
  470. If 1, Tor will not put two servers whose IP addresses are "too close" on
  471. the same circuit. Currently, two addresses are "too close" if they lie in
  472. the same /16 range. (Default: 1)
  473. **SocksPort** __PORT__::
  474. Advertise this port to listen for connections from Socks-speaking
  475. applications. Set this to 0 if you don't want to allow application
  476. connections. (Default: 9050)
  477. **SocksListenAddress** __IP__[:__PORT__]::
  478. Bind to this address to listen for connections from Socks-speaking
  479. applications. (Default: 127.0.0.1) You can also specify a port (e.g.
  480. 192.168.0.1:9100). This directive can be specified multiple times to bind
  481. to multiple addresses/ports.
  482. **SocksPolicy** __policy__,__policy__,__...__::
  483. Set an entrance policy for this server, to limit who can connect to the
  484. SocksPort and DNSPort ports. The policies have the same form as exit
  485. policies below.
  486. **SocksTimeout** __NUM__::
  487. Let a socks connection wait NUM seconds handshaking, and NUM seconds
  488. unattached waiting for an appropriate circuit, before we fail it. (Default:
  489. 2 minutes.)
  490. **TrackHostExits** __host__,__.domain__,__...__::
  491. For each value in the comma separated list, Tor will track recent
  492. connections to hosts that match this value and attempt to reuse the same
  493. exit node for each. If the value is prepended with a \'.\', it is treated as
  494. matching an entire domain. If one of the values is just a \'.', it means
  495. match everything. This option is useful if you frequently connect to sites
  496. that will expire all your authentication cookies (i.e. log you out) if
  497. your IP address changes. Note that this option does have the disadvantage
  498. of making it more clear that a given history is associated with a single
  499. user. However, most people who would wish to observe this will observe it
  500. through cookies or other protocol-specific means anyhow.
  501. **TrackHostExitsExpire** __NUM__::
  502. Since exit servers go up and down, it is desirable to expire the
  503. association between host and exit server after NUM seconds. The default is
  504. 1800 seconds (30 minutes).
  505. **UpdateBridgesFromAuthority** **0**|**1**::
  506. When set (along with UseBridges), Tor will try to fetch bridge descriptors
  507. from the configured bridge authorities when feasible. It will fall back to
  508. a direct request if the authority responds with a 404. (Default: 0)
  509. **UseBridges** **0**|**1**::
  510. When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
  511. config lines, and use these relays as both entry guards and directory
  512. guards. (Default: 0)
  513. **UseEntryGuards** **0**|**1**::
  514. If this option is set to 1, we pick a few long-term entry servers, and try
  515. to stick with them. This is desirable because constantly changing servers
  516. increases the odds that an adversary who owns some servers will observe a
  517. fraction of your paths. (Defaults to 1.)
  518. **NumEntryGuards** __NUM__::
  519. If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
  520. as long-term entries for our circuits. (Defaults to 3.)
  521. **SafeSocks** **0**|**1**::
  522. When this option is enabled, Tor will reject application connections that
  523. use unsafe variants of the socks protocol -- ones that only provide an IP
  524. address, meaning the application is doing a DNS resolve first.
  525. Specifically, these are socks4 and socks5 when not doing remote DNS.
  526. (Defaults to 0.)
  527. **TestSocks** **0**|**1**::
  528. When this option is enabled, Tor will make a notice-level log entry for
  529. each connection to the Socks port indicating whether the request used a
  530. safe socks protocol or an unsafe one (see above entry on SafeSocks). This
  531. helps to determine whether an application using Tor is possibly leaking
  532. DNS requests. (Default: 0)
  533. **WarnUnsafeSocks** **0**|**1**::
  534. When this option is enabled, Tor will warn whenever a request is
  535. received that only contains an IP address instead of a hostname. Allowing
  536. applications to do DNS resolves themselves is usually a bad idea and
  537. can leak your location to attackers. (Default: 1)
  538. **VirtualAddrNetwork** __Address__/__bits__::
  539. When a controller asks for a virtual (unused) address with the MAPADDRESS
  540. command, Tor picks an unassigned address from this range. (Default:
  541. 127.192.0.0/10) +
  542. +
  543. When providing proxy server service to a network of computers using a tool
  544. like dns-proxy-tor, change this address to "10.192.0.0/10" or
  545. "172.16.0.0/12". The default **VirtualAddrNetwork** address range on a
  546. properly configured machine will route to the loopback interface. For
  547. local use, no change to the default VirtualAddrNetwork setting is needed.
  548. **AllowNonRFC953Hostnames** **0**|**1**::
  549. When this option is disabled, Tor blocks hostnames containing illegal
  550. characters (like @ and :) rather than sending them to an exit node to be
  551. resolved. This helps trap accidental attempts to resolve URLs and so on.
  552. (Default: 0)
  553. **AllowDotExit** **0**|**1**::
  554. If enabled, we convert "www.google.com.foo.exit" addresses on the
  555. SocksPort/TransPort/NatdPort into "www.google.com" addresses that exit from
  556. the node "foo". Disabled by default since attacking websites and exit
  557. relays can use it to manipulate your path selection. (Default: 0)
  558. **FastFirstHopPK** **0**|**1**::
  559. When this option is disabled, Tor uses the public key step for the first
  560. hop of creating circuits. Skipping it is generally safe since we have
  561. already used TLS to authenticate the relay and to establish forward-secure
  562. keys. Turning this option off makes circuit building slower. +
  563. +
  564. Note that Tor will always use the public key step for the first hop if it's
  565. operating as a relay, and it will never use the public key step if it
  566. doesn't yet know the onion key of the first hop. (Default: 1)
  567. **TransPort** __PORT__::
  568. If non-zero, enables transparent proxy support on __PORT__ (by convention,
  569. 9040). Requires OS support for transparent proxies, such as BSDs' pf or
  570. Linux's IPTables. If you're planning to use Tor as a transparent proxy for
  571. a network, you'll want to examine and change VirtualAddrNetwork from the
  572. default setting. You'll also want to set the TransListenAddress option for
  573. the network you'd like to proxy. (Default: 0).
  574. **TransListenAddress** __IP__[:__PORT__]::
  575. Bind to this address to listen for transparent proxy connections. (Default:
  576. 127.0.0.1). This is useful for exporting a transparent proxy server to an
  577. entire network.
  578. **NATDPort** __PORT__::
  579. Allow old versions of ipfw (as included in old versions of FreeBSD, etc.)
  580. to send connections through Tor using the NATD protocol. This option is
  581. only for people who cannot use TransPort.
  582. **NATDListenAddress** __IP__[:__PORT__]::
  583. Bind to this address to listen for NATD connections. (Default: 127.0.0.1).
  584. **AutomapHostsOnResolve** **0**|**1**::
  585. When this option is enabled, and we get a request to resolve an address
  586. that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
  587. unused virtual address to that address, and return the new virtual address.
  588. This is handy for making ".onion" addresses work with applications that
  589. resolve an address and then connect to it. (Default: 0).
  590. **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
  591. A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
  592. The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
  593. **DNSPort** __PORT__::
  594. If non-zero, Tor listens for UDP DNS requests on this port and resolves
  595. them anonymously. (Default: 0).
  596. **DNSListenAddress** __IP__[:__PORT__]::
  597. Bind to this address to listen for DNS connections. (Default: 127.0.0.1).
  598. **ClientDNSRejectInternalAddresses** **0**|**1**::
  599. If true, Tor does not believe any anonymously retrieved DNS answer that
  600. tells it that an address resolves to an internal address (like 127.0.0.1 or
  601. 192.168.0.1). This option prevents certain browser-based attacks; don't
  602. turn it off unless you know what you're doing. (Default: 1).
  603. **DownloadExtraInfo** **0**|**1**::
  604. If true, Tor downloads and caches "extra-info" documents. These documents
  605. contain information about servers other than the information in their
  606. regular router descriptors. Tor does not use this information for anything
  607. itself; to save bandwidth, leave this option turned off. (Default: 0).
  608. **FallbackNetworkstatusFile** __FILENAME__::
  609. If Tor doesn't have a cached networkstatus file, it starts out using this
  610. one instead. Even if this file is out of date, Tor can still use it to
  611. learn about directory mirrors, so it doesn't need to put load on the
  612. authorities. (Default: None).
  613. **WarnPlaintextPorts** __port__,__port__,__...__::
  614. Tells Tor to issue a warnings whenever the user tries to make an anonymous
  615. connection to one of these ports. This option is designed to alert users
  616. to services that risk sending passwords in the clear. (Default:
  617. 23,109,110,143).
  618. **RejectPlaintextPorts** __port__,__port__,__...__::
  619. Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
  620. will instead refuse to make the connection. (Default: None).
  621. SERVER OPTIONS
  622. --------------
  623. The following options are useful only for servers (that is, if ORPort
  624. is non-zero):
  625. **Address** __address__::
  626. The IP address or fully qualified domain name of this server (e.g.
  627. moria.mit.edu). You can leave this unset, and Tor will guess your IP
  628. address. This IP address is the one used to tell clients and other
  629. servers where to find your Tor server; it doesn't affect the IP that your
  630. Tor client binds to. To bind to a different address, use the
  631. *ListenAddress and OutboundBindAddress options.
  632. **AllowSingleHopExits** **0**|**1**::
  633. This option controls whether clients can use this server as a single hop
  634. proxy. If set to 1, clients can use this server as an exit even if it is
  635. the only hop in the circuit. (Default: 0)
  636. **AssumeReachable** **0**|**1**::
  637. This option is used when bootstrapping a new Tor network. If set to 1,
  638. don't do self-reachability testing; just upload your server descriptor
  639. immediately. If **AuthoritativeDirectory** is also set, this option
  640. instructs the dirserver to bypass remote reachability testing too and list
  641. all connected servers as running.
  642. **BridgeRelay** **0**|**1**::
  643. Sets the relay to act as a "bridge" with respect to relaying connections
  644. from bridge users to the Tor network. Mainly it influences how the relay
  645. will cache and serve directory information. Usually used in combination
  646. with PublishServerDescriptor.
  647. **ContactInfo** __email_address__::
  648. Administrative contact information for server. This line might get picked
  649. up by spam harvesters, so you may want to obscure the fact that it's an
  650. email address.
  651. **ExitPolicy** __policy__,__policy__,__...__::
  652. Set an exit policy for this server. Each policy is of the form
  653. "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
  654. omitted then this policy just applies to the host given. Instead of giving
  655. a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
  656. __PORT__ can be a single port number, an interval of ports
  657. "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
  658. "\*". +
  659. +
  660. For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
  661. reject any traffic destined for MIT except for web.mit.edu, and accept
  662. anything else. +
  663. +
  664. To specify all internal and link-local networks (including 0.0.0.0/8,
  665. 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
  666. 172.16.0.0/12), you can use the "private" alias instead of an address.
  667. These addresses are rejected by default (at the beginning of your exit
  668. policy), along with your public IP address, unless you set the
  669. ExitPolicyRejectPrivate config option to 0. For example, once you've done
  670. that, you could allow HTTP to 127.0.0.1 and block all other connections to
  671. internal networks with "accept 127.0.0.1:80,reject private:\*", though that
  672. may also allow connections to your own computer that are addressed to its
  673. public (external) IP address. See RFC 1918 and RFC 3330 for more details
  674. about internal and reserved IP address space. +
  675. +
  676. This directive can be specified multiple times so you don't have to put it
  677. all on one line. +
  678. +
  679. Policies are considered first to last, and the first match wins. If you
  680. want to \_replace_ the default exit policy, end your exit policy with
  681. either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
  682. (prepending to) the default exit policy. The default exit policy is: +
  683. reject *:25
  684. reject *:119
  685. reject *:135-139
  686. reject *:445
  687. reject *:563
  688. reject *:1214
  689. reject *:4661-4666
  690. reject *:6346-6429
  691. reject *:6699
  692. reject *:6881-6999
  693. accept *:*
  694. **ExitPolicyRejectPrivate** **0**|**1**::
  695. Reject all private (local) networks, along with your own public IP address,
  696. at the beginning of your exit policy. See above entry on ExitPolicy.
  697. (Default: 1)
  698. **MaxOnionsPending** __NUM__::
  699. If you have more than this number of onionskins queued for decrypt, reject
  700. new ones. (Default: 100)
  701. **MyFamily** __node__,__node__,__...__::
  702. Declare that this Tor server is controlled or administered by a group or
  703. organization identical or similar to that of the other servers, defined by
  704. their identity fingerprints or nicknames. When two servers both declare
  705. that they are in the same \'family', Tor clients will not use them in the
  706. same circuit. (Each server only needs to list the other servers in its
  707. family; it doesn't need to list itself, but it won't hurt.)
  708. **Nickname** __name__::
  709. Set the server's nickname to \'name'. Nicknames must be between 1 and 19
  710. characters inclusive, and must contain only the characters [a-zA-Z0-9].
  711. **NumCPUs** __num__::
  712. How many processes to use at once for decrypting onionskins. (Default: 1)
  713. **ORPort** __PORT__::
  714. Advertise this port to listen for connections from Tor clients and servers.
  715. **ORListenAddress** __IP__[:__PORT__]::
  716. Bind to this IP address to listen for connections from Tor clients and
  717. servers. If you specify a port, bind to this port rather than the one
  718. specified in ORPort. (Default: 0.0.0.0) This directive can be specified
  719. multiple times to bind to multiple addresses/ports.
  720. **PublishServerDescriptor** **0**|**1**|**v1**|**v2**|**v3**|**bridge**|**hidserv**,**...**::
  721. This option is only considered if you have an ORPort defined. You can
  722. choose multiple arguments, separated by commas.
  723. +
  724. If set to 0, Tor will act as a server but it will not publish its
  725. descriptor to the directory authorities. (This is useful if you're testing
  726. out your server, or if you're using a Tor controller that handles directory
  727. publishing for you.) Otherwise, Tor will publish its descriptor to all
  728. directory authorities of the type(s) specified. The value "1" is the
  729. default, which means "publish to the appropriate authorities".
  730. **ShutdownWaitLength** __NUM__::
  731. When we get a SIGINT and we're a server, we begin shutting down:
  732. we close listeners and start refusing new circuits. After **NUM**
  733. seconds, we exit. If we get a second SIGINT, we exit immedi-
  734. ately. (Default: 30 seconds)
  735. **AccountingMax** __N__ **bytes**|**KB**|**MB**|**GB**|**TB**::
  736. Never send more than the specified number of bytes in a given accounting
  737. period, or receive more than that number in the period. For example, with
  738. AccountingMax set to 1 GB, a server could send 900 MB and receive 800 MB
  739. and continue running. It will only hibernate once one of the two reaches 1
  740. GB. When the number of bytes is exhausted, Tor will hibernate until some
  741. time in the next accounting period. To prevent all servers from waking at
  742. the same time, Tor will also wait until a random point in each period
  743. before waking up. If you have bandwidth cost issues, enabling hibernation
  744. is preferable to setting a low bandwidth, since it provides users with a
  745. collection of fast servers that are up some of the time, which is more
  746. useful than a set of slow servers that are always "available".
  747. **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
  748. Specify how long accounting periods last. If **month** is given, each
  749. accounting period runs from the time __HH:MM__ on the __dayth__ day of one
  750. month to the same day and time of the next. (The day must be between 1 and
  751. 28.) If **week** is given, each accounting period runs from the time __HH:MM__
  752. of the __dayth__ day of one week to the same day and time of the next week,
  753. with Monday as day 1 and Sunday as day 7. If **day** is given, each
  754. accounting period runs from the time __HH:MM__ each day to the same time on
  755. the next day. All times are local, and given in 24-hour time. (Defaults to
  756. "month 1 0:00".)
  757. **ServerDNSResolvConfFile** __filename__::
  758. Overrides the default DNS configuration with the configuration in
  759. __filename__. The file format is the same as the standard Unix
  760. "**resolv.conf**" file (7). This option, like all other ServerDNS options,
  761. only affects name lookups that your server does on behalf of clients.
  762. (Defaults to use the system DNS configuration.)
  763. **ServerDNSAllowBrokenConfig** **0**|**1**::
  764. If this option is false, Tor exits immediately if there are problems
  765. parsing the system DNS configuration or connecting to nameservers.
  766. Otherwise, Tor continues to periodically retry the system nameservers until
  767. it eventually succeeds. (Defaults to "1".)
  768. **ServerDNSSearchDomains** **0**|**1**::
  769. If set to 1, then we will search for addresses in the local search domain.
  770. For example, if this system is configured to believe it is in
  771. "example.com", and a client tries to connect to "www", the client will be
  772. connected to "www.example.com". This option only affects name lookups that
  773. your server does on behalf of clients. (Defaults to "0".)
  774. **ServerDNSDetectHijacking** **0**|**1**::
  775. When this option is set to 1, we will test periodically to determine
  776. whether our local nameservers have been configured to hijack failing DNS
  777. requests (usually to an advertising site). If they are, we will attempt to
  778. correct this. This option only affects name lookups that your server does
  779. on behalf of clients. (Defaults to "1".)
  780. **ServerDNSTestAddresses** __address__,__address__,__...__::
  781. When we're detecting DNS hijacking, make sure that these __valid__ addresses
  782. aren't getting redirected. If they are, then our DNS is completely useless,
  783. and we'll reset our exit policy to "reject *:*". This option only affects
  784. name lookups that your server does on behalf of clients. (Defaults to
  785. "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org".)
  786. **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
  787. When this option is disabled, Tor does not try to resolve hostnames
  788. containing illegal characters (like @ and :) rather than sending them to an
  789. exit node to be resolved. This helps trap accidental attempts to resolve
  790. URLs and so on. This option only affects name lookups that your server does
  791. on behalf of clients. (Default: 0)
  792. **BridgeRecordUsageByCountry** **0**|**1**::
  793. When this option is enabled and BridgeRelay is also enabled, and we have
  794. GeoIP data, Tor keeps a keep a per-country count of how many client
  795. addresses have contacted it so that it can help the bridge authority guess
  796. which countries have blocked access to it. (Default: 1)
  797. **ServerDNSRandomizeCase** **0**|**1**::
  798. When this option is set, Tor sets the case of each character randomly in
  799. outgoing DNS requests, and makes sure that the case matches in DNS replies.
  800. This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
  801. For more information, see "Increased DNS Forgery Resistance through
  802. 0x20-Bit Encoding". This option only affects name lookups that your server
  803. does on behalf of clients. (Default: 1)
  804. **GeoIPFile** __filename__::
  805. A filename containing GeoIP data, for use with BridgeRecordUsageByCountry.
  806. **CellStatistics** **0**|**1**::
  807. When this option is enabled, Tor writes statistics on the mean time that
  808. cells spend in circuit queues to disk every 24 hours. Cannot be changed
  809. while Tor is running. (Default: 0)
  810. **DirReqStatistics** **0**|**1**::
  811. When this option is enabled, Tor writes statistics on the number and
  812. response time of network status requests to disk every 24 hours. Cannot be
  813. changed while Tor is running. (Default: 0)
  814. **EntryStatistics** **0**|**1**::
  815. When this option is enabled, Tor writes statistics on the number of
  816. directly connecting clients to disk every 24 hours. Cannot be changed while
  817. Tor is running. (Default: 0)
  818. **ExitPortStatistics** **0**|**1**::
  819. When this option is enabled, Tor writes statistics on the number of relayed
  820. bytes and opened stream per exit port to disk every 24 hours. Cannot be
  821. changed while Tor is running. (Default: 0)
  822. **ExtraInfoStatistics** **0**|**1**::
  823. When this option is enabled, Tor includes previously gathered statistics in
  824. its extra-info documents that it uploads to the directory authorities.
  825. (Default: 0)
  826. DIRECTORY SERVER OPTIONS
  827. ------------------------
  828. The following options are useful only for directory servers (that is,
  829. if DirPort is non-zero):
  830. **AuthoritativeDirectory** **0**|**1**::
  831. When this option is set to 1, Tor operates as an authoritative directory
  832. server. Instead of caching the directory, it generates its own list of
  833. good servers, signs it, and sends that to the clients. Unless the clients
  834. already have you listed as a trusted directory, you probably do not want
  835. to set this option. Please coordinate with the other admins at
  836. tor-ops@torproject.org if you think you should be a directory.
  837. **DirPortFrontPage** __FILENAME__::
  838. When this option is set, it takes an HTML file and publishes it as "/" on
  839. the DirPort. Now relay operators can provide a disclaimer without needing
  840. to set up a separate webserver. There's a sample disclaimer in
  841. contrib/tor-exit-notice.html.
  842. **V1AuthoritativeDirectory** **0**|**1**::
  843. When this option is set in addition to **AuthoritativeDirectory**, Tor
  844. generates version 1 directory and running-routers documents (for legacy
  845. Tor clients up to 0.1.0.x).
  846. **V2AuthoritativeDirectory** **0**|**1**::
  847. When this option is set in addition to **AuthoritativeDirectory**, Tor
  848. generates version 2 network statuses and serves descriptors, etc as
  849. described in doc/spec/dir-spec-v2.txt (for Tor clients and servers running
  850. 0.1.1.x and 0.1.2.x).
  851. **V3AuthoritativeDirectory** **0**|**1**::
  852. When this option is set in addition to **AuthoritativeDirectory**, Tor
  853. generates version 3 network statuses and serves descriptors, etc as
  854. described in doc/spec/dir-spec.txt (for Tor clients and servers running at
  855. least 0.2.0.x).
  856. **VersioningAuthoritativeDirectory** **0**|**1**::
  857. When this option is set to 1, Tor adds information on which versions of
  858. Tor are still believed safe for use to the published directory. Each
  859. version 1 authority is automatically a versioning authority; version 2
  860. authorities provide this service optionally. See **RecommendedVersions**,
  861. **RecommendedClientVersions**, and **RecommendedServerVersions**.
  862. **NamingAuthoritativeDirectory** **0**|**1**::
  863. When this option is set to 1, then the server advertises that it has
  864. opinions about nickname-to-fingerprint bindings. It will include these
  865. opinions in its published network-status pages, by listing servers with
  866. the flag "Named" if a correct binding between that nickname and fingerprint
  867. has been registered with the dirserver. Naming dirservers will refuse to
  868. accept or publish descriptors that contradict a registered binding. See
  869. **approved-routers** in the **FILES** section below.
  870. **HSAuthoritativeDir** **0**|**1**::
  871. When this option is set in addition to **AuthoritativeDirectory**, Tor also
  872. accepts and serves hidden service descriptors. (Default: 0)
  873. **HidServDirectoryV2** **0**|**1**::
  874. When this option is set, Tor accepts and serves v2 hidden service
  875. descriptors. Setting DirPort is not required for this, because clients
  876. connect via the ORPort by default. (Default: 1)
  877. **BridgeAuthoritativeDir** **0**|**1**::
  878. When this option is set in addition to **AuthoritativeDirectory**, Tor
  879. accepts and serves router descriptors, but it caches and serves the main
  880. networkstatus documents rather than generating its own. (Default: 0)
  881. **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  882. Minimum uptime of a v2 hidden service directory to be accepted as such by
  883. authoritative directories. (Default: 24 hours)
  884. **DirPort** __PORT__::
  885. Advertise the directory service on this port.
  886. **DirListenAddress** __IP__[:__PORT__]::
  887. Bind the directory service to this address. If you specify a port, bind to
  888. this port rather than the one specified in DirPort. (Default: 0.0.0.0)
  889. This directive can be specified multiple times to bind to multiple
  890. addresses/ports.
  891. **DirPolicy** __policy__,__policy__,__...__::
  892. Set an entrance policy for this server, to limit who can connect to the
  893. directory ports. The policies have the same form as exit policies above.
  894. DIRECTORY AUTHORITY SERVER OPTIONS
  895. ----------------------------------
  896. **RecommendedVersions** __STRING__::
  897. STRING is a comma-separated list of Tor versions currently believed to be
  898. safe. The list is included in each directory, and nodes which pull down the
  899. directory learn whether they need to upgrade. This option can appear
  900. multiple times: the values from multiple lines are spliced together. When
  901. this is set then **VersioningAuthoritativeDirectory** should be set too.
  902. **RecommendedClientVersions** __STRING__::
  903. STRING is a comma-separated list of Tor versions currently believed to be
  904. safe for clients to use. This information is included in version 2
  905. directories. If this is not set then the value of **RecommendedVersions**
  906. is used. When this is set then **VersioningAuthoritativeDirectory** should
  907. be set too.
  908. **RecommendedServerVersions** __STRING__::
  909. STRING is a comma-separated list of Tor versions currently believed to be
  910. safe for servers to use. This information is included in version 2
  911. directories. If this is not set then the value of **RecommendedVersions**
  912. is used. When this is set then **VersioningAuthoritativeDirectory** should
  913. be set too.
  914. **ConsensusParams** __STRING__::
  915. STRING is a space-separated list of key=value pairs that Tor will include
  916. in the "params" line of its networkstatus vote.
  917. **DirAllowPrivateAddresses** **0**|**1**::
  918. If set to 1, Tor will accept router descriptors with arbitrary "Address"
  919. elements. Otherwise, if the address is not an IP address or is a private IP
  920. address, it will reject the router descriptor. Defaults to 0.
  921. **AuthDirBadDir** __AddressPattern...__::
  922. Authoritative directories only. A set of address patterns for servers that
  923. will be listed as bad directories in any network status document this
  924. authority publishes, if **AuthDirListBadDirs** is set.
  925. **AuthDirBadExit** __AddressPattern...__::
  926. Authoritative directories only. A set of address patterns for servers that
  927. will be listed as bad exits in any network status document this authority
  928. publishes, if **AuthDirListBadExits** is set.
  929. **AuthDirInvalid** __AddressPattern...__::
  930. Authoritative directories only. A set of address patterns for servers that
  931. will never be listed as "valid" in any network status document that this
  932. authority publishes.
  933. **AuthDirReject** __AddressPattern__...::
  934. Authoritative directories only. A set of address patterns for servers that
  935. will never be listed at all in any network status document that this
  936. authority publishes, or accepted as an OR address in any descriptor
  937. submitted for publication by this authority.
  938. **AuthDirListBadDirs** **0**|**1**::
  939. Authoritative directories only. If set to 1, this directory has some
  940. opinion about which nodes are unsuitable as directory caches. (Do not set
  941. this to 1 unless you plan to list non-functioning directories as bad;
  942. otherwise, you are effectively voting in favor of every declared
  943. directory.)
  944. **AuthDirListBadExits** **0**|**1**::
  945. Authoritative directories only. If set to 1, this directory has some
  946. opinion about which nodes are unsuitable as exit nodes. (Do not set this to
  947. 1 unless you plan to list non-functioning exits as bad; otherwise, you are
  948. effectively voting in favor of every declared exit as an exit.)
  949. **AuthDirRejectUnlisted** **0**|**1**::
  950. Authoritative directories only. If set to 1, the directory server rejects
  951. all uploaded server descriptors that aren't explicitly listed in the
  952. fingerprints file. This acts as a "panic button" if we get hit with a Sybil
  953. attack. (Default: 0)
  954. **AuthDirMaxServersPerAddr** __NUM__::
  955. Authoritative directories only. The maximum number of servers that we will
  956. list as acceptable on a single IP address. Set this to "0" for "no limit".
  957. (Default: 2)
  958. **AuthDirMaxServersPerAuthAddr** __NUM__::
  959. Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
  960. to addresses shared with directory authorities. (Default: 5)
  961. **V3AuthVotingInterval** __N__ **minutes**|**hours**::
  962. V3 authoritative directories only. Configures the server's preferred voting
  963. interval. Note that voting will __actually__ happen at an interval chosen
  964. by consensus from all the authorities' preferred intervals. This time
  965. SHOULD divide evenly into a day. (Default: 1 hour)
  966. **V3AuthVoteDelay** __N__ **minutes**|**hours**::
  967. V3 authoritative directories only. Configures the server's preferred delay
  968. between publishing its vote and assuming it has all the votes from all the
  969. other authorities. Note that the actual time used is not the server's
  970. preferred time, but the consensus of all preferences. (Default: 5 minutes.)
  971. **V3AuthDistDelay** __N__ **minutes**|**hours**::
  972. V3 authoritative directories only. Configures the server's preferred delay
  973. between publishing its consensus and signature and assuming it has all the
  974. signatures from all the other authorities. Note that the actual time used
  975. is not the server's preferred time, but the consensus of all preferences.
  976. (Default: 5 minutes.)
  977. **V3AuthNIntervalsValid** __NUM__::
  978. V3 authoritative directories only. Configures the number of VotingIntervals
  979. for which each consensus should be valid for. Choosing high numbers
  980. increases network partitioning risks; choosing low numbers increases
  981. directory traffic. Note that the actual number of intervals used is not the
  982. server's preferred number, but the consensus of all preferences. Must be at
  983. least 2. (Default: 3.)
  984. HIDDEN SERVICE OPTIONS
  985. ----------------------
  986. The following options are used to configure a hidden service.
  987. **HiddenServiceDir** __DIRECTORY__::
  988. Store data files for a hidden service in DIRECTORY. Every hidden service
  989. must have a separate directory. You may use this option multiple times to
  990. specify multiple services.
  991. **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
  992. Configure a virtual port VIRTPORT for a hidden service. You may use this
  993. option multiple times; each time applies to the service using the most
  994. recent hiddenservicedir. By default, this option maps the virtual port to
  995. the same port on 127.0.0.1. You may override the target port, address, or
  996. both by specifying a target of addr, port, or addr:port. You may also have
  997. multiple lines with the same VIRTPORT: when a user connects to that
  998. VIRTPORT, one of the TARGETs from those lines will be chosen at random.
  999. **PublishHidServDescriptors** **0**|**1**::
  1000. If set to 0, Tor will run any hidden services you configure, but it won't
  1001. advertise them to the rendezvous directory. This option is only useful if
  1002. you're using a Tor controller that handles hidserv publishing for you.
  1003. (Default: 1)
  1004. **HiddenServiceVersion** __version__,__version__,__...__::
  1005. A list of rendezvous service descriptor versions to publish for the hidden
  1006. service. Currently, only version 2 is supported. (Default: 2)
  1007. **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
  1008. If configured, the hidden service is accessible for authorized clients
  1009. only. The auth-type can either be \'basic' for a general-purpose
  1010. authorization protocol or \'stealth' for a less scalable protocol that also
  1011. hides service activity from unauthorized clients. Only clients that are
  1012. listed here are authorized to access the hidden service. Valid client names
  1013. are 1 to 19 characters long and only use characters in A-Za-z0-9+-_ (no
  1014. spaces). If this option is set, the hidden service is not accessible for
  1015. clients without authorization any more. Generated authorization data can be
  1016. found in the hostname file. Clients need to put this authorization data in
  1017. their configuration file using **HidServAuth**.
  1018. **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  1019. Every time the specified period elapses, Tor uploads any rendezvous
  1020. service descriptors to the directory servers. This information is also
  1021. uploaded whenever it changes. (Default: 20 minutes)
  1022. TESTING NETWORK OPTIONS
  1023. -----------------------
  1024. The following options are used for running a testing Tor network.
  1025. **TestingTorNetwork** **0**|**1**::
  1026. If set to 1, Tor adjusts default values of the configuration options below,
  1027. so that it is easier to set up a testing Tor network. May only be set if
  1028. non-default set of DirServers is set. Cannot be unset while Tor is running.
  1029. (Default: 0) +
  1030. ServerDNSAllowBrokenConfig 1
  1031. DirAllowPrivateAddresses 1
  1032. EnforceDistinctSubnets 0
  1033. AssumeReachable 1
  1034. AuthDirMaxServersPerAddr 0
  1035. AuthDirMaxServersPerAuthAddr 0
  1036. ClientDNSRejectInternalAddresses 0
  1037. ExitPolicyRejectPrivate 0
  1038. V3AuthVotingInterval 5 minutes
  1039. V3AuthVoteDelay 20 seconds
  1040. V3AuthDistDelay 20 seconds
  1041. TestingV3AuthInitialVotingInterval 5 minutes
  1042. TestingV3AuthInitialVoteDelay 20 seconds
  1043. TestingV3AuthInitialDistDelay 20 seconds
  1044. TestingAuthDirTimeToLearnReachability 0 minutes
  1045. TestingEstimatedDescriptorPropagationTime 0 minutes
  1046. **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
  1047. Like V3AuthVotingInterval, but for initial voting interval before the first
  1048. consensus has been created. Changing this requires that
  1049. **TestingTorNetwork** is set. (Default: 30 minutes)
  1050. **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
  1051. Like TestingV3AuthInitialVoteDelay, but for initial voting interval before
  1052. the first consensus has been created. Changing this requires that
  1053. **TestingTorNetwork** is set. (Default: 5 minutes)
  1054. **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
  1055. Like TestingV3AuthInitialDistDelay, but for initial voting interval before
  1056. the first consensus has been created. Changing this requires that
  1057. **TestingTorNetwork** is set. (Default: 5 minutes)
  1058. **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
  1059. After starting as an authority, do not make claims about whether routers
  1060. are Running until this much time has passed. Changing this requires
  1061. that **TestingTorNetwork** is set. (Default: 30 minutes)
  1062. **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
  1063. Clients try downloading router descriptors from directory caches after this
  1064. time. Changing this requires that **TestingTorNetwork** is set. (Default:
  1065. 10 minutes)
  1066. SIGNALS
  1067. -------
  1068. Tor catches the following signals:
  1069. **SIGTERM**::
  1070. Tor will catch this, clean up and sync to disk if necessary, and exit.
  1071. **SIGINT**::
  1072. Tor clients behave as with SIGTERM; but Tor servers will do a controlled
  1073. slow shutdown, closing listeners and waiting 30 seconds before exiting.
  1074. (The delay can be configured with the ShutdownWaitLength config option.)
  1075. **SIGHUP**::
  1076. The signal instructs Tor to reload its configuration (including closing and
  1077. reopening logs), and kill and restart its helper processes if applicable.
  1078. **SIGUSR1**::
  1079. Log statistics about current connections, past connections, and throughput.
  1080. **SIGUSR2**::
  1081. Switch all logs to loglevel debug. You can go back to the old loglevels by
  1082. sending a SIGHUP.
  1083. **SIGCHLD**::
  1084. Tor receives this signal when one of its helper processes has exited, so it
  1085. can clean up.
  1086. **SIGPIPE**::
  1087. Tor catches this signal and ignores it.
  1088. **SIGXFSZ**::
  1089. If this signal exists on your platform, Tor catches and ignores it.
  1090. FILES
  1091. -----
  1092. **@CONFDIR@/torrc**::
  1093. The configuration file, which contains "option value" pairs.
  1094. **@LOCALSTATEDIR@/lib/tor/**::
  1095. The tor process stores keys and other data here.
  1096. __DataDirectory__**/cached-status/**::
  1097. The most recently downloaded network status document for each authority.
  1098. Each file holds one such document; the filenames are the hexadecimal
  1099. identity key fingerprints of the directory authorities.
  1100. __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
  1101. These files hold downloaded router statuses. Some routers may appear more
  1102. than once; if so, the most recently published descriptor is used. Lines
  1103. beginning with @-signs are annotations that contain more information about
  1104. a given router. The ".new" file is an append-only journal; when it gets
  1105. too large, all entries are merged into a new cached-descriptors file.
  1106. __DataDirectory__**/cached-routers** and **cached-routers.new**::
  1107. Obsolete versions of cached-descriptors and cached-descriptors.new. When
  1108. Tor can't find the newer files, it looks here instead.
  1109. __DataDirectory__**/state**::
  1110. A set of persistent key-value mappings. These are documented in
  1111. the file. These include:
  1112. - The current entry guards and their status.
  1113. - The current bandwidth accounting values (unused so far; see
  1114. below).
  1115. - When the file was last written
  1116. - What version of Tor generated the state file
  1117. - A short history of bandwidth usage, as produced in the router
  1118. descriptors.
  1119. __DataDirectory__**/bw_accounting**::
  1120. Used to track bandwidth accounting values (when the current period starts
  1121. and ends; how much has been read and written so far this period). This file
  1122. is obsolete, and the data is now stored in the \'state' file as well. Only
  1123. used when bandwidth accounting is enabled.
  1124. __DataDirectory__**/control_auth_cookie**::
  1125. Used for cookie authentication with the controller. Location can be
  1126. overridden by the CookieAuthFile config option. Regenerated on startup. See
  1127. control-spec.txt for details. Only used when cookie authentication is
  1128. enabled.
  1129. __DataDirectory__**/keys/***::
  1130. Only used by servers. Holds identity keys and onion keys.
  1131. __DataDirectory__**/fingerprint**::
  1132. Only used by servers. Holds the fingerprint of the server's identity key.
  1133. __DataDirectory__**/approved-routers**::
  1134. Only for naming authoritative directory servers (see
  1135. **NamingAuthoritativeDirectory**). This file lists nickname to identity
  1136. bindings. Each line lists a nickname and a fingerprint separated by
  1137. whitespace. See your **fingerprint** file in the __DataDirectory__ for an
  1138. example line. If the nickname is **!reject** then descriptors from the
  1139. given identity (fingerprint) are rejected by this server. If it is
  1140. **!invalid** then descriptors are accepted but marked in the directory as
  1141. not valid, that is, not recommended.
  1142. __DataDirectory__**/router-stability**::
  1143. Only used by authoritative directory servers. Tracks measurements for
  1144. router mean-time-between-failures so that authorities have a good idea of
  1145. how to set their Stable flags.
  1146. __HiddenServiceDirectory__**/hostname**::
  1147. The <base32-encoded-fingerprint>.onion domain name for this hidden service.
  1148. If the hidden service is restricted to authorized clients only, this file
  1149. also contains authorization data for all clients.
  1150. __HiddenServiceDirectory__**/private_key**::
  1151. The private key for this hidden service.
  1152. __HiddenServiceDirectory__**/client_keys**::
  1153. Authorization data for a hidden service that is only accessible by
  1154. authorized clients.
  1155. SEE ALSO
  1156. --------
  1157. **privoxy**(1), **tsocks**(1), **torify**(1) +
  1158. **https://www.torproject.org/**
  1159. BUGS
  1160. ----
  1161. Plenty, probably. Tor is still in development. Please report them.
  1162. AUTHORS
  1163. -------
  1164. Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].