validation-policy-signed-interest.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2021 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_VALIDATION_POLICY_SIGNED_INTEREST_HPP
#define NDN_CXX_SECURITY_VALIDATION_POLICY_SIGNED_INTEREST_HPP

#include "ndn-cxx/security/validation-policy.hpp"

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/key_extractors.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/sequenced_index.hpp>

namespace ndn {
namespace security {
inline namespace v2 {

class ValidationPolicySignedInterest : public ValidationPolicy
{
private:
  using SigNonce = std::vector<uint8_t>;
  struct NonceSet {};
  struct NonceList {};

public:
  class Options
  {
  public:
    Options()
    {
    }

  public:
    bool shouldValidateTimestamps = true;

    time::nanoseconds timestampGracePeriod = 2_min;

    bool shouldValidateSeqNums = false;

    bool shouldValidateNonces = true;

    ssize_t maxNonceRecordCount = 1000;

    ssize_t maxRecordCount = 1000;
  };

  explicit
  ValidationPolicySignedInterest(unique_ptr<ValidationPolicy> inner, const Options& options = {});

protected:
  void
  checkPolicy(const Data& data, const shared_ptr<ValidationState>& state,
              const ValidationContinuation& continueValidation) override;

  void
  checkPolicy(const Interest& interest, const shared_ptr<ValidationState>& state,
              const ValidationContinuation& continueValidation) override;

private:
  bool
  checkIncomingInterest(const shared_ptr<ValidationState>& state, const Interest& interest);

  void
  insertRecord(const Name& keyName,
               optional<time::system_clock::TimePoint> timestamp,
               optional<uint64_t> seqNum,
               optional<SigNonce> nonce);

private:
  Options m_options;

  using NonceContainer = boost::multi_index_container<
    SigNonce,
    boost::multi_index::indexed_by<
      boost::multi_index::hashed_unique<
        boost::multi_index::tag<NonceSet>,
        boost::multi_index::identity<SigNonce>
      >,
      boost::multi_index::sequenced<
        boost::multi_index::tag<NonceList>
      >
    >
  >;

  struct LastInterestRecord
  {
    LastInterestRecord(const Name& keyName,
                       optional<time::system_clock::TimePoint> timestamp,
                       optional<uint64_t> seqNum)
      : keyName(keyName)
      , timestamp(timestamp)
      , seqNum(seqNum)
      , lastRefreshed(time::steady_clock::now())
    {
    }

    Name keyName;
    optional<time::system_clock::TimePoint> timestamp;
    optional<uint64_t> seqNum;
    NonceContainer observedNonces;
    time::steady_clock::TimePoint lastRefreshed;
  };

  using Container = boost::multi_index_container<
    LastInterestRecord,
    boost::multi_index::indexed_by<
      boost::multi_index::ordered_unique<
        boost::multi_index::member<LastInterestRecord, Name, &LastInterestRecord::keyName>
      >,
      boost::multi_index::ordered_non_unique<
        boost::multi_index::member<LastInterestRecord, time::steady_clock::TimePoint,
                                   &LastInterestRecord::lastRefreshed>
      >
    >
  >;

  Container m_container;
  Container::nth_index<0>::type& m_byKeyName;
  Container::nth_index<1>::type& m_byLastRefreshed;
};

} // inline namespace v2
} // namespace security
} // namespace ndn

#endif // NDN_CXX_SECURITY_VALIDATION_POLICY_SIGNED_INTEREST_HPP