Move caching out of MultiThreadedCertVerifier

net/cert/caching_cert_verifier.cc

Index: net/cert/caching_cert_verifier.cc
diff --git a/net/cert/caching_cert_verifier.cc b/net/cert/caching_cert_verifier.cc
new file mode 100644
index 0000000000000000000000000000000000000000..733d87867c350d50096bc8b4451b1c2246e378dd
--- /dev/null
+++ b/net/cert/caching_cert_verifier.cc
@@ -0,0 +1,196 @@
+// Copyright 2016 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 "net/cert/caching_cert_verifier.h"
+
+#include "base/time/time.h"
+#include "net/base/net_errors.h"
+#include "net/cert/cert_trust_anchor_provider.h"
+
+namespace net {
+
+namespace {
+
+// The maximum number of cache entries to use for the ExpiringCache.
+const unsigned kMaxCacheEntries = 256;
+
+// The number of seconds to cache entries.
+const unsigned kTTLSecs = 1800;  // 30 minutes.
+
+}  // namespace
+
+CachingCertVerifier::CachingCertVerifier(std::unique_ptr<CertVerifier> verifier)
+    : verifier_(std::move(verifier)),
+      trust_anchor_provider_(nullptr),
+      cache_(kMaxCacheEntries),
+      requests_(0u),
+      cache_hits_(0u) {
+  CertDatabase::GetInstance()->AddObserver(this);
+}
+
+CachingCertVerifier::~CachingCertVerifier() {
+  CertDatabase::GetInstance()->RemoveObserver(this);
+}
+
+void CachingCertVerifier::SetCertTrustAnchorProvider(
+    CertTrustAnchorProvider* trust_anchor_provider) {
+  DCHECK(!trust_anchor_provider_);
+  trust_anchor_provider_ = trust_anchor_provider;
+}
+
+int CachingCertVerifier::Verify(const CertVerifier::RequestParams& params,
+                                CRLSet* crl_set,
+                                CertVerifyResult* verify_result,
+                                const CompletionCallback& callback,
+                                std::unique_ptr<Request>* out_req,
+                                const BoundNetLog& net_log) {
+  out_req->reset();
+
+  requests_++;
+
+  CertificateList additional_trust_anchors(params.additional_trust_anchors());

[eroman, 2016/06/10 00:08:03]

This is... eeew.

I realize this CL doesn't introduce the concept of trust anchor provider, nor
this approach for duplicating the RequestParams to inject the extra anchors. But
it gets weirder with this layering since the SetCertTrustAnchorProvider() is now
a concept of just the CachingCertVerifier(). So for instance you couldn't simply
remove CachingCertVerifier from the chain of verifiers, as its
SetCertTrustAnchorProvider() method is relied on (at least on Chrome OS).

Do you have a timeline for removing CertTrustAnchorProvider from Chrome OS?

Assuming this is going to linger on in the mid-term, I suggest hiding this
through yet another layer of CertVerififer. As a strawman how about:

new CertVerifierWithAdditionalTrustAnchors(
    trust_anchor_provider,
    new CachingCertVerifier(new MultiThreadedCertVerifier));

Here CertVerifierWithAdditionalTrustAnchors() would be a very simple verifier
that just retrieves the extra trust anchors and forwards a (possibly modified)
RequestParams on to the next verifier in the chain.

In the non-Chrome OS case we wouldn't need to instantiate a
CertVerifierWithAdditionalTrustAnchors.

[Ryan Sleevi, 2016/06/10 00:41:10]

Right after the Symantec stuff finishes or, if that ends up getting stalled on
reviews, during.

I want to kill it with fire, and have a plan to, but didn't want to take on
another cleanup CL (and load you or David up with more), especially when I've
got some higher priority stuff to burn.

Sorry, I thought I made it clearer on one of the other CLs that I'm
super-grossed out by this as well, and it needs to live up in the ChromeOS code
and the world will be happier.
That's actually what I have in a local branch before I stopped for travel.

[eroman, 2016/06/10 01:26:38]

OK, sounds good as is then.

I knew you weren't fond of it, but wanted to confirm this was just a temporary
hack and not something that would get stuck in the CachingCertVerifier.

+  if (trust_anchor_provider_) {
+    const CertificateList& trust_anchors =
+        trust_anchor_provider_->GetAdditionalTrustAnchors();
+    additional_trust_anchors.insert(additional_trust_anchors.begin(),
+                                    trust_anchors.begin(), trust_anchors.end());
+  }
+
+  const CertVerifier::RequestParams new_params(
+      params.certificate(), params.hostname(), params.flags(),
+      params.ocsp_response(), additional_trust_anchors);
+  const CertVerificationCache::value_type* cached_entry =
+      cache_.Get(new_params, CacheValidityPeriod(base::Time::Now()));
+  if (cached_entry) {
+    ++cache_hits_;
+    *verify_result = cached_entry->result;
+    return cached_entry->error;
+  }
+
+  base::Time start_time = base::Time::Now();
+  CompletionCallback caching_callback = base::Bind(
+      &CachingCertVerifier::OnRequestFinished, base::Unretained(this),
+      new_params, start_time, callback, verify_result);
+  int result = verifier_->Verify(new_params, crl_set, verify_result,
+                                 caching_callback, out_req, net_log);
+  if (result != ERR_IO_PENDING) {
+    // Synchronous completion; add directly to cache.
+    AddResultToCache(new_params, start_time, *verify_result, result);
+  }
+
+  return result;
+}
+
+bool CachingCertVerifier::SupportsOCSPStapling() {
+  return verifier_->SupportsOCSPStapling();
+}
+
+CachingCertVerifier::CachedResult::CachedResult() : error(ERR_FAILED) {}
+
+CachingCertVerifier::CachedResult::~CachedResult() {}
+
+CachingCertVerifier::CacheValidityPeriod::CacheValidityPeriod(base::Time now)
+    : verification_time(now), expiration_time(now) {}
+
+CachingCertVerifier::CacheValidityPeriod::CacheValidityPeriod(
+    base::Time now,
+    base::Time expiration)
+    : verification_time(now), expiration_time(expiration) {}
+
+bool CachingCertVerifier::CacheExpirationFunctor::operator()(
+    const CacheValidityPeriod& now,
+    const CacheValidityPeriod& expiration) const {
+  // Ensure this functor is being used for expiration only, and not strict
+  // weak ordering/sorting. |now| should only ever contain a single
+  // base::Time.
+  // Note: DCHECK_EQ is not used due to operator<< overloading requirements.
+  DCHECK(now.verification_time == now.expiration_time);
+
+  // |now| contains only a single time (verification_time), while |expiration|
+  // contains the validity range - both when the certificate was verified and
+  // when the verification result should expire.
+  //
+  // If the user receives a "not yet valid" message, and adjusts their clock
+  // foward to the correct time, this will (typically) cause
+  // now.verification_time to advance past expiration.expiration_time, thus
+  // treating the cached result as an expired entry and re-verifying.
+  // If the user receives a "expired" message, and adjusts their clock
+  // backwards to the correct time, this will cause now.verification_time to
+  // be less than expiration_verification_time, thus treating the cached
+  // result as an expired entry and re-verifying.
+  // If the user receives either of those messages, and does not adjust their
+  // clock, then the result will be (typically) be cached until the expiration
+  // TTL.
+  //
+  // This algorithm is only problematic if the user consistently keeps
+  // adjusting their clock backwards in increments smaller than the expiration
+  // TTL, in which case, cached elements continue to be added. However,
+  // because the cache has a fixed upper bound, if no entries are expired, a
+  // 'random' entry will be, thus keeping the memory constraints bounded over
+  // time.
+  return now.verification_time >= expiration.verification_time &&
+         now.verification_time < expiration.expiration_time;
+};
+
+void CachingCertVerifier::OnRequestFinished(const RequestParams& params,
+                                            base::Time start_time,
+                                            const CompletionCallback& callback,
+                                            CertVerifyResult* verify_result,
+                                            int error) {
+  AddResultToCache(params, start_time, *verify_result, error);
+
+  // Now chain to the user's callback, which may delete |this|.
+  callback.Run(error);
+}
+
+void CachingCertVerifier::AddResultToCache(
+    const RequestParams& params,
+    base::Time start_time,
+    const CertVerifyResult& verify_result,
+    int error) {
+  // When caching, this uses the time that validation started as the
+  // beginning of the validity, rather than the time that it ended (aka
+  // base::Time::Now()), to account for the fact that during validation,
+  // the clock may have changed.
+  //
+  // If the clock has changed significantly, then this result will ideally
+  // be evicted and the next time the certificate is encountered, it will
+  // be revalidated.
+  //
+  // Because of this, it's possible for situations to arise where the
+  // clock was correct at the start of validation, changed to an
+  // incorrect time during validation (such as too far in the past or
+  // future), and then was reset to the correct time. If this happens,
+  // it's likely that the result will not be a valid/correct result,
+  // but will still be used from the cache because the clock was reset
+  // to the correct time after the (bad) validation result completed.
+  //
+  // However, this solution optimizes for the case where the clock is
+  // bad at the start of validation, and subsequently is corrected. In
+  // that situation, the result is also incorrect, but because the clock
+  // was corrected after validation, if the cache validity period was
+  // computed at the end of validation, it would continue to serve an
+  // invalid result for kTTLSecs.
+  CachedResult cached_result;
+  cached_result.error = error;
+  cached_result.result = verify_result;
+  cache_.Put(
+      params, cached_result, CacheValidityPeriod(start_time),
+      CacheValidityPeriod(start_time,
+                          start_time + base::TimeDelta::FromSeconds(kTTLSecs)));
+}
+
+void CachingCertVerifier::OnCACertChanged(const X509Certificate* cert) {
+  ClearCache();
+}
+
+void CachingCertVerifier::ClearCache() {
+  cache_.Clear();
+}
+
+size_t CachingCertVerifier::GetCacheSize() const {
+  return cache_.size();
+}
+
+}  // namespace net