Botan 3.14.1
Crypto and TLS for C&
Botan::DH_PrivateKey Class Referencefinal

#include <dh.h>

Inheritance diagram for Botan::DH_PrivateKey:
Botan::DH_PublicKey Botan::PK_Key_Agreement_Key Botan::Private_Key Botan::Public_Key Botan::Private_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Asymmetric_Key

Public Member Functions

virtual std::unique_ptr< PK_Ops::Decryption > _create_decryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op (RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op (const PK_KEM_Options_Reader &options) const
std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op (RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const override
virtual std::unique_ptr< PK_Ops::Signature > _create_signature_op (RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op (const PK_Signature_Options_Reader &options) const
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::Decryption > create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Encryption > create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::KEM_Decryption > create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::KEM_Encryption > create_kem_encryption_op (std::string_view params, std::string_view provider) const
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
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
Signature_Format default_x509_signature_format () const
 DH_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
 DH_PrivateKey (const DL_Group &group, const BigInt &private_key)
 DH_PrivateKey (RandomNumberGenerator &rng, const DL_Group &group)
size_t estimated_strength () const override
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 &rng) const final
const BigInt & get_int_field (std::string_view field) const override
OID get_oid () const
const DL_Group & group () 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
std::vector< uint8_t > public_value () const override
secure_vector< uint8_t > raw_private_key_bits () const override
std::vector< uint8_t > raw_public_key_bits () const override
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

Detailed Description

This class represents Diffie-Hellman private keys.

Definition at line 82 of file dh.h.

Constructor & Destructor Documentation

◆ DH_PrivateKey() [1/3]

Botan::DH_PrivateKey::DH_PrivateKey ( const AlgorithmIdentifier & alg_id,
std::span< const uint8_t > key_bits )

Load a private key from the ASN.1 encoding

Parameters
alg_idthe X.509 algorithm identifier
key_bitsPKCS #8 structure

Definition at line 72 of file dh.cpp.

72 {
73 m_private_key = std::make_shared<DL_PrivateKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_42);
74 m_public_key = m_private_key->public_key();
75}

References Botan::ANSI_X9_42.

◆ DH_PrivateKey() [2/3]

Botan::DH_PrivateKey::DH_PrivateKey ( const DL_Group & group,
const BigInt & private_key )

Load a private key from the integer encoding

Parameters
groupthe underlying DL group
private_keythe private key

Definition at line 67 of file dh.cpp.

67 {
68 m_private_key = std::make_shared<DL_PrivateKey>(group, x);
69 m_public_key = m_private_key->public_key();
70}
const DL_Group & group() const
Definition dh.cpp:38

References Botan::DH_PublicKey::group().

◆ DH_PrivateKey() [3/3]

Botan::DH_PrivateKey::DH_PrivateKey ( RandomNumberGenerator & rng,
const DL_Group & group )

Create a new private key.

Parameters
groupthe underlying DL group
Random Number Generatorsthe RNG to use

Definition at line 62 of file dh.cpp.

62 {
63 m_private_key = std::make_shared<DL_PrivateKey>(group, rng);
64 m_public_key = m_private_key->public_key();
65}

References Botan::DH_PublicKey::group().

Member Function Documentation

◆ _create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::_create_decryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) const
virtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a decryption operation for this key/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the encryption beyond those implicit to the key itself

Reimplemented in Botan::ElGamal_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.

Definition at line 130 of file pk_keys.cpp.

131 {
132 BOTAN_UNUSED(rng, options);
133 throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
134}
#define BOTAN_UNUSED
Definition assert.h:151
virtual std::string algo_name() const =0
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

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

Referenced by create_decryption_op(), and Botan::PK_Decryptor_EME::PK_Decryptor_EME().

◆ _create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::_create_encryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) 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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the encryption beyond those implicit to the public key itself

Reimplemented in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.

Definition at line 107 of file pk_keys.cpp.

108 {
109 BOTAN_UNUSED(rng, options);
110 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
111}

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

Referenced by create_encryption_op(), and 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,
const PK_KEM_Options_Reader & options ) const
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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the KEM beyond those implicit to the key itself

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

137 {
138 BOTAN_UNUSED(rng, options);
139 throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
140}

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

