interest-signer.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2024 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_INTEREST_SIGNER_HPP
#define NDN_CXX_SECURITY_INTEREST_SIGNER_HPP
 
#include "ndn-cxx/security/key-chain.hpp"
 
namespace ndn::security {
 
class InterestSigner
{
public:
  explicit
  InterestSigner(KeyChain& keyChain) noexcept
    : m_keyChain(keyChain)
  {
  }
 
  enum SigningFlags : uint32_t {
    WantNonce = 1 << 0,
    WantTime = 1 << 1,
    WantSeqNum = 1 << 2,
  };
 
  void
  makeSignedInterest(Interest& interest,
                     SigningInfo params = SigningInfo(),
                     uint32_t signingFlags = WantNonce | WantTime);
 
  Interest
  makeCommandInterest(Name name, const SigningInfo& params = SigningInfo());
 
private:
  time::system_clock::time_point
  getFreshTimestamp();
 
private:
  KeyChain& m_keyChain;
  time::system_clock::time_point m_lastUsedTimestamp;
  uint64_t m_lastUsedSeqNum = static_cast<uint64_t>(-1); // will wrap around to 0 on next Interest
};
 
} // namespace ndn::security
 
#endif // NDN_CXX_SECURITY_INTEREST_SIGNER_HPP