tor.1.txt 99 KB

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