Botan: Botan::RSA_PrivateKey Class Reference

Botan 1.10.17

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::RSA_PrivateKey Class Reference

`#include <rsa.h>`

Inheritance diagram for Botan::RSA_PrivateKey:

## Public Member Functions
std::string | algo_name () const
AlgorithmIdentifier | algorithm_identifier () const
bool | check_key (RandomNumberGenerator &rng, bool) const
const BigInt & | get_c () const
const BigInt & | get_d () const
const BigInt & | get_d1 () const
const BigInt & | get_d2 () const
const BigInt & | get_e () const
const BigInt & | get_n () const
virtual OID | get_oid () const
const BigInt & | get_p () const
const BigInt & | get_q () const
size_t | max_input_bits () const
virtual size_t | message_part_size () const
virtual size_t | message_parts () const
virtual AlgorithmIdentifier | pkcs8_algorithm_identifier () const
MemoryVector< byte > | pkcs8_private_key () const
| RSA_PrivateKey (const AlgorithmIdentifier &alg_id, const MemoryRegion< byte > &key_bits, RandomNumberGenerator &rng)
| RSA_PrivateKey (RandomNumberGenerator &rng, const BigInt &p, const BigInt &q, const BigInt &e, const BigInt &d=0, const BigInt &n=0)
| RSA_PrivateKey (RandomNumberGenerator &rng, size_t bits, size_t exp=65537)
MemoryVector< byte > | x509_subject_public_key () const

## Protected Member Functions
void | gen_check (RandomNumberGenerator &rng) const
virtual void | load_check (RandomNumberGenerator &rng) const
void | load_check (RandomNumberGenerator &rng) const

## Protected Attributes
BigInt | c
BigInt | d
BigInt | d1
BigInt | d2
BigInt | e
BigInt | n
BigInt | p
BigInt | q

## Detailed Description

RSA Private Key

Definition at line 47 of file rsa.h.

## Constructor & Destructor Documentation

## ◆ RSA_PrivateKey() [1/3]

Botan::RSA_PrivateKey::RSA_PrivateKey | ( | const AlgorithmIdentifier & | alg_id,
|  | const MemoryRegion< byte > & | key_bits,
|  | RandomNumberGenerator & | rng
| ) |  |
| inline

Definition at line 53 of file rsa.h.

55 :
56 IF_Scheme_PrivateKey(rng, alg_id, key_bits) {}
Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey
IF_Scheme_PrivateKey()
Definition: if_algo.h:99

## ◆ RSA_PrivateKey() [2/3]

Botan::RSA_PrivateKey::RSA_PrivateKey | ( | RandomNumberGenerator & | rng,
|  | const BigInt & | p,
|  | const BigInt & | q,
|  | const BigInt & | e,
|  | const BigInt & | d = `0`,
|  | const BigInt & | n = `0`
| ) |  |
| inline

Construct a private key from the specified parameters.

Parameters

  rng | a random number generator
  p | the first prime
  q | the second prime
  e | the exponent
  d | if specified, this has to be d with exp * d = 1 mod (p - 1, q - 1). Leave it as 0 if you wish to the constructor to calculate it.
  n | if specified, this must be n = p * q. Leave it as 0 if you wish to the constructor to calculate it.

Definition at line 70 of file rsa.h.

73 :
74 IF_Scheme_PrivateKey(rng, p, q, e, d, n) {}
Botan::IF_Scheme_PublicKey::n
BigInt n
Definition: if_algo.h:51
Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey
IF_Scheme_PrivateKey()
Definition: if_algo.h:99
Botan::IF_Scheme_PublicKey::e
BigInt e
Definition: if_algo.h:51
Botan::IF_Scheme_PrivateKey::q
BigInt q
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::d
BigInt d
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::p
BigInt p
Definition: if_algo.h:101

## ◆ RSA_PrivateKey() [3/3]

