manager-base.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2023, 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 
26 #include "manager-base.hpp"
27 
28 namespace nfd {
29 
30 ManagerBase::ManagerBase(std::string_view module, Dispatcher& dispatcher)
31  : m_module(module)
32  , m_dispatcher(dispatcher)
33 {
34 }
35 
36 ManagerBase::ManagerBase(std::string_view module, Dispatcher& dispatcher,
37  CommandAuthenticator& authenticator)
38  : m_module(module)
39  , m_dispatcher(dispatcher)
40  , m_authenticator(&authenticator)
41 {
42 }
43 
44 ManagerBase::~ManagerBase() = default;
45 
46 void
48  const ndn::mgmt::StatusDatasetHandler& handler)
49 {
50  m_dispatcher.addStatusDataset(makeRelPrefix(verb),
51  ndn::mgmt::makeAcceptAllAuthorization(),
52  handler);
53 }
54 
55 ndn::mgmt::PostNotification
57 {
58  return m_dispatcher.addNotificationStream(makeRelPrefix(verb));
59 }
60 
61 std::string
62 ManagerBase::extractSigner(const Interest& interest)
63 {
64  try {
65  // try v0.3 format first
66  auto sigInfo = interest.getSignatureInfo();
67  if (!sigInfo) {
68  // fallback to v0.2 format
69  sigInfo.emplace(interest.getName().at(ndn::signed_interest::POS_SIG_INFO).blockFromValue());
70  }
71  return sigInfo->getKeyLocator().getName().toUri();
72  }
73  catch (const tlv::Error&) {
74  return "";
75  }
76 }
77 
78 ndn::mgmt::Authorization
79 ManagerBase::makeAuthorization(const std::string& verb)
80 {
81  BOOST_ASSERT(m_authenticator != nullptr);
82  return m_authenticator->makeAuthorization(m_module, verb);
83 }
84 
85 bool
86 ManagerBase::validateParameters(const ControlCommand& command,
87  const ndn::mgmt::ControlParameters& parameters)
88 {
89  BOOST_ASSERT(dynamic_cast<const ControlParameters*>(&parameters) != nullptr);
90 
91  try {
92  command.validateRequest(static_cast<const ControlParameters&>(parameters));
93  }
94  catch (const ControlCommand::ArgumentError&) {
95  return false;
96  }
97  return true;
98 }
99 
100 void
101 ManagerBase::handleCommand(shared_ptr<ControlCommand> command,
102  const ControlCommandHandler& handler,
103  const Name& prefix, const Interest& interest,
104  const ndn::mgmt::ControlParameters& params,
105  const ndn::mgmt::CommandContinuation& done)
106 {
107  BOOST_ASSERT(dynamic_cast<const ControlParameters*>(&params) != nullptr);
108 
109  ControlParameters parameters = static_cast<const ControlParameters&>(params);
110  command->applyDefaultsToRequest(parameters);
111  handler(*command, prefix, interest, parameters, done);
112 }
113 
114 } // namespace nfd
Provides ControlCommand authorization according to NFD's configuration file.
ndn::mgmt::Authorization makeAuthorization(const std::string &module, const std::string &verb)
Returns an Authorization function for module/verb command.
ndn::mgmt::PostNotification registerNotificationStream(const std::string &verb)
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
static std::string extractSigner(const Interest &interest)
Extracts the name from the KeyLocator of a ControlCommand request.
ManagerBase(std::string_view module, Dispatcher &dispatcher)
-status-http-server
Definition: common.hpp:71