Referenced by create_kem_decryption_op(), and 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 ( const PK_KEM_Options_Reader & options) 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/options or throw

Parameters
optionswhich specify parameters of the KEM beyond those implicit to the public key itself

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

114 {
115 BOTAN_UNUSED(options);
116 throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
117}

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

Referenced by create_kem_encryption_op(), and Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ _create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::DH_PrivateKey::_create_key_agreement_op ( RandomNumberGenerator & rng,
const PK_Key_Agreement_Options_Reader & options ) const
overridevirtual

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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the key agreement beyond those implicit to the key itself

Reimplemented from Botan::Private_Key.

Definition at line 155 of file dh.cpp.

156 {
158
159 return std::make_unique<DH_KA_Operation>(this->m_private_key, options, rng);
160}
std::string algo_name() const override
Definition dh.h:55
void require_software_provider(const OptionsT &options, std::string_view algo_name)

References Botan::DH_PublicKey::algo_name(), and Botan::require_software_provider().

◆ _create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::_create_signature_op ( RandomNumberGenerator & rng,
const PK_Signature_Options_Reader & options ) const
virtualinherited

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
Random Number Generatorsa 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.
optionsallow controlling behavior

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

143 {
144 BOTAN_UNUSED(rng, options);
145 throw Lookup_Error(fmt("{} does not support signatures", algo_name()));
146}

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

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

◆ _create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::_create_verification_op ( const PK_Signature_Options_Reader & options) 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
optionswhich specify parameters of the signature beyond those implicit to the public key itself

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

120 {
121 BOTAN_UNUSED(options);
122 throw Lookup_Error(fmt("{} does not support verification", algo_name()));
123}

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

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

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const
virtualinherited

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const
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 148 of file pk_keys.h.

