tor.1.txt 173 KB

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