tor.1.txt 195 KB

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