blob: a7d29ef139ba96999415d5b16563033a30458ede [file] [log] [blame]
Yingdi Yub8f8b342015-04-27 11:06:42 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento5d0b0102017-10-07 13:43:16 -04002/*
Davide Pesavento78ca8ae2022-05-01 01:37:05 -04003 * Copyright (c) 2013-2022 Regents of the University of California.
Yingdi Yub8f8b342015-04-27 11:06:42 -07004 *
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
Davide Pesavento7e780642018-11-24 15:51:34 -050022#include "ndn-cxx/security/pib/key-container.hpp"
Davide Pesavento4fb35d82019-10-31 19:33:10 -040023#include "ndn-cxx/security/pib/impl/pib-memory.hpp"
Yingdi Yub8f8b342015-04-27 11:06:42 -070024
Davide Pesavento7e780642018-11-24 15:51:34 -050025#include "tests/boost-test.hpp"
26#include "tests/unit/security/pib/pib-data-fixture.hpp"
Yingdi Yub8f8b342015-04-27 11:06:42 -070027
28namespace ndn {
29namespace security {
Yingdi Yu6ee2d362015-07-16 21:48:05 -070030namespace pib {
Yingdi Yub8f8b342015-04-27 11:06:42 -070031namespace tests {
32
Davide Pesaventoeee3e822016-11-26 19:19:34 +010033BOOST_AUTO_TEST_SUITE(Security)
Yingdi Yu6ee2d362015-07-16 21:48:05 -070034BOOST_AUTO_TEST_SUITE(Pib)
Yingdi Yucbe72b02015-11-25 17:35:37 -080035BOOST_FIXTURE_TEST_SUITE(TestKeyContainer, PibDataFixture)
Yingdi Yub8f8b342015-04-27 11:06:42 -070036
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040037BOOST_AUTO_TEST_CASE(AddGetRemove)
Yingdi Yub8f8b342015-04-27 11:06:42 -070038{
Yingdi Yu3bf91f52015-06-12 19:39:40 -070039 auto pibImpl = make_shared<PibMemory>();
Yingdi Yub8f8b342015-04-27 11:06:42 -070040
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040041 {
42 // start with an empty container
43 KeyContainer container(id1, pibImpl);
44 BOOST_CHECK_EQUAL(container.size(), 0);
45 BOOST_CHECK_EQUAL(container.m_keys.size(), 0);
Yingdi Yub8f8b342015-04-27 11:06:42 -070046
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040047 // add the first key
48 Key key11 = container.add(id1Key1, id1Key1Name);
49 BOOST_CHECK_EQUAL(key11.getName(), id1Key1Name);
50 BOOST_TEST(key11.getPublicKey() == id1Key1, boost::test_tools::per_element());
51 BOOST_CHECK_EQUAL(container.size(), 1);
52 BOOST_CHECK_EQUAL(container.m_keys.size(), 1);
53 BOOST_CHECK(container.find(id1Key1Name) != container.end());
Yingdi Yub8f8b342015-04-27 11:06:42 -070054
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040055 // add the same key again
56 Key key12 = container.add(id1Key1, id1Key1Name);
57 BOOST_CHECK_EQUAL(key12.getName(), id1Key1Name);
58 BOOST_TEST(key12.getPublicKey() == id1Key1, boost::test_tools::per_element());
59 BOOST_CHECK_EQUAL(container.size(), 1);
60 BOOST_CHECK_EQUAL(container.m_keys.size(), 1);
61 BOOST_CHECK(container.find(id1Key1Name) != container.end());
Yingdi Yucbe72b02015-11-25 17:35:37 -080062
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040063 // add the second key
64 Key key21 = container.add(id1Key2, id1Key2Name);
65 BOOST_CHECK_EQUAL(key21.getName(), id1Key2Name);
66 BOOST_TEST(key21.getPublicKey() == id1Key2, boost::test_tools::per_element());
67 BOOST_CHECK_EQUAL(container.size(), 2);
68 BOOST_CHECK_EQUAL(container.m_keys.size(), 2);
69 BOOST_CHECK(container.find(id1Key1Name) != container.end());
70 BOOST_CHECK(container.find(id1Key2Name) != container.end());
Yingdi Yub8f8b342015-04-27 11:06:42 -070071
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040072 // check keys
73 Key key1 = container.get(id1Key1Name);
74 Key key2 = container.get(id1Key2Name);
75 BOOST_CHECK_EQUAL(key1.getName(), id1Key1Name);
76 BOOST_TEST(key1.getPublicKey() == id1Key1, boost::test_tools::per_element());
77 BOOST_CHECK_EQUAL(key2.getName(), id1Key2Name);
78 BOOST_TEST(key2.getPublicKey() == id1Key2, boost::test_tools::per_element());
79 Name id1Key3Name = constructKeyName(id1, name::Component("non-existing-id"));
80 BOOST_CHECK_THROW(container.get(id1Key3Name), pib::Pib::Error);
81 }
Yingdi Yucbe72b02015-11-25 17:35:37 -080082
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040083 {
84 // create a container from an existing (non-empty) PibImpl
85 // names are loaded immediately but the key cache should initially be empty
86 KeyContainer container2(id1, pibImpl);
87 BOOST_CHECK_EQUAL(container2.size(), 2);
88 BOOST_CHECK_EQUAL(container2.m_keys.size(), 0);
Yingdi Yucbe72b02015-11-25 17:35:37 -080089
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040090 // fetching the keys should populate the cache
91 BOOST_CHECK_EQUAL(container2.get(id1Key1Name).getName(), id1Key1Name);
92 BOOST_CHECK_EQUAL(container2.size(), 2);
93 BOOST_CHECK_EQUAL(container2.m_keys.size(), 1);
Yingdi Yucbe72b02015-11-25 17:35:37 -080094
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040095 BOOST_CHECK_EQUAL(container2.get(id1Key2Name).getName(), id1Key2Name);
96 BOOST_CHECK_EQUAL(container2.size(), 2);
97 BOOST_CHECK_EQUAL(container2.m_keys.size(), 2);
Yingdi Yucbe72b02015-11-25 17:35:37 -080098
Davide Pesavento78ca8ae2022-05-01 01:37:05 -040099 // remove a key
100 container2.remove(id1Key1Name);
101 BOOST_CHECK_EQUAL(container2.size(), 1);
102 BOOST_CHECK_EQUAL(container2.m_keys.size(), 1);
103 BOOST_CHECK(container2.find(id1Key1Name) == container2.end());
104 BOOST_CHECK(container2.find(id1Key2Name) != container2.end());
Yingdi Yucbe72b02015-11-25 17:35:37 -0800105
Davide Pesavento07db0732022-05-06 15:20:26 -0400106 // removing the same key again is a no-op
107 container2.remove(id1Key1Name);
108 BOOST_CHECK_EQUAL(container2.size(), 1);
109 BOOST_CHECK_EQUAL(container2.m_keys.size(), 1);
110 BOOST_CHECK(container2.find(id1Key1Name) == container2.end());
111 BOOST_CHECK(container2.find(id1Key2Name) != container2.end());
112
Davide Pesavento78ca8ae2022-05-01 01:37:05 -0400113 // remove another key
114 container2.remove(id1Key2Name);
115 BOOST_CHECK_EQUAL(container2.size(), 0);
116 BOOST_CHECK_EQUAL(container2.m_keys.size(), 0);
117 BOOST_CHECK(container2.find(id1Key2Name) == container2.end());
118 }
Yingdi Yucbe72b02015-11-25 17:35:37 -0800119}
120
121BOOST_AUTO_TEST_CASE(Errors)
122{
123 auto pibImpl = make_shared<PibMemory>();
Yingdi Yucbe72b02015-11-25 17:35:37 -0800124 KeyContainer container(id1, pibImpl);
125
Davide Pesavento765abc92021-12-27 00:44:04 -0500126 BOOST_CHECK_THROW(container.add(id2Key1, id2Key1Name), std::invalid_argument);
Yingdi Yucbe72b02015-11-25 17:35:37 -0800127 BOOST_CHECK_THROW(container.remove(id2Key1Name), std::invalid_argument);
128 BOOST_CHECK_THROW(container.get(id2Key1Name), std::invalid_argument);
129}
130
131BOOST_AUTO_TEST_CASE(Iterator)
132{
133 auto pibImpl = make_shared<PibMemory>();
134 KeyContainer container(id1, pibImpl);
Davide Pesavento765abc92021-12-27 00:44:04 -0500135 container.add(id1Key1, id1Key1Name);
136 container.add(id1Key2, id1Key2Name);
Yingdi Yucbe72b02015-11-25 17:35:37 -0800137
Davide Pesavento78ca8ae2022-05-01 01:37:05 -0400138 const std::set<Name> keyNames{id1Key1Name, id1Key2Name};
Yingdi Yub8f8b342015-04-27 11:06:42 -0700139
140 KeyContainer::const_iterator it = container.begin();
Davide Pesavento78ca8ae2022-05-01 01:37:05 -0400141 auto testIt = keyNames.begin();
Yingdi Yu6ee2d362015-07-16 21:48:05 -0700142 BOOST_CHECK_EQUAL((*it).getName(), *testIt);
Yingdi Yub8f8b342015-04-27 11:06:42 -0700143 it++;
144 testIt++;
Yingdi Yu6ee2d362015-07-16 21:48:05 -0700145 BOOST_CHECK_EQUAL((*it).getName(), *testIt);
Yingdi Yub8f8b342015-04-27 11:06:42 -0700146 ++it;
147 testIt++;
148 BOOST_CHECK(it == container.end());
149
Davide Pesavento78ca8ae2022-05-01 01:37:05 -0400150 // test range-based for
151 int count = 0;
Yingdi Yub8f8b342015-04-27 11:06:42 -0700152 testIt = keyNames.begin();
153 for (const auto& key : container) {
154 BOOST_CHECK_EQUAL(key.getIdentity(), id1);
Yingdi Yu6ee2d362015-07-16 21:48:05 -0700155 BOOST_CHECK_EQUAL(key.getName(), *testIt);
Yingdi Yub8f8b342015-04-27 11:06:42 -0700156 testIt++;
157 count++;
158 }
159 BOOST_CHECK_EQUAL(count, 2);
Yingdi Yucbe72b02015-11-25 17:35:37 -0800160
161 BOOST_CHECK(KeyContainer::const_iterator() == KeyContainer::const_iterator());
162 BOOST_CHECK(KeyContainer::const_iterator() == container.end());
163 BOOST_CHECK(container.end() == KeyContainer::const_iterator());
Yingdi Yub8f8b342015-04-27 11:06:42 -0700164}
165
Davide Pesaventoeee3e822016-11-26 19:19:34 +0100166BOOST_AUTO_TEST_SUITE_END() // TestKeyContainer
Yingdi Yu6ee2d362015-07-16 21:48:05 -0700167BOOST_AUTO_TEST_SUITE_END() // Pib
Davide Pesaventoeee3e822016-11-26 19:19:34 +0100168BOOST_AUTO_TEST_SUITE_END() // Security
Yingdi Yub8f8b342015-04-27 11:06:42 -0700169
170} // namespace tests
Yingdi Yu6ee2d362015-07-16 21:48:05 -0700171} // namespace pib
Yingdi Yub8f8b342015-04-27 11:06:42 -0700172} // namespace security
173} // namespace ndn