xref: /aosp_15_r20/external/cronet/crypto/rsa_private_key.h (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard Worker // Copyright 2012 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker 
5*6777b538SAndroid Build Coastguard Worker #ifndef CRYPTO_RSA_PRIVATE_KEY_H_
6*6777b538SAndroid Build Coastguard Worker #define CRYPTO_RSA_PRIVATE_KEY_H_
7*6777b538SAndroid Build Coastguard Worker 
8*6777b538SAndroid Build Coastguard Worker #include <stddef.h>
9*6777b538SAndroid Build Coastguard Worker #include <stdint.h>
10*6777b538SAndroid Build Coastguard Worker 
11*6777b538SAndroid Build Coastguard Worker #include <memory>
12*6777b538SAndroid Build Coastguard Worker #include <vector>
13*6777b538SAndroid Build Coastguard Worker 
14*6777b538SAndroid Build Coastguard Worker #include "base/containers/span.h"
15*6777b538SAndroid Build Coastguard Worker #include "build/build_config.h"
16*6777b538SAndroid Build Coastguard Worker #include "crypto/crypto_export.h"
17*6777b538SAndroid Build Coastguard Worker #include "third_party/boringssl/src/include/openssl/base.h"
18*6777b538SAndroid Build Coastguard Worker 
19*6777b538SAndroid Build Coastguard Worker namespace crypto {
20*6777b538SAndroid Build Coastguard Worker 
21*6777b538SAndroid Build Coastguard Worker // Encapsulates an RSA private key. Can be used to generate new keys, export
22*6777b538SAndroid Build Coastguard Worker // keys to other formats, or to extract a public key.
23*6777b538SAndroid Build Coastguard Worker // TODO(hclam): This class should be ref-counted so it can be reused easily.
24*6777b538SAndroid Build Coastguard Worker class CRYPTO_EXPORT RSAPrivateKey {
25*6777b538SAndroid Build Coastguard Worker  public:
26*6777b538SAndroid Build Coastguard Worker   RSAPrivateKey(const RSAPrivateKey&) = delete;
27*6777b538SAndroid Build Coastguard Worker   RSAPrivateKey& operator=(const RSAPrivateKey&) = delete;
28*6777b538SAndroid Build Coastguard Worker 
29*6777b538SAndroid Build Coastguard Worker   ~RSAPrivateKey();
30*6777b538SAndroid Build Coastguard Worker 
31*6777b538SAndroid Build Coastguard Worker   // Create a new random instance. Can return NULL if initialization fails.
32*6777b538SAndroid Build Coastguard Worker   static std::unique_ptr<RSAPrivateKey> Create(uint16_t num_bits);
33*6777b538SAndroid Build Coastguard Worker 
34*6777b538SAndroid Build Coastguard Worker   // Create a new instance by importing an existing private key. The format is
35*6777b538SAndroid Build Coastguard Worker   // an ASN.1-encoded PrivateKeyInfo block from PKCS #8. This can return NULL if
36*6777b538SAndroid Build Coastguard Worker   // initialization fails.
37*6777b538SAndroid Build Coastguard Worker   static std::unique_ptr<RSAPrivateKey> CreateFromPrivateKeyInfo(
38*6777b538SAndroid Build Coastguard Worker       base::span<const uint8_t> input);
39*6777b538SAndroid Build Coastguard Worker 
40*6777b538SAndroid Build Coastguard Worker   // Create a new instance from an existing EVP_PKEY, taking a
41*6777b538SAndroid Build Coastguard Worker   // reference to it. |key| must be an RSA key. Returns NULL on
42*6777b538SAndroid Build Coastguard Worker   // failure.
43*6777b538SAndroid Build Coastguard Worker   static std::unique_ptr<RSAPrivateKey> CreateFromKey(EVP_PKEY* key);
44*6777b538SAndroid Build Coastguard Worker 
key()45*6777b538SAndroid Build Coastguard Worker   EVP_PKEY* key() const { return key_.get(); }
46*6777b538SAndroid Build Coastguard Worker 
47*6777b538SAndroid Build Coastguard Worker   // Creates a copy of the object.
48*6777b538SAndroid Build Coastguard Worker   std::unique_ptr<RSAPrivateKey> Copy() const;
49*6777b538SAndroid Build Coastguard Worker 
50*6777b538SAndroid Build Coastguard Worker   // Exports the private key to a PKCS #8 PrivateKeyInfo block.
51*6777b538SAndroid Build Coastguard Worker   bool ExportPrivateKey(std::vector<uint8_t>* output) const;
52*6777b538SAndroid Build Coastguard Worker 
53*6777b538SAndroid Build Coastguard Worker   // Exports the public key to an X509 SubjectPublicKeyInfo block.
54*6777b538SAndroid Build Coastguard Worker   bool ExportPublicKey(std::vector<uint8_t>* output) const;
55*6777b538SAndroid Build Coastguard Worker 
56*6777b538SAndroid Build Coastguard Worker  private:
57*6777b538SAndroid Build Coastguard Worker   // Constructor is private. Use one of the Create*() methods above instead.
58*6777b538SAndroid Build Coastguard Worker   RSAPrivateKey();
59*6777b538SAndroid Build Coastguard Worker 
60*6777b538SAndroid Build Coastguard Worker   bssl::UniquePtr<EVP_PKEY> key_;
61*6777b538SAndroid Build Coastguard Worker };
62*6777b538SAndroid Build Coastguard Worker 
63*6777b538SAndroid Build Coastguard Worker }  // namespace crypto
64*6777b538SAndroid Build Coastguard Worker 
65*6777b538SAndroid Build Coastguard Worker #endif  // CRYPTO_RSA_PRIVATE_KEY_H_
66