tor.1.txt 93 KB

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