private-key.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2024 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_SECURITY_TRANSFORM_PRIVATE_KEY_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_PRIVATE_KEY_HPP
24 
28 
29 namespace ndn {
30 
31 class KeyParams;
32 
33 namespace security::transform {
34 
38 class PrivateKey : noncopyable
39 {
40 public:
41  class Error : public std::runtime_error
42  {
43  public:
44  using std::runtime_error::runtime_error;
45  };
46 
55  using PasswordCallback = std::function<int(char* buf, size_t bufSize, bool shouldConfirm)>;
56 
57 public:
63  PrivateKey();
64 
66 
70  KeyType
71  getKeyType() const;
72 
76  size_t
77  getKeySize() const;
78 
85  getKeyDigest(DigestAlgorithm algo) const;
86 
92  void
93  loadRaw(KeyType type, span<const uint8_t> buf);
94 
98  void
99  loadPkcs1(span<const uint8_t> buf);
100 
104  void
105  loadPkcs1(std::istream& is);
106 
110  void
111  loadPkcs1Base64(span<const uint8_t> buf);
112 
116  void
117  loadPkcs1Base64(std::istream& is);
118 
123  void
124  loadPkcs8(span<const uint8_t> buf, const char* pw, size_t pwLen);
125 
132  void
133  loadPkcs8(span<const uint8_t> buf, PasswordCallback pwCallback = nullptr);
134 
139  void
140  loadPkcs8(std::istream& is, const char* pw, size_t pwLen);
141 
148  void
149  loadPkcs8(std::istream& is, PasswordCallback pwCallback = nullptr);
150 
156  void
157  loadPkcs8Base64(span<const uint8_t> buf, const char* pw, size_t pwLen);
158 
165  void
166  loadPkcs8Base64(span<const uint8_t> buf, PasswordCallback pwCallback = nullptr);
167 
173  void
174  loadPkcs8Base64(std::istream& is, const char* pw, size_t pwLen);
175 
182  void
183  loadPkcs8Base64(std::istream& is, PasswordCallback pwCallback = nullptr);
184 
188  void
189  savePkcs1(std::ostream& os) const;
190 
194  void
195  savePkcs1Base64(std::ostream& os) const;
196 
200  void
201  savePkcs8(std::ostream& os, const char* pw, size_t pwLen) const;
202 
209  void
210  savePkcs8(std::ostream& os, PasswordCallback pwCallback = nullptr) const;
211 
215  void
216  savePkcs8Base64(std::ostream& os, const char* pw, size_t pwLen) const;
217 
224  void
225  savePkcs8Base64(std::ostream& os, PasswordCallback pwCallback = nullptr) const;
226 
231  derivePublicKey() const;
232 
239  decrypt(span<const uint8_t> cipherText) const;
240 
241 private:
242  friend class SignerFilter;
243  friend class VerifierFilter;
244 
250  void*
251  getEvpPkey() const;
252 
254  toPkcs1() const;
255 
257  toPkcs8(const char* pw, size_t pwLen) const;
258 
260  toPkcs8(PasswordCallback pwCallback = nullptr) const;
261 
263  rsaDecrypt(span<const uint8_t> cipherText) const;
264 
265 private:
266  friend unique_ptr<PrivateKey> generatePrivateKey(const KeyParams&);
267 
268  static unique_ptr<PrivateKey>
269  generateRsaKey(uint32_t keySize);
270 
271  static unique_ptr<PrivateKey>
272  generateEcKey(uint32_t keySize);
273 
274  static unique_ptr<PrivateKey>
275  generateHmacKey(uint32_t keySize);
276 
277 private:
278  class Impl;
279  const unique_ptr<Impl> m_impl;
280 };
281 
290 unique_ptr<PrivateKey>
291 generatePrivateKey(const KeyParams& keyParams);
292 
293 } // namespace security::transform
294 } // namespace ndn
295 
296 #endif // NDN_CXX_SECURITY_TRANSFORM_PRIVATE_KEY_HPP
Base class for key parameters.
Definition: key-params.hpp:36
Abstraction of a private key in crypto transformations.
Definition: private-key.hpp:39
friend unique_ptr< PrivateKey > generatePrivateKey(const KeyParams &)
Generate a private key according to keyParams.
void savePkcs8(std::ostream &os, const char *pw, size_t pwLen) const
Save the private key in encrypted PKCS#8 format into a stream os.
void savePkcs1(std::ostream &os) const
Save the private key in PKCS#1 format into a stream os.
std::function< int(char *buf, size_t bufSize, bool shouldConfirm)> PasswordCallback
Callback for application to handle password input.
Definition: private-key.hpp:55
ConstBufferPtr getKeyDigest(DigestAlgorithm algo) const
Returns a digest of the private key.
void loadRaw(KeyType type, span< const uint8_t > buf)
Load a raw private key from a buffer buf.
void loadPkcs8Base64(span< const uint8_t > buf, const char *pw, size_t pwLen)
Load the private key in base64-encoded encrypted PKCS#8 format from a buffer buf with passphrase pw.
void loadPkcs1Base64(span< const uint8_t > buf)
Load the private key in base64-encoded PKCS#1 format from a buffer buf.
void savePkcs1Base64(std::ostream &os) const
Save the private key in base64-encoded PKCS#1 format into a stream os.
void loadPkcs1(span< const uint8_t > buf)
Load the private key in PKCS#1 format from a buffer buf.
ConstBufferPtr derivePublicKey() const
void loadPkcs8(span< const uint8_t > buf, const char *pw, size_t pwLen)
Load the private key in encrypted PKCS#8 format from a buffer buf with passphrase pw.
void savePkcs8Base64(std::ostream &os, const char *pw, size_t pwLen) const
Save the private key in base64-encoded encrypted PKCS#8 format into a stream os.
ConstBufferPtr decrypt(span< const uint8_t > cipherText) const
KeyType getKeyType() const
Returns the type of the private key.
Definition: private-key.cpp:79
PrivateKey()
Creates an empty private key instance.
Definition: private-key.cpp:71
size_t getKeySize() const
Returns the size of the private key in bits.
Definition: private-key.cpp:97
The module to verify signatures.
Common includes and macros used throughout the library.
unique_ptr< PrivateKey > generatePrivateKey(const KeyParams &keyParams)
Generate a private key according to keyParams.
Definition: data.cpp:25
KeyType
The type of a cryptographic key.
std::shared_ptr< const Buffer > ConstBufferPtr
Definition: buffer.hpp:140