Packet.hpp 53 KB

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