tor.1.txt 173 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389
  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 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-list-deprecated-options]] **--list-deprecated-options**::
  69. List all valid options that are scheduled to become obsolete in a
  70. future version. (This is a warning, not a promise.)
  71. [[opt-version]] **--version**::
  72. Display Tor version and exit.
  73. [[opt-quiet]] **--quiet**|**--hush**::
  74. Override the default console log. By default, Tor starts out logging
  75. messages at level "notice" and higher to the console. It stops doing so
  76. after it parses its configuration, if the configuration tells it to log
  77. anywhere else. You can override this behavior with the **--hush** option,
  78. which tells Tor to only send warnings and errors to the console, or with
  79. the **--quiet** option, which tells Tor not to log to the console at all.
  80. [[opt-keygen]] **--keygen** [**--newpass**]::
  81. Running "tor --keygen" creates a new ed25519 master identity key for a
  82. relay, or only a fresh temporary signing key and certificate, if you
  83. already have a master key. Optionally you can encrypt the master identity
  84. key with a passphrase: Tor will ask you for one. If you don't want to
  85. encrypt the master key, just don't enter any passphrase when asked. +
  86. +
  87. The **--newpass** option should be used with --keygen only when you need
  88. to add, change, or remove a passphrase on an existing ed25519 master
  89. identity key. You will be prompted for the old passphase (if any),
  90. and the new passphrase (if any). +
  91. +
  92. When generating a master key, you will probably want to use
  93. **--DataDirectory** to control where the keys
  94. and certificates will be stored, and **--SigningKeyLifetime** to
  95. control their lifetimes. Their behavior is as documented in the
  96. server options section below. (You must have write access to the specified
  97. DataDirectory.) +
  98. +
  99. To use the generated files, you must copy them to the DataDirectory/keys
  100. directory of your Tor daemon, and make sure that they are owned by the
  101. user actually running the Tor daemon on your system.
  102. **--passphrase-fd** __FILEDES__::
  103. Filedescriptor to read the passphrase from. Note that unlike with the
  104. tor-gencert program, the entire file contents are read and used as
  105. the passphrase, including any trailing newlines.
  106. Default: read from the terminal.
  107. [[opt-key-expiration]] **--key-expiration** [**purpose**]::
  108. The **purpose** specifies which type of key certificate to determine
  109. the expiration of. The only currently recognised **purpose** is
  110. "sign". +
  111. +
  112. Running "tor --key-expiration sign" will attempt to find your signing
  113. key certificate and will output, both in the logs as well as to stdout,
  114. the signing key certificate's expiration time in ISO-8601 format.
  115. For example, the output sent to stdout will be of the form:
  116. "signing-cert-expiry: 2017-07-25 08:30:15 UTC"
  117. Other options can be specified on the command-line in the format "--option
  118. value", in the format "option value", or in a configuration file. For
  119. instance, you can tell Tor to start listening for SOCKS connections on port
  120. 9999 by passing --SocksPort 9999 or SocksPort 9999 to it on the command line,
  121. or by putting "SocksPort 9999" in the configuration file. You will need to
  122. quote options with spaces in them: if you want Tor to log all debugging
  123. messages to debug.log, you will probably need to say --Log 'debug file
  124. debug.log'.
  125. Options on the command line override those in configuration files. See the
  126. next section for more information.
  127. THE CONFIGURATION FILE FORMAT
  128. -----------------------------
  129. All configuration options in a configuration are written on a single line by
  130. default. They take the form of an option name and a value, or an option name
  131. and a quoted value (option value or option "value"). Anything after a #
  132. character is treated as a comment. Options are
  133. case-insensitive. C-style escaped characters are allowed inside quoted
  134. values. To split one configuration entry into multiple lines, use a single
  135. backslash character (\) before the end of the line. Comments can be used in
  136. such multiline entries, but they must start at the beginning of a line.
  137. Configuration options can be imported from files or folders using the %include
  138. option with the value being a path. If the path is a file, the options from the
  139. file will be parsed as if they were written where the %include option is. If
  140. the path is a folder, all files on that folder will be parsed following lexical
  141. order. Files starting with a dot are ignored. Files on subfolders are ignored.
  142. The %include option can be used recursively.
  143. By default, an option on the command line overrides an option found in the
  144. configuration file, and an option in a configuration file overrides one in
  145. the defaults file.
  146. This rule is simple for options that take a single value, but it can become
  147. complicated for options that are allowed to occur more than once: if you
  148. specify four SocksPorts in your configuration file, and one more SocksPort on
  149. the command line, the option on the command line will replace __all__ of the
  150. SocksPorts in the configuration file. If this isn't what you want, prefix
  151. the option name with a plus sign (+), and it will be appended to the previous
  152. set of options instead. For example, setting SocksPort 9100 will use only
  153. port 9100, but setting +SocksPort 9100 will use ports 9100 and 9050 (because
  154. this is the default).
  155. Alternatively, you might want to remove every instance of an option in the
  156. configuration file, and not replace it at all: you might want to say on the
  157. command line that you want no SocksPorts at all. To do that, prefix the
  158. option name with a forward slash (/). You can use the plus sign (+) and the
  159. forward slash (/) in the configuration file and on the command line.
  160. GENERAL OPTIONS
  161. ---------------
  162. [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  163. A token bucket limits the average incoming bandwidth usage on this node
  164. to the specified number of bytes per second, and the average outgoing
  165. bandwidth usage to that same value. If you want to run a relay in the
  166. public network, this needs to be _at the very least_ 75 KBytes for a
  167. relay (that is, 600 kbits) or 50 KBytes for a bridge (400 kbits) -- but of
  168. course, more is better; we recommend at least 250 KBytes (2 mbits) if
  169. possible. (Default: 1 GByte) +
  170. +
  171. Note that this option, and other bandwidth-limiting options, apply to TCP
  172. data only: They do not count TCP headers or DNS traffic. +
  173. +
  174. With this option, and in other options that take arguments in bytes,
  175. KBytes, and so on, other formats are also supported. Notably, "KBytes" can
  176. also be written as "kilobytes" or "kb"; "MBytes" can be written as
  177. "megabytes" or "MB"; "kbits" can be written as "kilobits"; and so forth.
  178. Tor also accepts "byte" and "bit" in the singular.
  179. The prefixes "tera" and "T" are also recognized.
  180. If no units are given, we default to bytes.
  181. To avoid confusion, we recommend writing "bytes" or "bits" explicitly,
  182. since it's easy to forget that "B" means bytes, not bits.
  183. [[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  184. Limit the maximum token bucket size (also known as the burst) to the given
  185. number of bytes in each direction. (Default: 1 GByte)
  186. [[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  187. If set, we will not advertise more than this amount of bandwidth for our
  188. BandwidthRate. Server operators who want to reduce the number of clients
  189. who ask to build circuits through them (since this is proportional to
  190. advertised bandwidth rate) can thus reduce the CPU demands on their server
  191. without impacting network performance.
  192. [[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  193. If not 0, a separate token bucket limits the average incoming bandwidth
  194. usage for \_relayed traffic_ on this node to the specified number of bytes
  195. per second, and the average outgoing bandwidth usage to that same value.
  196. Relayed traffic currently is calculated to include answers to directory
  197. requests, but that may change in future versions. They do not include directory
  198. fetches by the relay (from authority or other relays), because that is considered
  199. "client" activity. (Default: 0)
  200. [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  201. If not 0, limit the maximum token bucket size (also known as the burst) for
  202. \_relayed traffic_ to the given number of bytes in each direction.
  203. They do not include directory fetches by the relay (from authority
  204. or other relays), because that is considered "client" activity. (Default: 0)
  205. [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  206. If this option is set manually, or via the "perconnbwrate" consensus
  207. field, Tor will use it for separate rate limiting for each connection
  208. from a non-relay. (Default: 0)
  209. [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  210. If this option is set manually, or via the "perconnbwburst" consensus
  211. field, Tor will use it for separate rate limiting for each connection
  212. from a non-relay. (Default: 0)
  213. [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
  214. **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
  215. In its first form, when set along with a corresponding Bridge line, the Tor
  216. client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT".
  217. (IPv4 addresses should written as-is; IPv6 addresses should be wrapped in
  218. square brackets.) It's the
  219. duty of that proxy to properly forward the traffic to the bridge. +
  220. +
  221. In its second form, when set along with a corresponding Bridge line, the Tor
  222. client launches the pluggable transport proxy executable in
  223. __path-to-binary__ using __options__ as its command-line options, and
  224. forwards its traffic to it. It's the duty of that proxy to properly forward
  225. the traffic to the bridge.
  226. [[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
  227. The Tor relay launches the pluggable transport proxy in __path-to-binary__
  228. using __options__ as its command-line options, and expects to receive
  229. proxied client traffic from it.
  230. [[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
  231. When this option is set, Tor will suggest __IP__:__PORT__ as the
  232. listening address of any pluggable transport proxy that tries to
  233. launch __transport__. (IPv4 addresses should written as-is; IPv6
  234. addresses should be wrapped in square brackets.)
  235. [[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...::
  236. When this option is set, Tor will pass the __k=v__ parameters to
  237. any pluggable transport proxy that tries to launch __transport__. +
  238. (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache)
  239. [[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**::
  240. Open this port to listen for Extended ORPort connections from your
  241. pluggable transports.
  242. [[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__::
  243. If set, this option overrides the default location and file name
  244. for the Extended ORPort's cookie file -- the cookie file is needed
  245. for pluggable transports to communicate through the Extended ORPort.
  246. [[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**::
  247. If this option is set to 0, don't allow the filesystem group to read the
  248. Extended OR Port cookie file. If the option is set to 1, make the cookie
  249. file readable by the default GID. [Making the file readable by other
  250. groups is not yet implemented; let us know if you need this for some
  251. reason.] (Default: 0)
  252. [[ConnLimit]] **ConnLimit** __NUM__::
  253. The minimum number of file descriptors that must be available to the Tor
  254. process before it will start. Tor will ask the OS for as many file
  255. descriptors as the OS will allow (you can find this by "ulimit -H -n").
  256. If this number is less than ConnLimit, then Tor will refuse to start. +
  257. +
  258. You probably don't need to adjust this. It has no effect on Windows
  259. since that platform lacks getrlimit(). (Default: 1000)
  260. [[DisableNetwork]] **DisableNetwork** **0**|**1**::
  261. When this option is set, we don't listen for or accept any connections
  262. other than controller connections, and we close (and don't reattempt)
  263. any outbound
  264. connections. Controllers sometimes use this option to avoid using
  265. the network until Tor is fully configured. Tor will make still certain
  266. network-related calls (like DNS lookups) as a part of its configuration
  267. process, even if DisableNetwork is set. (Default: 0)
  268. [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
  269. If set, Tor will tell the kernel to attempt to shrink the buffers for all
  270. sockets to the size specified in **ConstrainedSockSize**. This is useful for
  271. virtual servers and other environments where system level TCP buffers may
  272. be limited. If you're on a virtual server, and you encounter the "Error
  273. creating network socket: No buffer space available" message, you are
  274. likely experiencing this problem. +
  275. +
  276. The preferred solution is to have the admin increase the buffer pool for
  277. the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
  278. this configuration option is a second-resort. +
  279. +
  280. The DirPort option should also not be used if TCP buffers are scarce. The
  281. cached directory requests consume additional sockets which exacerbates
  282. the problem. +
  283. +
  284. You should **not** enable this feature unless you encounter the "no buffer
  285. space available" issue. Reducing the TCP buffers affects window size for
  286. the TCP stream and will reduce throughput in proportion to round trip
  287. time on long paths. (Default: 0)
  288. [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
  289. When **ConstrainedSockets** is enabled the receive and transmit buffers for
  290. all sockets will be set to this limit. Must be a value between 2048 and
  291. 262144, in 1024 byte increments. Default of 8192 is recommended.
  292. [[ControlPort]] **ControlPort** __PORT__|**unix:**__path__|**auto** [__flags__]::
  293. If set, Tor will accept connections on this port and allow those
  294. connections to control the Tor process using the Tor Control Protocol
  295. (described in control-spec.txt in
  296. https://spec.torproject.org[torspec]). Note: unless you also
  297. specify one or more of **HashedControlPassword** or
  298. **CookieAuthentication**, setting this option will cause Tor to allow
  299. any process on the local host to control it. (Setting both authentication
  300. methods means either method is sufficient to authenticate to Tor.) This
  301. option is required for many Tor controllers; most use the value of 9051.
  302. If a unix domain socket is used, you may quote the path using standard
  303. C escape sequences.
  304. Set it to "auto" to have Tor pick a port for you. (Default: 0) +
  305. +
  306. Recognized flags are...
  307. **GroupWritable**;;
  308. Unix domain sockets only: makes the socket get created as
  309. group-writable.
  310. **WorldWritable**;;
  311. Unix domain sockets only: makes the socket get created as
  312. world-writable.
  313. **RelaxDirModeCheck**;;
  314. Unix domain sockets only: Do not insist that the directory
  315. that holds the socket be read-restricted.
  316. [[ControlSocket]] **ControlSocket** __Path__::
  317. Like ControlPort, but listens on a Unix domain socket, rather than a TCP
  318. socket. '0' disables ControlSocket (Unix and Unix-like systems only.)
  319. [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
  320. If this option is set to 0, don't allow the filesystem group to read and
  321. write unix sockets (e.g. ControlSocket). If the option is set to 1, make
  322. the control socket readable and writable by the default GID. (Default: 0)
  323. [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
  324. Allow connections on the control port if they present
  325. the password whose one-way hash is __hashed_password__. You
  326. can compute the hash of a password by running "tor --hash-password
  327. __password__". You can provide several acceptable passwords by using more
  328. than one HashedControlPassword line.
  329. [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
  330. If this option is set to 1, allow connections on the control port
  331. when the connecting process knows the contents of a file named
  332. "control_auth_cookie", which Tor will create in its data directory. This
  333. authentication method should only be used on systems with good filesystem
  334. security. (Default: 0)
  335. [[CookieAuthFile]] **CookieAuthFile** __Path__::
  336. If set, this option overrides the default location and file name
  337. for Tor's cookie file. (See CookieAuthentication above.)
  338. [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
  339. If this option is set to 0, don't allow the filesystem group to read the
  340. cookie file. If the option is set to 1, make the cookie file readable by
  341. the default GID. [Making the file readable by other groups is not yet
  342. implemented; let us know if you need this for some reason.] (Default: 0)
  343. [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
  344. If set, Tor writes the address and port of any control port it opens to
  345. this address. Usable by controllers to learn the actual control port
  346. when ControlPort is set to "auto".
  347. [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
  348. If this option is set to 0, don't allow the filesystem group to read the
  349. control port file. If the option is set to 1, make the control port
  350. file readable by the default GID. (Default: 0)
  351. [[DataDirectory]] **DataDirectory** __DIR__::
  352. Store working data in DIR. Can not be changed while tor is running.
  353. (Default: ~/.tor if your home directory is not /; otherwise,
  354. @LOCALSTATEDIR@/lib/tor. On Windows, the default is
  355. your ApplicationData folder.)
  356. [[DataDirectoryGroupReadable]] **DataDirectoryGroupReadable** **0**|**1**::
  357. If this option is set to 0, don't allow the filesystem group to read the
  358. DataDirectory. If the option is set to 1, make the DataDirectory readable
  359. by the default GID. (Default: 0)
  360. [[CacheDirectory]] **CacheDirectory** __DIR__::
  361. Store cached directory data in DIR. Can not be changed while tor is
  362. running.
  363. (Default: uses the value of DataDirectory.)
  364. [[CacheDirectoryGroupReadable]] **CacheDirectoryGroupReadable** **0**|**1**::
  365. If this option is set to 0, don't allow the filesystem group to read the
  366. CacheDirectory. If the option is set to 1, make the CacheDirectory readable
  367. by the default GID. (Default: 0)
  368. [[FallbackDir]] **FallbackDir** __ipv4address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__] [ipv6=**[**__ipv6address__**]**:__orport__]::
  369. When we're unable to connect to any directory cache for directory info
  370. (usually because we don't know about any yet) we try a directory authority.
  371. Clients also simultaneously try a FallbackDir, to avoid hangs on client
  372. startup if a directory authority is down. Clients retry FallbackDirs more
  373. often than directory authorities, to reduce the load on the directory
  374. authorities.
  375. By default, the directory authorities are also FallbackDirs. Specifying a
  376. FallbackDir replaces Tor's default hard-coded FallbackDirs (if any).
  377. (See the **DirAuthority** entry for an explanation of each flag.)
  378. [[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**::
  379. Use Tor's default hard-coded FallbackDirs (if any). (When a
  380. FallbackDir line is present, it replaces the hard-coded FallbackDirs,
  381. regardless of the value of UseDefaultFallbackDirs.) (Default: 1)
  382. [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__::
  383. Use a nonstandard authoritative directory server at the provided address
  384. and port, with the specified key fingerprint. This option can be repeated
  385. many times, for multiple authoritative directory servers. Flags are
  386. separated by spaces, and determine what kind of an authority this directory
  387. is. By default, an authority is not authoritative for any directory style
  388. or version unless an appropriate flag is given.
  389. Tor will use this authority as a bridge authoritative directory if the
  390. "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
  391. given port when opening encrypted tunnels to the dirserver. If a flag
  392. "weight=**num**" is given, then the directory server is chosen randomly
  393. with probability proportional to that weight (default 1.0). If a
  394. flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
  395. whose v3 long-term signing key has the fingerprint **fp**. Lastly,
  396. if an "ipv6=**[**__ipv6address__**]**:__orport__" flag is present, then
  397. the directory
  398. authority is listening for IPv6 connections on the indicated IPv6 address
  399. and OR Port. +
  400. +
  401. Tor will contact the authority at __ipv4address__ to
  402. download directory documents. The provided __port__ value is a dirport;
  403. clients ignore this in favor of the specified "orport=" value. If an
  404. IPv6 ORPort is supplied, Tor will
  405. also download directory documents at the IPv6 ORPort. +
  406. +
  407. If no **DirAuthority** line is given, Tor will use the default directory
  408. authorities. NOTE: this option is intended for setting up a private Tor
  409. network with its own directory authorities. If you use it, you will be
  410. distinguishable from other users, because you won't believe the same
  411. authorities they do.
  412. [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
  413. When configured to use both directory authorities and fallback
  414. directories, the directory authorities also work as fallbacks. They are
  415. chosen with their regular weights, multiplied by this number, which
  416. should be 1.0 or less. The default is less than 1, to reduce load on
  417. authorities. (Default: 0.1)
  418. [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__ +
  419. [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __ fingerprint__::
  420. These options behave as DirAuthority, but they replace fewer of the
  421. default directory authorities. Using
  422. AlternateDirAuthority replaces the default Tor directory authorities, but
  423. leaves the default bridge authorities in
  424. place. Similarly,
  425. AlternateBridgeAuthority replaces the default bridge authority,
  426. but leaves the directory authorities alone.
  427. [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
  428. If set to 1, Tor will attempt to lock all current and future memory pages,
  429. so that memory cannot be paged out. Windows, OS X and Solaris are currently
  430. not supported. We believe that this feature works on modern Gnu/Linux
  431. distributions, and that it should work on *BSD systems (untested). This
  432. option requires that you start your Tor as root, and you should use the
  433. **User** option to properly reduce Tor's privileges.
  434. Can not be changed while tor is running. (Default: 0)
  435. [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
  436. If set to 1, Tor will attempt to prevent basic debugging attachment attempts
  437. by other processes. This may also keep Tor from generating core files if
  438. it crashes. It has no impact for users who wish to attach if they
  439. have CAP_SYS_PTRACE or if they are root. We believe that this feature
  440. works on modern Gnu/Linux distributions, and that it may also work on *BSD
  441. systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
  442. kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
  443. limit the PTRACE scope for all user processes by default. This feature will
  444. attempt to limit the PTRACE scope for Tor specifically - it will not attempt
  445. to alter the system wide ptrace scope as it may not even exist. If you wish
  446. to attach to Tor with a debugger such as gdb or strace you will want to set
  447. this to 0 for the duration of your debugging. Normal users should leave it
  448. on. Disabling this option while Tor is running is prohibited. (Default: 1)
  449. [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
  450. If set to 1, Tor will always fetch directory information like other
  451. directory caches, even if you don't meet the normal criteria for fetching
  452. early. Normal users should leave it off. (Default: 0)
  453. [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
  454. If set to 1, Tor will fetch directory information before other directory
  455. caches. It will attempt to download directory information closer to the
  456. start of the consensus period. Normal users should leave it off.
  457. (Default: 0)
  458. [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
  459. If set to 0, Tor will never fetch any hidden service descriptors from the
  460. rendezvous directories. This option is only useful if you're using a Tor
  461. controller that handles hidden service fetches for you. (Default: 1)
  462. [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
  463. If set to 0, Tor will never fetch any network status summaries or server
  464. descriptors from the directory servers. This option is only useful if
  465. you're using a Tor controller that handles directory fetches for you.
  466. (Default: 1)
  467. [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
  468. If set to 1, Tor will fetch every consensus flavor, descriptor, and
  469. certificate that it hears about. Otherwise, it will avoid fetching useless
  470. descriptors: flavors that it is not using to build circuits, and authority
  471. certificates it does not trust. This option is useful if you're using a
  472. tor client with an external parser that uses a full consensus.
  473. This option fetches all documents, **DirCache** fetches and serves
  474. all documents. (Default: 0)
  475. [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
  476. Tor will make all its directory requests through this host:port (or host:80
  477. if port is not specified), rather than connecting directly to any directory
  478. servers. (DEPRECATED: As of 0.3.1.0-alpha you should use HTTPSProxy.)
  479. [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
  480. If defined, Tor will use this username:password for Basic HTTP proxy
  481. authentication, as in RFC 2617. This is currently the only form of HTTP
  482. proxy authentication that Tor supports; feel free to submit a patch if you
  483. want it to support others. (DEPRECATED: As of 0.3.1.0-alpha you should use
  484. HTTPSProxyAuthenticator.)
  485. [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
  486. Tor will make all its OR (SSL) connections through this host:port (or
  487. host:443 if port is not specified), via HTTP CONNECT rather than connecting
  488. directly to servers. You may want to set **FascistFirewall** to restrict
  489. the set of ports you might try to connect to, if your HTTPS proxy only
  490. allows connecting to certain ports.
  491. [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
  492. If defined, Tor will use this username:password for Basic HTTPS proxy
  493. authentication, as in RFC 2617. This is currently the only form of HTTPS
  494. proxy authentication that Tor supports; feel free to submit a patch if you
  495. want it to support others.
  496. [[Sandbox]] **Sandbox** **0**|**1**::
  497. If set to 1, Tor will run securely through the use of a syscall sandbox.
  498. Otherwise the sandbox will be disabled. The option is currently an
  499. experimental feature. It only works on Linux-based operating systems,
  500. and only when Tor has been built with the libseccomp library. This option
  501. can not be changed while tor is running.
  502. +
  503. When the Sandbox is 1, the following options can not be changed when tor
  504. is running:
  505. Address
  506. ConnLimit
  507. CookieAuthFile
  508. DirPortFrontPage
  509. ExtORPortCookieAuthFile
  510. Logs
  511. ServerDNSResolvConfFile
  512. Tor must remain in client or server mode (some changes to ClientOnly and
  513. ORPort are not allowed).
  514. (Default: 0)
  515. [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
  516. Tor will make all OR connections through the SOCKS 4 proxy at host:port
  517. (or host:1080 if port is not specified).
  518. [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
  519. Tor will make all OR connections through the SOCKS 5 proxy at host:port
  520. (or host:1080 if port is not specified).
  521. [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
  522. [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
  523. If defined, authenticate to the SOCKS 5 server using username and password
  524. in accordance to RFC 1929. Both username and password must be between 1 and
  525. 255 characters.
  526. [[UnixSocksGroupWritable]] **UnixSocksGroupWritable** **0**|**1**::
  527. If this option is set to 0, don't allow the filesystem group to read and
  528. write unix sockets (e.g. SocksPort unix:). If the option is set to 1, make
  529. the Unix socket readable and writable by the default GID. (Default: 0)
  530. [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
  531. To keep firewalls from expiring connections, send a padding keepalive cell
  532. every NUM seconds on open connections that are in use. If the connection
  533. has no open circuits, it will instead be closed after NUM seconds of
  534. idleness. (Default: 5 minutes)
  535. [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
  536. Send all messages between __minSeverity__ and __maxSeverity__ to the standard
  537. output stream, the standard error stream, or to the system log. (The
  538. "syslog" value is only supported on Unix.) Recognized severity levels are
  539. debug, info, notice, warn, and err. We advise using "notice" in most cases,
  540. since anything more verbose may provide sensitive information to an
  541. attacker who obtains the logs. If only one severity level is given, all
  542. messages of that level or higher will be sent to the listed destination.
  543. [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
  544. As above, but send log messages to the listed filename. The
  545. "Log" option may appear more than once in a configuration file.
  546. Messages are sent to all the logs that match their severity
  547. level.
  548. [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
  549. [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
  550. As above, but select messages by range of log severity __and__ by a
  551. set of "logging domains". Each logging domain corresponds to an area of
  552. functionality inside Tor. You can specify any number of severity ranges
  553. for a single log statement, each of them prefixed by a comma-separated
  554. list of logging domains. You can prefix a domain with $$~$$ to indicate
  555. negation, and use * to indicate "all domains". If you specify a severity
  556. range without a list of domains, it matches all domains. +
  557. +
  558. This is an advanced feature which is most useful for debugging one or two
  559. of Tor's subsystems at a time. +
  560. +
  561. The currently recognized domains are: general, crypto, net, config, fs,
  562. protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
  563. acct, hist, handshake, heartbeat, channel, sched, guard, consdiff, and dos.
  564. Domain names are case-insensitive. +
  565. +
  566. For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
  567. to stdout: all handshake messages of any severity, all info-and-higher
  568. messages from domains other than networking and memory management, and all
  569. messages of severity notice or higher.
  570. [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
  571. If 1, Tor includes message domains with each log message. Every log
  572. message currently has at least one domain; most currently have exactly
  573. one. This doesn't affect controller log messages. (Default: 0)
  574. [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
  575. Unparseable descriptors (e.g. for votes, consensuses, routers) are logged
  576. in separate files by hash, up to the specified size in total. Note that
  577. only files logged during the lifetime of this Tor process count toward the
  578. total; this is intended to be used to debug problems without opening live
  579. servers to resource exhaustion attacks. (Default: 10 MB)
  580. [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
  581. Make all outbound connections originate from the IP address specified. This
  582. is only useful when you have multiple network interfaces, and you want all
  583. of Tor's outgoing connections to use a single one. This option may
  584. be used twice, once with an IPv4 address and once with an IPv6 address.
  585. IPv6 addresses should be wrapped in square brackets.
  586. This setting will be ignored for connections to the loopback addresses
  587. (127.0.0.0/8 and ::1), and is not used for DNS requests as well.
  588. [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__::
  589. Make all outbound non-exit (relay and other) connections
  590. originate from the IP address specified. This option overrides
  591. **OutboundBindAddress** for the same IP version. This option may
  592. be used twice, once with an IPv4 address and once with an IPv6
  593. address. IPv6 addresses should be wrapped in square brackets.
  594. This setting will be ignored for connections to the loopback
  595. addresses (127.0.0.0/8 and ::1).
  596. [[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__::
  597. Make all outbound exit connections originate from the IP address
  598. specified. This option overrides **OutboundBindAddress** for the
  599. same IP version. This option may be used twice, once with an IPv4
  600. address and once with an IPv6 address.
  601. IPv6 addresses should be wrapped in square brackets.
  602. This setting will be ignored
  603. for connections to the loopback addresses (127.0.0.0/8 and ::1).
  604. [[PidFile]] **PidFile** __FILE__::
  605. On startup, write our PID to FILE. On clean shutdown, remove
  606. FILE. Can not be changed while tor is running.
  607. [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
  608. If 1, Tor will log with severity \'warn' various cases of other parties not
  609. following the Tor specification. Otherwise, they are logged with severity
  610. \'info'. (Default: 0)
  611. [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
  612. If 1, Tor forks and daemonizes to the background. This option has no effect
  613. on Windows; instead you should use the --service command-line option.
  614. Can not be changed while tor is running.
  615. (Default: 0)
  616. [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
  617. Set the resolution of timestamps in Tor's logs to NUM milliseconds.
  618. NUM must be positive and either a divisor or a multiple of 1 second.
  619. Note that this option only controls the granularity written by Tor to
  620. a file or console log. Tor does not (for example) "batch up" log
  621. messages to affect times logged by a controller, times attached to
  622. syslog messages, or the mtime fields on log files. (Default: 1 second)
  623. [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
  624. If 1, Tor will overwrite logs at startup and in response to a HUP signal,
  625. instead of appending to them. (Default: 0)
  626. [[SyslogIdentityTag]] **SyslogIdentityTag** __tag__::
  627. When logging to syslog, adds a tag to the syslog identity such that
  628. log entries are marked with "Tor-__tag__". Can not be changed while tor is
  629. running. (Default: none)
  630. [[AndroidIdentityTag]] **AndroidIdentityTag** __tag__::
  631. When logging to Android's logging subsystem, adds a tag to the log identity
  632. such that log entries are marked with "Tor-__tag__". Can not be changed while
  633. tor is running. (Default: none)
  634. [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
  635. Tor can scrub potentially sensitive strings from log messages (e.g.
  636. addresses) by replacing them with the string [scrubbed]. This way logs can
  637. still be useful, but they don't leave behind personally identifying
  638. information about what sites a user might have visited. +
  639. +
  640. If this option is set to 0, Tor will not perform any scrubbing, if it is
  641. set to 1, all potentially sensitive strings are replaced. If it is set to
  642. relay, all log messages generated when acting as a relay are sanitized, but
  643. all messages generated when acting as a client are not. (Default: 1)
  644. [[User]] **User** __Username__::
  645. On startup, setuid to this user and setgid to their primary group.
  646. Can not be changed while tor is running.
  647. [[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**::
  648. On Linux, when we are started as root and we switch our identity using
  649. the **User** option, the **KeepBindCapabilities** option tells us whether to
  650. try to retain our ability to bind to low ports. If this value is 1, we
  651. try to keep the capability; if it is 0 we do not; and if it is **auto**,
  652. we keep the capability only if we are configured to listen on a low port.
  653. Can not be changed while tor is running.
  654. (Default: auto.)
  655. [[HardwareAccel]] **HardwareAccel** **0**|**1**::
  656. If non-zero, try to use built-in (static) crypto hardware acceleration when
  657. available. Can not be changed while tor is running. (Default: 0)
  658. [[AccelName]] **AccelName** __NAME__::
  659. When using OpenSSL hardware crypto acceleration attempt to load the dynamic
  660. engine of this name. This must be used for any dynamic hardware engine.
  661. Names can be verified with the openssl engine command. Can not be changed
  662. while tor is running.
  663. [[AccelDir]] **AccelDir** __DIR__::
  664. Specify this option if using dynamic hardware acceleration and the engine
  665. implementation library resides somewhere other than the OpenSSL default.
  666. Can not be changed while tor is running.
  667. [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
  668. If non-zero, try to write to disk less frequently than we would otherwise.
  669. This is useful when running on flash memory or other media that support
  670. only a limited number of writes. (Default: 0)
  671. [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM__::
  672. If this value is set, we override the default algorithm for choosing which
  673. circuit's cell to deliver or relay next. It is delivered first to the
  674. circuit that has the lowest weighted cell count, where cells are weighted
  675. exponentially according to this value (in seconds). If the value is -1, it
  676. is taken from the consensus if possible else it will fallback to the
  677. default value of 30. Minimum: 1, Maximum: 2147483647. This can be defined
  678. as a float value. This is an advanced option; you generally shouldn't have
  679. to mess with it. (Default: -1)
  680. [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
  681. If this option is set, then Tor's rate-limiting applies not only to
  682. remote connections, but also to connections to private addresses like
  683. 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
  684. rate-limiting. (Default: 0)
  685. [[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**::
  686. If this option is set to 1, we always try to include a relay's Ed25519 ID
  687. when telling the proceeding relay in a circuit to extend to it.
  688. If this option is set to 0, we never include Ed25519 IDs when extending
  689. circuits. If the option is set to "default", we obey a
  690. parameter in the consensus document. (Default: auto)
  691. [[NoExec]] **NoExec** **0**|**1**::
  692. If this option is set to 1, then Tor will never launch another
  693. executable, regardless of the settings of ClientTransportPlugin
  694. or ServerTransportPlugin. Once this option has been set to 1,
  695. it cannot be set back to 0 without restarting Tor. (Default: 0)
  696. [[Schedulers]] **Schedulers** **KIST**|**KISTLite**|**Vanilla**::
  697. Specify the scheduler type that tor should use. The scheduler is
  698. responsible for moving data around within a Tor process. This is an ordered
  699. list by priority which means that the first value will be tried first and if
  700. unavailable, the second one is tried and so on. It is possible to change
  701. these values at runtime. This option mostly effects relays, and most
  702. operators should leave it set to its default value.
  703. (Default: KIST,KISTLite,Vanilla)
  704. +
  705. The possible scheduler types are:
  706. +
  707. **KIST**: Kernel-Informed Socket Transport. Tor will use TCP information
  708. from the kernel to make informed decisions regarding how much data to send
  709. and when to send it. KIST also handles traffic in batches (see
  710. KISTSchedRunInterval) in order to improve traffic prioritization decisions.
  711. As implemented, KIST will only work on Linux kernel version 2.6.39 or
  712. higher.
  713. +
  714. **KISTLite**: Same as KIST but without kernel support. Tor will use all
  715. the same mechanics as with KIST, including the batching, but its decisions
  716. regarding how much data to send will not be as good. KISTLite will work on
  717. all kernels and operating systems, and the majority of the benefits of KIST
  718. are still realized with KISTLite.
  719. +
  720. **Vanilla**: The scheduler that Tor used before KIST was implemented. It
  721. sends as much data as possible, as soon as possible. Vanilla will work on
  722. all kernels and operating systems.
  723. [[KISTSchedRunInterval]] **KISTSchedRunInterval** __NUM__ **msec**::
  724. If KIST or KISTLite is used in the Schedulers option, this controls at which
  725. interval the scheduler tick is. If the value is 0 msec, the value is taken
  726. from the consensus if possible else it will fallback to the default 10
  727. msec. Maximum possible value is 100 msec. (Default: 0 msec)
  728. [[KISTSockBufSizeFactor]] **KISTSockBufSizeFactor** __NUM__::
  729. If KIST is used in Schedulers, this is a multiplier of the per-socket
  730. limit calculation of the KIST algorithm. (Default: 1.0)
  731. CLIENT OPTIONS
  732. --------------
  733. The following options are useful only for clients (that is, if
  734. **SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**, or
  735. **NATDPort** is non-zero):
  736. [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
  737. When set along with UseBridges, instructs Tor to use the relay at
  738. "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
  739. is provided (using the same format as for DirAuthority), we will verify that
  740. the relay running at that location has the right fingerprint. We also use
  741. fingerprint to look up the bridge descriptor at the bridge authority, if
  742. it's provided and if UpdateBridgesFromAuthority is set too. +
  743. +
  744. If "transport" is provided, it must match a ClientTransportPlugin line. We
  745. then use that pluggable transport's proxy to transfer data to the bridge,
  746. rather than connecting to the bridge directly. Some transports use a
  747. transport-specific method to work out the remote address to connect to.
  748. These transports typically ignore the "IP:ORPort" specified in the bridge
  749. line. +
  750. +
  751. Tor passes any "key=val" settings to the pluggable transport proxy as
  752. per-connection arguments when connecting to the bridge. Consult
  753. the documentation of the pluggable transport for details of what
  754. arguments it supports.
  755. [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
  756. If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
  757. [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
  758. Try for at most NUM seconds when building circuits. If the circuit isn't
  759. open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
  760. value serves as the initial value to use before a timeout is learned. If
  761. LearnCircuitBuildTimeout is 0, this value is the only value used.
  762. (Default: 60 seconds)
  763. [[CircuitsAvailableTimeout]] **CircuitsAvailableTimeout** __NUM__::
  764. Tor will attempt to keep at least one open, unused circuit available for
  765. this amount of time. This option governs how long idle circuits are kept
  766. open, as well as the amount of time Tor will keep a circuit open to each
  767. of the recently used ports. This way when the Tor client is entirely
  768. idle, it can expire all of its circuits, and then expire its TLS
  769. connections. Note that the actual timeout value is uniformly randomized
  770. from the specified value to twice that amount. (Default: 30 minutes;
  771. Max: 24 hours)
  772. [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
  773. If non-zero, this option overrides our internal timeout schedule for how
  774. many seconds until we detach a stream from a circuit and try a new circuit.
  775. If your network is particularly slow, you might want to set this to a
  776. number like 60. (Default: 0)
  777. [[ClientOnly]] **ClientOnly** **0**|**1**::
  778. If set to 1, Tor will not run as a relay or serve
  779. directory requests, even if the ORPort, ExtORPort, or DirPort options are
  780. set. (This config option is
  781. mostly unnecessary: we added it back when we were considering having
  782. Tor clients auto-promote themselves to being relays if they were stable
  783. and fast enough. The current behavior is simply that Tor is a client
  784. unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
  785. [[ConnectionPadding]] **ConnectionPadding** **0**|**1**|**auto**::
  786. This option governs Tor's use of padding to defend against some forms of
  787. traffic analysis. If it is set to 'auto', Tor will send padding only
  788. if both the client and the relay support it. If it is set to 0, Tor will
  789. not send any padding cells. If it is set to 1, Tor will still send padding
  790. for client connections regardless of relay support. Only clients may set
  791. this option. This option should be offered via the UI to mobile users
  792. for use where bandwidth may be expensive.
  793. (Default: auto)
  794. [[ReducedConnectionPadding]] **ReducedConnectionPadding** **0**|**1**::
  795. If set to 1, Tor will not not hold OR connections open for very long,
  796. and will send less padding on these connections. Only clients may set
  797. this option. This option should be offered via the UI to mobile users
  798. for use where bandwidth may be expensive. (Default: 0)
  799. [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
  800. A list of identity fingerprints, country codes, and address
  801. patterns of nodes to avoid when building a circuit. Country codes are
  802. 2-letter ISO3166 codes, and must
  803. be wrapped in braces; fingerprints may be preceded by a dollar sign.
  804. (Example:
  805. ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
  806. +
  807. By default, this option is treated as a preference that Tor is allowed
  808. to override in order to keep working.
  809. For example, if you try to connect to a hidden service,
  810. but you have excluded all of the hidden service's introduction points,
  811. Tor will connect to one of them anyway. If you do not want this
  812. behavior, set the StrictNodes option (documented below). +
  813. +
  814. Note also that if you are a relay, this (and the other node selection
  815. options below) only affects your own circuits that Tor builds for you.
  816. Clients can still build circuits through you to any node. Controllers
  817. can tell Tor to build circuits through any node. +
  818. +
  819. Country codes are case-insensitive. The code "\{??}" refers to nodes whose
  820. country can't be identified. No country code, including \{??}, works if
  821. no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
  822. [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
  823. A list of identity fingerprints, country codes, and address
  824. patterns of nodes to never use when picking an exit node---that is, a
  825. node that delivers traffic for you *outside* the Tor network. Note that any
  826. node listed in ExcludeNodes is automatically considered to be part of this
  827. list too. See
  828. the **ExcludeNodes** option for more information on how to specify
  829. nodes. See also the caveats on the "ExitNodes" option below.
  830. [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
  831. If this option is set to 'auto', then whenever any country code is set in
  832. ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
  833. possibly \{A1}) are treated as excluded as well. If this option is set to
  834. '1', then all unknown countries are treated as excluded in ExcludeNodes
  835. and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
  836. configured or can't be found. (Default: auto)
  837. [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
  838. A list of identity fingerprints, country codes, and address
  839. patterns of nodes to use as exit node---that is, a
  840. node that delivers traffic for you *outside* the Tor network. See
  841. the **ExcludeNodes** option for more information on how to specify nodes. +
  842. +
  843. Note that if you list too few nodes here, or if you exclude too many exit
  844. nodes with ExcludeExitNodes, you can degrade functionality. For example,
  845. if none of the exits you list allows traffic on port 80 or 443, you won't
  846. be able to browse the web. +
  847. +
  848. Note also that not every circuit is used to deliver traffic *outside* of
  849. the Tor network. It is normal to see non-exit circuits (such as those
  850. used to connect to hidden services, those that do directory fetches,
  851. those used for relay reachability self-tests, and so on) that end
  852. at a non-exit node. To
  853. keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
  854. +
  855. The ExcludeNodes option overrides this option: any node listed in both
  856. ExitNodes and ExcludeNodes is treated as excluded. +
  857. +
  858. The .exit address notation, if enabled via MapAddress, overrides
  859. this option.
  860. [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
  861. A list of identity fingerprints and country codes of nodes
  862. to use for the first hop in your normal circuits.
  863. Normal circuits include all
  864. circuits except for direct connections to directory servers. The Bridge
  865. option overrides this option; if you have configured bridges and
  866. UseBridges is 1, the Bridges are used as your entry nodes. +
  867. +
  868. The ExcludeNodes option overrides this option: any node listed in both
  869. EntryNodes and ExcludeNodes is treated as excluded. See
  870. the **ExcludeNodes** option for more information on how to specify nodes.
  871. [[StrictNodes]] **StrictNodes** **0**|**1**::
  872. If StrictNodes is set to 1, Tor will treat solely the ExcludeNodes option
  873. as a requirement to follow for all the circuits you generate, even if
  874. doing so will break functionality for you (StrictNodes applies to neither
  875. ExcludeExitNodes nor to ExitNodes). If StrictNodes is set to 0, Tor will
  876. still try to avoid nodes in the ExcludeNodes list, but it will err on the
  877. side of avoiding unexpected errors. Specifically, StrictNodes 0 tells Tor
  878. that it is okay to use an excluded node when it is *necessary* to perform
  879. relay reachability self-tests, connect to a hidden service, provide a
  880. hidden service to a client, fulfill a .exit request, upload directory
  881. information, or download directory information. (Default: 0)
  882. [[FascistFirewall]] **FascistFirewall** **0**|**1**::
  883. If 1, Tor will only create outgoing connections to ORs running on ports
  884. that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
  885. This will allow you to run Tor as a client behind a firewall with
  886. restrictive policies, but will not allow you to run as a server behind such
  887. a firewall. If you prefer more fine-grained control, use
  888. ReachableAddresses instead.
  889. [[FirewallPorts]] **FirewallPorts** __PORTS__::
  890. A list of ports that your firewall allows you to connect to. Only used when
  891. **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
  892. instead. (Default: 80, 443)
  893. [[ReachableAddresses]] **ReachableAddresses** __IP__[/__MASK__][:__PORT__]...::
  894. A comma-separated list of IP addresses and ports that your firewall allows
  895. you to connect to. The format is as for the addresses in ExitPolicy, except
  896. that "accept" is understood unless "reject" is explicitly provided. For
  897. example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
  898. \*:80' means that your firewall allows connections to everything inside net
  899. 99, rejects port 80 connections to net 18, and accepts connections to port
  900. 80 otherwise. (Default: \'accept \*:*'.)
  901. [[ReachableDirAddresses]] **ReachableDirAddresses** __IP__[/__MASK__][:__PORT__]...::
  902. Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
  903. these restrictions when fetching directory information, using standard HTTP
  904. GET requests. If not set explicitly then the value of
  905. **ReachableAddresses** is used. If **HTTPProxy** is set then these
  906. connections will go through that proxy. (DEPRECATED: This option has
  907. had no effect for some time.)
  908. [[ReachableORAddresses]] **ReachableORAddresses** __IP__[/__MASK__][:__PORT__]...::
  909. Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
  910. these restrictions when connecting to Onion Routers, using TLS/SSL. If not
  911. set explicitly then the value of **ReachableAddresses** is used. If
  912. **HTTPSProxy** is set then these connections will go through that proxy. +
  913. +
  914. The separation between **ReachableORAddresses** and
  915. **ReachableDirAddresses** is only interesting when you are connecting
  916. through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
  917. TLS connections (which Tor uses to connect to Onion Routers) to port 443,
  918. and some limit HTTP GET requests (which Tor uses for fetching directory
  919. information) to port 80.
  920. [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
  921. Client authorization for a hidden service. Valid onion addresses contain 16
  922. characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
  923. characters in A-Za-z0-9+/. The service name is only used for internal
  924. purposes, e.g., for Tor controllers. This option may be used multiple times
  925. for different hidden services. If a hidden service uses authorization and
  926. this option is not set, the hidden service is not accessible. Hidden
  927. services can be configured to require authorization using the
  928. **HiddenServiceAuthorizeClient** option.
  929. [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
  930. A list of ports for services that tend to have long-running connections
  931. (e.g. chat and interactive shells). Circuits for streams that use these
  932. ports will contain only high-uptime nodes, to reduce the chance that a node
  933. will go down before the stream is finished. Note that the list is also
  934. honored for circuits (both client and service side) involving hidden
  935. services whose virtual port is in this list. (Default: 21, 22, 706,
  936. 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
  937. [[MapAddress]] **MapAddress** __address__ __newaddress__::
  938. When a request for address arrives to Tor, it will transform to newaddress
  939. before processing it. For example, if you always want connections to
  940. www.example.com to exit via __torserver__ (where __torserver__ is the
  941. fingerprint of the server), use "MapAddress www.example.com
  942. www.example.com.torserver.exit". If the value is prefixed with a
  943. "\*.", matches an entire domain. For example, if you
  944. always want connections to example.com and any if its subdomains
  945. to exit via
  946. __torserver__ (where __torserver__ is the fingerprint of the server), use
  947. "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
  948. leading "*." in each part of the directive.) You can also redirect all
  949. subdomains of a domain to a single address. For example, "MapAddress
  950. *.example.com www.example.com". +
  951. +
  952. NOTES:
  953. 1. When evaluating MapAddress expressions Tor stops when it hits the most
  954. recently added expression that matches the requested address. So if you
  955. have the following in your torrc, www.torproject.org will map to 1.1.1.1:
  956. MapAddress www.torproject.org 2.2.2.2
  957. MapAddress www.torproject.org 1.1.1.1
  958. 2. Tor evaluates the MapAddress configuration until it finds no matches. So
  959. if you have the following in your torrc, www.torproject.org will map to
  960. 2.2.2.2:
  961. MapAddress 1.1.1.1 2.2.2.2
  962. MapAddress www.torproject.org 1.1.1.1
  963. 3. The following MapAddress expression is invalid (and will be
  964. ignored) because you cannot map from a specific address to a wildcard
  965. address:
  966. MapAddress www.torproject.org *.torproject.org.torserver.exit
  967. 4. Using a wildcard to match only part of a string (as in *ample.com) is
  968. also invalid.
  969. [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
  970. Every NUM seconds consider whether to build a new circuit. (Default: 30
  971. seconds)
  972. [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
  973. Feel free to reuse a circuit that was first used at most NUM seconds ago,
  974. but never attach a new stream to a circuit that is too old. For hidden
  975. services, this applies to the __last__ time a circuit was used, not the
  976. first. Circuits with streams constructed with SOCKS authentication via
  977. SocksPorts that have **KeepAliveIsolateSOCKSAuth** also remain alive
  978. for MaxCircuitDirtiness seconds after carrying the last such stream.
  979. (Default: 10 minutes)
  980. [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
  981. Do not allow more than NUM circuits to be pending at a time for handling
  982. client streams. A circuit is pending if we have begun constructing it,
  983. but it has not yet been completely constructed. (Default: 32)
  984. [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
  985. The Tor servers, defined by their identity fingerprints,
  986. constitute a "family" of similar or co-administered servers, so never use
  987. any two of them in the same circuit. Defining a NodeFamily is only needed
  988. when a server doesn't list the family itself (with MyFamily). This option
  989. can be used multiple times; each instance defines a separate family. In
  990. addition to nodes, you can also list IP address and ranges and country
  991. codes in {curly braces}. See the **ExcludeNodes** option for more
  992. information on how to specify nodes.
  993. [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
  994. If 1, Tor will not put two servers whose IP addresses are "too close" on
  995. the same circuit. Currently, two addresses are "too close" if they lie in
  996. the same /16 range. (Default: 1)
  997. [[SocksPort]] **SocksPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
  998. Open this port to listen for connections from SOCKS-speaking
  999. applications. Set this to 0 if you don't want to allow application
  1000. connections via SOCKS. Set it to "auto" to have Tor pick a port for
  1001. you. This directive can be specified multiple times to bind
  1002. to multiple addresses/ports. If a unix domain socket is used, you may
  1003. quote the path using standard C escape sequences.
  1004. (Default: 9050) +
  1005. +
  1006. NOTE: Although this option allows you to specify an IP address
  1007. other than localhost, you should do so only with extreme caution.
  1008. The SOCKS protocol is unencrypted and (as we use it)
  1009. unauthenticated, so exposing it in this way could leak your
  1010. information to anybody watching your network, and allow anybody
  1011. to use your computer as an open proxy. +
  1012. +
  1013. The _isolation flags_ arguments give Tor rules for which streams
  1014. received on this SocksPort are allowed to share circuits with one
  1015. another. Recognized isolation flags are:
  1016. **IsolateClientAddr**;;
  1017. Don't share circuits with streams from a different
  1018. client address. (On by default and strongly recommended when
  1019. supported; you can disable it with **NoIsolateClientAddr**.
  1020. Unsupported and force-disabled when using Unix domain sockets.)
  1021. **IsolateSOCKSAuth**;;
  1022. Don't share circuits with streams for which different
  1023. SOCKS authentication was provided. (For HTTPTunnelPort
  1024. connections, this option looks at the Proxy-Authorization and
  1025. X-Tor-Stream-Isolation headers. On by default;
  1026. you can disable it with **NoIsolateSOCKSAuth**.)
  1027. **IsolateClientProtocol**;;
  1028. Don't share circuits with streams using a different protocol.
  1029. (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
  1030. and DNSPort requests are all considered to be different protocols.)
  1031. **IsolateDestPort**;;
  1032. Don't share circuits with streams targeting a different
  1033. destination port.
  1034. **IsolateDestAddr**;;
  1035. Don't share circuits with streams targeting a different
  1036. destination address.
  1037. **KeepAliveIsolateSOCKSAuth**;;
  1038. If **IsolateSOCKSAuth** is enabled, keep alive circuits while they have
  1039. at least one stream with SOCKS authentication active. After such a circuit
  1040. is idle for more than MaxCircuitDirtiness seconds, it can be closed.
  1041. **SessionGroup=**__INT__;;
  1042. If no other isolation rules would prevent it, allow streams
  1043. on this port to share circuits with streams from every other
  1044. port with the same session group. (By default, streams received
  1045. on different SocksPorts, TransPorts, etc are always isolated from one
  1046. another. This option overrides that behavior.)
  1047. // Anchor only for formatting, not visible in the man page.
  1048. [[OtherSocksPortFlags]]::
  1049. Other recognized __flags__ for a SocksPort are:
  1050. **NoIPv4Traffic**;;
  1051. Tell exits to not connect to IPv4 addresses in response to SOCKS
  1052. requests on this connection.
  1053. **IPv6Traffic**;;
  1054. Tell exits to allow IPv6 addresses in response to SOCKS requests on
  1055. this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
  1056. IPv6.)
  1057. **PreferIPv6**;;
  1058. Tells exits that, if a host has both an IPv4 and an IPv6 address,
  1059. we would prefer to connect to it via IPv6. (IPv4 is the default.)
  1060. **NoDNSRequest**;;
  1061. Do not ask exits to resolve DNS addresses in SOCKS5 requests. Tor will
  1062. connect to IPv4 addresses, IPv6 addresses (if IPv6Traffic is set) and
  1063. .onion addresses.
  1064. **NoOnionTraffic**;;
  1065. Do not connect to .onion addresses in SOCKS5 requests.
  1066. **OnionTrafficOnly**;;
  1067. Tell the tor client to only connect to .onion addresses in response to
  1068. SOCKS5 requests on this connection. This is equivalent to NoDNSRequest,
  1069. NoIPv4Traffic, NoIPv6Traffic. The corresponding NoOnionTrafficOnly
  1070. flag is not supported.
  1071. **CacheIPv4DNS**;;
  1072. Tells the client to remember IPv4 DNS answers we receive from exit
  1073. nodes via this connection. (On by default.)
  1074. **CacheIPv6DNS**;;
  1075. Tells the client to remember IPv6 DNS answers we receive from exit
  1076. nodes via this connection.
  1077. **GroupWritable**;;
  1078. Unix domain sockets only: makes the socket get created as
  1079. group-writable.
  1080. **WorldWritable**;;
  1081. Unix domain sockets only: makes the socket get created as
  1082. world-writable.
  1083. **CacheDNS**;;
  1084. Tells the client to remember all DNS answers we receive from exit
  1085. nodes via this connection.
  1086. **UseIPv4Cache**;;
  1087. Tells the client to use any cached IPv4 DNS answers we have when making
  1088. requests via this connection. (NOTE: This option, or UseIPv6Cache
  1089. or UseDNSCache, can harm your anonymity, and probably
  1090. won't help performance as much as you might expect. Use with care!)
  1091. **UseIPv6Cache**;;
  1092. Tells the client to use any cached IPv6 DNS answers we have when making
  1093. requests via this connection.
  1094. **UseDNSCache**;;
  1095. Tells the client to use any cached DNS answers we have when making
  1096. requests via this connection.
  1097. **PreferIPv6Automap**;;
  1098. When serving a hostname lookup request on this port that
  1099. should get automapped (according to AutomapHostsOnResolve),
  1100. if we could return either an IPv4 or an IPv6 answer, prefer
  1101. an IPv6 answer. (On by default.)
  1102. **PreferSOCKSNoAuth**;;
  1103. Ordinarily, when an application offers both "username/password
  1104. authentication" and "no authentication" to Tor via SOCKS5, Tor
  1105. selects username/password authentication so that IsolateSOCKSAuth can
  1106. work. This can confuse some applications, if they offer a
  1107. username/password combination then get confused when asked for
  1108. one. You can disable this behavior, so that Tor will select "No
  1109. authentication" when IsolateSOCKSAuth is disabled, or when this
  1110. option is set.
  1111. // Anchor only for formatting, not visible in the man page.
  1112. [[SocksPortFlagsMisc]]::
  1113. Flags are processed left to right. If flags conflict, the last flag on the
  1114. line is used, and all earlier flags are ignored. No error is issued for
  1115. conflicting flags.
  1116. [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
  1117. Set an entrance policy for this server, to limit who can connect to the
  1118. SocksPort and DNSPort ports. The policies have the same form as exit
  1119. policies below, except that port specifiers are ignored. Any address
  1120. not matched by some entry in the policy is accepted.
  1121. [[SocksTimeout]] **SocksTimeout** __NUM__::
  1122. Let a socks connection wait NUM seconds handshaking, and NUM seconds
  1123. unattached waiting for an appropriate circuit, before we fail it. (Default:
  1124. 2 minutes)
  1125. [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
  1126. Set the refill interval of Tor's token bucket to NUM milliseconds.
  1127. NUM must be between 1 and 1000, inclusive. Note that the configured
  1128. bandwidth limits are still expressed in bytes per second: this
  1129. option only affects the frequency with which Tor checks to see whether
  1130. previously exhausted connections may read again.
  1131. Can not be changed while tor is running. (Default: 100 msec)
  1132. [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
  1133. For each value in the comma separated list, Tor will track recent
  1134. connections to hosts that match this value and attempt to reuse the same
  1135. exit node for each. If the value is prepended with a \'.\', it is treated as
  1136. matching an entire domain. If one of the values is just a \'.', it means
  1137. match everything. This option is useful if you frequently connect to sites
  1138. that will expire all your authentication cookies (i.e. log you out) if
  1139. your IP address changes. Note that this option does have the disadvantage
  1140. of making it more clear that a given history is associated with a single
  1141. user. However, most people who would wish to observe this will observe it
  1142. through cookies or other protocol-specific means anyhow.
  1143. [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
  1144. Since exit servers go up and down, it is desirable to expire the
  1145. association between host and exit server after NUM seconds. The default is
  1146. 1800 seconds (30 minutes).
  1147. [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
  1148. When set (along with UseBridges), Tor will try to fetch bridge descriptors
  1149. from the configured bridge authorities when feasible. It will fall back to
  1150. a direct request if the authority responds with a 404. (Default: 0)
  1151. [[UseBridges]] **UseBridges** **0**|**1**::
  1152. When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
  1153. config lines, and use these relays as both entry guards and directory
  1154. guards. (Default: 0)
  1155. [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
  1156. If this option is set to 1, we pick a few long-term entry servers, and try
  1157. to stick with them. This is desirable because constantly changing servers
  1158. increases the odds that an adversary who owns some servers will observe a
  1159. fraction of your paths. Entry Guards can not be used by Directory
  1160. Authorities, Single Onion Services, and Tor2web clients. In these cases,
  1161. the this option is ignored. (Default: 1)
  1162. [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
  1163. V3 authoritative directories only. Configures the location of the
  1164. guardfraction file which contains information about how long relays
  1165. have been guards. (Default: unset)
  1166. [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
  1167. This torrc option specifies whether clients should use the
  1168. guardfraction information found in the consensus during path
  1169. selection. If it's set to 'auto', clients will do what the
  1170. UseGuardFraction consensus parameter tells them to do. (Default: auto)
  1171. [[NumEntryGuards]] **NumEntryGuards** __NUM__::
  1172. If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
  1173. as long-term entries for our circuits. If NUM is 0, we try to learn the
  1174. number from the guard-n-primary-guards-to-use consensus parameter, and
  1175. default to 1 if the consensus parameter isn't set. (Default: 0)
  1176. [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
  1177. If UseEntryGuards is set to 1, we try to make sure we have at least NUM
  1178. routers to use as directory guards. If this option is set to 0, use the
  1179. value from the guard-n-primary-dir-guards-to-use consensus parameter, and
  1180. default to 3 if the consensus parameter isn't set. (Default: 0)
  1181. [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
  1182. If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
  1183. picking a new one. If zero, we use the GuardLifetime parameter from the
  1184. consensus directory. No value here may be less than 1 month or greater
  1185. than 5 years; out-of-range values are clamped. (Default: 0)
  1186. [[SafeSocks]] **SafeSocks** **0**|**1**::
  1187. When this option is enabled, Tor will reject application connections that
  1188. use unsafe variants of the socks protocol -- ones that only provide an IP
  1189. address, meaning the application is doing a DNS resolve first.
  1190. Specifically, these are socks4 and socks5 when not doing remote DNS.
  1191. (Default: 0)
  1192. [[TestSocks]] **TestSocks** **0**|**1**::
  1193. When this option is enabled, Tor will make a notice-level log entry for
  1194. each connection to the Socks port indicating whether the request used a
  1195. safe socks protocol or an unsafe one (see above entry on SafeSocks). This
  1196. helps to determine whether an application using Tor is possibly leaking
  1197. DNS requests. (Default: 0)
  1198. [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __IPv4Address__/__bits__ +
  1199. [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__IPv6Address__]/__bits__::
  1200. When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
  1201. command from the controller or the AutomapHostsOnResolve feature, Tor
  1202. picks an unassigned address from this range. (Defaults:
  1203. 127.192.0.0/10 and [FE80::]/10 respectively.) +
  1204. +
  1205. When providing proxy server service to a network of computers using a tool
  1206. like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
  1207. "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7".
  1208. The default **VirtualAddrNetwork** address ranges on a
  1209. properly configured machine will route to the loopback or link-local
  1210. interface. The maximum number of bits for the network prefix is set to 104
  1211. for IPv6 and 16 for IPv4. However, a wider network - smaller prefix length
  1212. - is preferable since it reduces the chances for an attacker to guess the
  1213. used IP. For local use, no change to the default VirtualAddrNetwork setting
  1214. is needed.
  1215. [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
  1216. When this option is disabled, Tor blocks hostnames containing illegal
  1217. characters (like @ and :) rather than sending them to an exit node to be
  1218. resolved. This helps trap accidental attempts to resolve URLs and so on.
  1219. (Default: 0)
  1220. [[HTTPTunnelPort]] **HTTPTunnelPort** \['address':]__port__|**auto** [_isolation flags_]::
  1221. Open this port to listen for proxy connections using the "HTTP CONNECT"
  1222. protocol instead of SOCKS. Set this to
  1223. 0 if you don't want to allow "HTTP CONNECT" connections. Set the port
  1224. to "auto" to have Tor pick a port for you. This directive can be
  1225. specified multiple times to bind to multiple addresses/ports. See
  1226. SOCKSPort for an explanation of isolation flags. (Default: 0)
  1227. [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
  1228. Open this port to listen for transparent proxy connections. Set this to
  1229. 0 if you don't want to allow transparent proxy connections. Set the port
  1230. to "auto" to have Tor pick a port for you. This directive can be
  1231. specified multiple times to bind to multiple addresses/ports. See
  1232. SOCKSPort for an explanation of isolation flags. +
  1233. +
  1234. TransPort requires OS support for transparent proxies, such as BSDs' pf or
  1235. Linux's IPTables. If you're planning to use Tor as a transparent proxy for
  1236. a network, you'll want to examine and change VirtualAddrNetwork from the
  1237. default setting. (Default: 0)
  1238. [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
  1239. TransProxyType may only be enabled when there is transparent proxy listener
  1240. enabled. +
  1241. +
  1242. Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
  1243. to transparently proxy connections that are configured using the TransPort
  1244. option. Detailed information on how to configure the TPROXY
  1245. feature can be found in the Linux kernel source tree in the file
  1246. Documentation/networking/tproxy.txt. +
  1247. +
  1248. Set this option to "ipfw" to use the FreeBSD ipfw interface. +
  1249. +
  1250. On *BSD operating systems when using pf, set this to "pf-divert" to take
  1251. advantage of +divert-to+ rules, which do not modify the packets like
  1252. +rdr-to+ rules do. Detailed information on how to configure pf to use
  1253. +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
  1254. +divert-to+ is available to use on versions greater than or equal to
  1255. OpenBSD 4.4. +
  1256. +
  1257. Set this to "default", or leave it unconfigured, to use regular IPTables
  1258. on Linux, or to use pf +rdr-to+ rules on *BSD systems. +
  1259. +
  1260. (Default: "default")
  1261. [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
  1262. Open this port to listen for connections from old versions of ipfw (as
  1263. included in old versions of FreeBSD, etc) using the NATD protocol.
  1264. Use 0 if you don't want to allow NATD connections. Set the port
  1265. to "auto" to have Tor pick a port for you. This directive can be
  1266. specified multiple times to bind to multiple addresses/ports. See
  1267. SocksPort for an explanation of isolation flags. +
  1268. +
  1269. This option is only for people who cannot use TransPort. (Default: 0)
  1270. [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
  1271. When this option is enabled, and we get a request to resolve an address
  1272. that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
  1273. unused virtual address to that address, and return the new virtual address.
  1274. This is handy for making ".onion" addresses work with applications that
  1275. resolve an address and then connect to it. (Default: 0)
  1276. [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
  1277. A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
  1278. The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
  1279. [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
  1280. If non-zero, open this port to listen for UDP DNS requests, and resolve
  1281. them anonymously. This port only handles A, AAAA, and PTR requests---it
  1282. doesn't handle arbitrary DNS request types. Set the port to "auto" to
  1283. have Tor pick a port for
  1284. you. This directive can be specified multiple times to bind to multiple
  1285. addresses/ports. See SocksPort for an explanation of isolation
  1286. flags. (Default: 0)
  1287. [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
  1288. If true, Tor does not believe any anonymously retrieved DNS answer that
  1289. tells it that an address resolves to an internal address (like 127.0.0.1 or
  1290. 192.168.0.1). This option prevents certain browser-based attacks; it
  1291. is not allowed to be set on the default network. (Default: 1)
  1292. [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
  1293. If true, Tor does not try to fulfill requests to connect to an internal
  1294. address (like 127.0.0.1 or 192.168.0.1) __unless an exit node is
  1295. specifically requested__ (for example, via a .exit hostname, or a
  1296. controller request). If true, multicast DNS hostnames for machines on the
  1297. local network (of the form *.local) are also rejected. (Default: 1)
  1298. [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
  1299. If true, Tor downloads and caches "extra-info" documents. These documents
  1300. contain information about servers other than the information in their
  1301. regular server descriptors. Tor does not use this information for anything
  1302. itself; to save bandwidth, leave this option turned off. (Default: 0)
  1303. [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
  1304. Tells Tor to issue a warnings whenever the user tries to make an anonymous
  1305. connection to one of these ports. This option is designed to alert users
  1306. to services that risk sending passwords in the clear. (Default:
  1307. 23,109,110,143)
  1308. [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
  1309. Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
  1310. will instead refuse to make the connection. (Default: None)
  1311. [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
  1312. When this option is set, and Tor is using an exit node that supports
  1313. the feature, it will try optimistically to send data to the exit node
  1314. without waiting for the exit node to report whether the connection
  1315. succeeded. This can save a round-trip time for protocols like HTTP
  1316. where the client talks first. If OptimisticData is set to **auto**,
  1317. Tor will look at the UseOptimisticData parameter in the networkstatus.
  1318. (Default: auto)
  1319. [[Tor2webMode]] **Tor2webMode** **0**|**1**::
  1320. When this option is set, Tor connects to hidden services
  1321. **non-anonymously**. This option also disables client connections to
  1322. non-hidden-service hostnames through Tor. It **must only** be used when
  1323. running a tor2web Hidden Service web proxy.
  1324. To enable this option the compile time flag --enable-tor2web-mode must be
  1325. specified. Since Tor2webMode is non-anonymous, you can not run an
  1326. anonymous Hidden Service on a tor version compiled with Tor2webMode.
  1327. (Default: 0)
  1328. [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
  1329. A list of identity fingerprints, nicknames, country codes and
  1330. address patterns of nodes that are allowed to be used as RPs
  1331. in HS circuits; any other nodes will not be used as RPs.
  1332. (Example:
  1333. Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
  1334. +
  1335. This feature can only be used if Tor2webMode is also enabled. +
  1336. +
  1337. ExcludeNodes have higher priority than Tor2webRendezvousPoints,
  1338. which means that nodes specified in ExcludeNodes will not be
  1339. picked as RPs. +
  1340. +
  1341. If no nodes in Tor2webRendezvousPoints are currently available for
  1342. use, Tor will choose a random node when building HS circuits.
  1343. [[HSLayer2Nodes]] **HSLayer2Nodes** __node__,__node__,__...__::
  1344. A list of identity fingerprints, nicknames, country codes, and
  1345. address patterns of nodes that are allowed to be used as the
  1346. second hop in all client or service-side Onion Service circuits.
  1347. This option mitigates attacks where the adversary runs middle nodes
  1348. and induces your client or service to create many circuits, in order
  1349. to discover your primary guard node.
  1350. (Default: Any node in the network may be used in the second hop.)
  1351. +
  1352. (Example:
  1353. HSLayer2Nodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
  1354. +
  1355. When this is set, the resulting hidden service paths will
  1356. look like:
  1357. +
  1358. C - G - L2 - M - Rend +
  1359. C - G - L2 - M - HSDir +
  1360. C - G - L2 - M - Intro +
  1361. S - G - L2 - M - Rend +
  1362. S - G - L2 - M - HSDir +
  1363. S - G - L2 - M - Intro +
  1364. +
  1365. where C is this client, S is the service, G is the Guard node,
  1366. L2 is a node from this option, and M is a random middle node.
  1367. Rend, HSDir, and Intro point selection is not affected by this
  1368. option.
  1369. +
  1370. This option may be combined with HSLayer3Nodes to create
  1371. paths of the form:
  1372. +
  1373. C - G - L2 - L3 - Rend +
  1374. C - G - L2 - L3 - M - HSDir +
  1375. C - G - L2 - L3 - M - Intro +
  1376. S - G - L2 - L3 - M - Rend +
  1377. S - G - L2 - L3 - HSDir +
  1378. S - G - L2 - L3 - Intro +
  1379. +
  1380. ExcludeNodes have higher priority than HSLayer2Nodes,
  1381. which means that nodes specified in ExcludeNodes will not be
  1382. picked.
  1383. +
  1384. This option is meant to be managed by a Tor controller such as
  1385. https://github.com/mikeperry-tor/vanguards that selects and
  1386. updates this set of nodes for you. Hence it does not do load
  1387. balancing if fewer than 20 nodes are selected, and if no nodes in
  1388. HSLayer2Nodes are currently available for use, Tor will not work.
  1389. Please use extreme care if you are setting this option manually.
  1390. [[HSLayer3Nodes]] **HSLayer3Nodes** __node__,__node__,__...__::
  1391. A list of identity fingerprints, nicknames, country codes, and
  1392. address patterns of nodes that are allowed to be used as the
  1393. third hop in all client and service-side Onion Service circuits.
  1394. This option mitigates attacks where the adversary runs middle nodes
  1395. and induces your client or service to create many circuits, in order
  1396. to discover your primary or Layer2 guard nodes.
  1397. (Default: Any node in the network may be used in the third hop.)
  1398. +
  1399. (Example:
  1400. HSLayer3Nodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
  1401. +
  1402. When this is set by itself, the resulting hidden service paths
  1403. will look like: +
  1404. C - G - M - L3 - Rend +
  1405. C - G - M - L3 - M - HSDir +
  1406. C - G - M - L3 - M - Intro +
  1407. S - G - M - L3 - M - Rend +
  1408. S - G - M - L3 - HSDir +
  1409. S - G - M - L3 - Intro +
  1410. where C is this client, S is the service, G is the Guard node,
  1411. L2 is a node from this option, and M is a random middle node.
  1412. Rend, HSDir, and Intro point selection is not affected by this
  1413. option.
  1414. +
  1415. While it is possible to use this option by itself, it should be
  1416. combined with HSLayer2Nodes to create paths of the form:
  1417. +
  1418. C - G - L2 - L3 - Rend +
  1419. C - G - L2 - L3 - M - HSDir +
  1420. C - G - L2 - L3 - M - Intro +
  1421. S - G - L2 - L3 - M - Rend +
  1422. S - G - L2 - L3 - HSDir +
  1423. S - G - L2 - L3 - Intro +
  1424. +
  1425. ExcludeNodes have higher priority than HSLayer3Nodes,
  1426. which means that nodes specified in ExcludeNodes will not be
  1427. picked.
  1428. +
  1429. This option is meant to be managed by a Tor controller such as
  1430. https://github.com/mikeperry-tor/vanguards that selects and
  1431. updates this set of nodes for you. Hence it does not do load
  1432. balancing if fewer than 20 nodes are selected, and if no nodes in
  1433. HSLayer3Nodes are currently available for use, Tor will not work.
  1434. Please use extreme care if you are setting this option manually.
  1435. [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
  1436. Microdescriptors are a smaller version of the information that Tor needs
  1437. in order to build its circuits. Using microdescriptors makes Tor clients
  1438. download less directory information, thus saving bandwidth. Directory
  1439. caches need to fetch regular descriptors and microdescriptors, so this
  1440. option doesn't save any bandwidth for them. If this option is set to
  1441. "auto" (recommended) then it is on for all clients that do not set
  1442. FetchUselessDescriptors. (Default: auto)
  1443. [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
  1444. [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
  1445. [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
  1446. [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
  1447. [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
  1448. [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
  1449. These options override the default behavior of Tor's (**currently
  1450. experimental**) path bias detection algorithm. To try to find broken or
  1451. misbehaving guard nodes, Tor looks for nodes where more than a certain
  1452. fraction of circuits through that guard fail to get built. +
  1453. +
  1454. The PathBiasCircThreshold option controls how many circuits we need to build
  1455. through a guard before we make these checks. The PathBiasNoticeRate,
  1456. PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
  1457. circuits must succeed through a guard so we won't write log messages.
  1458. If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
  1459. is set to 1, we disable use of that guard. +
  1460. +
  1461. When we have seen more than PathBiasScaleThreshold
  1462. circuits through a guard, we scale our observations by 0.5 (governed by
  1463. the consensus) so that new observations don't get swamped by old ones. +
  1464. +
  1465. By default, or if a negative value is provided for one of these options,
  1466. Tor uses reasonable defaults from the networkstatus consensus document.
  1467. If no defaults are available there, these options default to 150, .70,
  1468. .50, .30, 0, and 300 respectively.
  1469. [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
  1470. [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
  1471. [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
  1472. [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
  1473. Similar to the above options, these options override the default behavior
  1474. of Tor's (**currently experimental**) path use bias detection algorithm. +
  1475. +
  1476. Where as the path bias parameters govern thresholds for successfully
  1477. building circuits, these four path use bias parameters govern thresholds
  1478. only for circuit usage. Circuits which receive no stream usage
  1479. are not counted by this detection algorithm. A used circuit is considered
  1480. successful if it is capable of carrying streams or otherwise receiving
  1481. well-formed responses to RELAY cells. +
  1482. +
  1483. By default, or if a negative value is provided for one of these options,
  1484. Tor uses reasonable defaults from the networkstatus consensus document.
  1485. If no defaults are available there, these options default to 20, .80,
  1486. .60, and 100, respectively.
  1487. [[ClientUseIPv4]] **ClientUseIPv4** **0**|**1**::
  1488. If this option is set to 0, Tor will avoid connecting to directory servers
  1489. and entry nodes over IPv4. Note that clients with an IPv4
  1490. address in a **Bridge**, proxy, or pluggable transport line will try
  1491. connecting over IPv4 even if **ClientUseIPv4** is set to 0. (Default: 1)
  1492. [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
  1493. If this option is set to 1, Tor might connect to directory servers or
  1494. entry nodes over IPv6. Note that clients configured with an IPv6 address
  1495. in a **Bridge**, proxy, or pluggable transport line will try connecting
  1496. over IPv6 even if **ClientUseIPv6** is set to 0. (Default: 0)
  1497. [[ClientPreferIPv6DirPort]] **ClientPreferIPv6DirPort** **0**|**1**|**auto**::
  1498. If this option is set to 1, Tor prefers a directory port with an IPv6
  1499. address over one with IPv4, for direct connections, if a given directory
  1500. server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to
  1501. 0.) If this option is set to auto, clients prefer IPv4. Other things may
  1502. influence the choice. This option breaks a tie to the favor of IPv6.
  1503. (Default: auto) (DEPRECATED: This option has had no effect for some
  1504. time.)
  1505. [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**|**auto**::
  1506. If this option is set to 1, Tor prefers an OR port with an IPv6
  1507. address over one with IPv4 if a given entry node has both. (Tor also
  1508. prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set
  1509. to auto, Tor bridge clients prefer the configured bridge address, and
  1510. other clients prefer IPv4. Other things may influence the choice. This
  1511. option breaks a tie to the favor of IPv6. (Default: auto)
  1512. [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
  1513. Tor clients don't build circuits for user traffic until they know
  1514. about enough of the network so that they could potentially construct
  1515. enough of the possible paths through the network. If this option
  1516. is set to a fraction between 0.25 and 0.95, Tor won't build circuits
  1517. until it has enough descriptors or microdescriptors to construct
  1518. that fraction of possible paths. Note that setting this option too low
  1519. can make your Tor client less anonymous, and setting it too high can
  1520. prevent your Tor client from bootstrapping. If this option is negative,
  1521. Tor will use a default value chosen by the directory authorities. If the
  1522. directory authorities do not choose a value, Tor will default to 0.6.
  1523. (Default: -1)
  1524. [[ClientBootstrapConsensusAuthorityDownloadSchedule]] **ClientBootstrapConsensusAuthorityDownloadSchedule** __N__,__N__,__...__::
  1525. Schedule for when clients should download consensuses from authorities
  1526. if they are bootstrapping (that is, they don't have a usable, reasonably
  1527. live consensus). Only used by clients fetching from a list of fallback
  1528. directory mirrors. This schedule is advanced by (potentially concurrent)
  1529. connection attempts, unlike other schedules, which are advanced by
  1530. connection failures. (Default: 6, 11, 3600, 10800, 25200, 54000, 111600,
  1531. 262800)
  1532. [[ClientBootstrapConsensusFallbackDownloadSchedule]] **ClientBootstrapConsensusFallbackDownloadSchedule** __N__,__N__,__...__::
  1533. Schedule for when clients should download consensuses from fallback
  1534. directory mirrors if they are bootstrapping (that is, they don't have a
  1535. usable, reasonably live consensus). Only used by clients fetching from a
  1536. list of fallback directory mirrors. This schedule is advanced by
  1537. (potentially concurrent) connection attempts, unlike other schedules,
  1538. which are advanced by connection failures. (Default: 0, 1, 4, 11, 3600,
  1539. 10800, 25200, 54000, 111600, 262800)
  1540. [[ClientBootstrapConsensusAuthorityOnlyDownloadSchedule]] **ClientBootstrapConsensusAuthorityOnlyDownloadSchedule** __N__,__N__,__...__::
  1541. Schedule for when clients should download consensuses from authorities
  1542. if they are bootstrapping (that is, they don't have a usable, reasonably
  1543. live consensus). Only used by clients which don't have or won't fetch
  1544. from a list of fallback directory mirrors. This schedule is advanced by
  1545. (potentially concurrent) connection attempts, unlike other schedules,
  1546. which are advanced by connection failures. (Default: 0, 3, 7, 3600,
  1547. 10800, 25200, 54000, 111600, 262800)
  1548. [[ClientBootstrapConsensusMaxInProgressTries]] **ClientBootstrapConsensusMaxInProgressTries** __NUM__::
  1549. Try this many simultaneous connections to download a consensus before
  1550. waiting for one to complete, timeout, or error out. (Default: 3)
  1551. SERVER OPTIONS
  1552. --------------
  1553. The following options are useful only for servers (that is, if ORPort
  1554. is non-zero):
  1555. [[Address]] **Address** __address__::
  1556. The IPv4 address of this server, or a fully qualified domain name of
  1557. this server that resolves to an IPv4 address. You can leave this
  1558. unset, and Tor will try to guess your IPv4 address. This IPv4
  1559. address is the one used to tell clients and other servers where to
  1560. find your Tor server; it doesn't affect the address that your server
  1561. binds to. To bind to a different address, use the ORPort and
  1562. OutboundBindAddress options.
  1563. [[AssumeReachable]] **AssumeReachable** **0**|**1**::
  1564. This option is used when bootstrapping a new Tor network. If set to 1,
  1565. don't do self-reachability testing; just upload your server descriptor
  1566. immediately. If **AuthoritativeDirectory** is also set, this option
  1567. instructs the dirserver to bypass remote reachability testing too and list
  1568. all connected servers as running.
  1569. [[BridgeRelay]] **BridgeRelay** **0**|**1**::
  1570. Sets the relay to act as a "bridge" with respect to relaying connections
  1571. from bridge users to the Tor network. It mainly causes Tor to publish a
  1572. server descriptor to the bridge database, rather than
  1573. to the public directory authorities.
  1574. [[BridgeDistribution]] **BridgeDistribution** __string__::
  1575. If set along with BridgeRelay, Tor will include a new line in its
  1576. bridge descriptor which indicates to the BridgeDB service how it
  1577. would like its bridge address to be given out. Set it to "none" if
  1578. you want BridgeDB to avoid distributing your bridge address, or "any" to
  1579. let BridgeDB decide. (Default: any)
  1580. +
  1581. Note: as of Oct 2017, the BridgeDB part of this option is not yet
  1582. implemented. Until BridgeDB is updated to obey this option, your
  1583. bridge will make this request, but it will not (yet) be obeyed.
  1584. [[ContactInfo]] **ContactInfo** __email_address__::
  1585. Administrative contact information for this relay or bridge. This line
  1586. can be used to contact you if your relay or bridge is misconfigured or
  1587. something else goes wrong. Note that we archive and publish all
  1588. descriptors containing these lines and that Google indexes them, so
  1589. spammers might also collect them. You may want to obscure the fact
  1590. that it's an email address and/or generate a new address for this
  1591. purpose. +
  1592. +
  1593. ContactInfo **must** be set to a working address if you run more than one
  1594. relay or bridge. (Really, everybody running a relay or bridge should set
  1595. it.)
  1596. [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
  1597. Tells Tor whether to run as an exit relay. If Tor is running as a
  1598. non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
  1599. exit according to the ExitPolicy option (or the default ExitPolicy if
  1600. none is specified). +
  1601. +
  1602. If ExitRelay is set to 0, no traffic is allowed to
  1603. exit, and the ExitPolicy option is ignored. +
  1604. +
  1605. If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
  1606. warns the user if this would cause traffic to exit. In a future version,
  1607. the default value will be 0. (Default: auto)
  1608. [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
  1609. Set an exit policy for this server. Each policy is of the form
  1610. "**accept[6]**|**reject[6]** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
  1611. omitted then this policy just applies to the host given. Instead of giving
  1612. a host or network you can also use "\*" to denote the universe (0.0.0.0/0
  1613. and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
  1614. IPv6 addresses.
  1615. __PORT__ can be a single port number, an interval of ports
  1616. "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
  1617. "\*". +
  1618. +
  1619. For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
  1620. reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
  1621. any other IPv4 or IPv6 traffic. +
  1622. +
  1623. Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
  1624. rejects all destinations that share 7 most significant bit prefix with
  1625. address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
  1626. that share 3 most significant bit prefix with address C000::. +
  1627. +
  1628. accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
  1629. address with accept6 or reject6 is ignored and generates a warning.
  1630. accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
  1631. wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
  1632. expands to matching IPv4 and IPv6 wildcard address rules. +
  1633. +
  1634. To specify all IPv4 and IPv6 internal and link-local networks (including
  1635. 0.0.0.0/8, 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8,
  1636. 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
  1637. and [::]/127), you can use the "private" alias instead of an address.
  1638. ("private" always produces rules for IPv4 and IPv6 addresses, even when
  1639. used with accept6/reject6.) +
  1640. +
  1641. Private addresses are rejected by default (at the beginning of your exit
  1642. policy), along with any configured primary public IPv4 and IPv6 addresses.
  1643. These private addresses are rejected unless you set the
  1644. ExitPolicyRejectPrivate config option to 0. For example, once you've done
  1645. that, you could allow HTTP to 127.0.0.1 and block all other connections to
  1646. internal networks with "accept 127.0.0.1:80,reject private:\*", though that
  1647. may also allow connections to your own computer that are addressed to its
  1648. public (external) IP address. See RFC 1918 and RFC 3330 for more details
  1649. about internal and reserved IP address space. See
  1650. ExitPolicyRejectLocalInterfaces if you want to block every address on the
  1651. relay, even those that aren't advertised in the descriptor. +
  1652. +
  1653. This directive can be specified multiple times so you don't have to put it
  1654. all on one line. +
  1655. +
  1656. Policies are considered first to last, and the first match wins. If you
  1657. want to allow the same ports on IPv4 and IPv6, write your rules using
  1658. accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
  1659. write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
  1660. accept/reject \*4. If you want to \_replace_ the default exit policy, end
  1661. your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
  1662. you're \_augmenting_ (prepending to) the default exit policy. +
  1663. +
  1664. If you want to use a reduced exit policy rather than the default exit
  1665. policy, set "ReducedExitPolicy 1". If you want to _replace_ the default
  1666. exit policy with your custom exit policy, end your exit policy with either
  1667. a reject *:* or an accept *:*. Otherwise, you're _augmenting_ (prepending
  1668. to) the default or reduced exit policy. +
  1669. +
  1670. The default exit policy is:
  1671. reject *:25
  1672. reject *:119
  1673. reject *:135-139
  1674. reject *:445
  1675. reject *:563
  1676. reject *:1214
  1677. reject *:4661-4666
  1678. reject *:6346-6429
  1679. reject *:6699
  1680. reject *:6881-6999
  1681. accept *:*
  1682. // Anchor only for formatting, not visible in the man page.
  1683. [[ExitPolicyDefault]]::
  1684. Since the default exit policy uses accept/reject *, it applies to both
  1685. IPv4 and IPv6 addresses.
  1686. [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
  1687. Reject all private (local) networks, along with the relay's advertised
  1688. public IPv4 and IPv6 addresses, at the beginning of your exit policy.
  1689. See above entry on ExitPolicy.
  1690. (Default: 1)
  1691. [[ExitPolicyRejectLocalInterfaces]] **ExitPolicyRejectLocalInterfaces** **0**|**1**::
  1692. Reject all IPv4 and IPv6 addresses that the relay knows about, at the
  1693. beginning of your exit policy. This includes any OutboundBindAddress, the
  1694. bind addresses of any port options, such as ControlPort or DNSPort, and any
  1695. public IPv4 and IPv6 addresses on any interface on the relay. (If IPv6Exit
  1696. is not set, all IPv6 addresses will be rejected anyway.)
  1697. See above entry on ExitPolicy.
  1698. This option is off by default, because it lists all public relay IP
  1699. addresses in the ExitPolicy, even those relay operators might prefer not
  1700. to disclose.
  1701. (Default: 0)
  1702. [[ReducedExitPolicy]] **ReducedExitPolicy** **0**|**1**::
  1703. If set, use a reduced exit policy rather than the default one. +
  1704. +
  1705. The reduced exit policy is an alternative to the default exit policy. It
  1706. allows as many Internet services as possible while still blocking the
  1707. majority of TCP ports. Currently, the policy allows approximately 65 ports.
  1708. This reduces the odds that your node will be used for peer-to-peer
  1709. applications. +
  1710. +
  1711. The reduced exit policy is:
  1712. accept *:20-21
  1713. accept *:22
  1714. accept *:23
  1715. accept *:43
  1716. accept *:53
  1717. accept *:79
  1718. accept *:80-81
  1719. accept *:88
  1720. accept *:110
  1721. accept *:143
  1722. accept *:194
  1723. accept *:220
  1724. accept *:389
  1725. accept *:443
  1726. accept *:464
  1727. accept *:465
  1728. accept *:531
  1729. accept *:543-544
  1730. accept *:554
  1731. accept *:563
  1732. accept *:587
  1733. accept *:636
  1734. accept *:706
  1735. accept *:749
  1736. accept *:873
  1737. accept *:902-904
  1738. accept *:981
  1739. accept *:989-990
  1740. accept *:991
  1741. accept *:992
  1742. accept *:993
  1743. accept *:994
  1744. accept *:995
  1745. accept *:1194
  1746. accept *:1220
  1747. accept *:1293
  1748. accept *:1500
  1749. accept *:1533
  1750. accept *:1677
  1751. accept *:1723
  1752. accept *:1755
  1753. accept *:1863
  1754. accept *:2082
  1755. accept *:2083
  1756. accept *:2086-2087
  1757. accept *:2095-2096
  1758. accept *:2102-2104
  1759. accept *:3128
  1760. accept *:3389
  1761. accept *:3690
  1762. accept *:4321
  1763. accept *:4643
  1764. accept *:5050
  1765. accept *:5190
  1766. accept *:5222-5223
  1767. accept *:5228
  1768. accept *:5900
  1769. accept *:6660-6669
  1770. accept *:6679
  1771. accept *:6697
  1772. accept *:8000
  1773. accept *:8008
  1774. accept *:8074
  1775. accept *:8080
  1776. accept *:8082
  1777. accept *:8087-8088
  1778. accept *:8232-8233
  1779. accept *:8332-8333
  1780. accept *:8443
  1781. accept *:8888
  1782. accept *:9418
  1783. accept *:9999
  1784. accept *:10000
  1785. accept *:11371
  1786. accept *:19294
  1787. accept *:19638
  1788. accept *:50002
  1789. accept *:64738
  1790. reject *:*
  1791. (Default: 0)
  1792. [[IPv6Exit]] **IPv6Exit** **0**|**1**::
  1793. If set, and we are an exit node, allow clients to use us for IPv6
  1794. traffic. (Default: 0)
  1795. [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
  1796. If we have more onionskins queued for processing than we can process in
  1797. this amount of time, reject new ones. (Default: 1750 msec)
  1798. [[MyFamily]] **MyFamily** __fingerprint__,__fingerprint__,...::
  1799. Declare that this Tor relay is controlled or administered by a group or
  1800. organization identical or similar to that of the other relays, defined by
  1801. their (possibly $-prefixed) identity fingerprints.
  1802. This option can be repeated many times, for
  1803. convenience in defining large families: all fingerprints in all MyFamily
  1804. lines are merged into one list.
  1805. When two relays both declare that they are in the
  1806. same \'family', Tor clients will not use them in the same circuit. (Each
  1807. relay only needs to list the other servers in its family; it doesn't need to
  1808. list itself, but it won't hurt if it does.) Do not list any bridge relay as it would
  1809. compromise its concealment. +
  1810. +
  1811. When listing a node, it's better to list it by fingerprint than by
  1812. nickname: fingerprints are more reliable. +
  1813. +
  1814. If you run more than one relay, the MyFamily option on each relay
  1815. **must** list all other relays, as described above.
  1816. [[Nickname]] **Nickname** __name__::
  1817. Set the server's nickname to \'name'. Nicknames must be between 1 and 19
  1818. characters inclusive, and must contain only the characters [a-zA-Z0-9].
  1819. [[NumCPUs]] **NumCPUs** __num__::
  1820. How many processes to use at once for decrypting onionskins and other
  1821. parallelizable operations. If this is set to 0, Tor will try to detect
  1822. how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
  1823. [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
  1824. Advertise this port to listen for connections from Tor clients and
  1825. servers. This option is required to be a Tor server.
  1826. Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
  1827. run an ORPort at all. This option can occur more than once. (Default: 0) +
  1828. +
  1829. Tor recognizes these flags on each ORPort:
  1830. **NoAdvertise**;;
  1831. By default, we bind to a port and tell our users about it. If
  1832. NoAdvertise is specified, we don't advertise, but listen anyway. This
  1833. can be useful if the port everybody will be connecting to (for
  1834. example, one that's opened on our firewall) is somewhere else.
  1835. **NoListen**;;
  1836. By default, we bind to a port and tell our users about it. If
  1837. NoListen is specified, we don't bind, but advertise anyway. This
  1838. can be useful if something else (for example, a firewall's port
  1839. forwarding configuration) is causing connections to reach us.
  1840. **IPv4Only**;;
  1841. If the address is absent, or resolves to both an IPv4 and an IPv6
  1842. address, only listen to the IPv4 address.
  1843. **IPv6Only**;;
  1844. If the address is absent, or resolves to both an IPv4 and an IPv6
  1845. address, only listen to the IPv6 address.
  1846. // Anchor only for formatting, not visible in the man page.
  1847. [[ORPortFlagsExclusive]]::
  1848. For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
  1849. IPv4Only and IPv6Only are mutually exclusive.
  1850. [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
  1851. This option specifies which descriptors Tor will publish when acting as
  1852. a relay. You can
  1853. choose multiple arguments, separated by commas. +
  1854. +
  1855. If this option is set to 0, Tor will not publish its
  1856. descriptors to any directories. (This is useful if you're testing
  1857. out your server, or if you're using a Tor controller that handles
  1858. directory publishing for you.) Otherwise, Tor will publish its
  1859. descriptors of all type(s) specified. The default is "1", which
  1860. means "if running as a relay or bridge, publish descriptors to the
  1861. appropriate authorities". Other possibilities are "v3", meaning
  1862. "publish as if you're a relay", and "bridge", meaning "publish as
  1863. if you're a bridge".
  1864. [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
  1865. When we get a SIGINT and we're a server, we begin shutting down:
  1866. we close listeners and start refusing new circuits. After **NUM**
  1867. seconds, we exit. If we get a second SIGINT, we exit immediately.
  1868. (Default: 30 seconds)
  1869. [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
  1870. When creating a link certificate for our outermost SSL handshake,
  1871. set its lifetime to this amount of time. If set to 0, Tor will choose
  1872. some reasonable random defaults. (Default: 0)
  1873. [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
  1874. Log a heartbeat message every **HeartbeatPeriod** seconds. This is
  1875. a log level __notice__ message, designed to let you know your Tor
  1876. server is still alive and doing useful things. Settings this
  1877. to 0 will disable the heartbeat. Otherwise, it must be at least 30
  1878. minutes. (Default: 6 hours)
  1879. [[MainloopStats]] **MainloopStats** **0**|**1**::
  1880. Log main loop statistics every **HeartbeatPeriod** seconds. This is a log
  1881. level __notice__ message designed to help developers instrumenting Tor's
  1882. main event loop. (Default: 0)
  1883. [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  1884. Limits the max number of bytes sent and received within a set time period
  1885. using a given calculation rule (see: AccountingStart, AccountingRule).
  1886. Useful if you need to stay under a specific bandwidth. By default, the
  1887. number used for calculation is the max of either the bytes sent or
  1888. received. For example, with AccountingMax set to 1 GByte, a server
  1889. could send 900 MBytes and receive 800 MBytes and continue running.
  1890. It will only hibernate once one of the two reaches 1 GByte. This can
  1891. be changed to use the sum of the both bytes received and sent by setting
  1892. the AccountingRule option to "sum" (total bandwidth in/out). When the
  1893. number of bytes remaining gets low, Tor will stop accepting new connections
  1894. and circuits. When the number of bytes is exhausted, Tor will hibernate
  1895. until some time in the next accounting period. To prevent all servers
  1896. from waking at the same time, Tor will also wait until a random point
  1897. in each period before waking up. If you have bandwidth cost issues,
  1898. enabling hibernation is preferable to setting a low bandwidth, since
  1899. it provides users with a collection of fast servers that are up some
  1900. of the time, which is more useful than a set of slow servers that are
  1901. always "available".
  1902. [[AccountingRule]] **AccountingRule** **sum**|**max**|**in**|**out**::
  1903. How we determine when our AccountingMax has been reached (when we
  1904. should hibernate) during a time interval. Set to "max" to calculate
  1905. using the higher of either the sent or received bytes (this is the
  1906. default functionality). Set to "sum" to calculate using the sent
  1907. plus received bytes. Set to "in" to calculate using only the
  1908. received bytes. Set to "out" to calculate using only the sent bytes.
  1909. (Default: max)
  1910. [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
  1911. Specify how long accounting periods last. If **month** is given,
  1912. each accounting period runs from the time __HH:MM__ on the __dayth__ day of one
  1913. month to the same day and time of the next. The relay will go at full speed,
  1914. use all the quota you specify, then hibernate for the rest of the period. (The
  1915. day must be between 1 and 28.) If **week** is given, each accounting period
  1916. runs from the time __HH:MM__ of the __dayth__ day of one week to the same day
  1917. and time of the next week, with Monday as day 1 and Sunday as day 7. If **day**
  1918. is given, each accounting period runs from the time __HH:MM__ each day to the
  1919. same time on the next day. All times are local, and given in 24-hour time.
  1920. (Default: "month 1 0:00")
  1921. [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
  1922. Prevent nodes that don't appear in the consensus from exiting using this
  1923. relay. If the option is 1, we always block exit attempts from such
  1924. nodes; if it's 0, we never do, and if the option is "auto", then we do
  1925. whatever the authorities suggest in the consensus (and block if the consensus
  1926. is quiet on the issue). (Default: auto)
  1927. [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
  1928. Overrides the default DNS configuration with the configuration in
  1929. __filename__. The file format is the same as the standard Unix
  1930. "**resolv.conf**" file (7). This option, like all other ServerDNS options,
  1931. only affects name lookups that your server does on behalf of clients.
  1932. (Defaults to use the system DNS configuration.)
  1933. [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
  1934. If this option is false, Tor exits immediately if there are problems
  1935. parsing the system DNS configuration or connecting to nameservers.
  1936. Otherwise, Tor continues to periodically retry the system nameservers until
  1937. it eventually succeeds. (Default: 1)
  1938. [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
  1939. If set to 1, then we will search for addresses in the local search domain.
  1940. For example, if this system is configured to believe it is in
  1941. "example.com", and a client tries to connect to "www", the client will be
  1942. connected to "www.example.com". This option only affects name lookups that
  1943. your server does on behalf of clients. (Default: 0)
  1944. [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
  1945. When this option is set to 1, we will test periodically to determine
  1946. whether our local nameservers have been configured to hijack failing DNS
  1947. requests (usually to an advertising site). If they are, we will attempt to
  1948. correct this. This option only affects name lookups that your server does
  1949. on behalf of clients. (Default: 1)
  1950. [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __hostname__,__hostname__,__...__::
  1951. When we're detecting DNS hijacking, make sure that these __valid__ addresses
  1952. aren't getting redirected. If they are, then our DNS is completely useless,
  1953. and we'll reset our exit policy to "reject \*:*". This option only affects
  1954. name lookups that your server does on behalf of clients. (Default:
  1955. "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
  1956. [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
  1957. When this option is disabled, Tor does not try to resolve hostnames
  1958. containing illegal characters (like @ and :) rather than sending them to an
  1959. exit node to be resolved. This helps trap accidental attempts to resolve
  1960. URLs and so on. This option only affects name lookups that your server does
  1961. on behalf of clients. (Default: 0)
  1962. [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
  1963. When this option is enabled and BridgeRelay is also enabled, and we have
  1964. GeoIP data, Tor keeps a per-country count of how many client
  1965. addresses have contacted it so that it can help the bridge authority guess
  1966. which countries have blocked access to it. (Default: 1)
  1967. [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
  1968. When this option is set, Tor sets the case of each character randomly in
  1969. outgoing DNS requests, and makes sure that the case matches in DNS replies.
  1970. This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
  1971. For more information, see "Increased DNS Forgery Resistance through
  1972. 0x20-Bit Encoding". This option only affects name lookups that your server
  1973. does on behalf of clients. (Default: 1)
  1974. [[GeoIPFile]] **GeoIPFile** __filename__::
  1975. A filename containing IPv4 GeoIP data, for use with by-country statistics.
  1976. [[GeoIPv6File]] **GeoIPv6File** __filename__::
  1977. A filename containing IPv6 GeoIP data, for use with by-country statistics.
  1978. [[CellStatistics]] **CellStatistics** **0**|**1**::
  1979. Relays only.
  1980. When this option is enabled, Tor collects statistics about cell
  1981. processing (i.e. mean time a cell is spending in a queue, mean
  1982. number of cells in a queue and mean number of processed cells per
  1983. circuit) and writes them into disk every 24 hours. Onion router
  1984. operators may use the statistics for performance monitoring.
  1985. If ExtraInfoStatistics is enabled, it will published as part of
  1986. extra-info document. (Default: 0)
  1987. [[PaddingStatistics]] **PaddingStatistics** **0**|**1**::
  1988. Relays only.
  1989. When this option is enabled, Tor collects statistics for padding cells
  1990. sent and received by this relay, in addition to total cell counts.
  1991. These statistics are rounded, and omitted if traffic is low. This
  1992. information is important for load balancing decisions related to padding.
  1993. If ExtraInfoStatistics is enabled, it will be published
  1994. as a part of extra-info document. (Default: 1)
  1995. [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
  1996. Relays and bridges only.
  1997. When this option is enabled, a Tor directory writes statistics on the
  1998. number and response time of network status requests to disk every 24
  1999. hours. Enables relay and bridge operators to monitor how much their
  2000. server is being used by clients to learn about Tor network.
  2001. If ExtraInfoStatistics is enabled, it will published as part of
  2002. extra-info document. (Default: 1)
  2003. [[EntryStatistics]] **EntryStatistics** **0**|**1**::
  2004. Relays only.
  2005. When this option is enabled, Tor writes statistics on the number of
  2006. directly connecting clients to disk every 24 hours. Enables relay
  2007. operators to monitor how much inbound traffic that originates from
  2008. Tor clients passes through their server to go further down the
  2009. Tor network. If ExtraInfoStatistics is enabled, it will be published
  2010. as part of extra-info document. (Default: 0)
  2011. [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
  2012. Exit relays only.
  2013. When this option is enabled, Tor writes statistics on the number of
  2014. relayed bytes and opened stream per exit port to disk every 24 hours.
  2015. Enables exit relay operators to measure and monitor amounts of traffic
  2016. that leaves Tor network through their exit node. If ExtraInfoStatistics
  2017. is enabled, it will be published as part of extra-info document.
  2018. (Default: 0)
  2019. [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
  2020. Relays only.
  2021. When this option is enabled, Tor writes statistics on the amounts of
  2022. traffic it passes between itself and other relays to disk every 24
  2023. hours. Enables relay operators to monitor how much their relay is
  2024. being used as middle node in the circuit. If ExtraInfoStatistics is
  2025. enabled, it will be published as part of extra-info document.
  2026. (Default: 0)
  2027. [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
  2028. Relays only.
  2029. When this option is enabled, a Tor relay writes obfuscated
  2030. statistics on its role as hidden-service directory, introduction
  2031. point, or rendezvous point to disk every 24 hours. If
  2032. ExtraInfoStatistics is also enabled, these statistics are further
  2033. published to the directory authorities. (Default: 1)
  2034. [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
  2035. When this option is enabled, Tor includes previously gathered statistics in
  2036. its extra-info documents that it uploads to the directory authorities.
  2037. (Default: 1)
  2038. [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
  2039. When this option is enabled, Tor will connect to relays on localhost,
  2040. RFC1918 addresses, and so on. In particular, Tor will make direct OR
  2041. connections, and Tor routers allow EXTEND requests, to these private
  2042. addresses. (Tor will always allow connections to bridges, proxies, and
  2043. pluggable transports configured on private addresses.) Enabling this
  2044. option can create security issues; you should probably leave it off.
  2045. (Default: 0)
  2046. [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
  2047. This option configures a threshold above which Tor will assume that it
  2048. needs to stop queueing or buffering data because it's about to run out of
  2049. memory. If it hits this threshold, it will begin killing circuits until
  2050. it has recovered at least 10% of this memory. Do not set this option too
  2051. low, or your relay may be unreliable under load. This option only
  2052. affects some queues, so the actual process size will be larger than
  2053. this. If this option is set to 0, Tor will try to pick a reasonable
  2054. default based on your system's physical memory. (Default: 0)
  2055. [[DisableOOSCheck]] **DisableOOSCheck** **0**|**1**::
  2056. This option disables the code that closes connections when Tor notices
  2057. that it is running low on sockets. Right now, it is on by default,
  2058. since the existing out-of-sockets mechanism tends to kill OR connections
  2059. more than it should. (Default: 1)
  2060. [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
  2061. For how long should each Ed25519 signing key be valid? Tor uses a
  2062. permanent master identity key that can be kept offline, and periodically
  2063. generates new "signing" keys that it uses online. This option
  2064. configures their lifetime.
  2065. (Default: 30 days)
  2066. [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
  2067. If non-zero, the Tor relay will never generate or load its master secret
  2068. key. Instead, you'll have to use "tor --keygen" to manage the permanent
  2069. ed25519 master identity key, as well as the corresponding temporary
  2070. signing keys and certificates. (Default: 0)
  2071. [[KeyDirectory]] **KeyDirectory** __DIR__::
  2072. Store secret keys in DIR. Can not be changed while tor is
  2073. running.
  2074. (Default: the "keys" subdirectory of DataDirectory.)
  2075. [[KeyDirectoryGroupReadable]] **KeyDirectoryGroupReadable** **0**|**1**::
  2076. If this option is set to 0, don't allow the filesystem group to read the
  2077. KeywDirectory. If the option is set to 1, make the KeyDirectory readable
  2078. by the default GID. (Default: 0)
  2079. [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  2080. Tells an authority, or other node tracking node reliability and history,
  2081. that fine-grained information about nodes can be discarded when it hasn't
  2082. changed for a given amount of time. (Default: 24 hours)
  2083. DIRECTORY SERVER OPTIONS
  2084. ------------------------
  2085. The following options are useful only for directory servers. (Relays with
  2086. enough bandwidth automatically become directory servers; see DirCache for
  2087. details.)
  2088. [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
  2089. When this option is set, it takes an HTML file and publishes it as "/" on
  2090. the DirPort. Now relay operators can provide a disclaimer without needing
  2091. to set up a separate webserver. There's a sample disclaimer in
  2092. contrib/operator-tools/tor-exit-notice.html.
  2093. [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
  2094. If this option is nonzero, advertise the directory service on this port.
  2095. Set it to "auto" to have Tor pick a port for you. This option can occur
  2096. more than once, but only one advertised DirPort is supported: all
  2097. but one DirPort must have the **NoAdvertise** flag set. (Default: 0) +
  2098. +
  2099. The same flags are supported here as are supported by ORPort.
  2100. [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
  2101. Set an entrance policy for this server, to limit who can connect to the
  2102. directory ports. The policies have the same form as exit policies above,
  2103. except that port specifiers are ignored. Any address not matched by
  2104. some entry in the policy is accepted.
  2105. [[DirCache]] **DirCache** **0**|**1**::
  2106. When this option is set, Tor caches all current directory documents and
  2107. accepts client requests for them. Setting DirPort is not required for this,
  2108. because clients connect via the ORPort by default. Setting either DirPort
  2109. or BridgeRelay and setting DirCache to 0 is not supported. (Default: 1)
  2110. [[MaxConsensusAgeForDiffs]] **MaxConsensusAgeForDiffs** __N__ **minutes**|**hours**|**days**|**weeks**::
  2111. When this option is nonzero, Tor caches will not try to generate
  2112. consensus diffs for any consensus older than this amount of time.
  2113. If this option is set to zero, Tor will pick a reasonable default from
  2114. the current networkstatus document. You should not set this
  2115. option unless your cache is severely low on disk space or CPU.
  2116. If you need to set it, keeping it above 3 or 4 hours will help clients
  2117. much more than setting it to zero.
  2118. (Default: 0)
  2119. DENIAL OF SERVICE MITIGATION OPTIONS
  2120. ------------------------------------
  2121. Tor has three built-in mitigation options that can be individually
  2122. enabled/disabled and fine-tuned, but by default Tor directory authorities will
  2123. define reasonable values for relays and no explicit configuration is required
  2124. to make use of these protections. The mitigations take place at relays,
  2125. and are as follows:
  2126. 1. If a single client address makes too many concurrent connections (this is
  2127. configurable via DoSConnectionMaxConcurrentCount), hang up on further
  2128. connections.
  2129. +
  2130. 2. If a single client IP address (v4 or v6) makes circuits too quickly
  2131. (default values are more than 3 per second, with an allowed burst of 90,
  2132. see DoSCircuitCreationRate and DoSCircuitCreationBurst) while also having
  2133. too many connections open (default is 3, see
  2134. DoSCircuitCreationMinConnections), tor will refuse any new circuit (CREATE
  2135. cells) for the next while (random value between 1 and 2 hours).
  2136. +
  2137. 3. If a client asks to establish a rendezvous point to you directly (ex:
  2138. Tor2Web client), ignore the request.
  2139. These defenses can be manually controlled by torrc options, but relays will
  2140. also take guidance from consensus parameters using these same names, so there's
  2141. no need to configure anything manually. In doubt, do not change those values.
  2142. The values set by the consensus, if any, can be found here:
  2143. https://consensus-health.torproject.org/#consensusparams
  2144. If any of the DoS mitigations are enabled, a heartbeat message will appear in
  2145. your log at NOTICE level which looks like:
  2146. DoS mitigation since startup: 429042 circuits rejected, 17 marked addresses.
  2147. 2238 connections closed. 8052 single hop clients refused.
  2148. The following options are useful only for a public relay. They control the
  2149. Denial of Service mitigation subsystem described above.
  2150. [[DoSCircuitCreationEnabled]] **DoSCircuitCreationEnabled** **0**|**1**|**auto**::
  2151. Enable circuit creation DoS mitigation. If set to 1 (enabled), tor will
  2152. cache client IPs along with statistics in order to detect circuit DoS
  2153. attacks. If an address is positively identified, tor will activate
  2154. defenses against the address. See the DoSCircuitCreationDefenseType option
  2155. for more details. This is a client to relay detection only. "auto" means
  2156. use the consensus parameter. If not defined in the consensus, the value is 0.
  2157. (Default: auto)
  2158. [[DoSCircuitCreationMinConnections]] **DoSCircuitCreationMinConnections** __NUM__::
  2159. Minimum threshold of concurrent connections before a client address can be
  2160. flagged as executing a circuit creation DoS. In other words, once a client
  2161. address reaches the circuit rate and has a minimum of NUM concurrent
  2162. connections, a detection is positive. "0" means use the consensus
  2163. parameter. If not defined in the consensus, the value is 3.
  2164. (Default: 0)
  2165. [[DoSCircuitCreationRate]] **DoSCircuitCreationRate** __NUM__::
  2166. The allowed circuit creation rate per second applied per client IP
  2167. address. If this option is 0, it obeys a consensus parameter. If not
  2168. defined in the consensus, the value is 3.
  2169. (Default: 0)
  2170. [[DoSCircuitCreationBurst]] **DoSCircuitCreationBurst** __NUM__::
  2171. The allowed circuit creation burst per client IP address. If the circuit
  2172. rate and the burst are reached, a client is marked as executing a circuit
  2173. creation DoS. "0" means use the consensus parameter. If not defined in the
  2174. consensus, the value is 90.
  2175. (Default: 0)
  2176. [[DoSCircuitCreationDefenseType]] **DoSCircuitCreationDefenseType** __NUM__::
  2177. This is the type of defense applied to a detected client address. The
  2178. possible values are:
  2179. +
  2180. 1: No defense.
  2181. +
  2182. 2: Refuse circuit creation for the DoSCircuitCreationDefenseTimePeriod period of time.
  2183. +
  2184. "0" means use the consensus parameter. If not defined in the consensus, the value is 2.
  2185. (Default: 0)
  2186. [[DoSCircuitCreationDefenseTimePeriod]] **DoSCircuitCreationDefenseTimePeriod** __N__ **seconds**|**minutes**|**hours**::
  2187. The base time period in seconds that the DoS defense is activated for. The
  2188. actual value is selected randomly for each activation from N+1 to 3/2 * N.
  2189. "0" means use the consensus parameter. If not defined in the consensus,
  2190. the value is 3600 seconds (1 hour).
  2191. (Default: 0)
  2192. [[DoSConnectionEnabled]] **DoSConnectionEnabled** **0**|**1**|**auto**::
  2193. Enable the connection DoS mitigation. If set to 1 (enabled), for client
  2194. address only, this allows tor to mitigate against large number of
  2195. concurrent connections made by a single IP address. "auto" means use the
  2196. consensus parameter. If not defined in the consensus, the value is 0.
  2197. (Default: auto)
  2198. [[DoSConnectionMaxConcurrentCount]] **DoSConnectionMaxConcurrentCount** __NUM__::
  2199. The maximum threshold of concurrent connection from a client IP address.
  2200. Above this limit, a defense selected by DoSConnectionDefenseType is
  2201. applied. "0" means use the consensus parameter. If not defined in the
  2202. consensus, the value is 100.
  2203. (Default: 0)
  2204. [[DoSConnectionDefenseType]] **DoSConnectionDefenseType** __NUM__::
  2205. This is the type of defense applied to a detected client address for the
  2206. connection mitigation. The possible values are:
  2207. +
  2208. 1: No defense.
  2209. +
  2210. 2: Immediately close new connections.
  2211. +
  2212. "0" means use the consensus parameter. If not defined in the consensus, the value is 2.
  2213. (Default: 0)
  2214. [[DoSRefuseSingleHopClientRendezvous]] **DoSRefuseSingleHopClientRendezvous** **0**|**1**|**auto**::
  2215. Refuse establishment of rendezvous points for single hop clients. In other
  2216. words, if a client directly connects to the relay and sends an
  2217. ESTABLISH_RENDEZVOUS cell, it is silently dropped. "auto" means use the
  2218. consensus parameter. If not defined in the consensus, the value is 0.
  2219. (Default: auto)
  2220. DIRECTORY AUTHORITY SERVER OPTIONS
  2221. ----------------------------------
  2222. The following options enable operation as a directory authority, and
  2223. control how Tor behaves as a directory authority. You should not need
  2224. to adjust any of them if you're running a regular relay or exit server
  2225. on the public Tor network.
  2226. [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
  2227. When this option is set to 1, Tor operates as an authoritative directory
  2228. server. Instead of caching the directory, it generates its own list of
  2229. good servers, signs it, and sends that to the clients. Unless the clients
  2230. already have you listed as a trusted directory, you probably do not want
  2231. to set this option.
  2232. [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
  2233. When this option is set in addition to **AuthoritativeDirectory**, Tor
  2234. generates version 3 network statuses and serves descriptors, etc as
  2235. described in dir-spec.txt file of https://spec.torproject.org/[torspec]
  2236. (for Tor clients and servers running at least 0.2.0.x).
  2237. [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
  2238. When this option is set to 1, Tor adds information on which versions of
  2239. Tor are still believed safe for use to the published directory. Each
  2240. version 1 authority is automatically a versioning authority; version 2
  2241. authorities provide this service optionally. See **RecommendedVersions**,
  2242. **RecommendedClientVersions**, and **RecommendedServerVersions**.
  2243. [[RecommendedVersions]] **RecommendedVersions** __STRING__::
  2244. STRING is a comma-separated list of Tor versions currently believed to be
  2245. safe. The list is included in each directory, and nodes which pull down the
  2246. directory learn whether they need to upgrade. This option can appear
  2247. multiple times: the values from multiple lines are spliced together. When
  2248. this is set then **VersioningAuthoritativeDirectory** should be set too.
  2249. [[RecommendedPackages]] **RecommendedPackages** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
  2250. Adds "package" line to the directory authority's vote. This information
  2251. is used to vote on the correct URL and digest for the released versions
  2252. of different Tor-related packages, so that the consensus can certify
  2253. them. This line may appear any number of times.
  2254. [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
  2255. STRING is a comma-separated list of Tor versions currently believed to be
  2256. safe for clients to use. This information is included in version 2
  2257. directories. If this is not set then the value of **RecommendedVersions**
  2258. is used. When this is set then **VersioningAuthoritativeDirectory** should
  2259. be set too.
  2260. [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
  2261. When this option is set in addition to **AuthoritativeDirectory**, Tor
  2262. accepts and serves server descriptors, but it caches and serves the main
  2263. networkstatus documents rather than generating its own. (Default: 0)
  2264. [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  2265. Minimum uptime of a v2 hidden service directory to be accepted as such by
  2266. authoritative directories. (Default: 25 hours)
  2267. [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
  2268. STRING is a comma-separated list of Tor versions currently believed to be
  2269. safe for servers to use. This information is included in version 2
  2270. directories. If this is not set then the value of **RecommendedVersions**
  2271. is used. When this is set then **VersioningAuthoritativeDirectory** should
  2272. be set too.
  2273. [[ConsensusParams]] **ConsensusParams** __STRING__::
  2274. STRING is a space-separated list of key=value pairs that Tor will include
  2275. in the "params" line of its networkstatus vote.
  2276. [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
  2277. If set to 1, Tor will accept server descriptors with arbitrary "Address"
  2278. elements. Otherwise, if the address is not an IP address or is a private IP
  2279. address, it will reject the server descriptor. Additionally, Tor
  2280. will allow exit policies for private networks to fulfill Exit flag
  2281. requirements. (Default: 0)
  2282. [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
  2283. Authoritative directories only. A set of address patterns for servers that
  2284. will be listed as bad exits in any network status document this authority
  2285. publishes, if **AuthDirListBadExits** is set. +
  2286. +
  2287. (The address pattern syntax here and in the options below
  2288. is the same as for exit policies, except that you don't need to say
  2289. "accept" or "reject", and ports are not needed.)
  2290. [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
  2291. Authoritative directories only. A set of address patterns for servers that
  2292. will never be listed as "valid" in any network status document that this
  2293. authority publishes.
  2294. [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
  2295. Authoritative directories only. A set of address patterns for servers that
  2296. will never be listed at all in any network status document that this
  2297. authority publishes, or accepted as an OR address in any descriptor
  2298. submitted for publication by this authority.
  2299. [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
  2300. [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
  2301. [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
  2302. Authoritative directories only. These options contain a comma-separated
  2303. list of country codes such that any server in one of those country codes
  2304. will be marked as a bad exit/invalid for use, or rejected
  2305. entirely.
  2306. [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
  2307. Authoritative directories only. If set to 1, this directory has some
  2308. opinion about which nodes are unsuitable as exit nodes. (Do not set this to
  2309. 1 unless you plan to list non-functioning exits as bad; otherwise, you are
  2310. effectively voting in favor of every declared exit as an exit.)
  2311. [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
  2312. Authoritative directories only. The maximum number of servers that we will
  2313. list as acceptable on a single IP address. Set this to "0" for "no limit".
  2314. (Default: 2)
  2315. [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  2316. Authoritative directories only. If non-zero, always vote the
  2317. Fast flag for any relay advertising this amount of capacity or
  2318. more. (Default: 100 KBytes)
  2319. [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  2320. Authoritative directories only. If non-zero, this advertised capacity
  2321. or more is always sufficient to satisfy the bandwidth requirement
  2322. for the Guard flag. (Default: 2 MBytes)
  2323. [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
  2324. Authoritative directories only. If non-zero, do not allow any relay to
  2325. publish a descriptor if any other relay has reserved its <Ed25519,RSA>
  2326. identity keypair. In all cases, Tor records every keypair it accepts
  2327. in a journal if it is new, or if it differs from the most recently
  2328. accepted pinning for one of the keys it contains. (Default: 1)
  2329. [[AuthDirSharedRandomness]] **AuthDirSharedRandomness** **0**|**1**::
  2330. Authoritative directories only. Switch for the shared random protocol.
  2331. If zero, the authority won't participate in the protocol. If non-zero
  2332. (default), the flag "shared-rand-participate" is added to the authority
  2333. vote indicating participation in the protocol. (Default: 1)
  2334. [[AuthDirTestEd25519LinkKeys]] **AuthDirTestEd25519LinkKeys** **0**|**1**::
  2335. Authoritative directories only. If this option is set to 0, then we treat
  2336. relays as "Running" if their RSA key is correct when we probe them,
  2337. regardless of their Ed25519 key. We should only ever set this option to 0
  2338. if there is some major bug in Ed25519 link authentication that causes us
  2339. to label all the relays as not Running. (Default: 1)
  2340. [[BridgePassword]] **BridgePassword** __Password__::
  2341. If set, contains an HTTP authenticator that tells a bridge authority to
  2342. serve all requested bridge information. Used by the (only partially
  2343. implemented) "bridge community" design, where a community of bridge
  2344. relay operators all use an alternate bridge directory authority,
  2345. and their target user audience can periodically fetch the list of
  2346. available community bridges to stay up-to-date. (Default: not set)
  2347. [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
  2348. V3 authoritative directories only. Configures the server's preferred voting
  2349. interval. Note that voting will __actually__ happen at an interval chosen
  2350. by consensus from all the authorities' preferred intervals. This time
  2351. SHOULD divide evenly into a day. (Default: 1 hour)
  2352. [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
  2353. V3 authoritative directories only. Configures the server's preferred delay
  2354. between publishing its vote and assuming it has all the votes from all the
  2355. other authorities. Note that the actual time used is not the server's
  2356. preferred time, but the consensus of all preferences. (Default: 5 minutes)
  2357. [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
  2358. V3 authoritative directories only. Configures the server's preferred delay
  2359. between publishing its consensus and signature and assuming it has all the
  2360. signatures from all the other authorities. Note that the actual time used
  2361. is not the server's preferred time, but the consensus of all preferences.
  2362. (Default: 5 minutes)
  2363. [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
  2364. V3 authoritative directories only. Configures the number of VotingIntervals
  2365. for which each consensus should be valid for. Choosing high numbers
  2366. increases network partitioning risks; choosing low numbers increases
  2367. directory traffic. Note that the actual number of intervals used is not the
  2368. server's preferred number, but the consensus of all preferences. Must be at
  2369. least 2. (Default: 3)
  2370. [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
  2371. V3 authoritative directories only. Configures the location of the
  2372. bandwidth-authority generated file storing information on relays' measured
  2373. bandwidth capacities. (Default: unset)
  2374. [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
  2375. If set, the directory authority will sign consensuses not only with its
  2376. own signing key, but also with a "legacy" key and certificate with a
  2377. different identity. This feature is used to migrate directory authority
  2378. keys in the event of a compromise. (Default: 0)
  2379. [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
  2380. Authoritative directories only. When set to 0, OR ports with an
  2381. IPv6 address are not included in the authority's votes. When set to 1,
  2382. IPv6 OR ports are tested for reachability like IPv4 OR ports. If the
  2383. reachability test succeeds, the authority votes for the IPv6 ORPort, and
  2384. votes Running for the relay. If the reachability test fails, the authority
  2385. does not vote for the IPv6 ORPort, and does not vote Running (Default: 0) +
  2386. +
  2387. The content of the consensus depends on the number of voting authorities
  2388. that set AuthDirHasIPv6Connectivity:
  2389. If no authorities set AuthDirHasIPv6Connectivity 1, there will be no
  2390. IPv6 ORPorts in the consensus.
  2391. If a minority of authorities set AuthDirHasIPv6Connectivity 1,
  2392. unreachable IPv6 ORPorts will be removed from the consensus. But the
  2393. majority of IPv4-only authorities will still vote the relay as Running.
  2394. Reachable IPv6 ORPort lines will be included in the consensus
  2395. If a majority of voting authorities set AuthDirHasIPv6Connectivity 1,
  2396. relays with unreachable IPv6 ORPorts will not be listed as Running.
  2397. Reachable IPv6 ORPort lines will be included in the consensus
  2398. (To ensure that any valid majority will vote relays with unreachable
  2399. IPv6 ORPorts not Running, 75% of authorities must set
  2400. AuthDirHasIPv6Connectivity 1.)
  2401. [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
  2402. A total value, in abstract bandwidth units, describing how much
  2403. measured total bandwidth an authority should have observed on the network
  2404. before it will treat advertised bandwidths as wholly
  2405. unreliable. (Default: 500)
  2406. HIDDEN SERVICE OPTIONS
  2407. ----------------------
  2408. The following options are used to configure a hidden service.
  2409. [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
  2410. Store data files for a hidden service in DIRECTORY. Every hidden service
  2411. must have a separate directory. You may use this option multiple times to
  2412. specify multiple services. If DIRECTORY does not exist, Tor will create it.
  2413. (Note: in current versions of Tor, if DIRECTORY is a relative path,
  2414. it will be relative to the current
  2415. working directory of Tor instance, not to its DataDirectory. Do not
  2416. rely on this behavior; it is not guaranteed to remain the same in future
  2417. versions.)
  2418. [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
  2419. Configure a virtual port VIRTPORT for a hidden service. You may use this
  2420. option multiple times; each time applies to the service using the most
  2421. recent HiddenServiceDir. By default, this option maps the virtual port to
  2422. the same port on 127.0.0.1 over TCP. You may override the target port,
  2423. address, or both by specifying a target of addr, port, addr:port, or
  2424. **unix:**__path__. (You can specify an IPv6 target as [addr]:port. Unix
  2425. paths may be quoted, and may use standard C escapes.)
  2426. You may also have multiple lines with the same VIRTPORT: when a user
  2427. connects to that VIRTPORT, one of the TARGETs from those lines will be
  2428. chosen at random.
  2429. [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
  2430. If set to 0, Tor will run any hidden services you configure, but it won't
  2431. advertise them to the rendezvous directory. This option is only useful if
  2432. you're using a Tor controller that handles hidserv publishing for you.
  2433. (Default: 1)
  2434. [[HiddenServiceVersion]] **HiddenServiceVersion** **2**|**3**::
  2435. A list of rendezvous service descriptor versions to publish for the hidden
  2436. service. Currently, versions 2 and 3 are supported. (Default: 2)
  2437. [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
  2438. If configured, the hidden service is accessible for authorized clients
  2439. only. The auth-type can either be \'basic' for a general-purpose
  2440. authorization protocol or \'stealth' for a less scalable protocol that also
  2441. hides service activity from unauthorized clients. Only clients that are
  2442. listed here are authorized to access the hidden service. Valid client names
  2443. are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
  2444. spaces). If this option is set, the hidden service is not accessible for
  2445. clients without authorization any more. Generated authorization data can be
  2446. found in the hostname file. Clients need to put this authorization data in
  2447. their configuration file using **HidServAuth**. This option is only for v2
  2448. services.
  2449. [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
  2450. If set to 1, then connections to unrecognized ports do not cause the
  2451. current hidden service to close rendezvous circuits. (Setting this to 0 is
  2452. not an authorization mechanism; it is instead meant to be a mild
  2453. inconvenience to port-scanners.) (Default: 0)
  2454. [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
  2455. The maximum number of simultaneous streams (connections) per rendezvous
  2456. circuit. The maximum value allowed is 65535. (Setting this to 0 will allow
  2457. an unlimited number of simultaneous streams.) (Default: 0)
  2458. [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
  2459. If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
  2460. offending rendezvous circuit to be torn down, as opposed to stream creation
  2461. requests that exceed the limit being silently ignored. (Default: 0)
  2462. [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
  2463. Every time the specified period elapses, Tor uploads any rendezvous
  2464. service descriptors to the directory servers. This information is also
  2465. uploaded whenever it changes. Minimum value allowed is 10 minutes and
  2466. maximum is 3.5 days. This option is only for v2 services.
  2467. (Default: 1 hour)
  2468. [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
  2469. If this option is set to 1, allow the filesystem group to read the
  2470. hidden service directory and hostname file. If the option is set to 0,
  2471. only owner is able to read the hidden service directory. (Default: 0)
  2472. Has no effect on Windows.
  2473. [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
  2474. Number of introduction points the hidden service will have. You can't
  2475. have more than 10 for v2 service and 20 for v3. (Default: 3)
  2476. [[HiddenServiceSingleHopMode]] **HiddenServiceSingleHopMode** **0**|**1**::
  2477. **Experimental - Non Anonymous** Hidden Services on a tor instance in
  2478. HiddenServiceSingleHopMode make one-hop (direct) circuits between the onion
  2479. service server, and the introduction and rendezvous points. (Onion service
  2480. descriptors are still posted using 3-hop paths, to avoid onion service
  2481. directories blocking the service.)
  2482. This option makes every hidden service instance hosted by a tor instance a
  2483. Single Onion Service. One-hop circuits make Single Onion servers easily
  2484. locatable, but clients remain location-anonymous. However, the fact that a
  2485. client is accessing a Single Onion rather than a Hidden Service may be
  2486. statistically distinguishable. +
  2487. +
  2488. **WARNING:** Once a hidden service directory has been used by a tor
  2489. instance in HiddenServiceSingleHopMode, it can **NEVER** be used again for
  2490. a hidden service. It is best practice to create a new hidden service
  2491. directory, key, and address for each new Single Onion Service and Hidden
  2492. Service. It is not possible to run Single Onion Services and Hidden
  2493. Services from the same tor instance: they should be run on different
  2494. servers with different IP addresses. +
  2495. +
  2496. HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be set
  2497. to 1. Since a Single Onion service is non-anonymous, you can not configure
  2498. a SOCKSPort on a tor instance that is running in
  2499. **HiddenServiceSingleHopMode**. Can not be changed while tor is running.
  2500. (Default: 0)
  2501. [[HiddenServiceNonAnonymousMode]] **HiddenServiceNonAnonymousMode** **0**|**1**::
  2502. Makes hidden services non-anonymous on this tor instance. Allows the
  2503. non-anonymous HiddenServiceSingleHopMode. Enables direct connections in the
  2504. server-side hidden service protocol. If you are using this option,
  2505. you need to disable all client-side services on your Tor instance,
  2506. including setting SOCKSPort to "0". Can not be changed while tor is
  2507. running. (Default: 0)
  2508. TESTING NETWORK OPTIONS
  2509. -----------------------
  2510. The following options are used for running a testing Tor network.
  2511. [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
  2512. If set to 1, Tor adjusts default values of the configuration options below,
  2513. so that it is easier to set up a testing Tor network. May only be set if
  2514. non-default set of DirAuthorities is set. Cannot be unset while Tor is
  2515. running.
  2516. (Default: 0) +
  2517. ServerDNSAllowBrokenConfig 1
  2518. DirAllowPrivateAddresses 1
  2519. EnforceDistinctSubnets 0
  2520. AssumeReachable 1
  2521. AuthDirMaxServersPerAddr 0
  2522. AuthDirMaxServersPerAuthAddr 0
  2523. ClientBootstrapConsensusAuthorityDownloadSchedule 0, 2,
  2524. 4 (for 40 seconds), 8, 16, 32, 60
  2525. ClientBootstrapConsensusFallbackDownloadSchedule 0, 1,
  2526. 4 (for 40 seconds), 8, 16, 32, 60
  2527. ClientBootstrapConsensusAuthorityOnlyDownloadSchedule 0, 1,
  2528. 4 (for 40 seconds), 8, 16, 32, 60
  2529. ClientDNSRejectInternalAddresses 0
  2530. ClientRejectInternalAddresses 0
  2531. CountPrivateBandwidth 1
  2532. ExitPolicyRejectPrivate 0
  2533. ExtendAllowPrivateAddresses 1
  2534. V3AuthVotingInterval 5 minutes
  2535. V3AuthVoteDelay 20 seconds
  2536. V3AuthDistDelay 20 seconds
  2537. MinUptimeHidServDirectoryV2 0 seconds
  2538. TestingV3AuthInitialVotingInterval 5 minutes
  2539. TestingV3AuthInitialVoteDelay 20 seconds
  2540. TestingV3AuthInitialDistDelay 20 seconds
  2541. TestingAuthDirTimeToLearnReachability 0 minutes
  2542. TestingEstimatedDescriptorPropagationTime 0 minutes
  2543. TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
  2544. TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
  2545. TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
  2546. TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
  2547. TestingBridgeDownloadSchedule 10, 30, 60
  2548. TestingBridgeBootstrapDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
  2549. TestingClientMaxIntervalWithoutRequest 5 seconds
  2550. TestingDirConnectionMaxStall 30 seconds
  2551. TestingEnableConnBwEvent 1
  2552. TestingEnableCellStatsEvent 1
  2553. [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
  2554. Like V3AuthVotingInterval, but for initial voting interval before the first
  2555. consensus has been created. Changing this requires that
  2556. **TestingTorNetwork** is set. (Default: 30 minutes)
  2557. [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
  2558. Like V3AuthVoteDelay, but for initial voting interval before
  2559. the first consensus has been created. Changing this requires that
  2560. **TestingTorNetwork** is set. (Default: 5 minutes)
  2561. [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
  2562. Like V3AuthDistDelay, but for initial voting interval before
  2563. the first consensus has been created. Changing this requires that
  2564. **TestingTorNetwork** is set. (Default: 5 minutes)
  2565. [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
  2566. Directory authorities offset voting start time by this much.
  2567. Changing this requires that **TestingTorNetwork** is set. (Default: 0)
  2568. [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
  2569. After starting as an authority, do not make claims about whether routers
  2570. are Running until this much time has passed. Changing this requires
  2571. that **TestingTorNetwork** is set. (Default: 30 minutes)
  2572. [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
  2573. Clients try downloading server descriptors from directory caches after this
  2574. time. Changing this requires that **TestingTorNetwork** is set. (Default:
  2575. 10 minutes)
  2576. [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  2577. Minimum value for the Fast flag. Overrides the ordinary minimum taken
  2578. from the consensus when TestingTorNetwork is set. (Default: 0.)
  2579. [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
  2580. Schedule for when servers should download things in general. Changing this
  2581. requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
  2582. 300, 900, 2147483647)
  2583. [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
  2584. Schedule for when clients should download things in general. Changing this
  2585. requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
  2586. 2147483647)
  2587. [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
  2588. Schedule for when servers should download consensuses. Changing this
  2589. requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
  2590. 1800, 1800, 1800, 1800, 1800, 3600, 7200)
  2591. [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
  2592. Schedule for when clients should download consensuses. Changing this
  2593. requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
  2594. 1800, 3600, 3600, 3600, 10800, 21600, 43200)
  2595. [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
  2596. Schedule for when clients should download each bridge descriptor when they
  2597. know that one or more of their configured bridges are running. Changing
  2598. this requires that **TestingTorNetwork** is set. (Default: 10800, 25200,
  2599. 54000, 111600, 262800)
  2600. [[TestingBridgeBootstrapDownloadSchedule]] **TestingBridgeBootstrapDownloadSchedule** __N__,__N__,__...__::
  2601. Schedule for when clients should download each bridge descriptor when they
  2602. have just started, or when they can not contact any of their bridges.
  2603. Changing this requires that **TestingTorNetwork** is set. (Default: 0, 30,
  2604. 90, 600, 3600, 10800, 25200, 54000, 111600, 262800)
  2605. [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
  2606. When directory clients have only a few descriptors to request, they batch
  2607. them until they have more, or until this amount of time has passed.
  2608. Changing this requires that **TestingTorNetwork** is set. (Default: 10
  2609. minutes)
  2610. [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
  2611. Let a directory connection stall this long before expiring it.
  2612. Changing this requires that **TestingTorNetwork** is set. (Default:
  2613. 5 minutes)
  2614. [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
  2615. A list of identity fingerprints, country codes, and
  2616. address patterns of nodes to vote Exit for regardless of their
  2617. uptime, bandwidth, or exit policy. See the **ExcludeNodes**
  2618. option for more information on how to specify nodes. +
  2619. +
  2620. In order for this option to have any effect, **TestingTorNetwork**
  2621. has to be set. See the **ExcludeNodes** option for more
  2622. information on how to specify nodes.
  2623. [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
  2624. If True (1), a node will never receive the Exit flag unless it is specified
  2625. in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
  2626. or exit policy. +
  2627. +
  2628. In order for this option to have any effect, **TestingTorNetwork**
  2629. has to be set.
  2630. [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
  2631. A list of identity fingerprints and country codes and
  2632. address patterns of nodes to vote Guard for regardless of their
  2633. uptime and bandwidth. See the **ExcludeNodes** option for more
  2634. information on how to specify nodes. +
  2635. +
  2636. In order for this option to have any effect, **TestingTorNetwork**
  2637. has to be set.
  2638. [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
  2639. If True (1), a node will never receive the Guard flag unless it is specified
  2640. in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth. +
  2641. +
  2642. In order for this option to have any effect, **TestingTorNetwork**
  2643. has to be set.
  2644. [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
  2645. A list of identity fingerprints and country codes and
  2646. address patterns of nodes to vote HSDir for regardless of their
  2647. uptime and DirPort. See the **ExcludeNodes** option for more
  2648. information on how to specify nodes. +
  2649. +
  2650. In order for this option to have any effect, **TestingTorNetwork**
  2651. must be set.
  2652. [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
  2653. If True (1), a node will never receive the HSDir flag unless it is specified
  2654. in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort. +
  2655. +
  2656. In order for this option to have any effect, **TestingTorNetwork**
  2657. has to be set.
  2658. [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
  2659. If this option is set, then Tor controllers may register for CONN_BW
  2660. events. Changing this requires that **TestingTorNetwork** is set.
  2661. (Default: 0)
  2662. [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
  2663. If this option is set, then Tor controllers may register for CELL_STATS
  2664. events. Changing this requires that **TestingTorNetwork** is set.
  2665. (Default: 0)
  2666. [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
  2667. Sets a lower-bound for assigning an exit flag when running as an
  2668. authority on a testing network. Overrides the usual default lower bound
  2669. of 4 KB. (Default: 0)
  2670. [[TestingLinkCertLifetime]] **TestingLinkCertLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
  2671. Overrides the default lifetime for the certificates used to authenticate
  2672. our X509 link cert with our ed25519 signing key.
  2673. (Default: 2 days)
  2674. [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
  2675. Overrides the default lifetime for a signing Ed25519 TLS Link authentication
  2676. key.
  2677. (Default: 2 days)
  2678. [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours** +
  2679. [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours** +
  2680. [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
  2681. How early before the official expiration of a an Ed25519 signing key do
  2682. we replace it and issue a new key?
  2683. (Default: 3 hours for link and auth; 1 day for signing.)
  2684. NON-PERSISTENT OPTIONS
  2685. ----------------------
  2686. These options are not saved to the torrc file by the "SAVECONF" controller
  2687. command. Other options of this type are documented in control-spec.txt,
  2688. section 5.4. End-users should mostly ignore them.
  2689. [[UnderscorePorts]] **\_\_ControlPort**, **\_\_DirPort**, **\_\_DNSPort**, **\_\_ExtORPort**, **\_\_NATDPort**, **\_\_ORPort**, **\_\_SocksPort**, **\_\_TransPort**::
  2690. These underscore-prefixed options are variants of the regular Port
  2691. options. They behave the same, except they are not saved to the
  2692. torrc file by the controller's SAVECONF command.
  2693. SIGNALS
  2694. -------
  2695. Tor catches the following signals:
  2696. [[SIGTERM]] **SIGTERM**::
  2697. Tor will catch this, clean up and sync to disk if necessary, and exit.
  2698. [[SIGINT]] **SIGINT**::
  2699. Tor clients behave as with SIGTERM; but Tor servers will do a controlled
  2700. slow shutdown, closing listeners and waiting 30 seconds before exiting.
  2701. (The delay can be configured with the ShutdownWaitLength config option.)
  2702. [[SIGHUP]] **SIGHUP**::
  2703. The signal instructs Tor to reload its configuration (including closing and
  2704. reopening logs), and kill and restart its helper processes if applicable.
  2705. [[SIGUSR1]] **SIGUSR1**::
  2706. Log statistics about current connections, past connections, and throughput.
  2707. [[SIGUSR2]] **SIGUSR2**::
  2708. Switch all logs to loglevel debug. You can go back to the old loglevels by
  2709. sending a SIGHUP.
  2710. [[SIGCHLD]] **SIGCHLD**::
  2711. Tor receives this signal when one of its helper processes has exited, so it
  2712. can clean up.
  2713. [[SIGPIPE]] **SIGPIPE**::
  2714. Tor catches this signal and ignores it.
  2715. [[SIGXFSZ]] **SIGXFSZ**::
  2716. If this signal exists on your platform, Tor catches and ignores it.
  2717. FILES
  2718. -----
  2719. **@CONFDIR@/torrc**::
  2720. The configuration file, which contains "option value" pairs.
  2721. **$HOME/.torrc**::
  2722. Fallback location for torrc, if @CONFDIR@/torrc is not found.
  2723. **@LOCALSTATEDIR@/lib/tor/**::
  2724. The tor process stores keys and other data here.
  2725. __CacheDirectory__**/cached-certs**::
  2726. This file holds downloaded directory key certificates that are used to
  2727. verify authenticity of documents generated by Tor directory authorities.
  2728. __CacheDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
  2729. The most recent consensus network status document we've downloaded.
  2730. __CacheDirectory__**/cached-descriptors** and **cached-descriptors.new**::
  2731. These files hold downloaded router statuses. Some routers may appear more
  2732. than once; if so, the most recently published descriptor is used. Lines
  2733. beginning with @-signs are annotations that contain more information about
  2734. a given router. The ".new" file is an append-only journal; when it gets
  2735. too large, all entries are merged into a new cached-descriptors file.
  2736. __CacheDirectory__**/cached-extrainfo** and **cached-extrainfo.new**::
  2737. As "cached-descriptors", but holds optionally-downloaded "extra-info"
  2738. documents. Relays use these documents to send inessential information
  2739. about statistics, bandwidth history, and network health to the
  2740. authorities. They aren't fetched by default; see the DownloadExtraInfo
  2741. option for more info.
  2742. __CacheDirectory__**/cached-microdescs** and **cached-microdescs.new**::
  2743. These files hold downloaded microdescriptors. Lines beginning with
  2744. @-signs are annotations that contain more information about a given
  2745. router. The ".new" file is an append-only journal; when it gets too
  2746. large, all entries are merged into a new cached-microdescs file.
  2747. __CacheDirectory__**/cached-routers** and **cached-routers.new**::
  2748. Obsolete versions of cached-descriptors and cached-descriptors.new. When
  2749. Tor can't find the newer files, it looks here instead.
  2750. __DataDirectory__**/state**::
  2751. A set of persistent key-value mappings. These are documented in
  2752. the file. These include:
  2753. - The current entry guards and their status.
  2754. - The current bandwidth accounting values.
  2755. - When the file was last written
  2756. - What version of Tor generated the state file
  2757. - A short history of bandwidth usage, as produced in the server
  2758. descriptors.
  2759. __DataDirectory__**/sr-state**::
  2760. Authority only. State file used to record information about the current
  2761. status of the shared-random-value voting state.
  2762. __CacheDirectory__**/diff-cache**::
  2763. Directory cache only. Holds older consensuses, and diffs from older
  2764. consensuses to the most recent consensus of each type, compressed
  2765. in various ways. Each file contains a set of key-value arguments
  2766. describing its contents, followed by a single NUL byte, followed by the
  2767. main file contents.
  2768. __DataDirectory__**/bw_accounting**::
  2769. Used to track bandwidth accounting values (when the current period starts
  2770. and ends; how much has been read and written so far this period). This file
  2771. is obsolete, and the data is now stored in the \'state' file instead.
  2772. __DataDirectory__**/control_auth_cookie**::
  2773. Used for cookie authentication with the controller. Location can be
  2774. overridden by the CookieAuthFile config option. Regenerated on startup. See
  2775. control-spec.txt in https://spec.torproject.org/[torspec] for details.
  2776. Only used when cookie authentication is enabled.
  2777. __DataDirectory__**/lock**::
  2778. This file is used to prevent two Tor instances from using same data
  2779. directory. If access to this file is locked, data directory is already
  2780. in use by Tor.
  2781. __DataDirectory__**/key-pinning-journal**::
  2782. Used by authorities. A line-based file that records mappings between
  2783. RSA1024 identity keys and Ed25519 identity keys. Authorities enforce
  2784. these mappings, so that once a relay has picked an Ed25519 key, stealing
  2785. or factoring the RSA1024 key will no longer let an attacker impersonate
  2786. the relay.
  2787. __KeyDirectory__**/authority_identity_key**::
  2788. A v3 directory authority's master identity key, used to authenticate its
  2789. signing key. Tor doesn't use this while it's running. The tor-gencert
  2790. program uses this. If you're running an authority, you should keep this
  2791. key offline, and not actually put it here.
  2792. __KeyDirectory__**/authority_certificate**::
  2793. A v3 directory authority's certificate, which authenticates the authority's
  2794. current vote- and consensus-signing key using its master identity key.
  2795. Only directory authorities use this file.
  2796. __KeyDirectory__**/authority_signing_key**::
  2797. A v3 directory authority's signing key, used to sign votes and consensuses.
  2798. Only directory authorities use this file. Corresponds to the
  2799. **authority_certificate** cert.
  2800. __KeyDirectory__**/legacy_certificate**::
  2801. As authority_certificate: used only when V3AuthUseLegacyKey is set.
  2802. See documentation for V3AuthUseLegacyKey.
  2803. __KeyDirectory__**/legacy_signing_key**::
  2804. As authority_signing_key: used only when V3AuthUseLegacyKey is set.
  2805. See documentation for V3AuthUseLegacyKey.
  2806. __KeyDirectory__**/secret_id_key**::
  2807. A relay's RSA1024 permanent identity key, including private and public
  2808. components. Used to sign router descriptors, and to sign other keys.
  2809. __KeyDirectory__**/ed25519_master_id_public_key**::
  2810. The public part of a relay's Ed25519 permanent identity key.
  2811. __KeyDirectory__**/ed25519_master_id_secret_key**::
  2812. The private part of a relay's Ed25519 permanent identity key. This key
  2813. is used to sign the medium-term ed25519 signing key. This file can be
  2814. kept offline, or kept encrypted. If so, Tor will not be able to generate
  2815. new signing keys itself; you'll need to use tor --keygen yourself to do
  2816. so.
  2817. __KeyDirectory__**/ed25519_signing_secret_key**::
  2818. The private and public components of a relay's medium-term Ed25519 signing
  2819. key. This key is authenticated by the Ed25519 master key, in turn
  2820. authenticates other keys (and router descriptors).
  2821. __KeyDirectory__**/ed25519_signing_cert**::
  2822. The certificate which authenticates "ed25519_signing_secret_key" as
  2823. having been signed by the Ed25519 master key.
  2824. __KeyDirectory__**/secret_onion_key** and **secret_onion_key.old**::
  2825. A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP")
  2826. circuit extension requests. The ".old" file holds the previously
  2827. generated key, which the relay uses to handle any requests that were
  2828. made by clients that didn't have the new one.
  2829. __KeyDirectory__**/secret_onion_key_ntor** and **secret_onion_key_ntor.old**::
  2830. A relay's Curve25519 short-term onion key. Used to handle modern ("ntor")
  2831. circuit extension requests. The ".old" file holds the previously
  2832. generated key, which the relay uses to handle any requests that were
  2833. made by clients that didn't have the new one.
  2834. __DataDirectory__**/fingerprint**::
  2835. Only used by servers. Holds the fingerprint of the server's identity key.
  2836. __DataDirectory__**/hashed-fingerprint**::
  2837. Only used by bridges. Holds the hashed fingerprint of the bridge's
  2838. identity key. (That is, the hash of the hash of the identity key.)
  2839. __DataDirectory__**/approved-routers**::
  2840. Only used by authoritative directory servers. This file lists
  2841. the status of routers by their identity fingerprint.
  2842. Each line lists a status and a fingerprint separated by
  2843. whitespace. See your **fingerprint** file in the __DataDirectory__ for an
  2844. example line. If the status is **!reject** then descriptors from the
  2845. given identity (fingerprint) are rejected by this server. If it is
  2846. **!invalid** then descriptors are accepted but marked in the directory as
  2847. not valid, that is, not recommended.
  2848. __DataDirectory__**/v3-status-votes**::
  2849. Only for v3 authoritative directory servers. This file contains
  2850. status votes from all the authoritative directory servers.
  2851. __CacheDirectory__**/unverified-consensus**::
  2852. This file contains a network consensus document that has been downloaded,
  2853. but which we didn't have the right certificates to check yet.
  2854. __CacheDirectory__**/unverified-microdesc-consensus**::
  2855. This file contains a microdescriptor-flavored network consensus document
  2856. that has been downloaded, but which we didn't have the right certificates
  2857. to check yet.
  2858. __DataDirectory__**/unparseable-desc**::
  2859. Onion server descriptors that Tor was unable to parse are dumped to this
  2860. file. Only used for debugging.
  2861. __DataDirectory__**/router-stability**::
  2862. Only used by authoritative directory servers. Tracks measurements for
  2863. router mean-time-between-failures so that authorities have a good idea of
  2864. how to set their Stable flags.
  2865. __DataDirectory__**/stats/dirreq-stats**::
  2866. Only used by directory caches and authorities. This file is used to
  2867. collect directory request statistics.
  2868. __DataDirectory__**/stats/entry-stats**::
  2869. Only used by servers. This file is used to collect incoming connection
  2870. statistics by Tor entry nodes.
  2871. __DataDirectory__**/stats/bridge-stats**::
  2872. Only used by servers. This file is used to collect incoming connection
  2873. statistics by Tor bridges.
  2874. __DataDirectory__**/stats/exit-stats**::
  2875. Only used by servers. This file is used to collect outgoing connection
  2876. statistics by Tor exit routers.
  2877. __DataDirectory__**/stats/buffer-stats**::
  2878. Only used by servers. This file is used to collect buffer usage
  2879. history.
  2880. __DataDirectory__**/stats/conn-stats**::
  2881. Only used by servers. This file is used to collect approximate connection
  2882. history (number of active connections over time).
  2883. __DataDirectory__**/stats/hidserv-stats**::
  2884. Only used by servers. This file is used to collect approximate counts
  2885. of what fraction of the traffic is hidden service rendezvous traffic, and
  2886. approximately how many hidden services the relay has seen.
  2887. __DataDirectory__**/networkstatus-bridges**::
  2888. Only used by authoritative bridge directories. Contains information
  2889. about bridges that have self-reported themselves to the bridge
  2890. authority.
  2891. __DataDirectory__**/approved-routers**::
  2892. Authorities only. This file is used to configure which relays are
  2893. known to be valid, invalid, and so forth.
  2894. __HiddenServiceDirectory__**/hostname**::
  2895. The <base32-encoded-fingerprint>.onion domain name for this hidden service.
  2896. If the hidden service is restricted to authorized clients only, this file
  2897. also contains authorization data for all clients.
  2898. +
  2899. Note that clients will ignore any extra subdomains prepended to a hidden
  2900. service hostname. So if you have "xyz.onion" as your hostname, you
  2901. can tell clients to connect to "www.xyz.onion" or "irc.xyz.onion"
  2902. for virtual-hosting purposes.
  2903. __HiddenServiceDirectory__**/private_key**::
  2904. The private key for this hidden service.
  2905. __HiddenServiceDirectory__**/client_keys**::
  2906. Authorization data for a hidden service that is only accessible by
  2907. authorized clients.
  2908. __HiddenServiceDirectory__**/onion_service_non_anonymous**::
  2909. This file is present if a hidden service key was created in
  2910. **HiddenServiceNonAnonymousMode**.
  2911. SEE ALSO
  2912. --------
  2913. **torsocks**(1), **torify**(1) +
  2914. **https://www.torproject.org/**
  2915. **torspec: https://spec.torproject.org **
  2916. BUGS
  2917. ----
  2918. Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/.
  2919. AUTHORS
  2920. -------
  2921. Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].