Botan::RSA_PrivateKey::RSA_PrivateKey | ( | RandomNumberGenerator & | rng,
|  | size_t | bits,
|  | size_t | exp = `65537`
| ) |  |

Create a new private key with the specified bit length

Parameters

  rng | the random number generator to use
  bits | the desired bit length of the private key
  exp | the public exponent to be used

Definition at line 20 of file rsa.cpp.

22 {
23 if(bits < 512)
24 throw Invalid_Argument(algo_name() + ": Can't make a key that is only " +
25 to_string(bits) + " bits long");
26 if(exp < 3 || exp % 2 == 0)
27 throw Invalid_Argument(algo_name() + ": Invalid encryption exponent");
28
29 e = exp;
30
31 do
32 {
33 p = random_prime(rng, (bits + 1) / 2, e);
34 q = random_prime(rng, bits - p.bits(), e);
35 n = p * q;
36 } while(n.bits() != bits);
37
38 d = inverse_mod(e, lcm(p - 1, q - 1));
39 d1 = d % (p - 1);
40 d2 = d % (q - 1);
41 c = inverse_mod(q, p);
42
43 gen_check(rng);
44 }
Botan::IF_Scheme_PublicKey::n
BigInt n
Definition: if_algo.h:51
Botan::IF_Scheme_PrivateKey::d2
BigInt d2
Definition: if_algo.h:101
Botan::BigInt::bits
size_t bits() const
Definition: bigint.cpp:254
Botan::RSA_PublicKey::algo_name
std::string algo_name() const
Definition: rsa.h:24
Botan::IF_Scheme_PublicKey::e
BigInt e
Definition: if_algo.h:51
Botan::Invalid_Argument
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20
Botan::Private_Key::gen_check
void gen_check(RandomNumberGenerator &rng) const
Definition: pk_keys.cpp:49
Botan::IF_Scheme_PrivateKey::d1
BigInt d1
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::q
BigInt q
Definition: if_algo.h:101
Botan::inverse_mod
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:314
Botan::IF_Scheme_PrivateKey::d
BigInt d
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::c
BigInt c
Definition: if_algo.h:101
Botan::to_string
std::string to_string(u64bit n, size_t min_len)
Definition: parsing.cpp:42
Botan::lcm
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:195
Botan::random_prime
BigInt random_prime(RandomNumberGenerator &rng, size_t bits, const BigInt &coprime, size_t equiv, size_t modulo)
Definition: make_prm.cpp:17
Botan::IF_Scheme_PrivateKey::p
BigInt p
Definition: if_algo.h:101

## Member Function Documentation

## ◆ algo_name()

std::string Botan::RSA_PublicKey::algo_name | ( |  | ) | const
| inlinevirtualinherited

Get the name of the underlying public key scheme.

Returns
  name of the public key scheme

Implements Botan::Public_Key.

Definition at line 24 of file rsa.h.

24 { return "RSA"; }

## ◆ algorithm_identifier()

AlgorithmIdentifier Botan::IF_Scheme_PublicKey::algorithm_identifier | ( |  | ) | const
| virtualinherited

Returns
  X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 15 of file if_algo.cpp.

