validator.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_SECURITY_VALIDATOR_HPP
#define NDN_CXX_SECURITY_VALIDATOR_HPP
 
#include "ndn-cxx/security/certificate-fetcher.hpp"
#include "ndn-cxx/security/certificate-request.hpp"
#include "ndn-cxx/security/certificate-storage.hpp"
#include "ndn-cxx/security/validation-callback.hpp"
#include "ndn-cxx/security/validation-policy.hpp"
#include "ndn-cxx/security/validation-state.hpp"
 
namespace ndn {
 
class Face;
 
namespace security {
 
class Validator : public CertificateStorage
{
public:
  Validator(unique_ptr<ValidationPolicy> policy, unique_ptr<CertificateFetcher> certFetcher);
 
  ~Validator() noexcept;
 
  ValidationPolicy&
  getPolicy() const noexcept
  {
    return *m_policy;
  }
 
  CertificateFetcher&
  getFetcher() const noexcept
  {
    return *m_certFetcher;
  }
 
  size_t
  getMaxDepth() const noexcept
  {
    return m_maxDepth;
  }
 
  void
  setMaxDepth(size_t depth) noexcept
  {
    m_maxDepth = depth;
  }
 
  void
  validate(const Data& data,
           const DataValidationSuccessCallback& successCb,
           const DataValidationFailureCallback& failureCb);
 
  void
  validate(const Interest& interest,
           const InterestValidationSuccessCallback& successCb,
           const InterestValidationFailureCallback& failureCb);
 
public: // anchor management
  void
  loadAnchor(const std::string& groupId, Certificate&& cert);
 
  void
  loadAnchor(const std::string& groupId, const std::string& certfilePath,
             time::nanoseconds refreshPeriod, bool isDir = false);
 
  void
  resetAnchors();
 
  void
  cacheVerifiedCertificate(Certificate&& cert);
 
  void
  resetVerifiedCertificates();
 
private: // Common validator operations
  void
  validate(const Certificate& cert, const shared_ptr<ValidationState>& state);
 
  void
  continueValidation(const shared_ptr<CertificateRequest>& certRequest,
                     const shared_ptr<ValidationState>& state);
 
  void
  requestCertificate(const shared_ptr<CertificateRequest>& certRequest,
                     const shared_ptr<ValidationState>& state);
 
private:
  unique_ptr<ValidationPolicy> m_policy;
  unique_ptr<CertificateFetcher> m_certFetcher;
  size_t m_maxDepth{25};
};
 
} // namespace security
} // namespace ndn
 
#endif // NDN_CXX_SECURITY_VALIDATOR_HPP