private-key.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2021 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_TRANSFORM_PRIVATE_KEY_HPP
#define NDN_CXX_SECURITY_TRANSFORM_PRIVATE_KEY_HPP
 
#include "ndn-cxx/security/security-common.hpp"
#include "ndn-cxx/encoding/buffer.hpp"
 
namespace ndn {
 
class KeyParams;
 
namespace security {
namespace transform {
 
class PrivateKey : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };
 
  using PasswordCallback = std::function<int(char* buf, size_t bufSize, bool shouldConfirm)>;
 
public:
  PrivateKey();
 
  ~PrivateKey();
 
  KeyType
  getKeyType() const;
 
  size_t
  getKeySize() const;
 
  ConstBufferPtr
  getKeyDigest(DigestAlgorithm algo) const;
 
  void
  loadRaw(KeyType type, span<const uint8_t> buf);
 
  [[deprecated("use the overload that takes a span<>")]]
  void
  loadRaw(KeyType type, const uint8_t* buf, size_t size)
  {
    loadRaw(type, {buf, size});
  }
 
  void
  loadPkcs1(span<const uint8_t> buf);
 
  [[deprecated("use the overload that takes a span<>")]]
  void
  loadPkcs1(const uint8_t* buf, size_t size)
  {
    loadPkcs1({buf, size});
  }
 
  void
  loadPkcs1(std::istream& is);
 
  void
  loadPkcs1Base64(span<const uint8_t> buf);
 
  [[deprecated("use the overload that takes a span<>")]]
  void
  loadPkcs1Base64(const uint8_t* buf, size_t size)
  {
    loadPkcs1Base64({buf, size});
  }
 
  void
  loadPkcs1Base64(std::istream& is);
 
  void
  loadPkcs8(span<const uint8_t> buf, const char* pw, size_t pwLen);
 
  void
  loadPkcs8(span<const uint8_t> buf, PasswordCallback pwCallback = nullptr);
 
  [[deprecated("use the overload that takes a span<>")]]
  void
  loadPkcs8(const uint8_t* buf, size_t size, PasswordCallback pwCallback = nullptr)
  {
    loadPkcs8({buf, size}, std::move(pwCallback));
  }
 
  void
  loadPkcs8(std::istream& is, const char* pw, size_t pwLen);
 
  void
  loadPkcs8(std::istream& is, PasswordCallback pwCallback = nullptr);
 
  void
  loadPkcs8Base64(span<const uint8_t> buf, const char* pw, size_t pwLen);
 
  void
  loadPkcs8Base64(span<const uint8_t> buf, PasswordCallback pwCallback = nullptr);
 
  [[deprecated("use the overload that takes a span<>")]]
  void
  loadPkcs8Base64(const uint8_t* buf, size_t size, PasswordCallback pwCallback = nullptr)
  {
    loadPkcs8Base64({buf, size}, std::move(pwCallback));
  }
 
  void
  loadPkcs8Base64(std::istream& is, const char* pw, size_t pwLen);
 
  void
  loadPkcs8Base64(std::istream& is, PasswordCallback pwCallback = nullptr);
 
  void
  savePkcs1(std::ostream& os) const;
 
  void
  savePkcs1Base64(std::ostream& os) const;
 
  void
  savePkcs8(std::ostream& os, const char* pw, size_t pwLen) const;
 
  void
  savePkcs8(std::ostream& os, PasswordCallback pwCallback = nullptr) const;
 
  void
  savePkcs8Base64(std::ostream& os, const char* pw, size_t pwLen) const;
 
  void
  savePkcs8Base64(std::ostream& os, PasswordCallback pwCallback = nullptr) const;
 
  ConstBufferPtr
  derivePublicKey() const;
 
  ConstBufferPtr
  decrypt(span<const uint8_t> cipherText) const;
 
  [[deprecated("use the overload that takes a span<>")]]
  ConstBufferPtr
  decrypt(const uint8_t* cipherText, size_t cipherLen) const
  {
    return decrypt({cipherText, cipherLen});
  }
 
private:
  friend class SignerFilter;
  friend class VerifierFilter;
 
  void*
  getEvpPkey() const;
 
private:
  ConstBufferPtr
  toPkcs1() const;
 
  ConstBufferPtr
  toPkcs8(const char* pw, size_t pwLen) const;
 
  ConstBufferPtr
  toPkcs8(PasswordCallback pwCallback = nullptr) const;
 
  ConstBufferPtr
  rsaDecrypt(span<const uint8_t> cipherText) const;
 
private:
  friend unique_ptr<PrivateKey> generatePrivateKey(const KeyParams&);
 
  static unique_ptr<PrivateKey>
  generateRsaKey(uint32_t keySize);
 
  static unique_ptr<PrivateKey>
  generateEcKey(uint32_t keySize);
 
  static unique_ptr<PrivateKey>
  generateHmacKey(uint32_t keySize);
 
private:
  class Impl;
  const unique_ptr<Impl> m_impl;
};
 
unique_ptr<PrivateKey>
generatePrivateKey(const KeyParams& keyParams);
 
} // namespace transform
} // namespace security
} // namespace ndn
 
#endif // NDN_CXX_SECURITY_TRANSFORM_PRIVATE_KEY_HPP