#include <pk_keys.h>

Inheritance diagram for Botan::Private_Key:

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, 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

virtual std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

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

virtual Signature_Format	default_x509_signature_format () const

virtual size_t	estimated_strength () const =0

std::string	fingerprint_private (std::string_view alg) const

std::string	fingerprint_public (std::string_view alg="SHA-256") const

virtual std::unique_ptr< Private_Key >	generate_another (RandomNumberGenerator &rng) const =0

virtual const BigInt &	get_int_field (std::string_view field) const

OID	get_oid () const

virtual size_t	key_length () const =0

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

virtual OID	object_identifier () const

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::unique_ptr< Public_Key >	public_key () const =0

virtual std::vector< uint8_t >	public_key_bits () const =0

virtual secure_vector< uint8_t >	raw_private_key_bits () const

virtual std::vector< uint8_t >	raw_public_key_bits () const =0

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

virtual bool	supports_operation (PublicKeyOperation op) const =0

Detailed Description

Private Key Base Class

Definition at line 263 of file pk_keys.h.

Member Function Documentation

◆ algo_name()

virtual std::string Botan::Asymmetric_Key::algo_name ( ) const

pure virtualinherited

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implemented in Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::EC_PublicKey, Botan::TPM_PrivateKey, Botan::X25519_PublicKey, Botan::X448_PublicKey, and Botan::XMSS_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::X509_Object::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), create_decryption_op(), Botan::Public_Key::create_encryption_op(), create_kem_decryption_op(), Botan::Public_Key::create_kem_encryption_op(), create_key_agreement_op(), create_signature_op(), Botan::Public_Key::create_verification_op(), Botan::Public_Key::create_x509_verification_op(), Botan::Asymmetric_Key::get_int_field(), Botan::Asymmetric_Key::object_identifier(), 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::PK_Verifier::PK_Verifier(), and raw_private_key_bits().

◆ algorithm_identifier()

virtual AlgorithmIdentifier Botan::Public_Key::algorithm_identifier ( ) const

pure virtualinherited

◆ check_key()

virtual bool Botan::Public_Key::check_key	(	RandomNumberGenerator &	rng,
		bool	strong ) const

pure virtualinherited

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtual

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

