tor.1.txt 134 KB

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