security-common.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_SECURITY_COMMON_HPP
#define NDN_CXX_SECURITY_SECURITY_COMMON_HPP
 
#include "ndn-cxx/util/span.hpp"
 
#include <cstdint>
#include <iosfwd>
#include <vector>
 
namespace ndn {
 
namespace signed_interest {
 
inline constexpr ssize_t POS_SIG_VALUE = -1;
inline constexpr ssize_t POS_SIG_INFO = -2;
 
inline constexpr size_t MIN_SIZE = 2;
 
} // namespace signed_interest
 
namespace command_interest {
 
inline constexpr ssize_t POS_SIG_VALUE = -1;
inline constexpr ssize_t POS_SIG_INFO = -2;
inline constexpr ssize_t POS_RANDOM_VAL = -3;
inline constexpr ssize_t POS_TIMESTAMP = -4;
 
inline constexpr size_t MIN_SIZE = 4;
 
} // namespace command_interest
 
#ifndef DOXYGEN
using InputBuffers = std::vector<span<const uint8_t>>;
#else
class InputBuffers;
#endif
 
enum class KeyIdType {
  USER_SPECIFIED = 0,
  SHA256 = 1,
  RANDOM = 2,
};
 
std::ostream&
operator<<(std::ostream& os, KeyIdType keyIdType);
 
enum class KeyType {
  NONE = 0, 
  RSA,      
  EC,       
  AES,      
  HMAC,     
};
 
std::ostream&
operator<<(std::ostream& os, KeyType keyType);
 
enum class DigestAlgorithm {
  NONE = 0,
  SHA224,
  SHA256,
  SHA384,
  SHA512,
  BLAKE2B_512,
  BLAKE2S_256,
  SHA3_224,
  SHA3_256,
  SHA3_384,
  SHA3_512,
};
 
std::ostream&
operator<<(std::ostream& os, DigestAlgorithm algorithm);
 
enum class BlockCipherAlgorithm {
  NONE,
  AES_CBC,
};
 
std::ostream&
operator<<(std::ostream& os, BlockCipherAlgorithm algorithm);
 
enum class CipherOperator {
  DECRYPT,
  ENCRYPT,
};
 
std::ostream&
operator<<(std::ostream& os, CipherOperator op);
 
} // namespace ndn
 
#endif // NDN_CXX_SECURITY_SECURITY_COMMON_HPP