Botan 3.8.1
Crypto and TLS for C&
|
#include <tpm.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 |
virtual std::unique_ptr< PK_Ops::Decryption > | create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Decryption > | create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (std::string_view params, std::string_view provider) const |
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 |
virtual std::unique_ptr< PK_Ops::Verification > | create_verification_op (std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::Verification > | create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const |
TPM_Context & | ctx () const |
Signature_Format | default_x509_signature_format () const |
size_t | estimated_strength () const override |
std::vector< uint8_t > | export_blob () const |
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 &) const override |
BigInt | get_e () const |
virtual const BigInt & | get_int_field (std::string_view field) const |
BigInt | get_n () const |
OID | get_oid () const |
TSS_HKEY | handle () 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 |
secure_vector< uint8_t > | private_key_bits () const override |
secure_vector< uint8_t > | private_key_info () 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 |
std::string | register_key (TPM_Storage_Type storage_type) |
virtual std::optional< uint64_t > | remaining_operations () const |
Retrieves the number of remaining operations if this is a stateful private key. | |
virtual bool | stateful_operation () const |
std::vector< uint8_t > | subject_public_key () const |
bool | supports_operation (PublicKeyOperation op) const override |
TPM_PrivateKey (TPM_Context &ctx, const std::vector< uint8_t > &blob) | |
TPM_PrivateKey (TPM_Context &ctx, size_t bits, const char *key_password) | |
TPM_PrivateKey (TPM_Context &ctx, std::string_view uuid, TPM_Storage_Type storage_type) | |
Static Public Member Functions | |
static std::vector< std::string > | registered_keys (TPM_Context &ctx) |
Botan::TPM_PrivateKey::TPM_PrivateKey | ( | TPM_Context & | ctx, |
size_t | bits, | ||
const char * | key_password ) |
Definition at line 178 of file tpm.cpp.
References ctx(), and TSPI_CHECK_SUCCESS.
Botan::TPM_PrivateKey::TPM_PrivateKey | ( | TPM_Context & | ctx, |
std::string_view | uuid, | ||
TPM_Storage_Type | storage_type ) |
Definition at line 200 of file tpm.cpp.
References ctx(), TSPI_CHECK_SUCCESS, and Botan::User.
Botan::TPM_PrivateKey::TPM_PrivateKey | ( | TPM_Context & | ctx, |
const std::vector< uint8_t > & | blob ) |
Definition at line 207 of file tpm.cpp.
References ctx(), and TSPI_CHECK_SUCCESS.
|
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().
|
inlineoverridevirtual |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 167 of file tpm.h.
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 284 of file tpm.cpp.
References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.
|
overridevirtual |
Implements Botan::Asymmetric_Key.
Definition at line 310 of file tpm.cpp.
|
virtualinherited |
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 in Botan::ElGamal_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.
Definition at line 119 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().
|
virtualinherited |
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 in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.
Definition at line 98 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
virtualinherited |
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 in Botan::Classic_McEliece_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, and Botan::TLS::Hybrid_KEM_PrivateKey.
Definition at line 125 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().
|
virtualinherited |
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 in Botan::Classic_McEliece_PublicKey, Botan::FrodoKEM_PublicKey, Botan::KEX_to_KEM_Adapter_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, and Botan::TLS::Hybrid_KEM_PublicKey.
Definition at line 104 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
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 375 of file tpm.cpp.
|
virtualinherited |
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 in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.
Definition at line 109 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Verifier::PK_Verifier().
|
virtualinherited |
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 in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.
Definition at line 114 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Verifier::PK_Verifier().
|
inline |
Definition at line 140 of file tpm.h.
Referenced by register_key(), registered_keys(), TPM_PrivateKey(), TPM_PrivateKey(), and TPM_PrivateKey().
|
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().
|
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 276 of file tpm.cpp.
References Botan::if_work_factor(), and key_length().
std::vector< uint8_t > Botan::TPM_PrivateKey::export_blob | ( | ) | const |
|
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().
|
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.
Implements Botan::Asymmetric_Key.
Definition at line 169 of file tpm.h.
BigInt Botan::TPM_PrivateKey::get_e | ( | ) | const |
Definition at line 267 of file tpm.cpp.
References Botan::BigInt::from_bytes().
Referenced by public_key(), and public_key_bits().
|
virtualinherited |
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 in Botan::DH_PrivateKey, Botan::DH_PublicKey, Botan::DSA_PrivateKey, Botan::DSA_PublicKey, Botan::EC_PrivateKey, Botan::EC_PublicKey, Botan::ElGamal_PrivateKey, Botan::ElGamal_PublicKey, Botan::RSA_PrivateKey, and Botan::RSA_PublicKey.
Definition at line 18 of file pk_keys.cpp.
References algo_name().
Referenced by estimated_strength(), Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().
BigInt Botan::TPM_PrivateKey::get_n | ( | ) | const |
Definition at line 258 of file tpm.cpp.
References Botan::BigInt::from_bytes().
Referenced by key_length(), 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().
|
inline |
|
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 280 of file tpm.cpp.
References Botan::BigInt::bits(), and get_n().
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().
|
overridevirtual |
Implements Botan::Private_Key.
Definition at line 298 of file tpm.cpp.
|
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().
|
overridevirtual |
Returns a copy of the public key
Implements Botan::Private_Key.
Definition at line 306 of file tpm.cpp.
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 288 of file tpm.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_e(), get_n(), and Botan::DER_Encoder::start_sequence().
|
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().
|
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.
Definition at line 294 of file tpm.cpp.
std::string Botan::TPM_PrivateKey::register_key | ( | TPM_Storage_Type | storage_type | ) |
If the key is not currently registered under a known UUID, generates a new random UUID and registers the key. Returns the access URL.
Definition at line 214 of file tpm.cpp.
References ctx(), TSPI_CHECK_SUCCESS, and Botan::User.
|
static |
Definition at line 238 of file tpm.cpp.
References ctx(), and TSPI_CHECK_SUCCESS.
|
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().
|
inlineoverridevirtual |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Definition at line 173 of file tpm.h.
References Botan::Signature.