NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2018 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 
27 
28 namespace ndn {
29 
30 class KeyParams;
31 
32 namespace security {
33 namespace 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  typedef function<int(char* buf, size_t bufSize, bool shouldConfirm)> PasswordCallback;
56 
57 public:
63  PrivateKey();
64 
65  ~PrivateKey();
66 
70  KeyType
71  getKeyType() const;
72 
76  void
77  loadPkcs1(const uint8_t* buf, size_t size);
78 
82  void
83  loadPkcs1(std::istream& is);
84 
88  void
89  loadPkcs1Base64(const uint8_t* buf, size_t size);
90 
94  void
95  loadPkcs1Base64(std::istream& is);
96 
101  void
102  loadPkcs8(const uint8_t* buf, size_t size, const char* pw, size_t pwLen);
103 
110  void
111  loadPkcs8(const uint8_t* buf, size_t size, PasswordCallback pwCallback = nullptr);
112 
117  void
118  loadPkcs8(std::istream& is, const char* pw, size_t pwLen);
119 
126  void
127  loadPkcs8(std::istream& is, PasswordCallback pwCallback = nullptr);
128 
134  void
135  loadPkcs8Base64(const uint8_t* buf, size_t size, const char* pw, size_t pwLen);
136 
143  void
144  loadPkcs8Base64(const uint8_t* buf, size_t size, PasswordCallback pwCallback = nullptr);
145 
151  void
152  loadPkcs8Base64(std::istream& is, const char* pw, size_t pwLen);
153 
160  void
161  loadPkcs8Base64(std::istream& is, PasswordCallback pwCallback = nullptr);
162 
166  void
167  savePkcs1(std::ostream& os) const;
168 
172  void
173  savePkcs1Base64(std::ostream& os) const;
174 
178  void
179  savePkcs8(std::ostream& os, const char* pw, size_t pwLen) const;
180 
187  void
188  savePkcs8(std::ostream& os, PasswordCallback pwCallback = nullptr) const;
189 
193  void
194  savePkcs8Base64(std::ostream& os, const char* pw, size_t pwLen) const;
195 
202  void
203  savePkcs8Base64(std::ostream& os, PasswordCallback pwCallback = nullptr) const;
204 
209  derivePublicKey() const;
210 
217  decrypt(const uint8_t* cipherText, size_t cipherLen) const;
218 
219 private:
220  friend class SignerFilter;
221 
227  void*
228  getEvpPkey() const;
229 
230 private:
232  toPkcs1() const;
233 
235  toPkcs8(const char* pw, size_t pwLen) const;
236 
238  toPkcs8(PasswordCallback pwCallback = nullptr) const;
239 
241  rsaDecrypt(const uint8_t* cipherText, size_t cipherLen) const;
242 
243 private:
244  friend unique_ptr<PrivateKey> generatePrivateKey(const KeyParams&);
245 
246  static unique_ptr<PrivateKey>
247  generateRsaKey(uint32_t keySize);
248 
249  static unique_ptr<PrivateKey>
250  generateEcKey(uint32_t keySize);
251 
252 private:
253  class Impl;
254  const unique_ptr<Impl> m_impl;
255 };
256 
265 unique_ptr<PrivateKey>
266 generatePrivateKey(const KeyParams& keyParams);
267 
268 } // namespace transform
269 } // namespace security
270 } // namespace ndn
271 
272 #endif // NDN_CXX_SECURITY_TRANSFORM_PRIVATE_KEY_HPP
Copyright (c) 2011-2015 Regents of the University of California.
void loadPkcs8(const uint8_t *buf, size_t size, const char *pw, size_t pwLen)
Load the private key in encrypted PKCS#8 format from a buffer buf with passphrase pw.
void loadPkcs1Base64(const uint8_t *buf, size_t size)
Load the private key in base64-encoded PKCS#1 format from a buffer buf.
function< int(char *buf, size_t bufSize, bool shouldConfirm)> PasswordCallback
Callback for application to handle password input.
Definition: private-key.hpp:55
void loadPkcs1(const uint8_t *buf, size_t size)
Load the private key in PKCS#1 format from a buffer buf.
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 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.
unique_ptr< PrivateKey > generatePrivateKey(const KeyParams &keyParams)
Generate a private key according to keyParams.
PrivateKey()
Create an empty private key instance.
Definition: private-key.cpp:80
KeyType
The type of a cryptographic key.
void loadPkcs8Base64(const uint8_t *buf, size_t size, const char *pw, size_t pwLen)
Load the private key in base64-encoded encrypted PKCS#8 format from a buffer buf with passphrase pw.
ConstBufferPtr decrypt(const uint8_t *cipherText, size_t cipherLen) const
Abstraction of private key in crypto transformation.
Definition: private-key.hpp:38
friend unique_ptr< PrivateKey > generatePrivateKey(const KeyParams &)
Generate a private key according to keyParams.
Base class of key parameters.
Definition: key-params.hpp:35
ConstBufferPtr derivePublicKey() const
KeyType getKeyType() const
Get the type of the private key.
Definition: private-key.cpp:88
void savePkcs1Base64(std::ostream &os) const
Save the private key in base64-encoded PKCS#1 format into a stream os.
void savePkcs1(std::ostream &os) const
Save the private key in PKCS#1 format into a stream os.
shared_ptr< const Buffer > ConstBufferPtr
Definition: buffer.hpp:126