blob: ea0b4b7e8e9b6221ddfd5052d2acbe51c54bfc96 [file] [log] [blame]
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
Davide Pesavento47ce2ee2023-05-09 01:33:33 -04003 * Copyright (c) 2013-2023 Regents of the University of California.
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -08004 *
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 Afanasyev09236c22020-06-03 13:42:38 -040022#include "ndn-cxx/security/validator-config/rule.hpp"
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080023
Davide Pesavento7e780642018-11-24 15:51:34 -050024#include "tests/boost-test.hpp"
Alexander Afanasyev09236c22020-06-03 13:42:38 -040025#include "tests/unit/security/validator-fixture.hpp"
26#include "tests/unit/security/validator-config/common.hpp"
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080027
28#include <boost/mpl/vector_c.hpp>
29
Davide Pesavento47ce2ee2023-05-09 01:33:33 -040030namespace ndn::tests {
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080031
Davide Pesavento47ce2ee2023-05-09 01:33:33 -040032using namespace ndn::security::validator_config;
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080033
34BOOST_AUTO_TEST_SUITE(Security)
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080035BOOST_AUTO_TEST_SUITE(ValidatorConfig)
36
Eric Newberry17d7c472020-06-18 21:29:22 -070037template<class Packet>
Davide Pesavento4c1ad4c2020-11-16 21:12:02 -050038class RuleFixture : public KeyChainFixture
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080039{
40public:
41 RuleFixture()
Eric Newberry17d7c472020-06-18 21:29:22 -070042 : rule(ruleId, Packet::getType())
43 , pktName(Packet::makeName("/foo/bar", m_keyChain))
44 , state(Packet::makeState())
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080045 {
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080046 }
47
48public:
49 const std::string ruleId = "rule-id";
50 Rule rule;
51 Name pktName;
Davide Pesavento47ce2ee2023-05-09 01:33:33 -040052 shared_ptr<security::ValidationState> state;
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080053};
54
Eric Newberry17d7c472020-06-18 21:29:22 -070055using PktTypes = boost::mpl::vector<DataPkt, InterestV02Pkt, InterestV03Pkt>;
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080056
57BOOST_AUTO_TEST_SUITE(TestRule)
58
Eric Newberry17d7c472020-06-18 21:29:22 -070059BOOST_FIXTURE_TEST_CASE(Errors, RuleFixture<DataPkt>)
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080060{
Eric Newberry17d7c472020-06-18 21:29:22 -070061 BOOST_CHECK_THROW(rule.match(tlv::Interest, this->pktName, state), Error);
Alexander Afanasyev17d4b932021-03-17 17:58:40 -040062 BOOST_CHECK_THROW(rule.check(tlv::Interest, tlv::SignatureSha256WithRsa,
63 this->pktName, "/foo/bar", state), Error);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080064}
65
Eric Newberry17d7c472020-06-18 21:29:22 -070066BOOST_FIXTURE_TEST_CASE_TEMPLATE(Constructor, PktType, PktTypes, RuleFixture<PktType>)
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080067{
68 BOOST_CHECK_EQUAL(this->rule.getId(), this->ruleId);
Eric Newberry17d7c472020-06-18 21:29:22 -070069 BOOST_CHECK_EQUAL(this->rule.getPktType(), PktType::getType());
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080070}
71
Eric Newberry17d7c472020-06-18 21:29:22 -070072BOOST_FIXTURE_TEST_CASE_TEMPLATE(EmptyRule, PktType, PktTypes, RuleFixture<PktType>)
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080073{
Eric Newberry17d7c472020-06-18 21:29:22 -070074 BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), this->pktName, this->state), true);
Alexander Afanasyev17d4b932021-03-17 17:58:40 -040075 BOOST_CHECK_EQUAL(this->rule.check(PktType::getType(), tlv::SignatureSha256WithRsa,
76 this->pktName, "/foo/bar", this->state), false);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080077}
78
Eric Newberry17d7c472020-06-18 21:29:22 -070079BOOST_FIXTURE_TEST_CASE_TEMPLATE(Filters, PktType, PktTypes, RuleFixture<PktType>)
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080080{
81 this->rule.addFilter(make_unique<RegexNameFilter>(Regex("^<foo><bar>$")));
82
Eric Newberry17d7c472020-06-18 21:29:22 -070083 BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), this->pktName, this->state), true);
84 BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), "/not" + this->pktName.toUri(), this->state), false);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080085
86 this->rule.addFilter(make_unique<RegexNameFilter>(Regex("^<not><foo><bar>$")));
87
Eric Newberry17d7c472020-06-18 21:29:22 -070088 BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), this->pktName, this->state), true);
89 BOOST_CHECK_EQUAL(this->rule.match(PktType::getType(), "/not" + this->pktName.toUri(), this->state), true);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080090
Alexander Afanasyev17d4b932021-03-17 17:58:40 -040091 BOOST_CHECK_EQUAL(this->rule.check(PktType::getType(), tlv::SignatureSha256WithRsa,
92 this->pktName, "/foo/bar", this->state), false);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080093}
94
Eric Newberry17d7c472020-06-18 21:29:22 -070095BOOST_FIXTURE_TEST_CASE_TEMPLATE(Checkers, PktType, PktTypes, RuleFixture<PktType>)
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -080096{
Junxiao Shi58b9e0f2021-03-18 15:54:07 -060097 auto testChecker = [this] (const Name& klName, bool expectedOutcome) {
98 BOOST_TEST_CONTEXT(klName << " expected=" << expectedOutcome) {
99 this->state = PktType::makeState(); // reset state
Alexander Afanasyev17d4b932021-03-17 17:58:40 -0400100 BOOST_CHECK_EQUAL(this->rule.check(PktType::getType(), tlv::SignatureSha256WithRsa,
101 this->pktName, klName, this->state),
Junxiao Shi58b9e0f2021-03-18 15:54:07 -0600102 expectedOutcome);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800103
Junxiao Shi58b9e0f2021-03-18 15:54:07 -0600104 auto outcome = this->state->getOutcome();
105 if (expectedOutcome) {
106 BOOST_CHECK(boost::logic::indeterminate(outcome));
107 }
108 else {
109 BOOST_CHECK(!boost::logic::indeterminate(outcome));
110 BOOST_CHECK(!bool(outcome));
111 }
112 }
113 };
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800114
Alexander Afanasyev17d4b932021-03-17 17:58:40 -0400115 this->rule.addChecker(make_unique<HyperRelationChecker>(tlv::SignatureSha256WithRsa,
116 "^(<>+)$", "\\1",
Junxiao Shi58b9e0f2021-03-18 15:54:07 -0600117 "^<always>(<>+)$", "\\1",
118 NameRelation::EQUAL));
119 testChecker("/always/foo/bar", true);
120 testChecker("/seldomly/foo/bar", false);
121 testChecker("/never/foo/bar", false);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800122
Alexander Afanasyev17d4b932021-03-17 17:58:40 -0400123 this->rule.addChecker(make_unique<HyperRelationChecker>(tlv::SignatureSha256WithRsa,
124 "^(<>+)$", "\\1",
Junxiao Shi58b9e0f2021-03-18 15:54:07 -0600125 "^<seldomly>(<>+)$", "\\1",
126 NameRelation::EQUAL));
127 testChecker("/always/foo/bar", true);
128 testChecker("/seldomly/foo/bar", true);
129 testChecker("/never/foo/bar", false);
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800130}
131
132BOOST_AUTO_TEST_SUITE(Create)
133
134BOOST_AUTO_TEST_CASE(Errors)
135{
136 BOOST_CHECK_THROW(Rule::create(makeSection(""), "test-config"), Error);
137
138 std::string config = R"CONF(
139 id rule-id
140 for something
141 )CONF";
142 BOOST_CHECK_THROW(Rule::create(makeSection(config), "test-config"), Error);
143
144 config = R"CONF(
145 id rule-id
146 for data
147 )CONF";
148 BOOST_CHECK_THROW(Rule::create(makeSection(config), "test-config"), Error); // at least one checker required
149
150 config = R"CONF(
151 id rule-id
152 for data
153 checker
154 {
155 type hierarchical
156 sig-type rsa-sha256
157 }
158 other stuff
159 )CONF";
160 BOOST_CHECK_THROW(Rule::create(makeSection(config), "test-config"), Error);
161}
162
Eric Newberry17d7c472020-06-18 21:29:22 -0700163BOOST_FIXTURE_TEST_CASE_TEMPLATE(FilterAndChecker, PktType, PktTypes, RuleFixture<PktType>)
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800164{
Davide Pesaventodb4da5e2018-06-15 11:37:52 -0400165 std::string config = R"CONF(
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800166 id rule-id
Eric Newberry17d7c472020-06-18 21:29:22 -0700167 for )CONF" + (PktType::getType() == tlv::Data ? "data"s : "interest"s) + R"CONF(
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800168 filter
169 {
170 type name
171 regex ^<foo><bar>$
172 }
173 checker
174 {
175 type customized
176 sig-type rsa-sha256
177 key-locator
178 {
179 type name
180 hyper-relation
181 {
182 k-regex ^(<>+)$
183 k-expand \\1
184 h-relation equal
185 p-regex ^(<>+)$
186 p-expand \\1
187 }
188 }
189 }
190 )CONF";
191 auto rule = Rule::create(makeSection(config), "test-config");
192
Alexander Afanasyev17d4b932021-03-17 17:58:40 -0400193 BOOST_CHECK(rule->match(PktType::getType(), this->pktName, this->state));
194 BOOST_CHECK(!rule->match(PktType::getType(), "/not" + this->pktName.toUri(), this->state));
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800195
Alexander Afanasyev17d4b932021-03-17 17:58:40 -0400196 BOOST_CHECK(rule->check(PktType::getType(), tlv::SignatureSha256WithRsa, this->pktName, "/foo/bar", this->state));
197 BOOST_CHECK(!rule->check(PktType::getType(), tlv::SignatureSha256WithEcdsa, this->pktName, "/foo/bar", this->state));
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800198
Eric Newberry17d7c472020-06-18 21:29:22 -0700199 this->state = PktType::makeState(); // reset state
Alexander Afanasyev17d4b932021-03-17 17:58:40 -0400200 BOOST_CHECK(!rule->check(PktType::getType(), tlv::SignatureSha256WithRsa, this->pktName, "/not/foo/bar", this->state));
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800201}
202
203BOOST_AUTO_TEST_SUITE_END() // Create
204
205BOOST_AUTO_TEST_SUITE_END() // TestRule
206BOOST_AUTO_TEST_SUITE_END() // ValidatorConfig
Alexander Afanasyeve5a19b82017-01-30 22:30:46 -0800207BOOST_AUTO_TEST_SUITE_END() // Security
208
Davide Pesavento47ce2ee2023-05-09 01:33:33 -0400209} // namespace ndn::tests