Packet.hpp 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345
  1. /*
  2. * ZeroTier One - Network Virtualization Everywhere
  3. * Copyright (C) 2011-2016 ZeroTier, Inc. https://www.zerotier.com/
  4. *
  5. * This program is free software: you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation, either version 3 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17. */
  18. #ifndef ZT_N_PACKET_HPP
  19. #define ZT_N_PACKET_HPP
  20. #include <stdint.h>
  21. #include <string.h>
  22. #include <stdio.h>
  23. #include <string>
  24. #include <iostream>
  25. #include "Constants.hpp"
  26. #include "Address.hpp"
  27. #include "Poly1305.hpp"
  28. #include "Salsa20.hpp"
  29. #include "Utils.hpp"
  30. #include "Buffer.hpp"
  31. #include "../ext/lz4/lz4.h"
  32. /**
  33. * Protocol version -- incremented only for major changes
  34. *
  35. * 1 - 0.2.0 ... 0.2.5
  36. * 2 - 0.3.0 ... 0.4.5
  37. * + Added signature and originating peer to multicast frame
  38. * + Double size of multicast frame bloom filter
  39. * 3 - 0.5.0 ... 0.6.0
  40. * + Yet another multicast redesign
  41. * + New crypto completely changes key agreement cipher
  42. * 4 - 0.6.0 ... 1.0.6
  43. * + New identity format based on hashcash design
  44. * 5 - 1.1.0 ... 1.1.5
  45. * + Supports circuit test, proof of work, and echo
  46. * + Supports in-band world (root server definition) updates
  47. * + Clustering! (Though this will work with protocol v4 clients.)
  48. * + Otherwise backward compatible with protocol v4
  49. * 6 - 1.1.5 ... CURRENT
  50. * + Deprecate old dictionary-based network config format
  51. * + Introduce new binary serialized network config and meta-data
  52. */
  53. #define ZT_PROTO_VERSION 6
  54. /**
  55. * Minimum supported protocol version
  56. */
  57. #define ZT_PROTO_VERSION_MIN 4
  58. /**
  59. * Maximum hop count allowed by packet structure (3 bits, 0-7)
  60. *
  61. * This is a protocol constant. It's the maximum allowed by the length
  62. * of the hop counter -- three bits. See node/Constants.hpp for the
  63. * pragmatic forwarding limit, which is typically lower.
  64. */
  65. #define ZT_PROTO_MAX_HOPS 7
  66. /**
  67. * Cipher suite: Curve25519/Poly1305/Salsa20/12/NOCRYPT
  68. *
  69. * This specifies Poly1305 MAC using a 32-bit key derived from the first
  70. * 32 bytes of a Salsa20/12 keystream as in the Salsa20/12 cipher suite,
  71. * but the payload is not encrypted. This is currently only used to send
  72. * HELLO since that's the public key specification packet and must be
  73. * sent in the clear. Key agreement is performed using Curve25519 elliptic
  74. * curve Diffie-Hellman.
  75. */
  76. #define ZT_PROTO_CIPHER_SUITE__C25519_POLY1305_NONE 0
  77. /**
  78. * Cipher suite: Curve25519/Poly1305/Salsa20/12
  79. *
  80. * This specifies Poly1305 using the first 32 bytes of a Salsa20/12 key
  81. * stream as its one-time-use key followed by payload encryption with
  82. * the remaining Salsa20/12 key stream. Key agreement is performed using
  83. * Curve25519 elliptic curve Diffie-Hellman.
  84. */
  85. #define ZT_PROTO_CIPHER_SUITE__C25519_POLY1305_SALSA2012 1
  86. /**
  87. * DEPRECATED payload encrypted flag, will be removed for re-use soon.
  88. *
  89. * This has been replaced by the three-bit cipher suite selection field where
  90. * a value of 0 indicates unencrypted (but authenticated) messages.
  91. */
  92. #define ZT_PROTO_FLAG_ENCRYPTED 0x80
  93. /**
  94. * Header flag indicating that a packet is fragmented
  95. *
  96. * If this flag is set, the receiver knows to expect more than one fragment.
  97. * See Packet::Fragment for details.
  98. */
  99. #define ZT_PROTO_FLAG_FRAGMENTED 0x40
  100. /**
  101. * Verb flag indicating payload is compressed with LZ4
  102. */
  103. #define ZT_PROTO_VERB_FLAG_COMPRESSED 0x80
  104. /**
  105. * Rounds used for Salsa20 encryption in ZT
  106. *
  107. * Discussion:
  108. *
  109. * DJB (Salsa20's designer) designed Salsa20 with a significant margin of 20
  110. * rounds, but has said repeatedly that 12 is likely sufficient. So far (as of
  111. * July 2015) there are no published attacks against 12 rounds, let alone 20.
  112. *
  113. * In cryptography, a "break" means something different from what it means in
  114. * common discussion. If a cipher is 256 bits strong and someone finds a way
  115. * to reduce key search to 254 bits, this constitues a "break" in the academic
  116. * literature. 254 bits is still far beyond what can be leveraged to accomplish
  117. * a "break" as most people would understand it -- the actual decryption and
  118. * reading of traffic.
  119. *
  120. * Nevertheless, "attacks only get better" as cryptographers like to say. As
  121. * a result, they recommend not using anything that's shown any weakness even
  122. * if that weakness is so far only meaningful to academics. It may be a sign
  123. * of a deeper problem.
  124. *
  125. * So why choose a lower round count?
  126. *
  127. * Turns out the speed difference is nontrivial. On a Macbook Pro (Core i3) 20
  128. * rounds of SSE-optimized Salsa20 achieves ~508mb/sec/core, while 12 rounds
  129. * hits ~832mb/sec/core. ZeroTier is designed for multiple objectives:
  130. * security, simplicity, and performance. In this case a deference was made
  131. * for performance.
  132. *
  133. * Meta discussion:
  134. *
  135. * The cipher is not the thing you should be paranoid about.
  136. *
  137. * I'll qualify that. If the cipher is known to be weak, like RC4, or has a
  138. * key size that is too small, like DES, then yes you should worry about
  139. * the cipher.
  140. *
  141. * But if the cipher is strong and your adversary is anyone other than the
  142. * intelligence apparatus of a major superpower, you are fine in that
  143. * department.
  144. *
  145. * Go ahead. Search for the last ten vulnerabilities discovered in SSL. Not
  146. * a single one involved the breaking of a cipher. Now broaden your search.
  147. * Look for issues with SSH, IPSec, etc. The only cipher-related issues you
  148. * will find might involve the use of RC4 or MD5, algorithms with known
  149. * issues or small key/digest sizes. But even weak ciphers are difficult to
  150. * exploit in the real world -- you usually need a lot of data and a lot of
  151. * compute time. No, virtually EVERY security vulnerability you will find
  152. * involves a problem with the IMPLEMENTATION not with the cipher.
  153. *
  154. * A flaw in ZeroTier's protocol or code is incredibly, unbelievably
  155. * more likely than a flaw in Salsa20 or any other cipher or cryptographic
  156. * primitive it uses. We're talking odds of dying in a car wreck vs. odds of
  157. * being personally impacted on the head by a meteorite. Nobody without a
  158. * billion dollar budget is going to break into your network by actually
  159. * cracking Salsa20/12 (or even /8) in the field.
  160. *
  161. * So stop worrying about the cipher unless you are, say, the Kremlin and your
  162. * adversary is the NSA and the GCHQ. In that case... well that's above my
  163. * pay grade. I'll just say defense in depth.
  164. */
  165. #define ZT_PROTO_SALSA20_ROUNDS 12
  166. /**
  167. * PUSH_DIRECT_PATHS flag: forget path
  168. */
  169. #define ZT_PUSH_DIRECT_PATHS_FLAG_FORGET_PATH 0x01
  170. /**
  171. * PUSH_DIRECT_PATHS flag: cluster redirect
  172. */
  173. #define ZT_PUSH_DIRECT_PATHS_FLAG_CLUSTER_REDIRECT 0x02
  174. // Field indexes in packet header
  175. #define ZT_PACKET_IDX_IV 0
  176. #define ZT_PACKET_IDX_DEST 8
  177. #define ZT_PACKET_IDX_SOURCE 13
  178. #define ZT_PACKET_IDX_FLAGS 18
  179. #define ZT_PACKET_IDX_MAC 19
  180. #define ZT_PACKET_IDX_VERB 27
  181. #define ZT_PACKET_IDX_PAYLOAD 28
  182. /**
  183. * Packet buffer size (can be changed)
  184. *
  185. * The current value is big enough for ZT_MAX_PACKET_FRAGMENTS, the pragmatic
  186. * packet fragment limit, times the default UDP MTU. Most packets won't be
  187. * this big.
  188. */
  189. #define ZT_PROTO_MAX_PACKET_LENGTH (ZT_MAX_PACKET_FRAGMENTS * ZT_UDP_DEFAULT_PAYLOAD_MTU)
  190. /**
  191. * Minimum viable packet length (a.k.a. header length)
  192. */
  193. #define ZT_PROTO_MIN_PACKET_LENGTH ZT_PACKET_IDX_PAYLOAD
  194. // Indexes of fields in fragment header
  195. #define ZT_PACKET_FRAGMENT_IDX_PACKET_ID 0
  196. #define ZT_PACKET_FRAGMENT_IDX_DEST 8
  197. #define ZT_PACKET_FRAGMENT_IDX_FRAGMENT_INDICATOR 13
  198. #define ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO 14
  199. #define ZT_PACKET_FRAGMENT_IDX_HOPS 15
  200. #define ZT_PACKET_FRAGMENT_IDX_PAYLOAD 16
  201. /**
  202. * Magic number found at ZT_PACKET_FRAGMENT_IDX_FRAGMENT_INDICATOR
  203. */
  204. #define ZT_PACKET_FRAGMENT_INDICATOR ZT_ADDRESS_RESERVED_PREFIX
  205. /**
  206. * Minimum viable fragment length
  207. */
  208. #define ZT_PROTO_MIN_FRAGMENT_LENGTH ZT_PACKET_FRAGMENT_IDX_PAYLOAD
  209. // Field incides for parsing verbs -------------------------------------------
  210. // Some verbs have variable-length fields. Those aren't fully defined here
  211. // yet-- instead they are parsed using relative indexes in IncomingPacket.
  212. // See their respective handler functions.
  213. #define ZT_PROTO_VERB_HELLO_IDX_PROTOCOL_VERSION (ZT_PACKET_IDX_PAYLOAD)
  214. #define ZT_PROTO_VERB_HELLO_IDX_MAJOR_VERSION (ZT_PROTO_VERB_HELLO_IDX_PROTOCOL_VERSION + 1)
  215. #define ZT_PROTO_VERB_HELLO_IDX_MINOR_VERSION (ZT_PROTO_VERB_HELLO_IDX_MAJOR_VERSION + 1)
  216. #define ZT_PROTO_VERB_HELLO_IDX_REVISION (ZT_PROTO_VERB_HELLO_IDX_MINOR_VERSION + 1)
  217. #define ZT_PROTO_VERB_HELLO_IDX_TIMESTAMP (ZT_PROTO_VERB_HELLO_IDX_REVISION + 2)
  218. #define ZT_PROTO_VERB_HELLO_IDX_IDENTITY (ZT_PROTO_VERB_HELLO_IDX_TIMESTAMP + 8)
  219. #define ZT_PROTO_VERB_ERROR_IDX_IN_RE_VERB (ZT_PACKET_IDX_PAYLOAD)
  220. #define ZT_PROTO_VERB_ERROR_IDX_IN_RE_PACKET_ID (ZT_PROTO_VERB_ERROR_IDX_IN_RE_VERB + 1)
  221. #define ZT_PROTO_VERB_ERROR_IDX_ERROR_CODE (ZT_PROTO_VERB_ERROR_IDX_IN_RE_PACKET_ID + 8)
  222. #define ZT_PROTO_VERB_ERROR_IDX_PAYLOAD (ZT_PROTO_VERB_ERROR_IDX_ERROR_CODE + 1)
  223. #define ZT_PROTO_VERB_OK_IDX_IN_RE_VERB (ZT_PACKET_IDX_PAYLOAD)
  224. #define ZT_PROTO_VERB_OK_IDX_IN_RE_PACKET_ID (ZT_PROTO_VERB_OK_IDX_IN_RE_VERB + 1)
  225. #define ZT_PROTO_VERB_OK_IDX_PAYLOAD (ZT_PROTO_VERB_OK_IDX_IN_RE_PACKET_ID + 8)
  226. #define ZT_PROTO_VERB_WHOIS_IDX_ZTADDRESS (ZT_PACKET_IDX_PAYLOAD)
  227. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_FLAGS (ZT_PACKET_IDX_PAYLOAD)
  228. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_ZTADDRESS (ZT_PROTO_VERB_RENDEZVOUS_IDX_FLAGS + 1)
  229. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_PORT (ZT_PROTO_VERB_RENDEZVOUS_IDX_ZTADDRESS + 5)
  230. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRLEN (ZT_PROTO_VERB_RENDEZVOUS_IDX_PORT + 2)
  231. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRESS (ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRLEN + 1)
  232. #define ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  233. #define ZT_PROTO_VERB_FRAME_IDX_ETHERTYPE (ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID + 8)
  234. #define ZT_PROTO_VERB_FRAME_IDX_PAYLOAD (ZT_PROTO_VERB_FRAME_IDX_ETHERTYPE + 2)
  235. #define ZT_PROTO_VERB_EXT_FRAME_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  236. #define ZT_PROTO_VERB_EXT_FRAME_LEN_NETWORK_ID 8
  237. #define ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS (ZT_PROTO_VERB_EXT_FRAME_IDX_NETWORK_ID + ZT_PROTO_VERB_EXT_FRAME_LEN_NETWORK_ID)
  238. #define ZT_PROTO_VERB_EXT_FRAME_LEN_FLAGS 1
  239. #define ZT_PROTO_VERB_EXT_FRAME_IDX_COM (ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS + ZT_PROTO_VERB_EXT_FRAME_LEN_FLAGS)
  240. #define ZT_PROTO_VERB_EXT_FRAME_IDX_TO (ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS + ZT_PROTO_VERB_EXT_FRAME_LEN_FLAGS)
  241. #define ZT_PROTO_VERB_EXT_FRAME_LEN_TO 6
  242. #define ZT_PROTO_VERB_EXT_FRAME_IDX_FROM (ZT_PROTO_VERB_EXT_FRAME_IDX_TO + ZT_PROTO_VERB_EXT_FRAME_LEN_TO)
  243. #define ZT_PROTO_VERB_EXT_FRAME_LEN_FROM 6
  244. #define ZT_PROTO_VERB_EXT_FRAME_IDX_ETHERTYPE (ZT_PROTO_VERB_EXT_FRAME_IDX_FROM + ZT_PROTO_VERB_EXT_FRAME_LEN_FROM)
  245. #define ZT_PROTO_VERB_EXT_FRAME_LEN_ETHERTYPE 2
  246. #define ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD (ZT_PROTO_VERB_EXT_FRAME_IDX_ETHERTYPE + ZT_PROTO_VERB_EXT_FRAME_LEN_ETHERTYPE)
  247. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  248. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT_LEN (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_NETWORK_ID + 8)
  249. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT_LEN + 2)
  250. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  251. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_FLAGS (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_NETWORK_ID + 8)
  252. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_MAC (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_FLAGS + 1)
  253. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_ADI (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_MAC + 6)
  254. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_GATHER_LIMIT (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_ADI + 4)
  255. // Note: COM, GATHER_LIMIT, and SOURCE_MAC are optional, and so are specified without size
  256. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  257. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FLAGS (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_NETWORK_ID + 8)
  258. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_COM (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FLAGS + 1)
  259. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_GATHER_LIMIT (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FLAGS + 1)
  260. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_SOURCE_MAC (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FLAGS + 1)
  261. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_DEST_MAC (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FLAGS + 1)
  262. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_DEST_ADI (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_DEST_MAC + 6)
  263. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_ETHERTYPE (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_DEST_ADI + 4)
  264. #define ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_ETHERTYPE + 2)
  265. #define ZT_PROTO_VERB_HELLO__OK__IDX_TIMESTAMP (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  266. #define ZT_PROTO_VERB_HELLO__OK__IDX_PROTOCOL_VERSION (ZT_PROTO_VERB_HELLO__OK__IDX_TIMESTAMP + 8)
  267. #define ZT_PROTO_VERB_HELLO__OK__IDX_MAJOR_VERSION (ZT_PROTO_VERB_HELLO__OK__IDX_PROTOCOL_VERSION + 1)
  268. #define ZT_PROTO_VERB_HELLO__OK__IDX_MINOR_VERSION (ZT_PROTO_VERB_HELLO__OK__IDX_MAJOR_VERSION + 1)
  269. #define ZT_PROTO_VERB_HELLO__OK__IDX_REVISION (ZT_PROTO_VERB_HELLO__OK__IDX_MINOR_VERSION + 1)
  270. #define ZT_PROTO_VERB_WHOIS__OK__IDX_IDENTITY (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  271. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_NETWORK_ID (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  272. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT_LEN (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_NETWORK_ID + 8)
  273. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT_LEN + 2)
  274. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_NETWORK_ID (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  275. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_MAC (ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_NETWORK_ID + 8)
  276. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_ADI (ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_MAC + 6)
  277. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_GATHER_RESULTS (ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_ADI + 4)
  278. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_NETWORK_ID (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  279. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_MAC (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_NETWORK_ID + 8)
  280. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_ADI (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_MAC + 6)
  281. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_FLAGS (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_ADI + 4)
  282. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_COM_AND_GATHER_RESULTS (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_FLAGS + 1)
  283. // ---------------------------------------------------------------------------
  284. namespace ZeroTier {
  285. /**
  286. * ZeroTier packet
  287. *
  288. * Packet format:
  289. * <[8] 64-bit random packet ID and crypto initialization vector>
  290. * <[5] destination ZT address>
  291. * <[5] source ZT address>
  292. * <[1] flags/cipher/hops>
  293. * <[8] 64-bit MAC>
  294. * [... -- begin encryption envelope -- ...]
  295. * <[1] encrypted flags (MS 3 bits) and verb (LS 5 bits)>
  296. * [... verb-specific payload ...]
  297. *
  298. * Packets smaller than 28 bytes are invalid and silently discarded.
  299. *
  300. * The flags/cipher/hops bit field is: FFCCCHHH where C is a 3-bit cipher
  301. * selection allowing up to 7 cipher suites, F is outside-envelope flags,
  302. * and H is hop count.
  303. *
  304. * The three-bit hop count is the only part of a packet that is mutable in
  305. * transit without invalidating the MAC. All other bits in the packet are
  306. * immutable. This is because intermediate nodes can increment the hop
  307. * count up to 7 (protocol max).
  308. *
  309. * For unencrypted packets, MAC is computed on plaintext. Only HELLO is ever
  310. * sent in the clear, as it's the "here is my public key" message.
  311. */
  312. class Packet : public Buffer<ZT_PROTO_MAX_PACKET_LENGTH>
  313. {
  314. public:
  315. /**
  316. * A packet fragment
  317. *
  318. * Fragments are sent if a packet is larger than UDP MTU. The first fragment
  319. * is sent with its normal header with the fragmented flag set. Remaining
  320. * fragments are sent this way.
  321. *
  322. * The fragmented bit indicates that there is at least one fragment. Fragments
  323. * themselves contain the total, so the receiver must "learn" this from the
  324. * first fragment it receives.
  325. *
  326. * Fragments are sent with the following format:
  327. * <[8] packet ID of packet whose fragment this belongs to>
  328. * <[5] destination ZT address>
  329. * <[1] 0xff, a reserved address, signals that this isn't a normal packet>
  330. * <[1] total fragments (most significant 4 bits), fragment no (LS 4 bits)>
  331. * <[1] ZT hop count (top 5 bits unused and must be zero)>
  332. * <[...] fragment data>
  333. *
  334. * The protocol supports a maximum of 16 fragments. If a fragment is received
  335. * before its main packet header, it should be cached for a brief period of
  336. * time to see if its parent arrives. Loss of any fragment constitutes packet
  337. * loss; there is no retransmission mechanism. The receiver must wait for full
  338. * receipt to authenticate and decrypt; there is no per-fragment MAC. (But if
  339. * fragments are corrupt, the MAC will fail for the whole assembled packet.)
  340. */
  341. class Fragment : public Buffer<ZT_PROTO_MAX_PACKET_LENGTH>
  342. {
  343. public:
  344. Fragment() :
  345. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>()
  346. {
  347. }
  348. template<unsigned int C2>
  349. Fragment(const Buffer<C2> &b)
  350. throw(std::out_of_range) :
  351. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(b)
  352. {
  353. }
  354. Fragment(const void *data,unsigned int len) :
  355. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(data,len)
  356. {
  357. }
  358. /**
  359. * Initialize from a packet
  360. *
  361. * @param p Original assembled packet
  362. * @param fragStart Start of fragment (raw index in packet data)
  363. * @param fragLen Length of fragment in bytes
  364. * @param fragNo Which fragment (>= 1, since 0 is Packet with end chopped off)
  365. * @param fragTotal Total number of fragments (including 0)
  366. * @throws std::out_of_range Packet size would exceed buffer
  367. */
  368. Fragment(const Packet &p,unsigned int fragStart,unsigned int fragLen,unsigned int fragNo,unsigned int fragTotal)
  369. throw(std::out_of_range)
  370. {
  371. init(p,fragStart,fragLen,fragNo,fragTotal);
  372. }
  373. /**
  374. * Initialize from a packet
  375. *
  376. * @param p Original assembled packet
  377. * @param fragStart Start of fragment (raw index in packet data)
  378. * @param fragLen Length of fragment in bytes
  379. * @param fragNo Which fragment (>= 1, since 0 is Packet with end chopped off)
  380. * @param fragTotal Total number of fragments (including 0)
  381. * @throws std::out_of_range Packet size would exceed buffer
  382. */
  383. inline void init(const Packet &p,unsigned int fragStart,unsigned int fragLen,unsigned int fragNo,unsigned int fragTotal)
  384. throw(std::out_of_range)
  385. {
  386. if ((fragStart + fragLen) > p.size())
  387. throw std::out_of_range("Packet::Fragment: tried to construct fragment of packet past its length");
  388. setSize(fragLen + ZT_PROTO_MIN_FRAGMENT_LENGTH);
  389. // NOTE: this copies both the IV/packet ID and the destination address.
  390. memcpy(field(ZT_PACKET_FRAGMENT_IDX_PACKET_ID,13),p.field(ZT_PACKET_IDX_IV,13),13);
  391. (*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_INDICATOR] = ZT_PACKET_FRAGMENT_INDICATOR;
  392. (*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO] = (char)(((fragTotal & 0xf) << 4) | (fragNo & 0xf));
  393. (*this)[ZT_PACKET_FRAGMENT_IDX_HOPS] = 0;
  394. memcpy(field(ZT_PACKET_FRAGMENT_IDX_PAYLOAD,fragLen),p.field(fragStart,fragLen),fragLen);
  395. }
  396. /**
  397. * Get this fragment's destination
  398. *
  399. * @return Destination ZT address
  400. */
  401. inline Address destination() const { return Address(field(ZT_PACKET_FRAGMENT_IDX_DEST,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  402. /**
  403. * @return True if fragment is of a valid length
  404. */
  405. inline bool lengthValid() const { return (size() >= ZT_PACKET_FRAGMENT_IDX_PAYLOAD); }
  406. /**
  407. * @return ID of packet this is a fragment of
  408. */
  409. inline uint64_t packetId() const { return at<uint64_t>(ZT_PACKET_FRAGMENT_IDX_PACKET_ID); }
  410. /**
  411. * @return Total number of fragments in packet
  412. */
  413. inline unsigned int totalFragments() const { return (((unsigned int)((*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO]) >> 4) & 0xf); }
  414. /**
  415. * @return Fragment number of this fragment
  416. */
  417. inline unsigned int fragmentNumber() const { return ((unsigned int)((*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO]) & 0xf); }
  418. /**
  419. * @return Fragment ZT hop count
  420. */
  421. inline unsigned int hops() const { return (unsigned int)((*this)[ZT_PACKET_FRAGMENT_IDX_HOPS]); }
  422. /**
  423. * Increment this packet's hop count
  424. */
  425. inline void incrementHops()
  426. {
  427. (*this)[ZT_PACKET_FRAGMENT_IDX_HOPS] = (((*this)[ZT_PACKET_FRAGMENT_IDX_HOPS]) + 1) & ZT_PROTO_MAX_HOPS;
  428. }
  429. /**
  430. * @return Length of payload in bytes
  431. */
  432. inline unsigned int payloadLength() const { return ((size() > ZT_PACKET_FRAGMENT_IDX_PAYLOAD) ? (size() - ZT_PACKET_FRAGMENT_IDX_PAYLOAD) : 0); }
  433. /**
  434. * @return Raw packet payload
  435. */
  436. inline const unsigned char *payload() const
  437. {
  438. return field(ZT_PACKET_FRAGMENT_IDX_PAYLOAD,size() - ZT_PACKET_FRAGMENT_IDX_PAYLOAD);
  439. }
  440. };
  441. /**
  442. * ZeroTier protocol verbs
  443. */
  444. enum Verb /* Max value: 32 (5 bits) */
  445. {
  446. /**
  447. * No operation (ignored, no reply)
  448. */
  449. VERB_NOP = 0,
  450. /**
  451. * Announcement of a node's existence:
  452. * <[1] protocol version>
  453. * <[1] software major version>
  454. * <[1] software minor version>
  455. * <[2] software revision>
  456. * <[8] timestamp (ms since epoch)>
  457. * <[...] binary serialized identity (see Identity)>
  458. * <[1] destination address type>
  459. * [<[...] destination address>]
  460. * <[8] 64-bit world ID of current world>
  461. * <[8] 64-bit timestamp of current world>
  462. *
  463. * This is the only message that ever must be sent in the clear, since it
  464. * is used to push an identity to a new peer.
  465. *
  466. * The destination address is the wire address to which this packet is
  467. * being sent, and in OK is *also* the destination address of the OK
  468. * packet. This can be used by the receiver to detect NAT, learn its real
  469. * external address if behind NAT, and detect changes to its external
  470. * address that require re-establishing connectivity.
  471. *
  472. * Destination address types and formats (not all of these are used now):
  473. * 0x00 - None -- no destination address data present
  474. * 0x01 - Ethernet address -- format: <[6] Ethernet MAC>
  475. * 0x04 - 6-byte IPv4 UDP address/port -- format: <[4] IP>, <[2] port>
  476. * 0x06 - 18-byte IPv6 UDP address/port -- format: <[16] IP>, <[2] port>
  477. *
  478. * OK payload:
  479. * <[8] timestamp (echoed from original HELLO)>
  480. * <[1] protocol version (of responder)>
  481. * <[1] software major version (of responder)>
  482. * <[1] software minor version (of responder)>
  483. * <[2] software revision (of responder)>
  484. * <[1] destination address type (for this OK, not copied from HELLO)>
  485. * [<[...] destination address>]
  486. * <[2] 16-bit length of world update or 0 if none>
  487. * [[...] world update]
  488. *
  489. * ERROR has no payload.
  490. */
  491. VERB_HELLO = 1,
  492. /**
  493. * Error response:
  494. * <[1] in-re verb>
  495. * <[8] in-re packet ID>
  496. * <[1] error code>
  497. * <[...] error-dependent payload>
  498. */
  499. VERB_ERROR = 2,
  500. /**
  501. * Success response:
  502. * <[1] in-re verb>
  503. * <[8] in-re packet ID>
  504. * <[...] request-specific payload>
  505. */
  506. VERB_OK = 3,
  507. /**
  508. * Query an identity by address:
  509. * <[5] address to look up>
  510. *
  511. * OK response payload:
  512. * <[...] binary serialized identity>
  513. *
  514. * If querying a cluster, duplicate OK responses may occasionally occur.
  515. * These should be discarded.
  516. *
  517. * If the address is not found, no response is generated. WHOIS requests
  518. * will time out much like ARP requests and similar do in L2.
  519. */
  520. VERB_WHOIS = 4,
  521. /**
  522. * Meet another node at a given protocol address:
  523. * <[1] flags (unused, currently 0)>
  524. * <[5] ZeroTier address of peer that might be found at this address>
  525. * <[2] 16-bit protocol address port>
  526. * <[1] protocol address length (4 for IPv4, 16 for IPv6)>
  527. * <[...] protocol address (network byte order)>
  528. *
  529. * This is sent by a relaying node to initiate NAT traversal between two
  530. * peers that are communicating by way of indirect relay. The relay will
  531. * send this to both peers at the same time on a periodic basis, telling
  532. * each where it might find the other on the network.
  533. *
  534. * Upon receipt a peer sends HELLO to establish a direct link.
  535. *
  536. * Nodes should implement rate control, limiting the rate at which they
  537. * respond to these packets to prevent their use in DDOS attacks. Nodes
  538. * may also ignore these messages if a peer is not known or is not being
  539. * actively communicated with.
  540. *
  541. * Unfortunately the physical address format in this message pre-dates
  542. * InetAddress's serialization format. :( ZeroTier is four years old and
  543. * yes we've accumulated a tiny bit of cruft here and there.
  544. *
  545. * No OK or ERROR is generated.
  546. */
  547. VERB_RENDEZVOUS = 5,
  548. /**
  549. * ZT-to-ZT unicast ethernet frame (shortened EXT_FRAME):
  550. * <[8] 64-bit network ID>
  551. * <[2] 16-bit ethertype>
  552. * <[...] ethernet payload>
  553. *
  554. * MAC addresses are derived from the packet's source and destination
  555. * ZeroTier addresses. This is a shortened EXT_FRAME that elides full
  556. * Ethernet framing and other optional flags and features when they
  557. * are not necessary.
  558. *
  559. * ERROR may be generated if a membership certificate is needed for a
  560. * closed network. Payload will be network ID.
  561. */
  562. VERB_FRAME = 6,
  563. /**
  564. * Full Ethernet frame with MAC addressing and optional fields:
  565. * <[8] 64-bit network ID>
  566. * <[1] flags>
  567. * [<[...] certificate of network membership>]
  568. * <[6] destination MAC or all zero for destination node>
  569. * <[6] source MAC or all zero for node of origin>
  570. * <[2] 16-bit ethertype>
  571. * <[...] ethernet payload>
  572. *
  573. * Flags:
  574. * 0x01 - Certificate of network membership is attached
  575. *
  576. * An extended frame carries full MAC addressing, making them a
  577. * superset of VERB_FRAME. They're used for bridging or when we
  578. * want to attach a certificate since FRAME does not support that.
  579. *
  580. * Multicast frames may not be sent as EXT_FRAME.
  581. *
  582. * ERROR may be generated if a membership certificate is needed for a
  583. * closed network. Payload will be network ID.
  584. */
  585. VERB_EXT_FRAME = 7,
  586. /**
  587. * ECHO request (a.k.a. ping):
  588. * <[...] arbitrary payload>
  589. *
  590. * This generates OK with a copy of the transmitted payload. No ERROR
  591. * is generated. Response to ECHO requests is optional and ECHO may be
  592. * ignored if a node detects a possible flood.
  593. */
  594. VERB_ECHO = 8,
  595. /**
  596. * Announce interest in multicast group(s):
  597. * <[8] 64-bit network ID>
  598. * <[6] multicast Ethernet address>
  599. * <[4] multicast additional distinguishing information (ADI)>
  600. * [... additional tuples of network/address/adi ...]
  601. *
  602. * LIKEs may be sent to any peer, though a good implementation should
  603. * restrict them to peers on the same network they're for and to network
  604. * controllers and root servers. In the current network, root servers
  605. * will provide the service of final multicast cache.
  606. *
  607. * It is recommended that NETWORK_MEMBERSHIP_CERTIFICATE pushes be sent
  608. * along with MULTICAST_LIKE when pushing LIKEs to peers that do not
  609. * share a network membership (such as root servers), since this can be
  610. * used to authenticate GATHER requests and limit responses to peers
  611. * authorized to talk on a network. (Should be an optional field here,
  612. * but saving one or two packets every five minutes is not worth an
  613. * ugly hack or protocol rev.)
  614. *
  615. * OK/ERROR are not generated.
  616. */
  617. VERB_MULTICAST_LIKE = 9,
  618. /**
  619. * Network member certificate replication/push:
  620. * <[...] serialized certificate of membership>
  621. * [ ... additional certificates may follow ...]
  622. *
  623. * This is sent in response to ERROR_NEED_MEMBERSHIP_CERTIFICATE and may
  624. * be pushed at any other time to keep exchanged certificates up to date.
  625. *
  626. * OK/ERROR are not generated.
  627. */
  628. VERB_NETWORK_MEMBERSHIP_CERTIFICATE = 10,
  629. /**
  630. * Network configuration request:
  631. * <[8] 64-bit network ID>
  632. * <[2] 16-bit length of request meta-data dictionary>
  633. * <[...] string-serialized request meta-data>
  634. * [<[8] 64-bit revision of netconf we currently have>]
  635. *
  636. * This message requests network configuration from a node capable of
  637. * providing it. If the optional revision is included, a response is
  638. * only generated if there is a newer network configuration available.
  639. *
  640. * OK response payload:
  641. * <[8] 64-bit network ID>
  642. * <[2] 16-bit length of network configuration dictionary>
  643. * <[...] network configuration dictionary>
  644. *
  645. * OK returns a Dictionary (string serialized) containing the network's
  646. * configuration and IP address assignment information for the querying
  647. * node. It also contains a membership certificate that the querying
  648. * node can push to other peers to demonstrate its right to speak on
  649. * a given network.
  650. *
  651. * When a new network configuration is received, another config request
  652. * should be sent with the new netconf's revision. This confirms receipt
  653. * and also causes any subsequent changes to rapidly propagate as this
  654. * cycle will repeat until there are no changes. This is optional but
  655. * recommended behavior.
  656. *
  657. * ERROR response payload:
  658. * <[8] 64-bit network ID>
  659. *
  660. * UNSUPPORTED_OPERATION is returned if this service is not supported,
  661. * and OBJ_NOT_FOUND if the queried network ID was not found.
  662. */
  663. VERB_NETWORK_CONFIG_REQUEST = 11,
  664. /**
  665. * Network configuration refresh request:
  666. * <[...] array of 64-bit network IDs>
  667. *
  668. * This can be sent by the network controller to inform a node that it
  669. * should now make a NETWORK_CONFIG_REQUEST.
  670. *
  671. * It does not generate an OK or ERROR message, and is treated only as
  672. * a hint to refresh now.
  673. */
  674. VERB_NETWORK_CONFIG_REFRESH = 12,
  675. /**
  676. * Request endpoints for multicast distribution:
  677. * <[8] 64-bit network ID>
  678. * <[1] flags>
  679. * <[6] MAC address of multicast group being queried>
  680. * <[4] 32-bit ADI for multicast group being queried>
  681. * <[4] 32-bit requested max number of multicast peers>
  682. * [<[...] network certificate of membership>]
  683. *
  684. * Flags:
  685. * 0x01 - Network certificate of membership is attached
  686. *
  687. * This message asks a peer for additional known endpoints that have
  688. * LIKEd a given multicast group. It's sent when the sender wishes
  689. * to send multicast but does not have the desired number of recipient
  690. * peers.
  691. *
  692. * More than one OK response can occur if the response is broken up across
  693. * multiple packets or if querying a clustered node.
  694. *
  695. * OK response payload:
  696. * <[8] 64-bit network ID>
  697. * <[6] MAC address of multicast group being queried>
  698. * <[4] 32-bit ADI for multicast group being queried>
  699. * [begin gather results -- these same fields can be in OK(MULTICAST_FRAME)]
  700. * <[4] 32-bit total number of known members in this multicast group>
  701. * <[2] 16-bit number of members enumerated in this packet>
  702. * <[...] series of 5-byte ZeroTier addresses of enumerated members>
  703. *
  704. * ERROR is not generated; queries that return no response are dropped.
  705. */
  706. VERB_MULTICAST_GATHER = 13,
  707. /**
  708. * Multicast frame:
  709. * <[8] 64-bit network ID>
  710. * <[1] flags>
  711. * [<[...] network certificate of membership>]
  712. * [<[4] 32-bit implicit gather limit>]
  713. * [<[6] source MAC>]
  714. * <[6] destination MAC (multicast address)>
  715. * <[4] 32-bit multicast ADI (multicast address extension)>
  716. * <[2] 16-bit ethertype>
  717. * <[...] ethernet payload>
  718. *
  719. * Flags:
  720. * 0x01 - Network certificate of membership is attached
  721. * 0x02 - Implicit gather limit field is present
  722. * 0x04 - Source MAC is specified -- otherwise it's computed from sender
  723. *
  724. * OK and ERROR responses are optional. OK may be generated if there are
  725. * implicit gather results or if the recipient wants to send its own
  726. * updated certificate of network membership to the sender. ERROR may be
  727. * generated if a certificate is needed or if multicasts to this group
  728. * are no longer wanted (multicast unsubscribe).
  729. *
  730. * OK response payload:
  731. * <[8] 64-bit network ID>
  732. * <[6] MAC address of multicast group>
  733. * <[4] 32-bit ADI for multicast group>
  734. * <[1] flags>
  735. * [<[...] network certficate of membership>]
  736. * [<[...] implicit gather results if flag 0x01 is set>]
  737. *
  738. * OK flags (same bits as request flags):
  739. * 0x01 - OK includes certificate of network membership
  740. * 0x02 - OK includes implicit gather results
  741. *
  742. * ERROR response payload:
  743. * <[8] 64-bit network ID>
  744. * <[6] multicast group MAC>
  745. * <[4] 32-bit multicast group ADI>
  746. */
  747. VERB_MULTICAST_FRAME = 14,
  748. /**
  749. * Push of potential endpoints for direct communication:
  750. * <[2] 16-bit number of paths>
  751. * <[...] paths>
  752. *
  753. * Path record format:
  754. * <[1] 8-bit path flags>
  755. * <[2] length of extended path characteristics or 0 for none>
  756. * <[...] extended path characteristics>
  757. * <[1] address type>
  758. * <[1] address length in bytes>
  759. * <[...] address>
  760. *
  761. * Path record flags:
  762. * 0x01 - Forget this path if currently known (not implemented yet)
  763. * 0x02 - Cluster redirect -- use this in preference to others
  764. *
  765. * The receiver may, upon receiving a push, attempt to establish a
  766. * direct link to one or more of the indicated addresses. It is the
  767. * responsibility of the sender to limit which peers it pushes direct
  768. * paths to to those with whom it has a trust relationship. The receiver
  769. * must obey any restrictions provided such as exclusivity or blacklists.
  770. * OK responses to this message are optional.
  771. *
  772. * Note that a direct path push does not imply that learned paths can't
  773. * be used unless they are blacklisted explicitly or unless flag 0x01
  774. * is set.
  775. *
  776. * Only a subset of this functionality is currently implemented: basic
  777. * path pushing and learning. Blacklisting and trust are not fully
  778. * implemented yet (encryption is still always used).
  779. *
  780. * OK and ERROR are not generated.
  781. */
  782. VERB_PUSH_DIRECT_PATHS = 16,
  783. /**
  784. * Source-routed circuit test message:
  785. * <[5] address of originator of circuit test>
  786. * <[2] 16-bit flags>
  787. * <[8] 64-bit timestamp>
  788. * <[8] 64-bit test ID (arbitrary, set by tester)>
  789. * <[2] 16-bit originator credential length (includes type)>
  790. * [[1] originator credential type (for authorizing test)]
  791. * [[...] originator credential]
  792. * <[2] 16-bit length of additional fields>
  793. * [[...] additional fields]
  794. * [ ... end of signed portion of request ... ]
  795. * <[2] 16-bit length of signature of request>
  796. * <[...] signature of request by originator>
  797. * <[2] 16-bit previous hop credential length (including type)>
  798. * [[1] previous hop credential type]
  799. * [[...] previous hop credential]
  800. * <[...] next hop(s) in path>
  801. *
  802. * Flags:
  803. * 0x01 - Report back to originator at middle hops
  804. * 0x02 - Report back to originator at last hop
  805. *
  806. * Originator credential types:
  807. * 0x01 - 64-bit network ID for which originator is controller
  808. *
  809. * Previous hop credential types:
  810. * 0x01 - Certificate of network membership
  811. *
  812. * Path record format:
  813. * <[1] 8-bit flags (unused, must be zero)>
  814. * <[1] 8-bit breadth (number of next hops)>
  815. * <[...] one or more ZeroTier addresses of next hops>
  816. *
  817. * The circuit test allows a device to send a message that will traverse
  818. * the network along a specified path, with each hop optionally reporting
  819. * back to the tester via VERB_CIRCUIT_TEST_REPORT.
  820. *
  821. * Each circuit test packet includes a digital signature by the originator
  822. * of the request, as well as a credential by which that originator claims
  823. * authorization to perform the test. Currently this signature is ed25519,
  824. * but in the future flags might be used to indicate an alternative
  825. * algorithm. For example, the originator might be a network controller.
  826. * In this case the test might be authorized if the recipient is a member
  827. * of a network controlled by it, and if the previous hop(s) are also
  828. * members. Each hop may include its certificate of network membership.
  829. *
  830. * Circuit test paths consist of a series of records. When a node receives
  831. * an authorized circuit test, it:
  832. *
  833. * (1) Reports back to circuit tester as flags indicate
  834. * (2) Reads and removes the next hop from the packet's path
  835. * (3) Sends the packet along to next hop(s), if any.
  836. *
  837. * It is perfectly legal for a path to contain the same hop more than
  838. * once. In fact, this can be a very useful test to determine if a hop
  839. * can be reached bidirectionally and if so what that connectivity looks
  840. * like.
  841. *
  842. * The breadth field in source-routed path records allows a hop to forward
  843. * to more than one recipient, allowing the tester to specify different
  844. * forms of graph traversal in a test.
  845. *
  846. * There is no hard limit to the number of hops in a test, but it is
  847. * practically limited by the maximum size of a (possibly fragmented)
  848. * ZeroTier packet.
  849. *
  850. * Support for circuit tests is optional. If they are not supported, the
  851. * node should respond with an UNSUPPORTED_OPERATION error. If a circuit
  852. * test request is not authorized, it may be ignored or reported as
  853. * an INVALID_REQUEST. No OK messages are generated, but TEST_REPORT
  854. * messages may be sent (see below).
  855. *
  856. * ERROR packet format:
  857. * <[8] 64-bit timestamp (echoed from original>
  858. * <[8] 64-bit test ID (echoed from original)>
  859. */
  860. VERB_CIRCUIT_TEST = 17,
  861. /**
  862. * Circuit test hop report:
  863. * <[8] 64-bit timestamp (from original test)>
  864. * <[8] 64-bit test ID (from original test)>
  865. * <[8] 64-bit reserved field (set to 0, currently unused)>
  866. * <[1] 8-bit vendor ID (set to 0, currently unused)>
  867. * <[1] 8-bit reporter protocol version>
  868. * <[1] 8-bit reporter major version>
  869. * <[1] 8-bit reporter minor version>
  870. * <[2] 16-bit reporter revision>
  871. * <[2] 16-bit reporter OS/platform>
  872. * <[2] 16-bit reporter architecture>
  873. * <[2] 16-bit error code (set to 0, currently unused)>
  874. * <[8] 64-bit report flags (set to 0, currently unused)>
  875. * <[8] 64-bit source packet ID>
  876. * <[5] upstream ZeroTier address from which test was received>
  877. * <[1] 8-bit source packet hop count (ZeroTier hop count)>
  878. * <[...] local wire address on which packet was received>
  879. * <[...] remote wire address from which packet was received>
  880. * <[2] 16-bit length of additional fields>
  881. * <[...] additional fields>
  882. * <[1] 8-bit number of next hops (breadth)>
  883. * <[...] next hop information>
  884. *
  885. * Next hop information record format:
  886. * <[5] ZeroTier address of next hop>
  887. * <[...] current best direct path address, if any, 0 if none>
  888. *
  889. * Circuit test reports can be sent by hops in a circuit test to report
  890. * back results. They should include information about the sender as well
  891. * as about the paths to which next hops are being sent.
  892. *
  893. * If a test report is received and no circuit test was sent, it should be
  894. * ignored. This message generates no OK or ERROR response.
  895. */
  896. VERB_CIRCUIT_TEST_REPORT = 18,
  897. /**
  898. * Request proof of work:
  899. * <[1] 8-bit proof of work type>
  900. * <[1] 8-bit proof of work difficulty>
  901. * <[2] 16-bit length of proof of work challenge>
  902. * <[...] proof of work challenge>
  903. *
  904. * This requests that a peer perform a proof of work calucation. It can be
  905. * sent by highly trusted peers (e.g. root servers, network controllers)
  906. * under suspected denial of service conditions in an attempt to filter
  907. * out "non-serious" peers and remain responsive to those proving their
  908. * intent to actually communicate.
  909. *
  910. * If the peer obliges to perform the work, it does so and responds with
  911. * an OK containing the result. Otherwise it may ignore the message or
  912. * response with an ERROR_INVALID_REQUEST or ERROR_UNSUPPORTED_OPERATION.
  913. *
  914. * Proof of work type IDs:
  915. * 0x01 - Salsa20/12+SHA512 hashcash function
  916. *
  917. * Salsa20/12+SHA512 is based on the following composite hash function:
  918. *
  919. * (1) Compute SHA512(candidate)
  920. * (2) Use the first 256 bits of the result of #1 as a key to encrypt
  921. * 131072 zero bytes with Salsa20/12 (with a zero IV).
  922. * (3) Compute SHA512(the result of step #2)
  923. * (4) Accept this candiate if the first [difficulty] bits of the result
  924. * from step #3 are zero. Otherwise generate a new candidate and try
  925. * again.
  926. *
  927. * This is performed repeatedly on candidates generated by appending the
  928. * supplied challenge to an arbitrary nonce until a valid candidate
  929. * is found. This chosen prepended nonce is then returned as the result
  930. * in OK.
  931. *
  932. * OK payload:
  933. * <[2] 16-bit length of result>
  934. * <[...] computed proof of work>
  935. *
  936. * ERROR has no payload.
  937. */
  938. VERB_REQUEST_PROOF_OF_WORK = 19
  939. };
  940. /**
  941. * Error codes for VERB_ERROR
  942. */
  943. enum ErrorCode
  944. {
  945. /* No error, not actually used in transit */
  946. ERROR_NONE = 0,
  947. /* Invalid request */
  948. ERROR_INVALID_REQUEST = 1,
  949. /* Bad/unsupported protocol version */
  950. ERROR_BAD_PROTOCOL_VERSION = 2,
  951. /* Unknown object queried */
  952. ERROR_OBJ_NOT_FOUND = 3,
  953. /* HELLO pushed an identity whose address is already claimed */
  954. ERROR_IDENTITY_COLLISION = 4,
  955. /* Verb or use case not supported/enabled by this node */
  956. ERROR_UNSUPPORTED_OPERATION = 5,
  957. /* Message to private network rejected -- no unexpired certificate on file */
  958. ERROR_NEED_MEMBERSHIP_CERTIFICATE = 6,
  959. /* Tried to join network, but you're not a member */
  960. ERROR_NETWORK_ACCESS_DENIED_ = 7, /* extra _ to avoid Windows name conflict */
  961. /* Multicasts to this group are not wanted */
  962. ERROR_UNWANTED_MULTICAST = 8
  963. };
  964. //#ifdef ZT_TRACE
  965. static const char *verbString(Verb v)
  966. throw();
  967. static const char *errorString(ErrorCode e)
  968. throw();
  969. //#endif
  970. template<unsigned int C2>
  971. Packet(const Buffer<C2> &b) :
  972. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(b)
  973. {
  974. }
  975. Packet(const void *data,unsigned int len) :
  976. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(data,len)
  977. {
  978. }
  979. /**
  980. * Construct a new empty packet with a unique random packet ID
  981. *
  982. * Flags and hops will be zero. Other fields and data region are undefined.
  983. * Use the header access methods (setDestination() and friends) to fill out
  984. * the header. Payload should be appended; initial size is header size.
  985. */
  986. Packet() :
  987. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(ZT_PROTO_MIN_PACKET_LENGTH)
  988. {
  989. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  990. (*this)[ZT_PACKET_IDX_FLAGS] = 0; // zero flags, cipher ID, and hops
  991. }
  992. /**
  993. * Make a copy of a packet with a new initialization vector and destination address
  994. *
  995. * This can be used to take one draft prototype packet and quickly make copies to
  996. * encrypt for different destinations.
  997. *
  998. * @param prototype Prototype packet
  999. * @param dest Destination ZeroTier address for new packet
  1000. */
  1001. Packet(const Packet &prototype,const Address &dest) :
  1002. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(prototype)
  1003. {
  1004. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  1005. setDestination(dest);
  1006. }
  1007. /**
  1008. * Construct a new empty packet with a unique random packet ID
  1009. *
  1010. * @param dest Destination ZT address
  1011. * @param source Source ZT address
  1012. * @param v Verb
  1013. */
  1014. Packet(const Address &dest,const Address &source,const Verb v) :
  1015. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(ZT_PROTO_MIN_PACKET_LENGTH)
  1016. {
  1017. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  1018. setDestination(dest);
  1019. setSource(source);
  1020. (*this)[ZT_PACKET_IDX_FLAGS] = 0; // zero flags and hops
  1021. setVerb(v);
  1022. }
  1023. /**
  1024. * Reset this packet structure for reuse in place
  1025. *
  1026. * @param dest Destination ZT address
  1027. * @param source Source ZT address
  1028. * @param v Verb
  1029. */
  1030. inline void reset(const Address &dest,const Address &source,const Verb v)
  1031. {
  1032. setSize(ZT_PROTO_MIN_PACKET_LENGTH);
  1033. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  1034. setDestination(dest);
  1035. setSource(source);
  1036. (*this)[ZT_PACKET_IDX_FLAGS] = 0; // zero flags, cipher ID, and hops
  1037. setVerb(v);
  1038. }
  1039. /**
  1040. * Generate a new IV / packet ID in place
  1041. *
  1042. * This can be used to re-use a packet buffer multiple times to send
  1043. * technically different but otherwise identical copies of the same
  1044. * packet.
  1045. */
  1046. inline void newInitializationVector() { Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8); }
  1047. /**
  1048. * Set this packet's destination
  1049. *
  1050. * @param dest ZeroTier address of destination
  1051. */
  1052. inline void setDestination(const Address &dest) { dest.copyTo(field(ZT_PACKET_IDX_DEST,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  1053. /**
  1054. * Set this packet's source
  1055. *
  1056. * @param source ZeroTier address of source
  1057. */
  1058. inline void setSource(const Address &source) { source.copyTo(field(ZT_PACKET_IDX_SOURCE,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  1059. /**
  1060. * Get this packet's destination
  1061. *
  1062. * @return Destination ZT address
  1063. */
  1064. inline Address destination() const { return Address(field(ZT_PACKET_IDX_DEST,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  1065. /**
  1066. * Get this packet's source
  1067. *
  1068. * @return Source ZT address
  1069. */
  1070. inline Address source() const { return Address(field(ZT_PACKET_IDX_SOURCE,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  1071. /**
  1072. * @return True if packet is of valid length
  1073. */
  1074. inline bool lengthValid() const { return (size() >= ZT_PROTO_MIN_PACKET_LENGTH); }
  1075. /**
  1076. * @return True if packet is fragmented (expect fragments)
  1077. */
  1078. inline bool fragmented() const { return (((unsigned char)(*this)[ZT_PACKET_IDX_FLAGS] & ZT_PROTO_FLAG_FRAGMENTED) != 0); }
  1079. /**
  1080. * Set this packet's fragmented flag
  1081. *
  1082. * @param f Fragmented flag value
  1083. */
  1084. inline void setFragmented(bool f)
  1085. {
  1086. if (f)
  1087. (*this)[ZT_PACKET_IDX_FLAGS] |= (char)ZT_PROTO_FLAG_FRAGMENTED;
  1088. else (*this)[ZT_PACKET_IDX_FLAGS] &= (char)(~ZT_PROTO_FLAG_FRAGMENTED);
  1089. }
  1090. /**
  1091. * @return True if compressed (result only valid if unencrypted)
  1092. */
  1093. inline bool compressed() const { return (((unsigned char)(*this)[ZT_PACKET_IDX_VERB] & ZT_PROTO_VERB_FLAG_COMPRESSED) != 0); }
  1094. /**
  1095. * @return ZeroTier forwarding hops (0 to 7)
  1096. */
  1097. inline unsigned int hops() const { return ((unsigned int)(*this)[ZT_PACKET_IDX_FLAGS] & 0x07); }
  1098. /**
  1099. * Increment this packet's hop count
  1100. */
  1101. inline void incrementHops()
  1102. {
  1103. unsigned char &b = (*this)[ZT_PACKET_IDX_FLAGS];
  1104. b = (b & 0xf8) | ((b + 1) & 0x07);
  1105. }
  1106. /**
  1107. * @return Cipher suite selector: 0 - 7 (see #defines)
  1108. */
  1109. inline unsigned int cipher() const
  1110. {
  1111. // Note: this uses the new cipher spec field, which is incompatible with <1.0.0 peers
  1112. return (((unsigned int)(*this)[ZT_PACKET_IDX_FLAGS] & 0x38) >> 3);
  1113. }
  1114. /**
  1115. * Set this packet's cipher suite
  1116. */
  1117. inline void setCipher(unsigned int c)
  1118. {
  1119. unsigned char &b = (*this)[ZT_PACKET_IDX_FLAGS];
  1120. b = (b & 0xc7) | (unsigned char)((c << 3) & 0x38); // bits: FFCCCHHH
  1121. // DEPRECATED "encrypted" flag -- used by pre-1.0.3 peers
  1122. if (c == ZT_PROTO_CIPHER_SUITE__C25519_POLY1305_SALSA2012)
  1123. b |= ZT_PROTO_FLAG_ENCRYPTED;
  1124. else b &= (~ZT_PROTO_FLAG_ENCRYPTED);
  1125. }
  1126. /**
  1127. * Get this packet's unique ID (the IV field interpreted as uint64_t)
  1128. *
  1129. * @return Packet ID
  1130. */
  1131. inline uint64_t packetId() const { return at<uint64_t>(ZT_PACKET_IDX_IV); }
  1132. /**
  1133. * Set packet verb
  1134. *
  1135. * This also has the side-effect of clearing any verb flags, such as
  1136. * compressed, and so must only be done during packet composition.
  1137. *
  1138. * @param v New packet verb
  1139. */
  1140. inline void setVerb(Verb v) { (*this)[ZT_PACKET_IDX_VERB] = (char)v; }
  1141. /**
  1142. * @return Packet verb (not including flag bits)
  1143. */
  1144. inline Verb verb() const { return (Verb)((*this)[ZT_PACKET_IDX_VERB] & 0x1f); }
  1145. /**
  1146. * @return Length of packet payload
  1147. */
  1148. inline unsigned int payloadLength() const { return ((size() < ZT_PROTO_MIN_PACKET_LENGTH) ? 0 : (size() - ZT_PROTO_MIN_PACKET_LENGTH)); }
  1149. /**
  1150. * @return Raw packet payload
  1151. */
  1152. inline const unsigned char *payload() const { return field(ZT_PACKET_IDX_PAYLOAD,size() - ZT_PACKET_IDX_PAYLOAD); }
  1153. /**
  1154. * Armor packet for transport
  1155. *
  1156. * @param key 32-byte key
  1157. * @param encryptPayload If true, encrypt packet payload, else just MAC
  1158. */
  1159. void armor(const void *key,bool encryptPayload);
  1160. /**
  1161. * Verify and (if encrypted) decrypt packet
  1162. *
  1163. * @param key 32-byte key
  1164. * @return False if packet is invalid or failed MAC authenticity check
  1165. */
  1166. bool dearmor(const void *key);
  1167. /**
  1168. * Attempt to compress payload if not already (must be unencrypted)
  1169. *
  1170. * This requires that the payload at least contain the verb byte already
  1171. * set. The compressed flag in the verb is set if compression successfully
  1172. * results in a size reduction. If no size reduction occurs, compression
  1173. * is not done and the flag is left cleared.
  1174. *
  1175. * @return True if compression occurred
  1176. */
  1177. bool compress();
  1178. /**
  1179. * Attempt to decompress payload if it is compressed (must be unencrypted)
  1180. *
  1181. * If payload is compressed, it is decompressed and the compressed verb
  1182. * flag is cleared. Otherwise nothing is done and true is returned.
  1183. *
  1184. * @return True if data is now decompressed and valid, false on error
  1185. */
  1186. bool uncompress();
  1187. private:
  1188. static const unsigned char ZERO_KEY[32];
  1189. /**
  1190. * Deterministically mangle a 256-bit crypto key based on packet
  1191. *
  1192. * This uses extra data from the packet to mangle the secret, giving us an
  1193. * effective IV that is somewhat more than 64 bits. This is "free" for
  1194. * Salsa20 since it has negligible key setup time so using a different
  1195. * key each time is fine.
  1196. *
  1197. * @param in Input key (32 bytes)
  1198. * @param out Output buffer (32 bytes)
  1199. */
  1200. inline void _salsa20MangleKey(const unsigned char *in,unsigned char *out) const
  1201. {
  1202. const unsigned char *d = (const unsigned char *)data();
  1203. // IV and source/destination addresses. Using the addresses divides the
  1204. // key space into two halves-- A->B and B->A (since order will change).
  1205. for(unsigned int i=0;i<18;++i) // 8 + (ZT_ADDRESS_LENGTH * 2) == 18
  1206. out[i] = in[i] ^ d[i];
  1207. // Flags, but with hop count masked off. Hop count is altered by forwarding
  1208. // nodes. It's one of the only parts of a packet modifiable by people
  1209. // without the key.
  1210. out[18] = in[18] ^ (d[ZT_PACKET_IDX_FLAGS] & 0xf8);
  1211. // Raw packet size in bytes -- thus each packet size defines a new
  1212. // key space.
  1213. out[19] = in[19] ^ (unsigned char)(size() & 0xff);
  1214. out[20] = in[20] ^ (unsigned char)((size() >> 8) & 0xff); // little endian
  1215. // Rest of raw key is used unchanged
  1216. for(unsigned int i=21;i<32;++i)
  1217. out[i] = in[i];
  1218. }
  1219. };
  1220. } // namespace ZeroTier
  1221. #endif