dir-spec.txt 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769
  1. $Id$
  2. Tor directory protocol, version 2
  3. 0. Scope and preliminaries
  4. This directory protocol is used by Tor version 0.1.1.x and later. See
  5. dir-spec-v1.txt for information on earlier versions.
  6. 0.1. Goals and motivation
  7. There were several problems with the way Tor handles directory information
  8. in version 0.1.0.x and earlier. Here are the problems we try to fix with
  9. this new design, already implemented in 0.1.1.x:
  10. 1. Directories were very large and use up a lot of bandwidth: clients
  11. downloaded descriptors for all router several times an hour.
  12. 2. Every directory authority was a trust bottleneck: if a single
  13. directory authority lied, it could make clients believe for a time an
  14. arbitrarily distorted view of the Tor network.
  15. 3. Our current "verified server" system is kind of nonsensical.
  16. 4. Getting more directory authorities would add more points of failure
  17. and worsen possible partitioning attacks.
  18. There are two problems that remain unaddressed by this design.
  19. 5. Requiring every client to know about every router won't scale.
  20. 6. Requiring every directory cache to know every router won't scale.
  21. We attempt to fix 1-4 here, and to build a solution that will work when we
  22. figure out an answer for 5. We haven't thought at all about what to do
  23. about 6.
  24. 1. Outline
  25. There is a small set (say, around 10) of semi-trusted directory
  26. authorities. A default list of authorities is shipped with the Tor
  27. software. Users can change this list, but are encouraged not to do so, in
  28. order to avoid partitioning attacks.
  29. Routers periodically upload signed "descriptors" to the directory
  30. authorities describing their keys, capabilities, and other information.
  31. Routers may act as directory mirrors (also called "caches"), to reduce
  32. load on the directory authorities. They announce this in their
  33. descriptors.
  34. Each directory authority periodically generates and signs a compact
  35. "network status" document that lists that authority's view of the current
  36. descriptors and status for known routers, but which does not include the
  37. descriptors themselves.
  38. Directory mirrors download, cache, and re-serve network-status documents
  39. to clients.
  40. Clients, directory mirrors, and directory authorities all use
  41. network-status documents to find out when their list of routers is
  42. out-of-date. If it is, they download any missing router descriptors.
  43. Clients download missing descriptors from mirrors; mirrors and authorities
  44. download from authorities. Descriptors are downloaded by the hash of the
  45. descriptor, not by the server's identity key: this prevents servers from
  46. attacking clients by giving them descriptors nobody else uses.
  47. All directory information is uploaded and downloaded with HTTP.
  48. Coordination among directory authorities is done client-side: clients
  49. compute a vote-like algorithm among the network-status documents they
  50. have, and base their decisions on the result.
  51. 1.1. What's different from 0.1.0.x?
  52. Clients used to download a signed concatenated set of router descriptors
  53. (called a "directory") from directory mirrors, regardless of which
  54. descriptors had changed.
  55. Between downloading directories, clients would download "network-status"
  56. documents that would list which servers were supposed to running.
  57. Clients would always believe the most recently published network-status
  58. document they were served.
  59. Routers used to upload fresh descriptors all the time, whether their keys
  60. and other information had changed or not.
  61. 1.2. Document meta-format
  62. Router descriptors, directories, and running-routers documents all obey the
  63. following lightweight extensible information format.
  64. The highest level object is a Document, which consists of one or more
  65. Items. Every Item begins with a KeywordLine, followed by one or more
  66. Objects. A KeywordLine begins with a Keyword, optionally followed by
  67. whitespace and more non-newline characters, and ends with a newline. A
  68. Keyword is a sequence of one or more characters in the set [A-Za-z0-9-].
  69. An Object is a block of encoded data in pseudo-Open-PGP-style
  70. armor. (cf. RFC 2440)
  71. More formally:
  72. Document ::= (Item | NL)+
  73. Item ::= KeywordLine Object*
  74. KeywordLine ::= Keyword NL | Keyword WS ArgumentsChar+ NL
  75. Keyword = KeywordChar+
  76. KeywordChar ::= 'A' ... 'Z' | 'a' ... 'z' | '0' ... '9' | '-'
  77. ArgumentChar ::= any printing ASCII character except NL.
  78. WS = (SP | TAB)+
  79. Object ::= BeginLine Base-64-encoded-data EndLine
  80. BeginLine ::= "-----BEGIN " Keyword "-----" NL
  81. EndLine ::= "-----END " Keyword "-----" NL
  82. The BeginLine and EndLine of an Object must use the same keyword.
  83. When interpreting a Document, software MUST reject any document containing a
  84. KeywordLine that starts with a keyword it doesn't recognize.
  85. The "opt" keyword is reserved for non-critical future extensions. All
  86. implementations MUST ignore any item of the form "opt keyword ....." when
  87. they would not recognize "keyword ....."; and MUST treat "opt keyword ....."
  88. as synonymous with "keyword ......" when keyword is recognized.
  89. 2. Router operation
  90. ORs SHOULD generate a new router descriptor whenever any of the
  91. following events have occurred:
  92. - A period of time (18 hrs by default) has passed since the last
  93. time a descriptor was generated.
  94. - A descriptor field other than bandwidth or uptime has changed.
  95. - Bandwidth has changed by more than +/- 50% from the last time a
  96. descriptor was generated, and at least a given interval of time
  97. (20 mins by default) has passed since then.
  98. - Its uptime has been reset (by restarting).
  99. After generating a descriptor, ORs upload it to every directory
  100. authority they know, by posting it to the URL
  101. http://<hostname:port>/tor/
  102. 2.1. Router descriptor format
  103. Every router descriptor MUST start with a "router" Item; MUST end with a
  104. "router-signature" Item and an extra NL; and MUST contain exactly one
  105. instance of each of the following Items: "published" "onion-key"
  106. "link-key" "signing-key" "bandwidth". Additionally, a router descriptor
  107. MAY contain any number of "accept", "reject", "fingerprint", "uptime", and
  108. "opt" Items. Other than "router" and "router-signature", the items may
  109. appear in any order.
  110. The items' formats are as follows:
  111. "router" nickname address ORPort SocksPort DirPort
  112. Indicates the beginning of a router descriptor. "address" must be an
  113. IPv4 address in dotted-quad format. The last three numbers indicate
  114. the TCP ports at which this OR exposes functionality. ORPort is a port
  115. at which this OR accepts TLS connections for the main OR protocol;
  116. SocksPort is deprecated and should always be 0; and DirPort is the
  117. port at which this OR accepts directory-related HTTP connections. If
  118. any port is not supported, the value 0 is given instead of a port
  119. number.
  120. "bandwidth" bandwidth-avg bandwidth-burst bandwidth-observed
  121. Estimated bandwidth for this router, in bytes per second. The
  122. "average" bandwidth is the volume per second that the OR is willing to
  123. sustain over long periods; the "burst" bandwidth is the volume that
  124. the OR is willing to sustain in very short intervals. The "observed"
  125. value is an estimate of the capacity this server can handle. The
  126. server remembers the max bandwidth sustained output over any ten
  127. second period in the past day, and another sustained input. The
  128. "observed" value is the lesser of these two numbers.
  129. "platform" string
  130. A human-readable string describing the system on which this OR is
  131. running. This MAY include the operating system, and SHOULD include
  132. the name and version of the software implementing the Tor protocol.
  133. "published" YYYY-MM-DD HH:MM:SS
  134. The time, in GMT, when this descriptor was generated.
  135. "fingerprint"
  136. A fingerprint (a HASH_LEN-byte of asn1 encoded public key, encoded in
  137. hex, with a single space after every 4 characters) for this router's
  138. identity key. A descriptor is considered invalid (and MUST be
  139. rejected) if the fingerprint line does not match the public key.
  140. [We didn't start parsing this line until Tor 0.1.0.6-rc; it should
  141. be marked with "opt" until earlier versions of Tor are obsolete.]
  142. "hibernating" 0|1
  143. If the value is 1, then the Tor server was hibernating when the
  144. descriptor was published, and shouldn't be used to build circuits.
  145. [We didn't start parsing this line until Tor 0.1.0.6-rc; it should be
  146. marked with "opt" until earlier versions of Tor are obsolete.]
  147. "uptime"
  148. The number of seconds that this OR process has been running.
  149. "onion-key" NL a public key in PEM format
  150. This key is used to encrypt EXTEND cells for this OR. The key MUST be
  151. accepted for at least XXXX hours after any new key is published in a
  152. subsequent descriptor.
  153. "signing-key" NL a public key in PEM format
  154. The OR's long-term identity key.
  155. "accept" exitpattern
  156. "reject" exitpattern
  157. These lines, in order, describe the rules that an OR follows when
  158. deciding whether to allow a new stream to a given address. The
  159. 'exitpattern' syntax is described below.
  160. "router-signature" NL Signature NL
  161. The "SIGNATURE" object contains a signature of the PKCS1-padded
  162. hash of the entire router descriptor, taken from the beginning of the
  163. "router" line, through the newline after the "router-signature" line.
  164. The router descriptor is invalid unless the signature is performed
  165. with the router's identity key.
  166. "contact" info NL
  167. Describes a way to contact the server's administrator, preferably
  168. including an email address and a PGP key fingerprint.
  169. "family" names NL
  170. 'Names' is a whitespace-separated list of server nicknames. If two
  171. ORs list one another in their "family" entries, then OPs should treat
  172. them as a single OR for the purpose of path selection.
  173. For example, if node A's descriptor contains "family B", and node B's
  174. descriptor contains "family A", then node A and node B should never
  175. be used on the same circuit.
  176. "read-history" YYYY-MM-DD HH:MM:SS (NSEC s) NUM,NUM,NUM,NUM,NUM... NL
  177. "write-history" YYYY-MM-DD HH:MM:SS (NSEC s) NUM,NUM,NUM,NUM,NUM... NL
  178. Declare how much bandwidth the OR has used recently. Usage is divided
  179. into intervals of NSEC seconds. The YYYY-MM-DD HH:MM:SS field
  180. defines the end of the most recent interval. The numbers are the
  181. number of bytes used in the most recent intervals, ordered from
  182. oldest to newest.
  183. [We didn't start parsing these lines until Tor 0.1.0.6-rc; they should
  184. be marked with "opt" until earlier versions of Tor are obsolete.]
  185. 2.1. Nonterminals in routerdescriptors
  186. nickname ::= between 1 and 19 alphanumeric characters, case-insensitive.
  187. exitpattern ::= addrspec ":" portspec
  188. portspec ::= "*" | port | port "-" port
  189. port ::= an integer between 1 and 65535, inclusive.
  190. addrspec ::= "*" | ip4spec | ip6spec
  191. ipv4spec ::= ip4 | ip4 "/" num_ip4_bits | ip4 "/" ip4mask
  192. ip4 ::= an IPv4 address in dotted-quad format
  193. ip4mask ::= an IPv4 mask in dotted-quad format
  194. num_ip4_bits ::= an integer between 0 and 32
  195. ip6spec ::= ip6 | ip6 "/" num_ip6_bits
  196. ip6 ::= an IPv6 address, surrounded by square brackets.
  197. num_ip6_bits ::= an integer between 0 and 128
  198. Ports are required; if they are not included in the router
  199. line, they must appear in the "ports" lines.
  200. 3. Network status format
  201. Directory authorities generate, sign, and compress network-status
  202. documents. Directory servers SHOULD generate a fresh network-status
  203. document when the contents of such a document would be different from the
  204. last one generated, and some time (at least one second, possibly longer)
  205. has passed since the last one was generated.
  206. The network status document contains a preamble, a set of router status
  207. entries, and a signature, in that order.
  208. We use the same meta-format as used for directories and router descriptors
  209. in "tor-spec.txt". Implementations MAY insert blank lines
  210. for clarity between sections; these blank lines are ignored.
  211. Implementations MUST NOT depend on blank lines in any particular location.
  212. As used here, "whitespace" is a sequence of 1 or more tab or space
  213. characters.
  214. The preamble contains:
  215. "network-status-version" -- A document format version. For this
  216. specification, the version is "2".
  217. "dir-source" -- The authority's hostname, current IP address, and
  218. directory port, all separated by whitespace.
  219. "fingerprint" -- A base16-encoded hash of the signing key's
  220. fingerprint, with no additional spaces added.
  221. "contact" -- An arbitrary string describing how to contact the
  222. directory server's administrator. Administrators should include at
  223. least an email address and a PGP fingerprint.
  224. "dir-signing-key" -- The directory server's public signing key.
  225. "client-versions" -- A comma-separated list of recommended client
  226. versions.
  227. "server-versions" -- A comma-separated list of recommended server
  228. versions.
  229. "published" -- The publication time for this network-status object.
  230. "dir-options" -- A set of flags, in any order, separated by whitespace:
  231. "Names" if this directory authority performs name bindings.
  232. "Versions" if this directory authority recommends software versions.
  233. The dir-options entry is optional. The "-versions" entries are required if
  234. the "Versions" flag is present. The other entries are required and must
  235. appear exactly once. The "network-status-version" entry must appear first;
  236. the others may appear in any order. Implementations MUST ignore
  237. additional arguments to the items above, and MUST ignore unrecognized
  238. flags.
  239. For each router, the router entry contains: (This format is designed for
  240. conciseness.)
  241. "r" -- followed by the following elements, in order, separated by
  242. whitespace:
  243. - The OR's nickname,
  244. - A hash of its identity key, encoded in base64, with trailing =
  245. signs removed.
  246. - A hash of its most recent descriptor, encoded in base64, with
  247. trailing = signs removed. (The hash is calculated as for
  248. computing the signature of a descriptor.)
  249. - The publication time of its most recent descriptor, in the form
  250. YYYY-MM-DD HH:MM:SS, in GMT.
  251. - An IP address
  252. - An OR port
  253. - A directory port (or "0" for none")
  254. "s" -- A series of whitespace-separated status flags, in any order:
  255. "Authority" if the router is a directory authority.
  256. "Exit" if the router is useful for building general-purpose exit
  257. circuits.
  258. "Fast" if the router is suitable for high-bandwidth circuits.
  259. "Guard" if the router is suitable for use as an entry guard.
  260. (Currently, this means 'fast' and 'stable'.)
  261. "Named" if the router's identity-nickname mapping is canonical,
  262. and this authority binds names.
  263. "Stable" if the router is suitable for long-lived circuits.
  264. "Running" if the router is currently usable.
  265. "Valid" if the router has been 'validated'.
  266. "V2Dir" if the router implements this protocol.
  267. The "r" entry for each router must appear first and is required. The
  268. "s" entry is optional. Unrecognized flags on the "s" line and extra
  269. elements on the "r" line must be ignored.
  270. The signature section contains:
  271. "directory-signature". A signature of the rest of the document
  272. (the document up until the signature, including the line
  273. "directory-signature <nick>\n") using the directory authority's
  274. signing key.
  275. We compress the network status list with zlib before transmitting it.
  276. 3.1. Establishing server status
  277. (This section describes how directory authorities choose which status
  278. flags to apply to routers, as of Tor 0.1.1.18-rc. Later directory
  279. authorities MAY do things differently, so long as clients keep working
  280. well. Clients MUST NOT depend on the exact behaviors in this section.)
  281. "Valid" -- a router is 'Valid' if it seems to have been running well for a
  282. while, and is running a version of Tor not known to be broken, and the
  283. directory authority has not blacklisted it as suspicious.
  284. "Named" -- Directory authority administrators may decide to support name
  285. binding. If they do, then they must maintain a file of
  286. nickname-to-identity-key mappings, and try to keep this file consistent
  287. with other directory authorities. If they don't, they act as clients, and
  288. report bindings made by other directory authorities (name X is bound to
  289. identity Y if at least one binding directory lists it, and no directory
  290. binds X to some other Y'.) A router is called 'Named' if the router
  291. believes the given name should be bound to the given key.
  292. "Running" -- A router is 'Running' if the authority managed to connect to
  293. it successfully within the last 30 minutes.
  294. "Stable" -- A router is 'Stable' if its uptime is above median for known
  295. running, valid routers, and it's running a version of Tor not known to
  296. drop circuits stupidly. (0.1.1.10-alpha throught 0.1.1.16-rc are stupid
  297. this way.)
  298. "Fast" -- A router is 'Fast' if its bandwidth is in the top 7/8ths for
  299. known running, valid routers.
  300. "Guard" -- A router is a possible 'Guard' if it is 'Stable' and its
  301. bandwidth is above median for known running, valid routers.
  302. "Authority" -- A router is called an 'Authority' if the authority
  303. generating the network-status document believes it is an authority.
  304. "V2Dir" -- A router supports the v2 directory protocol if it has an open
  305. directory port, and it is running a version of the directory protocol that
  306. supports the functionality clients need. (Currently, this is
  307. 0.1.1.9-alpha or later.)
  308. Directory server administrators may label some servers or IPs as
  309. blacklisted, and elect not to include them in their network-status lists.
  310. Thus, the network-status list includes all non-blacklisted,
  311. non-expired, non-superseded descriptors for ORs that the directory has
  312. observed at least once to be running.
  313. 4. Directory server operation
  314. All directory authorities and directory mirrors ("directory servers")
  315. implement this section, except as noted.
  316. 4.1. Accepting uploads (authorities only)
  317. When a router posts a signed descriptor to a directory authority, the
  318. authority first checks whether it is well-formed and correctly
  319. self-signed. If it is, the authority next verifies that the nickname
  320. question is already assigned to a router with a different public key.
  321. Finally, the authority MAY check that the router is not blacklisted
  322. because of its key, IP, or another reason.
  323. If the descriptor passes these tests, and the authority does not already
  324. have a descriptor for a router with this public key, it accepts the
  325. descriptor and remembers it.
  326. If the authority _does_ have a descriptor with the same public key, the
  327. newly uploaded descriptor is remembered if its publication time is more
  328. recent than the most recent old descriptor for that router, and either:
  329. - There are non-cosmetic differences between the old descriptor and the
  330. new one.
  331. - Enough time has passed between the descriptors' publication times.
  332. (Currently, 12 hours.)
  333. Differences between router descriptors are "non-cosmetic" if they would be
  334. sufficient to force an upload as described in section 2 above.
  335. Note that the "cosmetic difference" test only applies to uploaded
  336. descriptors, not to descriptors that the authority downloads from other
  337. authorities.
  338. 4.2. Downloading network-status documents (authorities and caches)
  339. All directory servers (authorities and mirrors) try to keep a fresh
  340. set of network-status documents from every authority. To do so,
  341. every 5 minutes, each authority asks every other authority for its
  342. most recent network-status document. Every 15 minutes, each mirror
  343. picks a random authority and asks it for the most recent network-status
  344. documents for all the authorities the authority knows about (including
  345. the chosen authority itself).
  346. Directory servers and mirrors remember and serve the most recent
  347. network-status document they have from each authority. Other
  348. network-status documents don't need to be stored. If the most recent
  349. network-status document is over 10 days old, it is discarded anyway.
  350. Mirrors SHOULD store and serve network-status documents from authorities
  351. they don't recognize, but SHOULD NOT use such documents for any other
  352. purpose. Mirrors SHOULD discard network-status documents older than 48
  353. hours.
  354. 4.3. Downloading and storing router descriptors (authorities and caches)
  355. Periodically (currently, every 10 seconds), directory servers check
  356. whether there are any specific descriptors (as identified by descriptor
  357. hash in a network-status document) that they do not have and that they
  358. are not currently trying to download.
  359. If so, the directory server launches requests to the authorities for these
  360. descriptors, such that each authority is only asked for descriptors listed
  361. in its most recent network-status. When more than one authority lists the
  362. descriptor, we choose which to ask at random.
  363. If one of these downloads fails, we do not try to download that descriptor
  364. from the authority that failed to serve it again unless we receive a newer
  365. network-status from that authority that lists the same descriptor.
  366. Directory servers must potentially cache multiple descriptors for each
  367. router. Servers must not discard any descriptor listed by any current
  368. network-status document from any authority. If there is enough space to
  369. store additional descriptors, servers SHOULD try to hold those which
  370. clients are likely download the most. (Currently, this is judged based on
  371. the interval for which each descriptor seemed newest.)
  372. Authorities SHOULD NOT download descriptors for routers that they would
  373. immediately reject for reasons listed in 3.1.
  374. 4.4. HTTP URLs
  375. "Fingerprints" in these URLs are base-16-encoded SHA1 hashes.
  376. The authoritative network-status published by a host should be available at:
  377. http://<hostname>/tor/status/authority.z
  378. The network-status published by a host with fingerprint
  379. <F> should be available at:
  380. http://<hostname>/tor/status/fp/<F>.z
  381. The network-status documents published by hosts with fingerprints
  382. <F1>,<F2>,<F3> should be available at:
  383. http://<hostname>/tor/status/fp/<F1>+<F2>+<F3>.z
  384. The most recent network-status documents from all known authorities,
  385. concatenated, should be available at:
  386. http://<hostname>/tor/status/all.z
  387. The most recent descriptor for a server whose identity key has a
  388. fingerprint of <F> should be available at:
  389. http://<hostname>/tor/server/fp/<F>.z
  390. The most recent descriptors for servers with identity fingerprints
  391. <F1>,<F2>,<F3> should be available at:
  392. http://<hostname>/tor/server/fp/<F1>+<F2>+<F3>.z
  393. (NOTE: Implementations SHOULD NOT download descriptors by identity key
  394. fingerprint. This allows a corrupted server (in collusion with a cache) to
  395. provide a unique descriptor to a client, and thereby partition that client
  396. from the rest of the network.)
  397. The server descriptor with (descriptor) digest <D> (in hex) should be
  398. available at:
  399. http://<hostname>/tor/server/d/<D>.z
  400. The most recent descriptors with digests <D1>,<D2>,<D3> should be
  401. available at:
  402. http://<hostname>/tor/server/d/<D1>+<D2>+<D3>.z
  403. The most recent descriptor for this server should be at:
  404. http://<hostname>/tor/server/authority.z
  405. [Nothing in the Tor protocol uses this resource yet, but it is useful
  406. for debugging purposes. Also, the official Tor implementations
  407. (starting at 0.1.1.x) use this resource to test whether a server's
  408. own DirPort is reachable.]
  409. A concatenated set of the most recent descriptors for all known servers
  410. should be available at:
  411. http://<hostname>/tor/server/all.z
  412. For debugging, directories SHOULD expose non-compressed objects at URLs like
  413. the above, but without the final ".z".
  414. Clients MUST handle compressed concatenated information in two forms:
  415. - A concatenated list of zlib-compressed objects.
  416. - A zlib-compressed concatenated list of objects.
  417. Directory servers MAY generate either format: the former requires less
  418. CPU, but the latter requires less bandwidth.
  419. Clients SHOULD use upper case letters (A-F) when base16-encoding
  420. fingerprints. Servers MUST accept both upper and lower case fingerprints
  421. in requests.
  422. 5. Client operation: downloading information
  423. Every Tor that is not a directory server (that is, those that do
  424. not have a DirPort set) implements this section.
  425. 5.1. Downloading network-status documents
  426. Each client maintains an ordered list of directory authorities.
  427. Insofar as possible, clients SHOULD all use the same ordered list.
  428. For each network-status document a client has, it keeps track of its
  429. publication time *and* the time when the client retrieved it. Clients
  430. consider a network-status document "live" if it was published within the
  431. last 24 hours.
  432. Clients try to have a live network-status document hours from *every*
  433. authority, and try to periodically get new network-status documents from
  434. each authority in rotation as follows:
  435. If a client is missing a live network-status document for any
  436. authority, it tries to fetch it from a directory cache. On failure,
  437. the client waits briefly, then tries that network-status document
  438. again from another cache. The client does not build circuits until it
  439. has live network-status documents from more than half the authorities
  440. it trusts, and it has descriptors for more than 1/4 of the routers
  441. that it believes are running.
  442. If the most recently _retrieved_ network-status document is over 30
  443. minutes old, the client attempts to download a network-status document.
  444. When choosing which documents to download, clients treat their list of
  445. directory authorities as a circular ring, and begin with the authority
  446. appearing immediately after the authority for their most recently
  447. retrieved network-status document. If this attempt fails, the client
  448. retries at other caches several times, before moving on to the next
  449. network-status document in sequence.
  450. Clients discard all network-status documents over 24 hours old.
  451. If enough mirrors (currently 4) claim not to have a given network status,
  452. we stop trying to download that authority's network-status, until we
  453. download a new network-status that makes us believe that the authority in
  454. question is running. Clients should wait a little longer after each
  455. failure.
  456. Clients SHOULD try to batch as many network-status requests as possible
  457. into each HTTP GET.
  458. (Note: clients can and should pick caches based on the network-status
  459. information they have: once they have first fetched network-status info
  460. from an authority, they should not need to go to the authority directly
  461. again.)
  462. 5.2. Downloading router descriptors
  463. Clients try to have the best descriptor for each router. A descriptor is
  464. "best" if:
  465. * It is the most recently published descriptor listed for that router
  466. by at least two network-status documents.
  467. OR,
  468. * No descriptor for that router is listed by two or more
  469. network-status documents, and it is the most recently published
  470. descriptor listed by any network-status document.
  471. Periodically (currently every 10 seconds) clients check whether there are
  472. any "downloadable" descriptors. A descriptor is downloadable if:
  473. - It is the "best" descriptor for some router.
  474. - The descriptor was published at least 10 minutes in the past.
  475. (This prevents clients from trying to fetch descriptors that the
  476. mirrors have probably not yet retrieved and cached.)
  477. - The client does not currently have it.
  478. - The client is not currently trying to download it.
  479. - The client would not discard it immediately upon receiving it.
  480. - The client thinks it is running and valid (see 6.1 below).
  481. If at least 16 known routers have downloadable descriptors, or if
  482. enough time (currently 10 minutes) has passed since the last time the
  483. client tried to download descriptors, it launches requests for all
  484. downloadable descriptors, as described in 5.3 below.
  485. When a descriptor download fails, the client notes it, and does not
  486. consider the descriptor downloadable again until a certain amount of time
  487. has passed. (Currently 0 seconds for the first failure, 60 seconds for the
  488. second, 5 minutes for the third, 10 minutes for the fourth, and 1 day
  489. thereafter.) Periodically (currently once an hour) clients reset the
  490. failure count.
  491. No descriptors are downloaded until the client has downloaded more than
  492. half of the network-status documents.
  493. 5.3. Managing downloads
  494. When a client has no live network-status documents, it downloads
  495. network-status documents from a randomly chosen authority. In all other
  496. cases, the client downloads from mirrors randomly chosen from among those
  497. believed to be V2 directory servers. (This information comes from the
  498. network-status documents; see 6 below.)
  499. When downloading multiple router descriptors, the client chooses multiple
  500. mirrors so that:
  501. - At least 3 different mirrors are used, except when this would result
  502. in more than one request for under 4 descriptors.
  503. - No more than 128 descriptors are requested from a single mirror.
  504. - Otherwise, as few mirrors as possible are used.
  505. After choosing mirrors, the client divides the descriptors among them
  506. randomly.
  507. After receiving any response client MUST discard any network-status
  508. documents and descriptors that it did not request.
  509. 6. Using directory information
  510. Everyone besides directory authorities uses the approaches in this section
  511. to decide which servers to use and what their keys are likely to be.
  512. (Directory authorities just believe their own opinions, as in 3.1 above.)
  513. 6.1. Choosing routers for circuits.
  514. Tor implementations only pay attention to "live" network-status documents.
  515. A network status is "live" if it is the most recently downloaded network
  516. status document for a given directory server, and the server is a
  517. directory server trusted by the client, and the network-status document is
  518. no more than 1 day old.
  519. For time-sensitive information, Tor implementations focus on "recent"
  520. network-status documents. A network status is "recent" if it is live, and
  521. if it was published in the last 60 minutes. If there are fewer
  522. than 3 such documents, the most recently published 3 are "recent." If
  523. there are fewer than 3 in all, all are "recent.")
  524. Circuits SHOULD NOT be built until the client has enough directory
  525. information: network-statuses (or failed attempts to download
  526. network-statuses) for all authorities, network-statuses for at more than
  527. half of the authorites, and descriptors for at least 1/4 of the servers
  528. believed to be running.
  529. A server is "listed" if it is included by more than half of the live
  530. network status documents. Clients SHOULD NOT use unlisted servers.
  531. Clients believe the flags "Valid", "Exit", "Fast", "Guard", "Stable", and
  532. "V2Dir" about a given router when they are asserted by more than half of
  533. the live network-status documents. Clients believe the flag "Running" if
  534. it is listed by more than half of the recent network-status documents.
  535. These flags are used as follows:
  536. - Clients SHOULD NOT use non-'Valid' or non-'Running' routers unless
  537. requested to do so.
  538. - Clients SHOULD NOT use non-'Fast' routers for any purpose other than
  539. very-low-bandwidth circuits (such as introduction circuits).
  540. - Clients SHOULD NOT use non-'Stable' routers for circuits that are
  541. likely to need to be open for a very long time (such as those used for
  542. IRC or SSH connections).
  543. - Clients SHOULD NOT choose non-'Guard' nodes when picking entry guard
  544. nodes.
  545. - Clients SHOULD NOT download directory information from non-'V2Dir'
  546. caches.
  547. 6.1. Managing naming
  548. In order to provide human-memorable names for individual server
  549. identities, some directory servers bind names to IDs. Clients handle
  550. names in two ways:
  551. When a client encounters a name it has not mapped before:
  552. If all the live "Naming" network-status documents the client has
  553. claim that the name binds to some identity ID, and the client has at
  554. least three live network-status documents, the client maps the name to
  555. ID.
  556. If a client encounters a name it has mapped before:
  557. It uses the last-mapped identity value, unless all of the "Naming"
  558. network status documents that list the name bind it to some other
  559. identity.
  560. When a user tries to refer to a router with a name that does not have a
  561. mapping under the above rules, the implementation SHOULD warn the user.
  562. After giving the warning, the implementation MAY use a router that at
  563. least one Naming authority maps the name to, so long as no other naming
  564. authority maps that name to a different router.
  565. (XXXX The last-bound thing above isn't implemented)
  566. 6.2. Software versions
  567. An implementation of Tor SHOULD warn when it has fetched (or has
  568. attempted to fetch and failed four consecutive times) a network-status
  569. for each authority, and it is running a software version
  570. not listed on more than half of the live "Versioning" network-status
  571. documents.
  572. 6.3. Warning about a router's status.
  573. If a router tries to publish its descriptor to a Naming authority
  574. that has its nickname mapped to another key, the router SHOULD
  575. warn the operator that it is either using the wrong key or is using
  576. an already claimed nickname.
  577. If a router has fetched (or attempted to fetch and failed four
  578. consecutive times) a network-status for every authority, and at
  579. least one of the authorities is "Naming", and no live "Naming"
  580. authorities publish a binding for the router's nickname, the
  581. router MAY remind the operator that the chosen nickname is not
  582. bound to this key at the authorities, and suggest contacting the
  583. authority operators.
  584. ...