NetworkConfig.hpp 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706
  1. /*
  2. * Copyright (c)2019 ZeroTier, Inc.
  3. *
  4. * Use of this software is governed by the Business Source License included
  5. * in the LICENSE.TXT file in the project's root directory.
  6. *
  7. * Change Date: 2025-01-01
  8. *
  9. * On the date above, in accordance with the Business Source License, use
  10. * of this software will be governed by version 2.0 of the Apache License.
  11. */
  12. /****/
  13. #ifndef ZT_NETWORKCONFIG_HPP
  14. #define ZT_NETWORKCONFIG_HPP
  15. #include <stdint.h>
  16. #include <string.h>
  17. #include <stdlib.h>
  18. #include <vector>
  19. #include <stdexcept>
  20. #include <algorithm>
  21. #include "../include/ZeroTierOne.h"
  22. #include "Constants.hpp"
  23. #include "Buffer.hpp"
  24. #include "DNS.hpp"
  25. #include "InetAddress.hpp"
  26. #include "MulticastGroup.hpp"
  27. #include "Address.hpp"
  28. #include "CertificateOfMembership.hpp"
  29. #include "CertificateOfOwnership.hpp"
  30. #include "Capability.hpp"
  31. #include "Tag.hpp"
  32. #include "Dictionary.hpp"
  33. #include "Hashtable.hpp"
  34. #include "Identity.hpp"
  35. #include "Utils.hpp"
  36. #include "Trace.hpp"
  37. /**
  38. * Default time delta for COMs, tags, and capabilities
  39. */
  40. #define ZT_NETWORKCONFIG_DEFAULT_CREDENTIAL_TIME_DFL_MAX_DELTA ((int64_t)(1000 * 60 * 30))
  41. /**
  42. * Maximum time delta for COMs, tags, and capabilities
  43. */
  44. #define ZT_NETWORKCONFIG_DEFAULT_CREDENTIAL_TIME_MAX_MAX_DELTA ((int64_t)(1000 * 60 * 60 * 2))
  45. /**
  46. * Minimum credential TTL and maxDelta for COM timestamps
  47. */
  48. #define ZT_NETWORKCONFIG_DEFAULT_CREDENTIAL_TIME_MIN_MAX_DELTA ((int64_t)(1000 * 60 * 5))
  49. /**
  50. * Flag: enable broadcast
  51. */
  52. #define ZT_NETWORKCONFIG_FLAG_ENABLE_BROADCAST 0x0000000000000002ULL
  53. /**
  54. * Flag: enable IPv6 NDP emulation for certain V6 address patterns
  55. */
  56. #define ZT_NETWORKCONFIG_FLAG_ENABLE_IPV6_NDP_EMULATION 0x0000000000000004ULL
  57. /**
  58. * Flag: result of unrecognized MATCH entries in a rules table: match if set, no-match if clear
  59. */
  60. #define ZT_NETWORKCONFIG_FLAG_RULES_RESULT_OF_UNSUPPORTED_MATCH 0x0000000000000008ULL
  61. /**
  62. * Flag: disable frame compression
  63. */
  64. #define ZT_NETWORKCONFIG_FLAG_DISABLE_COMPRESSION 0x0000000000000010ULL
  65. /**
  66. * Device can bridge to other Ethernet networks and gets unknown recipient multicasts
  67. */
  68. #define ZT_NETWORKCONFIG_SPECIALIST_TYPE_ACTIVE_BRIDGE 0x0000020000000000ULL
  69. /**
  70. * Anchors are stable devices on this network that can act like roots when none are up
  71. */
  72. #define ZT_NETWORKCONFIG_SPECIALIST_TYPE_ANCHOR 0x0000040000000000ULL
  73. /**
  74. * Designated multicast replicators replicate multicast in place of sender-side replication
  75. */
  76. #define ZT_NETWORKCONFIG_SPECIALIST_TYPE_MULTICAST_REPLICATOR 0x0000080000000000ULL
  77. namespace ZeroTier {
  78. // Dictionary capacity needed for max size network config
  79. #define ZT_NETWORKCONFIG_DICT_CAPACITY (4096 + (sizeof(ZT_VirtualNetworkConfig)) + (sizeof(ZT_VirtualNetworkRule) * ZT_MAX_NETWORK_RULES) + (sizeof(Capability) * ZT_MAX_NETWORK_CAPABILITIES) + (sizeof(Tag) * ZT_MAX_NETWORK_TAGS) + (sizeof(CertificateOfOwnership) * ZT_MAX_CERTIFICATES_OF_OWNERSHIP))
  80. // Dictionary capacity needed for max size network meta-data
  81. #define ZT_NETWORKCONFIG_METADATA_DICT_CAPACITY 1024
  82. // Network config version
  83. #define ZT_NETWORKCONFIG_VERSION 7
  84. // Fields for meta-data sent with network config requests
  85. // Network config version
  86. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_VERSION "v"
  87. // Protocol version (see Packet.hpp)
  88. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_PROTOCOL_VERSION "pv"
  89. // Software vendor
  90. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_NODE_VENDOR "vend"
  91. // Software major version
  92. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_NODE_MAJOR_VERSION "majv"
  93. // Software minor version
  94. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_NODE_MINOR_VERSION "minv"
  95. // Software revision
  96. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_NODE_REVISION "revv"
  97. // Rules engine revision
  98. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_RULES_ENGINE_REV "revr"
  99. // Maximum number of rules per network this node can accept
  100. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_MAX_NETWORK_RULES "mr"
  101. // Maximum number of capabilities this node can accept
  102. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_MAX_NETWORK_CAPABILITIES "mc"
  103. // Maximum number of rules per capability this node can accept
  104. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_MAX_CAPABILITY_RULES "mcr"
  105. // Maximum number of tags this node can accept
  106. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_MAX_NETWORK_TAGS "mt"
  107. // Network join authorization token (if any)
  108. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_AUTH "a"
  109. // Network configuration meta-data flags
  110. #define ZT_NETWORKCONFIG_REQUEST_METADATA_KEY_FLAGS "f"
  111. // These dictionary keys are short so they don't take up much room.
  112. // By convention we use upper case for binary blobs, but it doesn't really matter.
  113. // network config version
  114. #define ZT_NETWORKCONFIG_DICT_KEY_VERSION "v"
  115. // network ID
  116. #define ZT_NETWORKCONFIG_DICT_KEY_NETWORK_ID "nwid"
  117. // integer(hex)
  118. #define ZT_NETWORKCONFIG_DICT_KEY_TIMESTAMP "ts"
  119. // integer(hex)
  120. #define ZT_NETWORKCONFIG_DICT_KEY_REVISION "r"
  121. // address of member
  122. #define ZT_NETWORKCONFIG_DICT_KEY_ISSUED_TO "id"
  123. // remote trace target
  124. #define ZT_NETWORKCONFIG_DICT_KEY_REMOTE_TRACE_TARGET "tt"
  125. // remote trace level
  126. #define ZT_NETWORKCONFIG_DICT_KEY_REMOTE_TRACE_LEVEL "tl"
  127. // flags(hex)
  128. #define ZT_NETWORKCONFIG_DICT_KEY_FLAGS "f"
  129. // integer(hex)
  130. #define ZT_NETWORKCONFIG_DICT_KEY_MULTICAST_LIMIT "ml"
  131. // network type (hex)
  132. #define ZT_NETWORKCONFIG_DICT_KEY_TYPE "t"
  133. // text
  134. #define ZT_NETWORKCONFIG_DICT_KEY_NAME "n"
  135. // network MTU
  136. #define ZT_NETWORKCONFIG_DICT_KEY_MTU "mtu"
  137. // credential time max delta in ms
  138. #define ZT_NETWORKCONFIG_DICT_KEY_CREDENTIAL_TIME_MAX_DELTA "ctmd"
  139. // binary serialized certificate of membership
  140. #define ZT_NETWORKCONFIG_DICT_KEY_COM "C"
  141. // specialists (binary array of uint64_t)
  142. #define ZT_NETWORKCONFIG_DICT_KEY_SPECIALISTS "S"
  143. // routes (binary blob)
  144. #define ZT_NETWORKCONFIG_DICT_KEY_ROUTES "RT"
  145. // static IPs (binary blob)
  146. #define ZT_NETWORKCONFIG_DICT_KEY_STATIC_IPS "I"
  147. // rules (binary blob)
  148. #define ZT_NETWORKCONFIG_DICT_KEY_RULES "R"
  149. // capabilities (binary blobs)
  150. #define ZT_NETWORKCONFIG_DICT_KEY_CAPABILITIES "CAP"
  151. // tags (binary blobs)
  152. #define ZT_NETWORKCONFIG_DICT_KEY_TAGS "TAG"
  153. // tags (binary blobs)
  154. #define ZT_NETWORKCONFIG_DICT_KEY_CERTIFICATES_OF_OWNERSHIP "COO"
  155. // dns (binary blobs)
  156. #define ZT_NETWORKCONFIG_DICT_KEY_DNS "DNS"
  157. // sso enabld
  158. #define ZT_NETWORKCONFIG_DICT_KEY_SSO_ENABLED "ssoe"
  159. // so version
  160. #define ZT_NETWORKCONFIG_DICT_KEY_SSO_VERSION "ssov"
  161. // authentication URL
  162. #define ZT_NETWORKCONFIG_DICT_KEY_AUTHENTICATION_URL "aurl"
  163. // authentication expiry
  164. #define ZT_NETWORKCONFIG_DICT_KEY_AUTHENTICATION_EXPIRY_TIME "aexpt"
  165. // oidc issuer URL
  166. #define ZT_NETWORKCONFIG_DICT_KEY_ISSUER_URL "iurl"
  167. // central endpoint
  168. #define ZT_NETWORKCONFIG_DICT_KEY_CENTRAL_ENDPOINT_URL "ssoce"
  169. // nonce
  170. #define ZT_NETWORKCONFIG_DICT_KEY_NONCE "sson"
  171. // state
  172. #define ZT_NETWORKCONFIG_DICT_KEY_STATE "ssos"
  173. // client ID
  174. #define ZT_NETWORKCONFIG_DICT_KEY_CLIENT_ID "ssocid"
  175. // AuthInfo fields -- used by ncSendError for sso
  176. // AuthInfo Version
  177. #define ZT_AUTHINFO_DICT_KEY_VERSION "aV"
  178. // authenticaiton URL
  179. #define ZT_AUTHINFO_DICT_KEY_AUTHENTICATION_URL "aU"
  180. // issuer URL
  181. #define ZT_AUTHINFO_DICT_KEY_ISSUER_URL "iU"
  182. // Central endpoint URL
  183. #define ZT_AUTHINFO_DICT_KEY_CENTRAL_ENDPOINT_URL "aCU"
  184. // Nonce
  185. #define ZT_AUTHINFO_DICT_KEY_NONCE "aN"
  186. // State
  187. #define ZT_AUTHINFO_DICT_KEY_STATE "aS"
  188. // Client ID
  189. #define ZT_AUTHINFO_DICT_KEY_CLIENT_ID "aCID"
  190. // Legacy fields -- these are obsoleted but are included when older clients query
  191. // boolean (now a flag)
  192. #define ZT_NETWORKCONFIG_DICT_KEY_ENABLE_BROADCAST_OLD "eb"
  193. // IP/bits[,IP/bits,...]
  194. // Note that IPs that end in all zeroes are routes with no assignment in them.
  195. #define ZT_NETWORKCONFIG_DICT_KEY_IPV4_STATIC_OLD "v4s"
  196. // IP/bits[,IP/bits,...]
  197. // Note that IPs that end in all zeroes are routes with no assignment in them.
  198. #define ZT_NETWORKCONFIG_DICT_KEY_IPV6_STATIC_OLD "v6s"
  199. // 0/1
  200. #define ZT_NETWORKCONFIG_DICT_KEY_PRIVATE_OLD "p"
  201. // integer(hex)[,integer(hex),...]
  202. #define ZT_NETWORKCONFIG_DICT_KEY_ALLOWED_ETHERNET_TYPES_OLD "et"
  203. // string-serialized CertificateOfMembership
  204. #define ZT_NETWORKCONFIG_DICT_KEY_CERTIFICATE_OF_MEMBERSHIP_OLD "com"
  205. // node[,node,...]
  206. #define ZT_NETWORKCONFIG_DICT_KEY_ACTIVE_BRIDGES_OLD "ab"
  207. // node;IP/port[,node;IP/port]
  208. #define ZT_NETWORKCONFIG_DICT_KEY_RELAYS_OLD "rl"
  209. // End legacy fields
  210. /**
  211. * Network configuration received from network controller nodes
  212. *
  213. * This is a memcpy()'able structure and is safe (in a crash sense) to modify
  214. * without locks.
  215. */
  216. class NetworkConfig
  217. {
  218. public:
  219. NetworkConfig() :
  220. networkId(0),
  221. timestamp(0),
  222. credentialTimeMaxDelta(0),
  223. revision(0),
  224. issuedTo(),
  225. remoteTraceTarget(),
  226. flags(0),
  227. remoteTraceLevel(Trace::LEVEL_NORMAL),
  228. mtu(0),
  229. multicastLimit(0),
  230. specialistCount(0),
  231. routeCount(0),
  232. staticIpCount(0),
  233. ruleCount(0),
  234. capabilityCount(0),
  235. tagCount(0),
  236. certificateOfOwnershipCount(0),
  237. capabilities(),
  238. tags(),
  239. certificatesOfOwnership(),
  240. type(ZT_NETWORK_TYPE_PRIVATE),
  241. dnsCount(0),
  242. ssoEnabled(false),
  243. authenticationURL(),
  244. authenticationExpiryTime(0),
  245. issuerURL(),
  246. centralAuthURL(),
  247. ssoNonce(),
  248. ssoState(),
  249. ssoClientID()
  250. {
  251. name[0] = 0;
  252. memset(specialists, 0, sizeof(uint64_t)*ZT_MAX_NETWORK_SPECIALISTS);
  253. memset(routes, 0, sizeof(ZT_VirtualNetworkRoute)*ZT_MAX_NETWORK_ROUTES);
  254. memset(staticIps, 0, sizeof(InetAddress)*ZT_MAX_ZT_ASSIGNED_ADDRESSES);
  255. memset(rules, 0, sizeof(ZT_VirtualNetworkRule)*ZT_MAX_NETWORK_RULES);
  256. memset(&dns, 0, sizeof(ZT_VirtualNetworkDNS));
  257. memset(authenticationURL, 0, sizeof(authenticationURL));
  258. memset(issuerURL, 0, sizeof(issuerURL));
  259. memset(centralAuthURL, 0, sizeof(centralAuthURL));
  260. memset(ssoNonce, 0, sizeof(ssoNonce));
  261. memset(ssoState, 0, sizeof(ssoState));
  262. memset(ssoClientID, 0, sizeof(ssoClientID));
  263. }
  264. /**
  265. * Write this network config to a dictionary for transport
  266. *
  267. * @param d Dictionary
  268. * @param includeLegacy If true, include legacy fields for old node versions
  269. * @return True if dictionary was successfully created, false if e.g. overflow
  270. */
  271. bool toDictionary(Dictionary<ZT_NETWORKCONFIG_DICT_CAPACITY> &d,bool includeLegacy) const;
  272. /**
  273. * Read this network config from a dictionary
  274. *
  275. * @param d Dictionary (non-const since it might be modified during parse, should not be used after call)
  276. * @return True if dictionary was valid and network config successfully initialized
  277. */
  278. bool fromDictionary(const Dictionary<ZT_NETWORKCONFIG_DICT_CAPACITY> &d);
  279. /**
  280. * @return True if broadcast (ff:ff:ff:ff:ff:ff) address should work on this network
  281. */
  282. inline bool enableBroadcast() const { return ((this->flags & ZT_NETWORKCONFIG_FLAG_ENABLE_BROADCAST) != 0); }
  283. /**
  284. * @return True if IPv6 NDP emulation should be allowed for certain "magic" IPv6 address patterns
  285. */
  286. inline bool ndpEmulation() const { return ((this->flags & ZT_NETWORKCONFIG_FLAG_ENABLE_IPV6_NDP_EMULATION) != 0); }
  287. /**
  288. * @return True if frames should not be compressed
  289. */
  290. inline bool disableCompression() const
  291. {
  292. #ifndef ZT_DISABLE_COMPRESSION
  293. return ((this->flags & ZT_NETWORKCONFIG_FLAG_DISABLE_COMPRESSION) != 0);
  294. #else
  295. /* Compression is disabled for libzt builds since it causes non-obvious chaotic
  296. interference with lwIP's TCP congestion algorithm. Compression is also disabled
  297. for some NAS builds due to the usage of low-performance processors in certain
  298. older and budget models. */
  299. return false;
  300. #endif
  301. }
  302. /**
  303. * @return Network type is public (no access control)
  304. */
  305. inline bool isPublic() const { return (this->type == ZT_NETWORK_TYPE_PUBLIC); }
  306. /**
  307. * @return Network type is private (certificate access control)
  308. */
  309. inline bool isPrivate() const { return (this->type == ZT_NETWORK_TYPE_PRIVATE); }
  310. /**
  311. * @return ZeroTier addresses of devices on this network designated as active bridges
  312. */
  313. inline std::vector<Address> activeBridges() const
  314. {
  315. std::vector<Address> r;
  316. for(unsigned int i=0;i<specialistCount;++i) {
  317. if ((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_ACTIVE_BRIDGE) != 0)
  318. r.push_back(Address(specialists[i]));
  319. }
  320. return r;
  321. }
  322. inline unsigned int activeBridges(Address ab[ZT_MAX_NETWORK_SPECIALISTS]) const
  323. {
  324. unsigned int c = 0;
  325. for(unsigned int i=0;i<specialistCount;++i) {
  326. if ((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_ACTIVE_BRIDGE) != 0)
  327. ab[c++] = specialists[i];
  328. }
  329. return c;
  330. }
  331. inline bool isActiveBridge(const Address &a) const
  332. {
  333. for(unsigned int i=0;i<specialistCount;++i) {
  334. if (((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_ACTIVE_BRIDGE) != 0)&&(a == specialists[i]))
  335. return true;
  336. }
  337. return false;
  338. }
  339. inline std::vector<Address> anchors() const
  340. {
  341. std::vector<Address> r;
  342. for(unsigned int i=0;i<specialistCount;++i) {
  343. if ((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_ANCHOR) != 0)
  344. r.push_back(Address(specialists[i]));
  345. }
  346. return r;
  347. }
  348. inline std::vector<Address> multicastReplicators() const
  349. {
  350. std::vector<Address> r;
  351. for(unsigned int i=0;i<specialistCount;++i) {
  352. if ((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_MULTICAST_REPLICATOR) != 0)
  353. r.push_back(Address(specialists[i]));
  354. }
  355. return r;
  356. }
  357. inline unsigned int multicastReplicators(Address mr[ZT_MAX_NETWORK_SPECIALISTS]) const
  358. {
  359. unsigned int c = 0;
  360. for(unsigned int i=0;i<specialistCount;++i) {
  361. if ((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_MULTICAST_REPLICATOR) != 0)
  362. mr[c++] = specialists[i];
  363. }
  364. return c;
  365. }
  366. inline bool isMulticastReplicator(const Address &a) const
  367. {
  368. for(unsigned int i=0;i<specialistCount;++i) {
  369. if (((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_MULTICAST_REPLICATOR) != 0)&&(a == specialists[i]))
  370. return true;
  371. }
  372. return false;
  373. }
  374. inline std::vector<Address> alwaysContactAddresses() const
  375. {
  376. std::vector<Address> r;
  377. for(unsigned int i=0;i<specialistCount;++i) {
  378. if ((specialists[i] & (ZT_NETWORKCONFIG_SPECIALIST_TYPE_ANCHOR | ZT_NETWORKCONFIG_SPECIALIST_TYPE_MULTICAST_REPLICATOR)) != 0)
  379. r.push_back(Address(specialists[i]));
  380. }
  381. return r;
  382. }
  383. inline unsigned int alwaysContactAddresses(Address ac[ZT_MAX_NETWORK_SPECIALISTS]) const
  384. {
  385. unsigned int c = 0;
  386. for(unsigned int i=0;i<specialistCount;++i) {
  387. if ((specialists[i] & (ZT_NETWORKCONFIG_SPECIALIST_TYPE_ANCHOR | ZT_NETWORKCONFIG_SPECIALIST_TYPE_MULTICAST_REPLICATOR)) != 0)
  388. ac[c++] = specialists[i];
  389. }
  390. return c;
  391. }
  392. inline void alwaysContactAddresses(Hashtable< Address,std::vector<InetAddress> > &a) const
  393. {
  394. for(unsigned int i=0;i<specialistCount;++i) {
  395. if ((specialists[i] & (ZT_NETWORKCONFIG_SPECIALIST_TYPE_ANCHOR | ZT_NETWORKCONFIG_SPECIALIST_TYPE_MULTICAST_REPLICATOR)) != 0) {
  396. a[Address(specialists[i])];
  397. }
  398. }
  399. }
  400. /**
  401. * @param fromPeer Peer attempting to bridge other Ethernet peers onto network
  402. * @return True if this network allows bridging
  403. */
  404. inline bool permitsBridging(const Address &fromPeer) const
  405. {
  406. for(unsigned int i=0;i<specialistCount;++i) {
  407. if ((fromPeer == specialists[i])&&((specialists[i] & ZT_NETWORKCONFIG_SPECIALIST_TYPE_ACTIVE_BRIDGE) != 0))
  408. return true;
  409. }
  410. return false;
  411. }
  412. inline operator bool() const { return (networkId != 0); }
  413. inline bool operator==(const NetworkConfig &nc) const { return (memcmp(this,&nc,sizeof(NetworkConfig)) == 0); }
  414. inline bool operator!=(const NetworkConfig &nc) const { return (!(*this == nc)); }
  415. /**
  416. * Add a specialist or mask flags if already present
  417. *
  418. * This masks the existing flags if the specialist is already here or adds
  419. * it otherwise.
  420. *
  421. * @param a Address of specialist
  422. * @param f Flags (OR of specialist role/type flags)
  423. * @return True if successfully masked or added
  424. */
  425. inline bool addSpecialist(const Address &a,const uint64_t f)
  426. {
  427. const uint64_t aint = a.toInt();
  428. for(unsigned int i=0;i<specialistCount;++i) {
  429. if ((specialists[i] & 0xffffffffffULL) == aint) {
  430. specialists[i] |= f;
  431. return true;
  432. }
  433. }
  434. if (specialistCount < ZT_MAX_NETWORK_SPECIALISTS) {
  435. specialists[specialistCount++] = f | aint;
  436. return true;
  437. }
  438. return false;
  439. }
  440. const Capability *capability(const uint32_t id) const
  441. {
  442. for(unsigned int i=0;i<capabilityCount;++i) {
  443. if (capabilities[i].id() == id)
  444. return &(capabilities[i]);
  445. }
  446. return (Capability *)0;
  447. }
  448. const Tag *tag(const uint32_t id) const
  449. {
  450. for(unsigned int i=0;i<tagCount;++i) {
  451. if (tags[i].id() == id)
  452. return &(tags[i]);
  453. }
  454. return (Tag *)0;
  455. }
  456. /**
  457. * Network ID that this configuration applies to
  458. */
  459. uint64_t networkId;
  460. /**
  461. * Controller-side time of config generation/issue
  462. */
  463. int64_t timestamp;
  464. /**
  465. * Max difference between timestamp and tag/capability timestamp
  466. */
  467. int64_t credentialTimeMaxDelta;
  468. /**
  469. * Controller-side revision counter for this configuration
  470. */
  471. uint64_t revision;
  472. /**
  473. * Address of device to which this config is issued
  474. */
  475. Address issuedTo;
  476. /**
  477. * If non-NULL, remote traces related to this network are sent here
  478. */
  479. Address remoteTraceTarget;
  480. /**
  481. * Flags (64-bit)
  482. */
  483. uint64_t flags;
  484. /**
  485. * Remote trace level
  486. */
  487. Trace::Level remoteTraceLevel;
  488. /**
  489. * Network MTU
  490. */
  491. unsigned int mtu;
  492. /**
  493. * Maximum number of recipients per multicast (not including active bridges)
  494. */
  495. unsigned int multicastLimit;
  496. /**
  497. * Number of specialists
  498. */
  499. unsigned int specialistCount;
  500. /**
  501. * Number of routes
  502. */
  503. unsigned int routeCount;
  504. /**
  505. * Number of ZT-managed static IP assignments
  506. */
  507. unsigned int staticIpCount;
  508. /**
  509. * Number of rule table entries
  510. */
  511. unsigned int ruleCount;
  512. /**
  513. * Number of capabilities
  514. */
  515. unsigned int capabilityCount;
  516. /**
  517. * Number of tags
  518. */
  519. unsigned int tagCount;
  520. /**
  521. * Number of certificates of ownership
  522. */
  523. unsigned int certificateOfOwnershipCount;
  524. /**
  525. * Specialist devices
  526. *
  527. * For each entry the least significant 40 bits are the device's ZeroTier
  528. * address and the most significant 24 bits are flags indicating its role.
  529. */
  530. uint64_t specialists[ZT_MAX_NETWORK_SPECIALISTS];
  531. /**
  532. * Statically defined "pushed" routes (including default gateways)
  533. */
  534. ZT_VirtualNetworkRoute routes[ZT_MAX_NETWORK_ROUTES];
  535. /**
  536. * Static IP assignments
  537. */
  538. InetAddress staticIps[ZT_MAX_ZT_ASSIGNED_ADDRESSES];
  539. /**
  540. * Base network rules
  541. */
  542. ZT_VirtualNetworkRule rules[ZT_MAX_NETWORK_RULES];
  543. /**
  544. * Capabilities for this node on this network, in ascending order of capability ID
  545. */
  546. Capability capabilities[ZT_MAX_NETWORK_CAPABILITIES];
  547. /**
  548. * Tags for this node on this network, in ascending order of tag ID
  549. */
  550. Tag tags[ZT_MAX_NETWORK_TAGS];
  551. /**
  552. * Certificates of ownership for this network member
  553. */
  554. CertificateOfOwnership certificatesOfOwnership[ZT_MAX_CERTIFICATES_OF_OWNERSHIP];
  555. /**
  556. * Network type (currently just public or private)
  557. */
  558. ZT_VirtualNetworkType type;
  559. /**
  560. * Network short name or empty string if not defined
  561. */
  562. char name[ZT_MAX_NETWORK_SHORT_NAME_LENGTH + 1];
  563. /**
  564. * Certificate of membership (for private networks)
  565. */
  566. CertificateOfMembership com;
  567. /**
  568. * Number of ZT-pushed DNS configurations
  569. */
  570. unsigned int dnsCount;
  571. /**
  572. * ZT pushed DNS configuration
  573. */
  574. ZT_VirtualNetworkDNS dns;
  575. /**
  576. * SSO enabled flag.
  577. */
  578. bool ssoEnabled;
  579. /**
  580. * SSO verison
  581. */
  582. uint64_t ssoVersion;
  583. /**
  584. * Authentication URL if authentication is required
  585. */
  586. char authenticationURL[2048];
  587. /**
  588. * Time current authentication expires or 0 if external authentication is disabled
  589. *
  590. * Not used if authVersion >= 1
  591. */
  592. uint64_t authenticationExpiryTime;
  593. /**
  594. * OIDC issuer URL
  595. */
  596. char issuerURL[2048];
  597. /**
  598. * central base URL.
  599. */
  600. char centralAuthURL[2048];
  601. /**
  602. * sso nonce
  603. */
  604. char ssoNonce[128];
  605. /**
  606. * sso state
  607. */
  608. char ssoState[256];
  609. /**
  610. * oidc client id
  611. */
  612. char ssoClientID[256];
  613. };
  614. } // namespace ZeroTier
  615. #endif