Parameters

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 111 of file pk_keys.cpp.

                                                                                              {
   throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

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

Parameters

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 90 of file pk_keys.cpp.

                                                                                             {
   throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtual

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

Parameters

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::FrodoKEM_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, Botan::TLS::Hybrid_KEM_PrivateKey, and Botan::TLS::KEX_to_KEM_Adapter_PrivateKey.

Definition at line 117 of file pk_keys.cpp.

                                                                                                      {
   throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op	(	std::string_view	params,
		std::string_view	provider ) const

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

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::FrodoKEM_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, and Botan::TLS::KEX_to_KEM_Adapter_PublicKey.

Definition at line 96 of file pk_keys.cpp.

                                                                                                     {
   throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtual

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

Parameters

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 129 of file pk_keys.cpp.

                                                                                                    {
   throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtual

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

Parameters

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::Dilithium_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::RSA_PrivateKey, Botan::TPM_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 123 of file pk_keys.cpp.

                                                                                            {
   throw Lookup_Error(fmt("{} does not support signatures", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Signer::PK_Signer().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op	(	std::string_view	params,
		std::string_view	provider ) const

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

Parameters

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 101 of file pk_keys.cpp.

                                                                                                 {
   throw Lookup_Error(fmt("{} does not support verification", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_x509_verification_op	(	const AlgorithmIdentifier &	signature_algorithm,
		std::string_view	provider ) const

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.

Parameters

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 106 of file pk_keys.cpp.

                                                                                                      {
   throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ default_x509_signature_format()

virtual Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 201 of file pk_keys.h.

                                                                     {
         return (this->message_parts() >= 2) ? Signature_Format::DerSequence : Signature_Format::Standard;
      }

Referenced by Botan::X509_Object::choose_sig_format(), and Botan::PK_Verifier::PK_Verifier().

◆ estimated_strength()

virtual size_t Botan::Asymmetric_Key::estimated_strength ( ) const

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.

Returns: estimated strength in bits

Implemented in Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::TPM_PrivateKey, Botan::X25519_PublicKey, Botan::X448_PublicKey, and Botan::XMSS_PublicKey.

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg ) const

Returns: Hash of the PKCS #8 encoding for this key object

Definition at line 86 of file pk_keys.cpp.

                                                                         {
   return create_hex_fingerprint(private_key_bits(), hash_algo);
}

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().

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256" ) const

inherited

Returns: Hash of the subject public key

Definition at line 79 of file pk_keys.cpp.

                                                                       {
   return create_hex_fingerprint(subject_public_key(), hash_algo);
}

References Botan::create_hex_fingerprint(), and Botan::Public_Key::subject_public_key().

◆ generate_another()

virtual std::unique_ptr< Private_Key > Botan::Asymmetric_Key::generate_another ( RandomNumberGenerator & rng ) const

pure virtualinherited

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.

Implemented in Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PrivateKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::PublicKey, Botan::TPM2::RSA_PublicKey, Botan::TPM_PrivateKey, Botan::X25519_PublicKey, Botan::X448_PublicKey, and Botan::XMSS_PublicKey.

◆ get_int_field()

const BigInt & Botan::Asymmetric_Key::get_int_field ( std::string_view field ) const

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.

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.

                                                                      {
   throw Unknown_PK_Field_Name(algo_name(), field);
}

References Botan::Asymmetric_Key::algo_name().

Referenced by Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 132 of file pk_keys.h.

132{ return this->object_identifier(); }

Botan::Asymmetric_Key::object_identifier

virtual OID object_identifier() const

Definition pk_keys.cpp:22

◆ key_length()

virtual size_t Botan::Public_Key::key_length ( ) const

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::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::TPM_PrivateKey, Botan::X25519_PublicKey, Botan::X448_PublicKey, and Botan::XMSS_PublicKey.

Referenced by Botan::TLS::Policy::check_peer_key_acceptable().

◆ message_part_size()

virtual size_t Botan::Public_Key::message_part_size ( ) const

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.

Returns: size of the message parts in bits

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 199 of file pk_keys.h.

199{ return 0; }

Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ message_parts()

virtual size_t Botan::Public_Key::message_parts ( ) const

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.

Returns: number of message parts

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 188 of file pk_keys.h.

188{ return 1; }

Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in 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.

                                            {
   try {
      return OID::from_string(algo_name());
   } catch(Lookup_Error&) {
      throw Lookup_Error(fmt("Public key algorithm {} has no defined OIDs", algo_name()));
   }
}

References Botan::Asymmetric_Key::algo_name(), Botan::fmt(), and Botan::OID::from_string().

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const

inlinevirtual

Returns: PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.

Definition at line 296 of file pk_keys.h.

296{ return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

Referenced by private_key_info().

◆ private_key_bits()

virtual secure_vector< uint8_t > Botan::Private_Key::private_key_bits ( ) const

pure virtual

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const

Returns: PKCS #8 private key encoding for this key object

Definition at line 60 of file pk_keys.cpp.

                                                           {
   const size_t PKCS8_VERSION = 0;
 
   return DER_Encoder()
      .start_sequence()
      .encode(PKCS8_VERSION)
      .encode(pkcs8_algorithm_identifier())
      .encode(private_key_bits(), ASN1_Type::OctetString)
      .end_cons()
      .get_contents();
}

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(), and Botan::PKCS8::PEM_encode().

◆ public_key()

virtual std::unique_ptr< Public_Key > Botan::Private_Key::public_key ( ) const

pure virtual

Allocate a new object for the public key associated with this private key.

Returns: public key

◆ public_key_bits()

virtual std::vector< uint8_t > Botan::Public_Key::public_key_bits ( ) const

pure virtualinherited

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::Private_Key::raw_private_key_bits ( ) const

virtual

Returns: binary private key bits, with no additional encoding

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::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::Kyber_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 72 of file pk_keys.cpp.

                                                               {
   throw Not_Implemented(algo_name() + " does not implement raw_private_key_bits");
}

References Botan::Asymmetric_Key::algo_name().

◆ raw_public_key_bits()

virtual std::vector< uint8_t > Botan::Public_Key::raw_public_key_bits ( ) const

pure virtualinherited

Returns: binary public key bits, with no additional encoding

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.

Implemented in Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::PrivateKey, Botan::TPM2::PublicKey, Botan::TPM2::RSA_PrivateKey, Botan::TPM2::RSA_PublicKey, Botan::TPM_PrivateKey, Botan::X25519_PublicKey, Botan::X448_PublicKey, and Botan::XMSS_PublicKey.

◆ remaining_operations()

virtual std::optional< uint64_t > Botan::Private_Key::remaining_operations ( ) const

inlinevirtual

Retrieves the number of remaining operations if this is a stateful private key.

Returns: the number of remaining operations or std::nullopt if not applicable.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 309 of file pk_keys.h.

309{ return std::nullopt; }

◆ stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const

inlinevirtual

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 302 of file pk_keys.h.

302{ return false; }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const

inherited

Returns: X.509 subject key encoding for this key object

Definition at line 48 of file pk_keys.cpp.

                                                        {
   std::vector<uint8_t> output;
 
   DER_Encoder(output)
      .start_sequence()
      .encode(algorithm_identifier())
      .encode(public_key_bits(), ASN1_Type::BitString)
      .end_cons();
 
   return output;
}

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().

◆ supports_operation()

virtual bool Botan::Asymmetric_Key::supports_operation ( PublicKeyOperation op ) const

pure virtualinherited

Return true if this key could be used for the specified type of operation.

Implemented in Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PrivateKey, Botan::TPM2::RSA_PublicKey, Botan::TPM_PrivateKey, Botan::X25519_PublicKey, Botan::X448_PublicKey, and Botan::XMSS_PublicKey.

Referenced by Botan::Key_Constraints::compatible_with().

The documentation for this class was generated from the following files:

src/lib/pubkey/pk_keys.h
src/lib/pubkey/pk_keys.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_decryption_op()

◆ create_encryption_op()

◆ create_kem_decryption_op()

◆ create_kem_encryption_op()

◆ create_key_agreement_op()

◆ create_signature_op()

◆ create_verification_op()

◆ create_x509_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_private()

◆ fingerprint_public()

◆ generate_another()

◆ get_int_field()

◆ get_oid()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

◆ private_key_bits()

◆ private_key_info()

◆ public_key()

◆ public_key_bits()

◆ raw_private_key_bits()

◆ raw_public_key_bits()

◆ remaining_operations()

◆ stateful_operation()

◆ subject_public_key()

◆ supports_operation()