References Botan::Public_Key::get_oid(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

16 {
17 return AlgorithmIdentifier(get_oid(),
18 AlgorithmIdentifier::USE_NULL_PARAM);
19 }
Botan::Public_Key::get_oid
virtual OID get_oid() const
Definition: pk_keys.cpp:17
Botan::AlgorithmIdentifier::USE_NULL_PARAM
Definition: alg_id.h:23

## ◆ check_key()

bool Botan::RSA_PrivateKey::check_key | ( | RandomNumberGenerator & | rng,
|  | bool | strong
| ) |  | const
| virtual

Test the key values for consistency.

Parameters

  rng | rng to use
  strong | whether to perform strong and lengthy version of the test

Returns
  true if the test is passed

Reimplemented from Botan::IF_Scheme_PrivateKey.

Definition at line 49 of file rsa.cpp.

50 {
51 if(!IF_Scheme_PrivateKey::check_key(rng, strong))
52 return false;
53
54 if(!strong)
55 return true;
56
57 if((e * d) % lcm(p - 1, q - 1) != 1)
58 return false;
59
60 return KeyPair::signature_consistency_check(rng, *this, "EMSA4(SHA-1)");
61 }
Botan::KeyPair::signature_consistency_check
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &key, const std::string &padding)
Definition: keypair.cpp:47
Botan::IF_Scheme_PublicKey::e
BigInt e
Definition: if_algo.h:51
Botan::IF_Scheme_PrivateKey::q
BigInt q
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::d
BigInt d
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::check_key
bool check_key(RandomNumberGenerator &rng, bool) const
Definition: if_algo.cpp:121
Botan::lcm
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:195
Botan::IF_Scheme_PrivateKey::p
BigInt p
Definition: if_algo.h:101

## ◆ gen_check()

void Botan::Private_Key::gen_check | ( | RandomNumberGenerator & | rng | ) | const
| protectedinherited

Self-test after generating a key

Parameters

  rng | a random number generator

Definition at line 49 of file pk_keys.cpp.

50 {
51 if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_GENERATE))
52 throw Self_Test_Failure(algo_name() + " private key generation failed");
53 }
Botan::Public_Key::check_key
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0

## ◆ get_c()

const BigInt& Botan::IF_Scheme_PrivateKey::get_c | ( |  | ) | const
| inlineinherited

Definition at line 92 of file if_algo.h.

92 { return c; }
Botan::IF_Scheme_PrivateKey::c
BigInt c
Definition: if_algo.h:101

## ◆ get_d()

const BigInt& Botan::IF_Scheme_PrivateKey::get_d | ( |  | ) | const
| inlineinherited

Get d with exp * d = 1 mod (p - 1, q - 1).

Returns
  d

Definition at line 90 of file if_algo.h.

90 { return d; }
Botan::IF_Scheme_PrivateKey::d
BigInt d
Definition: if_algo.h:101

## ◆ get_d1()

const BigInt& Botan::IF_Scheme_PrivateKey::get_d1 | ( |  | ) | const
| inlineinherited

Definition at line 93 of file if_algo.h.

93 { return d1; }
Botan::IF_Scheme_PrivateKey::d1
BigInt d1
Definition: if_algo.h:101

## ◆ get_d2()

const BigInt& Botan::IF_Scheme_PrivateKey::get_d2 | ( |  | ) | const
| inlineinherited

Definition at line 94 of file if_algo.h.

94 { return d2; }
Botan::IF_Scheme_PrivateKey::d2
BigInt d2
Definition: if_algo.h:101

## ◆ get_e()

const BigInt& Botan::IF_Scheme_PublicKey::get_e | ( |  | ) | const
| inlineinherited

Returns
  public exponent

Definition at line 44 of file if_algo.h.

44 { return e; }
Botan::IF_Scheme_PublicKey::e
BigInt e
Definition: if_algo.h:51

## ◆ get_n()

const BigInt& Botan::IF_Scheme_PublicKey::get_n | ( |  | ) | const
| inlineinherited

Returns
  public modulus

Definition at line 39 of file if_algo.h.

39 { return n; }
Botan::IF_Scheme_PublicKey::n
BigInt n
Definition: if_algo.h:51

## ◆ get_oid()

OID Botan::Public_Key::get_oid | ( |  | ) | const
| virtualinherited

Get the OID of the underlying public key scheme.

Returns
  OID of the public key scheme

Definition at line 17 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::OIDS::lookup().

Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::IF_Scheme_PublicKey::algorithm_identifier(), and Botan::EC_PublicKey::algorithm_identifier().

18 {
19 try {
20 return OIDS::lookup(algo_name());
21 }
22 catch(Lookup_Error)
23 {
24 throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
25 }
26 }
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0
Botan::OIDS::lookup
std::string lookup(const OID &oid)
Definition: oids.cpp:31

