tor.1.txt 127 KB

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