tor.1.txt 153 KB

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