## ◆ get_p()

const BigInt& Botan::IF_Scheme_PrivateKey::get_p | ( |  | ) | const
| inlineinherited

Get the first prime p.

Returns
  prime p

Definition at line 78 of file if_algo.h.

78 { return p; }
Botan::IF_Scheme_PrivateKey::p
BigInt p
Definition: if_algo.h:101

## ◆ get_q()

const BigInt& Botan::IF_Scheme_PrivateKey::get_q | ( |  | ) | const
| inlineinherited

Get the second prime q.

Returns
  prime q

Definition at line 84 of file if_algo.h.

84 { return q; }
Botan::IF_Scheme_PrivateKey::q
BigInt q
Definition: if_algo.h:101

## ◆ load_check() [1/2]

void Botan::Public_Key::load_check | ( | RandomNumberGenerator & | rng | ) | const
| protectedvirtualinherited

Self-test after loading a key

Parameters

  rng | a random number generator

Reimplemented in Botan::Private_Key.

Definition at line 31 of file pk_keys.cpp.

32 {
33 if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
34 throw Invalid_Argument(algo_name() + ": Invalid public key");
35 }
Botan::Public_Key::check_key
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0
Botan::Invalid_Argument
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20

## ◆ load_check() [2/2]

void Botan::Private_Key::load_check | ( | RandomNumberGenerator & | rng | ) | const
| protectedvirtualinherited

Self-test after loading a key

Parameters

  rng | a random number generator

Reimplemented from Botan::Public_Key.

Definition at line 40 of file pk_keys.cpp.

41 {
42 if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_LOAD))
43 throw Invalid_Argument(algo_name() + ": Invalid private key");
44 }
Botan::Public_Key::check_key
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0
Botan::Invalid_Argument
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20

## ◆ max_input_bits()

size_t Botan::IF_Scheme_PublicKey::max_input_bits | ( |  | ) | const
| inlinevirtualinherited

Get the maximum message size in bits supported by this public key.

Returns
  maximum message size in bits

Implements Botan::Public_Key.

Definition at line 46 of file if_algo.h.

46 { return (n.bits() - 1); }
Botan::IF_Scheme_PublicKey::n
BigInt n
Definition: if_algo.h:51
Botan::BigInt::bits
size_t bits() const
Definition: bigint.cpp:254

## ◆ message_part_size()

virtual size_t Botan::Public_Key::message_part_size | ( |  | ) | const
| inlinevirtualinherited

Find out the message part size supported by this scheme/key.

Returns
  size of the message parts in bits

Reimplemented in Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 56 of file pk_keys.h.

56 { return 0; }

## ◆ message_parts()

virtual size_t Botan::Public_Key::message_parts | ( |  | ) | const
| inlinevirtualinherited

Find out the number of message parts supported by this scheme.

Returns
  number of message parts

Reimplemented in Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 50 of file pk_keys.h.

Referenced by Botan::EAC_Signed_Object::check_signature(), and Botan::X509_Object::check_signature().

50 { return 1; }

## ◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier | ( |  | ) | const
| inlinevirtualinherited

Returns
  PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Definition at line 98 of file pk_keys.h.

Referenced by Botan::PKCS8::BER_encode().

99 { return algorithm_identifier(); }
Botan::Public_Key::algorithm_identifier
virtual AlgorithmIdentifier algorithm_identifier() const =0

## ◆ pkcs8_private_key()

MemoryVector< byte > Botan::IF_Scheme_PrivateKey::pkcs8_private_key | ( |  | ) | const
| virtualinherited

Returns
  PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 52 of file if_algo.cpp.

References Botan::IF_Scheme_PrivateKey::c, Botan::IF_Scheme_PrivateKey::d, Botan::IF_Scheme_PrivateKey::d1, Botan::IF_Scheme_PrivateKey::d2, Botan::IF_Scheme_PublicKey::e, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::IF_Scheme_PublicKey::n, Botan::IF_Scheme_PrivateKey::p, Botan::IF_Scheme_PrivateKey::q, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

