NetworkConfig.hpp 19 KB

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