148{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ algo_name()

std::string Botan::DH_PublicKey::algo_name ( ) const
inlineoverridevirtualinherited

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 55 of file dh.h.

55{ return "DH"; }

Referenced by Botan::DH_PrivateKey::_create_key_agreement_op(), Botan::DH_PrivateKey::get_int_field(), and get_int_field().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::DH_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 42 of file dh.cpp.

42 {
43 return AlgorithmIdentifier(object_identifier(), m_public_key->group().DER_encode(DL_Group_Format::ANSI_X9_42));
44}
virtual OID object_identifier() const
Definition pk_keys.cpp:24

References Botan::ANSI_X9_42, and Botan::Asymmetric_Key::object_identifier().

◆ check_key()

bool Botan::DH_PrivateKey::check_key ( RandomNumberGenerator & rng,
bool strong ) const
overridevirtual

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters
Random Number Generatorsrng to use for randomized testing (may be ignored)
strongwhether to perform strong and lengthy version of the test, however for many algorithms this has no effect
Returns
true if the tests passed

Implements Botan::Asymmetric_Key.

Definition at line 77 of file dh.cpp.

77 {
78 return m_private_key->check_key(rng, strong);
79}

◆ 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
inherited

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
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 185 of file pk_keys.cpp.

187 {
188 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
189 const auto reader = PK_Options_Reader_Access::read(options);
190 auto op = this->_create_decryption_op(rng, reader);
192 return op;
193}
PK_Encryption_Options with_provider(std::string_view provider)
static void throw_if_unexamined(const ReaderT &reader, std::string_view algo_name)
static PK_Encryption_Options_Reader read(const PK_Encryption_Options &options)
virtual std::unique_ptr< PK_Ops::Decryption > _create_decryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:130
PK_Encryption_Options parse_legacy_enc_options(const Public_Key &key, std::string_view params)

References _create_decryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

◆ 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
inherited

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
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 175 of file pk_keys.cpp.

177 {
178 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
179 const auto reader = PK_Options_Reader_Access::read(options);
180 auto op = this->_create_encryption_op(rng, reader);
182 return op;
183}
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:107

References _create_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

◆ 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
inherited

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
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 204 of file pk_keys.cpp.

206 {
207 const auto options = parse_legacy_kem_options(params).with_provider(provider);
208 const auto reader = PK_Options_Reader_Access::read(options);
209 auto op = this->_create_kem_decryption_op(rng, reader);
211 return op;
212}
PK_KEM_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op(RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:136
PK_KEM_Options parse_legacy_kem_options(std::string_view params)

References _create_kem_decryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

◆ 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
inherited

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
paramsadditional parameters
providerthe provider to use

Definition at line 195 of file pk_keys.cpp.

196 {
197 const auto options = parse_legacy_kem_options(params).with_provider(provider);
198 const auto reader = PK_Options_Reader_Access::read(options);
199 auto op = this->_create_kem_encryption_op(reader);
201 return op;
202}
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op(const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:113

References _create_kem_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

◆ 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
inherited

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
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 214 of file pk_keys.cpp.

216 {
217 const auto options = parse_legacy_ka_options(params).with_provider(provider);
218 const auto reader = PK_Options_Reader_Access::read(options);
219 auto op = this->_create_key_agreement_op(rng, reader);
221 return op;
222}
PK_Key_Agreement_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op(RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
Definition pk_keys.cpp:148
PK_Key_Agreement_Options parse_legacy_ka_options(std::string_view params)

References _create_key_agreement_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_ka_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Key_Agreement_Options::with_provider().

◆ 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
inherited

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
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 165 of file pk_keys.cpp.

167 {
168 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
169 const auto reader = PK_Options_Reader_Access::for_signing(options);
170 auto op = this->_create_signature_op(rng, reader);
172 return op;
173}
static PK_Signature_Options_Reader for_signing(const PK_Signature_Options &options)
PK_Signature_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Signature > _create_signature_op(RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:142
PK_Signature_Options parse_legacy_sig_options(const Public_Key &key, std::string_view params)

References _create_signature_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_signing(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ create_verification_op()

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

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
paramsadditional parameters
providerthe provider to use

Definition at line 156 of file pk_keys.cpp.

157 {
158 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
159 const auto reader = PK_Options_Reader_Access::for_verification(options);
160 auto op = this->_create_verification_op(reader);
162 return op;
163}
static PK_Signature_Options_Reader for_verification(const PK_Signature_Options &options)
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op(const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:119

References _create_verification_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_verification(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ 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_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe 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 125 of file pk_keys.cpp.

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

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

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

◆ default_x509_signature_format()

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

Definition at line 245 of file pk_keys.h.

245 {
247 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:32

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::DH_PublicKey::estimated_strength ( ) const
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.

Returns
estimated strength in bits

Implements Botan::Asymmetric_Key.

Definition at line 26 of file dh.cpp.

26 {
27 return m_public_key->estimated_strength();
28}

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg) const
inherited
Returns
Hash of the algorithm specific private key encoding
Warning
This hashes private_key_bits(), which does not include the algorithm identifier; keys of different algorithms with identical raw encodings (such as an Ed25519 and an X25519 key built from the same 32 bytes) share a fingerprint.

Definition at line 103 of file pk_keys.cpp.

103 {
104 return create_hex_fingerprint(private_key_bits(), hash_algo);
105}
virtual secure_vector< uint8_t > private_key_bits() const =0
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:40

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

96 {
97 return create_hex_fingerprint(subject_public_key(), hash_algo);
98}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:65

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

Referenced by public_key_bits().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::DH_PublicKey::generate_another ( RandomNumberGenerator & rng) const
finalvirtualinherited

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 58 of file dh.cpp.

58 {
59 return std::make_unique<DH_PrivateKey>(rng, group());
60}

References group().

◆ get_int_field()

const BigInt & Botan::DH_PrivateKey::get_int_field ( std::string_view field) const
overridevirtual

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 97 of file dh.cpp.

97 {
98 return m_private_key->get_int_field(algo_name(), field);
99}

References Botan::DH_PublicKey::algo_name().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
inlineinherited

Deprecated version of object_identifier

Definition at line 172 of file pk_keys.h.

172{ return this->object_identifier(); }

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

◆ group()

const DL_Group & Botan::DH_PublicKey::group ( ) const
inherited

Definition at line 38 of file dh.cpp.

38 {
39 return m_public_key->group();
40}

Referenced by Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PrivateKey::DH_PrivateKey(), DH_PublicKey(), and generate_another().

◆ key_length()

size_t Botan::DH_PublicKey::key_length ( ) const
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 30 of file dh.cpp.

30 {
31 return m_public_key->p_bits();
32}

◆ message_part_size()

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

Returns how large each of the message parts referred 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

Definition at line 236 of file pk_keys.h.

236 {
237 return _signature_element_size_for_DER_encoding().value_or(0);
238 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

◆ message_parts()

size_t Botan::Public_Key::message_parts ( ) const
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.

Returns
number of message parts

Definition at line 223 of file pk_keys.h.

223 {
225 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

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

Return the PKCS #8 AlgorithmIdentifier for this key

Note
normally this is the same as the public key identifier, but a few oddball algorithms use a different value

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

Definition at line 390 of file pk_keys.h.

390{ return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0

References Botan::Public_Key::algorithm_identifier().

Referenced by private_key_info().

◆ private_key_bits()

secure_vector< uint8_t > Botan::DH_PrivateKey::private_key_bits ( ) const
overridevirtual

Return the PKCS8 private key encoding

Note
this encoding omits the outer PKCS8 algorithm identifiers and will not be portably decodable on its own. Prefer private_key_info.

Implements Botan::Private_Key.

Definition at line 89 of file dh.cpp.

89 {
90 return m_private_key->DER_encode();
91}

◆ private_key_info()

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

Return PKCS #8 private key encoding for this key object

Definition at line 77 of file pk_keys.cpp.

77 {
78 const size_t PKCS8_VERSION = 0;
79
80 return DER_Encoder()
81 .start_sequence()
82 .encode(PKCS8_VERSION)
85 .end_cons()
86 .get_contents();
87}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:390

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

◆ public_key()

std::unique_ptr< Public_Key > Botan::DH_PrivateKey::public_key ( ) const
overridevirtual

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

Returns
public key

Implements Botan::Private_Key.

Definition at line 81 of file dh.cpp.

81 {
82 return std::unique_ptr<DH_PublicKey>(new DH_PublicKey(m_public_key));
83}
DH_PublicKey(const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
Definition dh.cpp:18

References Botan::DH_PublicKey::DH_PublicKey().

◆ public_key_bits()

std::vector< uint8_t > Botan::DH_PublicKey::public_key_bits ( ) const
overridevirtualinherited

Return the subject public key encoding of this public key

Note
this excludes the parameters field and may not be reliably decodable

Implements Botan::Public_Key.

Definition at line 50 of file dh.cpp.

50 {
51 return m_public_key->DER_encode();
52}

◆ public_value()

std::vector< uint8_t > Botan::DH_PrivateKey::public_value ( ) const
overridevirtual

Return the public value used to effect key exchange

Implements Botan::PK_Key_Agreement_Key.

Definition at line 85 of file dh.cpp.

85 {
86 return raw_public_key_bits();
87}
std::vector< uint8_t > raw_public_key_bits() const override
Definition dh.cpp:46

References Botan::DH_PublicKey::raw_public_key_bits().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::DH_PrivateKey::raw_private_key_bits ( ) const
overridevirtual

Return the 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 from Botan::Private_Key.

Definition at line 93 of file dh.cpp.

93 {
94 return m_private_key->raw_private_key_bits();
95}

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::DH_PublicKey::raw_public_key_bits ( ) const
overridevirtualinherited

Return the raw public key bits (algorithm specific) with no extra 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.

Implements Botan::Public_Key.

Definition at line 46 of file dh.cpp.

46 {
47 return m_public_key->public_key_as_bytes();
48}

Referenced by Botan::DH_PrivateKey::public_value(), and public_value().

◆ remaining_operations()

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

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

403{ return std::nullopt; }

◆ stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const
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 396 of file pk_keys.h.

396{ return false; }

◆ subject_public_key()

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

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 65 of file pk_keys.cpp.

65 {
66 std::vector<uint8_t> output;
67
68 DER_Encoder(output)
69 .start_sequence()
70 .encode(algorithm_identifier())
71 .encode_octet_aligned_bitstring(public_key_bits())
72 .end_cons();
73
74 return output;
75}
virtual std::vector< uint8_t > public_key_bits() const =0

References algorithm_identifier(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::encode_octet_aligned_bitstring(), 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().

◆ supports_operation()

bool Botan::DH_PublicKey::supports_operation ( PublicKeyOperation op) const
inlineoverridevirtualinherited

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

Implements Botan::Asymmetric_Key.

Definition at line 59 of file dh.h.

References Botan::KeyAgreement.


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