Botan 2.19.1
Crypto and TLS for C&
|
#include <pk_keys.h>
Public Member Functions | |
virtual std::string | algo_name () const =0 |
virtual AlgorithmIdentifier | algorithm_identifier () const =0 |
virtual bool | check_key (RandomNumberGenerator &rng, bool strong) const =0 |
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 |
virtual std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::Verification > | create_verification_op (const std::string ¶ms, const std::string &provider) const |
virtual Signature_Format | default_x509_signature_format () const |
virtual size_t | estimated_strength () const =0 |
std::string | fingerprint (const std::string &alg) const |
std::string | fingerprint_private (const std::string &alg) const |
std::string | fingerprint_public (const std::string &alg="SHA-256") const |
virtual OID | get_oid () const |
virtual size_t | key_length () const =0 |
virtual size_t | message_part_size () const |
virtual size_t | message_parts () const |
PK_Key_Agreement_Key & | operator= (const PK_Key_Agreement_Key &)=default |
PK_Key_Agreement_Key ()=default | |
PK_Key_Agreement_Key (const PK_Key_Agreement_Key &)=default | |
virtual AlgorithmIdentifier | pkcs8_algorithm_identifier () const |
virtual secure_vector< uint8_t > | private_key_bits () const =0 |
secure_vector< uint8_t > | private_key_info () const |
virtual std::vector< uint8_t > | public_key_bits () const =0 |
virtual std::vector< uint8_t > | public_value () const =0 |
virtual bool | stateful_operation () const |
std::vector< uint8_t > | subject_public_key () const |
virtual | ~PK_Key_Agreement_Key ()=default |
|
default |
|
default |
|
virtualdefault |
|
pure virtualinherited |
Get the name of the underlying public key scheme.
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, Botan::GOST_3410_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Referenced by Botan::PKCS8::BER_encode(), botan_pubkey_sm2_compute_za(), Botan::TLS::Policy::check_peer_key_acceptable(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::EMSA1::config_for_x509(), Botan::EMSA_PKCS1v15::config_for_x509(), Botan::PSSR::config_for_x509(), Botan::Private_Key::create_decryption_op(), Botan::Public_Key::create_encryption_op(), Botan::Private_Key::create_kem_decryption_op(), Botan::Public_Key::create_kem_encryption_op(), Botan::Private_Key::create_key_agreement_op(), Botan::Private_Key::create_signature_op(), Botan::Public_Key::create_verification_op(), Botan::Public_Key::get_oid(), Botan::TLS::Handshake_State::parse_sig_format(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_KEM_Decryptor::PK_KEM_Decryptor(), Botan::PK_KEM_Encryptor::PK_KEM_Encryptor(), Botan::PK_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::verify_cert_constraints_valid_for_key_type(), and Botan::X509_Object::verify_signature().
|
pure virtualinherited |
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Referenced by Botan::EMSA1::config_for_x509(), and Botan::Public_Key::subject_public_key().
|
pure virtualinherited |
Test the key values for consistency.
rng | rng to use |
strong | whether to perform strong and lengthy version of the test |
Implemented in Botan::McEliece_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, Botan::Curve25519_PublicKey, Botan::Curve25519_PrivateKey, Botan::DSA_PrivateKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed25519_PrivateKey, Botan::McEliece_PrivateKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::TPM_PrivateKey, Botan::DL_Scheme_PublicKey, Botan::DL_Scheme_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::ElGamal_PrivateKey, Botan::RSA_PublicKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.
|
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::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::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().
Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().
|
virtualinherited |
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 in Botan::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.
Definition at line 130 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Signer::PK_Signer().
|
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().
|
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().
|
pure virtualinherited |
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.
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Referenced by botan_pubkey_estimated_strength().
|
inlineinherited |
|
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().
|
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 Botan::TPM_PrivateKey::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::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().
|
pure virtualinherited |
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.
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Referenced by Botan::TLS::Policy::check_peer_key_acceptable().
|
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().
|
default |
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PrivateKey, Botan::XMSS_WOTS_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.
Definition at line 204 of file pk_keys.h.
Referenced by Botan::Private_Key::private_key_info().
|
pure virtualinherited |
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PrivateKey, Botan::DL_Scheme_PrivateKey, Botan::EC_PrivateKey, Botan::Ed25519_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, Botan::XMSS_PrivateKey, Botan::XMSS_WOTS_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.
Referenced by Botan::Private_Key::fingerprint_private(), and Botan::Private_Key::private_key_info().
|
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::OCTET_STRING, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().
Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), and Botan::PKCS8::BER_encode_encrypted_pbkdf_msec().
|
pure virtualinherited |
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Referenced by Botan::Public_Key::subject_public_key().
|
pure virtual |
Implemented in Botan::Curve25519_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.
Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange().
|
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::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().
Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().