tor.1.txt 113 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273
  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. :man source: Tor
  6. :man manual: Tor Manual
  7. TOR(1)
  8. ======
  9. NAME
  10. ----
  11. tor - The second-generation onion router
  12. SYNOPSIS
  13. --------
  14. **tor** [__OPTION__ __value__]...
  15. DESCRIPTION
  16. -----------
  17. __tor__ is a connection-oriented anonymizing communication
  18. service. Users choose a source-routed path through a set of nodes, and
  19. negotiate a "virtual circuit" through the network, in which each node
  20. knows its predecessor and successor, but no others. Traffic flowing down
  21. the circuit is unwrapped by a symmetric key at each node, which reveals
  22. the downstream node. +
  23. Basically __tor__ provides a distributed network of servers ("onion routers").
  24. Users bounce their TCP streams -- web traffic, ftp, ssh, etc -- around the
  25. routers, and recipients, observers, and even the routers themselves have
  26. difficulty tracking the source of the stream.
  27. COMMAND-LINE OPTIONS
  28. --------------------
  29. **-h**, **-help**::
  30. Display a short help message and exit.
  31. **-f** __FILE__::
  32. Specify a new configuration file to contain further Tor configuration
  33. options. (Default: $HOME/.torrc, or @CONFDIR@/torrc if that file is not
  34. found)
  35. **--defaults-torrc** __FILE__::
  36. Specify a file in which to find default values for Tor options. The
  37. contents of this file are overridden by those in the regular
  38. configuration file, and by those on the command line. (Default:
  39. @CONFDIR@/torrc-defaults.)
  40. **--hash-password** __PASSWORD__::
  41. Generates a hashed password for control port access.
  42. **--list-fingerprint**::
  43. Generate your keys and output your nickname and fingerprint.
  44. **--verify-config**::
  45. Verify the configuration file is valid.
  46. **--service install** [**--options** __command-line options__]::
  47. Install an instance of Tor as a Windows service, with the provided
  48. command-line options. Current instructions can be found at
  49. https://trac.torproject.org/projects/tor/wiki/doc/TorFAQ#HowdoIrunmyTorrelayasanNTservice
  50. **--service** **remove**|**start**|**stop**::
  51. Remove, start, or stop a configured Tor Windows service.
  52. **--nt-service**::
  53. Used internally to implement a Windows service.
  54. **--list-torrc-options**::
  55. List all valid options.
  56. **--version**::
  57. Display Tor version and exit.
  58. **--quiet**|**--hush**::
  59. Override the default console log. By default, Tor starts out logging
  60. messages at level "notice" and higher to the console. It stops doing so
  61. after it parses its configuration, if the configuration tells it to log
  62. anywhere else. You can override this behavior with the **--hush** option,
  63. which tells Tor to only send warnings and errors to the console, or with
  64. the **--quiet** option, which tells Tor not to log to the console at all.
  65. Other options can be specified on the command-line in the format "--option
  66. value", in the format "option value", or in a configuration file. For
  67. instance, you can tell Tor to start listening for SOCKS connections on port
  68. 9999 by passing --SOCKSPort 9999 or SOCKSPort 9999 to it on the command line,
  69. or by putting "SOCKSPort 9999" in the configuration file. You will need to
  70. quote options with spaces in them: if you want Tor to log all debugging
  71. messages to debug.log, you will probably need to say --Log 'debug file
  72. debug.log'.
  73. Options on the command line override those in configuration files. See the
  74. next section for more information.
  75. THE CONFIGURATION FILE FORMAT
  76. -----------------------------
  77. All configuration options in a configuration are written on a single line by
  78. default. They take the form of an option name and a value, or an option name
  79. and a quoted value (option value or option "value"). Anything after a #
  80. character is treated as a comment. Options are
  81. case-insensitive. C-style escaped characters are allowed inside quoted
  82. values. To split one configuration entry into multiple lines, use a single
  83. backslash character (\) before the end of the line. Comments can be used in
  84. such multiline entries, but they must start at the beginning of a line.
  85. By default, an option on the command line overrides an option found in the
  86. configuration file, and an option in a configuration file overrides one in
  87. the defaults file.
  88. This rule is simple for options that take a single value, but it can become
  89. complicated for options that are allowed to occur more than once: if you
  90. specify four SOCKSPorts in your configuration file, and one more SOCKSPort on
  91. the command line, the option on the command line will replace __all__ of the
  92. SOCKSPorts in the configuration file. If this isn't what you want, prefix
  93. the option name with a plus sign, and it will be appended to the previous set
  94. of options instead.
  95. Alternatively, you might want to remove every instance of an option in the
  96. configuration file, and not replace it at all: you might want to say on the
  97. command line that you want no SOCKSPorts at all. To do that, prefix the
  98. option name with a forward slash.
  99. GENERAL OPTIONS
  100. ---------------
  101. **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  102. A token bucket limits the average incoming bandwidth usage on this node to
  103. the specified number of bytes per second, and the average outgoing
  104. bandwidth usage to that same value. If you want to run a relay in the
  105. public network, this needs to be _at the very least_ 30 KBytes (that is,
  106. 30720 bytes). (Default: 1 GByte)
  107. **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  108. Limit the maximum token bucket size (also known as the burst) to the given
  109. number of bytes in each direction. (Default: 1 GByte)
  110. **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  111. If set, we will not advertise more than this amount of bandwidth for our
  112. BandwidthRate. Server operators who want to reduce the number of clients
  113. who ask to build circuits through them (since this is proportional to
  114. advertised bandwidth rate) can thus reduce the CPU demands on their server
  115. without impacting network performance.
  116. **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  117. If not 0, a separate token bucket limits the average incoming bandwidth
  118. usage for \_relayed traffic_ on this node to the specified number of bytes
  119. per second, and the average outgoing bandwidth usage to that same value.
  120. Relayed traffic currently is calculated to include answers to directory
  121. requests, but that may change in future versions. (Default: 0)
  122. **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  123. If not 0, limit the maximum token bucket size (also known as the burst) for
  124. \_relayed traffic_ to the given number of bytes in each direction.
  125. (Default: 0)
  126. **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  127. If set, do separate rate limiting for each connection from a non-relay.
  128. You should never need to change this value, since a network-wide value is
  129. published in the consensus and your relay will use that value. (Default: 0)
  130. **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  131. If set, do separate rate limiting for each connection from a non-relay.
  132. You should never need to change this value, since a network-wide value is
  133. published in the consensus and your relay will use that value. (Default: 0)
  134. **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
  135. **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
  136. In its first form, when set along with a corresponding Bridge line, the Tor
  137. client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
  138. duty of that proxy to properly forward the traffic to the bridge. +
  139. +
  140. In its second form, when set along with a corresponding Bridge line, the Tor
  141. client launches the pluggable transport proxy executable in
  142. __path-to-binary__ using __options__ as its command-line options, and
  143. forwards its traffic to it. It's the duty of that proxy to properly forward
  144. the traffic to the bridge.
  145. **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
  146. The Tor relay launches the pluggable transport proxy in __path-to-binary__
  147. using __options__ as its command-line options, and expects to receive
  148. proxied client traffic from it.
  149. **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
  150. When this option is set, Tor will suggest __IP__:__PORT__ as the
  151. listening address of any pluggable transport proxy that tries to
  152. launch __transport__.
  153. **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...::
  154. When this option is set, Tor will pass the __k=v__ parameters to
  155. any pluggable transport proxy that tries to launch __transport__. +
  156. (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache)
  157. **ExtORPort** \['address':]__port__|**auto**
  158. Open this port to listen for Extended ORPort connections from your
  159. pluggable transports.
  160. **ExtORPortCookieAuthFile** __Path__::
  161. If set, this option overrides the default location and file name
  162. for the Extended ORPort's cookie file -- the cookie file is needed
  163. for pluggable transports to communicate through the Extended ORPort.
  164. **ConnLimit** __NUM__::
  165. The minimum number of file descriptors that must be available to the Tor
  166. process before it will start. Tor will ask the OS for as many file
  167. descriptors as the OS will allow (you can find this by "ulimit -H -n").
  168. If this number is less than ConnLimit, then Tor will refuse to start. +
  169. +
  170. You probably don't need to adjust this. It has no effect on Windows
  171. since that platform lacks getrlimit(). (Default: 1000)
  172. **DisableNetwork** **0**|**1**::
  173. When this option is set, we don't listen for or accept any connections
  174. other than controller connections, and we don't make any outbound
  175. connections. Controllers sometimes use this option to avoid using
  176. the network until Tor is fully configured. (Default: 0)
  177. **ConstrainedSockets** **0**|**1**::
  178. If set, Tor will tell the kernel to attempt to shrink the buffers for all
  179. sockets to the size specified in **ConstrainedSockSize**. This is useful for
  180. virtual servers and other environments where system level TCP buffers may
  181. be limited. If you're on a virtual server, and you encounter the "Error
  182. creating network socket: No buffer space available" message, you are
  183. likely experiencing this problem. +
  184. +
  185. The preferred solution is to have the admin increase the buffer pool for
  186. the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
  187. this configuration option is a second-resort. +
  188. +
  189. The DirPort option should also not be used if TCP buffers are scarce. The
  190. cached directory requests consume additional sockets which exacerbates
  191. the problem. +
  192. +
  193. You should **not** enable this feature unless you encounter the "no buffer
  194. space available" issue. Reducing the TCP buffers affects window size for
  195. the TCP stream and will reduce throughput in proportion to round trip
  196. time on long paths. (Default: 0)
  197. **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
  198. When **ConstrainedSockets** is enabled the receive and transmit buffers for
  199. all sockets will be set to this limit. Must be a value between 2048 and
  200. 262144, in 1024 byte increments. Default of 8192 is recommended.
  201. **ControlPort** __PORT__|**auto**::
  202. If set, Tor will accept connections on this port and allow those
  203. connections to control the Tor process using the Tor Control Protocol
  204. (described in control-spec.txt). Note: unless you also specify one or
  205. more of **HashedControlPassword** or **CookieAuthentication**,
  206. setting this option will cause Tor to allow any process on the local
  207. host to control it. (Setting both authentication methods means either
  208. method is sufficient to authenticate to Tor.) This
  209. option is required for many Tor controllers; most use the value of 9051.
  210. Set it to "auto" to have Tor pick a port for you. (Default: 0)
  211. **ControlListenAddress** __IP__[:__PORT__]::
  212. Bind the controller listener to this address. If you specify a port, bind
  213. to this port rather than the one specified in ControlPort. We strongly
  214. recommend that you leave this alone unless you know what you're doing,
  215. since giving attackers access to your control listener is really
  216. dangerous. This directive can be specified multiple
  217. times to bind to multiple addresses/ports. (Default: 127.0.0.1)
  218. **ControlSocket** __Path__::
  219. Like ControlPort, but listens on a Unix domain socket, rather than a TCP
  220. socket. (Unix and Unix-like systems only.)
  221. **ControlSocketsGroupWritable** **0**|**1**::
  222. If this option is set to 0, don't allow the filesystem group to read and
  223. write unix sockets (e.g. ControlSocket). If the option is set to 1, make
  224. the control socket readable and writable by the default GID. (Default: 0)
  225. **HashedControlPassword** __hashed_password__::
  226. Allow connections on the control port if they present
  227. the password whose one-way hash is __hashed_password__. You
  228. can compute the hash of a password by running "tor --hash-password
  229. __password__". You can provide several acceptable passwords by using more
  230. than one HashedControlPassword line.
  231. **CookieAuthentication** **0**|**1**::
  232. If this option is set to 1, allow connections on the control port
  233. when the connecting process knows the contents of a file named
  234. "control_auth_cookie", which Tor will create in its data directory. This
  235. authentication method should only be used on systems with good filesystem
  236. security. (Default: 0)
  237. **CookieAuthFile** __Path__::
  238. If set, this option overrides the default location and file name
  239. for Tor's cookie file. (See CookieAuthentication above.)
  240. **CookieAuthFileGroupReadable** **0**|**1**|__Groupname__::
  241. If this option is set to 0, don't allow the filesystem group to read the
  242. cookie file. If the option is set to 1, make the cookie file readable by
  243. the default GID. [Making the file readable by other groups is not yet
  244. implemented; let us know if you need this for some reason.] (Default: 0)
  245. **ControlPortWriteToFile** __Path__::
  246. If set, Tor writes the address and port of any control port it opens to
  247. this address. Usable by controllers to learn the actual control port
  248. when ControlPort is set to "auto".
  249. **ControlPortFileGroupReadable** **0**|**1**::
  250. If this option is set to 0, don't allow the filesystem group to read the
  251. control port file. If the option is set to 1, make the control port
  252. file readable by the default GID. (Default: 0)
  253. **DataDirectory** __DIR__::
  254. Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
  255. **FallbackDir** __address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__]::
  256. When we're unable to connect to any directory cache for directory info
  257. (usually because we don't know about any yet) we try a FallbackDir.
  258. By default, the directory authorities are also FallbackDirs.
  259. **DirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
  260. Use a nonstandard authoritative directory server at the provided address
  261. and port, with the specified key fingerprint. This option can be repeated
  262. many times, for multiple authoritative directory servers. Flags are
  263. separated by spaces, and determine what kind of an authority this directory
  264. is. By default, every authority is authoritative for current ("v2")-style
  265. directories, unless the "no-v2" flag is given. If the "v1" flags is
  266. provided, Tor will use this server as an authority for old-style (v1)
  267. directories as well. (Only directory mirrors care about this.) Tor will
  268. use this server as an authority for hidden service information if the "hs"
  269. flag is set, or if the "v1" flag is set and the "no-hs" flag is **not** set.
  270. Tor will use this authority as a bridge authoritative directory if the
  271. "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
  272. given port when opening encrypted tunnels to the dirserver. If a flag
  273. "weight=**num**" is given, then the directory server is chosen randomly
  274. with probability proportional to that weight (default 1.0). Lastly, if a
  275. flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
  276. whose v3 long-term signing key has the fingerprint **fp**. +
  277. +
  278. If no **DirAuthority** line is given, Tor will use the default directory
  279. authorities. NOTE: this option is intended for setting up a private Tor
  280. network with its own directory authorities. If you use it, you will be
  281. distinguishable from other users, because you won't believe the same
  282. authorities they do.
  283. **DirAuthorityFallbackRate** __NUM__::
  284. When configured to use both directory authorities and fallback
  285. directories, the directory authorities also work as fallbacks. They are
  286. chosen with their regular weights, multiplied by this number, which
  287. should be 1.0 or less. (Default: 1.0)
  288. **DynamicDHGroups** **0**|**1**::
  289. If this option is set to 1, when running as a server, generate our
  290. own Diffie-Hellman group instead of using the one from Apache's mod_ssl.
  291. This option may help circumvent censorship based on static
  292. Diffie-Hellman parameters. (Default: 0)
  293. **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
  294. **AlternateHSAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
  295. **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
  296. These options behave as DirAuthority, but they replace fewer of the
  297. default directory authorities. Using
  298. AlternateDirAuthority replaces the default Tor directory authorities, but
  299. leaves the default hidden service authorities and bridge authorities in
  300. place. Similarly, AlternateHSAuthority replaces the default hidden
  301. service authorities, but not the directory or bridge authorities; and
  302. AlternateBridgeAuthority replaces the default bridge authority,
  303. but leaves the directory and hidden service authorities alone.
  304. **DisableAllSwap** **0**|**1**::
  305. If set to 1, Tor will attempt to lock all current and future memory pages,
  306. so that memory cannot be paged out. Windows, OS X and Solaris are currently
  307. not supported. We believe that this feature works on modern Gnu/Linux
  308. distributions, and that it should work on *BSD systems (untested). This
  309. option requires that you start your Tor as root, and you should use the
  310. **User** option to properly reduce Tor's privileges. (Default: 0)
  311. **DisableDebuggerAttachment** **0**|**1**::
  312. If set to 1, Tor will attempt to prevent basic debugging attachment attempts
  313. by other processes. It has no impact for users who wish to attach if they
  314. have CAP_SYS_PTRACE or if they are root. We believe that this feature
  315. works on modern Gnu/Linux distributions, and that it may also work on *BSD
  316. systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
  317. kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
  318. limit the PTRACE scope for all user processes by default. This feature will
  319. attempt to limit the PTRACE scope for Tor specifically - it will not attempt
  320. to alter the system wide ptrace scope as it may not even exist. If you wish
  321. to attach to Tor with a debugger such as gdb or strace you will want to set
  322. this to 0 for the duration of your debugging. Normal users should leave it
  323. on. Disabling this option while Tor is running is prohibited. (Default: 1)
  324. **FetchDirInfoEarly** **0**|**1**::
  325. If set to 1, Tor will always fetch directory information like other
  326. directory caches, even if you don't meet the normal criteria for fetching
  327. early. Normal users should leave it off. (Default: 0)
  328. **FetchDirInfoExtraEarly** **0**|**1**::
  329. If set to 1, Tor will fetch directory information before other directory
  330. caches. It will attempt to download directory information closer to the
  331. start of the consensus period. Normal users should leave it off.
  332. (Default: 0)
  333. **FetchHidServDescriptors** **0**|**1**::
  334. If set to 0, Tor will never fetch any hidden service descriptors from the
  335. rendezvous directories. This option is only useful if you're using a Tor
  336. controller that handles hidden service fetches for you. (Default: 1)
  337. **FetchServerDescriptors** **0**|**1**::
  338. If set to 0, Tor will never fetch any network status summaries or server
  339. descriptors from the directory servers. This option is only useful if
  340. you're using a Tor controller that handles directory fetches for you.
  341. (Default: 1)
  342. **FetchUselessDescriptors** **0**|**1**::
  343. If set to 1, Tor will fetch every non-obsolete descriptor from the
  344. authorities that it hears about. Otherwise, it will avoid fetching useless
  345. descriptors, for example for routers that are not running. This option is
  346. useful if you're using the contributed "exitlist" script to enumerate Tor
  347. nodes that exit to certain addresses. (Default: 0)
  348. **HTTPProxy** __host__[:__port__]::
  349. Tor will make all its directory requests through this host:port (or host:80
  350. if port is not specified), rather than connecting directly to any directory
  351. servers.
  352. **HTTPProxyAuthenticator** __username:password__::
  353. If defined, Tor will use this username:password for Basic HTTP proxy
  354. authentication, as in RFC 2617. This is currently the only form of HTTP
  355. proxy authentication that Tor supports; feel free to submit a patch if you
  356. want it to support others.
  357. **HTTPSProxy** __host__[:__port__]::
  358. Tor will make all its OR (SSL) connections through this host:port (or
  359. host:443 if port is not specified), via HTTP CONNECT rather than connecting
  360. directly to servers. You may want to set **FascistFirewall** to restrict
  361. the set of ports you might try to connect to, if your HTTPS proxy only
  362. allows connecting to certain ports.
  363. **HTTPSProxyAuthenticator** __username:password__::
  364. If defined, Tor will use this username:password for Basic HTTPS proxy
  365. authentication, as in RFC 2617. This is currently the only form of HTTPS
  366. proxy authentication that Tor supports; feel free to submit a patch if you
  367. want it to support others.
  368. **Sandbox** **0**|**1**::
  369. If set to 1, Tor will run securely through the use of a syscall sandbox.
  370. Otherwise the sandbox will be disabled. The option is currently an
  371. experimental feature. (Default: 0)
  372. **Socks4Proxy** __host__[:__port__]::
  373. Tor will make all OR connections through the SOCKS 4 proxy at host:port
  374. (or host:1080 if port is not specified).
  375. **Socks5Proxy** __host__[:__port__]::
  376. Tor will make all OR connections through the SOCKS 5 proxy at host:port
  377. (or host:1080 if port is not specified).
  378. **Socks5ProxyUsername** __username__ +
  379. **Socks5ProxyPassword** __password__::
  380. If defined, authenticate to the SOCKS 5 server using username and password
  381. in accordance to RFC 1929. Both username and password must be between 1 and
  382. 255 characters.
  383. **KeepalivePeriod** __NUM__::
  384. To keep firewalls from expiring connections, send a padding keepalive cell
  385. every NUM seconds on open connections that are in use. If the connection
  386. has no open circuits, it will instead be closed after NUM seconds of
  387. idleness. (Default: 5 minutes)
  388. **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
  389. Send all messages between __minSeverity__ and __maxSeverity__ to the standard
  390. output stream, the standard error stream, or to the system log. (The
  391. "syslog" value is only supported on Unix.) Recognized severity levels are
  392. debug, info, notice, warn, and err. We advise using "notice" in most cases,
  393. since anything more verbose may provide sensitive information to an
  394. attacker who obtains the logs. If only one severity level is given, all
  395. messages of that level or higher will be sent to the listed destination.
  396. **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
  397. As above, but send log messages to the listed filename. The
  398. "Log" option may appear more than once in a configuration file.
  399. Messages are sent to all the logs that match their severity
  400. level.
  401. **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
  402. **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
  403. As above, but select messages by range of log severity __and__ by a
  404. set of "logging domains". Each logging domain corresponds to an area of
  405. functionality inside Tor. You can specify any number of severity ranges
  406. for a single log statement, each of them prefixed by a comma-separated
  407. list of logging domains. You can prefix a domain with $$~$$ to indicate
  408. negation, and use * to indicate "all domains". If you specify a severity
  409. range without a list of domains, it matches all domains. +
  410. +
  411. This is an advanced feature which is most useful for debugging one or two
  412. of Tor's subsystems at a time. +
  413. +
  414. The currently recognized domains are: general, crypto, net, config, fs,
  415. protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
  416. acct, hist, and handshake. Domain names are case-insensitive. +
  417. +
  418. For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
  419. to stdout: all handshake messages of any severity, all info-and-higher
  420. messages from domains other than networking and memory management, and all
  421. messages of severity notice or higher.
  422. **LogMessageDomains** **0**|**1**::
  423. If 1, Tor includes message domains with each log message. Every log
  424. message currently has at least one domain; most currently have exactly
  425. one. This doesn't affect controller log messages. (Default: 0)
  426. **OutboundBindAddress** __IP__::
  427. Make all outbound connections originate from the IP address specified. This
  428. is only useful when you have multiple network interfaces, and you want all
  429. of Tor's outgoing connections to use a single one. This option may
  430. be used twice, once with an IPv4 address and once with an IPv6 address.
  431. This setting will be ignored for connections to the loopback addresses
  432. (127.0.0.0/8 and ::1).
  433. **PidFile** __FILE__::
  434. On startup, write our PID to FILE. On clean shutdown, remove
  435. FILE.
  436. **ProtocolWarnings** **0**|**1**::
  437. If 1, Tor will log with severity \'warn' various cases of other parties not
  438. following the Tor specification. Otherwise, they are logged with severity
  439. \'info'. (Default: 0)
  440. **RunAsDaemon** **0**|**1**::
  441. If 1, Tor forks and daemonizes to the background. This option has no effect
  442. on Windows; instead you should use the --service command-line option.
  443. (Default: 0)
  444. **LogTimeGranularity** __NUM__::
  445. Set the resolution of timestamps in Tor's logs to NUM milliseconds.
  446. NUM must be positive and either a divisor or a multiple of 1 second.
  447. Note that this option only controls the granularity written by Tor to
  448. a file or console log. Tor does not (for example) "batch up" log
  449. messages to affect times logged by a controller, times attached to
  450. syslog messages, or the mtime fields on log files. (Default: 1 second)
  451. **SafeLogging** **0**|**1**|**relay**::
  452. Tor can scrub potentially sensitive strings from log messages (e.g.
  453. addresses) by replacing them with the string [scrubbed]. This way logs can
  454. still be useful, but they don't leave behind personally identifying
  455. information about what sites a user might have visited. +
  456. +
  457. If this option is set to 0, Tor will not perform any scrubbing, if it is
  458. set to 1, all potentially sensitive strings are replaced. If it is set to
  459. relay, all log messages generated when acting as a relay are sanitized, but
  460. all messages generated when acting as a client are not. (Default: 1)
  461. **User** __UID__::
  462. On startup, setuid to this user and setgid to their primary group.
  463. **HardwareAccel** **0**|**1**::
  464. If non-zero, try to use built-in (static) crypto hardware acceleration when
  465. available. (Default: 0)
  466. **AccelName** __NAME__::
  467. When using OpenSSL hardware crypto acceleration attempt to load the dynamic
  468. engine of this name. This must be used for any dynamic hardware engine.
  469. Names can be verified with the openssl engine command.
  470. **AccelDir** __DIR__::
  471. Specify this option if using dynamic hardware acceleration and the engine
  472. implementation library resides somewhere other than the OpenSSL default.
  473. **AvoidDiskWrites** **0**|**1**::
  474. If non-zero, try to write to disk less frequently than we would otherwise.
  475. This is useful when running on flash memory or other media that support
  476. only a limited number of writes. (Default: 0)
  477. **TunnelDirConns** **0**|**1**::
  478. If non-zero, when a directory server we contact supports it, we will build
  479. a one-hop circuit and make an encrypted connection via its ORPort.
  480. (Default: 1)
  481. **PreferTunneledDirConns** **0**|**1**::
  482. If non-zero, we will avoid directory servers that don't support tunneled
  483. directory connections, when possible. (Default: 1)
  484. **CircuitPriorityHalflife** __NUM1__::
  485. If this value is set, we override the default algorithm for choosing which
  486. circuit's cell to deliver or relay next. When the value is 0, we
  487. round-robin between the active circuits on a connection, delivering one
  488. cell from each in turn. When the value is positive, we prefer delivering
  489. cells from whichever connection has the lowest weighted cell count, where
  490. cells are weighted exponentially according to the supplied
  491. CircuitPriorityHalflife value (in seconds). If this option is not set at
  492. all, we use the behavior recommended in the current consensus
  493. networkstatus. This is an advanced option; you generally shouldn't have
  494. to mess with it. (Default: not set)
  495. **DisableIOCP** **0**|**1**::
  496. If Tor was built to use the Libevent's "bufferevents" networking code
  497. and you're running on Windows, setting this option to 1 will tell Libevent
  498. not to use the Windows IOCP networking API. (Default: 1)
  499. **UserspaceIOCPBuffers** **0**|**1**::
  500. If IOCP is enabled (see DisableIOCP above), setting this option to 1
  501. will tell Tor to disable kernel-space TCP buffers, in order to avoid
  502. needless copy operations and try not to run out of non-paged RAM.
  503. This feature is experimental; don't use it yet unless you're eager to
  504. help tracking down bugs. (Default: 0)
  505. **_UseFilteringSSLBufferevents** **0**|**1**::
  506. Tells Tor to do its SSL communication using a chain of
  507. bufferevents: one for SSL and one for networking. This option has no
  508. effect if bufferevents are disabled (in which case it can't turn on), or
  509. if IOCP bufferevents are enabled (in which case it can't turn off). This
  510. option is useful for debugging only; most users shouldn't touch it.
  511. (Default: 0)
  512. **CountPrivateBandwidth** **0**|**1**::
  513. If this option is set, then Tor's rate-limiting applies not only to
  514. remote connections, but also to connections to private addresses like
  515. 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
  516. rate-limiting. (Default: 0)
  517. CLIENT OPTIONS
  518. --------------
  519. The following options are useful only for clients (that is, if
  520. **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
  521. **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
  522. If some Tor servers are obviously not working right, the directory
  523. authorities can manually mark them as invalid, meaning that it's not
  524. recommended you use them for entry or exit positions in your circuits. You
  525. can opt to use them in some circuit positions, though. The default is
  526. "middle,rendezvous", and other choices are not advised.
  527. **ExcludeSingleHopRelays** **0**|**1**::
  528. This option controls whether circuits built by Tor will include relays with
  529. the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
  530. to 0, these relays will be included. Note that these relays might be at
  531. higher risk of being seized or observed, so they are not normally
  532. included. Also note that relatively few clients turn off this option,
  533. so using these relays might make your client stand out.
  534. (Default: 1)
  535. **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
  536. When set along with UseBridges, instructs Tor to use the relay at
  537. "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
  538. is provided (using the same format as for DirServer), we will verify that
  539. the relay running at that location has the right fingerprint. We also use
  540. fingerprint to look up the bridge descriptor at the bridge authority, if
  541. it's provided and if UpdateBridgesFromAuthority is set too. +
  542. +
  543. If "transport" is provided, and matches to a ClientTransportPlugin
  544. line, we use that pluggable transports proxy to transfer data to
  545. the bridge.
  546. **LearnCircuitBuildTimeout** **0**|**1**::
  547. If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
  548. **CircuitBuildTimeout** __NUM__::
  549. Try for at most NUM seconds when building circuits. If the circuit isn't
  550. open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
  551. value serves as the initial value to use before a timeout is learned. If
  552. LearnCircuitBuildTimeout is 0, this value is the only value used.
  553. (Default: 60 seconds)
  554. **CircuitIdleTimeout** __NUM__::
  555. If we have kept a clean (never used) circuit around for NUM seconds, then
  556. close it. This way when the Tor client is entirely idle, it can expire all
  557. of its circuits, and then expire its TLS connections. Also, if we end up
  558. making a circuit that is not useful for exiting any of the requests we're
  559. receiving, it won't forever take up a slot in the circuit list. (Default: 1
  560. hour)
  561. **CircuitStreamTimeout** __NUM__::
  562. If non-zero, this option overrides our internal timeout schedule for how
  563. many seconds until we detach a stream from a circuit and try a new circuit.
  564. If your network is particularly slow, you might want to set this to a
  565. number like 60. (Default: 0)
  566. **ClientOnly** **0**|**1**::
  567. If set to 1, Tor will under no circumstances run as a relay or serve
  568. directory requests. This config option is mostly meaningless: we
  569. added it back when we were considering having Tor clients auto-promote
  570. themselves to being relays if they were stable and fast enough. The
  571. current behavior is simply that Tor is a client unless ORPort or
  572. DirPort are configured. (Default: 0)
  573. **ExcludeNodes** __node__,__node__,__...__::
  574. A list of identity fingerprints, nicknames, country codes and address
  575. patterns of nodes to avoid when building a circuit.
  576. (Example:
  577. ExcludeNodes SlowServer, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
  578. +
  579. By default, this option is treated as a preference that Tor is allowed
  580. to override in order to keep working.
  581. For example, if you try to connect to a hidden service,
  582. but you have excluded all of the hidden service's introduction points,
  583. Tor will connect to one of them anyway. If you do not want this
  584. behavior, set the StrictNodes option (documented below). +
  585. +
  586. Note also that if you are a relay, this (and the other node selection
  587. options below) only affects your own circuits that Tor builds for you.
  588. Clients can still build circuits through you to any node. Controllers
  589. can tell Tor to build circuits through any node. +
  590. +
  591. Country codes are case-insensitive. The code "\{??}" refers to nodes whose
  592. country can't be identified. No country code, including \{??}, works if
  593. no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
  594. **ExcludeExitNodes** __node__,__node__,__...__::
  595. A list of identity fingerprints, nicknames, country codes and address
  596. patterns of nodes to never use when picking an exit node---that is, a
  597. node that delivers traffic for you outside the Tor network. Note that any
  598. node listed in ExcludeNodes is automatically considered to be part of this
  599. list too. See also the caveats on the "ExitNodes" option below.
  600. **GeoIPExcludeUnknown** **0**|**1**|**auto**::
  601. If this option is set to 'auto', then whenever any country code is set in
  602. ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
  603. possibly \{A1}) are treated as excluded as well. If this option is set to
  604. '1', then all unknown countries are treated as excluded in ExcludeNodes
  605. and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
  606. configured or can't be found. (Default: auto)
  607. **ExitNodes** __node__,__node__,__...__::
  608. A list of identity fingerprints, nicknames, country codes and address
  609. patterns of nodes to use as exit node---that is, a
  610. node that delivers traffic for you outside the Tor network. +
  611. +
  612. Note that if you list too few nodes here, or if you exclude too many exit
  613. nodes with ExcludeExitNodes, you can degrade functionality. For example,
  614. if none of the exits you list allows traffic on port 80 or 443, you won't
  615. be able to browse the web. +
  616. +
  617. Note also that not every circuit is used to deliver traffic outside of
  618. the Tor network. It is normal to see non-exit circuits (such as those
  619. used to connect to hidden services, those that do directory fetches,
  620. those used for relay reachability self-tests, and so on) that end
  621. at a non-exit node. To
  622. keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
  623. +
  624. The ExcludeNodes option overrides this option: any node listed in both
  625. ExitNodes and ExcludeNodes is treated as excluded. +
  626. +
  627. The .exit address notation, if enabled via AllowDotExit, overrides
  628. this option.
  629. **EntryNodes** __node__,__node__,__...__::
  630. A list of identity fingerprints, nicknames, and country codes of nodes
  631. to use for the first hop in your normal circuits.
  632. Normal circuits include all
  633. circuits except for direct connections to directory servers. The Bridge
  634. option overrides this option; if you have configured bridges and
  635. UseBridges is 1, the Bridges are used as your entry nodes. +
  636. +
  637. The ExcludeNodes option overrides this option: any node listed in both
  638. EntryNodes and ExcludeNodes is treated as excluded.
  639. **StrictNodes** **0**|**1**::
  640. If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a
  641. requirement to follow for all the circuits you generate, even if doing so
  642. will break functionality for you. If StrictNodes is set to 0, Tor will
  643. still try to avoid nodes in the ExcludeNodes list, but it will err on the
  644. side of avoiding unexpected errors. Specifically, StrictNodes 0 tells
  645. Tor that it is okay to use an excluded node when it is *necessary* to
  646. perform relay reachability self-tests, connect to
  647. a hidden service, provide a hidden service to a client, fulfill a .exit
  648. request, upload directory information, or download directory information.
  649. (Default: 0)
  650. **FascistFirewall** **0**|**1**::
  651. If 1, Tor will only create outgoing connections to ORs running on ports
  652. that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
  653. This will allow you to run Tor as a client behind a firewall with
  654. restrictive policies, but will not allow you to run as a server behind such
  655. a firewall. If you prefer more fine-grained control, use
  656. ReachableAddresses instead.
  657. **FirewallPorts** __PORTS__::
  658. A list of ports that your firewall allows you to connect to. Only used when
  659. **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
  660. instead. (Default: 80, 443)
  661. **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
  662. A comma-separated list of IP addresses and ports that your firewall allows
  663. you to connect to. The format is as for the addresses in ExitPolicy, except
  664. that "accept" is understood unless "reject" is explicitly provided. For
  665. example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
  666. \*:80' means that your firewall allows connections to everything inside net
  667. 99, rejects port 80 connections to net 18, and accepts connections to port
  668. 80 otherwise. (Default: \'accept \*:*'.)
  669. **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
  670. Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
  671. these restrictions when fetching directory information, using standard HTTP
  672. GET requests. If not set explicitly then the value of
  673. **ReachableAddresses** is used. If **HTTPProxy** is set then these
  674. connections will go through that proxy.
  675. **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
  676. Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
  677. these restrictions when connecting to Onion Routers, using TLS/SSL. If not
  678. set explicitly then the value of **ReachableAddresses** is used. If
  679. **HTTPSProxy** is set then these connections will go through that proxy. +
  680. +
  681. The separation between **ReachableORAddresses** and
  682. **ReachableDirAddresses** is only interesting when you are connecting
  683. through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
  684. TLS connections (which Tor uses to connect to Onion Routers) to port 443,
  685. and some limit HTTP GET requests (which Tor uses for fetching directory
  686. information) to port 80.
  687. **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
  688. Client authorization for a hidden service. Valid onion addresses contain 16
  689. characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
  690. characters in A-Za-z0-9+/. The service name is only used for internal
  691. purposes, e.g., for Tor controllers. This option may be used multiple times
  692. for different hidden services. If a hidden service uses authorization and
  693. this option is not set, the hidden service is not accessible. Hidden
  694. services can be configured to require authorization using the
  695. **HiddenServiceAuthorizeClient** option.
  696. **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
  697. If 1, Tor will close unfinished hidden service client circuits
  698. which have not moved closer to connecting to their destination
  699. hidden service when their internal state has not changed for the
  700. duration of the current circuit-build timeout. Otherwise, such
  701. circuits will be left open, in the hope that they will finish
  702. connecting to their destination hidden services. In either case,
  703. another set of introduction and rendezvous circuits for the same
  704. destination hidden service will be launched. (Default: 0)
  705. **CloseHSServiceRendCircuitsImmediatelyOnTimeout** **0**|**1**::
  706. If 1, Tor will close unfinished hidden-service-side rendezvous
  707. circuits after the current circuit-build timeout. Otherwise, such
  708. circuits will be left open, in the hope that they will finish
  709. connecting to their destinations. In either case, another
  710. rendezvous circuit for the same destination client will be
  711. launched. (Default: 0)
  712. **LongLivedPorts** __PORTS__::
  713. A list of ports for services that tend to have long-running connections
  714. (e.g. chat and interactive shells). Circuits for streams that use these
  715. ports will contain only high-uptime nodes, to reduce the chance that a node
  716. will go down before the stream is finished. Note that the list is also
  717. honored for circuits (both client and service side) involving hidden
  718. services whose virtual port is in this list. (Default: 21, 22, 706,
  719. 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
  720. **MapAddress** __address__ __newaddress__::
  721. When a request for address arrives to Tor, it will transform to newaddress
  722. before processing it. For example, if you always want connections to
  723. www.example.com to exit via __torserver__ (where __torserver__ is the
  724. nickname of the server), use "MapAddress www.example.com
  725. www.example.com.torserver.exit". If the value is prefixed with a
  726. "\*.", matches an entire domain. For example, if you
  727. always want connections to example.com and any if its subdomains
  728. to exit via
  729. __torserver__ (where __torserver__ is the nickname of the server), use
  730. "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
  731. leading "*." in each part of the directive.) You can also redirect all
  732. subdomains of a domain to a single address. For example, "MapAddress
  733. *.example.com www.example.com". +
  734. +
  735. NOTES:
  736. 1. When evaluating MapAddress expressions Tor stops when it hits the most
  737. recently added expression that matches the requested address. So if you
  738. have the following in your torrc, www.torproject.org will map to 1.1.1.1:
  739. MapAddress www.torproject.org 2.2.2.2
  740. MapAddress www.torproject.org 1.1.1.1
  741. 2. Tor evaluates the MapAddress configuration until it finds no matches. So
  742. if you have the following in your torrc, www.torproject.org will map to
  743. 2.2.2.2:
  744. MapAddress 1.1.1.1 2.2.2.2
  745. MapAddress www.torproject.org 1.1.1.1
  746. 3. The following MapAddress expression is invalid (and will be
  747. ignored) because you cannot map from a specific address to a wildcard
  748. address:
  749. MapAddress www.torproject.org *.torproject.org.torserver.exit
  750. 4. Using a wildcard to match only part of a string (as in *ample.com) is
  751. also invalid.
  752. **NewCircuitPeriod** __NUM__::
  753. Every NUM seconds consider whether to build a new circuit. (Default: 30
  754. seconds)
  755. **MaxCircuitDirtiness** __NUM__::
  756. Feel free to reuse a circuit that was first used at most NUM seconds ago,
  757. but never attach a new stream to a circuit that is too old. For hidden
  758. services, this applies to the __last__ time a circuit was used, not the
  759. first. (Default: 10 minutes)
  760. **MaxClientCircuitsPending** __NUM__::
  761. Do not allow more than NUM circuits to be pending at a time for handling
  762. client streams. A circuit is pending if we have begun constructing it,
  763. but it has not yet been completely constructed. (Default: 32)
  764. **NodeFamily** __node__,__node__,__...__::
  765. The Tor servers, defined by their identity fingerprints or nicknames,
  766. constitute a "family" of similar or co-administered servers, so never use
  767. any two of them in the same circuit. Defining a NodeFamily is only needed
  768. when a server doesn't list the family itself (with MyFamily). This option
  769. can be used multiple times. In addition to nodes, you can also list
  770. IP address and ranges and country codes in {curly braces}.
  771. **EnforceDistinctSubnets** **0**|**1**::
  772. If 1, Tor will not put two servers whose IP addresses are "too close" on
  773. the same circuit. Currently, two addresses are "too close" if they lie in
  774. the same /16 range. (Default: 1)
  775. **SOCKSPort** \['address':]__port__|**auto** [_flags_] [_isolation flags_]::
  776. Open this port to listen for connections from SOCKS-speaking
  777. applications. Set this to 0 if you don't want to allow application
  778. connections via SOCKS. Set it to "auto" to have Tor pick a port for
  779. you. This directive can be specified multiple times to bind
  780. to multiple addresses/ports. (Default: 9050) +
  781. +
  782. The _isolation flags_ arguments give Tor rules for which streams
  783. received on this SOCKSPort are allowed to share circuits with one
  784. another. Recognized isolation flags are:
  785. **IsolateClientAddr**;;
  786. Don't share circuits with streams from a different
  787. client address. (On by default and strongly recommended;
  788. you can disable it with **NoIsolateClientAddr**.)
  789. **IsolateSOCKSAuth**;;
  790. Don't share circuits with streams for which different
  791. SOCKS authentication was provided. (On by default;
  792. you can disable it with **NoIsolateSOCKSAuth**.)
  793. **IsolateClientProtocol**;;
  794. Don't share circuits with streams using a different protocol.
  795. (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
  796. and DNSPort requests are all considered to be different protocols.)
  797. **IsolateDestPort**;;
  798. Don't share circuits with streams targetting a different
  799. destination port.
  800. **IsolateDestAddr**;;
  801. Don't share circuits with streams targetting a different
  802. destination address.
  803. **SessionGroup=**__INT__;;
  804. If no other isolation rules would prevent it, allow streams
  805. on this port to share circuits with streams from every other
  806. port with the same session group. (By default, streams received
  807. on different SOCKSPorts, TransPorts, etc are always isolated from one
  808. another. This option overrides that behavior.) +
  809. +
  810. Other recognized _flags_ for a SOCKSPort are:
  811. **NoIPv4Traffic**;;
  812. Tell exits to not connect to IPv4 addresses in response to SOCKS
  813. requests on this connection.
  814. **IPv6Traffic**;;
  815. Tell exits to allow IPv6 addresses in response to SOCKS requests on
  816. this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
  817. IPv6.)
  818. **PreferIPv6**;;
  819. Tells exits that, if a host has both an IPv4 and an IPv6 address,
  820. we would prefer to connect to it via IPv6. (IPv4 is the default.) +
  821. +
  822. NOTE: Although this option allows you to specify an IP address
  823. other than localhost, you should do so only with extreme caution.
  824. The SOCKS protocol is unencrypted and (as we use it)
  825. unauthenticated, so exposing it in this way could leak your
  826. information to anybody watching your network, and allow anybody
  827. to use your computer as an open proxy.
  828. **CacheIPv4DNS**;;
  829. Tells the client to remember IPv4 DNS answers we receive from exit
  830. nodes via this connection. (On by default.)
  831. **CacheIPv6DNS**;;
  832. Tells the client to remember IPv6 DNS answers we receive from exit
  833. nodes via this connection.
  834. **CacheDNS**;;
  835. Tells the client to remember all DNS answers we receive from exit
  836. nodes via this connection.
  837. **UseIPv4Cache**;;
  838. Tells the client to use any cached IPv4 DNS answers we have when making
  839. requests via this connection. (NOTE: This option, along UseIPv6Cache
  840. and UseDNSCache, can harm your anonymity, and probably
  841. won't help performance as much as you might expect. Use with care!)
  842. **UseIPv6Cache**;;
  843. Tells the client to use any cached IPv6 DNS answers we have when making
  844. requests via this connection.
  845. **UseDNSCache**;;
  846. Tells the client to use any cached DNS answers we have when making
  847. requests via this connection.
  848. **PreferIPv6Automap**;;
  849. When serving a hostname lookup request on this port that
  850. should get automapped (according to AutomapHostsOnResove),
  851. if we could return either an IPv4 or an IPv6 answer, prefer
  852. an IPv6 answer. (On by default.)
  853. **PreferSOCKSNoAuth**;;
  854. Ordinarily, when an application offers both "username/password
  855. authentication" and "no authentication" to Tor via SOCKS5, Tor
  856. selects username/password authentication so that IsolateSOCKSAuth can
  857. work. This can confuse some applications, if they offer a
  858. username/password combination then get confused when asked for
  859. one. You can disable this behavior, so that Tor will select "No
  860. authentication" when IsolateSOCKSAuth is disabled, or when this
  861. option is set.
  862. **SOCKSListenAddress** __IP__[:__PORT__]::
  863. Bind to this address to listen for connections from Socks-speaking
  864. applications. (Default: 127.0.0.1) You can also specify a port (e.g.
  865. 192.168.0.1:9100). This directive can be specified multiple times to bind
  866. to multiple addresses/ports. (DEPRECATED: As of 0.2.3.x-alpha, you can
  867. now use multiple SOCKSPort entries, and provide addresses for SOCKSPort
  868. entries, so SOCKSListenAddress no longer has a purpose. For backward
  869. compatibility, SOCKSListenAddress is only allowed when SOCKSPort is just
  870. a port number.)
  871. **SocksPolicy** __policy__,__policy__,__...__::
  872. Set an entrance policy for this server, to limit who can connect to the
  873. SocksPort and DNSPort ports. The policies have the same form as exit
  874. policies below.
  875. **SocksTimeout** __NUM__::
  876. Let a socks connection wait NUM seconds handshaking, and NUM seconds
  877. unattached waiting for an appropriate circuit, before we fail it. (Default:
  878. 2 minutes)
  879. **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
  880. Set the refill interval of Tor's token bucket to NUM milliseconds.
  881. NUM must be between 1 and 1000, inclusive. Note that the configured
  882. bandwidth limits are still expressed in bytes per second: this
  883. option only affects the frequency with which Tor checks to see whether
  884. previously exhausted connections may read again. (Default: 100 msec)
  885. **TrackHostExits** __host__,__.domain__,__...__::
  886. For each value in the comma separated list, Tor will track recent
  887. connections to hosts that match this value and attempt to reuse the same
  888. exit node for each. If the value is prepended with a \'.\', it is treated as
  889. matching an entire domain. If one of the values is just a \'.', it means
  890. match everything. This option is useful if you frequently connect to sites
  891. that will expire all your authentication cookies (i.e. log you out) if
  892. your IP address changes. Note that this option does have the disadvantage
  893. of making it more clear that a given history is associated with a single
  894. user. However, most people who would wish to observe this will observe it
  895. through cookies or other protocol-specific means anyhow.
  896. **TrackHostExitsExpire** __NUM__::
  897. Since exit servers go up and down, it is desirable to expire the
  898. association between host and exit server after NUM seconds. The default is
  899. 1800 seconds (30 minutes).
  900. **UpdateBridgesFromAuthority** **0**|**1**::
  901. When set (along with UseBridges), Tor will try to fetch bridge descriptors
  902. from the configured bridge authorities when feasible. It will fall back to
  903. a direct request if the authority responds with a 404. (Default: 0)
  904. **UseBridges** **0**|**1**::
  905. When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
  906. config lines, and use these relays as both entry guards and directory
  907. guards. (Default: 0)
  908. **UseEntryGuards** **0**|**1**::
  909. If this option is set to 1, we pick a few long-term entry servers, and try
  910. to stick with them. This is desirable because constantly changing servers
  911. increases the odds that an adversary who owns some servers will observe a
  912. fraction of your paths. (Default: 1)
  913. **UseEntryGuardsAsDirectoryGuards** **0**|**1**::
  914. If this option is set to 1, and UseEntryGuards is also set to 1,
  915. we try to use our entry guards as directory
  916. guards, and failing that, pick more nodes to act as our directory guards.
  917. This helps prevent an adversary from enumerating clients. It's only
  918. available for clients (non-relay, non-bridge) that aren't configured to
  919. download any non-default directory material. It doesn't currently
  920. do anything when we lack a live consensus. (Default: 1)
  921. **NumEntryGuards** __NUM__::
  922. If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
  923. as long-term entries for our circuits. (Default: 3)
  924. **NumDirectoryGuards** __NUM__::
  925. If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we
  926. have at least NUM routers to use as directory guards. If this option
  927. is set to 0, use the value from NumEntryGuards. (Default: 0)
  928. **GuardLifetime** __N__ **days**|**weeks**|**months**::
  929. If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
  930. picking a new one. If zero, we use the GuardLifetime parameter from the
  931. consensus directory. No value here may be less than 1 month or greater
  932. than 5 years; out-of-range values are clamped. (Default: 0)
  933. **SafeSocks** **0**|**1**::
  934. When this option is enabled, Tor will reject application connections that
  935. use unsafe variants of the socks protocol -- ones that only provide an IP
  936. address, meaning the application is doing a DNS resolve first.
  937. Specifically, these are socks4 and socks5 when not doing remote DNS.
  938. (Default: 0)
  939. **TestSocks** **0**|**1**::
  940. When this option is enabled, Tor will make a notice-level log entry for
  941. each connection to the Socks port indicating whether the request used a
  942. safe socks protocol or an unsafe one (see above entry on SafeSocks). This
  943. helps to determine whether an application using Tor is possibly leaking
  944. DNS requests. (Default: 0)
  945. **WarnUnsafeSocks** **0**|**1**::
  946. When this option is enabled, Tor will warn whenever a request is
  947. received that only contains an IP address instead of a hostname. Allowing
  948. applications to do DNS resolves themselves is usually a bad idea and
  949. can leak your location to attackers. (Default: 1)
  950. **VirtualAddrNetworkIPv4** __Address__/__bits__ +
  951. **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
  952. When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
  953. command from the controller or the AutomapHostsOnResolve feature, Tor
  954. picks an unassigned address from this range. (Defaults:
  955. 127.192.0.0/10 and [FE80::]/10 respectively.) +
  956. +
  957. When providing proxy server service to a network of computers using a tool
  958. like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
  959. "172.16.0.0/12" and change the IPv6 network to "[FC00]/7".
  960. The default **VirtualAddrNetwork** address ranges on a
  961. properly configured machine will route to the loopback or link-local
  962. interface. For
  963. local use, no change to the default VirtualAddrNetwork setting is needed.
  964. **AllowNonRFC953Hostnames** **0**|**1**::
  965. When this option is disabled, Tor blocks hostnames containing illegal
  966. characters (like @ and :) rather than sending them to an exit node to be
  967. resolved. This helps trap accidental attempts to resolve URLs and so on.
  968. (Default: 0)
  969. **AllowDotExit** **0**|**1**::
  970. If enabled, we convert "www.google.com.foo.exit" addresses on the
  971. SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
  972. the node "foo". Disabled by default since attacking websites and exit
  973. relays can use it to manipulate your path selection. (Default: 0)
  974. **FastFirstHopPK** **0**|**1**::
  975. When this option is disabled, Tor uses the public key step for the first
  976. hop of creating circuits. Skipping it is generally safe since we have
  977. already used TLS to authenticate the relay and to establish forward-secure
  978. keys. Turning this option off makes circuit building slower. +
  979. +
  980. Note that Tor will always use the public key step for the first hop if it's
  981. operating as a relay, and it will never use the public key step if it
  982. doesn't yet know the onion key of the first hop. (Default: 1)
  983. **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
  984. Open this port to listen for transparent proxy connections. Set this to
  985. 0 if you don't want to allow transparent proxy connections. Set the port
  986. to "auto" to have Tor pick a port for you. This directive can be
  987. specified multiple times to bind to multiple addresses/ports. See
  988. SOCKSPort for an explanation of isolation flags. +
  989. +
  990. TransPort requires OS support for transparent proxies, such as BSDs' pf or
  991. Linux's IPTables. If you're planning to use Tor as a transparent proxy for
  992. a network, you'll want to examine and change VirtualAddrNetwork from the
  993. default setting. You'll also want to set the TransListenAddress option for
  994. the network you'd like to proxy. (Default: 0)
  995. **TransListenAddress** __IP__[:__PORT__]::
  996. Bind to this address to listen for transparent proxy connections. (Default:
  997. 127.0.0.1). This is useful for exporting a transparent proxy server to an
  998. entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
  999. now use multiple TransPort entries, and provide addresses for TransPort
  1000. entries, so TransListenAddress no longer has a purpose. For backward
  1001. compatibility, TransListenAddress is only allowed when TransPort is just
  1002. a port number.)
  1003. **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
  1004. Open this port to listen for connections from old versions of ipfw (as
  1005. included in old versions of FreeBSD, etc) using the NATD protocol.
  1006. Use 0 if you don't want to allow NATD connections. Set the port
  1007. to "auto" to have Tor pick a port for you. This directive can be
  1008. specified multiple times to bind to multiple addresses/ports. See
  1009. SOCKSPort for an explanation of isolation flags. +
  1010. +
  1011. This option is only for people who cannot use TransPort. (Default: 0)
  1012. **NATDListenAddress** __IP__[:__PORT__]::
  1013. Bind to this address to listen for NATD connections. (DEPRECATED: As of
  1014. 0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
  1015. addresses for NATDPort entries, so NATDListenAddress no longer has a
  1016. purpose. For backward compatibility, NATDListenAddress is only allowed
  1017. when NATDPort is just a port number.)
  1018. **AutomapHostsOnResolve** **0**|**1**::
  1019. When this option is enabled, and we get a request to resolve an address
  1020. that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
  1021. unused virtual address to that address, and return the new virtual address.
  1022. This is handy for making ".onion" addresses work with applications that
  1023. resolve an address and then connect to it. (Default: 0)
  1024. **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
  1025. A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
  1026. The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
  1027. **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
  1028. If non-zero, open this port to listen for UDP DNS requests, and resolve
  1029. them anonymously. This port only handles A, AAAA, and PTR requests---it
  1030. doesn't handle arbitrary DNS request types. Set the port to "auto" to
  1031. have Tor pick a port for
  1032. you. This directive can be specified multiple times to bind to multiple
  1033. addresses/ports. See SOCKSPort for an explanation of isolation
  1034. flags. (Default: 0)
  1035. **DNSListenAddress** __IP__[:__PORT__]::
  1036. Bind to this address to listen for DNS connections. (DEPRECATED: As of
  1037. 0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
  1038. addresses for DNSPort entries, so DNSListenAddress no longer has a
  1039. purpose. For backward compatibility, DNSListenAddress is only allowed
  1040. when DNSPort is just a port number.)
  1041. **ClientDNSRejectInternalAddresses** **0**|**1**::
  1042. If true, Tor does not believe any anonymously retrieved DNS answer that
  1043. tells it that an address resolves to an internal address (like 127.0.0.1 or
  1044. 192.168.0.1). This option prevents certain browser-based attacks; don't
  1045. turn it off unless you know what you're doing. (Default: 1)
  1046. **ClientRejectInternalAddresses** **0**|**1**::
  1047. If true, Tor does not try to fulfill requests to connect to an internal
  1048. address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
  1049. specifically requested__ (for example, via a .exit hostname, or a
  1050. controller request). (Default: 1)
  1051. **DownloadExtraInfo** **0**|**1**::
  1052. If true, Tor downloads and caches "extra-info" documents. These documents
  1053. contain information about servers other than the information in their
  1054. regular router descriptors. Tor does not use this information for anything
  1055. itself; to save bandwidth, leave this option turned off. (Default: 0)
  1056. **WarnPlaintextPorts** __port__,__port__,__...__::
  1057. Tells Tor to issue a warnings whenever the user tries to make an anonymous
  1058. connection to one of these ports. This option is designed to alert users
  1059. to services that risk sending passwords in the clear. (Default:
  1060. 23,109,110,143)
  1061. **RejectPlaintextPorts** __port__,__port__,__...__::
  1062. Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
  1063. will instead refuse to make the connection. (Default: None)
  1064. **AllowSingleHopCircuits** **0**|**1**::
  1065. When this option is set, the attached Tor controller can use relays
  1066. that have the **AllowSingleHopExits** option turned on to build
  1067. one-hop Tor connections. (Default: 0)
  1068. **OptimisticData** **0**|**1**|**auto**::
  1069. When this option is set, and Tor is using an exit node that supports
  1070. the feature, it will try optimistically to send data to the exit node
  1071. without waiting for the exit node to report whether the connection
  1072. succeeded. This can save a round-trip time for protocols like HTTP
  1073. where the client talks first. If OptimisticData is set to **auto**,
  1074. Tor will look at the UseOptimisticData parameter in the networkstatus.
  1075. (Default: auto)
  1076. **Tor2webMode** **0**|**1**::
  1077. When this option is set, Tor connects to hidden services
  1078. **non-anonymously**. This option also disables client connections to
  1079. non-hidden-service hostnames through Tor. It **must only** be used when
  1080. running a tor2web Hidden Service web proxy.
  1081. To enable this option the compile time flag --enable-tor2webmode must be
  1082. specified. (Default: 0)
  1083. **UseMicrodescriptors** **0**|**1**|**auto**::
  1084. Microdescriptors are a smaller version of the information that Tor needs
  1085. in order to build its circuits. Using microdescriptors makes Tor clients
  1086. download less directory information, thus saving bandwidth. Directory
  1087. caches need to fetch regular descriptors and microdescriptors, so this
  1088. option doesn't save any bandwidth for them. If this option is set to
  1089. "auto" (recommended) then it is on for all clients that do not set
  1090. FetchUselessDescriptors. (Default: auto)
  1091. **UseNTorHandshake** **0**|**1**|**auto**::
  1092. The "ntor" circuit-creation handshake is faster and (we think) more
  1093. secure than the original ("TAP") circuit handshake, but starting to use
  1094. it too early might make your client stand out. If this option is 0, your
  1095. Tor client won't use the ntor handshake. If it's 1, your Tor client
  1096. will use the ntor handshake to extend circuits through servers that
  1097. support it. If this option is "auto", then your client
  1098. will use the ntor handshake once enough directory authorities recommend
  1099. it. (Default: 1)
  1100. **PathBiasCircThreshold** __NUM__ +
  1101. **PathBiasNoticeRate** __NUM__ +
  1102. **PathBiasWarnRate** __NUM__ +
  1103. **PathBiasExtremeRate** __NUM__ +
  1104. **PathBiasDropGuards** __NUM__ +
  1105. **PathBiasScaleThreshold** __NUM__::
  1106. These options override the default behavior of Tor's (**currently
  1107. experimental**) path bias detection algorithm. To try to find broken or
  1108. misbehaving guard nodes, Tor looks for nodes where more than a certain
  1109. fraction of circuits through that guard fail to get built.
  1110. +
  1111. The PathBiasCircThreshold option controls how many circuits we need to build
  1112. through a guard before we make these checks. The PathBiasNoticeRate,
  1113. PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
  1114. circuits must succeed through a guard so we won't write log messages.
  1115. If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
  1116. is set to 1, we disable use of that guard. +
  1117. +
  1118. When we have seen more than PathBiasScaleThreshold
  1119. circuits through a guard, we scale our observations by 0.5 (governed by
  1120. the consensus) so that new observations don't get swamped by old ones. +
  1121. +
  1122. By default, or if a negative value is provided for one of these options,
  1123. Tor uses reasonable defaults from the networkstatus consensus document.
  1124. If no defaults are available there, these options default to 150, .70,
  1125. .50, .30, 0, and 300 respectively.
  1126. **PathBiasUseThreshold** __NUM__ +
  1127. **PathBiasNoticeUseRate** __NUM__ +
  1128. **PathBiasExtremeUseRate** __NUM__ +
  1129. **PathBiasScaleUseThreshold** __NUM__::
  1130. Similar to the above options, these options override the default behavior
  1131. of Tor's (**currently experimental**) path use bias detection algorithm.
  1132. +
  1133. Where as the path bias parameters govern thresholds for successfully
  1134. building circuits, these four path use bias parameters govern thresholds
  1135. only for circuit usage. Circuits which receive no stream usage
  1136. are not counted by this detection algorithm. A used circuit is considered
  1137. successful if it is capable of carrying streams or otherwise receiving
  1138. well-formed responses to RELAY cells.
  1139. +
  1140. By default, or if a negative value is provided for one of these options,
  1141. Tor uses reasonable defaults from the networkstatus consensus document.
  1142. If no defaults are available there, these options default to 20, .80,
  1143. .60, and 100, respectively.
  1144. **ClientUseIPv6** **0**|**1**::
  1145. If this option is set to 1, Tor might connect to entry nodes over
  1146. IPv6. Note that clients configured with an IPv6 address in a
  1147. **Bridge** line will try connecting over IPv6 even if
  1148. **ClientUseIPv6** is set to 0. (Default: 0)
  1149. **ClientPreferIPv6ORPort** **0**|**1**::
  1150. If this option is set to 1, Tor prefers an OR port with an IPv6
  1151. address over one with IPv4 if a given entry node has both. Other
  1152. things may influence the choice. This option breaks a tie to the
  1153. favor of IPv6. (Default: 0)
  1154. **PathsNeededToBuildCircuits** __NUM__::
  1155. Tor clients don't build circuits for user traffic until they know
  1156. about enough of the network so that they could potentially construct
  1157. enough of the possible paths through the network. If this option
  1158. is set to a fraction between 0.25 and 0.95, Tor won't build circuits
  1159. until it has enough descriptors or microdescriptors to construct
  1160. that fraction of possible paths. Note that setting this option too low
  1161. can make your Tor client less anonymous, and setting it too high can
  1162. prevent your Tor client from bootstrapping. If this option is negative,
  1163. Tor will use a default value chosen by the directory
  1164. authorities. (Default: -1.)
  1165. SERVER OPTIONS
  1166. --------------
  1167. The following options are useful only for servers (that is, if ORPort
  1168. is non-zero):
  1169. **Address** __address__::
  1170. The IP address or fully qualified domain name of this server (e.g.
  1171. moria.mit.edu). You can leave this unset, and Tor will guess your IP
  1172. address. This IP address is the one used to tell clients and other
  1173. servers where to find your Tor server; it doesn't affect the IP that your
  1174. Tor client binds to. To bind to a different address, use the
  1175. *ListenAddress and OutboundBindAddress options.
  1176. **AllowSingleHopExits** **0**|**1**::
  1177. This option controls whether clients can use this server as a single hop
  1178. proxy. If set to 1, clients can use this server as an exit even if it is
  1179. the only hop in the circuit. Note that most clients will refuse to use
  1180. servers that set this option, since most clients have
  1181. ExcludeSingleHopRelays set. (Default: 0)
  1182. **AssumeReachable** **0**|**1**::
  1183. This option is used when bootstrapping a new Tor network. If set to 1,
  1184. don't do self-reachability testing; just upload your server descriptor
  1185. immediately. If **AuthoritativeDirectory** is also set, this option
  1186. instructs the dirserver to bypass remote reachability testing too and list
  1187. all connected servers as running.
  1188. **BridgeRelay** **0**|**1**::
  1189. Sets the relay to act as a "bridge" with respect to relaying connections
  1190. from bridge users to the Tor network. It mainly causes Tor to publish a
  1191. server descriptor to the bridge database, rather than publishing a relay
  1192. descriptor to the public directory authorities.
  1193. **ContactInfo** __email_address__::
  1194. Administrative contact information for server. This line might get picked
  1195. up by spam harvesters, so you may want to obscure the fact that it's an
  1196. email address.
  1197. **ExitPolicy** __policy__,__policy__,__...__::
  1198. Set an exit policy for this server. Each policy is of the form
  1199. "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
  1200. omitted then this policy just applies to the host given. Instead of giving
  1201. a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
  1202. __PORT__ can be a single port number, an interval of ports
  1203. "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
  1204. "\*". +
  1205. +
  1206. For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
  1207. reject any traffic destined for MIT except for web.mit.edu, and accept
  1208. anything else. +
  1209. +
  1210. To specify all internal and link-local networks (including 0.0.0.0/8,
  1211. 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
  1212. 172.16.0.0/12), you can use the "private" alias instead of an address.
  1213. These addresses are rejected by default (at the beginning of your exit
  1214. policy), along with your public IP address, unless you set the
  1215. ExitPolicyRejectPrivate config option to 0. For example, once you've done
  1216. that, you could allow HTTP to 127.0.0.1 and block all other connections to
  1217. internal networks with "accept 127.0.0.1:80,reject private:\*", though that
  1218. may also allow connections to your own computer that are addressed to its
  1219. public (external) IP address. See RFC 1918 and RFC 3330 for more details
  1220. about internal and reserved IP address space. +
  1221. +
  1222. This directive can be specified multiple times so you don't have to put it
  1223. all on one line. +
  1224. +
  1225. Policies are considered first to last, and the first match wins. If you
  1226. want to \_replace_ the default exit policy, end your exit policy with
  1227. either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
  1228. (prepending to) the default exit policy. The default exit policy is: +
  1229. reject *:25
  1230. reject *:119
  1231. reject *:135-139
  1232. reject *:445
  1233. reject *:563
  1234. reject *:1214
  1235. reject *:4661-4666
  1236. reject *:6346-6429
  1237. reject *:6699
  1238. reject *:6881-6999
  1239. accept *:*
  1240. **ExitPolicyRejectPrivate** **0**|**1**::
  1241. Reject all private (local) networks, along with your own public IP address,
  1242. at the beginning of your exit policy. See above entry on ExitPolicy.
  1243. (Default: 1)
  1244. **IPv6Exit** **0**|**1**::
  1245. If set, and we are an exit node, allow clients to use us for IPv6
  1246. traffic. (Default: 0)
  1247. **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
  1248. If we have more onionskins queued for processing than we can process in
  1249. this amount of time, reject new ones. (Default: 1750 msec)
  1250. **MyFamily** __node__,__node__,__...__::
  1251. Declare that this Tor server is controlled or administered by a group or
  1252. organization identical or similar to that of the other servers, defined by
  1253. their identity fingerprints or nicknames. When two servers both declare
  1254. that they are in the same \'family', Tor clients will not use them in the
  1255. same circuit. (Each server only needs to list the other servers in its
  1256. family; it doesn't need to list itself, but it won't hurt.) Do not list
  1257. any bridge relay as it would compromise its concealment.
  1258. +
  1259. When listing a node, it's better to list it by fingerprint than by
  1260. nickname: fingerprints are more reliable.
  1261. **Nickname** __name__::
  1262. Set the server's nickname to \'name'. Nicknames must be between 1 and 19
  1263. characters inclusive, and must contain only the characters [a-zA-Z0-9].
  1264. **NumCPUs** __num__::
  1265. How many processes to use at once for decrypting onionskins and other
  1266. parallelizable operations. If this is set to 0, Tor will try to detect
  1267. how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
  1268. **ORPort** \['address':]__PORT__|**auto** [_flags_]::
  1269. Advertise this port to listen for connections from Tor clients and
  1270. servers. This option is required to be a Tor server.
  1271. Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
  1272. run an ORPort at all. This option can occur more than once. (Default: 0)
  1273. +
  1274. Tor recognizes these flags on each ORPort:
  1275. **NoAdvertise**::
  1276. By default, we bind to a port and tell our users about it. If
  1277. NoAdvertise is specified, we don't advertise, but listen anyway. This
  1278. can be useful if the port everybody will be connecting to (for
  1279. example, one that's opened on our firewall) is somewhere else.
  1280. **NoListen**::
  1281. By default, we bind to a port and tell our users about it. If
  1282. NoListen is specified, we don't bind, but advertise anyway. This
  1283. can be useful if something else (for example, a firewall's port
  1284. forwarding configuration) is causing connections to reach us.
  1285. **IPv4Only**::
  1286. If the address is absent, or resolves to both an IPv4 and an IPv6
  1287. address, only listen to the IPv4 address.
  1288. **IPv6Only**::
  1289. If the address is absent, or resolves to both an IPv4 and an IPv6
  1290. address, only listen to the IPv6 address.
  1291. +
  1292. For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
  1293. IPv4Only and IPv6Only are mutually exclusive.
  1294. **ORListenAddress** __IP__[:__PORT__]::
  1295. Bind to this IP address to listen for connections from Tor clients and
  1296. servers. If you specify a port, bind to this port rather than the one
  1297. specified in ORPort. (Default: 0.0.0.0) This directive can be specified
  1298. multiple times to bind to multiple addresses/ports.
  1299. +
  1300. This option is deprecated; you can get the same behavior with ORPort now
  1301. that it supports NoAdvertise and explicit addresses.
  1302. **PortForwarding** **0**|**1**::
  1303. Attempt to automatically forward the DirPort and ORPort on a NAT router
  1304. connecting this Tor server to the Internet. If set, Tor will try both
  1305. NAT-PMP (common on Apple routers) and UPnP (common on routers from other
  1306. manufacturers). (Default: 0)
  1307. **PortForwardingHelper** __filename__|__pathname__::
  1308. If PortForwarding is set, use this executable to configure the forwarding.
  1309. If set to a filename, the system path will be searched for the executable.
  1310. If set to a path, only the specified path will be executed.
  1311. (Default: tor-fw-helper)
  1312. **PublishServerDescriptor** **0**|**1**|**v1**|**v2**|**v3**|**bridge**,**...**::
  1313. This option specifies which descriptors Tor will publish when acting as
  1314. a relay. You can
  1315. choose multiple arguments, separated by commas.
  1316. +
  1317. If this option is set to 0, Tor will not publish its
  1318. descriptors to any directories. (This is useful if you're testing
  1319. out your server, or if you're using a Tor controller that handles directory
  1320. publishing for you.) Otherwise, Tor will publish its descriptors of all
  1321. type(s) specified. The default is "1",
  1322. which means "if running as a server, publish the
  1323. appropriate descriptors to the authorities".
  1324. **ShutdownWaitLength** __NUM__::
  1325. When we get a SIGINT and we're a server, we begin shutting down:
  1326. we close listeners and start refusing new circuits. After **NUM**
  1327. seconds, we exit. If we get a second SIGINT, we exit immediately.
  1328. (Default: 30 seconds)
  1329. **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
  1330. When creating a link certificate for our outermost SSL handshake,
  1331. set its lifetime to this amount of time. If set to 0, Tor will choose
  1332. some reasonable random defaults. (Default: 0)
  1333. **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
  1334. Log a heartbeat message every **HeartbeatPeriod** seconds. This is
  1335. a log level __notice__ message, designed to let you know your Tor
  1336. server is still alive and doing useful things. Settings this
  1337. to 0 will disable the heartbeat. (Default: 6 hours)
  1338. **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**|**TBytes**::
  1339. Never send more than the specified number of bytes in a given accounting
  1340. period, or receive more than that number in the period. For example, with
  1341. AccountingMax set to 1 GByte, a server could send 900 MBytes and
  1342. receive 800 MBytes and continue running. It will only hibernate once
  1343. one of the two reaches 1 GByte. When the number of bytes gets low,
  1344. Tor will stop accepting new connections and circuits. When the
  1345. number of bytes is exhausted, Tor will hibernate until some
  1346. time in the next accounting period. To prevent all servers from waking at
  1347. the same time, Tor will also wait until a random point in each period
  1348. before waking up. If you have bandwidth cost issues, enabling hibernation
  1349. is preferable to setting a low bandwidth, since it provides users with a
  1350. collection of fast servers that are up some of the time, which is more
  1351. useful than a set of slow servers that are always "available".
  1352. **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
  1353. Specify how long accounting periods last. If **month** is given, each
  1354. accounting period runs from the time __HH:MM__ on the __dayth__ day of one
  1355. month to the same day and time of the next. (The day must be between 1 and
  1356. 28.) If **week** is given, each accounting period runs from the time __HH:MM__
  1357. of the __dayth__ day of one week to the same day and time of the next week,
  1358. with Monday as day 1 and Sunday as day 7. If **day** is given, each
  1359. accounting period runs from the time __HH:MM__ each day to the same time on
  1360. the next day. All times are local, and given in 24-hour time. (Default:
  1361. "month 1 0:00")
  1362. **RefuseUnknownExits** **0**|**1**|**auto**::
  1363. Prevent nodes that don't appear in the consensus from exiting using this
  1364. relay. If the option is 1, we always block exit attempts from such
  1365. nodes; if it's 0, we never do, and if the option is "auto", then we do
  1366. whatever the authorities suggest in the consensus (and block if the consensus
  1367. is quiet on the issue). (Default: auto)
  1368. **ServerDNSResolvConfFile** __filename__::
  1369. Overrides the default DNS configuration with the configuration in
  1370. __filename__. The file format is the same as the standard Unix
  1371. "**resolv.conf**" file (7). This option, like all other ServerDNS options,
  1372. only affects name lookups that your server does on behalf of clients.
  1373. (Defaults to use the system DNS configuration.)
  1374. **ServerDNSAllowBrokenConfig** **0**|**1**::
  1375. If this option is false, Tor exits immediately if there are problems
  1376. parsing the system DNS configuration or connecting to nameservers.
  1377. Otherwise, Tor continues to periodically retry the system nameservers until
  1378. it eventually succeeds. (Default: 1)
  1379. **ServerDNSSearchDomains** **0**|**1**::
  1380. If set to 1, then we will search for addresses in the local search domain.
  1381. For example, if this system is configured to believe it is in
  1382. "example.com", and a client tries to connect to "www", the client will be
  1383. connected to "www.example.com". This option only affects name lookups that
  1384. your server does on behalf of clients. (Default: 0)
  1385. **ServerDNSDetectHijacking** **0**|**1**::
  1386. When this option is set to 1, we will test periodically to determine
  1387. whether our local nameservers have been configured to hijack failing DNS
  1388. requests (usually to an advertising site). If they are, we will attempt to
  1389. correct this. This option only affects name lookups that your server does
  1390. on behalf of clients. (Default: 1)
  1391. **ServerDNSTestAddresses** __address__,__address__,__...__::
  1392. When we're detecting DNS hijacking, make sure that these __valid__ addresses
  1393. aren't getting redirected. If they are, then our DNS is completely useless,
  1394. and we'll reset our exit policy to "reject *:*". This option only affects
  1395. name lookups that your server does on behalf of clients. (Default:
  1396. "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
  1397. **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
  1398. When this option is disabled, Tor does not try to resolve hostnames
  1399. containing illegal characters (like @ and :) rather than sending them to an
  1400. exit node to be resolved. This helps trap accidental attempts to resolve
  1401. URLs and so on. This option only affects name lookups that your server does
  1402. on behalf of clients. (Default: 0)
  1403. **BridgeRecordUsageByCountry** **0**|**1**::
  1404. When this option is enabled and BridgeRelay is also enabled, and we have
  1405. GeoIP data, Tor keeps a keep a per-country count of how many client
  1406. addresses have contacted it so that it can help the bridge authority guess
  1407. which countries have blocked access to it. (Default: 1)
  1408. **ServerDNSRandomizeCase** **0**|**1**::
  1409. When this option is set, Tor sets the case of each character randomly in
  1410. outgoing DNS requests, and makes sure that the case matches in DNS replies.
  1411. This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
  1412. For more information, see "Increased DNS Forgery Resistance through
  1413. 0x20-Bit Encoding". This option only affects name lookups that your server
  1414. does on behalf of clients. (Default: 1)
  1415. **GeoIPFile** __filename__::
  1416. A filename containing IPv4 GeoIP data, for use with by-country statistics.
  1417. **GeoIPv6File** __filename__::
  1418. A filename containing IPv6 GeoIP data, for use with by-country statistics.
  1419. **TLSECGroup** **P224**|**P256**::
  1420. What EC group should we try to use for incoming TLS connections?
  1421. P224 is faster, but makes us stand out more. Has no effect if
  1422. we're a client, or if our OpenSSL version lacks support for ECDHE.
  1423. (Default: P224 for public servers; P256 for bridges.)
  1424. **CellStatistics** **0**|**1**::
  1425. When this option is enabled, Tor writes statistics on the mean time that
  1426. cells spend in circuit queues to disk every 24 hours. (Default: 0)
  1427. **DirReqStatistics** **0**|**1**::
  1428. When this option is enabled, a Tor directory writes statistics on the
  1429. number and response time of network status requests to disk every 24
  1430. hours. (Default: 1)
  1431. **EntryStatistics** **0**|**1**::
  1432. When this option is enabled, Tor writes statistics on the number of
  1433. directly connecting clients to disk every 24 hours. (Default: 0)
  1434. **ExitPortStatistics** **0**|**1**::
  1435. When this option is enabled, Tor writes statistics on the number of relayed
  1436. bytes and opened stream per exit port to disk every 24 hours. (Default: 0)
  1437. **ConnDirectionStatistics** **0**|**1**::
  1438. When this option is enabled, Tor writes statistics on the bidirectional use
  1439. of connections to disk every 24 hours. (Default: 0)
  1440. **ExtraInfoStatistics** **0**|**1**::
  1441. When this option is enabled, Tor includes previously gathered statistics in
  1442. its extra-info documents that it uploads to the directory authorities.
  1443. (Default: 1)
  1444. **ExtendAllowPrivateAddresses** **0**|**1**::
  1445. When this option is enabled, Tor routers allow EXTEND request to
  1446. localhost, RFC1918 addresses, and so on. This can create security issues;
  1447. you should probably leave it off. (Default: 0)
  1448. **MaxMemInCellQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
  1449. This option configures a threshold above which Tor will assume that it
  1450. needs to stop queueing cells because it's about to run out of memory.
  1451. If it hits this threshold, it will begin killing circuits until it
  1452. has recovered at least 10% of this memory. Do not set this option too
  1453. low, or your relay may be unreliable under load. This option only
  1454. affects circuit queues, so the actual process size will be larger than
  1455. this. (Default: 8GB)
  1456. DIRECTORY SERVER OPTIONS
  1457. ------------------------
  1458. The following options are useful only for directory servers (that is,
  1459. if DirPort is non-zero):
  1460. **AuthoritativeDirectory** **0**|**1**::
  1461. When this option is set to 1, Tor operates as an authoritative directory
  1462. server. Instead of caching the directory, it generates its own list of
  1463. good servers, signs it, and sends that to the clients. Unless the clients
  1464. already have you listed as a trusted directory, you probably do not want
  1465. to set this option. Please coordinate with the other admins at
  1466. tor-ops@torproject.org if you think you should be a directory.
  1467. **DirPortFrontPage** __FILENAME__::
  1468. When this option is set, it takes an HTML file and publishes it as "/" on
  1469. the DirPort. Now relay operators can provide a disclaimer without needing
  1470. to set up a separate webserver. There's a sample disclaimer in
  1471. contrib/tor-exit-notice.html.
  1472. **V1AuthoritativeDirectory** **0**|**1**::
  1473. When this option is set in addition to **AuthoritativeDirectory**, Tor
  1474. generates version 1 directory and running-routers documents (for legacy
  1475. Tor clients up to 0.1.0.x).
  1476. **V2AuthoritativeDirectory** **0**|**1**::
  1477. When this option is set in addition to **AuthoritativeDirectory**, Tor
  1478. generates version 2 network statuses and serves descriptors, etc as
  1479. described in doc/spec/dir-spec-v2.txt (for Tor clients and servers running
  1480. 0.1.1.x and 0.1.2.x).
  1481. **V3AuthoritativeDirectory** **0**|**1**::
  1482. When this option is set in addition to **AuthoritativeDirectory**, Tor
  1483. generates version 3 network statuses and serves descriptors, etc as
  1484. described in doc/spec/dir-spec.txt (for Tor clients and servers running at
  1485. least 0.2.0.x).
  1486. **VersioningAuthoritativeDirectory** **0**|**1**::
  1487. When this option is set to 1, Tor adds information on which versions of
  1488. Tor are still believed safe for use to the published directory. Each
  1489. version 1 authority is automatically a versioning authority; version 2
  1490. authorities provide this service optionally. See **RecommendedVersions**,
  1491. **RecommendedClientVersions**, and **RecommendedServerVersions**.
  1492. **NamingAuthoritativeDirectory** **0**|**1**::
  1493. When this option is set to 1, then the server advertises that it has
  1494. opinions about nickname-to-fingerprint bindings. It will include these
  1495. opinions in its published network-status pages, by listing servers with
  1496. the flag "Named" if a correct binding between that nickname and fingerprint
  1497. has been registered with the dirserver. Naming dirservers will refuse to
  1498. accept or publish descriptors that contradict a registered binding. See
  1499. **approved-routers** in the **FILES** section below.
  1500. **HSAuthoritativeDir** **0**|**1**::
  1501. When this option is set in addition to **AuthoritativeDirectory**, Tor also
  1502. accepts and serves v0 hidden service descriptors,
  1503. which are produced and used by Tor 0.2.1.x and older. (Default: 0)
  1504. **HidServDirectoryV2** **0**|**1**::
  1505. When this option is set, Tor accepts and serves v2 hidden service
  1506. descriptors. Setting DirPort is not required for this, because clients
  1507. connect via the ORPort by default. (Default: 1)
  1508. **BridgeAuthoritativeDir** **0**|**1**::
  1509. When this option is set in addition to **AuthoritativeDirectory**, Tor
  1510. accepts and serves router descriptors, but it caches and serves the main
  1511. networkstatus documents rather than generating its own. (Default: 0)
  1512. **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  1513. Minimum uptime of a v2 hidden service directory to be accepted as such by
  1514. authoritative directories. (Default: 25 hours)
  1515. **DirPort** \['address':]__PORT__|**auto** [_flags_]::
  1516. If this option is nonzero, advertise the directory service on this port.
  1517. Set it to "auto" to have Tor pick a port for you. This option can occur
  1518. more than once. (Default: 0)
  1519. +
  1520. The same flags are supported here as are supported by ORPort.
  1521. **DirListenAddress** __IP__[:__PORT__]::
  1522. Bind the directory service to this address. If you specify a port, bind to
  1523. this port rather than the one specified in DirPort. (Default: 0.0.0.0)
  1524. This directive can be specified multiple times to bind to multiple
  1525. addresses/ports.
  1526. +
  1527. This option is deprecated; you can get the same behavior with DirPort now
  1528. that it supports NoAdvertise and explicit addresses.
  1529. **DirPolicy** __policy__,__policy__,__...__::
  1530. Set an entrance policy for this server, to limit who can connect to the
  1531. directory ports. The policies have the same form as exit policies above.
  1532. **FetchV2Networkstatus** **0**|**1**::
  1533. If set, we try to fetch the (obsolete, unused) version 2 network status
  1534. consensus documents from the directory authorities. No currently
  1535. supported Tor version uses them. (Default: 0)
  1536. DIRECTORY AUTHORITY SERVER OPTIONS
  1537. ----------------------------------
  1538. **RecommendedVersions** __STRING__::
  1539. STRING is a comma-separated list of Tor versions currently believed to be
  1540. safe. The list is included in each directory, and nodes which pull down the
  1541. directory learn whether they need to upgrade. This option can appear
  1542. multiple times: the values from multiple lines are spliced together. When
  1543. this is set then **VersioningAuthoritativeDirectory** should be set too.
  1544. **RecommendedClientVersions** __STRING__::
  1545. STRING is a comma-separated list of Tor versions currently believed to be
  1546. safe for clients to use. This information is included in version 2
  1547. directories. If this is not set then the value of **RecommendedVersions**
  1548. is used. When this is set then **VersioningAuthoritativeDirectory** should
  1549. be set too.
  1550. **RecommendedServerVersions** __STRING__::
  1551. STRING is a comma-separated list of Tor versions currently believed to be
  1552. safe for servers to use. This information is included in version 2
  1553. directories. If this is not set then the value of **RecommendedVersions**
  1554. is used. When this is set then **VersioningAuthoritativeDirectory** should
  1555. be set too.
  1556. **ConsensusParams** __STRING__::
  1557. STRING is a space-separated list of key=value pairs that Tor will include
  1558. in the "params" line of its networkstatus vote.
  1559. **DirAllowPrivateAddresses** **0**|**1**::
  1560. If set to 1, Tor will accept router descriptors with arbitrary "Address"
  1561. elements. Otherwise, if the address is not an IP address or is a private IP
  1562. address, it will reject the router descriptor. (Default: 0)
  1563. **AuthDirBadDir** __AddressPattern...__::
  1564. Authoritative directories only. A set of address patterns for servers that
  1565. will be listed as bad directories in any network status document this
  1566. authority publishes, if **AuthDirListBadDirs** is set.
  1567. **AuthDirBadExit** __AddressPattern...__::
  1568. Authoritative directories only. A set of address patterns for servers that
  1569. will be listed as bad exits in any network status document this authority
  1570. publishes, if **AuthDirListBadExits** is set.
  1571. **AuthDirInvalid** __AddressPattern...__::
  1572. Authoritative directories only. A set of address patterns for servers that
  1573. will never be listed as "valid" in any network status document that this
  1574. authority publishes.
  1575. **AuthDirReject** __AddressPattern__...::
  1576. Authoritative directories only. A set of address patterns for servers that
  1577. will never be listed at all in any network status document that this
  1578. authority publishes, or accepted as an OR address in any descriptor
  1579. submitted for publication by this authority.
  1580. **AuthDirBadDirCCs** __CC__,... +
  1581. **AuthDirBadExitCCs** __CC__,... +
  1582. **AuthDirInvalidCCs** __CC__,... +
  1583. **AuthDirRejectCCs** __CC__,...::
  1584. Authoritative directories only. These options contain a comma-separated
  1585. list of country codes such that any server in one of those country codes
  1586. will be marked as a bad directory/bad exit/invalid for use, or rejected
  1587. entirely.
  1588. **AuthDirListBadDirs** **0**|**1**::
  1589. Authoritative directories only. If set to 1, this directory has some
  1590. opinion about which nodes are unsuitable as directory caches. (Do not set
  1591. this to 1 unless you plan to list non-functioning directories as bad;
  1592. otherwise, you are effectively voting in favor of every declared
  1593. directory.)
  1594. **AuthDirListBadExits** **0**|**1**::
  1595. Authoritative directories only. If set to 1, this directory has some
  1596. opinion about which nodes are unsuitable as exit nodes. (Do not set this to
  1597. 1 unless you plan to list non-functioning exits as bad; otherwise, you are
  1598. effectively voting in favor of every declared exit as an exit.)
  1599. **AuthDirRejectUnlisted** **0**|**1**::
  1600. Authoritative directories only. If set to 1, the directory server rejects
  1601. all uploaded server descriptors that aren't explicitly listed in the
  1602. fingerprints file. This acts as a "panic button" if we get hit with a Sybil
  1603. attack. (Default: 0)
  1604. **AuthDirMaxServersPerAddr** __NUM__::
  1605. Authoritative directories only. The maximum number of servers that we will
  1606. list as acceptable on a single IP address. Set this to "0" for "no limit".
  1607. (Default: 2)
  1608. **AuthDirMaxServersPerAuthAddr** __NUM__::
  1609. Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
  1610. to addresses shared with directory authorities. (Default: 5)
  1611. **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  1612. Authoritative directories only. If non-zero, always vote the
  1613. Fast flag for any relay advertising this amount of capacity or
  1614. more. (Default: 100 KBytes)
  1615. **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  1616. Authoritative directories only. If non-zero, this advertised capacity
  1617. or more is always sufficient to satisfy the bandwidth requirement
  1618. for the Guard flag. (Default: 250 KBytes)
  1619. **BridgePassword** __Password__::
  1620. If set, contains an HTTP authenticator that tells a bridge authority to
  1621. serve all requested bridge information. Used by the (only partially
  1622. implemented) "bridge community" design, where a community of bridge
  1623. relay operators all use an alternate bridge directory authority,
  1624. and their target user audience can periodically fetch the list of
  1625. available community bridges to stay up-to-date. (Default: not set)
  1626. **V3AuthVotingInterval** __N__ **minutes**|**hours**::
  1627. V3 authoritative directories only. Configures the server's preferred voting
  1628. interval. Note that voting will __actually__ happen at an interval chosen
  1629. by consensus from all the authorities' preferred intervals. This time
  1630. SHOULD divide evenly into a day. (Default: 1 hour)
  1631. **V3AuthVoteDelay** __N__ **minutes**|**hours**::
  1632. V3 authoritative directories only. Configures the server's preferred delay
  1633. between publishing its vote and assuming it has all the votes from all the
  1634. other authorities. Note that the actual time used is not the server's
  1635. preferred time, but the consensus of all preferences. (Default: 5 minutes)
  1636. **V3AuthDistDelay** __N__ **minutes**|**hours**::
  1637. V3 authoritative directories only. Configures the server's preferred delay
  1638. between publishing its consensus and signature and assuming it has all the
  1639. signatures from all the other authorities. Note that the actual time used
  1640. is not the server's preferred time, but the consensus of all preferences.
  1641. (Default: 5 minutes)
  1642. **V3AuthNIntervalsValid** __NUM__::
  1643. V3 authoritative directories only. Configures the number of VotingIntervals
  1644. for which each consensus should be valid for. Choosing high numbers
  1645. increases network partitioning risks; choosing low numbers increases
  1646. directory traffic. Note that the actual number of intervals used is not the
  1647. server's preferred number, but the consensus of all preferences. Must be at
  1648. least 2. (Default: 3)
  1649. **V3BandwidthsFile** __FILENAME__::
  1650. V3 authoritative directories only. Configures the location of the
  1651. bandwidth-authority generated file storing information on relays' measured
  1652. bandwidth capacities. (Default: unset)
  1653. **V3AuthUseLegacyKey** **0**|**1**::
  1654. If set, the directory authority will sign consensuses not only with its
  1655. own signing key, but also with a "legacy" key and certificate with a
  1656. different identity. This feature is used to migrate directory authority
  1657. keys in the event of a compromise. (Default: 0)
  1658. **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  1659. Tells an authority, or other node tracking node reliability and history,
  1660. that fine-grained information about nodes can be discarded when it hasn't
  1661. changed for a given amount of time. (Default: 24 hours)
  1662. **VoteOnHidServDirectoriesV2** **0**|**1**::
  1663. When this option is set in addition to **AuthoritativeDirectory**, Tor
  1664. votes on whether to accept relays as hidden service directories.
  1665. (Default: 1)
  1666. **AuthDirHasIPv6Connectivity** **0**|**1**::
  1667. Authoritative directories only. When set to 0, OR ports with an
  1668. IPv6 address are being accepted without reachability testing.
  1669. When set to 1, IPv6 OR ports are being tested just like IPv4 OR
  1670. ports. (Default: 0)
  1671. HIDDEN SERVICE OPTIONS
  1672. ----------------------
  1673. The following options are used to configure a hidden service.
  1674. **HiddenServiceDir** __DIRECTORY__::
  1675. Store data files for a hidden service in DIRECTORY. Every hidden service
  1676. must have a separate directory. You may use this option multiple times to
  1677. specify multiple services. DIRECTORY must be an existing directory.
  1678. **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
  1679. Configure a virtual port VIRTPORT for a hidden service. You may use this
  1680. option multiple times; each time applies to the service using the most
  1681. recent hiddenservicedir. By default, this option maps the virtual port to
  1682. the same port on 127.0.0.1 over TCP. You may override the target port,
  1683. address, or both by specifying a target of addr, port, or addr:port.
  1684. You may also have multiple lines with the same VIRTPORT: when a user
  1685. connects to that VIRTPORT, one of the TARGETs from those lines will be
  1686. chosen at random.
  1687. **PublishHidServDescriptors** **0**|**1**::
  1688. If set to 0, Tor will run any hidden services you configure, but it won't
  1689. advertise them to the rendezvous directory. This option is only useful if
  1690. you're using a Tor controller that handles hidserv publishing for you.
  1691. (Default: 1)
  1692. **HiddenServiceVersion** __version__,__version__,__...__::
  1693. A list of rendezvous service descriptor versions to publish for the hidden
  1694. service. Currently, only version 2 is supported. (Default: 2)
  1695. **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
  1696. If configured, the hidden service is accessible for authorized clients
  1697. only. The auth-type can either be \'basic' for a general-purpose
  1698. authorization protocol or \'stealth' for a less scalable protocol that also
  1699. hides service activity from unauthorized clients. Only clients that are
  1700. listed here are authorized to access the hidden service. Valid client names
  1701. are 1 to 19 characters long and only use characters in A-Za-z0-9+-_ (no
  1702. spaces). If this option is set, the hidden service is not accessible for
  1703. clients without authorization any more. Generated authorization data can be
  1704. found in the hostname file. Clients need to put this authorization data in
  1705. their configuration file using **HidServAuth**.
  1706. **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  1707. Every time the specified period elapses, Tor uploads any rendezvous
  1708. service descriptors to the directory servers. This information is also
  1709. uploaded whenever it changes. (Default: 1 hour)
  1710. TESTING NETWORK OPTIONS
  1711. -----------------------
  1712. The following options are used for running a testing Tor network.
  1713. **TestingTorNetwork** **0**|**1**::
  1714. If set to 1, Tor adjusts default values of the configuration options below,
  1715. so that it is easier to set up a testing Tor network. May only be set if
  1716. non-default set of DirServers is set. Cannot be unset while Tor is running.
  1717. (Default: 0) +
  1718. ServerDNSAllowBrokenConfig 1
  1719. DirAllowPrivateAddresses 1
  1720. EnforceDistinctSubnets 0
  1721. AssumeReachable 1
  1722. AuthDirMaxServersPerAddr 0
  1723. AuthDirMaxServersPerAuthAddr 0
  1724. ClientDNSRejectInternalAddresses 0
  1725. ClientRejectInternalAddresses 0
  1726. CountPrivateBandwidth 1
  1727. ExitPolicyRejectPrivate 0
  1728. ExtendAllowPrivateAddresses 1
  1729. V3AuthVotingInterval 5 minutes
  1730. V3AuthVoteDelay 20 seconds
  1731. V3AuthDistDelay 20 seconds
  1732. MinUptimeHidServDirectoryV2 0 seconds
  1733. TestingV3AuthInitialVotingInterval 5 minutes
  1734. TestingV3AuthInitialVoteDelay 20 seconds
  1735. TestingV3AuthInitialDistDelay 20 seconds
  1736. TestingAuthDirTimeToLearnReachability 0 minutes
  1737. TestingEstimatedDescriptorPropagationTime 0 minutes
  1738. TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
  1739. TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
  1740. TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
  1741. TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
  1742. TestingBridgeDownloadSchedule 60, 30, 30, 60
  1743. TestingClientMaxIntervalWithoutRequest 5 seconds
  1744. TestingDirConnectionMaxStall 30 seconds
  1745. TestingConsensusMaxDownloadTries 80
  1746. TestingDescriptorMaxDownloadTries 80
  1747. TestingMicrodescMaxDownloadTries 80
  1748. TestingCertMaxDownloadTries 80
  1749. **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
  1750. Like V3AuthVotingInterval, but for initial voting interval before the first
  1751. consensus has been created. Changing this requires that
  1752. **TestingTorNetwork** is set. (Default: 30 minutes)
  1753. **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
  1754. Like V3AuthVoteDelay, but for initial voting interval before
  1755. the first consensus has been created. Changing this requires that
  1756. **TestingTorNetwork** is set. (Default: 5 minutes)
  1757. **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
  1758. Like V3AuthDistDelay, but for initial voting interval before
  1759. the first consensus has been created. Changing this requires that
  1760. **TestingTorNetwork** is set. (Default: 5 minutes)
  1761. **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
  1762. Directory authorities offset voting start time by this much.
  1763. Changing this requires that **TestingTorNetwork** is set. (Default: 0)
  1764. **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
  1765. After starting as an authority, do not make claims about whether routers
  1766. are Running until this much time has passed. Changing this requires
  1767. that **TestingTorNetwork** is set. (Default: 30 minutes)
  1768. **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
  1769. Clients try downloading router descriptors from directory caches after this
  1770. time. Changing this requires that **TestingTorNetwork** is set. (Default:
  1771. 10 minutes)
  1772. **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
  1773. Minimum value for the Fast flag. Overrides the ordinary minimum taken
  1774. from the consensus when TestingTorNetwork is set. (Default: 0.)
  1775. **TestingServerDownloadSchedule** __N__,__N__,__...__::
  1776. Schedule for when servers should download things in general. Changing this
  1777. requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
  1778. 300, 900, 2147483647)
  1779. **TestingClientDownloadSchedule** __N__,__N__,__...__::
  1780. Schedule for when clients should download things in general. Changing this
  1781. requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
  1782. 2147483647)
  1783. **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
  1784. Schedule for when servers should download consensuses. Changing this
  1785. requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
  1786. 1800, 1800, 1800, 1800, 1800, 3600, 7200)
  1787. **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
  1788. Schedule for when clients should download consensuses. Changing this
  1789. requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
  1790. 1800, 3600, 3600, 3600, 10800, 21600, 43200)
  1791. **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
  1792. Schedule for when clients should download bridge descriptors. Changing this
  1793. requires that **TestingTorNetwork** is set. (Default: 3600, 900, 900, 3600)
  1794. **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
  1795. When directory clients have only a few descriptors to request, they batch
  1796. them until they have more, or until this amount of time has passed.
  1797. Changing this requires that **TestingTorNetwork** is set. (Default: 10
  1798. minutes)
  1799. **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
  1800. Let a directory connection stall this long before expiring it.
  1801. Changing this requires that **TestingTorNetwork** is set. (Default:
  1802. 5 minutes)
  1803. **TestingConsensusMaxDownloadTries** __NUM__::
  1804. Try this often to download a consensus before giving up. Changing
  1805. this requires that **TestingTorNetwork** is set. (Default: 8)
  1806. **TestingDescriptorMaxDownloadTries** __NUM__::
  1807. Try this often to download a router descriptor before giving up.
  1808. Changing this requires that **TestingTorNetwork** is set. (Default: 8)
  1809. **TestingMicrodescMaxDownloadTries** __NUM__::
  1810. Try this often to download a microdesc descriptor before giving up.
  1811. Changing this requires that **TestingTorNetwork** is set. (Default: 8)
  1812. **TestingCertMaxDownloadTries** __NUM__::
  1813. Try this often to download a v3 authority certificate before giving up.
  1814. Changing this requires that **TestingTorNetwork** is set. (Default: 8)
  1815. SIGNALS
  1816. -------
  1817. Tor catches the following signals:
  1818. **SIGTERM**::
  1819. Tor will catch this, clean up and sync to disk if necessary, and exit.
  1820. **SIGINT**::
  1821. Tor clients behave as with SIGTERM; but Tor servers will do a controlled
  1822. slow shutdown, closing listeners and waiting 30 seconds before exiting.
  1823. (The delay can be configured with the ShutdownWaitLength config option.)
  1824. **SIGHUP**::
  1825. The signal instructs Tor to reload its configuration (including closing and
  1826. reopening logs), and kill and restart its helper processes if applicable.
  1827. **SIGUSR1**::
  1828. Log statistics about current connections, past connections, and throughput.
  1829. **SIGUSR2**::
  1830. Switch all logs to loglevel debug. You can go back to the old loglevels by
  1831. sending a SIGHUP.
  1832. **SIGCHLD**::
  1833. Tor receives this signal when one of its helper processes has exited, so it
  1834. can clean up.
  1835. **SIGPIPE**::
  1836. Tor catches this signal and ignores it.
  1837. **SIGXFSZ**::
  1838. If this signal exists on your platform, Tor catches and ignores it.
  1839. FILES
  1840. -----
  1841. **@CONFDIR@/torrc**::
  1842. The configuration file, which contains "option value" pairs.
  1843. **@LOCALSTATEDIR@/lib/tor/**::
  1844. The tor process stores keys and other data here.
  1845. __DataDirectory__**/cached-status/**::
  1846. The most recently downloaded network status document for each authority.
  1847. Each file holds one such document; the filenames are the hexadecimal
  1848. identity key fingerprints of the directory authorities. Mostly obsolete.
  1849. __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
  1850. The most recent consensus network status document we've downloaded.
  1851. __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
  1852. These files hold downloaded router statuses. Some routers may appear more
  1853. than once; if so, the most recently published descriptor is used. Lines
  1854. beginning with @-signs are annotations that contain more information about
  1855. a given router. The ".new" file is an append-only journal; when it gets
  1856. too large, all entries are merged into a new cached-descriptors file.
  1857. __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
  1858. These files hold downloaded microdescriptors. Lines beginning with
  1859. @-signs are annotations that contain more information about a given
  1860. router. The ".new" file is an append-only journal; when it gets too
  1861. large, all entries are merged into a new cached-microdescs file.
  1862. __DataDirectory__**/cached-routers** and **cached-routers.new**::
  1863. Obsolete versions of cached-descriptors and cached-descriptors.new. When
  1864. Tor can't find the newer files, it looks here instead.
  1865. __DataDirectory__**/state**::
  1866. A set of persistent key-value mappings. These are documented in
  1867. the file. These include:
  1868. - The current entry guards and their status.
  1869. - The current bandwidth accounting values (unused so far; see
  1870. below).
  1871. - When the file was last written
  1872. - What version of Tor generated the state file
  1873. - A short history of bandwidth usage, as produced in the router
  1874. descriptors.
  1875. __DataDirectory__**/bw_accounting**::
  1876. Used to track bandwidth accounting values (when the current period starts
  1877. and ends; how much has been read and written so far this period). This file
  1878. is obsolete, and the data is now stored in the \'state' file as well. Only
  1879. used when bandwidth accounting is enabled.
  1880. __DataDirectory__**/control_auth_cookie**::
  1881. Used for cookie authentication with the controller. Location can be
  1882. overridden by the CookieAuthFile config option. Regenerated on startup. See
  1883. control-spec.txt for details. Only used when cookie authentication is
  1884. enabled.
  1885. __DataDirectory__**/keys/***::
  1886. Only used by servers. Holds identity keys and onion keys.
  1887. __DataDirectory__**/fingerprint**::
  1888. Only used by servers. Holds the fingerprint of the server's identity key.
  1889. __DataDirectory__**/approved-routers**::
  1890. Only for naming authoritative directory servers (see
  1891. **NamingAuthoritativeDirectory**). This file lists nickname to identity
  1892. bindings. Each line lists a nickname and a fingerprint separated by
  1893. whitespace. See your **fingerprint** file in the __DataDirectory__ for an
  1894. example line. If the nickname is **!reject** then descriptors from the
  1895. given identity (fingerprint) are rejected by this server. If it is
  1896. **!invalid** then descriptors are accepted but marked in the directory as
  1897. not valid, that is, not recommended.
  1898. __DataDirectory__**/router-stability**::
  1899. Only used by authoritative directory servers. Tracks measurements for
  1900. router mean-time-between-failures so that authorities have a good idea of
  1901. how to set their Stable flags.
  1902. __HiddenServiceDirectory__**/hostname**::
  1903. The <base32-encoded-fingerprint>.onion domain name for this hidden service.
  1904. If the hidden service is restricted to authorized clients only, this file
  1905. also contains authorization data for all clients.
  1906. __HiddenServiceDirectory__**/private_key**::
  1907. The private key for this hidden service.
  1908. __HiddenServiceDirectory__**/client_keys**::
  1909. Authorization data for a hidden service that is only accessible by
  1910. authorized clients.
  1911. SEE ALSO
  1912. --------
  1913. **privoxy**(1), **torsocks**(1), **torify**(1) +
  1914. **https://www.torproject.org/**
  1915. BUGS
  1916. ----
  1917. Plenty, probably. Tor is still in development. Please report them.
  1918. AUTHORS
  1919. -------
  1920. Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].