Packet.hpp 48 KB

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