blob: 347d2f0bb1dde960042f96af08acdbc6b6068db2 [file] [log] [blame]
// Copyright (c) 2014 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 <string>
#include "base/callback.h"
#include "base/containers/hash_tables.h"
#include "base/containers/mru_cache.h"
#include "base/memory/weak_ptr.h"
#include "net/base/net_export.h"
#include "net/cert/x509_certificate.h"
namespace disk_cache {
class Backend;
} // namespace disk_cache
namespace net {
// DiskBasedCertCache is used to store and retrieve X.509 certificates from the
// cache. Each individual certificate is stored separately from its certificate
// chain. No more than one copy (per certificate) will be stored on disk.
class NET_EXPORT_PRIVATE DiskBasedCertCache {
typedef base::Callback<void(const X509Certificate::OSCertHandle cert_handle)>
typedef base::Callback<void(const std::string&)> SetCallback;
// Initializes a new DiskBasedCertCache that will access the disk cache via
// |backend|.
explicit DiskBasedCertCache(disk_cache::Backend* backend);
// Fetches the certificate associated with |key|. If the certificate is
// found within the cache, |cb| will be called with the certificate.
// Otherwise, |cb| will be called with NULL. Callers that wish to store
// a reference to the certificate need to use X509Certificate::DupOSCertHandle
// inside |cb|.
void GetCertificate(const std::string& key, const GetCallback& cb);
// Stores |cert_handle| in the cache. If |cert_handle| is successfully stored,
// |cb| will be called with the key. If |cb| is called with an empty
// string, then |cert_handle| was not stored.
void SetCertificate(const X509Certificate::OSCertHandle cert_handle,
const SetCallback& cb);
// Returns the number of in-memory MRU cache hits that have occurred
// on SetCertificate and GetCertificate operations. Intended for test purposes
// only.
size_t mem_cache_hits_for_testing() const { return mem_cache_hits_; }
// Returns the number of in-memory MRU cache misses that have occurred
// on SetCertificate and GetCertificate operations. Intended for test purposes
// only.
size_t mem_cache_misses_for_testing() const { return mem_cache_misses_; }
class ReadWorker;
class WriteWorker;
// A functor used to free an OSCertHandle. Used by the MRUCertCache.
struct CertFree {
void operator()(X509Certificate::OSCertHandle cert_handle);
// An in-memory cache that is used to prevent redundantly reading
// from disk.
typedef base::MRUCacheBase<std::string,
CertFree> MRUCertCache;
// ReadWorkerMap and WriteWorkerMap map cache keys to their
// corresponding Workers.
typedef base::hash_map<std::string, ReadWorker*> ReadWorkerMap;
typedef base::hash_map<std::string, WriteWorker*> WriteWorkerMap;
// FinishedReadOperation and FinishedWriteOperation are used to remove
// workers from their respective worker maps, and perform other necessary
// cleanup. They are called from the workers via callback.
void FinishedReadOperation(const std::string& key,
X509Certificate::OSCertHandle cert_handle);
void FinishedWriteOperation(const std::string& key,
X509Certificate::OSCertHandle cert_handle);
disk_cache::Backend* backend_;
ReadWorkerMap read_worker_map_;
WriteWorkerMap write_worker_map_;
MRUCertCache mru_cert_cache_;
int mem_cache_hits_;
int mem_cache_misses_;
base::WeakPtrFactory<DiskBasedCertCache> weak_factory_;
} // namespace net