host-to-gateway-readvertise-policy.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2022, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
27 #include "fw/scope-prefix.hpp"
28 #include "mgmt/rib-manager.hpp"
29 
30 #include <ndn-cxx/security/pib/identity.hpp>
31 #include <ndn-cxx/security/signing-helpers.hpp>
32 
33 namespace nfd::rib {
34 
35 const name::Component IGNORE_COMPONENT{"nrd"};
36 constexpr time::seconds DEFAULT_REFRESH_INTERVAL = 25_s;
37 
39  const ConfigSection& section)
40  : m_keyChain(keyChain)
41 {
42  auto interval = section.get_optional<uint64_t>("refresh_interval");
43  m_refreshInterval = interval ? time::seconds(*interval) : DEFAULT_REFRESH_INTERVAL;
44 }
45 
46 std::optional<ReadvertiseAction>
48 {
49  auto ribEntryName = ribRoute.entry->getName();
50  if (scope_prefix::LOCALHOST.isPrefixOf(ribEntryName) ||
51  ribEntryName == RibManager::LOCALHOP_TOP_PREFIX) {
52  return std::nullopt;
53  }
54 
55  // find out the shortest identity whose name is a prefix of the RIB entry name
56  auto prefixToAdvertise = ribEntryName;
57  ndn::security::pib::Identity signingIdentity;
58  bool isFound = false;
59 
60  for (const auto& identity : m_keyChain.getPib().getIdentities()) {
61  auto prefix = identity.getName();
62 
63  // ignore the identity name's last component if it is "nrd"
64  if (!prefix.empty() && IGNORE_COMPONENT == prefix.at(-1)) {
65  prefix = prefix.getPrefix(-1);
66  }
67 
68  if (prefix.isPrefixOf(prefixToAdvertise)) {
69  isFound = true;
70  prefixToAdvertise = prefix;
71  signingIdentity = identity;
72  }
73  }
74 
75  if (!isFound) {
76  return std::nullopt;
77  }
78  return ReadvertiseAction{prefixToAdvertise, ndn::security::signingByIdentity(signingIdentity)};
79 }
80 
81 time::milliseconds
83 {
84  return m_refreshInterval;
85 }
86 
87 } // namespace nfd::rib
static const Name LOCALHOP_TOP_PREFIX
std::optional< ReadvertiseAction > handleNewRoute(const RibRouteRef &ribRoute) const override
Decide whether to readvertise a route, and what prefix to readvertise.
HostToGatewayReadvertisePolicy(const ndn::KeyChain &keyChain, const ConfigSection &section)
const name::Component IGNORE_COMPONENT
constexpr time::seconds DEFAULT_REFRESH_INTERVAL
const Name LOCALHOST
The localhost scope ndn:/localhost.
boost::property_tree::ptree ConfigSection
A configuration file section.
Definition: config-file.hpp:41
A decision made by readvertise policy.
References a route.
Definition: rib.hpp:47
shared_ptr< RibEntry > entry
Definition: rib.hpp:48