tor.1.txt 79 KB

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