validation-policy-config.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2023 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_CXX_SECURITY_VALIDATION_POLICY_CONFIG_HPP
23 #define NDN_CXX_SECURITY_VALIDATION_POLICY_CONFIG_HPP
24 
27 
28 namespace ndn::security {
29 namespace validator_config {
30 
41 {
42 public:
47  void
48  load(const std::string& filename);
49 
54  void
55  load(const std::string& input, const std::string& filename);
56 
61  void
62  load(std::istream& input, const std::string& filename);
63 
68  void
69  load(const ConfigSection& configSection, const std::string& filename);
70 
71 protected:
72  void
73  checkPolicy(const Data& data, const shared_ptr<ValidationState>& state,
74  const ValidationContinuation& continueValidation) override;
75 
76  void
77  checkPolicy(const Interest& interest, const shared_ptr<ValidationState>& state,
78  const ValidationContinuation& continueValidation) override;
79 
80 private:
81  void
82  processConfigTrustAnchor(const ConfigSection& section, const std::string& filename);
83 
85  getRefreshPeriod(ConfigSection::const_iterator& it, const ConfigSection::const_iterator& end);
86 
88  getDefaultRefreshPeriod();
89 
96  bool m_shouldBypass = false;
97  bool m_isConfigured = false;
98 
99  std::vector<unique_ptr<Rule>> m_dataRules;
100  std::vector<unique_ptr<Rule>> m_interestRules;
101 };
102 
103 } // namespace validator_config
104 
106 
107 } // namespace ndn::security
108 
109 #endif // NDN_CXX_SECURITY_VALIDATION_POLICY_CONFIG_HPP
Represents a Data packet.
Definition: data.hpp:39
Represents an Interest packet.
Definition: interest.hpp:50
Abstraction that implements a validation policy for Interest and Data packets.
std::function< void(const shared_ptr< CertificateRequest > &certRequest, const shared_ptr< ValidationState > &state)> ValidationContinuation
A validator that can be set up via a configuration file.
void load(const std::string &filename)
Load policy from file filename.
void checkPolicy(const Data &data, const shared_ptr< ValidationState > &state, const ValidationContinuation &continueValidation) override
Check data against the policy.
#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:49
boost::property_tree::ptree ConfigSection
Definition: common.hpp:33
Contains the ndn-cxx security framework.
::boost::chrono::nanoseconds nanoseconds
Definition: time.hpp:54