checker.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_CONFIG_CHECKER_HPP
#define NDN_CXX_SECURITY_VALIDATOR_CONFIG_CHECKER_HPP
 
#include "ndn-cxx/name.hpp"
#include "ndn-cxx/security/validator-config/common.hpp"
#include "ndn-cxx/security/validator-config/name-relation.hpp"
#include "ndn-cxx/util/regex.hpp"
 
namespace ndn::security {
 
class ValidationState;
 
namespace validator_config {
 
class Checker : noncopyable
{
public:
  class Result
  {
  public:
    explicit operator bool() const
    {
      return m_error.empty();
    }
 
    const std::string&
    getErrorMessage() const
    {
      return m_error;
    }
 
  private:
    explicit
    Result(std::string error);
 
  private:
    std::string m_error;
 
    friend Checker;
  };
 
  explicit
  Checker(tlv::SignatureTypeValue sigType);
 
  virtual
  ~Checker() = default;
 
  Result
  check(uint32_t pktType, tlv::SignatureTypeValue sigType,
        const Name& pktName, const Name& klName, const ValidationState& state);
 
  static unique_ptr<Checker>
  create(const ConfigSection& configSection, const std::string& configFilename);
 
protected:
  virtual Result
  checkNames(const Name& pktName, const Name& klName);
 
  static Result
  accept()
  {
    return Result("");
  }
 
  class NegativeResultBuilder;
 
  static NegativeResultBuilder
  reject();
 
private:
  static unique_ptr<Checker>
  createCustomizedChecker(const ConfigSection& configSection, const std::string& configFilename);
 
  static unique_ptr<Checker>
  createHierarchicalChecker(const ConfigSection& configSection, const std::string& configFilename);
 
  static unique_ptr<Checker>
  createKeyLocatorChecker(tlv::SignatureTypeValue sigType,
                          const ConfigSection& configSection, const std::string& configFilename);
 
  static unique_ptr<Checker>
  createKeyLocatorNameChecker(tlv::SignatureTypeValue sigType,
                              const ConfigSection& configSection, const std::string& configFilename);
 
protected:
    tlv::SignatureTypeValue m_sigType = tlv::SignatureSha256WithEcdsa;
};
 
class NameRelationChecker : public Checker
{
public:
  NameRelationChecker(tlv::SignatureTypeValue sigType, const Name& name, const NameRelation& relation);
 
protected:
  Result
  checkNames(const Name& pktName, const Name& klName) override;
 
private:
  Name m_name;
  NameRelation m_relation;
};
 
class RegexChecker : public Checker
{
public:
  explicit
  RegexChecker(tlv::SignatureTypeValue sigType, const Regex& regex);
 
protected:
  Result
  checkNames(const Name& pktName, const Name& klName) override;
 
private:
  Regex m_regex;
};
 
class HyperRelationChecker : public Checker
{
public:
  HyperRelationChecker(tlv::SignatureTypeValue sigType,
                       const std::string& pktNameExpr, const std::string& pktNameExpand,
                       const std::string& klNameExpr, const std::string& klNameExpand,
                       const NameRelation& hyperRelation);
 
protected:
  Result
  checkNames(const Name& pktName, const Name& klName) override;
 
private:
  Regex m_hyperPRegex;
  Regex m_hyperKRegex;
  NameRelation m_hyperRelation;
};
 
} // namespace validator_config
} // namespace ndn::security
 
#endif // NDN_CXX_SECURITY_VALIDATOR_CONFIG_CHECKER_HPP