53 {
54 return DER_Encoder()
55 .start_cons(SEQUENCE)
56 .encode(static_cast<size_t>(0))
57 .encode(n)
58 .encode(e)
59 .encode(d)
60 .encode(p)
61 .encode(q)
62 .encode(d1)
63 .encode(d2)
64 .encode(c)
65 .end_cons()
66 .get_contents();
67 }
Botan::IF_Scheme_PublicKey::n
BigInt n
Definition: if_algo.h:51
Botan::IF_Scheme_PrivateKey::d2
BigInt d2
Definition: if_algo.h:101
Botan::IF_Scheme_PublicKey::e
BigInt e
Definition: if_algo.h:51
Botan::IF_Scheme_PrivateKey::d1
BigInt d1
Definition: if_algo.h:101
Botan::SEQUENCE
Definition: asn1_int.h:35
Botan::IF_Scheme_PrivateKey::q
BigInt q
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::d
BigInt d
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::c
BigInt c
Definition: if_algo.h:101
Botan::IF_Scheme_PrivateKey::p
BigInt p
Definition: if_algo.h:101

## ◆ x509_subject_public_key()

MemoryVector< byte > Botan::IF_Scheme_PublicKey::x509_subject_public_key | ( |  | ) | const
| virtualinherited

Returns
  X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Definition at line 21 of file if_algo.cpp.

References Botan::IF_Scheme_PublicKey::e, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::IF_Scheme_PublicKey::n, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

22 {
23 return DER_Encoder()
24 .start_cons(SEQUENCE)
25 .encode(n)
26 .encode(e)
27 .end_cons()
28 .get_contents();
29 }
Botan::IF_Scheme_PublicKey::n
BigInt n
Definition: if_algo.h:51
Botan::IF_Scheme_PublicKey::e
BigInt e
Definition: if_algo.h:51
Botan::SEQUENCE
Definition: asn1_int.h:35

## Member Data Documentation

## ◆ c

BigInt Botan::IF_Scheme_PrivateKey::c
| protectedinherited

Definition at line 101 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::pkcs8_private_key().

## ◆ d

BigInt Botan::IF_Scheme_PrivateKey::d
| protectedinherited

Definition at line 101 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::pkcs8_private_key().

## ◆ d1

BigInt Botan::IF_Scheme_PrivateKey::d1
| protectedinherited

Definition at line 101 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::pkcs8_private_key().

## ◆ d2

BigInt Botan::IF_Scheme_PrivateKey::d2
| protectedinherited

Definition at line 101 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::pkcs8_private_key().

## ◆ e

BigInt Botan::IF_Scheme_PublicKey::e
| protectedinherited

Definition at line 51 of file if_algo.h.

Referenced by Botan::IF_Scheme_PublicKey::check_key(), Botan::IF_Scheme_PublicKey::IF_Scheme_PublicKey(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), and Botan::IF_Scheme_PublicKey::x509_subject_public_key().

## ◆ n

BigInt Botan::IF_Scheme_PublicKey::n
| protectedinherited

Definition at line 51 of file if_algo.h.

Referenced by Botan::IF_Scheme_PublicKey::check_key(), Botan::IF_Scheme_PublicKey::IF_Scheme_PublicKey(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), and Botan::IF_Scheme_PublicKey::x509_subject_public_key().

## ◆ p

BigInt Botan::IF_Scheme_PrivateKey::p
| protectedinherited

Definition at line 101 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::pkcs8_private_key().

## ◆ q

BigInt Botan::IF_Scheme_PrivateKey::q
| protectedinherited

Definition at line 101 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::pkcs8_private_key().

The documentation for this class was generated from the following files:

- src/pubkey/rsa/rsa.h
- src/pubkey/rsa/rsa.cpp