blob: 7abc5f57e8f5315373c9e8e6467f4a27852fd19f [file] [log] [blame]
Alexander Afanasyev7bc10fa2017-01-13 16:56:26 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2013-2017 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
22#ifndef NDN_SECURITY_V2_CERTIFICATE_FETCHER_HPP
23#define NDN_SECURITY_V2_CERTIFICATE_FETCHER_HPP
24
25#include "certificate-request.hpp"
26#include "certificate-storage.hpp"
27#include "validation-state.hpp"
28
29namespace ndn {
30
31class Face;
32
33namespace security {
34namespace v2 {
35
36/**
37 * @brief Interface used by the validator to fetch missing certificates
38 */
39class CertificateFetcher : noncopyable
40{
41public:
42 using ValidationContinuation = std::function<void(const Certificate& cert,
43 const shared_ptr<ValidationState>& state)>;
44
45 CertificateFetcher();
46
47 virtual
48 ~CertificateFetcher();
49
50 /**
51 * @brief Assign certificate storage to check known certificate and to cache unverified ones
52 * @note The supplied @p certStorage should be valid for the lifetime of CertificateFetcher
53 */
54 void
55 setCertificateStorage(CertificateStorage& certStorage);
56
57 /**
58 * @brief Asynchronously fetch certificate
59 * @pre m_certStorage != nullptr
60 *
61 * If the requested certificate exists in the storage, then this method will immediately call
62 * continueValidation with the certification. If certificate is not available, the
63 * implementation-specific doFetch will be called to asynchronously fetch certificate. The
64 * successfully retrieved certificate will be automatically added to the unverified cache of
65 * the certificate storage.
66 *
67 * When the requested certificate is retrieved, continueValidation is called. Otherwise, the
68 * fetcher implementation call state->failed() with the appropriate error code and diagnostic
69 * message.
70 */
71 void
72 fetch(const shared_ptr<CertificateRequest>& certRequest, const shared_ptr<ValidationState>& state,
73 const ValidationContinuation& continueValidation);
74
75private:
76 /**
77 * @brief Asynchronous certificate fetching implementation
78 */
79 virtual void
80 doFetch(const shared_ptr<CertificateRequest>& certRequest, const shared_ptr<ValidationState>& state,
81 const ValidationContinuation& continueValidation) = 0;
82
83protected:
84 CertificateStorage* m_certStorage;
85};
86
87} // namespace v2
88} // namespace security
89} // namespace ndn
90
91#endif // NDN_SECURITY_V2_CERTIFICATE_FETCHER_HPP