tor.1.txt 91 KB

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