Packet.hpp 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318
  1. /*
  2. * ZeroTier One - Network Virtualization Everywhere
  3. * Copyright (C) 2011-2019 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. * --
  19. *
  20. * You can be released from the requirements of the license by purchasing
  21. * a commercial license. Buying such a license is mandatory as soon as you
  22. * develop commercial closed-source software that incorporates or links
  23. * directly against ZeroTier software without disclosing the source code
  24. * of your own application.
  25. */
  26. #ifndef ZT_N_PACKET_HPP
  27. #define ZT_N_PACKET_HPP
  28. #include <stdint.h>
  29. #include <string.h>
  30. #include <stdio.h>
  31. #include <string>
  32. #include <iostream>
  33. #include "Constants.hpp"
  34. #include "Address.hpp"
  35. #include "Poly1305.hpp"
  36. #include "Salsa20.hpp"
  37. #include "Utils.hpp"
  38. #include "Buffer.hpp"
  39. /**
  40. * Protocol version -- incremented only for major changes
  41. *
  42. * 1 - 0.2.0 ... 0.2.5
  43. * 2 - 0.3.0 ... 0.4.5
  44. * + Added signature and originating peer to multicast frame
  45. * + Double size of multicast frame bloom filter
  46. * 3 - 0.5.0 ... 0.6.0
  47. * + Yet another multicast redesign
  48. * + New crypto completely changes key agreement cipher
  49. * 4 - 0.6.0 ... 1.0.6
  50. * + BREAKING CHANGE: New identity format based on hashcash design
  51. * 5 - 1.1.0 ... 1.1.5
  52. * + Supports echo
  53. * + Supports in-band world (root server definition) updates
  54. * + Clustering! (Though this will work with protocol v4 clients.)
  55. * + Otherwise backward compatible with protocol v4
  56. * 6 - 1.1.5 ... 1.1.10
  57. * + Network configuration format revisions including binary values
  58. * 7 - 1.1.10 ... 1.1.17
  59. * + Introduce trusted paths for local SDN use
  60. * 8 - 1.1.17 ... 1.2.0
  61. * + Multipart network configurations for large network configs
  62. * + Tags and Capabilities
  63. * + Inline push of CertificateOfMembership deprecated
  64. * 9 - 1.2.0 ... 1.2.14
  65. * 10 - 1.4.0 ... 1.6.0
  66. * + Multipath capability and load balancing
  67. * 11 - 1.6.0 ... CURRENT
  68. * + Peer-to-peer multicast replication (optional)
  69. * + Old planet/moon stuff is DEAD!
  70. */
  71. #define ZT_PROTO_VERSION 11
  72. /**
  73. * Minimum supported protocol version
  74. */
  75. #define ZT_PROTO_VERSION_MIN 4
  76. /**
  77. * Maximum hop count allowed by packet structure (3 bits, 0-7)
  78. *
  79. * This is a protocol constant. It's the maximum allowed by the length
  80. * of the hop counter -- three bits. See node/Constants.hpp for the
  81. * pragmatic forwarding limit, which is typically lower.
  82. */
  83. #define ZT_PROTO_MAX_HOPS 7
  84. /**
  85. * Cipher suite: Curve25519/Poly1305/Salsa20/12/NOCRYPT
  86. *
  87. * This specifies Poly1305 MAC using a 32-bit key derived from the first
  88. * 32 bytes of a Salsa20/12 keystream as in the Salsa20/12 cipher suite,
  89. * but the payload is not encrypted. This is currently only used to send
  90. * HELLO since that's the public key specification packet and must be
  91. * sent in the clear. Key agreement is performed using Curve25519 elliptic
  92. * curve Diffie-Hellman.
  93. */
  94. #define ZT_PROTO_CIPHER_SUITE__C25519_POLY1305_NONE 0
  95. /**
  96. * Cipher suite: Curve25519/Poly1305/Salsa20/12
  97. *
  98. * This specifies Poly1305 using the first 32 bytes of a Salsa20/12 key
  99. * stream as its one-time-use key followed by payload encryption with
  100. * the remaining Salsa20/12 key stream. Key agreement is performed using
  101. * Curve25519 elliptic curve Diffie-Hellman.
  102. */
  103. #define ZT_PROTO_CIPHER_SUITE__C25519_POLY1305_SALSA2012 1
  104. /**
  105. * Cipher suite: NONE
  106. *
  107. * This differs from POLY1305/NONE in that *no* crypto is done, not even
  108. * authentication. This is for trusted local LAN interconnects for internal
  109. * SDN use within a data center.
  110. *
  111. * For this mode the MAC field becomes a trusted path ID and must match the
  112. * configured ID of a trusted path or the packet is discarded.
  113. */
  114. #define ZT_PROTO_CIPHER_SUITE__NO_CRYPTO_TRUSTED_PATH 2
  115. /**
  116. * DEPRECATED payload encrypted flag, may be re-used in the future.
  117. *
  118. * This has been replaced by the three-bit cipher suite selection field.
  119. */
  120. #define ZT_PROTO_FLAG_ENCRYPTED 0x80
  121. /**
  122. * Header flag indicating that a packet is fragmented
  123. *
  124. * If this flag is set, the receiver knows to expect more than one fragment.
  125. * See Packet::Fragment for details.
  126. */
  127. #define ZT_PROTO_FLAG_FRAGMENTED 0x40
  128. /**
  129. * Verb flag indicating payload is compressed with LZ4
  130. */
  131. #define ZT_PROTO_VERB_FLAG_COMPRESSED 0x80
  132. /**
  133. * Rounds used for Salsa20 encryption in ZT
  134. *
  135. * Discussion:
  136. *
  137. * DJB (Salsa20's designer) designed Salsa20 with a significant margin of 20
  138. * rounds, but has said repeatedly that 12 is likely sufficient. So far (as of
  139. * July 2015) there are no published attacks against 12 rounds, let alone 20.
  140. *
  141. * In cryptography, a "break" means something different from what it means in
  142. * common discussion. If a cipher is 256 bits strong and someone finds a way
  143. * to reduce key search to 254 bits, this constitutes a "break" in the academic
  144. * literature. 254 bits is still far beyond what can be leveraged to accomplish
  145. * a "break" as most people would understand it -- the actual decryption and
  146. * reading of traffic.
  147. *
  148. * Nevertheless, "attacks only get better" as cryptographers like to say. As
  149. * a result, they recommend not using anything that's shown any weakness even
  150. * if that weakness is so far only meaningful to academics. It may be a sign
  151. * of a deeper problem.
  152. *
  153. * So why choose a lower round count?
  154. *
  155. * Turns out the speed difference is nontrivial. On a Macbook Pro (Core i3) 20
  156. * rounds of SSE-optimized Salsa20 achieves ~508mb/sec/core, while 12 rounds
  157. * hits ~832mb/sec/core. ZeroTier is designed for multiple objectives:
  158. * security, simplicity, and performance. In this case a deference was made
  159. * for performance.
  160. *
  161. * Meta discussion:
  162. *
  163. * The cipher is not the thing you should be paranoid about.
  164. *
  165. * I'll qualify that. If the cipher is known to be weak, like RC4, or has a
  166. * key size that is too small, like DES, then yes you should worry about
  167. * the cipher.
  168. *
  169. * But if the cipher is strong and your adversary is anyone other than the
  170. * intelligence apparatus of a major superpower, you are fine in that
  171. * department.
  172. *
  173. * Go ahead. Search for the last ten vulnerabilities discovered in SSL. Not
  174. * a single one involved the breaking of a cipher. Now broaden your search.
  175. * Look for issues with SSH, IPSec, etc. The only cipher-related issues you
  176. * will find might involve the use of RC4 or MD5, algorithms with known
  177. * issues or small key/digest sizes. But even weak ciphers are difficult to
  178. * exploit in the real world -- you usually need a lot of data and a lot of
  179. * compute time. No, virtually EVERY security vulnerability you will find
  180. * involves a problem with the IMPLEMENTATION not with the cipher.
  181. *
  182. * A flaw in ZeroTier's protocol or code is incredibly, unbelievably
  183. * more likely than a flaw in Salsa20 or any other cipher or cryptographic
  184. * primitive it uses. We're talking odds of dying in a car wreck vs. odds of
  185. * being personally impacted on the head by a meteorite. Nobody without a
  186. * billion dollar budget is going to break into your network by actually
  187. * cracking Salsa20/12 (or even /8) in the field.
  188. *
  189. * So stop worrying about the cipher unless you are, say, the Kremlin and your
  190. * adversary is the NSA and the GCHQ. In that case... well that's above my
  191. * pay grade. I'll just say defense in depth.
  192. */
  193. #define ZT_PROTO_SALSA20_ROUNDS 12
  194. /**
  195. * PUSH_DIRECT_PATHS flag: forget path
  196. */
  197. #define ZT_PUSH_DIRECT_PATHS_FLAG_FORGET_PATH 0x01
  198. /**
  199. * PUSH_DIRECT_PATHS flag: cluster redirect
  200. */
  201. #define ZT_PUSH_DIRECT_PATHS_FLAG_CLUSTER_REDIRECT 0x02
  202. // Field indexes in packet header
  203. #define ZT_PACKET_IDX_IV 0
  204. #define ZT_PACKET_IDX_DEST 8
  205. #define ZT_PACKET_IDX_SOURCE 13
  206. #define ZT_PACKET_IDX_FLAGS 18
  207. #define ZT_PACKET_IDX_MAC 19
  208. #define ZT_PACKET_IDX_VERB 27
  209. #define ZT_PACKET_IDX_PAYLOAD 28
  210. /**
  211. * Packet buffer size (can be changed)
  212. */
  213. #define ZT_PROTO_MAX_PACKET_LENGTH (ZT_MAX_PACKET_FRAGMENTS * ZT_DEFAULT_PHYSMTU)
  214. /**
  215. * Minimum viable packet length (a.k.a. header length)
  216. */
  217. #define ZT_PROTO_MIN_PACKET_LENGTH ZT_PACKET_IDX_PAYLOAD
  218. // Indexes of fields in fragment header
  219. #define ZT_PACKET_FRAGMENT_IDX_PACKET_ID 0
  220. #define ZT_PACKET_FRAGMENT_IDX_DEST 8
  221. #define ZT_PACKET_FRAGMENT_IDX_FRAGMENT_INDICATOR 13
  222. #define ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO 14
  223. #define ZT_PACKET_FRAGMENT_IDX_HOPS 15
  224. #define ZT_PACKET_FRAGMENT_IDX_PAYLOAD 16
  225. /**
  226. * Magic number found at ZT_PACKET_FRAGMENT_IDX_FRAGMENT_INDICATOR
  227. */
  228. #define ZT_PACKET_FRAGMENT_INDICATOR ZT_ADDRESS_RESERVED_PREFIX
  229. /**
  230. * Minimum viable fragment length
  231. */
  232. #define ZT_PROTO_MIN_FRAGMENT_LENGTH ZT_PACKET_FRAGMENT_IDX_PAYLOAD
  233. // Field indices for parsing verbs -------------------------------------------
  234. // Some verbs have variable-length fields. Those aren't fully defined here
  235. // yet-- instead they are parsed using relative indexes in IncomingPacket.
  236. // See their respective handler functions.
  237. #define ZT_PROTO_VERB_HELLO_IDX_PROTOCOL_VERSION (ZT_PACKET_IDX_PAYLOAD)
  238. #define ZT_PROTO_VERB_HELLO_IDX_MAJOR_VERSION (ZT_PROTO_VERB_HELLO_IDX_PROTOCOL_VERSION + 1)
  239. #define ZT_PROTO_VERB_HELLO_IDX_MINOR_VERSION (ZT_PROTO_VERB_HELLO_IDX_MAJOR_VERSION + 1)
  240. #define ZT_PROTO_VERB_HELLO_IDX_REVISION (ZT_PROTO_VERB_HELLO_IDX_MINOR_VERSION + 1)
  241. #define ZT_PROTO_VERB_HELLO_IDX_TIMESTAMP (ZT_PROTO_VERB_HELLO_IDX_REVISION + 2)
  242. #define ZT_PROTO_VERB_HELLO_IDX_IDENTITY (ZT_PROTO_VERB_HELLO_IDX_TIMESTAMP + 8)
  243. #define ZT_PROTO_VERB_ERROR_IDX_IN_RE_VERB (ZT_PACKET_IDX_PAYLOAD)
  244. #define ZT_PROTO_VERB_ERROR_IDX_IN_RE_PACKET_ID (ZT_PROTO_VERB_ERROR_IDX_IN_RE_VERB + 1)
  245. #define ZT_PROTO_VERB_ERROR_IDX_ERROR_CODE (ZT_PROTO_VERB_ERROR_IDX_IN_RE_PACKET_ID + 8)
  246. #define ZT_PROTO_VERB_ERROR_IDX_PAYLOAD (ZT_PROTO_VERB_ERROR_IDX_ERROR_CODE + 1)
  247. #define ZT_PROTO_VERB_OK_IDX_IN_RE_VERB (ZT_PACKET_IDX_PAYLOAD)
  248. #define ZT_PROTO_VERB_OK_IDX_IN_RE_PACKET_ID (ZT_PROTO_VERB_OK_IDX_IN_RE_VERB + 1)
  249. #define ZT_PROTO_VERB_OK_IDX_PAYLOAD (ZT_PROTO_VERB_OK_IDX_IN_RE_PACKET_ID + 8)
  250. #define ZT_PROTO_VERB_WHOIS_IDX_ZTADDRESS (ZT_PACKET_IDX_PAYLOAD)
  251. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_FLAGS (ZT_PACKET_IDX_PAYLOAD)
  252. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_ZTADDRESS (ZT_PROTO_VERB_RENDEZVOUS_IDX_FLAGS + 1)
  253. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_PORT (ZT_PROTO_VERB_RENDEZVOUS_IDX_ZTADDRESS + 5)
  254. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRLEN (ZT_PROTO_VERB_RENDEZVOUS_IDX_PORT + 2)
  255. #define ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRESS (ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRLEN + 1)
  256. #define ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  257. #define ZT_PROTO_VERB_FRAME_IDX_ETHERTYPE (ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID + 8)
  258. #define ZT_PROTO_VERB_FRAME_IDX_PAYLOAD (ZT_PROTO_VERB_FRAME_IDX_ETHERTYPE + 2)
  259. #define ZT_PROTO_VERB_EXT_FRAME_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  260. #define ZT_PROTO_VERB_EXT_FRAME_LEN_NETWORK_ID 8
  261. #define ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS (ZT_PROTO_VERB_EXT_FRAME_IDX_NETWORK_ID + ZT_PROTO_VERB_EXT_FRAME_LEN_NETWORK_ID)
  262. #define ZT_PROTO_VERB_EXT_FRAME_LEN_FLAGS 1
  263. #define ZT_PROTO_VERB_EXT_FRAME_IDX_COM (ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS + ZT_PROTO_VERB_EXT_FRAME_LEN_FLAGS)
  264. #define ZT_PROTO_VERB_EXT_FRAME_IDX_TO (ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS + ZT_PROTO_VERB_EXT_FRAME_LEN_FLAGS)
  265. #define ZT_PROTO_VERB_EXT_FRAME_LEN_TO 6
  266. #define ZT_PROTO_VERB_EXT_FRAME_IDX_FROM (ZT_PROTO_VERB_EXT_FRAME_IDX_TO + ZT_PROTO_VERB_EXT_FRAME_LEN_TO)
  267. #define ZT_PROTO_VERB_EXT_FRAME_LEN_FROM 6
  268. #define ZT_PROTO_VERB_EXT_FRAME_IDX_ETHERTYPE (ZT_PROTO_VERB_EXT_FRAME_IDX_FROM + ZT_PROTO_VERB_EXT_FRAME_LEN_FROM)
  269. #define ZT_PROTO_VERB_EXT_FRAME_LEN_ETHERTYPE 2
  270. #define ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD (ZT_PROTO_VERB_EXT_FRAME_IDX_ETHERTYPE + ZT_PROTO_VERB_EXT_FRAME_LEN_ETHERTYPE)
  271. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  272. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT_LEN (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_NETWORK_ID + 8)
  273. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT_LEN + 2)
  274. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_NETWORK_ID (ZT_PACKET_IDX_PAYLOAD)
  275. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_FLAGS (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_NETWORK_ID + 8)
  276. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_MAC (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_FLAGS + 1)
  277. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_ADI (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_MAC + 6)
  278. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_GATHER_LIMIT (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_ADI + 4)
  279. #define ZT_PROTO_VERB_MULTICAST_GATHER_IDX_COM (ZT_PROTO_VERB_MULTICAST_GATHER_IDX_GATHER_LIMIT + 4)
  280. #define ZT_PROTO_VERB_HELLO__OK__IDX_TIMESTAMP (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  281. #define ZT_PROTO_VERB_HELLO__OK__IDX_PROTOCOL_VERSION (ZT_PROTO_VERB_HELLO__OK__IDX_TIMESTAMP + 8)
  282. #define ZT_PROTO_VERB_HELLO__OK__IDX_MAJOR_VERSION (ZT_PROTO_VERB_HELLO__OK__IDX_PROTOCOL_VERSION + 1)
  283. #define ZT_PROTO_VERB_HELLO__OK__IDX_MINOR_VERSION (ZT_PROTO_VERB_HELLO__OK__IDX_MAJOR_VERSION + 1)
  284. #define ZT_PROTO_VERB_HELLO__OK__IDX_REVISION (ZT_PROTO_VERB_HELLO__OK__IDX_MINOR_VERSION + 1)
  285. #define ZT_PROTO_VERB_WHOIS__OK__IDX_IDENTITY (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  286. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_NETWORK_ID (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  287. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT_LEN (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_NETWORK_ID + 8)
  288. #define ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT (ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT_LEN + 2)
  289. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_NETWORK_ID (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  290. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_MAC (ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_NETWORK_ID + 8)
  291. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_ADI (ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_MAC + 6)
  292. #define ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_GATHER_RESULTS (ZT_PROTO_VERB_MULTICAST_GATHER__OK__IDX_ADI + 4)
  293. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_NETWORK_ID (ZT_PROTO_VERB_OK_IDX_PAYLOAD)
  294. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_MAC (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_NETWORK_ID + 8)
  295. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_ADI (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_MAC + 6)
  296. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_FLAGS (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_ADI + 4)
  297. #define ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_COM_AND_GATHER_RESULTS (ZT_PROTO_VERB_MULTICAST_FRAME__OK__IDX_FLAGS + 1)
  298. // ---------------------------------------------------------------------------
  299. namespace ZeroTier {
  300. /**
  301. * ZeroTier packet
  302. *
  303. * Packet format:
  304. * <[8] 64-bit packet ID / crypto IV / packet counter>
  305. * <[5] destination ZT address>
  306. * <[5] source ZT address>
  307. * <[1] flags/cipher/hops>
  308. * <[8] 64-bit MAC (or trusted path ID in trusted path mode)>
  309. * [... -- begin encryption envelope -- ...]
  310. * <[1] encrypted flags (MS 3 bits) and verb (LS 5 bits)>
  311. * [... verb-specific payload ...]
  312. *
  313. * Packets smaller than 28 bytes are invalid and silently discarded.
  314. *
  315. * The 64-bit packet ID is a strongly random value used as a crypto IV.
  316. * Its least significant 3 bits are also used as a monotonically increasing
  317. * (and looping) counter for sending packets to a particular recipient. This
  318. * can be used for link quality monitoring and reporting and has no crypto
  319. * impact as it does not increase the likelihood of an IV collision. (The
  320. * crypto we use is not sensitive to the nature of the IV, only that it does
  321. * not repeat.)
  322. *
  323. * The flags/cipher/hops bit field is: FFCCCHHH where C is a 3-bit cipher
  324. * selection allowing up to 7 cipher suites, F is outside-envelope flags,
  325. * and H is hop count.
  326. *
  327. * The three-bit hop count is the only part of a packet that is mutable in
  328. * transit without invalidating the MAC. All other bits in the packet are
  329. * immutable. This is because intermediate nodes can increment the hop
  330. * count up to 7 (protocol max).
  331. *
  332. * For unencrypted packets, MAC is computed on plaintext. Only HELLO is ever
  333. * sent in the clear, as it's the "here is my public key" message.
  334. */
  335. class Packet : public Buffer<ZT_PROTO_MAX_PACKET_LENGTH>
  336. {
  337. public:
  338. /**
  339. * A packet fragment
  340. *
  341. * Fragments are sent if a packet is larger than UDP MTU. The first fragment
  342. * is sent with its normal header with the fragmented flag set. Remaining
  343. * fragments are sent this way.
  344. *
  345. * The fragmented bit indicates that there is at least one fragment. Fragments
  346. * themselves contain the total, so the receiver must "learn" this from the
  347. * first fragment it receives.
  348. *
  349. * Fragments are sent with the following format:
  350. * <[8] packet ID of packet whose fragment this belongs to>
  351. * <[5] destination ZT address>
  352. * <[1] 0xff, a reserved address, signals that this isn't a normal packet>
  353. * <[1] total fragments (most significant 4 bits), fragment no (LS 4 bits)>
  354. * <[1] ZT hop count (top 5 bits unused and must be zero)>
  355. * <[...] fragment data>
  356. *
  357. * The protocol supports a maximum of 16 fragments. If a fragment is received
  358. * before its main packet header, it should be cached for a brief period of
  359. * time to see if its parent arrives. Loss of any fragment constitutes packet
  360. * loss; there is no retransmission mechanism. The receiver must wait for full
  361. * receipt to authenticate and decrypt; there is no per-fragment MAC. (But if
  362. * fragments are corrupt, the MAC will fail for the whole assembled packet.)
  363. */
  364. class Fragment : public Buffer<ZT_PROTO_MAX_PACKET_LENGTH>
  365. {
  366. public:
  367. Fragment() :
  368. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>()
  369. {
  370. }
  371. template<unsigned int C2>
  372. Fragment(const Buffer<C2> &b) :
  373. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(b)
  374. {
  375. }
  376. Fragment(const void *data,unsigned int len) :
  377. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(data,len)
  378. {
  379. }
  380. /**
  381. * Initialize from a packet
  382. *
  383. * @param p Original assembled packet
  384. * @param fragStart Start of fragment (raw index in packet data)
  385. * @param fragLen Length of fragment in bytes
  386. * @param fragNo Which fragment (>= 1, since 0 is Packet with end chopped off)
  387. * @param fragTotal Total number of fragments (including 0)
  388. */
  389. Fragment(const Packet &p,unsigned int fragStart,unsigned int fragLen,unsigned int fragNo,unsigned int fragTotal)
  390. {
  391. init(p,fragStart,fragLen,fragNo,fragTotal);
  392. }
  393. /**
  394. * Initialize from a packet
  395. *
  396. * @param p Original assembled packet
  397. * @param fragStart Start of fragment (raw index in packet data)
  398. * @param fragLen Length of fragment in bytes
  399. * @param fragNo Which fragment (>= 1, since 0 is Packet with end chopped off)
  400. * @param fragTotal Total number of fragments (including 0)
  401. */
  402. inline void init(const Packet &p,unsigned int fragStart,unsigned int fragLen,unsigned int fragNo,unsigned int fragTotal)
  403. {
  404. if ((fragStart + fragLen) > p.size())
  405. throw ZT_EXCEPTION_OUT_OF_BOUNDS;
  406. setSize(fragLen + ZT_PROTO_MIN_FRAGMENT_LENGTH);
  407. // NOTE: this copies both the IV/packet ID and the destination address.
  408. memcpy(field(ZT_PACKET_FRAGMENT_IDX_PACKET_ID,13),p.field(ZT_PACKET_IDX_IV,13),13);
  409. (*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_INDICATOR] = ZT_PACKET_FRAGMENT_INDICATOR;
  410. (*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO] = (char)(((fragTotal & 0xf) << 4) | (fragNo & 0xf));
  411. (*this)[ZT_PACKET_FRAGMENT_IDX_HOPS] = 0;
  412. memcpy(field(ZT_PACKET_FRAGMENT_IDX_PAYLOAD,fragLen),p.field(fragStart,fragLen),fragLen);
  413. }
  414. /**
  415. * Get this fragment's destination
  416. *
  417. * @return Destination ZT address
  418. */
  419. inline Address destination() const { return Address(field(ZT_PACKET_FRAGMENT_IDX_DEST,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  420. /**
  421. * @return True if fragment is of a valid length
  422. */
  423. inline bool lengthValid() const { return (size() >= ZT_PACKET_FRAGMENT_IDX_PAYLOAD); }
  424. /**
  425. * @return ID of packet this is a fragment of
  426. */
  427. inline uint64_t packetId() const { return at<uint64_t>(ZT_PACKET_FRAGMENT_IDX_PACKET_ID); }
  428. /**
  429. * @return Total number of fragments in packet
  430. */
  431. inline unsigned int totalFragments() const { return (((unsigned int)((*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO]) >> 4) & 0xf); }
  432. /**
  433. * @return Fragment number of this fragment
  434. */
  435. inline unsigned int fragmentNumber() const { return ((unsigned int)((*this)[ZT_PACKET_FRAGMENT_IDX_FRAGMENT_NO]) & 0xf); }
  436. /**
  437. * @return Fragment ZT hop count
  438. */
  439. inline unsigned int hops() const { return (unsigned int)((*this)[ZT_PACKET_FRAGMENT_IDX_HOPS]); }
  440. /**
  441. * Increment this packet's hop count
  442. */
  443. inline void incrementHops()
  444. {
  445. (*this)[ZT_PACKET_FRAGMENT_IDX_HOPS] = (((*this)[ZT_PACKET_FRAGMENT_IDX_HOPS]) + 1) & ZT_PROTO_MAX_HOPS;
  446. }
  447. /**
  448. * @return Length of payload in bytes
  449. */
  450. inline unsigned int payloadLength() const { return ((size() > ZT_PACKET_FRAGMENT_IDX_PAYLOAD) ? (size() - ZT_PACKET_FRAGMENT_IDX_PAYLOAD) : 0); }
  451. /**
  452. * @return Raw packet payload
  453. */
  454. inline const unsigned char *payload() const
  455. {
  456. return field(ZT_PACKET_FRAGMENT_IDX_PAYLOAD,size() - ZT_PACKET_FRAGMENT_IDX_PAYLOAD);
  457. }
  458. };
  459. /**
  460. * ZeroTier protocol verbs
  461. */
  462. enum Verb /* Max value: 32 (5 bits) */
  463. {
  464. /**
  465. * No operation (ignored, no reply)
  466. */
  467. VERB_NOP = 0x00,
  468. /**
  469. * Announcement of a node's existence and vitals:
  470. * <[1] protocol version>
  471. * <[1] software major version>
  472. * <[1] software minor version>
  473. * <[2] software revision>
  474. * <[8] timestamp for determining latency>
  475. * <[...] binary serialized identity (see Identity)>
  476. * <[...] physical destination address of packet>
  477. *
  478. * HELLO is sent in the clear as it is how peers share their identity
  479. * public keys.
  480. *
  481. * Destination address is the actual wire address to which the packet
  482. * was sent. See InetAddress::serialize() for format.
  483. *
  484. * OK payload:
  485. * <[8] HELLO timestamp field echo>
  486. * <[1] protocol version>
  487. * <[1] software major version>
  488. * <[1] software minor version>
  489. * <[2] software revision>
  490. * <[...] physical destination address of packet>
  491. *
  492. * With the exception of the timestamp, the other fields pertain to the
  493. * respondent who is sending OK and are not echoes.
  494. *
  495. * ERROR has no payload.
  496. */
  497. VERB_HELLO = 0x01,
  498. /**
  499. * Error response:
  500. * <[1] in-re verb>
  501. * <[8] in-re packet ID>
  502. * <[1] error code>
  503. * <[...] error-dependent payload>
  504. */
  505. VERB_ERROR = 0x02,
  506. /**
  507. * Success response:
  508. * <[1] in-re verb>
  509. * <[8] in-re packet ID>
  510. * <[...] request-specific payload>
  511. */
  512. VERB_OK = 0x03,
  513. /**
  514. * Query an identity by address:
  515. * <[5] address to look up>
  516. * [<[...] additional addresses to look up>
  517. *
  518. * OK response payload:
  519. * <[...] binary serialized identity>
  520. * [<[...] additional binary serialized identities>]
  521. *
  522. * If querying a cluster, duplicate OK responses may occasionally occur.
  523. * These must be tolerated, which is easy since they'll have info you
  524. * already have.
  525. *
  526. * If the address is not found, no response is generated. The semantics
  527. * of WHOIS is similar to ARP and NDP in that persistent retrying can
  528. * be performed.
  529. */
  530. VERB_WHOIS = 0x04,
  531. /**
  532. * Relay-mediated NAT traversal or firewall punching initiation:
  533. * <[1] flags (unused, currently 0)>
  534. * <[5] ZeroTier address of peer that might be found at this address>
  535. * <[2] 16-bit protocol address port>
  536. * <[1] protocol address length (4 for IPv4, 16 for IPv6)>
  537. * <[...] protocol address (network byte order)>
  538. *
  539. * An upstream node can send this to inform both sides of a relay of
  540. * information they might use to establish a direct connection.
  541. *
  542. * Upon receipt a peer sends HELLO to establish a direct link.
  543. *
  544. * No OK or ERROR is generated.
  545. */
  546. VERB_RENDEZVOUS = 0x05,
  547. /**
  548. * ZT-to-ZT unicast ethernet frame (shortened EXT_FRAME):
  549. * <[8] 64-bit network ID>
  550. * <[2] 16-bit ethertype>
  551. * <[...] ethernet payload>
  552. *
  553. * MAC addresses are derived from the packet's source and destination
  554. * ZeroTier addresses. This is a shortened EXT_FRAME that elides full
  555. * Ethernet framing and other optional flags and features when they
  556. * are not necessary.
  557. *
  558. * ERROR may be generated if a membership certificate is needed for a
  559. * closed network. Payload will be network ID.
  560. */
  561. VERB_FRAME = 0x06,
  562. /**
  563. * Full Ethernet frame with MAC addressing and optional fields:
  564. * <[8] 64-bit network ID>
  565. * <[1] flags>
  566. * <[6] destination MAC or all zero for destination node>
  567. * <[6] source MAC or all zero for node of origin>
  568. * <[2] 16-bit ethertype>
  569. * <[...] ethernet payload>
  570. *
  571. * Flags:
  572. * 0x01 - Certificate of network membership attached (DEPRECATED)
  573. * 0x02 - Most significant bit of subtype (see below)
  574. * 0x04 - Middle bit of subtype (see below)
  575. * 0x08 - Least significant bit of subtype (see below)
  576. * 0x10 - ACK requested in the form of OK(EXT_FRAME)
  577. *
  578. * Subtypes (0..7):
  579. * 0x0 - Normal frame (bridging can be determined by checking MAC)
  580. * 0x1 - TEEd outbound frame
  581. * 0x2 - REDIRECTed outbound frame
  582. * 0x3 - WATCHed outbound frame (TEE with ACK, ACK bit also set)
  583. * 0x4 - TEEd inbound frame
  584. * 0x5 - REDIRECTed inbound frame
  585. * 0x6 - WATCHed inbound frame
  586. * 0x7 - (reserved for future use)
  587. *
  588. * An extended frame carries full MAC addressing, making it a
  589. * superset of VERB_FRAME. It is used for bridged traffic,
  590. * redirected or observed traffic via rules, and can in theory
  591. * be used for multicast though MULTICAST_FRAME exists for that
  592. * purpose and has additional options and capabilities.
  593. *
  594. * OK payload (if ACK flag is set):
  595. * <[8] 64-bit network ID>
  596. */
  597. VERB_EXT_FRAME = 0x07,
  598. /**
  599. * ECHO request (a.k.a. ping):
  600. * <[...] arbitrary payload>
  601. *
  602. * This generates OK with a copy of the transmitted payload. No ERROR
  603. * is generated. Response to ECHO requests is optional and ECHO may be
  604. * ignored if a node detects a possible flood.
  605. */
  606. VERB_ECHO = 0x08,
  607. /**
  608. * Announce interest in multicast group(s):
  609. * <[8] 64-bit network ID>
  610. * <[6] multicast Ethernet address>
  611. * <[4] multicast additional distinguishing information (ADI)>
  612. * [... additional tuples of network/address/adi ...]
  613. *
  614. * LIKEs may be sent to any peer, though a good implementation should
  615. * restrict them to peers on the same network they're for and to network
  616. * controllers and root servers. In the current network, root servers
  617. * will provide the service of final multicast cache.
  618. *
  619. * OK/ERROR are not generated.
  620. */
  621. VERB_MULTICAST_LIKE = 0x09,
  622. /**
  623. * Network credentials push:
  624. * [<[...] one or more certificates of membership>]
  625. * <[1] 0x00, null byte marking end of COM array>
  626. * <[2] 16-bit number of capabilities>
  627. * <[...] one or more serialized Capability>
  628. * <[2] 16-bit number of tags>
  629. * <[...] one or more serialized Tags>
  630. * <[2] 16-bit number of revocations>
  631. * <[...] one or more serialized Revocations>
  632. * <[2] 16-bit number of certificates of ownership>
  633. * <[...] one or more serialized CertificateOfOwnership>
  634. *
  635. * This can be sent by anyone at any time to push network credentials.
  636. * These will of course only be accepted if they are properly signed.
  637. * Credentials can be for any number of networks.
  638. *
  639. * The use of a zero byte to terminate the COM section is for legacy
  640. * backward compatibility. Newer fields are prefixed with a length.
  641. *
  642. * OK/ERROR are not generated.
  643. */
  644. VERB_NETWORK_CREDENTIALS = 0x0a,
  645. /**
  646. * Network configuration request:
  647. * <[8] 64-bit network ID>
  648. * <[2] 16-bit length of request meta-data dictionary>
  649. * <[...] string-serialized request meta-data>
  650. * <[8] 64-bit revision of netconf we currently have>
  651. * <[8] 64-bit timestamp of netconf we currently have>
  652. *
  653. * This message requests network configuration from a node capable of
  654. * providing it.
  655. *
  656. * Responses to this are always whole configs intended for the recipient.
  657. * For patches and other updates a NETWORK_CONFIG is sent instead.
  658. *
  659. * It would be valid and correct as of 1.2.0 to use NETWORK_CONFIG always,
  660. * but OK(NETWORK_CONFIG_REQUEST) should be sent for compatibility.
  661. *
  662. * OK response payload:
  663. * <[8] 64-bit network ID>
  664. * <[2] 16-bit length of network configuration dictionary chunk>
  665. * <[...] network configuration dictionary (may be incomplete)>
  666. * [ ... end of legacy single chunk response ... ]
  667. * <[1] 8-bit flags>
  668. * <[8] 64-bit config update ID (should never be 0)>
  669. * <[4] 32-bit total length of assembled dictionary>
  670. * <[4] 32-bit index of chunk>
  671. * [ ... end signed portion ... ]
  672. * <[1] 8-bit chunk signature type>
  673. * <[2] 16-bit length of chunk signature>
  674. * <[...] chunk signature>
  675. *
  676. * The chunk signature signs the entire payload of the OK response.
  677. * Currently only one signature type is supported: ed25519 (1).
  678. *
  679. * Each config chunk is signed to prevent memory exhaustion or
  680. * traffic crowding DOS attacks against config fragment assembly.
  681. *
  682. * If the packet is from the network controller it is permitted to end
  683. * before the config update ID or other chunking related or signature
  684. * fields. This is to support older controllers that don't include
  685. * these fields and may be removed in the future.
  686. *
  687. * ERROR response payload:
  688. * <[8] 64-bit network ID>
  689. */
  690. VERB_NETWORK_CONFIG_REQUEST = 0x0b,
  691. /**
  692. * Network configuration data push:
  693. * <[8] 64-bit network ID>
  694. * <[2] 16-bit length of network configuration dictionary chunk>
  695. * <[...] network configuration dictionary (may be incomplete)>
  696. * <[1] 8-bit flags>
  697. * <[8] 64-bit config update ID (should never be 0)>
  698. * <[4] 32-bit total length of assembled dictionary>
  699. * <[4] 32-bit index of chunk>
  700. * [ ... end signed portion ... ]
  701. * <[1] 8-bit chunk signature type>
  702. * <[2] 16-bit length of chunk signature>
  703. * <[...] chunk signature>
  704. *
  705. * This is a direct push variant for network config updates. It otherwise
  706. * carries the same payload as OK(NETWORK_CONFIG_REQUEST) and has the same
  707. * semantics.
  708. *
  709. * The legacy mode missing the additional chunking fields is not supported
  710. * here.
  711. *
  712. * Flags:
  713. * 0x01 - Use fast propagation
  714. *
  715. * An OK should be sent if the config is successfully received and
  716. * accepted.
  717. *
  718. * OK payload:
  719. * <[8] 64-bit network ID>
  720. * <[8] 64-bit config update ID>
  721. */
  722. VERB_NETWORK_CONFIG = 0x0c,
  723. /**
  724. * Request endpoints for multicast distribution:
  725. * <[8] 64-bit network ID>
  726. * <[1] flags>
  727. * <[6] MAC address of multicast group being queried>
  728. * <[4] 32-bit ADI for multicast group being queried>
  729. * <[4] 32-bit requested max number of multicast peers>
  730. * [<[...] network certificate of membership>]
  731. *
  732. * Flags:
  733. * 0x01 - COM is attached (DEPRECATED)
  734. *
  735. * More than one OK response can occur if the response is broken up across
  736. * multiple packets or if querying a clustered node.
  737. *
  738. * OK response payload:
  739. * <[8] 64-bit network ID>
  740. * <[6] MAC address of multicast group being queried>
  741. * <[4] 32-bit ADI for multicast group being queried>
  742. * [begin gather results -- these same fields can be in OK(MULTICAST_FRAME)]
  743. * <[4] 32-bit total number of known members in this multicast group>
  744. * <[2] 16-bit number of members enumerated in this packet>
  745. * <[...] series of 5-byte ZeroTier addresses of enumerated members>
  746. *
  747. * ERROR is not generated; queries that return no response are dropped.
  748. */
  749. VERB_MULTICAST_GATHER = 0x0d,
  750. /**
  751. * Multicast frame:
  752. * <[8] 64-bit network ID>
  753. * <[1] flags>
  754. * [<[4] 32-bit implicit gather limit>]
  755. * [<[6] source MAC>]
  756. * [<[2] number of explicitly specified recipients>]
  757. * [<[...] series of 5-byte explicitly specified recipients>]
  758. * <[6] destination MAC (multicast address)>
  759. * <[4] 32-bit multicast ADI (multicast address extension)>
  760. * <[2] 16-bit ethertype>
  761. * <[...] ethernet payload>
  762. *
  763. * Flags:
  764. * 0x01 - Network certificate of membership attached (DEPRECATED)
  765. * 0x02 - Implicit gather limit field is present (DEPRECATED)
  766. * 0x04 - Source MAC is specified -- otherwise it's computed from sender
  767. * 0x08 - Explicit recipient list included for P2P/HS replication
  768. *
  769. * Explicit recipient lists are used for peer to peer or hub and spoke
  770. * replication.
  771. *
  772. * OK response payload:
  773. * <[8] 64-bit network ID>
  774. * <[6] MAC address of multicast group>
  775. * <[4] 32-bit ADI for multicast group>
  776. * <[1] flags>
  777. * [<[...] network certificate of membership (DEPRECATED)>]
  778. * [<[...] implicit gather results if flag 0x01 is set>]
  779. *
  780. * OK flags (same bits as request flags):
  781. * 0x01 - OK includes certificate of network membership (DEPRECATED)
  782. * 0x02 - OK includes implicit gather results
  783. *
  784. * ERROR response payload:
  785. * <[8] 64-bit network ID>
  786. * <[6] multicast group MAC>
  787. * <[4] 32-bit multicast group ADI>
  788. */
  789. VERB_MULTICAST_FRAME = 0x0e,
  790. /**
  791. * Push of potential endpoints for direct communication:
  792. * <[2] 16-bit number of paths>
  793. * <[...] paths>
  794. *
  795. * Path record format:
  796. * <[1] 8-bit path flags>
  797. * <[2] length of extended path characteristics or 0 for none>
  798. * <[...] extended path characteristics>
  799. * <[1] address type>
  800. * <[1] address length in bytes>
  801. * <[...] address>
  802. *
  803. * Path record flags:
  804. * 0x01 - Forget this path if currently known (not implemented yet)
  805. * 0x02 - Cluster redirect -- use this in preference to others
  806. *
  807. * The receiver may, upon receiving a push, attempt to establish a
  808. * direct link to one or more of the indicated addresses. It is the
  809. * responsibility of the sender to limit which peers it pushes direct
  810. * paths to to those with whom it has a trust relationship. The receiver
  811. * must obey any restrictions provided such as exclusivity or blacklists.
  812. * OK responses to this message are optional.
  813. *
  814. * Note that a direct path push does not imply that learned paths can't
  815. * be used unless they are blacklisted explicitly or unless flag 0x01
  816. * is set.
  817. *
  818. * OK and ERROR are not generated.
  819. */
  820. VERB_PUSH_DIRECT_PATHS = 0x10,
  821. // 0x11 -- deprecated
  822. /**
  823. * An acknowledgment of receipt of a series of recent packets from another
  824. * peer. This is used to calculate relative throughput values and to detect
  825. * packet loss. Only VERB_FRAME and VERB_EXT_FRAME packets are counted.
  826. *
  827. * ACK response format:
  828. * <[4] 32-bit number of bytes received since last ACK>
  829. *
  830. * Upon receipt of this packet, the local peer will verify that the correct
  831. * number of bytes were received by the remote peer. If these values do
  832. * not agree that could be an indicator of packet loss.
  833. *
  834. * Additionally, the local peer knows the interval of time that has
  835. * elapsed since the last received ACK. With this information it can compute
  836. * a rough estimate of the current throughput.
  837. *
  838. * This is sent at a maximum rate of once per every ZT_PATH_ACK_INTERVAL
  839. */
  840. VERB_ACK = 0x12,
  841. /**
  842. * A packet containing timing measurements useful for estimating path quality.
  843. * Composed of a list of <packet ID:internal sojourn time> pairs for an
  844. * arbitrary set of recent packets. This is used to sample for latency and
  845. * packet delay variance (PDV, "jitter").
  846. *
  847. * QoS record format:
  848. *
  849. * <[8] 64-bit packet ID of previously-received packet>
  850. * <[1] 8-bit packet sojourn time>
  851. * <...repeat until end of max 1400 byte packet...>
  852. *
  853. * The number of possible records per QoS packet is: (1400 * 8) / 72 = 155
  854. * This packet should be sent very rarely (every few seconds) as it can be
  855. * somewhat large if the connection is saturated. Future versions might use
  856. * a bloom table to probabilistically determine these values in a vastly
  857. * more space-efficient manner.
  858. *
  859. * Note: The 'internal packet sojourn time' is a slight misnomer as it is a
  860. * measure of the amount of time between when a packet was received and the
  861. * egress time of its tracking QoS packet.
  862. *
  863. * This is sent at a maximum rate of once per every ZT_PATH_QOS_INTERVAL
  864. */
  865. VERB_QOS_MEASUREMENT = 0x13,
  866. /**
  867. * A message with arbitrary user-definable content:
  868. * <[8] 64-bit arbitrary message type ID>
  869. * [<[...] message payload>]
  870. *
  871. * This can be used to send arbitrary messages over VL1. It generates no
  872. * OK or ERROR and has no special semantics outside of whatever the user
  873. * (via the ZeroTier core API) chooses to give it.
  874. *
  875. * Message type IDs less than or equal to 65535 are reserved for use by
  876. * ZeroTier, Inc. itself. We recommend making up random ones for your own
  877. * implementations.
  878. */
  879. VERB_USER_MESSAGE = 0x14,
  880. /**
  881. * A trace for remote debugging or diagnostics:
  882. * <[...] null-terminated dictionary containing trace information>
  883. * [<[...] additional null-terminated dictionaries>]
  884. *
  885. * This message contains a remote trace event. Remote trace events can
  886. * be sent to observers configured at the network level for those that
  887. * pertain directly to activity on a network, or to global observers if
  888. * locally configured.
  889. */
  890. VERB_REMOTE_TRACE = 0x15
  891. };
  892. /**
  893. * Error codes for VERB_ERROR
  894. */
  895. enum ErrorCode
  896. {
  897. /* No error, not actually used in transit */
  898. ERROR_NONE = 0x00,
  899. /* Invalid request */
  900. ERROR_INVALID_REQUEST = 0x01,
  901. /* Bad/unsupported protocol version */
  902. ERROR_BAD_PROTOCOL_VERSION = 0x02,
  903. /* Unknown object queried */
  904. ERROR_OBJ_NOT_FOUND = 0x03,
  905. /* HELLO pushed an identity whose address is already claimed */
  906. ERROR_IDENTITY_COLLISION = 0x04,
  907. /* Verb or use case not supported/enabled by this node */
  908. ERROR_UNSUPPORTED_OPERATION = 0x05,
  909. /* Network membership certificate update needed */
  910. ERROR_NEED_MEMBERSHIP_CERTIFICATE = 0x06,
  911. /* Tried to join network, but you're not a member */
  912. ERROR_NETWORK_ACCESS_DENIED_ = 0x07, /* extra _ at end to avoid Windows name conflict */
  913. /* Multicasts to this group are not wanted */
  914. ERROR_UNWANTED_MULTICAST = 0x08
  915. };
  916. template<unsigned int C2>
  917. Packet(const Buffer<C2> &b) :
  918. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(b)
  919. {
  920. }
  921. Packet(const void *data,unsigned int len) :
  922. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(data,len)
  923. {
  924. }
  925. /**
  926. * Construct a new empty packet with a unique random packet ID
  927. *
  928. * Flags and hops will be zero. Other fields and data region are undefined.
  929. * Use the header access methods (setDestination() and friends) to fill out
  930. * the header. Payload should be appended; initial size is header size.
  931. */
  932. Packet() :
  933. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(ZT_PROTO_MIN_PACKET_LENGTH)
  934. {
  935. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  936. (*this)[ZT_PACKET_IDX_FLAGS] = 0; // zero flags, cipher ID, and hops
  937. }
  938. /**
  939. * Make a copy of a packet with a new initialization vector and destination address
  940. *
  941. * This can be used to take one draft prototype packet and quickly make copies to
  942. * encrypt for different destinations.
  943. *
  944. * @param prototype Prototype packet
  945. * @param dest Destination ZeroTier address for new packet
  946. */
  947. Packet(const Packet &prototype,const Address &dest) :
  948. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(prototype)
  949. {
  950. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  951. setDestination(dest);
  952. }
  953. /**
  954. * Construct a new empty packet with a unique random packet ID
  955. *
  956. * @param dest Destination ZT address
  957. * @param source Source ZT address
  958. * @param v Verb
  959. */
  960. Packet(const Address &dest,const Address &source,const Verb v) :
  961. Buffer<ZT_PROTO_MAX_PACKET_LENGTH>(ZT_PROTO_MIN_PACKET_LENGTH)
  962. {
  963. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  964. setDestination(dest);
  965. setSource(source);
  966. (*this)[ZT_PACKET_IDX_FLAGS] = 0; // zero flags and hops
  967. setVerb(v);
  968. }
  969. /**
  970. * Reset this packet structure for reuse in place
  971. *
  972. * @param dest Destination ZT address
  973. * @param source Source ZT address
  974. * @param v Verb
  975. */
  976. inline void reset(const Address &dest,const Address &source,const Verb v)
  977. {
  978. setSize(ZT_PROTO_MIN_PACKET_LENGTH);
  979. Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8);
  980. setDestination(dest);
  981. setSource(source);
  982. (*this)[ZT_PACKET_IDX_FLAGS] = 0; // zero flags, cipher ID, and hops
  983. setVerb(v);
  984. }
  985. /**
  986. * Generate a new IV / packet ID in place
  987. *
  988. * This can be used to re-use a packet buffer multiple times to send
  989. * technically different but otherwise identical copies of the same
  990. * packet.
  991. */
  992. inline void newInitializationVector() { Utils::getSecureRandom(field(ZT_PACKET_IDX_IV,8),8); }
  993. /**
  994. * Set this packet's destination
  995. *
  996. * @param dest ZeroTier address of destination
  997. */
  998. inline void setDestination(const Address &dest) { dest.copyTo(field(ZT_PACKET_IDX_DEST,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  999. /**
  1000. * Set this packet's source
  1001. *
  1002. * @param source ZeroTier address of source
  1003. */
  1004. inline void setSource(const Address &source) { source.copyTo(field(ZT_PACKET_IDX_SOURCE,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  1005. /**
  1006. * Get this packet's destination
  1007. *
  1008. * @return Destination ZT address
  1009. */
  1010. inline Address destination() const { return Address(field(ZT_PACKET_IDX_DEST,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  1011. /**
  1012. * Get this packet's source
  1013. *
  1014. * @return Source ZT address
  1015. */
  1016. inline Address source() const { return Address(field(ZT_PACKET_IDX_SOURCE,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH); }
  1017. /**
  1018. * @return True if packet is of valid length
  1019. */
  1020. inline bool lengthValid() const { return (size() >= ZT_PROTO_MIN_PACKET_LENGTH); }
  1021. /**
  1022. * @return True if packet is fragmented (expect fragments)
  1023. */
  1024. inline bool fragmented() const { return (((unsigned char)(*this)[ZT_PACKET_IDX_FLAGS] & ZT_PROTO_FLAG_FRAGMENTED) != 0); }
  1025. /**
  1026. * Set this packet's fragmented flag
  1027. *
  1028. * @param f Fragmented flag value
  1029. */
  1030. inline void setFragmented(bool f)
  1031. {
  1032. if (f)
  1033. (*this)[ZT_PACKET_IDX_FLAGS] |= (char)ZT_PROTO_FLAG_FRAGMENTED;
  1034. else (*this)[ZT_PACKET_IDX_FLAGS] &= (char)(~ZT_PROTO_FLAG_FRAGMENTED);
  1035. }
  1036. /**
  1037. * @return True if compressed (result only valid if unencrypted)
  1038. */
  1039. inline bool compressed() const { return (((unsigned char)(*this)[ZT_PACKET_IDX_VERB] & ZT_PROTO_VERB_FLAG_COMPRESSED) != 0); }
  1040. /**
  1041. * @return ZeroTier forwarding hops (0 to 7)
  1042. */
  1043. inline unsigned int hops() const { return ((unsigned int)(*this)[ZT_PACKET_IDX_FLAGS] & 0x07); }
  1044. /**
  1045. * Increment this packet's hop count
  1046. */
  1047. inline void incrementHops()
  1048. {
  1049. unsigned char &b = (*this)[ZT_PACKET_IDX_FLAGS];
  1050. b = (b & 0xf8) | ((b + 1) & 0x07);
  1051. }
  1052. /**
  1053. * @return Cipher suite selector: 0 - 7 (see #defines)
  1054. */
  1055. inline unsigned int cipher() const
  1056. {
  1057. return (((unsigned int)(*this)[ZT_PACKET_IDX_FLAGS] & 0x38) >> 3);
  1058. }
  1059. /**
  1060. * Set this packet's cipher suite
  1061. */
  1062. inline void setCipher(unsigned int c)
  1063. {
  1064. unsigned char &b = (*this)[ZT_PACKET_IDX_FLAGS];
  1065. b = (b & 0xc7) | (unsigned char)((c << 3) & 0x38); // bits: FFCCCHHH
  1066. // Set DEPRECATED "encrypted" flag -- used by pre-1.0.3 peers
  1067. if (c == ZT_PROTO_CIPHER_SUITE__C25519_POLY1305_SALSA2012)
  1068. b |= ZT_PROTO_FLAG_ENCRYPTED;
  1069. else b &= (~ZT_PROTO_FLAG_ENCRYPTED);
  1070. }
  1071. /**
  1072. * Get the trusted path ID for this packet (only meaningful if cipher is trusted path)
  1073. *
  1074. * @return Trusted path ID (from MAC field)
  1075. */
  1076. inline uint64_t trustedPathId() const { return at<uint64_t>(ZT_PACKET_IDX_MAC); }
  1077. /**
  1078. * Set this packet's trusted path ID and set the cipher spec to trusted path
  1079. *
  1080. * @param tpid Trusted path ID
  1081. */
  1082. inline void setTrusted(const uint64_t tpid)
  1083. {
  1084. setCipher(ZT_PROTO_CIPHER_SUITE__NO_CRYPTO_TRUSTED_PATH);
  1085. setAt(ZT_PACKET_IDX_MAC,tpid);
  1086. }
  1087. /**
  1088. * Get this packet's unique ID (the IV field interpreted as uint64_t)
  1089. *
  1090. * Note that the least significant 3 bits of this ID will change when armor()
  1091. * is called to armor the packet for transport. This is because armor() will
  1092. * mask the last 3 bits against the send counter for QoS monitoring use prior
  1093. * to actually using the IV to encrypt and MAC the packet. Be aware of this
  1094. * when grabbing the packetId of a new packet prior to armor/send.
  1095. *
  1096. * @return Packet ID
  1097. */
  1098. inline uint64_t packetId() const { return at<uint64_t>(ZT_PACKET_IDX_IV); }
  1099. /**
  1100. * Set packet verb
  1101. *
  1102. * This also has the side-effect of clearing any verb flags, such as
  1103. * compressed, and so must only be done during packet composition.
  1104. *
  1105. * @param v New packet verb
  1106. */
  1107. inline void setVerb(Verb v) { (*this)[ZT_PACKET_IDX_VERB] = (char)v; }
  1108. /**
  1109. * @return Packet verb (not including flag bits)
  1110. */
  1111. inline Verb verb() const { return (Verb)((*this)[ZT_PACKET_IDX_VERB] & 0x1f); }
  1112. /**
  1113. * @return Length of packet payload
  1114. */
  1115. inline unsigned int payloadLength() const { return ((size() < ZT_PROTO_MIN_PACKET_LENGTH) ? 0 : (size() - ZT_PROTO_MIN_PACKET_LENGTH)); }
  1116. /**
  1117. * @return Raw packet payload
  1118. */
  1119. inline const unsigned char *payload() const { return field(ZT_PACKET_IDX_PAYLOAD,size() - ZT_PACKET_IDX_PAYLOAD); }
  1120. /**
  1121. * Armor packet for transport
  1122. *
  1123. * @param key 32-byte key
  1124. * @param encryptPayload If true, encrypt packet payload, else just MAC
  1125. */
  1126. void armor(const void *key,bool encryptPayload);
  1127. /**
  1128. * Verify and (if encrypted) decrypt packet
  1129. *
  1130. * This does not handle trusted path mode packets and will return false
  1131. * for these. These are handled in IncomingPacket if the sending physical
  1132. * address and MAC field match a trusted path.
  1133. *
  1134. * @param key 32-byte key
  1135. * @return False if packet is invalid or failed MAC authenticity check
  1136. */
  1137. bool dearmor(const void *key);
  1138. /**
  1139. * Attempt to compress payload if not already (must be unencrypted)
  1140. *
  1141. * This requires that the payload at least contain the verb byte already
  1142. * set. The compressed flag in the verb is set if compression successfully
  1143. * results in a size reduction. If no size reduction occurs, compression
  1144. * is not done and the flag is left cleared.
  1145. *
  1146. * @return True if compression occurred
  1147. */
  1148. bool compress();
  1149. /**
  1150. * Attempt to decompress payload if it is compressed (must be unencrypted)
  1151. *
  1152. * If payload is compressed, it is decompressed and the compressed verb
  1153. * flag is cleared. Otherwise nothing is done and true is returned.
  1154. *
  1155. * @return True if data is now decompressed and valid, false on error
  1156. */
  1157. bool uncompress();
  1158. private:
  1159. static const unsigned char ZERO_KEY[32];
  1160. /**
  1161. * Deterministically mangle a 256-bit crypto key based on packet
  1162. *
  1163. * This uses extra data from the packet to mangle the secret, giving us an
  1164. * effective IV that is somewhat more than 64 bits. This is "free" for
  1165. * Salsa20 since it has negligible key setup time so using a different
  1166. * key each time is fine.
  1167. *
  1168. * @param in Input key (32 bytes)
  1169. * @param out Output buffer (32 bytes)
  1170. */
  1171. inline void _salsa20MangleKey(const unsigned char *in,unsigned char *out) const
  1172. {
  1173. const unsigned char *d = (const unsigned char *)data();
  1174. // IV and source/destination addresses. Using the addresses divides the
  1175. // key space into two halves-- A->B and B->A (since order will change).
  1176. for(unsigned int i=0;i<18;++i) // 8 + (ZT_ADDRESS_LENGTH * 2) == 18
  1177. out[i] = in[i] ^ d[i];
  1178. // Flags, but with hop count masked off. Hop count is altered by forwarding
  1179. // nodes. It's one of the only parts of a packet modifiable by people
  1180. // without the key.
  1181. out[18] = in[18] ^ (d[ZT_PACKET_IDX_FLAGS] & 0xf8);
  1182. // Raw packet size in bytes -- thus each packet size defines a new
  1183. // key space.
  1184. out[19] = in[19] ^ (unsigned char)(size() & 0xff);
  1185. out[20] = in[20] ^ (unsigned char)((size() >> 8) & 0xff); // little endian
  1186. // Rest of raw key is used unchanged
  1187. for(unsigned int i=21;i<32;++i)
  1188. out[i] = in[i];
  1189. }
  1190. };
  1191. } // namespace ZeroTier
  1192. #endif