rend-spec.txt 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759
  1. $Id$
  2. Tor Rendezvous Specification
  3. 0. Overview and preliminaries
  4. Read https://www.torproject.org/doc/design-paper/tor-design.html#sec:rendezvous
  5. before you read this specification. It will make more sense.
  6. Rendezvous points provide location-hidden services (server
  7. anonymity) for the onion routing network. With rendezvous points,
  8. Bob can offer a TCP service (say, a webserver) via the onion
  9. routing network, without revealing the IP of that service.
  10. Bob does this by anonymously advertising a public key for his
  11. service, along with a list of onion routers to act as "Introduction
  12. Points" for his service. He creates forward circuits to those
  13. introduction points, and tells them about his public key. To
  14. connect to Bob, Alice first builds a circuit to an OR to act as
  15. her "Rendezvous Point." She then connects to one of Bob's chosen
  16. introduction points, optionally provides authentication or
  17. authorization information, and asks it to tell him about her Rendezvous
  18. Point (RP). If Bob chooses to answer, he builds a circuit to her
  19. RP, and tells it to connect him to Alice. The RP joins their
  20. circuits together, and begins relaying cells. Alice's 'BEGIN'
  21. cells are received directly by Bob's OP, which passes data to
  22. and from the local server implementing Bob's service.
  23. Below we describe a network-level specification of this service,
  24. along with interfaces to make this process transparent to Alice
  25. (so long as she is using an OP).
  26. 0.1. Notation, conventions and prerequisites
  27. In the specifications below, we use the same notation and terminology
  28. as in "tor-spec.txt". The service specified here also requires the
  29. existence of an onion routing network as specified in that file.
  30. H(x) is a SHA1 digest of x.
  31. PKSign(SK,x) is a PKCS.1-padded RSA signature of x with SK.
  32. PKEncrypt(SK,x) is a PKCS.1-padded RSA encryption of x with SK.
  33. Public keys are all RSA, and encoded in ASN.1.
  34. All integers are stored in network (big-endian) order.
  35. All symmetric encryption uses AES in counter mode, except where
  36. otherwise noted.
  37. In all discussions, "Alice" will refer to a user connecting to a
  38. location-hidden service, and "Bob" will refer to a user running a
  39. location-hidden service.
  40. An OP is (as defined elsewhere) an "Onion Proxy" or Tor client.
  41. An OR is (as defined elsewhere) an "Onion Router" or Tor server.
  42. An "Introduction point" is a Tor server chosen to be Bob's medium-term
  43. 'meeting place'. A "Rendezvous point" is a Tor server chosen by Alice to
  44. be a short-term communication relay between her and Bob. All Tor servers
  45. potentially act as introduction and rendezvous points.
  46. 0.2. Protocol outline
  47. 1. Bob->Bob's OP: "Offer IP:Port as
  48. public-key-name:Port". [configuration]
  49. (We do not specify this step; it is left to the implementor of
  50. Bob's OP.)
  51. 2. Bob's OP generates keypair and rendezvous service descriptor:
  52. "Meet public-key X at introduction point A, B, or C." (signed)
  53. 3. Bob's OP->Introduction point via Tor: [introduction setup]
  54. "This pk is me."
  55. 4. Bob's OP->directory service via Tor: publishes Bob's service
  56. descriptor [advertisement]
  57. 5. Out of band, Alice receives a [x.y.]z.onion:port address.
  58. She opens a SOCKS connection to her OP, and requests
  59. x.y.z.onion:port.
  60. 6. Alice's OP retrieves Bob's descriptor via Tor. [descriptor lookup.]
  61. 7. Alice's OP chooses a rendezvous point, opens a circuit to that
  62. rendezvous point, and establishes a rendezvous circuit. [rendezvous
  63. setup.]
  64. 8. Alice connects to the Introduction point via Tor, and tells it about
  65. her rendezvous point and optional authentication/authorization
  66. information. (Encrypted to Bob.) [Introduction 1]
  67. 9. The Introduction point passes this on to Bob's OP via Tor, along the
  68. introduction circuit. [Introduction 2]
  69. 10. Bob's OP decides whether to connect to Alice, and if so, creates a
  70. circuit to Alice's RP via Tor. Establishes a shared circuit.
  71. [Rendezvous.]
  72. 11. Alice's OP sends begin cells to Bob's OP. [Connection]
  73. 0.3. Constants and new cell types
  74. Relay cell types
  75. 32 -- RELAY_ESTABLISH_INTRO
  76. 33 -- RELAY_ESTABLISH_RENDEZVOUS
  77. 34 -- RELAY_INTRODUCE1
  78. 35 -- RELAY_INTRODUCE2
  79. 36 -- RELAY_RENDEZVOUS1
  80. 37 -- RELAY_RENDEZVOUS2
  81. 38 -- RELAY_INTRO_ESTABLISHED
  82. 39 -- RELAY_RENDEZVOUS_ESTABLISHED
  83. 40 -- RELAY_COMMAND_INTRODUCE_ACK
  84. 0.4. Version overview
  85. There are several parts in the hidden service protocol that have
  86. changed over time, each of them having its own version number, whereas
  87. other parts remained the same. The following list of potentially
  88. versioned protocol parts should help reduce some confusion:
  89. - Hidden service descriptor: see 1.2.
  90. - Hidden service descriptor propagation mechanism: currently related to
  91. the hidden service descriptor version; see 1.4 and 1.6.
  92. - Introduction protocol: see 1.8.
  93. 1. The Protocol
  94. 1.1. Bob configures his local OP.
  95. We do not specify a format for the OP configuration file. However,
  96. OPs SHOULD allow Bob to provide more than one advertised service
  97. per OP, and MUST allow Bob to specify one or more virtual ports per
  98. service. Bob provides a mapping from each of these virtual ports
  99. to a local IP:Port pair.
  100. 1.2. Bob's OP generates service descriptors.
  101. The first time the OP provides an advertised service, it generates
  102. a public/private keypair (stored locally). Periodically, the OP
  103. generates and publishes a descriptor of type "V0".
  104. The "V0" descriptor contains:
  105. KL Key length [2 octets]
  106. PK Bob's public key [KL octets]
  107. TS A timestamp [4 octets]
  108. NI Number of introduction points [2 octets]
  109. Ipt A list of NUL-terminated ORs [variable]
  110. SIG Signature of above fields [variable]
  111. KL is the length of PK, in octets.
  112. TS is the number of seconds elapsed since Jan 1, 1970.
  113. The members of Ipt may be either (a) nicknames, or (b) identity key
  114. digests, encoded in hex, and prefixed with a '$'. Clients must
  115. accept both forms. Services must only generate the second form.
  116. Once 0.0.9.x is obsoleted, we can drop the first form.
  117. [It's ok for Bob to advertise 0 introduction points. He might want
  118. to do that if he previously advertised some introduction points,
  119. and now he doesn't have any. -RD]
  120. Beginning with 0.2.0.10-alpha, Bob's OP encodes "V2" descriptors in
  121. addition to "V0" descriptors. The format of a "V2" descriptor is as
  122. follows:
  123. "rendezvous-service-descriptor" descriptor-id NL
  124. [At start, exactly once]
  125. Indicates the beginning of the descriptor. "descriptor-id" is a
  126. periodically changing identifier of 160 bits formatted as 32 base32
  127. chars that is calculated by the hidden service and its clients. If
  128. the optional "descriptor-cookie" is used, this "descriptor-id"
  129. cannot be computed by anyone else. (Everyone can verify that this
  130. "descriptor-id" belongs to the rest of the descriptor, even without
  131. knowing the optional "descriptor-cookie", as described below.) The
  132. "descriptor-id" is calculated by performing the following operation:
  133. descriptor-id =
  134. H(permanent-id | H(time-period | descriptor-cookie | replica))
  135. "permanent-id" is the permanent identifier of the hidden service,
  136. consisting of 80 bits. It can be calculated by computing the hash value
  137. of the public hidden service key and truncating after the first 80 bits:
  138. permanent-id = H(public-key)[:10]
  139. "H(time-period | descriptor-cookie | replica)" is the (possibly
  140. secret) id part that is
  141. necessary to verify that the hidden service is the true originator
  142. of this descriptor. It can only be created by the hidden service
  143. and its clients, but the "signature" below can only be created by
  144. the service.
  145. "descriptor-cookie" is an optional secret password of 128 bits that
  146. is shared between the hidden service provider and its clients.
  147. "replica" denotes the number of the non-consecutive replica.
  148. (Each descriptor is replicated on a number of _consecutive_ nodes
  149. in the identifier ring by making every storing node responsible
  150. for the identifier intervals starting from its 3rd predecessor's
  151. ID to its own ID. In addition to that, every service publishes
  152. multiple descriptors with different descriptor IDs in order to
  153. distribute them to different places on the ring. Therefore,
  154. "replica" chooses one of the _non-consecutive_ replicas. -KL)
  155. The "time-period" changes periodically depending on the global time and
  156. as a function of "permanent-id". The current value for "time-period" can
  157. be calculated using the following formula:
  158. time-period = (current-time + permanent-id-byte * 86400 / 256)
  159. / 86400
  160. "current-time" contains the current system time in seconds since
  161. 1970-01-01 00:00, e.g. 1188241957. "permanent-id-byte" is the first
  162. (unsigned) byte of the permanent identifier (which is in network
  163. order), e.g. 143. Adding the product of "permanent-id-byte" and
  164. 86400 (seconds per day), divided by 256, prevents "time-period" from
  165. changing for all descriptors at the same time of the day. The result
  166. of the overall operation is a (network-ordered) 32-bit integer, e.g.
  167. 13753 or 0x000035B9 with the example values given above.
  168. "version" version-number NL
  169. [Exactly once]
  170. The version number of this descriptor's format. In this case: 2.
  171. "permanent-key" NL a public key in PEM format
  172. [Exactly once]
  173. The public key of the hidden service which is required to verify the
  174. "descriptor-id" and the "signature".
  175. "secret-id-part" secret-id-part NL
  176. [Exactly once]
  177. The result of the following operation as explained above, formatted as
  178. 32 base32 chars. Using this secret id part, everyone can verify that
  179. the signed descriptor belongs to "descriptor-id".
  180. secret-id-part = H(time-period | cookie | replica)
  181. "publication-time" YYYY-MM-DD HH:MM:SS NL
  182. [Exactly once]
  183. A timestamp when this descriptor has been created.
  184. "protocol-versions" version-string NL
  185. [Exactly once]
  186. A comma-separated list of recognized and permitted version numbers
  187. for use in INTRODUCE cells; these versions are described in section
  188. 1.8 below.
  189. "introduction-points" NL encrypted-string
  190. [At most once]
  191. A list of introduction points. If the optional "descriptor-cookie" is
  192. used, this list is encrypted with AES in CTR mode with a random
  193. initialization vector of 128 bits that is written to
  194. the beginning of the encrypted string, and the "descriptor-cookie" as
  195. secret key of 128 bits length.
  196. The string containing the introduction point data (either encrypted
  197. or not) is encoded in base64, and surrounded with
  198. "-----BEGIN MESSAGE-----" and "-----END MESSAGE-----".
  199. The unencrypted string may begin with:
  200. ["service-authentication" auth-type NL auth-data ... reserved]
  201. [At start, any number]
  202. The service-specific authentication data can be used to perform
  203. client authentication. This data is independent of the selected
  204. introduction point as opposed to "intro-authentication" below.
  205. Subsequently, an arbitrary number of introduction point entries may
  206. follow, each containing the following data:
  207. "introduction-point" identifier NL
  208. [At start, exactly once]
  209. The identifier of this introduction point: the base-32 encoded
  210. hash of this introduction point's identity key.
  211. "ip-address" ip-address NL
  212. [Exactly once]
  213. The IP address of this introduction point.
  214. "onion-port" port NL
  215. [Exactly once]
  216. The TCP port on which the introduction point is listening for
  217. incoming onion requests.
  218. "onion-key" NL a public key in PEM format
  219. [Exactly once]
  220. The public key that can be used to encrypt messages to this
  221. introduction point.
  222. "service-key" NL a public key in PEM format
  223. [Exactly once]
  224. The public key that can be used to encrypt messages to the hidden
  225. service.
  226. ["intro-authentication" auth-type NL auth-data ... reserved]
  227. [Any number]
  228. The introduction-point-specific authentication data can be used
  229. to perform client authentication. This data depends on the
  230. selected introduction point as opposed to "service-authentication"
  231. above.
  232. (This ends the fields in the encrypted portion of the descriptor.)
  233. "signature" NL signature-string
  234. [At end, exactly once]
  235. A signature of all fields above with the private key of the hidden
  236. service.
  237. 1.2.1. Other descriptor formats we don't use.
  238. The V1 descriptor format was understood and accepted from
  239. 0.1.1.5-alpha-cvs to 0.2.0.6-alpha-dev, but no Tors generated it and
  240. was removed:
  241. V Format byte: set to 255 [1 octet]
  242. V Version byte: set to 1 [1 octet]
  243. KL Key length [2 octets]
  244. PK Bob's public key [KL octets]
  245. TS A timestamp [4 octets]
  246. PROTO Protocol versions: bitmask [2 octets]
  247. NI Number of introduction points [2 octets]
  248. For each introduction point: (as in INTRODUCE2 cells)
  249. IP Introduction point's address [4 octets]
  250. PORT Introduction point's OR port [2 octets]
  251. ID Introduction point identity ID [20 octets]
  252. KLEN Length of onion key [2 octets]
  253. KEY Introduction point onion key [KLEN octets]
  254. SIG Signature of above fields [variable]
  255. A hypothetical "V1" descriptor, that has never been used but might
  256. be useful for historical reasons, contains:
  257. V Format byte: set to 255 [1 octet]
  258. V Version byte: set to 1 [1 octet]
  259. KL Key length [2 octets]
  260. PK Bob's public key [KL octets]
  261. TS A timestamp [4 octets]
  262. PROTO Rendezvous protocol versions: bitmask [2 octets]
  263. NA Number of auth mechanisms accepted [1 octet]
  264. For each auth mechanism:
  265. AUTHT The auth type that is supported [2 octets]
  266. AUTHL Length of auth data [1 octet]
  267. AUTHD Auth data [variable]
  268. NI Number of introduction points [2 octets]
  269. For each introduction point: (as in INTRODUCE2 cells)
  270. ATYPE An address type (typically 4) [1 octet]
  271. ADDR Introduction point's IP address [4 or 16 octets]
  272. PORT Introduction point's OR port [2 octets]
  273. AUTHT The auth type that is supported [2 octets]
  274. AUTHL Length of auth data [1 octet]
  275. AUTHD Auth data [variable]
  276. ID Introduction point identity ID [20 octets]
  277. KLEN Length of onion key [2 octets]
  278. KEY Introduction point onion key [KLEN octets]
  279. SIG Signature of above fields [variable]
  280. AUTHT specifies which authentication/authorization mechanism is
  281. required by the hidden service or the introduction point. AUTHD
  282. is arbitrary data that can be associated with an auth approach.
  283. Currently only AUTHT of [00 00] is supported, with an AUTHL of 0.
  284. See section 2 of this document for details on auth mechanisms.
  285. 1.3. Bob's OP establishes his introduction points.
  286. The OP establishes a new introduction circuit to each introduction
  287. point. These circuits MUST NOT be used for anything but rendezvous
  288. introduction. To establish the introduction, Bob sends a
  289. RELAY_ESTABLISH_INTRO cell, containing:
  290. KL Key length [2 octets]
  291. PK Bob's public key [KL octets]
  292. HS Hash of session info [20 octets]
  293. SIG Signature of above information [variable]
  294. [XXX011, need to add auth information here. -RD]
  295. To prevent replay attacks, the HS field contains a SHA-1 hash based on the
  296. shared secret KH between Bob's OP and the introduction point, as
  297. follows:
  298. HS = H(KH | "INTRODUCE")
  299. That is:
  300. HS = H(KH | [49 4E 54 52 4F 44 55 43 45])
  301. (KH, as specified in tor-spec.txt, is H(g^xy | [00]) .)
  302. Upon receiving such a cell, the OR first checks that the signature is
  303. correct with the included public key. If so, it checks whether HS is
  304. correct given the shared state between Bob's OP and the OR. If either
  305. check fails, the OP discards the cell; otherwise, it associates the
  306. circuit with Bob's public key, and dissociates any other circuits
  307. currently associated with PK. On success, the OR sends Bob a
  308. RELAY_INTRO_ESTABLISHED cell with an empty payload.
  309. If a hidden service is configured to publish only v2 hidden service
  310. descriptors, Bob's OP does not include its own public key in the
  311. RELAY_ESTABLISH_INTRO cell, but the public key of a freshly generated
  312. key pair. The OP also includes these fresh public keys in the v2 hidden
  313. service descriptor together with the other introduction point
  314. information. The reason is that the introduction point does not need to
  315. and therefore should not know for which hidden service it works, so as
  316. to prevent it from tracking the hidden service's activity. If the hidden
  317. service is configured to publish both, v0 and v2 descriptors, two
  318. separate sets of introduction points are established.
  319. 1.4. Bob's OP advertises his service descriptor(s).
  320. Bob's OP opens a stream to each directory server's directory port via Tor.
  321. (He may re-use old circuits for this.) Over this stream, Bob's OP makes
  322. an HTTP 'POST' request, to a URL "/tor/rendezvous/publish" relative to the
  323. directory server's root, containing as its body Bob's service descriptor.
  324. Bob should upload a service descriptor for each version format that
  325. is supported in the current Tor network.
  326. Upon receiving a descriptor, the directory server checks the signature,
  327. and discards the descriptor if the signature does not match the enclosed
  328. public key. Next, the directory server checks the timestamp. If the
  329. timestamp is more than 24 hours in the past or more than 1 hour in the
  330. future, or the directory server already has a newer descriptor with the
  331. same public key, the server discards the descriptor. Otherwise, the
  332. server discards any older descriptors with the same public key and
  333. version format, and associates the new descriptor with the public key.
  334. The directory server remembers this descriptor for at least 24 hours
  335. after its timestamp. At least every 18 hours, Bob's OP uploads a
  336. fresh descriptor.
  337. If Bob's OP is configured to publish v2 descriptors instead of or in
  338. addition to v0 descriptors, it does so to a changing subset of all v2
  339. hidden service directories instead of the authoritative directory
  340. servers. Therefore, Bob's OP opens a stream via Tor to all
  341. responsible hidden service directories. (He may re-use old circuits
  342. for this.) Over this stream, Bob's OP makes an HTTP 'POST' request to a
  343. URL "/tor/rendezvous2/publish" relative to the hidden service
  344. directory's root, containing as its body Bob's service descriptor.
  345. At any time, there are 6 hidden service directories responsible for
  346. keeping replicas of a descriptor; they consist of 2 sets of 3 hidden
  347. service directories with consecutive onion IDs. Bob's OP learns about
  348. the complete list of hidden service directories by filtering the
  349. consensus status document received from the directory authorities. A
  350. hidden service directory is deemed responsible for all descriptor IDs in
  351. the interval from its direct predecessor, exclusive, to its own ID,
  352. inclusive; it further holds replicas for its 2 predecessors. A
  353. participant only trusts its own routing list and never learns about
  354. routing information from other parties.
  355. Bob's OP publishes a new v2 descriptor once an hour or whenever its
  356. content changes. V2 descriptors can be found by clients within a given
  357. time period of 24 hours, after which they change their ID as described
  358. under 1.2. If a published descriptor would be valid for less than 60
  359. minutes (= 2 x 30 minutes to allow the server to be 30 minutes behind
  360. and the client 30 minutes ahead), Bob's OP publishes the descriptor
  361. under the ID of both, the current and the next publication period.
  362. 1.5. Alice receives a x.y.z.onion address.
  363. When Alice receives a pointer to a location-hidden service, it is as a
  364. hostname of the form "z.onion" or "y.z.onion" or "x.y.z.onion", where
  365. z is a base-32 encoding of a 10-octet hash of Bob's service's public
  366. key, computed as follows:
  367. 1. Let H = H(PK).
  368. 2. Let H' = the first 80 bits of H, considering each octet from
  369. most significant bit to least significant bit.
  370. 2. Generate a 16-character encoding of H', using base32 as defined
  371. in RFC 3548.
  372. (We only use 80 bits instead of the 160 bits from SHA1 because we
  373. don't need to worry about arbitrary collisions, and because it will
  374. make handling the url's more convenient.)
  375. The string "x", if present, is the base-32 encoding of the
  376. authentication/authorization required by the introduction point.
  377. The string "y", if present, is the base-32 encoding of the
  378. authentication/authorization required by the hidden service.
  379. Omitting a string is taken to mean auth type [00 00].
  380. See section 2 of this document for details on auth mechanisms.
  381. [Yes, numbers are allowed at the beginning. See RFC 1123. -NM]
  382. 1.6. Alice's OP retrieves a service descriptor.
  383. Alice opens a stream to a directory server via Tor, and makes an HTTP GET
  384. request for the document '/tor/rendezvous/<z>', where '<z>' is replaced
  385. with the encoding of Bob's public key as described above. (She may re-use
  386. old circuits for this.) The directory replies with a 404 HTTP response if
  387. it does not recognize <z>, and otherwise returns Bob's most recently
  388. uploaded service descriptor.
  389. If Alice's OP receives a 404 response, it tries the other directory
  390. servers, and only fails the lookup if none recognize the public key hash.
  391. Upon receiving a service descriptor, Alice verifies with the same process
  392. as the directory server uses, described above in section 1.4.
  393. The directory server gives a 400 response if it cannot understand Alice's
  394. request.
  395. Alice should cache the descriptor locally, but should not use
  396. descriptors that are more than 24 hours older than their timestamp.
  397. [Caching may make her partitionable, but she fetched it anonymously,
  398. and we can't very well *not* cache it. -RD]
  399. Alice's OP fetches v2 descriptors in parallel to v0 descriptors. Analog
  400. to the description in section 1.4, the OP fetches a v2 descriptor from a
  401. randomly chosen hidden service directory out of the changing subset of
  402. 6 nodes. If the request is unsuccessful, Alice retries the other
  403. remaining responsible hidden service directories one after the other.
  404. Alice relies on Bob to care about a potential clock skew between the two
  405. by possibly storing two sets of descriptors.
  406. Alice's OP opens a stream via Tor to the chosen v2 hidden service
  407. directory. (She may re-use old circuits for this.) Over this stream,
  408. Alice's OP makes an HTTP 'GET' request for the document
  409. "/tor/rendezvous2/<z>", where z is replaced with the encoding of the
  410. descriptor ID. The directory replies with a 404 HTTP response if it does
  411. not recognize <z>, and otherwise returns Bob's most recently uploaded
  412. service descriptor.
  413. 1.7. Alice's OP establishes a rendezvous point.
  414. When Alice requests a connection to a given location-hidden service,
  415. and Alice's OP does not have an established circuit to that service,
  416. the OP builds a rendezvous circuit. It does this by establishing
  417. a circuit to a randomly chosen OR, and sending a
  418. RELAY_ESTABLISH_RENDEZVOUS cell to that OR. The body of that cell
  419. contains:
  420. RC Rendezvous cookie [20 octets]
  421. [XXX011 this looks like an auth mechanism. should we generalize here? -RD]
  422. The rendezvous cookie is an arbitrary 20-byte value, chosen randomly by
  423. Alice's OP.
  424. Upon receiving a RELAY_ESTABLISH_RENDEZVOUS cell, the OR associates the
  425. RC with the circuit that sent it. It replies to Alice with an empty
  426. RELAY_RENDEZVOUS_ESTABLISHED cell to indicate success.
  427. Alice's OP MUST NOT use the circuit which sent the cell for any purpose
  428. other than rendezvous with the given location-hidden service.
  429. 1.8. Introduction: from Alice's OP to Introduction Point
  430. Alice builds a separate circuit to one of Bob's chosen introduction
  431. points, and sends it a RELAY_INTRODUCE1 cell containing:
  432. Cleartext
  433. PK_ID Identifier for Bob's PK [20 octets]
  434. Encrypted to Bob's PK:
  435. RP Rendezvous point's nickname [20 octets]
  436. RC Rendezvous cookie [20 octets]
  437. g^x Diffie-Hellman data, part 1 [128 octets]
  438. OR
  439. VER Version byte: set to 1. [1 octet]
  440. RP Rendezvous point nick or ID [42 octets]
  441. RC Rendezvous cookie [20 octets]
  442. g^x Diffie-Hellman data, part 1 [128 octets]
  443. OR
  444. VER Version byte: set to 2. [1 octet]
  445. IP Rendezvous point's address [4 octets]
  446. PORT Rendezvous point's OR port [2 octets]
  447. ID Rendezvous point identity ID [20 octets]
  448. KLEN Length of onion key [2 octets]
  449. KEY Rendezvous point onion key [KLEN octets]
  450. RC Rendezvous cookie [20 octets]
  451. g^x Diffie-Hellman data, part 1 [128 octets]
  452. PK_ID is the hash of Bob's public key. RP is NUL-padded and
  453. terminated. In version 0, it must contain a nickname. In version 1,
  454. it must contain EITHER a nickname or an identity key digest that is
  455. encoded in hex and prefixed with a '$'.
  456. The hybrid encryption to Bob's PK works just like the hybrid
  457. encryption in CREATE cells (see tor-spec). Thus the payload of the
  458. version 0 RELAY_INTRODUCE1 cell on the wire will contain
  459. 20+42+16+20+20+128=246 bytes, and the version 1 and version 2
  460. introduction formats have other sizes.
  461. Through Tor 0.2.0.6-alpha, clients only generated the v0 introduction
  462. format, whereas hidden services have understood and accepted v0,
  463. v1, and v2 since 0.1.1.x. As of Tor 0.2.0.7-alpha, clients switched
  464. to using the v2 intro format.
  465. If Alice has downloaded a v2 descriptor, she uses the contained public
  466. key ("service-key") instead of Bob's public key to create the
  467. RELAY_INTRODUCE1 cell as described above.
  468. 1.8.1. Other introduction formats we don't use.
  469. We briefly speculated about using the following format for the
  470. "encrypted to Bob's PK" part of the introduction, but no Tors have
  471. ever generated these.
  472. VER Version byte: set to 3. [1 octet]
  473. ATYPE An address type (typically 4) [1 octet]
  474. ADDR Rendezvous point's IP address [4 or 16 octets]
  475. PORT Rendezvous point's OR port [2 octets]
  476. AUTHT The auth type that is supported [2 octets]
  477. AUTHL Length of auth data [1 octet]
  478. AUTHD Auth data [variable]
  479. ID Rendezvous point identity ID [20 octets]
  480. KLEN Length of onion key [2 octets]
  481. KEY Rendezvous point onion key [KLEN octets]
  482. RC Rendezvous cookie [20 octets]
  483. g^x Diffie-Hellman data, part 1 [128 octets]
  484. 1.9. Introduction: From the Introduction Point to Bob's OP
  485. If the Introduction Point recognizes PK_ID as a public key which has
  486. established a circuit for introductions as in 1.3 above, it sends the body
  487. of the cell in a new RELAY_INTRODUCE2 cell down the corresponding circuit.
  488. (If the PK_ID is unrecognized, the RELAY_INTRODUCE1 cell is discarded.)
  489. After sending the RELAY_INTRODUCE2 cell, the OR replies to Alice with an
  490. empty RELAY_COMMAND_INTRODUCE_ACK cell. If no RELAY_INTRODUCE2 cell can
  491. be sent, the OR replies to Alice with a non-empty cell to indicate an
  492. error. (The semantics of the cell body may be determined later; the
  493. current implementation sends a single '1' byte on failure.)
  494. When Bob's OP receives the RELAY_INTRODUCE2 cell, it decrypts it with
  495. the private key for the corresponding hidden service, and extracts the
  496. rendezvous point's nickname, the rendezvous cookie, and the value of g^x
  497. chosen by Alice.
  498. 1.10. Rendezvous
  499. Bob's OP builds a new Tor circuit ending at Alice's chosen rendezvous
  500. point, and sends a RELAY_RENDEZVOUS1 cell along this circuit, containing:
  501. RC Rendezvous cookie [20 octets]
  502. g^y Diffie-Hellman [128 octets]
  503. KH Handshake digest [20 octets]
  504. (Bob's OP MUST NOT use this circuit for any other purpose.)
  505. If the RP recognizes RC, it relays the rest of the cell down the
  506. corresponding circuit in a RELAY_RENDEZVOUS2 cell, containing:
  507. g^y Diffie-Hellman [128 octets]
  508. KH Handshake digest [20 octets]
  509. (If the RP does not recognize the RC, it discards the cell and
  510. tears down the circuit.)
  511. When Alice's OP receives a RELAY_RENDEZVOUS2 cell on a circuit which
  512. has sent a RELAY_ESTABLISH_RENDEZVOUS cell but which has not yet received
  513. a reply, it uses g^y and H(g^xy) to complete the handshake as in the Tor
  514. circuit extend process: they establish a 60-octet string as
  515. K = SHA1(g^xy | [00]) | SHA1(g^xy | [01]) | SHA1(g^xy | [02])
  516. and generate
  517. KH = K[0..15]
  518. Kf = K[16..31]
  519. Kb = K[32..47]
  520. Subsequently, the rendezvous point passes relay cells, unchanged, from
  521. each of the two circuits to the other. When Alice's OP sends
  522. RELAY cells along the circuit, it first encrypts them with the
  523. Kf, then with all of the keys for the ORs in Alice's side of the circuit;
  524. and when Alice's OP receives RELAY cells from the circuit, it decrypts
  525. them with the keys for the ORs in Alice's side of the circuit, then
  526. decrypts them with Kb. Bob's OP does the same, with Kf and Kb
  527. interchanged.
  528. 1.11. Creating streams
  529. To open TCP connections to Bob's location-hidden service, Alice's OP sends
  530. a RELAY_BEGIN cell along the established circuit, using the special
  531. address "", and a chosen port. Bob's OP chooses a destination IP and
  532. port, based on the configuration of the service connected to the circuit,
  533. and opens a TCP stream. From then on, Bob's OP treats the stream as an
  534. ordinary exit connection.
  535. [ Except he doesn't include addr in the connected cell or the end
  536. cell. -RD]
  537. Alice MAY send multiple RELAY_BEGIN cells along the circuit, to open
  538. multiple streams to Bob. Alice SHOULD NOT send RELAY_BEGIN cells for any
  539. other address along her circuit to Bob; if she does, Bob MUST reject them.
  540. 2. Authentication and authorization.
  541. Foo.
  542. 3. Hidden service directory operation
  543. This section has been introduced with the v2 hidden service descriptor
  544. format. It contains all operations of a v2 hidden service directory that
  545. are required for the protocol described in section 1 to succeed with v2
  546. hidden service descriptors.
  547. 3.1. Configuring as hidden service directory
  548. Every onion router that has its directory port open can decide whether it
  549. wants to store and serve hidden service descriptors. An onion router which
  550. is configured as such includes the "hidden-service-dir" flag in its router
  551. descriptors that it sends to directory authorities.
  552. The directory authorities include a new flag "HSDir" for routers that
  553. decided to provide storage for hidden service descriptors and that are
  554. running for at least 24 hours.
  555. 3.2. Accepting publish requests
  556. Hidden service directory nodes accept publish requests for v2 hidden service
  557. descriptors and store them to their local memory. (It is not necessary to
  558. make descriptors persistent, because after disconnecting, the onion router
  559. would not be accepted as storing node anyway, because it has not been
  560. running for at least 24 hours.) All requests and replies are formatted as
  561. HTTP messages. Requests are contained within BEGIN_DIR cells, directed to
  562. the router's directory port, and formatted as HTTP POST requests to the URL
  563. "/tor/rendezvous2/publish" relative to the hidden service directory's root,
  564. containing as its body a v2 service descriptor.
  565. A hidden service directory node parses every received descriptor and only
  566. stores it when it thinks that it is responsible for storing that descriptor
  567. based on its own routing table. See section 1.4 for more information on how
  568. to determine responsibility for a certain descriptor ID.
  569. 3.3. Processing fetch requests
  570. Hidden service directory nodes process fetch requests for hidden service
  571. descriptors by looking them up in their local memory. (They do not need to
  572. determine if they are responsible for the passed ID, because it does no harm
  573. if they deliver a descriptor for which they are not (any more) responsible.)
  574. All requests and replies are formatted as HTTP messages. Requests are
  575. contained within BEGIN_DIR cells, directed to the router's directory port,
  576. and formatted as HTTP GET requests for the document "/tor/rendezvous2/<z>",
  577. where z is replaced with the encoding of the descriptor ID.