certificate-cache.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_SECURITY_CERTIFICATE_CACHE_HPP
#define NDN_CXX_SECURITY_CERTIFICATE_CACHE_HPP
 
#include "ndn-cxx/interest.hpp"
#include "ndn-cxx/security/certificate.hpp"
 
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/member.hpp>
 
namespace ndn::security {
 
class CertificateCache : noncopyable
{
public:
  explicit
  CertificateCache(const time::nanoseconds& maxLifetime = getDefaultLifetime());
 
  void
  insert(const Certificate& cert);
 
  void
  clear();
 
  const Certificate*
  find(const Name& certPrefix) const;
 
  const Certificate*
  find(const Interest& interest) const;
 
private:
  class Entry
  {
  public:
    explicit
    Entry(const Certificate& cert, const time::system_clock::time_point& removalTime)
      : cert(cert)
      , removalTime(removalTime)
    {
    }
 
    const Name&
    getCertName() const
    {
      return cert.getName();
    }
 
  public:
    Certificate cert;
    time::system_clock::time_point removalTime;
  };
 
  void
  refresh();
 
public:
  static constexpr time::nanoseconds
  getDefaultLifetime() noexcept
  {
    return 1_h;
  }
 
private:
  using CertIndex = boost::multi_index::multi_index_container<
    Entry,
    boost::multi_index::indexed_by<
      boost::multi_index::ordered_non_unique<
        boost::multi_index::member<Entry, const time::system_clock::time_point, &Entry::removalTime>
      >,
      boost::multi_index::ordered_unique<
        boost::multi_index::const_mem_fun<Entry, const Name&, &Entry::getCertName>
      >
    >
  >;
  using CertIndexByTime = CertIndex::nth_index<0>::type;
  using CertIndexByName = CertIndex::nth_index<1>::type;
 
  CertIndex m_certs;
  CertIndexByTime& m_certsByTime;
  CertIndexByName& m_certsByName;
  time::nanoseconds m_maxLifetime;
};
 
} // namespace ndn::security
 
#endif // NDN_CXX_SECURITY_CERTIFICATE_CACHE_HPP