back-end.cpp

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.
 */
 
#include "ndn-cxx/security/tpm/back-end.hpp"
 
#include "ndn-cxx/encoding/buffer-stream.hpp"
#include "ndn-cxx/security/pib/key.hpp"
#include "ndn-cxx/security/transform/buffer-source.hpp"
#include "ndn-cxx/security/transform/digest-filter.hpp"
#include "ndn-cxx/security/transform/private-key.hpp"
#include "ndn-cxx/security/transform/stream-sink.hpp"
#include "ndn-cxx/util/random.hpp"
 
#include <boost/lexical_cast.hpp>
 
namespace ndn::security::tpm {
 
BackEnd::~BackEnd() = default;
 
bool
BackEnd::hasKey(const Name& keyName) const
{
  return doHasKey(keyName);
}
 
unique_ptr<KeyHandle>
BackEnd::getKeyHandle(const Name& keyName) const
{
  return doGetKeyHandle(keyName);
}
 
unique_ptr<KeyHandle>
BackEnd::createKey(const Name& identity, const KeyParams& params)
{
  if (params.getKeyType() == KeyType::HMAC) {
    return doCreateKey(identity, params);
  }
 
  switch (params.getKeyIdType()) {
    case KeyIdType::USER_SPECIFIED: {
      // check that the provided key id isn't already taken
      Name keyName = constructKeyName(identity, params.getKeyId());
      if (hasKey(keyName)) {
        NDN_THROW(Error("Key `" + keyName.toUri() + "` already exists"));
      }
      break;
    }
    case KeyIdType::SHA256:
    case KeyIdType::RANDOM:
      // key id will be determined after key is generated
      break;
    default:
      NDN_THROW(std::invalid_argument("Unsupported key id type " +
                                      boost::lexical_cast<std::string>(params.getKeyIdType())));
  }
 
  return doCreateKey(identity, params);
}
 
void
BackEnd::deleteKey(const Name& keyName)
{
  doDeleteKey(keyName);
}
 
ConstBufferPtr
BackEnd::exportKey(const Name& keyName, const char* pw, size_t pwLen)
{
  if (!hasKey(keyName)) {
    NDN_THROW(Error("Key `" + keyName.toUri() + "` does not exist"));
  }
  return doExportKey(keyName, pw, pwLen);
}
 
void
BackEnd::importKey(const Name& keyName, span<const uint8_t> pkcs8, const char* pw, size_t pwLen)
{
  if (hasKey(keyName)) {
    NDN_THROW(Error("Key `" + keyName.toUri() + "` already exists"));
  }
  doImportKey(keyName, pkcs8, pw, pwLen);
}
 
void
BackEnd::importKey(const Name& keyName, shared_ptr<transform::PrivateKey> key)
{
  if (hasKey(keyName)) {
    NDN_THROW(Error("Key `" + keyName.toUri() + "` already exists"));
  }
  doImportKey(keyName, std::move(key));
}
 
Name
BackEnd::constructAsymmetricKeyName(const KeyHandle& keyHandle, const Name& identity,
                                    const KeyParams& params) const
{
  switch (params.getKeyIdType()) {
    case KeyIdType::USER_SPECIFIED: {
      return constructKeyName(identity, params.getKeyId());
    }
    case KeyIdType::SHA256: {
      using namespace transform;
      OBufferStream os;
      bufferSource(*keyHandle.derivePublicKey()) >>
        digestFilter(DigestAlgorithm::SHA256) >>
        streamSink(os);
      return constructKeyName(identity, name::Component(os.buf()));
    }
    case KeyIdType::RANDOM: {
      Name keyName;
      do {
        auto keyId = name::Component::fromNumber(random::generateSecureWord64());
        keyName = constructKeyName(identity, keyId);
      } while (hasKey(keyName));
      return keyName;
    }
    default: {
      NDN_THROW(Error("Unsupported key id type " + boost::lexical_cast<std::string>(params.getKeyIdType())));
    }
  }
}
 
Name
BackEnd::constructHmacKeyName(const transform::PrivateKey& key, const Name& identity,
                              const KeyParams& params) const
{
  return Name(identity).append(name::Component(key.getKeyDigest(DigestAlgorithm::SHA256)));
}
 
} // namespace ndn::security::tpm