tor.1.txt 70 KB

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