NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
trust-anchor-group.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 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 
22 #ifndef NDN_SECURITY_V2_TRUST_ANCHOR_GROUP_HPP
23 #define NDN_SECURITY_V2_TRUST_ANCHOR_GROUP_HPP
24 
25 #include "ndn-cxx/data.hpp"
27 
28 #include <boost/filesystem/path.hpp>
29 #include <set>
30 
31 namespace ndn {
32 namespace security {
33 namespace v2 {
34 
36 {
37 public:
38  virtual
40 
41  virtual void
42  add(Certificate&& cert) = 0;
43 
44  virtual void
45  remove(const Name& certName) = 0;
46 };
47 
51 class TrustAnchorGroup : noncopyable
52 {
53 public:
57  TrustAnchorGroup(CertContainerInterface& certContainer, const std::string& id);
58 
59  virtual
61 
65  const std::string&
66  getId() const
67  {
68  return m_id;
69  }
70 
74  size_t
75  size() const;
76 
80  virtual void
81  refresh();
82 
83 protected:
85  std::set<Name> m_anchorNames;
86 
87 private:
88  std::string m_id;
89 };
90 
95 {
96 public:
102  StaticTrustAnchorGroup(CertContainerInterface& certContainer, const std::string& id);
103 
107  void
108  add(Certificate&& cert);
109 
113  void
114  remove(const Name& certName);
115 };
116 
121 {
122 public:
152  DynamicTrustAnchorGroup(CertContainerInterface& certContainer, const std::string& id,
153  const boost::filesystem::path& path, time::nanoseconds refreshPeriod,
154  bool isDir = false);
155 
156  void
157  refresh() override;
158 
159 private:
160  bool m_isDir;
161  boost::filesystem::path m_path;
162  time::nanoseconds m_refreshPeriod;
163  time::steady_clock::TimePoint m_expireTime;
164 };
165 
166 } // namespace v2
167 } // namespace security
168 } // namespace ndn
169 
170 #endif // NDN_SECURITY_V2_TRUST_ANCHOR_GROUP_HPP
ndn::security::v2::CertContainerInterface
Definition: trust-anchor-group.hpp:36
certificate.hpp
ndn::security::v2::TrustAnchorGroup::TrustAnchorGroup
TrustAnchorGroup(CertContainerInterface &certContainer, const std::string &id)
Create an anchor group.
Definition: trust-anchor-group.cpp:39
ndn::security::v2::CertContainerInterface::~CertContainerInterface
virtual ~CertContainerInterface()=default
ndn::security::v2::StaticTrustAnchorGroup::remove
void remove(const Name &certName)
Remove static anchor certName.
Definition: trust-anchor-group.cpp:78
ndn::security::v2::TrustAnchorGroup
A group of trust anchors.
Definition: trust-anchor-group.hpp:52
ndn::security::v2::TrustAnchorGroup::size
size_t size() const
Definition: trust-anchor-group.cpp:48
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
ndn::security::v2::Certificate
The certificate following the certificate format naming convention.
Definition: certificate.hpp:82
ndn::security::v2::StaticTrustAnchorGroup::StaticTrustAnchorGroup
StaticTrustAnchorGroup(CertContainerInterface &certContainer, const std::string &id)
Create a static trust anchor group.
Definition: trust-anchor-group.cpp:61
ndn::security::v2::StaticTrustAnchorGroup::add
void add(Certificate &&cert)
Load static anchor cert.
Definition: trust-anchor-group.cpp:67
ndn::security::v2::DynamicTrustAnchorGroup
Dynamic trust anchor group.
Definition: trust-anchor-group.hpp:121
ndn::security::v2::TrustAnchorGroup::m_anchorNames
std::set< Name > m_anchorNames
Definition: trust-anchor-group.hpp:85
ndn::security::v2::TrustAnchorGroup::m_certs
CertContainerInterface & m_certs
Definition: trust-anchor-group.hpp:84
ndn::security::v2::TrustAnchorGroup::refresh
virtual void refresh()
Request certificate refresh.
Definition: trust-anchor-group.cpp:54
ndn::time::steady_clock::TimePoint
time_point TimePoint
Definition: time.hpp:225
ndn::security::v2::CertContainerInterface::remove
virtual void remove(const Name &certName)=0
data.hpp
ndn::security::v2::DynamicTrustAnchorGroup::refresh
void refresh() override
Request certificate refresh.
Definition: trust-anchor-group.cpp:104
ndn::security::v2::TrustAnchorGroup::~TrustAnchorGroup
virtual ~TrustAnchorGroup()
ndn::security::v2::StaticTrustAnchorGroup
Static trust anchor group.
Definition: trust-anchor-group.hpp:95
ndn::security::v2::CertContainerInterface::add
virtual void add(Certificate &&cert)=0
ndn::security::v2::DynamicTrustAnchorGroup::DynamicTrustAnchorGroup
DynamicTrustAnchorGroup(CertContainerInterface &certContainer, const std::string &id, const boost::filesystem::path &path, time::nanoseconds refreshPeriod, bool isDir=false)
Create a dynamic trust anchor group.
Definition: trust-anchor-group.cpp:86
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34
ndn::security::v2::TrustAnchorGroup::getId
const std::string & getId() const
Definition: trust-anchor-group.hpp:66