command-interest-validator.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NDN_SECURITY_COMMAND_INTEREST_VALIDATOR_HPP
#define NDN_SECURITY_COMMAND_INTEREST_VALIDATOR_HPP

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

namespace ndn {
namespace security {

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

  public:
    time::nanoseconds gracePeriod = time::seconds(120);

    ssize_t maxTimestamps = 1000;

    time::nanoseconds timestampTtl = time::hours(1);
  };

  enum class ErrorCode {
    NONE = 0,
    NAME_TOO_SHORT,
    BAD_TIMESTAMP,
    BAD_SIG_INFO,
    MISSING_KEY_LOCATOR,
    BAD_KEY_LOCATOR_TYPE,
    BAD_CERT_NAME,
    TIMESTAMP_OUT_OF_GRACE,
    TIMESTAMP_REORDER
  };

  explicit
  CommandInterestValidator(unique_ptr<Validator> inner,
                           const Options& options = Options());

protected:
  void
  checkPolicy(const Interest& interest, int nSteps,
              const OnInterestValidated& accept,
              const OnInterestValidationFailed& reject,
              std::vector<shared_ptr<ValidationRequest>>& nextSteps) override;

  void
  checkPolicy(const Data& data, int nSteps,
              const OnDataValidated& accept,
              const OnDataValidationFailed& reject,
              std::vector<shared_ptr<ValidationRequest>>& nextSteps) override;

private:
  void
  cleanup();

  ErrorCode
  parseCommandInterest(const Interest& interest, Name& keyName, uint64_t& timestamp) const;

  ErrorCode
  checkTimestamp(const Name& keyName, uint64_t timestamp,
                 time::system_clock::TimePoint receiveTime);

private:
  unique_ptr<Validator> m_inner;
  Options m_options;

  struct LastTimestampRecord
  {
    Name keyName;
    uint64_t timestamp;
    time::steady_clock::TimePoint lastRefreshed;
  };

  typedef boost::multi_index_container<
    LastTimestampRecord,
    boost::multi_index::indexed_by<
      boost::multi_index::ordered_unique<
        boost::multi_index::member<LastTimestampRecord, Name, &LastTimestampRecord::keyName>
      >,
      boost::multi_index::sequenced<>
    >
  > Container;
  typedef Container::nth_index<0>::type Index;
  typedef Container::nth_index<1>::type Queue;

  Container m_container;
  Index& m_index;
  Queue& m_queue;
};

std::ostream&
operator<<(std::ostream& os, CommandInterestValidator::ErrorCode error);

} // namespace security
} // namespace ndn


#endif // NDN_SECURITY_COMMAND_INTEREST_VALIDATOR_HPP