Update V8 to version 4.7.52.
[chromium-blink-merge.git] / chromeos / cert_loader.h
blob694ea31eac3062c49b3e076f02440e19f1fd5b8a
1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef CHROMEOS_CERT_LOADER_H_
6 #define CHROMEOS_CERT_LOADER_H_
8 #include <string>
9 #include <vector>
11 #include "base/basictypes.h"
12 #include "base/compiler_specific.h"
13 #include "base/memory/ref_counted.h"
14 #include "base/memory/weak_ptr.h"
15 #include "base/observer_list.h"
16 #include "base/threading/thread_checker.h"
17 #include "chromeos/chromeos_export.h"
18 #include "net/cert/cert_database.h"
20 namespace net {
21 class NSSCertDatabase;
22 class X509Certificate;
23 typedef std::vector<scoped_refptr<X509Certificate> > CertificateList;
26 namespace chromeos {
28 // This class is responsible for loading certificates once the TPM is
29 // initialized. It is expected to be constructed on the UI thread and public
30 // methods should all be called from the UI thread.
31 // When certificates have been loaded (after login completes and tpm token is
32 // initialized), or the cert database changes, observers are called with
33 // OnCertificatesLoaded().
34 class CHROMEOS_EXPORT CertLoader : public net::CertDatabase::Observer {
35 public:
36 class Observer {
37 public:
38 // Called when the certificates, passed for convenience as |cert_list|,
39 // have completed loading. |initial_load| is true the first time this
40 // is called.
41 virtual void OnCertificatesLoaded(const net::CertificateList& cert_list,
42 bool initial_load) = 0;
44 protected:
45 virtual ~Observer() {}
48 // Sets the global instance. Must be called before any calls to Get().
49 static void Initialize();
51 // Destroys the global instance.
52 static void Shutdown();
54 // Gets the global instance. Initialize() must be called first.
55 static CertLoader* Get();
57 // Returns true if the global instance has been initialized.
58 static bool IsInitialized();
60 // Returns the PKCS#11 attribute CKA_ID for a certificate as an upper-case
61 // hex string and sets |slot_id| to the id of the containing slot, or returns
62 // an empty string and doesn't modify |slot_id| if the PKCS#11 id could not be
63 // determined.
64 static std::string GetPkcs11IdAndSlotForCert(const net::X509Certificate& cert,
65 int* slot_id);
67 // Starts the CertLoader with the NSS cert database.
68 // The CertLoader will _not_ take the ownership of the database, but it
69 // expects it to stay alive at least until the shutdown starts on the main
70 // thread. This assumes that |StartWithNSSDB| and other methods directly
71 // using |database_| are not called during shutdown.
72 void StartWithNSSDB(net::NSSCertDatabase* database);
74 void AddObserver(CertLoader::Observer* observer);
75 void RemoveObserver(CertLoader::Observer* observer);
77 // Returns true if |cert| is hardware backed. See also
78 // ForceHardwareBackedForTesting().
79 static bool IsCertificateHardwareBacked(const net::X509Certificate* cert);
81 // Returns true when the certificate list has been requested but not loaded.
82 bool CertificatesLoading() const;
84 bool certificates_loaded() const { return certificates_loaded_; }
86 // This will be empty until certificates_loaded() is true.
87 const net::CertificateList& cert_list() const { return *cert_list_; }
89 // Called in tests if |IsCertificateHardwareBacked()| should always return
90 // true.
91 static void ForceHardwareBackedForTesting();
93 private:
94 CertLoader();
95 ~CertLoader() override;
97 // Trigger a certificate load. If a certificate loading task is already in
98 // progress, will start a reload once the current task is finished.
99 void LoadCertificates();
101 // Called if a certificate load task is finished.
102 void UpdateCertificates(scoped_ptr<net::CertificateList> cert_list);
104 void NotifyCertificatesLoaded(bool initial_load);
106 // net::CertDatabase::Observer
107 void OnCACertChanged(const net::X509Certificate* cert) override;
108 void OnCertAdded(const net::X509Certificate* cert) override;
109 void OnCertRemoved(const net::X509Certificate* cert) override;
111 base::ObserverList<Observer> observers_;
113 // Flags describing current CertLoader state.
114 bool certificates_loaded_;
115 bool certificates_update_required_;
116 bool certificates_update_running_;
118 // The user-specific NSS certificate database from which the certificates
119 // should be loaded.
120 net::NSSCertDatabase* database_;
122 // Cached Certificates loaded from the database.
123 scoped_ptr<net::CertificateList> cert_list_;
125 base::ThreadChecker thread_checker_;
127 base::WeakPtrFactory<CertLoader> weak_factory_;
129 DISALLOW_COPY_AND_ASSIGN(CertLoader);
132 } // namespace chromeos
134 #endif // CHROMEOS_CERT_LOADER_H_