Botan 3.0.0-alpha0
Crypto and TLS for C&
|
#include <tpm.h>
Public Member Functions | |
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, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Decryption > | create_kem_decryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::Key_Agreement > | create_key_agreement_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const override |
virtual std::unique_ptr< PK_Ops::Verification > | create_verification_op (const std::string ¶ms, const std::string &provider) const |
TPM_Context & | ctx () const |
virtual Signature_Format | default_x509_signature_format () const |
size_t | estimated_strength () const override |
std::vector< uint8_t > | export_blob () const |
std::string | fingerprint_private (const std::string &alg) const |
std::string | fingerprint_public (const std::string &alg="SHA-256") const |
BigInt | get_e () const |
BigInt | get_n () const |
virtual OID | get_oid () const |
TSS_HKEY | handle () const |
size_t | key_length () const override |
virtual size_t | message_part_size () const |
virtual size_t | message_parts () 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 |
std::string | register_key (TPM_Storage_Type storage_type) |
virtual bool | stateful_operation () const |
std::vector< uint8_t > | subject_public_key () const |
TPM_PrivateKey (TPM_Context &ctx, const std::string &uuid, TPM_Storage_Type storage_type) | |
TPM_PrivateKey (TPM_Context &ctx, const std::vector< uint8_t > &blob) | |
TPM_PrivateKey (TPM_Context &ctx, size_t bits, const char *key_password) | |
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 213 of file tpm.cpp.
Botan::TPM_PrivateKey::TPM_PrivateKey | ( | TPM_Context & | ctx, |
const std::string & | uuid, | ||
TPM_Storage_Type | storage_type | ||
) |
Definition at line 238 of file tpm.cpp.
Botan::TPM_PrivateKey::TPM_PrivateKey | ( | TPM_Context & | ctx, |
const std::vector< uint8_t > & | blob | ||
) |
|
inlineoverridevirtual |
Get the name of the underlying public key scheme.
Implements Botan::Public_Key.
Definition at line 170 of file tpm.h.
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 356 of file tpm.cpp.
References Botan::Public_Key::get_oid(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.
|
overridevirtual |
Test the key values for consistency.
rng | rng to use |
strong | whether to perform strong and lengthy version of the test |
Implements Botan::Public_Key.
Definition at line 390 of file tpm.cpp.
|
virtualinherited |
This is an internal library function exposed on key types. In almost 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, and Botan::SM2_PrivateKey.
Definition at line 114 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
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, and Botan::SM2_PublicKey.
Definition at line 91 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
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 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::Kyber_PrivateKey, Botan::McEliece_PrivateKey, and Botan::RSA_PrivateKey.
Definition at line 122 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
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
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::Kyber_PublicKey, Botan::McEliece_PublicKey, and Botan::RSA_PublicKey.
Definition at line 99 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
virtualinherited |
This is an internal library function exposed on key types. In almost 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::Curve25519_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.
Definition at line 138 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
|
overridevirtual |
This is an internal library function exposed on key types. In almost 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 462 of file tpm.cpp.
|
virtualinherited |
This is an internal library function exposed on key types. In almost 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::XMSS_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Definition at line 107 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::create_verification_op(), and Botan::PK_Verifier::PK_Verifier().
|
inline |
Definition at line 145 of file tpm.h.
Referenced by register_key(), and registered_keys().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 125 of file pk_keys.h.
References Botan::DER_SEQUENCE, and Botan::IEEE_1363.
Referenced by Botan::X509_Object::choose_sig_format(), and Botan::X509_Object::verify_signature().
|
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::Public_Key.
Definition at line 346 of file tpm.cpp.
References Botan::if_work_factor(), and key_length().
std::vector< uint8_t > Botan::TPM_PrivateKey::export_blob | ( | ) | const |
Definition at line 378 of file tpm.cpp.
References Botan::TPM_Context::handle().
|
inherited |
Definition at line 85 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), hash_algo, and Botan::Private_Key::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 77 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), hash_algo, and Botan::Public_Key::subject_public_key().
BigInt Botan::TPM_PrivateKey::get_e | ( | ) | const |
Definition at line 334 of file tpm.cpp.
References Botan::BigInt::decode(), and Botan::TPM_Context::handle().
Referenced by public_key(), and public_key_bits().
BigInt Botan::TPM_PrivateKey::get_n | ( | ) | const |
Definition at line 322 of file tpm.cpp.
References Botan::BigInt::decode(), and Botan::TPM_Context::handle().
Referenced by key_length(), public_key(), and public_key_bits().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.
Definition at line 53 of file pk_keys.cpp.
References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().
Referenced by algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::Kyber_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::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 351 of file tpm.cpp.
References Botan::BigInt::bits(), and get_n().
Referenced by estimated_strength().
|
inlinevirtualinherited |
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.
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 123 of file pk_keys.h.
Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
inlinevirtualinherited |
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.
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 112 of file pk_keys.h.
Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PrivateKey, Botan::XMSS_WOTS_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.
Definition at line 212 of file pk_keys.h.
Referenced by Botan::Private_Key::private_key_info().
|
overridevirtual |
Implements Botan::Private_Key.
Definition at line 373 of file tpm.cpp.
|
inherited |
Definition at line 61 of file pk_keys.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::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(), and Botan::PKCS8::PEM_encode().
|
overridevirtual |
Returns a copy of the public key
Implements Botan::Private_Key.
Definition at line 385 of file tpm.cpp.
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 362 of file tpm.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_e(), get_n(), and Botan::DER_Encoder::start_sequence().
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 263 of file tpm.cpp.
References ctx(), Botan::TPM_Context::handle(), Botan::UUID::is_valid(), Botan::UUID::to_string(), TSPI_CHECK_SUCCESS, and Botan::User.
|
static |
Definition at line 297 of file tpm.cpp.
References ctx(), Botan::TPM_Context::handle(), and TSPI_CHECK_SUCCESS.
|
inlinevirtualinherited |
Reimplemented in Botan::XMSS_PrivateKey.
Definition at line 188 of file pk_keys.h.
|
inherited |
Definition at line 38 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().