Botan 3.9.0
Crypto and TLS for C&
|
#include <tpm2_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 strong) const override |
std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (Botan::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 (Botan::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 |
const Object & | handles () 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 |
const SessionBundle & | sessions () const |
std::vector< uint8_t > | subject_public_key () const |
bool | supports_operation (PublicKeyOperation op) const override |
Static Public Member Functions | |
static std::unique_ptr< PublicKey > | load_persistent (const std::shared_ptr< Context > &ctx, TPM2_HANDLE persistent_object_handle, const SessionBundle &sessions={}) |
static std::unique_ptr< PublicKey > | load_transient (const std::shared_ptr< Context > &ctx, std::span< const uint8_t > public_blob, const SessionBundle &sessions) |
Protected Member Functions | |
void | init (BigInt &&n, BigInt &&e) |
RSA_PublicKey (Object handle, SessionBundle sessions, const TPM2B_PUBLIC *public_blob) |
Static Protected Member Functions | |
static std::unique_ptr< PublicKey > | create (Object handles, const SessionBundle &sessions) |
Protected Attributes | |
std::shared_ptr< const RSA_Public_Data > | m_public |
Friends | |
class | TPM2::PublicKey |
Definition at line 19 of file tpm2_rsa.h.
|
protected |
Definition at line 29 of file tpm2_rsa.cpp.
References RSA_PublicKey().
Referenced by RSA_PublicKey(), and TPM2::PublicKey.
|
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 186 of file rsa.cpp.
References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.
Referenced by Botan::TPM2::RSA_PrivateKey::public_key().
|
overridevirtualinherited |
Implements Botan::Asymmetric_Key.
Definition at line 205 of file rsa.cpp.
|
staticprotectedinherited |
Definition at line 158 of file tpm2_key.cpp.
References Botan::fmt(), handles(), and sessions().
Referenced by load_persistent(), and load_transient().
|
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.
Definition at line 405 of file tpm2_rsa.cpp.
References BOTAN_UNUSED, Botan::TPM2::PublicKey::handles(), and Botan::TPM2::PublicKey::sessions().
|
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 790 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 verification operation for this key/params or throw
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 392 of file tpm2_rsa.cpp.
References BOTAN_UNUSED, Botan::TPM2::PublicKey::handles(), and Botan::TPM2::PublicKey::sessions().
|
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 857 of file rsa.cpp.
References algo_name().
|
inlineinherited |
Definition at line 229 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 182 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 subject_public_key().
Referenced by public_key_bits().
|
inlineoverridevirtual |
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.
Reimplemented from Botan::TPM2::PublicKey.
Definition at line 22 of file tpm2_rsa.h.
References Botan::TPM2::PublicKey::generate_another().
|
inherited |
Definition at line 148 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().
|
overridevirtualinherited |
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 130 of file rsa.cpp.
References Botan::Asymmetric_Key::get_int_field(), and m_public.
Referenced by Botan::RSA_PrivateKey::get_int_field().
|
inherited |
Definition at line 144 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().
|
inlineinherited |
Definition at line 99 of file tpm2_key.h.
Referenced by create(), Botan::TPM2::RSA_PublicKey::create_encryption_op(), Botan::TPM2::EC_PublicKey::create_verification_op(), and Botan::TPM2::RSA_PublicKey::create_verification_op().
Definition at line 152 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 178 of file rsa.cpp.
References m_public.
Referenced by estimated_strength().
|
staticinherited |
Load a public key that resides in the TPM's persistent storage.
ctx | The TPM context to use |
persistent_object_handle | The handle of the persistent object to load |
sessions | The session bundle to use for loading |
Definition at line 128 of file tpm2_key.cpp.
References create(), and sessions().
|
staticinherited |
Load a public key from the public blob obtained by a TPM key creation.
Transient keys don't reside inside the TPM but must be loaded by the application as required. Once this object is destructed, the transient memory on the TPM is cleared.
ctx | The TPM context to use |
public_blob | The public blob of the key to load |
sessions | The session bundle to use for loading |
Definition at line 134 of file tpm2_key.cpp.
References BOTAN_ASSERT_NONNULL, Botan::TPM2::check_rc(), create(), Botan::TPM2::out_transient_handle(), and sessions().
|
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().
|
inherited |
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 194 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().
|
inlineoverridevirtual |
Reimplemented from Botan::TPM2::PublicKey.
Definition at line 26 of file tpm2_rsa.h.
References Botan::TPM2::PublicKey::raw_public_key_bits().
|
inlineinherited |
Definition at line 101 of file tpm2_key.h.
Referenced by create(), Botan::TPM2::RSA_PublicKey::create_encryption_op(), Botan::TPM2::EC_PublicKey::create_verification_op(), Botan::TPM2::RSA_PublicKey::create_verification_op(), Botan::TPM2::EC_PublicKey::EC_PublicKey(), Botan::TPM2::EC_PublicKey::EC_PublicKey(), load_persistent(), load_transient(), PublicKey(), Botan::TPM2::EC_PublicKey::TPM2::PublicKey, and Botan::TPM2::RSA_PublicKey::TPM2::PublicKey.
|
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().
|
inlineoverridevirtual |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Definition at line 28 of file tpm2_rsa.h.
References Botan::Encryption, and Botan::Signature.
|
friend |
Definition at line 41 of file tpm2_rsa.h.
References RSA_PublicKey(), and Botan::TPM2::PublicKey::sessions().
|
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().