/* * Copyright (c)2013-2020 ZeroTier, Inc. * * Use of this software is governed by the Business Source License included * in the LICENSE.TXT file in the project's root directory. * * Change Date: 2024-01-01 * * On the date above, in accordance with the Business Source License, use * of this software will be governed by version 2.0 of the Apache License. */ /****/ #include "Certificate.hpp" #include "SHA512.hpp" #include "ECC384.hpp" namespace ZeroTier { Certificate::Certificate() noexcept { ZT_Certificate *const sup = this; Utils::zero< sizeof(ZT_Certificate) >(sup); } Certificate::Certificate(const ZT_Certificate &apiCert) { ZT_Certificate *const sup = this; Utils::copy< sizeof(ZT_Certificate) >(sup, &apiCert); } Certificate::Certificate(const Certificate &cert) { *this = cert; } Certificate::~Certificate() {} Certificate &Certificate::operator=(const ZT_Certificate &cert) { m_clear(); ZT_Certificate *const sup = this; Utils::copy< sizeof(ZT_Certificate) >(sup, &cert); // Zero these since we must explicitly attach all the objects from // the other certificate to copy them into our containers. this->subject.identities = nullptr; this->subject.identityCount = 0; this->subject.networks = nullptr; this->subject.networkCount = 0; this->subject.certificates = nullptr; this->subject.certificateCount = 0; this->subject.updateUrls = nullptr; this->subject.updateUrlCount = 0; this->subject.uniqueId = nullptr; this->subject.uniqueIdProofSignature = nullptr; this->subject.uniqueIdSize = 0; this->subject.uniqueIdProofSignatureSize = 0; this->extendedAttributes = nullptr; this->extendedAttributesSize = 0; this->issuer = nullptr; this->signature = nullptr; this->signatureSize = 0; for (unsigned int i = 0; i < cert.subject.identityCount; ++i) { if (cert.subject.identities[i].identity) { if (cert.subject.identities[i].locator) addSubjectIdentity(*reinterpret_cast(cert.subject.identities[i].identity), *reinterpret_cast(cert.subject.identities[i].locator)); else addSubjectIdentity(*reinterpret_cast(cert.subject.identities[i].identity)); } } for (unsigned int i = 0; i < cert.subject.networkCount; ++i) { if (cert.subject.networks[i].id) addSubjectNetwork(cert.subject.networks[i].id, cert.subject.networks[i].controller); } for (unsigned int i = 0; i < cert.subject.certificateCount; ++i) { if (cert.subject.certificates[i]) addSubjectCertificate(cert.subject.certificates[i]); } if (cert.subject.updateUrls) { for (unsigned int i = 0; i < cert.subject.updateUrlCount; ++i) { if (cert.subject.updateUrls[i]) addSubjectUpdateUrl(cert.subject.updateUrls[i]); } } if ((cert.subject.uniqueId) && (cert.subject.uniqueIdSize > 0)) { m_subjectUniqueId.assign(cert.subject.uniqueId, cert.subject.uniqueId + cert.subject.uniqueIdSize); this->subject.uniqueId = m_subjectUniqueId.data(); this->subject.uniqueIdSize = (unsigned int)m_subjectUniqueId.size(); } if ((cert.subject.uniqueIdProofSignature) && (cert.subject.uniqueIdProofSignatureSize > 0)) { m_subjectUniqueIdProofSignature.assign(cert.subject.uniqueIdProofSignature, cert.subject.uniqueIdProofSignature + cert.subject.uniqueIdProofSignatureSize); this->subject.uniqueIdProofSignature = m_subjectUniqueIdProofSignature.data(); this->subject.uniqueIdProofSignatureSize = (unsigned int)m_subjectUniqueIdProofSignature.size(); } if (cert.issuer) { m_identities.push_back(*reinterpret_cast(cert.issuer)); this->issuer = &(m_identities.back()); } if ((cert.extendedAttributes) && (cert.extendedAttributesSize > 0)) { m_extendedAttributes.assign(cert.extendedAttributes, cert.extendedAttributes + cert.extendedAttributesSize); this->extendedAttributes = m_extendedAttributes.data(); this->extendedAttributesSize = (unsigned int)m_extendedAttributes.size(); } if ((cert.signature) && (cert.signatureSize > 0)) { m_signature.assign(cert.signature, cert.signature + cert.signatureSize); this->signature = m_signature.data(); this->signatureSize = (unsigned int)m_signature.size(); } return *this; } ZT_Certificate_Identity *Certificate::addSubjectIdentity(const Identity &id) { // Enlarge array of ZT_Certificate_Identity structs and set pointer to potentially reallocated array. m_subjectIdentities.resize(++this->subject.identityCount); this->subject.identities = m_subjectIdentities.data(); // Store a local copy of the actual identity. m_identities.push_back(id); // Set ZT_Certificate_Identity struct fields to point to local copy of identity. m_subjectIdentities.back().identity = &(m_identities.back()); m_subjectIdentities.back().locator = nullptr; return &(m_subjectIdentities.back()); } ZT_Certificate_Identity *Certificate::addSubjectIdentity(const Identity &id, const Locator &loc) { // Add identity as above. ZT_Certificate_Identity *const n = addSubjectIdentity(id); // Store local copy of locator. m_locators.push_back(loc); // Set pointer to stored local copy of locator. n->locator = &(m_locators.back()); return n; } ZT_Certificate_Network *Certificate::addSubjectNetwork(const uint64_t id, const ZT_Fingerprint &controller) { // Enlarge array of ZT_Certificate_Network and set pointer to potentially reallocated array. m_subjectNetworks.resize(++this->subject.networkCount); this->subject.networks = m_subjectNetworks.data(); // Set fields in new ZT_Certificate_Network structure. m_subjectNetworks.back().id = id; Utils::copy< sizeof(ZT_Fingerprint) >(&(m_subjectNetworks.back().controller), &controller); return &(m_subjectNetworks.back()); } void Certificate::addSubjectCertificate(const uint8_t serialNo[ZT_SHA384_DIGEST_SIZE]) { // Store local copy of serial in m_serials container. m_serials.push_back(SHA384Hash(serialNo)); // Enlarge array of uint8_t pointers, set new pointer to local copy of serial, and set // certificates to point to potentially reallocated array. m_subjectCertificates.resize(++this->subject.certificateCount); m_subjectCertificates.back() = m_serials.back().bytes(); this->subject.certificates = m_subjectCertificates.data(); } void Certificate::addSubjectUpdateUrl(const char *url) { // Store local copy of URL. m_strings.push_back(url); // Add pointer to local copy to pointer array and update C structure to point to // potentially reallocated array. m_updateUrls.push_back(m_strings.back().c_str()); this->subject.updateUrls = m_updateUrls.data(); this->subject.updateUrlCount = (unsigned int)m_updateUrls.size(); } void Certificate::setExtendedAttributes(const Dictionary &x) { m_extendedAttributes.clear(); x.encode(m_extendedAttributes); this->extendedAttributes = m_extendedAttributes.data(); this->extendedAttributesSize = (unsigned int)m_extendedAttributes.size(); } Vector< uint8_t > Certificate::encode(const bool omitSignature) const { Vector< uint8_t > enc; Dictionary d; // A Dictionary is used to encode certificates as it's a common and extensible // format. Custom packed formats are used for credentials as these are smaller // and faster to marshal/unmarshal. if (this->flags != 0) d.add("f", this->flags); d.add("t", (uint64_t)this->timestamp); d.add("v#0", (uint64_t)this->validity[0]); d.add("v#1", (uint64_t)this->validity[1]); if ((this->extendedAttributes) && (this->extendedAttributesSize > 0)) d["x"].assign(this->extendedAttributes, this->extendedAttributes + this->extendedAttributesSize); d.add("mP", (uint64_t)this->maxPathLength); m_encodeSubject(this->subject, d, false); if (this->issuer) d.addO("i", *reinterpret_cast(this->issuer)); if (this->issuerName.country[0]) d.add("iN.c", this->issuerName.country); if (this->issuerName.organization[0]) d.add("iN.o", this->issuerName.organization); if (this->issuerName.unit[0]) d.add("iN.u", this->issuerName.unit); if (this->issuerName.locality[0]) d.add("iN.l", this->issuerName.locality); if (this->issuerName.province[0]) d.add("iN.p", this->issuerName.province); if (this->issuerName.streetAddress[0]) d.add("iN.sA", this->issuerName.streetAddress); if (this->issuerName.postalCode[0]) d.add("iN.pC", this->issuerName.postalCode); if (this->issuerName.commonName[0]) d.add("iN.cN", this->issuerName.commonName); if (this->issuerName.serialNo[0]) d.add("iN.sN", this->issuerName.serialNo); if (this->issuerName.email[0]) d.add("iN.e", this->issuerName.email); if (this->issuerName.url[0]) d.add("iN.ur", this->issuerName.url); if (this->issuerName.host[0]) d.add("iN.h", this->issuerName.host); if ((this->extendedAttributes) && (this->extendedAttributesSize > 0)) d["x"].assign(this->extendedAttributes, this->extendedAttributes + this->extendedAttributesSize); if ((!omitSignature) && (this->signatureSize > 0) && (this->signature)) d["si"].assign(this->signature, this->signature + this->signatureSize); d.encode(enc); return enc; } bool Certificate::decode(const Vector< uint8_t > &data) { char tmp[256], tmp2[ZT_CERTIFICATE_MAX_STRING_LENGTH + 1]; m_clear(); Dictionary d; if (!d.decode(data.data(), (unsigned int)data.size())) return false; this->flags = d.getUI("f"); this->timestamp = (int64_t)d.getUI("t"); this->validity[0] = (int64_t)d.getUI("v#0"); this->validity[1] = (int64_t)d.getUI("v#1"); this->maxPathLength = (unsigned int)d.getUI("mP"); this->subject.timestamp = (int64_t)d.getUI("s.t"); unsigned int cnt = (unsigned int)d.getUI("s.i$"); for (unsigned int i = 0; i < cnt; ++i) { const Vector< uint8_t > &identityData = d[Dictionary::arraySubscript(tmp, "s.i$.i", i)]; if (identityData.empty()) return false; Identity id; if (id.unmarshal(identityData.data(), (unsigned int)identityData.size()) <= 0) return false; const Vector< uint8_t > &locatorData = d[Dictionary::arraySubscript(tmp, "s.i$.l", i)]; if (!locatorData.empty()) { Locator loc; if (loc.unmarshal(locatorData.data(), (unsigned int)locatorData.size()) <= 0) return false; this->addSubjectIdentity(id, loc); } else { this->addSubjectIdentity(id); } } cnt = (unsigned int)d.getUI("s.n$"); for (unsigned int i = 0; i < cnt; ++i) { const uint64_t nwid = d.getUI(Dictionary::arraySubscript(tmp, "s.n$.i", i)); const Vector< uint8_t > &fingerprintData = d[Dictionary::arraySubscript(tmp, "s.n$.c", i)]; if ((nwid == 0) || (fingerprintData.empty())) return false; Fingerprint fp; if (fp.unmarshal(fingerprintData.data(), (unsigned int)fingerprintData.size()) <= 0) return false; this->addSubjectNetwork(nwid, fp); } cnt = (unsigned int)d.getUI("s.c$"); for (unsigned int i = 0; i < cnt; ++i) { const Vector< uint8_t > &serial = d[Dictionary::arraySubscript(tmp, "s.c$", i)]; if (serial.size() != ZT_SHA384_DIGEST_SIZE) return false; this->addSubjectCertificate(serial.data()); } cnt = (unsigned int)d.getUI("s.u$"); for (unsigned int i = 0; i < cnt; ++i) addSubjectUpdateUrl(d.getS(Dictionary::arraySubscript(tmp, "s.u$", i), tmp, sizeof(tmp))); d.getS("s.n.sN", this->subject.name.serialNo, sizeof(this->subject.name.serialNo)); d.getS("s.n.cN", this->subject.name.commonName, sizeof(this->subject.name.commonName)); d.getS("s.n.c", this->subject.name.country, sizeof(this->subject.name.country)); d.getS("s.n.o", this->subject.name.organization, sizeof(this->subject.name.organization)); d.getS("s.n.u", this->subject.name.unit, sizeof(this->subject.name.unit)); d.getS("s.n.l", this->subject.name.locality, sizeof(this->subject.name.locality)); d.getS("s.n.p", this->subject.name.province, sizeof(this->subject.name.province)); d.getS("s.n.sA", this->subject.name.streetAddress, sizeof(this->subject.name.streetAddress)); d.getS("s.n.pC", this->subject.name.postalCode, sizeof(this->subject.name.postalCode)); d.getS("s.n.e", this->subject.name.email, sizeof(this->subject.name.email)); d.getS("s.n.ur", this->subject.name.url, sizeof(this->subject.name.url)); d.getS("s.n.h", this->subject.name.host, sizeof(this->subject.name.host)); m_subjectUniqueId = d["s.uI"]; if (!m_subjectUniqueId.empty()) { this->subject.uniqueId = m_subjectUniqueId.data(); this->subject.uniqueIdSize = (unsigned int)m_subjectUniqueId.size(); } m_subjectUniqueIdProofSignature = d["s.uS"]; if (!m_subjectUniqueIdProofSignature.empty()) { this->subject.uniqueIdProofSignature = m_subjectUniqueIdProofSignature.data(); this->subject.uniqueIdProofSignatureSize = (unsigned int)m_subjectUniqueIdProofSignature.size(); } const Vector< uint8_t > &issuerData = d["i"]; if (!issuerData.empty()) { Identity id; if (id.unmarshal(issuerData.data(), (int)issuerData.size()) > 0) { m_identities.push_back(id); this->issuer = reinterpret_cast(&(m_identities.back())); } } d.getS("iN.sN", this->issuerName.serialNo, sizeof(this->issuerName.serialNo)); d.getS("iN.cN", this->issuerName.commonName, sizeof(this->issuerName.commonName)); d.getS("iN.c", this->issuerName.country, sizeof(this->issuerName.country)); d.getS("iN.o", this->issuerName.organization, sizeof(this->issuerName.organization)); d.getS("iN.u", this->issuerName.unit, sizeof(this->issuerName.unit)); d.getS("iN.l", this->issuerName.locality, sizeof(this->issuerName.locality)); d.getS("iN.p", this->issuerName.province, sizeof(this->issuerName.province)); d.getS("iN.sA", this->issuerName.streetAddress, sizeof(this->issuerName.streetAddress)); d.getS("iN.pC", this->issuerName.postalCode, sizeof(this->issuerName.postalCode)); d.getS("iN.e", this->issuerName.email, sizeof(this->issuerName.email)); d.getS("iN.ur", this->issuerName.url, sizeof(this->issuerName.url)); d.getS("iN.h", this->issuerName.host, sizeof(this->issuerName.host)); cnt = (unsigned int)d.getUI("u$"); for (unsigned int i = 0; i < cnt; ++i) { const char *const url = d.getS(Dictionary::arraySubscript(tmp, "u$", i), tmp2, sizeof(tmp2)); if (url) addSubjectUpdateUrl(tmp2); else return false; } m_extendedAttributes = d["x"]; if (!m_extendedAttributes.empty()) { this->extendedAttributes = m_extendedAttributes.data(); this->extendedAttributesSize = (unsigned int)m_extendedAttributes.size(); } m_signature = d["si"]; if (!m_signature.empty()) { this->signature = m_signature.data(); this->signatureSize = (unsigned int)m_signature.size(); } const Vector< uint8_t > enc(encode(true)); SHA384(this->serialNo, enc.data(), (unsigned int)enc.size()); return true; } bool Certificate::sign(const Identity &issuer) { Vector< uint8_t > enc(encode(true)); SHA384(this->serialNo, enc.data(), (unsigned int)enc.size()); uint8_t sig[ZT_SIGNATURE_BUFFER_SIZE]; const unsigned int sigSize = issuer.sign(enc.data(), (unsigned int)enc.size(), sig, sizeof(sig)); if (sigSize > 0) { m_signature.assign(sig, sig + sigSize); this->signature = m_signature.data(); this->signatureSize = sigSize; return true; } m_signature.clear(); this->signature = nullptr; this->signatureSize = 0; return false; } ZT_CertificateError Certificate::verify() const { try { if (this->issuer) { const Vector< uint8_t > enc(encode(true)); if (!reinterpret_cast(this->issuer)->verify(enc.data(), (unsigned int)enc.size(), this->signature, this->signatureSize)) return ZT_CERTIFICATE_ERROR_INVALID_PRIMARY_SIGNATURE; } else { return ZT_CERTIFICATE_ERROR_INVALID_PRIMARY_SIGNATURE; } if (this->subject.uniqueIdProofSignatureSize > 0) { if ( (this->subject.uniqueIdProofSignatureSize != ZT_ECC384_SIGNATURE_SIZE) || (this->subject.uniqueIdSize != (ZT_ECC384_PUBLIC_KEY_SIZE + 1)) || (this->subject.uniqueId[0] != ZT_CERTIFICATE_UNIQUE_ID_PUBLIC_KEY_TYPE_NIST_P_384)) return ZT_CERTIFICATE_ERROR_INVALID_UNIQUE_ID_PROOF; Dictionary tmp; m_encodeSubject(this->subject, tmp, true); Vector< uint8_t > enc; tmp.encode(enc); uint8_t h[ZT_SHA384_DIGEST_SIZE]; SHA384(h, enc.data(), (unsigned int)enc.size()); if (!ECC384ECDSAVerify(this->subject.uniqueId + 1, h, this->subject.uniqueIdProofSignature)) return ZT_CERTIFICATE_ERROR_INVALID_UNIQUE_ID_PROOF; } else if (this->subject.uniqueIdSize > 0) { return ZT_CERTIFICATE_ERROR_INVALID_UNIQUE_ID_PROOF; } for (unsigned int i = 0; i < this->subject.identityCount; ++i) { if (!this->subject.identities[i].identity) return ZT_CERTIFICATE_ERROR_MISSING_REQUIRED_FIELDS; if (!reinterpret_cast(this->subject.identities[i].identity)->locallyValidate()) return ZT_CERTIFICATE_ERROR_INVALID_IDENTITY; if (this->subject.identities[i].locator) { if (!reinterpret_cast(this->subject.identities[i].locator)->verify(*reinterpret_cast(this->subject.identities[i].identity))) return ZT_CERTIFICATE_ERROR_INVALID_COMPONENT_SIGNATURE; } } for (unsigned int i = 0; i < this->subject.networkCount; ++i) { if (!this->subject.networks[i].id) return ZT_CERTIFICATE_ERROR_MISSING_REQUIRED_FIELDS; } if (this->subject.updateUrlCount) { if (!this->subject.updateUrls) return ZT_CERTIFICATE_ERROR_INVALID_FORMAT; for (unsigned int i = 0; i < this->subject.updateUrlCount; ++i) { if (!this->subject.updateUrls[i]) return ZT_CERTIFICATE_ERROR_MISSING_REQUIRED_FIELDS; } } else if (this->subject.updateUrls) { return ZT_CERTIFICATE_ERROR_INVALID_FORMAT; } } catch (...) {} return ZT_CERTIFICATE_ERROR_NONE; } bool Certificate::setSubjectUniqueId(const uint8_t uniqueId[ZT_CERTIFICATE_UNIQUE_ID_SIZE_TYPE_NIST_P_384], const uint8_t uniqueIdPrivate[ZT_CERTIFICATE_UNIQUE_ID_PRIVATE_KEY_SIZE_TYPE_NIST_P_384]) { m_subjectUniqueId.assign(uniqueId, uniqueId + ZT_CERTIFICATE_UNIQUE_ID_SIZE_TYPE_NIST_P_384); this->subject.uniqueId = m_subjectUniqueId.data(); this->subject.uniqueIdSize = ZT_CERTIFICATE_UNIQUE_ID_SIZE_TYPE_NIST_P_384; Dictionary d; m_encodeSubject(this->subject, d, true); Vector< uint8_t > enc; d.encode(enc); uint8_t h[ZT_SHA384_DIGEST_SIZE]; SHA384(h, enc.data(), (unsigned int)enc.size()); m_subjectUniqueIdProofSignature.resize(ZT_ECC384_SIGNATURE_SIZE); ECC384ECDSASign(uniqueIdPrivate, h, m_subjectUniqueIdProofSignature.data()); this->subject.uniqueIdProofSignature = m_subjectUniqueIdProofSignature.data(); this->subject.uniqueIdProofSignatureSize = ZT_ECC384_SIGNATURE_SIZE; return true; } void Certificate::m_clear() { ZT_Certificate *const sup = this; Utils::zero< sizeof(ZT_Certificate) >(sup); m_identities.clear(); m_locators.clear(); m_strings.clear(); m_serials.clear(); m_subjectIdentities.clear(); m_subjectNetworks.clear(); m_updateUrls.clear(); m_subjectCertificates.clear(); m_extendedAttributes.clear(); m_subjectUniqueId.clear(); m_subjectUniqueIdProofSignature.clear(); m_signature.clear(); } void Certificate::m_encodeSubject(const ZT_Certificate_Subject &s, Dictionary &d, bool omitUniqueIdProofSignature) { char tmp[64]; d.add("s.t", (uint64_t)s.timestamp); d.add("s.i$", (uint64_t)s.identityCount); for (unsigned int i = 0; i < s.identityCount; ++i) { if (s.identities[i].identity) d.addO(Dictionary::arraySubscript(tmp, "s.i$.i", i), *reinterpret_cast(s.identities[i].identity)); if (s.identities[i].locator) d.addO(Dictionary::arraySubscript(tmp, "s.i$.l", i), *reinterpret_cast(s.identities[i].locator)); } d.add("s.n$", (uint64_t)s.networkCount); for (unsigned int i = 0; i < s.networkCount; ++i) { d.add(Dictionary::arraySubscript(tmp, "s.n$.i", i), s.networks[i].id); Fingerprint fp(s.networks[i].controller); d.addO(Dictionary::arraySubscript(tmp, "s.n$.c", i), fp); } d.add("s.c$", (uint64_t)s.certificateCount); for (unsigned int i = 0; i < s.certificateCount; ++i) { if (s.certificates[i]) d[Dictionary::arraySubscript(tmp, "s.c$", i)].assign(s.certificates[i], s.certificates[i] + ZT_SHA384_DIGEST_SIZE); } d.add("s.u$", (uint64_t)s.updateUrlCount); if (s.updateUrls) { for (unsigned int i = 0; i < s.updateUrlCount; ++i) d.add(Dictionary::arraySubscript(tmp, "s.u$", i), s.updateUrls[i]); } if (s.name.country[0]) d.add("s.n.c", s.name.country); if (s.name.organization[0]) d.add("s.n.o", s.name.organization); if (s.name.unit[0]) d.add("s.n.u", s.name.unit); if (s.name.locality[0]) d.add("s.n.l", s.name.locality); if (s.name.province[0]) d.add("s.n.p", s.name.province); if (s.name.streetAddress[0]) d.add("s.n.sA", s.name.streetAddress); if (s.name.postalCode[0]) d.add("s.n.pC", s.name.postalCode); if (s.name.commonName[0]) d.add("s.n.cN", s.name.commonName); if (s.name.serialNo[0]) d.add("s.n.sN", s.name.serialNo); if (s.name.email[0]) d.add("s.n.e", s.name.email); if (s.name.url[0]) d.add("s.n.ur", s.name.url); if (s.name.host[0]) d.add("s.n.h", s.name.host); if ((s.uniqueIdSize > 0) && (s.uniqueId != nullptr)) d["s.uI"].assign(s.uniqueId, s.uniqueId + s.uniqueIdSize); if ((!omitUniqueIdProofSignature) && (s.uniqueIdProofSignatureSize > 0) && (s.uniqueIdProofSignature != nullptr)) d["s.uS"].assign(s.uniqueIdProofSignature, s.uniqueIdProofSignature + s.uniqueIdProofSignatureSize); } } // namespace ZeroTier