Botan 3.8.1
Crypto and TLS for C&
|
#include <rsa.h>
Public Member Functions | |
virtual Signature_Format | _default_x509_signature_format () const |
virtual std::optional< size_t > | _signature_element_size_for_DER_encoding () const |
std::string | algo_name () const override |
AlgorithmIdentifier | algorithm_identifier () const override |
bool | check_key (RandomNumberGenerator &rng, bool) const override |
std::unique_ptr< PK_Ops::Decryption > | create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::KEM_Decryption > | create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (std::string_view params, std::string_view provider) const override |
virtual std::unique_ptr< PK_Ops::Key_Agreement > | create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::Verification > | create_verification_op (std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::Verification > | create_x509_verification_op (const AlgorithmIdentifier &alg_id, std::string_view provider) const override |
Signature_Format | default_x509_signature_format () const |
size_t | estimated_strength () const override |
std::string | fingerprint_private (std::string_view alg) const |
std::string | fingerprint_public (std::string_view alg="SHA-256") const |
std::unique_ptr< Private_Key > | generate_another (RandomNumberGenerator &rng) const override |
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_int_field (std::string_view field) const override |
const BigInt & | get_n () const |
OID | get_oid () const |
const BigInt & | get_p () const |
const BigInt & | get_q () const |
size_t | key_length () const override |
size_t | message_part_size () const |
size_t | message_parts () const |
virtual OID | object_identifier () const |
virtual AlgorithmIdentifier | pkcs8_algorithm_identifier () const |
std::shared_ptr< const RSA_Private_Data > | private_data () const |
secure_vector< uint8_t > | private_key_bits () const override |
secure_vector< uint8_t > | private_key_info () const |
std::shared_ptr< const RSA_Public_Data > | public_data () const |
std::unique_ptr< Public_Key > | public_key () const override |
std::vector< uint8_t > | public_key_bits () const override |
virtual secure_vector< uint8_t > | raw_private_key_bits () const |
std::vector< uint8_t > | raw_public_key_bits () const override |
virtual std::optional< uint64_t > | remaining_operations () const |
Retrieves the number of remaining operations if this is a stateful private key. | |
RSA_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits) | |
RSA_PrivateKey (const BigInt &p, const BigInt &q, const BigInt &e, const BigInt &d=BigInt::zero(), const BigInt &n=BigInt::zero()) | |
RSA_PrivateKey (RandomNumberGenerator &rng, size_t bits, size_t exp=65537) | |
virtual bool | stateful_operation () const |
std::vector< uint8_t > | subject_public_key () const |
bool | supports_operation (PublicKeyOperation op) const override |
Protected Member Functions | |
void | init (BigInt &&n, BigInt &&e) |
Protected Attributes | |
std::shared_ptr< const RSA_Public_Data > | m_public |
Botan::RSA_PrivateKey::RSA_PrivateKey | ( | const AlgorithmIdentifier & | alg_id, |
std::span< const uint8_t > | key_bits ) |
Load a private key.
alg_id | the X.509 algorithm identifier |
key_bits | PKCS#1 RSAPrivateKey bits |
Definition at line 259 of file rsa.cpp.
References Botan::BER_Decoder::decode_and_check(), Botan::RSA_PublicKey::init(), and Botan::BER_Decoder::start_sequence().
Botan::RSA_PrivateKey::RSA_PrivateKey | ( | const BigInt & | p, |
const BigInt & | q, | ||
const BigInt & | e, | ||
const BigInt & | d = BigInt::zero(), | ||
const BigInt & | n = BigInt::zero() ) |
Construct a private key from the specified parameters.
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 280 of file rsa.cpp.
References Botan::compute_rsa_secret_exponent(), Botan::ct_modulo(), Botan::RSA_PublicKey::init(), Botan::inverse_mod_secret_prime(), Botan::BigInt::is_zero(), and Botan::lcm().
Botan::RSA_PrivateKey::RSA_PrivateKey | ( | RandomNumberGenerator & | rng, |
size_t | bits, | ||
size_t | exp = 65537 ) |
Create a new private key with the specified bit length
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 313 of file rsa.cpp.
References Botan::BigInt::bits(), BOTAN_DEBUG_ASSERT, Botan::compute_rsa_secret_exponent(), Botan::ct_modulo(), Botan::fmt(), Botan::BigInt::from_u64(), Botan::generate_rsa_prime(), Botan::RSA_PublicKey::init(), Botan::inverse_mod_secret_prime(), Botan::lcm(), and Botan::low_zero_bits().
|
virtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 30 of file pk_keys.cpp.
References _signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.
Referenced by Botan::X509_Object::choose_sig_format(), Botan::Public_Key::default_x509_signature_format(), and Botan::PK_Verifier::PK_Verifier().
|
inlinevirtualinherited |
Certain signatures schemes such as ECDSA have more than one element, and certain unfortunate protocols decided the thing to do was not concatenate them as normally done, but instead DER encode each of the elements as independent values.
If this returns a value x then the signature is checked to be exactly 2*x bytes and split in half for DER encoding.
Reimplemented in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.
Definition at line 137 of file pk_keys.h.
Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().
|
inlineoverridevirtualinherited |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 41 of file rsa.h.
Referenced by Botan::RSA_PrivateKey::create_decryption_op(), create_encryption_op(), Botan::RSA_PrivateKey::create_kem_decryption_op(), create_kem_encryption_op(), Botan::RSA_PrivateKey::create_signature_op(), create_verification_op(), and create_x509_verification_op().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 184 of file rsa.cpp.
References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.
Referenced by Botan::TPM2::RSA_PrivateKey::public_key().
|
overridevirtual |
Implements Botan::Asymmetric_Key.
Definition at line 393 of file rsa.cpp.
References Botan::ct_modulo(), get_c(), get_d(), get_d1(), get_d2(), Botan::RSA_PublicKey::get_e(), Botan::RSA_PublicKey::get_n(), get_p(), get_q(), Botan::inverse_mod_secret_prime(), Botan::is_prime(), Botan::lcm(), and Botan::KeyPair::signature_consistency_check().
|
overridevirtual |
This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h
Return an decryption operation for this key/params or throw
rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it. |
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Private_Key.
Definition at line 816 of file rsa.cpp.
References Botan::RSA_PublicKey::algo_name().
|
overridevirtualinherited |
This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h
Return an encryption operation for this key/params or throw
rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it. |
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Reimplemented in Botan::TPM2::RSA_PublicKey.
Definition at line 731 of file rsa.cpp.
References algo_name().
|
overridevirtual |
This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h
Return a KEM decryption operation for this key/params or throw
rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it. |
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Private_Key.
Definition at line 826 of file rsa.cpp.
References Botan::RSA_PublicKey::algo_name().
|
overridevirtualinherited |
This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h
Return a KEM encryption operation for this key/params or throw
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 740 of file rsa.cpp.
References algo_name().
|
virtualinherited |
This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h
Return a key agreement operation for this key/params or throw
rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it. |
params | additional parameters |
provider | the provider to use |
Reimplemented in Botan::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.
Definition at line 137 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().
|
overridevirtual |
This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h
Return a signature operation for this key/params or throw
rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it. |
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Private_Key.
Definition at line 836 of file rsa.cpp.
References Botan::RSA_PublicKey::algo_name().
|
overridevirtualinherited |
This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h
Return a verification operation for this key/params or throw
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Reimplemented in Botan::TPM2::RSA_PublicKey.
Definition at line 748 of file rsa.cpp.
References algo_name().
|
overridevirtualinherited |
This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h
Return a verification operation for this combination of key and signature algorithm or throw.
signature_algorithm | is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable. |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 807 of file rsa.cpp.
References algo_name().
|
inlineinherited |
Definition at line 228 of file pk_keys.h.
References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().
Referenced by default_x509_signature_format().
|
overridevirtualinherited |
Return the estimated strength of the underlying key against the best currently known attack. Note that this ignores anything but pure attacks against the key itself and do not take into account padding schemes, usage mistakes, etc which might reduce the strength. However it does suffice to provide an upper bound.
Implements Botan::Asymmetric_Key.
Definition at line 180 of file rsa.cpp.
References Botan::if_work_factor(), and key_length().
|
inherited |
Definition at line 94 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and private_key_bits().
Referenced by Botan::Certificate_Store_In_SQL::find_certs_for_key(), Botan::Certificate_Store_In_SQL::insert_key(), and Botan::Certificate_Store_In_SQL::remove_key().
|
inherited |
Definition at line 87 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and subject_public_key().
Referenced by public_key_bits().
|
overridevirtualinherited |
Generate another (cryptographically independent) key pair using the same algorithm parameters as this key. This is most useful for algorithms that support PublicKeyOperation::KeyAgreement to generate a fitting ephemeral key pair. For other key types it might throw Not_Implemented.
Implements Botan::Asymmetric_Key.
Reimplemented in Botan::TPM2::RSA_PublicKey.
Definition at line 139 of file rsa.cpp.
References m_public.
const BigInt & Botan::RSA_PrivateKey::get_c | ( | ) | const |
Definition at line 242 of file rsa.cpp.
Referenced by check_key(), and private_key_bits().
const BigInt & Botan::RSA_PrivateKey::get_d | ( | ) | const |
Get d with exp * d = 1 mod (p - 1, q - 1).
Definition at line 238 of file rsa.cpp.
Referenced by check_key(), and private_key_bits().
const BigInt & Botan::RSA_PrivateKey::get_d1 | ( | ) | const |
Definition at line 246 of file rsa.cpp.
Referenced by check_key(), and private_key_bits().
const BigInt & Botan::RSA_PrivateKey::get_d2 | ( | ) | const |
Definition at line 250 of file rsa.cpp.
Referenced by check_key(), and private_key_bits().
|
inherited |
Definition at line 147 of file rsa.cpp.
References m_public.
Referenced by Botan::RSA_PrivateKey::check_key(), check_key(), Botan::RSA_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::public_key(), and public_key_bits().
|
overridevirtual |
Access an algorithm specific field
If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.
Some algorithms may not implement this method at all.
This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.
TODO(Botan4) Change this to return by value
Reimplemented from Botan::Asymmetric_Key.
Definition at line 368 of file rsa.cpp.
References Botan::RSA_PublicKey::get_int_field().
|
inherited |
Definition at line 143 of file rsa.cpp.
References m_public.
Referenced by Botan::RSA_PrivateKey::check_key(), check_key(), Botan::RSA_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::public_key(), and public_key_bits().
|
inlineinherited |
Deprecated version of object_identifier
Definition at line 161 of file pk_keys.h.
References get_oid(), and Botan::Asymmetric_Key::object_identifier().
Referenced by get_oid().
const BigInt & Botan::RSA_PrivateKey::get_p | ( | ) | const |
Get the first prime p.
Definition at line 230 of file rsa.cpp.
Referenced by check_key(), and private_key_bits().
const BigInt & Botan::RSA_PrivateKey::get_q | ( | ) | const |
Get the second prime q.
Definition at line 234 of file rsa.cpp.
Referenced by check_key(), and private_key_bits().
Definition at line 151 of file rsa.cpp.
References m_public.
Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), RSA_PublicKey(), RSA_PublicKey(), and RSA_PublicKey().
|
overridevirtualinherited |
Return an integer value best approximating the length of the primary security parameter. For example for RSA this will be the size of the modulus, for ECDSA the size of the ECC group, and for McEliece the size of the code will be returned.
Implements Botan::Public_Key.
Definition at line 176 of file rsa.cpp.
References m_public.
Referenced by estimated_strength().
|
inlineinherited |
Returns how large each of the message parts refered to by message_parts() is
This function is public but applications should have few reasons to ever call this.
Definition at line 221 of file pk_keys.h.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().
Referenced by message_part_size().
|
inlineinherited |
Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.
This function is public but applications should have few reasons to ever call this.
Definition at line 208 of file pk_keys.h.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().
Referenced by message_parts().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::Classic_McEliece_PublicKey, Botan::Dilithium_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, and Botan::SphincsPlus_PublicKey.
Definition at line 22 of file pk_keys.cpp.
References algo_name(), Botan::fmt(), and Botan::OID::from_string().
Referenced by Botan::DH_PublicKey::algorithm_identifier(), Botan::DSA_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::Ed448_PublicKey::algorithm_identifier(), Botan::ElGamal_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), Botan::X25519_PublicKey::algorithm_identifier(), Botan::X448_PublicKey::algorithm_identifier(), Botan::XMSS_PublicKey::algorithm_identifier(), estimated_strength(), and Botan::Public_Key::get_oid().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.
Definition at line 323 of file pk_keys.h.
References Botan::Public_Key::algorithm_identifier().
Referenced by private_key_info().
std::shared_ptr< const RSA_Private_Data > Botan::RSA_PrivateKey::private_data | ( | ) | const |
|
overridevirtual |
Implements Botan::Private_Key.
Definition at line 214 of file rsa.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_c(), Botan::DER_Encoder::get_contents(), get_d(), get_d1(), get_d2(), Botan::RSA_PublicKey::get_e(), Botan::RSA_PublicKey::get_n(), get_p(), get_q(), and Botan::DER_Encoder::start_sequence().
|
inherited |
Definition at line 68 of file pk_keys.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, pkcs8_algorithm_identifier(), private_key_bits(), and Botan::DER_Encoder::start_sequence().
Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), Botan::PKCS8::PEM_encode(), and public_key().
|
inherited |
|
overridevirtual |
Allocate a new object for the public key associated with this private key.
Implements Botan::Private_Key.
Definition at line 386 of file rsa.cpp.
References Botan::RSA_PublicKey::get_e(), and Botan::RSA_PublicKey::get_n().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 192 of file rsa.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_e(), get_n(), and Botan::DER_Encoder::start_sequence().
Referenced by Botan::TPM2::RSA_PrivateKey::public_key().
|
virtualinherited |
Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented
Reimplemented in Botan::Classic_McEliece_PrivateKey, Botan::DH_PrivateKey, Botan::Dilithium_PrivateKey, Botan::DSA_PrivateKey, Botan::EC_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::ElGamal_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Kyber_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.
Definition at line 80 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name().
Referenced by private_key_bits().
|
overridevirtualinherited |
For key agreements this is an alias for PK_Key_Agreement_Key::public_value.
Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.
Implements Botan::Public_Key.
Reimplemented in Botan::TPM2::RSA_PublicKey.
Definition at line 188 of file rsa.cpp.
|
inlinevirtualinherited |
Retrieves the number of remaining operations if this is a stateful private key.
Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.
Definition at line 336 of file pk_keys.h.
|
inlinevirtualinherited |
Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.
Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.
Definition at line 329 of file pk_keys.h.
|
inherited |
Definition at line 56 of file pk_keys.cpp.
References algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), public_key_bits(), and Botan::DER_Encoder::start_sequence().
Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), fingerprint_public(), Botan::X509::PEM_encode(), and public_key_bits().
|
overridevirtualinherited |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Reimplemented in Botan::TPM2::RSA_PublicKey.
Definition at line 165 of file rsa.cpp.
References Botan::Encryption, Botan::KeyEncapsulation, and Botan::Signature.
|
protectedinherited |
Definition at line 91 of file rsa.h.
Referenced by generate_another(), get_e(), get_int_field(), get_n(), init(), key_length(), and public_data().