1 // Copyright 2015 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "net/cert/x509_util_nss.h"
6
7 #include <cert.h> // Must be included before certdb.h
8 #include <certdb.h>
9 #include <cryptohi.h>
10 #include <dlfcn.h>
11 #include <nss.h>
12 #include <pk11pub.h>
13 #include <prerror.h>
14 #include <seccomon.h>
15 #include <secder.h>
16 #include <sechash.h>
17 #include <secmod.h>
18 #include <secport.h>
19 #include <string.h>
20
21 #include "base/logging.h"
22 #include "base/strings/stringprintf.h"
23 #include "crypto/nss_util.h"
24 #include "crypto/scoped_nss_types.h"
25 #include "net/cert/x509_util.h"
26 #include "net/third_party/mozilla_security_manager/nsNSSCertificateDB.h"
27 #include "third_party/boringssl/src/include/openssl/pool.h"
28
29 namespace net::x509_util {
30
31 namespace {
32
33 // Microsoft User Principal Name: 1.3.6.1.4.1.311.20.2.3
34 const uint8_t kUpnOid[] = {0x2b, 0x6, 0x1, 0x4, 0x1,
35 0x82, 0x37, 0x14, 0x2, 0x3};
36
DecodeAVAValue(CERTAVA * ava)37 std::string DecodeAVAValue(CERTAVA* ava) {
38 SECItem* decode_item = CERT_DecodeAVAValue(&ava->value);
39 if (!decode_item)
40 return std::string();
41 std::string value(reinterpret_cast<char*>(decode_item->data),
42 decode_item->len);
43 SECITEM_FreeItem(decode_item, PR_TRUE);
44 return value;
45 }
46
47 // Generates a unique nickname for |slot|, returning |nickname| if it is
48 // already unique.
49 //
50 // Note: The nickname returned will NOT include the token name, thus the
51 // token name must be prepended if calling an NSS function that expects
52 // <token>:<nickname>.
53 // TODO(gspencer): Internationalize this: it's wrong to hard-code English.
GetUniqueNicknameForSlot(const std::string & nickname,const SECItem * subject,PK11SlotInfo * slot)54 std::string GetUniqueNicknameForSlot(const std::string& nickname,
55 const SECItem* subject,
56 PK11SlotInfo* slot) {
57 int index = 2;
58 std::string new_name = nickname;
59 std::string temp_nickname = new_name;
60 std::string token_name;
61
62 if (!slot)
63 return new_name;
64
65 if (!PK11_IsInternalKeySlot(slot)) {
66 token_name.assign(PK11_GetTokenName(slot));
67 token_name.append(":");
68
69 temp_nickname = token_name + new_name;
70 }
71
72 while (SEC_CertNicknameConflict(temp_nickname.c_str(),
73 const_cast<SECItem*>(subject),
74 CERT_GetDefaultCertDB())) {
75 new_name = base::StringPrintf("%s #%d", nickname.c_str(), index++);
76 temp_nickname = token_name + new_name;
77 }
78
79 return new_name;
80 }
81
82 // The default nickname of the certificate, based on the certificate type
83 // passed in.
GetDefaultNickname(CERTCertificate * nss_cert,CertType type)84 std::string GetDefaultNickname(CERTCertificate* nss_cert, CertType type) {
85 std::string result;
86 if (type == USER_CERT && nss_cert->slot) {
87 // Find the private key for this certificate and see if it has a
88 // nickname. If there is a private key, and it has a nickname, then
89 // return that nickname.
90 SECKEYPrivateKey* private_key = PK11_FindPrivateKeyFromCert(
91 nss_cert->slot, nss_cert, nullptr /*wincx*/);
92 if (private_key) {
93 char* private_key_nickname = PK11_GetPrivateKeyNickname(private_key);
94 if (private_key_nickname) {
95 result = private_key_nickname;
96 PORT_Free(private_key_nickname);
97 SECKEY_DestroyPrivateKey(private_key);
98 return result;
99 }
100 SECKEY_DestroyPrivateKey(private_key);
101 }
102 }
103
104 switch (type) {
105 case CA_CERT: {
106 char* nickname = CERT_MakeCANickname(nss_cert);
107 result = nickname;
108 PORT_Free(nickname);
109 break;
110 }
111 case USER_CERT: {
112 std::string subject_name = GetCERTNameDisplayName(&nss_cert->subject);
113 if (subject_name.empty()) {
114 const char* email = CERT_GetFirstEmailAddress(nss_cert);
115 if (email)
116 subject_name = email;
117 }
118 // TODO(gspencer): Internationalize this. It's wrong to assume English
119 // here.
120 result =
121 base::StringPrintf("%s's %s ID", subject_name.c_str(),
122 GetCERTNameDisplayName(&nss_cert->issuer).c_str());
123 break;
124 }
125 case SERVER_CERT: {
126 result = GetCERTNameDisplayName(&nss_cert->subject);
127 break;
128 }
129 case OTHER_CERT:
130 default:
131 break;
132 }
133 return result;
134 }
135
136 } // namespace
137
IsSameCertificate(CERTCertificate * a,CERTCertificate * b)138 bool IsSameCertificate(CERTCertificate* a, CERTCertificate* b) {
139 DCHECK(a && b);
140 if (a == b)
141 return true;
142 return a->derCert.len == b->derCert.len &&
143 memcmp(a->derCert.data, b->derCert.data, a->derCert.len) == 0;
144 }
145
IsSameCertificate(CERTCertificate * a,const X509Certificate * b)146 bool IsSameCertificate(CERTCertificate* a, const X509Certificate* b) {
147 return IsSameCertificate(a, b->cert_buffer());
148 }
IsSameCertificate(const X509Certificate * a,CERTCertificate * b)149 bool IsSameCertificate(const X509Certificate* a, CERTCertificate* b) {
150 return IsSameCertificate(b, a->cert_buffer());
151 }
152
IsSameCertificate(CERTCertificate * a,const CRYPTO_BUFFER * b)153 bool IsSameCertificate(CERTCertificate* a, const CRYPTO_BUFFER* b) {
154 return a->derCert.len == CRYPTO_BUFFER_len(b) &&
155 memcmp(a->derCert.data, CRYPTO_BUFFER_data(b), a->derCert.len) == 0;
156 }
IsSameCertificate(const CRYPTO_BUFFER * a,CERTCertificate * b)157 bool IsSameCertificate(const CRYPTO_BUFFER* a, CERTCertificate* b) {
158 return IsSameCertificate(b, a);
159 }
160
CreateCERTCertificateFromBytes(base::span<const uint8_t> data)161 ScopedCERTCertificate CreateCERTCertificateFromBytes(
162 base::span<const uint8_t> data) {
163 crypto::EnsureNSSInit();
164
165 if (!NSS_IsInitialized())
166 return nullptr;
167
168 SECItem der_cert;
169 der_cert.data = const_cast<uint8_t*>(data.data());
170 der_cert.len = base::checked_cast<unsigned>(data.size());
171 der_cert.type = siDERCertBuffer;
172
173 // Parse into a certificate structure.
174 return ScopedCERTCertificate(CERT_NewTempCertificate(
175 CERT_GetDefaultCertDB(), &der_cert, nullptr /* nickname */,
176 PR_FALSE /* is_perm */, PR_TRUE /* copyDER */));
177 }
178
CreateCERTCertificateFromX509Certificate(const X509Certificate * cert)179 ScopedCERTCertificate CreateCERTCertificateFromX509Certificate(
180 const X509Certificate* cert) {
181 return CreateCERTCertificateFromBytes(
182 CryptoBufferAsSpan(cert->cert_buffer()));
183 }
184
CreateCERTCertificateListFromX509Certificate(const X509Certificate * cert)185 ScopedCERTCertificateList CreateCERTCertificateListFromX509Certificate(
186 const X509Certificate* cert) {
187 return x509_util::CreateCERTCertificateListFromX509Certificate(
188 cert, InvalidIntermediateBehavior::kFail);
189 }
190
CreateCERTCertificateListFromX509Certificate(const X509Certificate * cert,InvalidIntermediateBehavior invalid_intermediate_behavior)191 ScopedCERTCertificateList CreateCERTCertificateListFromX509Certificate(
192 const X509Certificate* cert,
193 InvalidIntermediateBehavior invalid_intermediate_behavior) {
194 ScopedCERTCertificateList nss_chain;
195 nss_chain.reserve(1 + cert->intermediate_buffers().size());
196 ScopedCERTCertificate nss_cert =
197 CreateCERTCertificateFromX509Certificate(cert);
198 if (!nss_cert)
199 return {};
200 nss_chain.push_back(std::move(nss_cert));
201 for (const auto& intermediate : cert->intermediate_buffers()) {
202 ScopedCERTCertificate nss_intermediate =
203 CreateCERTCertificateFromBytes(CryptoBufferAsSpan(intermediate.get()));
204 if (!nss_intermediate) {
205 if (invalid_intermediate_behavior == InvalidIntermediateBehavior::kFail)
206 return {};
207 LOG(WARNING) << "error parsing intermediate";
208 continue;
209 }
210 nss_chain.push_back(std::move(nss_intermediate));
211 }
212 return nss_chain;
213 }
214
CreateCERTCertificateListFromBytes(const char * data,size_t length,int format)215 ScopedCERTCertificateList CreateCERTCertificateListFromBytes(const char* data,
216 size_t length,
217 int format) {
218 CertificateList certs = X509Certificate::CreateCertificateListFromBytes(
219 base::as_bytes(base::make_span(data, length)), format);
220 ScopedCERTCertificateList nss_chain;
221 nss_chain.reserve(certs.size());
222 for (const scoped_refptr<X509Certificate>& cert : certs) {
223 ScopedCERTCertificate nss_cert =
224 CreateCERTCertificateFromX509Certificate(cert.get());
225 if (!nss_cert)
226 return {};
227 nss_chain.push_back(std::move(nss_cert));
228 }
229 return nss_chain;
230 }
231
DupCERTCertificate(CERTCertificate * cert)232 ScopedCERTCertificate DupCERTCertificate(CERTCertificate* cert) {
233 return ScopedCERTCertificate(CERT_DupCertificate(cert));
234 }
235
DupCERTCertificateList(const ScopedCERTCertificateList & certs)236 ScopedCERTCertificateList DupCERTCertificateList(
237 const ScopedCERTCertificateList& certs) {
238 ScopedCERTCertificateList result;
239 result.reserve(certs.size());
240 for (const ScopedCERTCertificate& cert : certs)
241 result.push_back(DupCERTCertificate(cert.get()));
242 return result;
243 }
244
CreateX509CertificateFromCERTCertificate(CERTCertificate * nss_cert,const std::vector<CERTCertificate * > & nss_chain)245 scoped_refptr<X509Certificate> CreateX509CertificateFromCERTCertificate(
246 CERTCertificate* nss_cert,
247 const std::vector<CERTCertificate*>& nss_chain) {
248 return CreateX509CertificateFromCERTCertificate(nss_cert, nss_chain, {});
249 }
250
CreateX509CertificateFromCERTCertificate(CERTCertificate * nss_cert,const std::vector<CERTCertificate * > & nss_chain,X509Certificate::UnsafeCreateOptions options)251 scoped_refptr<X509Certificate> CreateX509CertificateFromCERTCertificate(
252 CERTCertificate* nss_cert,
253 const std::vector<CERTCertificate*>& nss_chain,
254 X509Certificate::UnsafeCreateOptions options) {
255 if (!nss_cert || !nss_cert->derCert.len) {
256 return nullptr;
257 }
258 bssl::UniquePtr<CRYPTO_BUFFER> cert_handle(x509_util::CreateCryptoBuffer(
259 base::make_span(nss_cert->derCert.data, nss_cert->derCert.len)));
260
261 std::vector<bssl::UniquePtr<CRYPTO_BUFFER>> intermediates;
262 intermediates.reserve(nss_chain.size());
263 for (const CERTCertificate* nss_intermediate : nss_chain) {
264 if (!nss_intermediate || !nss_intermediate->derCert.len) {
265 return nullptr;
266 }
267 intermediates.push_back(x509_util::CreateCryptoBuffer(base::make_span(
268 nss_intermediate->derCert.data, nss_intermediate->derCert.len)));
269 }
270
271 return X509Certificate::CreateFromBufferUnsafeOptions(
272 std::move(cert_handle), std::move(intermediates), options);
273 }
274
CreateX509CertificateFromCERTCertificate(CERTCertificate * cert)275 scoped_refptr<X509Certificate> CreateX509CertificateFromCERTCertificate(
276 CERTCertificate* cert) {
277 return CreateX509CertificateFromCERTCertificate(
278 cert, std::vector<CERTCertificate*>());
279 }
280
CreateX509CertificateListFromCERTCertificates(const ScopedCERTCertificateList & certs)281 CertificateList CreateX509CertificateListFromCERTCertificates(
282 const ScopedCERTCertificateList& certs) {
283 CertificateList result;
284 result.reserve(certs.size());
285 for (const ScopedCERTCertificate& cert : certs) {
286 scoped_refptr<X509Certificate> x509_cert(
287 CreateX509CertificateFromCERTCertificate(cert.get()));
288 if (!x509_cert)
289 return {};
290 result.push_back(std::move(x509_cert));
291 }
292 return result;
293 }
294
GetDEREncoded(CERTCertificate * cert,std::string * der_encoded)295 bool GetDEREncoded(CERTCertificate* cert, std::string* der_encoded) {
296 if (!cert || !cert->derCert.len)
297 return false;
298 der_encoded->assign(reinterpret_cast<char*>(cert->derCert.data),
299 cert->derCert.len);
300 return true;
301 }
302
GetPEMEncoded(CERTCertificate * cert,std::string * pem_encoded)303 bool GetPEMEncoded(CERTCertificate* cert, std::string* pem_encoded) {
304 if (!cert || !cert->derCert.len)
305 return false;
306 std::string der(reinterpret_cast<char*>(cert->derCert.data),
307 cert->derCert.len);
308 return X509Certificate::GetPEMEncodedFromDER(der, pem_encoded);
309 }
310
GetRFC822SubjectAltNames(CERTCertificate * cert_handle,std::vector<std::string> * names)311 void GetRFC822SubjectAltNames(CERTCertificate* cert_handle,
312 std::vector<std::string>* names) {
313 crypto::ScopedSECItem alt_name(SECITEM_AllocItem(nullptr, nullptr, 0));
314 DCHECK(alt_name.get());
315
316 names->clear();
317 SECStatus rv = CERT_FindCertExtension(
318 cert_handle, SEC_OID_X509_SUBJECT_ALT_NAME, alt_name.get());
319 if (rv != SECSuccess)
320 return;
321
322 crypto::ScopedPLArenaPool arena(PORT_NewArena(DER_DEFAULT_CHUNKSIZE));
323 DCHECK(arena.get());
324
325 CERTGeneralName* alt_name_list;
326 alt_name_list = CERT_DecodeAltNameExtension(arena.get(), alt_name.get());
327
328 CERTGeneralName* name = alt_name_list;
329 while (name) {
330 if (name->type == certRFC822Name) {
331 names->push_back(
332 std::string(reinterpret_cast<char*>(name->name.other.data),
333 name->name.other.len));
334 }
335 name = CERT_GetNextGeneralName(name);
336 if (name == alt_name_list)
337 break;
338 }
339 }
340
GetUPNSubjectAltNames(CERTCertificate * cert_handle,std::vector<std::string> * names)341 void GetUPNSubjectAltNames(CERTCertificate* cert_handle,
342 std::vector<std::string>* names) {
343 crypto::ScopedSECItem alt_name(SECITEM_AllocItem(nullptr, nullptr, 0));
344 DCHECK(alt_name.get());
345
346 names->clear();
347 SECStatus rv = CERT_FindCertExtension(
348 cert_handle, SEC_OID_X509_SUBJECT_ALT_NAME, alt_name.get());
349 if (rv != SECSuccess)
350 return;
351
352 crypto::ScopedPLArenaPool arena(PORT_NewArena(DER_DEFAULT_CHUNKSIZE));
353 DCHECK(arena.get());
354
355 CERTGeneralName* alt_name_list;
356 alt_name_list = CERT_DecodeAltNameExtension(arena.get(), alt_name.get());
357
358 CERTGeneralName* name = alt_name_list;
359 while (name) {
360 if (name->type == certOtherName) {
361 OtherName* on = &name->name.OthName;
362 if (on->oid.len == sizeof(kUpnOid) &&
363 memcmp(on->oid.data, kUpnOid, sizeof(kUpnOid)) == 0) {
364 SECItem decoded;
365 if (SEC_QuickDERDecodeItem(arena.get(), &decoded,
366 SEC_ASN1_GET(SEC_UTF8StringTemplate),
367 &name->name.OthName.name) == SECSuccess) {
368 names->push_back(
369 std::string(reinterpret_cast<char*>(decoded.data), decoded.len));
370 }
371 }
372 }
373 name = CERT_GetNextGeneralName(name);
374 if (name == alt_name_list)
375 break;
376 }
377 }
378
GetDefaultUniqueNickname(CERTCertificate * nss_cert,CertType type,PK11SlotInfo * slot)379 std::string GetDefaultUniqueNickname(CERTCertificate* nss_cert,
380 CertType type,
381 PK11SlotInfo* slot) {
382 return GetUniqueNicknameForSlot(GetDefaultNickname(nss_cert, type),
383 &nss_cert->derSubject, slot);
384 }
385
GetCERTNameDisplayName(CERTName * name)386 std::string GetCERTNameDisplayName(CERTName* name) {
387 // Search for attributes in the Name, in this order: CN, O and OU.
388 CERTAVA* ou_ava = nullptr;
389 CERTAVA* o_ava = nullptr;
390 CERTRDN** rdns = name->rdns;
391 for (size_t rdn = 0; rdns[rdn]; ++rdn) {
392 CERTAVA** avas = rdns[rdn]->avas;
393 for (size_t pair = 0; avas[pair] != nullptr; ++pair) {
394 SECOidTag tag = CERT_GetAVATag(avas[pair]);
395 if (tag == SEC_OID_AVA_COMMON_NAME) {
396 // If CN is found, return immediately.
397 return DecodeAVAValue(avas[pair]);
398 }
399 // If O or OU is found, save the first one of each so that it can be
400 // returned later if no CN attribute is found.
401 if (tag == SEC_OID_AVA_ORGANIZATION_NAME && !o_ava)
402 o_ava = avas[pair];
403 if (tag == SEC_OID_AVA_ORGANIZATIONAL_UNIT_NAME && !ou_ava)
404 ou_ava = avas[pair];
405 }
406 }
407 if (o_ava)
408 return DecodeAVAValue(o_ava);
409 if (ou_ava)
410 return DecodeAVAValue(ou_ava);
411 return std::string();
412 }
413
GetValidityTimes(CERTCertificate * cert,base::Time * not_before,base::Time * not_after)414 bool GetValidityTimes(CERTCertificate* cert,
415 base::Time* not_before,
416 base::Time* not_after) {
417 PRTime pr_not_before, pr_not_after;
418 if (CERT_GetCertTimes(cert, &pr_not_before, &pr_not_after) == SECSuccess) {
419 if (not_before)
420 *not_before = crypto::PRTimeToBaseTime(pr_not_before);
421 if (not_after)
422 *not_after = crypto::PRTimeToBaseTime(pr_not_after);
423 return true;
424 }
425 return false;
426 }
427
CalculateFingerprint256(CERTCertificate * cert)428 SHA256HashValue CalculateFingerprint256(CERTCertificate* cert) {
429 SHA256HashValue sha256;
430 memset(sha256.data, 0, sizeof(sha256.data));
431
432 DCHECK(cert->derCert.data);
433 DCHECK_NE(0U, cert->derCert.len);
434
435 SECStatus rv = HASH_HashBuf(HASH_AlgSHA256, sha256.data, cert->derCert.data,
436 cert->derCert.len);
437 DCHECK_EQ(SECSuccess, rv);
438
439 return sha256;
440 }
441
ImportUserCert(CERTCertificate * cert,crypto::ScopedPK11Slot preferred_slot)442 int ImportUserCert(CERTCertificate* cert,
443 crypto::ScopedPK11Slot preferred_slot) {
444 return mozilla_security_manager::ImportUserCert(cert,
445 std::move(preferred_slot));
446 }
447
448 } // namespace net::x509_util
449