key-params.cpp

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.
 */
 
#include "ndn-cxx/security/key-params.hpp"
 
namespace ndn {
 
KeyParams::KeyParams(KeyType keyType, KeyIdType keyIdType)
  : m_keyType(keyType)
  , m_keyIdType(keyIdType)
{
  BOOST_ASSERT(keyIdType != KeyIdType::USER_SPECIFIED);
}
 
KeyParams::KeyParams(KeyType keyType, const name::Component& keyId)
  : m_keyType(keyType)
  , m_keyIdType(KeyIdType::USER_SPECIFIED)
  , m_keyId(keyId)
{
  BOOST_ASSERT(!keyId.empty());
}
 
KeyParams::~KeyParams() = default;
 
namespace detail {
 
constexpr uint32_t MIN_RSA_KEY_SIZE = 2048;
constexpr uint32_t MAX_RSA_KEY_SIZE = 16384;
constexpr uint32_t DEFAULT_RSA_KEY_SIZE = 2048;
constexpr uint32_t EC_KEY_SIZES[] = {224, 256, 384, 521};
constexpr uint32_t DEFAULT_EC_KEY_SIZE = 256;
constexpr uint32_t AES_KEY_SIZES[] = {128, 192, 256};
constexpr uint32_t DEFAULT_AES_KEY_SIZE = 128;
constexpr uint32_t DEFAULT_HMAC_KEY_SIZE = 256;
 
uint32_t
RsaKeyParamsInfo::checkKeySize(uint32_t size)
{
  if (size < MIN_RSA_KEY_SIZE || size > MAX_RSA_KEY_SIZE)
    NDN_THROW(KeyParams::Error("Unsupported RSA key size " + to_string(size)));
  return size;
}
 
uint32_t
RsaKeyParamsInfo::getDefaultSize()
{
  return DEFAULT_RSA_KEY_SIZE;
}
 
uint32_t
EcKeyParamsInfo::checkKeySize(uint32_t size)
{
  for (auto s : EC_KEY_SIZES) {
    if (s == size)
      return size;
  }
  NDN_THROW(KeyParams::Error("Unsupported EC key size " + to_string(size)));
}
 
uint32_t
EcKeyParamsInfo::getDefaultSize()
{
  return DEFAULT_EC_KEY_SIZE;
}
 
uint32_t
AesKeyParamsInfo::checkKeySize(uint32_t size)
{
  for (auto s : AES_KEY_SIZES) {
    if (s == size)
      return size;
  }
  NDN_THROW(KeyParams::Error("Unsupported AES key size " + to_string(size)));
}
 
uint32_t
AesKeyParamsInfo::getDefaultSize()
{
  return DEFAULT_AES_KEY_SIZE;
}
 
uint32_t
HmacKeyParamsInfo::checkKeySize(uint32_t size)
{
  if (size == 0 || size % 8 != 0)
    NDN_THROW(KeyParams::Error("Unsupported HMAC key size " + to_string(size)));
  return size;
}
 
uint32_t
HmacKeyParamsInfo::getDefaultSize()
{
  return DEFAULT_HMAC_KEY_SIZE;
}
 
} // namespace detail
} // namespace ndn