key-params.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_KEY_PARAMS_HPP
#define NDN_CXX_SECURITY_KEY_PARAMS_HPP
 
#include "ndn-cxx/security/security-common.hpp"
#include "ndn-cxx/name-component.hpp"
 
namespace ndn {
 
class KeyParams
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };
 
  virtual
  ~KeyParams();
 
  KeyType
  getKeyType() const
  {
    return m_keyType;
  }
 
  KeyIdType
  getKeyIdType() const
  {
    return m_keyIdType;
  }
 
  const name::Component&
  getKeyId() const
  {
    return m_keyId;
  }
 
  void
  setKeyId(const name::Component& keyId)
  {
    m_keyId = keyId;
  }
 
protected:
  KeyParams(KeyType keyType, KeyIdType keyIdType);
 
  KeyParams(KeyType keyType, const name::Component& keyId);
 
private:
  KeyType m_keyType;
  KeyIdType m_keyIdType;
  name::Component m_keyId;
};
 
 
namespace detail {
 
class RsaKeyParamsInfo
{
public:
  static constexpr KeyType
  getType()
  {
    return KeyType::RSA;
  }
 
  static uint32_t
  checkKeySize(uint32_t size);
 
  static uint32_t
  getDefaultSize();
};
 
class EcKeyParamsInfo
{
public:
  static constexpr KeyType
  getType()
  {
    return KeyType::EC;
  }
 
  static uint32_t
  checkKeySize(uint32_t size);
 
  static uint32_t
  getDefaultSize();
};
 
} // namespace detail
 
 
template<typename KeyParamsInfo>
class SimplePublicKeyParams : public KeyParams
{
public:
  explicit
  SimplePublicKeyParams(const name::Component& keyId,
                        uint32_t size = KeyParamsInfo::getDefaultSize())
    : KeyParams(KeyParamsInfo::getType(), keyId)
  {
    setKeySize(size);
  }
 
  explicit
  SimplePublicKeyParams(uint32_t size = KeyParamsInfo::getDefaultSize(),
                        KeyIdType keyIdType = KeyIdType::RANDOM)
    : KeyParams(KeyParamsInfo::getType(), keyIdType)
  {
    setKeySize(size);
  }
 
  uint32_t
  getKeySize() const
  {
    return m_size;
  }
 
private:
  void
  setKeySize(uint32_t size)
  {
    m_size = KeyParamsInfo::checkKeySize(size);
  }
 
  uint32_t
  getDefaultKeySize() const
  {
    return KeyParamsInfo::getDefaultSize();
  }
 
private:
  uint32_t m_size;
};
 
using RsaKeyParams = SimplePublicKeyParams<detail::RsaKeyParamsInfo>;
 
using EcKeyParams = SimplePublicKeyParams<detail::EcKeyParamsInfo>;
 
 
namespace detail {
 
class AesKeyParamsInfo
{
public:
  static constexpr KeyType
  getType()
  {
    return KeyType::AES;
  }
 
  static uint32_t
  checkKeySize(uint32_t size);
 
  static uint32_t
  getDefaultSize();
};
 
class HmacKeyParamsInfo
{
public:
  static constexpr KeyType
  getType()
  {
    return KeyType::HMAC;
  }
 
  static uint32_t
  checkKeySize(uint32_t size);
 
  static uint32_t
  getDefaultSize();
};
 
} // namespace detail
 
 
template<typename KeyParamsInfo>
class SimpleSymmetricKeyParams : public KeyParams
{
public:
  explicit
  SimpleSymmetricKeyParams(const name::Component& keyId,
                           uint32_t size = KeyParamsInfo::getDefaultSize())
    : KeyParams(KeyParamsInfo::getType(), keyId)
  {
    setKeySize(size);
  }
 
  explicit
  SimpleSymmetricKeyParams(uint32_t size = KeyParamsInfo::getDefaultSize(),
                           KeyIdType keyIdType = KeyIdType::RANDOM)
    : KeyParams(KeyParamsInfo::getType(), keyIdType)
  {
    setKeySize(size);
  }
 
  uint32_t
  getKeySize() const
  {
    return m_size;
  }
 
private:
  void
  setKeySize(uint32_t size)
  {
    m_size = KeyParamsInfo::checkKeySize(size);
  }
 
  uint32_t
  getDefaultKeySize() const
  {
    return KeyParamsInfo::getDefaultSize();
  }
 
private:
  uint32_t m_size;
};
 
using AesKeyParams = SimpleSymmetricKeyParams<detail::AesKeyParamsInfo>;
 
using HmacKeyParams = SimpleSymmetricKeyParams<detail::HmacKeyParamsInfo>;
 
} // namespace ndn
 
#endif // NDN_CXX_SECURITY_KEY_PARAMS_HPP