Botan 3.7.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::Encryption > | create_encryption_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 |
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_public (std::string_view alg="SHA-256") const |
std::unique_ptr< Private_Key > | generate_another (RandomNumberGenerator &rng) const override |
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 |
size_t | key_length () const override |
size_t | message_part_size () const |
size_t | message_parts () const |
virtual OID | object_identifier () const |
std::shared_ptr< const RSA_Public_Data > | public_data () const |
std::vector< uint8_t > | public_key_bits () const override |
std::vector< uint8_t > | raw_public_key_bits () const override |
RSA_PublicKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits) | |
RSA_PublicKey (const BigInt &n, const BigInt &e) | |
std::vector< uint8_t > | subject_public_key () const |
bool | supports_operation (PublicKeyOperation op) const override |
Protected Member Functions | |
void | init (BigInt &&n, BigInt &&e) |
RSA_PublicKey ()=default | |
Protected Attributes | |
std::shared_ptr< const RSA_Public_Data > | m_public |
Botan::RSA_PublicKey::RSA_PublicKey | ( | const AlgorithmIdentifier & | alg_id, |
std::span< const uint8_t > | key_bits ) |
Load a public key.
alg_id | the X.509 algorithm identifier |
key_bits | DER encoded public key bits |
Definition at line 157 of file rsa.cpp.
References Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), init, and Botan::BER_Decoder::start_sequence().
|
protecteddefault |
|
virtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 30 of file pk_keys.cpp.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.
Referenced by Botan::X509_Object::choose_sig_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 136 of file pk_keys.h.
Referenced by Botan::Asymmetric_Key::_default_x509_signature_format(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().
|
inlineoverridevirtual |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 41 of file rsa.h.
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 183 of file rsa.cpp.
References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.
|
overridevirtual |
Implements Botan::Asymmetric_Key.
Definition at line 202 of file rsa.cpp.
|
overridevirtual |
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 730 of file rsa.cpp.
|
overridevirtual |
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 739 of file rsa.cpp.
|
overridevirtual |
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 747 of file rsa.cpp.
|
overridevirtual |
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 806 of file rsa.cpp.
|
inlineinherited |
Definition at line 227 of file pk_keys.h.
|
overridevirtual |
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 179 of file rsa.cpp.
References Botan::if_work_factor(), and key_length().
|
inherited |
Definition at line 87 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and Botan::Public_Key::subject_public_key().
|
overridevirtual |
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 138 of file rsa.cpp.
References m_public.
const BigInt & Botan::RSA_PublicKey::get_e | ( | ) | const |
Definition at line 146 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 128 of file rsa.cpp.
References Botan::Asymmetric_Key::get_int_field(), and m_public.
Referenced by Botan::RSA_PrivateKey::get_int_field().
const BigInt & Botan::RSA_PublicKey::get_n | ( | ) | const |
Definition at line 142 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 |
Definition at line 150 of file rsa.cpp.
References m_public.
Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RSA_PrivateKey::RSA_PrivateKey().
|
overridevirtual |
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 175 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.
|
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.
|
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 Botan::Asymmetric_Key::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(), algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), Botan::X25519_PublicKey::algorithm_identifier(), and Botan::X448_PublicKey::algorithm_identifier().
std::shared_ptr< const RSA_Public_Data > Botan::RSA_PublicKey::public_data | ( | ) | const |
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 191 of file rsa.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_e(), get_n(), and Botan::DER_Encoder::start_sequence().
|
overridevirtual |
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 187 of file rsa.cpp.
|
inherited |
Definition at line 56 of file pk_keys.cpp.
References Botan::Public_Key::algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), and Botan::DER_Encoder::start_sequence().
Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().
|
overridevirtual |
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 164 of file rsa.cpp.
References Botan::Encryption, Botan::KeyEncapsulation, and Botan::Signature.
|
protected |
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().