blob: 97be8c45eb334593c287006f9917372b921bb226 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stdint.h>
#include <memory>
#include <string>
#include <vector>
#include "base/callback_forward.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "base/strings/string16.h"
#include "crypto/scoped_nss_types.h"
#include "net/base/net_errors.h"
#include "net/base/net_export.h"
#include "net/cert/cert_type.h"
#include "net/cert/scoped_nss_types.h"
#include "net/cert/x509_certificate.h"
namespace base {
template <class ObserverType>
class ObserverListThreadSafe;
namespace net {
// Provides functions to manipulate the NSS certificate stores.
// Forwards notifications about certificate changes to the global CertDatabase
// singleton.
class NET_EXPORT NSSCertDatabase {
class NET_EXPORT Observer {
virtual ~Observer() {}
// Will be called when a certificate is added, removed, or trust settings
// are changed.
virtual void OnCertDBChanged() {}
Observer() {}
// Stores per-certificate error codes for import failures.
struct NET_EXPORT ImportCertFailure {
ImportCertFailure(ScopedCERTCertificate cert, int err);
ImportCertFailure(ImportCertFailure&& other);
ScopedCERTCertificate certificate;
int net_error;
typedef std::vector<ImportCertFailure> ImportCertFailureList;
// Constants that define which usages a certificate is trusted for.
// They are used in combination with CertType to specify trust for each type
// of certificate.
// For a CA_CERT, they specify that the CA is trusted for issuing server and
// client certs of each type.
// For SERVER_CERT, only TRUSTED_SSL makes sense, and specifies the cert is
// trusted as a server.
// For EMAIL_CERT, only TRUSTED_EMAIL makes sense, and specifies the cert is
// trusted for email.
// DISTRUSTED_* specifies that the cert should not be trusted for the given
// usage, regardless of whether it would otherwise inherit trust from the
// issuer chain.
// Use TRUST_DEFAULT to inherit trust as normal.
// NOTE: The actual constants are defined using an enum instead of static
// consts due to compilation/linkage constraints with template functions.
typedef uint32_t TrustBits;
enum {
TRUSTED_SSL = 1 << 0,
using ListCertsCallback =
base::OnceCallback<void(ScopedCERTCertificateList certs)>;
using DeleteCertCallback = base::OnceCallback<void(bool)>;
// Creates a NSSCertDatabase that will store public information (such as
// certificates and trust records) in |public_slot|, and private information
// (such as keys) in |private_slot|.
// In general, code should avoid creating an NSSCertDatabase directly,
// as doing so requires making opinionated decisions about where to store
// data, and instead prefer to be passed an existing NSSCertDatabase
// instance.
// |public_slot| must not be NULL, |private_slot| can be NULL. Both slots can
// be identical.
NSSCertDatabase(crypto::ScopedPK11Slot public_slot,
crypto::ScopedPK11Slot private_slot);
virtual ~NSSCertDatabase();
// Get a list of unique certificates in the certificate database (one
// instance of all certificates).
// DEPRECATED by |ListCerts|. See
virtual ScopedCERTCertificateList ListCertsSync();
// Asynchronously get a list of unique certificates in the certificate
// database (one instance of all certificates). Note that the callback may be
// run even after the database is deleted.
virtual void ListCerts(ListCertsCallback callback);
// Get a list of certificates in the certificate database of the given slot.
// Note that the callback may be run even after the database is deleted.
// Must be called on the IO thread and it calls |callback| on the IO thread.
// This does not block by retrieving the certs asynchronously on a worker
// thread. Never calls |callback| synchronously.
virtual void ListCertsInSlot(ListCertsCallback callback, PK11SlotInfo* slot);
#if defined(OS_CHROMEOS)
// Get the slot for system-wide key data. May be NULL if the system token was
// not explicitly set.
// Note: The System slot is set after the NSSCertDatabase is constructed and
// this call returns synchronously. Thus, it is possible to call this function
// before SetSystemSlot is called and get a NULL result.
// See .
virtual crypto::ScopedPK11Slot GetSystemSlot() const;
// Check whether the certificate is stored on the system slot (i.e. is a
// device certificate).
bool IsCertificateOnSystemSlot(CERTCertificate* cert) const;
// Get the default slot for public key data.
crypto::ScopedPK11Slot GetPublicSlot() const;
// Get the default slot for private key or mixed private/public key data.
// Can return NULL.
crypto::ScopedPK11Slot GetPrivateSlot() const;
// Get all modules.
// If |need_rw| is true, only writable modules will be returned.
virtual void ListModules(std::vector<crypto::ScopedPK11Slot>* modules,
bool need_rw) const;
// Import certificates and private keys from PKCS #12 blob into the module.
// If |is_extractable| is false, mark the private key as being unextractable
// from the module.
// Returns OK or a network error code such as ERR_PKCS12_IMPORT_BAD_PASSWORD
// or ERR_PKCS12_IMPORT_ERROR. |imported_certs|, if non-NULL, returns a list
// of certs that were imported.
int ImportFromPKCS12(PK11SlotInfo* slot_info,
const std::string& data,
const base::string16& password,
bool is_extractable,
ScopedCERTCertificateList* imported_certs);
// Export the given certificates and private keys into a PKCS #12 blob,
// storing into |output|.
// Returns the number of certificates successfully exported.
int ExportToPKCS12(const ScopedCERTCertificateList& certs,
const base::string16& password,
std::string* output) const;
// Uses similar logic to nsNSSCertificateDB::handleCACertDownload to find the
// root. Assumes the list is an ordered hierarchy with the root being either
// the first or last element.
// TODO(mattm): improve this to handle any order.
CERTCertificate* FindRootInList(
const ScopedCERTCertificateList& certificates) const;
// Import a user certificate. The private key for the user certificate must
// already be installed, otherwise we return ERR_NO_PRIVATE_KEY_FOR_CERT.
// Returns OK or a network error code.
int ImportUserCert(const std::string& data);
int ImportUserCert(CERTCertificate* cert);
// Import CA certificates.
// Tries to import all the certificates given. The root will be trusted
// according to |trust_bits|. Any certificates that could not be imported
// will be listed in |not_imported|.
// Returns false if there is an internal error, otherwise true is returned and
// |not_imported| should be checked for any certificates that were not
// imported.
bool ImportCACerts(const ScopedCERTCertificateList& certificates,
TrustBits trust_bits,
ImportCertFailureList* not_imported);
// Import server certificate. The first cert should be the server cert. Any
// additional certs should be intermediate/CA certs and will be imported but
// not given any trust.
// Any certificates that could not be imported will be listed in
// |not_imported|.
// |trust_bits| can be set to explicitly trust or distrust the certificate, or
// use TRUST_DEFAULT to inherit trust as normal.
// Returns false if there is an internal error, otherwise true is returned and
// |not_imported| should be checked for any certificates that were not
// imported.
bool ImportServerCert(const ScopedCERTCertificateList& certificates,
TrustBits trust_bits,
ImportCertFailureList* not_imported);
// Get trust bits for certificate.
TrustBits GetCertTrust(const CERTCertificate* cert, CertType type) const;
// IsUntrusted returns true if |cert| is specifically untrusted. These
// certificates are stored in the database for the specific purpose of
// rejecting them.
bool IsUntrusted(const CERTCertificate* cert) const;
// IsWebTrustAnchor returns true if |cert| is explicitly trusted for web
// navigations according to the trust bits stored in the database.
bool IsWebTrustAnchor(const CERTCertificate* cert) const;
// Set trust values for certificate.
// Returns true on success or false on failure.
bool SetCertTrust(CERTCertificate* cert, CertType type, TrustBits trust_bits);
// Delete certificate and associated private key (if one exists).
// |cert| is still valid when this function returns. Returns true on
// success.
bool DeleteCertAndKey(CERTCertificate* cert);
// Like DeleteCertAndKey but does not block by running the removal on a worker
// thread. This must be called on IO thread and it will run |callback| on IO
// thread. Never calls |callback| synchronously.
void DeleteCertAndKeyAsync(ScopedCERTCertificate cert,
DeleteCertCallback callback);
// Check whether cert is stored in a readonly slot.
bool IsReadOnly(const CERTCertificate* cert) const;
// Check whether cert is stored in a hardware slot.
bool IsHardwareBacked(const CERTCertificate* cert) const;
// Certificate listing implementation used by |ListCerts*| and
// |ListCertsSync|. Static so it may safely be used on the worker thread.
// If |slot| is NULL, obtains the certs of all slots, otherwise only of
// |slot|.
static ScopedCERTCertificateList ListCertsImpl(crypto::ScopedPK11Slot slot);
// Broadcasts notifications to all registered observers.
void NotifyObserversCertDBChanged();
// Registers |observer| to receive notifications of certificate changes. The
// thread on which this is called is the thread on which |observer| will be
// called back with notifications.
// NOTE: Observers registered here will only receive notifications generated
// directly through the NSSCertDatabase, but not those from the CertDatabase.
// CertDatabase observers will receive all certificate notifications.
void AddObserver(Observer* observer);
// Unregisters |observer| from receiving notifications. This must be called
// on the same thread on which AddObserver() was called.
void RemoveObserver(Observer* observer);
// Notifies observers of the removal of a cert and calls |callback| with
// |success| as argument.
void NotifyCertRemovalAndCallBack(DeleteCertCallback callback, bool success);
// Certificate removal implementation used by |DeleteCertAndKey*|. Static so
// it may safely be used on the worker thread.
static bool DeleteCertAndKeyImpl(CERTCertificate* cert);
// Like above, but taking a ScopedCERTCertificate. This is a workaround for
// base::Bind not having a way to own a unique_ptr but pass it to the
// function as a raw pointer.
static bool DeleteCertAndKeyImplScoped(ScopedCERTCertificate cert);
crypto::ScopedPK11Slot public_slot_;
crypto::ScopedPK11Slot private_slot_;
// A helper observer that forwards events from this database to CertDatabase.
std::unique_ptr<Observer> cert_notification_forwarder_;
const scoped_refptr<base::ObserverListThreadSafe<Observer>> observer_list_;
base::WeakPtrFactory<NSSCertDatabase> weak_factory_{this};
} // namespace net