summaryrefslogtreecommitdiff
path: root/chromium/net/cert/test_root_certs.h
diff options
context:
space:
mode:
Diffstat (limited to 'chromium/net/cert/test_root_certs.h')
-rw-r--r--chromium/net/cert/test_root_certs.h134
1 files changed, 134 insertions, 0 deletions
diff --git a/chromium/net/cert/test_root_certs.h b/chromium/net/cert/test_root_certs.h
new file mode 100644
index 00000000000..22c635f9dbb
--- /dev/null
+++ b/chromium/net/cert/test_root_certs.h
@@ -0,0 +1,134 @@
+// 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.
+
+#ifndef NET_CERT_TEST_ROOT_CERTS_H_
+#define NET_CERT_TEST_ROOT_CERTS_H_
+
+#include "base/lazy_instance.h"
+#include "base/memory/ref_counted.h"
+#include "build/build_config.h"
+#include "net/base/net_export.h"
+
+#if defined(USE_NSS) || defined(OS_IOS)
+#include <list>
+#elif defined(OS_WIN)
+#include <windows.h>
+#include <wincrypt.h>
+#elif defined(OS_MACOSX)
+#include <CoreFoundation/CFArray.h>
+#include <Security/SecTrust.h>
+#include "base/mac/scoped_cftyperef.h"
+#endif
+
+namespace base {
+class FilePath;
+}
+
+namespace net {
+
+class X509Certificate;
+
+// TestRootCerts is a helper class for unit tests that is used to
+// artificially mark a certificate as trusted, independent of the local
+// machine configuration.
+class NET_EXPORT_PRIVATE TestRootCerts {
+ public:
+ // Obtains the Singleton instance to the trusted certificates.
+ static TestRootCerts* GetInstance();
+
+ // Returns true if an instance exists, without forcing an initialization.
+ static bool HasInstance();
+
+ // Marks |certificate| as trusted for X509Certificate::Verify(). Returns
+ // false if the certificate could not be marked trusted.
+ bool Add(X509Certificate* certificate);
+
+ // Reads a single certificate from |file| and marks it as trusted. Returns
+ // false if an error is encountered, such as being unable to read |file|
+ // or more than one certificate existing in |file|.
+ bool AddFromFile(const base::FilePath& file);
+
+ // Clears the trusted status of any certificates that were previously
+ // marked trusted via Add().
+ void Clear();
+
+ // Returns true if there are no certificates that have been marked trusted.
+ bool IsEmpty() const;
+
+#if defined(OS_MACOSX) && !defined(OS_IOS)
+ CFArrayRef temporary_roots() const { return temporary_roots_; }
+
+ // Modifies the root certificates of |trust_ref| to include the
+ // certificates stored in |temporary_roots_|. If IsEmpty() is true, this
+ // does not modify |trust_ref|.
+ OSStatus FixupSecTrustRef(SecTrustRef trust_ref) const;
+
+ // Configures whether or not the default/system root store should also
+ // be trusted. By default, this is true, indicating that the TestRootCerts
+ // are used in addition to OS trust store.
+ void SetAllowSystemTrust(bool allow_system_trust);
+
+#elif defined(OS_WIN)
+ HCERTSTORE temporary_roots() const { return temporary_roots_; }
+
+ // Returns an HCERTCHAINENGINE suitable to be used for certificate
+ // validation routines, or NULL to indicate that the default system chain
+ // engine is appropriate. The caller is responsible for freeing the
+ // returned HCERTCHAINENGINE.
+ HCERTCHAINENGINE GetChainEngine() const;
+#endif
+
+ private:
+ friend struct base::DefaultLazyInstanceTraits<TestRootCerts>;
+
+ TestRootCerts();
+ ~TestRootCerts();
+
+ // Performs platform-dependent initialization.
+ void Init();
+
+#if defined(USE_NSS) || defined(OS_IOS)
+ // It is necessary to maintain a cache of the original certificate trust
+ // settings, in order to restore them when Clear() is called.
+ class TrustEntry;
+ std::list<TrustEntry*> trust_cache_;
+#elif defined(OS_WIN)
+ HCERTSTORE temporary_roots_;
+#elif defined(OS_MACOSX)
+ base::ScopedCFTypeRef<CFMutableArrayRef> temporary_roots_;
+ bool allow_system_trust_;
+#endif
+
+#if defined(OS_WIN) || defined(USE_OPENSSL)
+ // True if there are no temporarily trusted root certificates.
+ bool empty_;
+#endif
+
+ DISALLOW_COPY_AND_ASSIGN(TestRootCerts);
+};
+
+// Scoped helper for unittests to handle safely managing trusted roots.
+class NET_EXPORT_PRIVATE ScopedTestRoot {
+ public:
+ ScopedTestRoot();
+ // Creates a ScopedTestRoot that will adds|cert| to the TestRootCerts store.
+ explicit ScopedTestRoot(X509Certificate* cert);
+ ~ScopedTestRoot();
+
+ // Assigns |cert| to be the new test root cert. If |cert| is NULL, undoes
+ // any work the ScopedTestRoot may have previously done.
+ // If |cert_| contains a certificate (due to a prior call to Reset or due to
+ // a cert being passed at construction), the existing TestRootCerts store is
+ // cleared.
+ void Reset(X509Certificate* cert);
+
+ private:
+ scoped_refptr<X509Certificate> cert_;
+
+ DISALLOW_COPY_AND_ASSIGN(ScopedTestRoot);
+};
+
+} // namespace net
+
+#endif // NET_CERT_TEST_ROOT_CERTS_H_