certificate-fetcher-from-network.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2023 Regents of the University of California.
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 
23 
24 #include "ndn-cxx/face.hpp"
27 #include "ndn-cxx/util/logger.hpp"
28 
29 namespace ndn::security {
30 
32 
33 #define NDN_LOG_DEBUG_DEPTH(x) NDN_LOG_DEBUG(std::string(state->getDepth() + 1, '>') << " " << x)
34 #define NDN_LOG_TRACE_DEPTH(x) NDN_LOG_TRACE(std::string(state->getDepth() + 1, '>') << " " << x)
35 
37  : m_face(face)
38  , m_scheduler(face.getIoContext())
39 {
40 }
41 
42 void
43 CertificateFetcherFromNetwork::doFetch(const shared_ptr<CertificateRequest>& certRequest,
44  const shared_ptr<ValidationState>& state,
45  const ValidationContinuation& continueValidation)
46 {
47  m_face.expressInterest(certRequest->interest,
48  [=] (const Interest&, const Data& data) {
49  dataCallback(data, certRequest, state, continueValidation);
50  },
51  [=] (const Interest&, const lp::Nack& nack) {
52  nackCallback(nack, certRequest, state, continueValidation);
53  },
54  [=] (const Interest&) {
55  timeoutCallback(certRequest, state, continueValidation);
56  });
57 }
58 
59 void
61  const shared_ptr<CertificateRequest>&,
62  const shared_ptr<ValidationState>& state,
63  const ValidationContinuation& continueValidation)
64 {
65  NDN_LOG_DEBUG_DEPTH("Fetched certificate from network " << data.getName());
66 
67  Certificate cert;
68  try {
69  cert = Certificate(data);
70  }
71  catch (const tlv::Error& e) {
72  return state->fail({ValidationError::MALFORMED_CERT, "`" + data.getName().toUri() + "`: " + e.what()});
73  }
74  continueValidation(cert, state);
75 }
76 
77 void
79  const shared_ptr<CertificateRequest>& certRequest,
80  const shared_ptr<ValidationState>& state,
81  const ValidationContinuation& continueValidation)
82 {
83  NDN_LOG_DEBUG_DEPTH("Nack (" << nack.getReason() << ") while fetching certificate "
84  << certRequest->interest.getName());
85 
86  --certRequest->nRetriesLeft;
87  if (certRequest->nRetriesLeft >= 0) {
88  m_scheduler.schedule(certRequest->waitAfterNack,
89  [=] { fetch(certRequest, state, continueValidation); });
90  certRequest->waitAfterNack *= 2;
91  }
92  else {
93  state->fail({ValidationError::CANNOT_RETRIEVE_CERT, "Nack after exhausting all retries for "
94  "`" + certRequest->interest.getName().toUri() + "`"});
95  }
96 }
97 
98 void
99 CertificateFetcherFromNetwork::timeoutCallback(const shared_ptr<CertificateRequest>& certRequest,
100  const shared_ptr<ValidationState>& state,
101  const ValidationContinuation& continueValidation)
102 {
103  NDN_LOG_DEBUG_DEPTH("Timeout while fetching certificate " << certRequest->interest.getName());
104 
105  --certRequest->nRetriesLeft;
106  if (certRequest->nRetriesLeft >= 0) {
107  fetch(certRequest, state, continueValidation);
108  }
109  else {
110  state->fail({ValidationError::CANNOT_RETRIEVE_CERT, "Timeout after exhausting all retries for "
111  "`" + certRequest->interest.getName().toUri() + "`"});
112  }
113 }
114 
115 } // namespace ndn::security
#define NDN_LOG_DEBUG_DEPTH(x)
Represents a Data packet.
Definition: data.hpp:39
const Name & getName() const noexcept
Get the Data name.
Definition: data.hpp:137
Provide a communication channel with local or remote NDN forwarder.
Definition: face.hpp:91
PendingInterestHandle expressInterest(const Interest &interest, const DataCallback &afterSatisfied, const NackCallback &afterNacked, const TimeoutCallback &afterTimeout)
Express an Interest.
Definition: face.cpp:151
Represents an Interest packet.
Definition: interest.hpp:50
Represents a Network Nack.
Definition: nack.hpp:39
NackReason getReason() const
Definition: nack.hpp:90
EventId schedule(time::nanoseconds after, EventCallback callback)
Schedule a one-time event after the specified delay.
Definition: scheduler.cpp:78
void dataCallback(const Data &data, const shared_ptr< CertificateRequest > &certRequest, const shared_ptr< ValidationState > &state, const ValidationContinuation &continueValidation)
Callback invoked when certificate is retrieved.
void nackCallback(const lp::Nack &nack, const shared_ptr< CertificateRequest > &certRequest, const shared_ptr< ValidationState > &state, const ValidationContinuation &continueValidation)
Callback invoked when interest for fetching certificate gets NACKed.
void timeoutCallback(const shared_ptr< CertificateRequest > &certRequest, const shared_ptr< ValidationState > &state, const ValidationContinuation &continueValidation)
Callback invoked when interest for fetching certificate times out.
void doFetch(const shared_ptr< CertificateRequest > &certRequest, const shared_ptr< ValidationState > &state, const ValidationContinuation &continueValidation) override
Asynchronous certificate fetching implementation.
Interface used by the validator to fetch missing certificates.
void fetch(const shared_ptr< CertificateRequest > &certRequest, const shared_ptr< ValidationState > &state, const ValidationContinuation &continueValidation)
Asynchronously fetch certificate.
std::function< void(const Certificate &cert, const shared_ptr< ValidationState > &state)> ValidationContinuation
Represents an NDN certificate.
Definition: certificate.hpp:58
@ CANNOT_RETRIEVE_CERT
The certificate cannot be retrieved.
@ MALFORMED_CERT
The certificate is malformed.
Represents an error in TLV encoding or decoding.
Definition: tlv.hpp:54
#define NDN_LOG_INIT(name)
Define a non-member log module.
Definition: logger.hpp:169
Contains the ndn-cxx security framework.
Definition: data.cpp:25