NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
certificate-cache.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2020 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
23 #include "ndn-cxx/util/logger.hpp"
24 
25 namespace ndn {
26 namespace security {
27 inline namespace v2 {
28 
29 NDN_LOG_INIT(ndn.security.CertificateCache);
30 
33 {
34  return 1_h;
35 }
36 
38  : m_certsByTime(m_certs.get<0>())
39  , m_certsByName(m_certs.get<1>())
40  , m_maxLifetime(maxLifetime)
41 {
42 }
43 
44 void
46 {
47  time::system_clock::TimePoint notAfterTime = cert.getValidityPeriod().getPeriod().second;
49  if (notAfterTime < now) {
50  NDN_LOG_DEBUG("Not adding " << cert.getName() << ": already expired at " << time::toIsoString(notAfterTime));
51  return;
52  }
53 
54  time::system_clock::TimePoint removalTime = std::min(notAfterTime, now + m_maxLifetime);
55  NDN_LOG_DEBUG("Adding " << cert.getName() << ", will remove in "
56  << time::duration_cast<time::seconds>(removalTime - now));
57  m_certs.insert(Entry(cert, removalTime));
58 }
59 
60 void
62 {
63  m_certs.clear();
64 }
65 
66 const Certificate*
67 CertificateCache::find(const Name& certPrefix) const
68 {
69  const_cast<CertificateCache*>(this)->refresh();
70  if (certPrefix.size() > 0 && certPrefix[-1].isImplicitSha256Digest()) {
71  NDN_LOG_INFO("Certificate search using name with the implicit digest is not yet supported");
72  }
73  auto itr = m_certsByName.lower_bound(certPrefix);
74  if (itr == m_certsByName.end() || !certPrefix.isPrefixOf(itr->getCertName()))
75  return nullptr;
76  return &itr->cert;
77 }
78 
79 const Certificate*
80 CertificateCache::find(const Interest& interest) const
81 {
82  if (interest.getName().size() > 0 && interest.getName()[-1].isImplicitSha256Digest()) {
83  NDN_LOG_INFO("Certificate search using name with implicit digest is not yet supported");
84  }
85  const_cast<CertificateCache*>(this)->refresh();
86 
87  for (auto i = m_certsByName.lower_bound(interest.getName());
88  i != m_certsByName.end() && interest.getName().isPrefixOf(i->getCertName());
89  ++i) {
90  const auto& cert = i->cert;
91  if (interest.matchesData(cert)) {
92  return &cert;
93  }
94  }
95  return nullptr;
96 }
97 
98 void
99 CertificateCache::refresh()
100 {
102 
103  auto cIt = m_certsByTime.begin();
104  while (cIt != m_certsByTime.end() && cIt->removalTime < now) {
105  m_certsByTime.erase(cIt);
106  cIt = m_certsByTime.begin();
107  }
108 }
109 
110 } // inline namespace v2
111 } // namespace security
112 } // namespace ndn
boost::chrono::seconds seconds
Definition: time.hpp:47
Copyright (c) 2011-2015 Regents of the University of California.
Represents an NDN certificate following the version 2.0 format.
Definition: certificate.hpp:60
const Certificate * find(const Name &certPrefix) const
Get certificate given key name.
bool isPrefixOf(const Name &other) const
Check if this name is a prefix of another name.
Definition: name.cpp:300
#define NDN_LOG_DEBUG(expression)
Definition: logger.hpp:99
R & get(variant< T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15 > &v, nonstd_lite_in_place_type_t(R)=nonstd_lite_in_place_type(R))
void clear()
Remove all certificates from cache.
Represents an Interest packet.
Definition: interest.hpp:48
static time::nanoseconds getDefaultLifetime()
static time_point now() noexcept
Definition: time.cpp:46
Represents a container for verified certificates.
CertificateCache(const time::nanoseconds &maxLifetime=getDefaultLifetime())
Create an object for certificate cache.
std::pair< time::system_clock::TimePoint, time::system_clock::TimePoint > getPeriod() const
Get the stored validity period.
#define NDN_LOG_INFO(expression)
Definition: logger.hpp:100
bool matchesData(const Data &data) const
Check if Interest can be satisfied by data.
Definition: interest.cpp:325
const Name & getName() const noexcept
Get name.
Definition: data.hpp:127
Represents an absolute name.
Definition: name.hpp:41
size_t size() const
Returns the number of components.
Definition: name.hpp:151
std::string toIsoString(const system_clock::time_point &timePoint)
Convert to the ISO 8601 string representation, basic format (YYYYMMDDTHHMMSS,fffffffff).
Definition: time.cpp:143
void insert(const Certificate &cert)
Insert certificate into cache.
const Name & getName() const noexcept
Definition: interest.hpp:172
#define NDN_LOG_INIT(name)
declare a log module
Definition: logger.hpp:81
ValidityPeriod getValidityPeriod() const
Get validity period of the certificate.
boost::chrono::nanoseconds nanoseconds
Definition: time.hpp:50
time_point TimePoint
Definition: time.hpp:203