Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /* |
Junxiao Shi | 58b9e0f | 2021-03-18 15:54:07 -0600 | [diff] [blame] | 3 | * Copyright (c) 2013-2021 Regents of the University of California. |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 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 | |
Alexander Afanasyev | 09236c2 | 2020-06-03 13:42:38 -0400 | [diff] [blame] | 22 | #include "ndn-cxx/security/validator-config/rule.hpp" |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 23 | |
Davide Pesavento | 7e78064 | 2018-11-24 15:51:34 -0500 | [diff] [blame] | 24 | #include "tests/boost-test.hpp" |
Alexander Afanasyev | 09236c2 | 2020-06-03 13:42:38 -0400 | [diff] [blame] | 25 | #include "tests/unit/security/validator-fixture.hpp" |
| 26 | #include "tests/unit/security/validator-config/common.hpp" |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 27 | |
| 28 | #include <boost/mpl/vector_c.hpp> |
| 29 | |
| 30 | namespace ndn { |
| 31 | namespace security { |
Alexander Afanasyev | 09236c2 | 2020-06-03 13:42:38 -0400 | [diff] [blame] | 32 | inline namespace v2 { |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 33 | namespace validator_config { |
| 34 | namespace tests { |
| 35 | |
| 36 | using namespace ndn::tests; |
| 37 | using namespace ndn::security::v2::tests; |
| 38 | |
| 39 | BOOST_AUTO_TEST_SUITE(Security) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 40 | BOOST_AUTO_TEST_SUITE(ValidatorConfig) |
| 41 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 42 | template<class Packet> |
Davide Pesavento | 4c1ad4c | 2020-11-16 21:12:02 -0500 | [diff] [blame] | 43 | class RuleFixture : public KeyChainFixture |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 44 | { |
| 45 | public: |
| 46 | RuleFixture() |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 47 | : rule(ruleId, Packet::getType()) |
| 48 | , pktName(Packet::makeName("/foo/bar", m_keyChain)) |
| 49 | , state(Packet::makeState()) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 50 | { |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 51 | } |
| 52 | |
| 53 | public: |
| 54 | const std::string ruleId = "rule-id"; |
| 55 | Rule rule; |
| 56 | Name pktName; |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 57 | shared_ptr<ValidationState> state; |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 58 | }; |
| 59 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 60 | using PktTypes = boost::mpl::vector<DataPkt, InterestV02Pkt, InterestV03Pkt>; |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 61 | |
| 62 | BOOST_AUTO_TEST_SUITE(TestRule) |
| 63 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 64 | BOOST_FIXTURE_TEST_CASE(Errors, RuleFixture<DataPkt>) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 65 | { |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 66 | BOOST_CHECK_THROW(rule.match(tlv::Interest, this->pktName, state), Error); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 67 | BOOST_CHECK_THROW(rule.check(tlv::Interest, this->pktName, "/foo/bar", state), Error); |
| 68 | } |
| 69 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 70 | BOOST_FIXTURE_TEST_CASE_TEMPLATE(Constructor, PktType, PktTypes, RuleFixture<PktType>) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 71 | { |
| 72 | BOOST_CHECK_EQUAL(this->rule.getId(), this->ruleId); |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 73 | BOOST_CHECK_EQUAL(this->rule.getPktType(), PktType::getType()); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 74 | } |
| 75 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 76 | BOOST_FIXTURE_TEST_CASE_TEMPLATE(EmptyRule, PktType, PktTypes, RuleFixture<PktType>) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 77 | { |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 78 | BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), this->pktName, this->state), true); |
| 79 | BOOST_CHECK_EQUAL(this->rule.check(PktType::getType(), this->pktName, "/foo/bar", this->state), false); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 80 | } |
| 81 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 82 | BOOST_FIXTURE_TEST_CASE_TEMPLATE(Filters, PktType, PktTypes, RuleFixture<PktType>) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 83 | { |
| 84 | this->rule.addFilter(make_unique<RegexNameFilter>(Regex("^<foo><bar>$"))); |
| 85 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 86 | BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), this->pktName, this->state), true); |
| 87 | BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), "/not" + this->pktName.toUri(), this->state), false); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 88 | |
| 89 | this->rule.addFilter(make_unique<RegexNameFilter>(Regex("^<not><foo><bar>$"))); |
| 90 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 91 | BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), this->pktName, this->state), true); |
| 92 | BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), "/not" + this->pktName.toUri(), this->state), true); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 93 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 94 | BOOST_CHECK_EQUAL(this->rule.check(PktType::getType(), this->pktName, "/foo/bar", this->state), false); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 95 | } |
| 96 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 97 | BOOST_FIXTURE_TEST_CASE_TEMPLATE(Checkers, PktType, PktTypes, RuleFixture<PktType>) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 98 | { |
Junxiao Shi | 58b9e0f | 2021-03-18 15:54:07 -0600 | [diff] [blame] | 99 | auto testChecker = [this] (const Name& klName, bool expectedOutcome) { |
| 100 | BOOST_TEST_CONTEXT(klName << " expected=" << expectedOutcome) { |
| 101 | this->state = PktType::makeState(); // reset state |
| 102 | BOOST_CHECK_EQUAL(this->rule.check(PktType::getType(), this->pktName, klName, this->state), |
| 103 | expectedOutcome); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 104 | |
Junxiao Shi | 58b9e0f | 2021-03-18 15:54:07 -0600 | [diff] [blame] | 105 | auto outcome = this->state->getOutcome(); |
| 106 | if (expectedOutcome) { |
| 107 | BOOST_CHECK(boost::logic::indeterminate(outcome)); |
| 108 | } |
| 109 | else { |
| 110 | BOOST_CHECK(!boost::logic::indeterminate(outcome)); |
| 111 | BOOST_CHECK(!bool(outcome)); |
| 112 | } |
| 113 | } |
| 114 | }; |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 115 | |
| 116 | this->rule.addChecker(make_unique<HyperRelationChecker>("^(<>+)$", "\\1", |
Junxiao Shi | 58b9e0f | 2021-03-18 15:54:07 -0600 | [diff] [blame] | 117 | "^<always>(<>+)$", "\\1", |
| 118 | NameRelation::EQUAL)); |
| 119 | testChecker("/always/foo/bar", true); |
| 120 | testChecker("/seldomly/foo/bar", false); |
| 121 | testChecker("/never/foo/bar", false); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 122 | |
Junxiao Shi | 58b9e0f | 2021-03-18 15:54:07 -0600 | [diff] [blame] | 123 | this->rule.addChecker(make_unique<HyperRelationChecker>("^(<>+)$", "\\1", |
| 124 | "^<seldomly>(<>+)$", "\\1", |
| 125 | NameRelation::EQUAL)); |
| 126 | testChecker("/always/foo/bar", true); |
| 127 | testChecker("/seldomly/foo/bar", true); |
| 128 | testChecker("/never/foo/bar", false); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | BOOST_AUTO_TEST_SUITE(Create) |
| 132 | |
| 133 | BOOST_AUTO_TEST_CASE(Errors) |
| 134 | { |
| 135 | BOOST_CHECK_THROW(Rule::create(makeSection(""), "test-config"), Error); |
| 136 | |
| 137 | std::string config = R"CONF( |
| 138 | id rule-id |
| 139 | for something |
| 140 | )CONF"; |
| 141 | BOOST_CHECK_THROW(Rule::create(makeSection(config), "test-config"), Error); |
| 142 | |
| 143 | config = R"CONF( |
| 144 | id rule-id |
| 145 | for data |
| 146 | )CONF"; |
| 147 | BOOST_CHECK_THROW(Rule::create(makeSection(config), "test-config"), Error); // at least one checker required |
| 148 | |
| 149 | config = R"CONF( |
| 150 | id rule-id |
| 151 | for data |
| 152 | checker |
| 153 | { |
| 154 | type hierarchical |
| 155 | sig-type rsa-sha256 |
| 156 | } |
| 157 | other stuff |
| 158 | )CONF"; |
| 159 | BOOST_CHECK_THROW(Rule::create(makeSection(config), "test-config"), Error); |
| 160 | } |
| 161 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 162 | BOOST_FIXTURE_TEST_CASE_TEMPLATE(FilterAndChecker, PktType, PktTypes, RuleFixture<PktType>) |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 163 | { |
Davide Pesavento | db4da5e | 2018-06-15 11:37:52 -0400 | [diff] [blame] | 164 | std::string config = R"CONF( |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 165 | id rule-id |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 166 | for )CONF" + (PktType::getType() == tlv::Data ? "data"s : "interest"s) + R"CONF( |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 167 | filter |
| 168 | { |
| 169 | type name |
| 170 | regex ^<foo><bar>$ |
| 171 | } |
| 172 | checker |
| 173 | { |
| 174 | type customized |
| 175 | sig-type rsa-sha256 |
| 176 | key-locator |
| 177 | { |
| 178 | type name |
| 179 | hyper-relation |
| 180 | { |
| 181 | k-regex ^(<>+)$ |
| 182 | k-expand \\1 |
| 183 | h-relation equal |
| 184 | p-regex ^(<>+)$ |
| 185 | p-expand \\1 |
| 186 | } |
| 187 | } |
| 188 | } |
| 189 | )CONF"; |
| 190 | auto rule = Rule::create(makeSection(config), "test-config"); |
| 191 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 192 | BOOST_CHECK_EQUAL(rule->match(PktType::getType(), this->pktName, this->state), true); |
| 193 | BOOST_CHECK_EQUAL(rule->match(PktType::getType(), "/not" + this->pktName.toUri(), this->state), false); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 194 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 195 | BOOST_CHECK_EQUAL(rule->check(PktType::getType(), this->pktName, "/foo/bar", this->state), true); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 196 | |
Eric Newberry | 17d7c47 | 2020-06-18 21:29:22 -0700 | [diff] [blame] | 197 | this->state = PktType::makeState(); // reset state |
| 198 | BOOST_CHECK_EQUAL(rule->check(PktType::getType(), this->pktName, "/not/foo/bar", this->state), false); |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 199 | } |
| 200 | |
| 201 | BOOST_AUTO_TEST_SUITE_END() // Create |
| 202 | |
| 203 | BOOST_AUTO_TEST_SUITE_END() // TestRule |
| 204 | BOOST_AUTO_TEST_SUITE_END() // ValidatorConfig |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 205 | BOOST_AUTO_TEST_SUITE_END() // Security |
| 206 | |
| 207 | } // namespace tests |
| 208 | } // namespace validator_config |
Alexander Afanasyev | 09236c2 | 2020-06-03 13:42:38 -0400 | [diff] [blame] | 209 | } // inline namespace v2 |
Alexander Afanasyev | e5a19b8 | 2017-01-30 22:30:46 -0800 | [diff] [blame] | 210 | } // namespace security |
| 211 | } // namespace ndn |