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

#include <gost_3410.h>

Inheritance diagram for Botan::GOST_3410_PrivateKey:
Botan::GOST_3410_PublicKey Botan::EC_PrivateKey Botan::EC_PublicKey Botan::EC_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::Public_Key Botan::Asymmetric_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
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op (RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
std::unique_ptr< PK_Ops::Signature > _create_signature_op (RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const override
std::unique_ptr< PK_Ops::Verification > _create_verification_op (const PK_Signature_Options_Reader &options) const override
Signature_Format _default_x509_signature_format () const override
const EC_Scalar & _private_key () const
const EC_AffinePoint & _public_ec_point () const
std::optional< size_t > _signature_element_size_for_DER_encoding () const override
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
std::unique_ptr< PK_Ops::Verification > create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override
Signature_Format default_x509_signature_format () const
std::vector< uint8_t > DER_domain () const
const EC_Group & domain () const
EC_Group_Encoding domain_format () const
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 final
OID get_oid () const
 GOST_3410_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
 GOST_3410_PrivateKey (const EC_Group &domain, const BigInt &x)
 GOST_3410_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x)
 GOST_3410_PrivateKey (RandomNumberGenerator &rng, EC_Group domain)
size_t key_length () const override
size_t message_part_size () const
size_t message_parts () const
virtual OID object_identifier () const
AlgorithmIdentifier pkcs8_algorithm_identifier () const override
EC_Point_Format point_encoding () const
secure_vector< uint8_t > private_key_bits () const final
secure_vector< uint8_t > private_key_info () const
const BigInt & private_value () const
const EC_AffinePoint & public_ec_point () const
std::unique_ptr< Public_Key > public_key () const override
std::vector< uint8_t > public_key_bits () const override
secure_vector< uint8_t > raw_private_key_bits () const final
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.
void set_parameter_encoding (EC_Group_Encoding enc)
void set_point_encoding (EC_Point_Format enc)
virtual bool stateful_operation () const
std::vector< uint8_t > subject_public_key () const
bool supports_operation (PublicKeyOperation op) const override

Static Protected Member Functions

static const AlgorithmIdentifier & assert_algorithm_identifier (const AlgorithmIdentifier &alg_id, std::string_view alg_name)

Protected Attributes

EC_Group_Encoding m_domain_encoding = EC_Group_Encoding::NamedCurve
EC_Point_Format m_point_encoding = EC_Point_Format::Uncompressed
std::shared_ptr< const EC_PrivateKey_Data > m_private_key
std::shared_ptr< const EC_PublicKey_Data > m_public_key
bool m_with_modular_inverse

Detailed Description

GOST-34.10 Private Key

Definition at line 82 of file gost_3410.h.

Constructor & Destructor Documentation

◆ GOST_3410_PrivateKey() [1/4]

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

Load a private key.

Parameters
alg_idthe X.509 algorithm identifier
key_bitsECPrivateKey bits

Definition at line 190 of file gost_3410.cpp.

190 :
191 EC_PrivateKey(gost_private_key_alg_id(alg_id), key_bits) {}

References Botan::EC_PrivateKey::EC_PrivateKey().

◆ GOST_3410_PrivateKey() [2/4]

Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey ( const EC_Group & domain,
const BigInt & x )

Create a private key from a given secret x

Parameters
domaincurve parameters to bu used for this key
xthe private key

Definition at line 181 of file gost_3410.cpp.

181 :
const EC_Group & domain() const
Definition ecc_key.cpp:76
static EC_Scalar from_bigint(const EC_Group &group, const BigInt &bn)
Definition ec_scalar.cpp:84

References Botan::EC_PublicKey::domain(), and Botan::EC_PrivateKey::EC_PrivateKey().

◆ GOST_3410_PrivateKey() [3/4]

Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey ( RandomNumberGenerator & rng,
EC_Group domain )

Create a new private key

Parameters
Random Number Generatorsa random number generator
domainparameters to used for this key

Definition at line 184 of file gost_3410.cpp.

184 :
185 EC_PrivateKey(rng, check_domain(std::move(domain))) {}

References Botan::EC_PublicKey::domain(), and Botan::EC_PrivateKey::EC_PrivateKey().

◆ GOST_3410_PrivateKey() [4/4]

Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey ( RandomNumberGenerator & rng,
const EC_Group & domain,
const BigInt & x )

Generate a new private key

Parameters
Random Number Generatorsa random number generator
domainparameters to used for this key
xthe private key; if zero, a new random key is generated

Definition at line 187 of file gost_3410.cpp.

187 :
188 EC_PrivateKey(rng, check_domain(domain), x) {}

References Botan::EC_PublicKey::domain(), and Botan::EC_PrivateKey::EC_PrivateKey().

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::Private_Key::_create_key_agreement_op ( RandomNumberGenerator & rng,
const PK_Key_Agreement_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 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 in Botan::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 148 of file pk_keys.cpp.

149 {
150 BOTAN_UNUSED(rng, options);
151 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
152}

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

Referenced by create_key_agreement_op(), and Botan::PK_Key_Agreement::PK_Key_Agreement().

◆ _create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::GOST_3410_PrivateKey::_create_signature_op ( RandomNumberGenerator & rng,
const PK_Signature_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 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 from Botan::Private_Key.

Definition at line 352 of file gost_3410.cpp.

353 {
354 BOTAN_UNUSED(rng);
355
357
358 return std::make_unique<GOST_3410_Signature_Operation>(*this, options);
359}
std::string algo_name() const override
void require_software_provider(const OptionsT &options, std::string_view algo_name)

References Botan::GOST_3410_PublicKey::algo_name(), BOTAN_UNUSED, and Botan::require_software_provider().

◆ _create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::GOST_3410_PublicKey::_create_verification_op ( const PK_Signature_Options_Reader & options) const
overridevirtualinherited

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 from Botan::Public_Key.

Definition at line 336 of file gost_3410.cpp.

337 {
339
340 return std::make_unique<GOST_3410_Verification_Operation>(*this, options);
341}

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

◆ _default_x509_signature_format()

Signature_Format Botan::GOST_3410_PublicKey::_default_x509_signature_format ( ) const
inlineoverridevirtualinherited

Reimplemented from Botan::Asymmetric_Key.

Definition at line 59 of file gost_3410.h.

References Botan::Standard.

◆ _private_key()

const EC_Scalar & Botan::EC_PrivateKey::_private_key ( ) const
inherited

Definition at line 135 of file ecc_key.cpp.

135 {
137 return m_private_key->private_key();
138}
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:49
std::shared_ptr< const EC_PrivateKey_Data > m_private_key
Definition ecc_key.h:235

References BOTAN_STATE_CHECK, and m_private_key.

Referenced by botan_ec_privkey_get_private_key(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), and ~EC_PrivateKey().

◆ _public_ec_point()

const EC_AffinePoint & Botan::EC_PublicKey::_public_ec_point ( ) const
inlineinherited

Definition at line 115 of file ecc_key.h.

115{ return public_ec_point(); }
const EC_AffinePoint & public_ec_point() const
Definition ecc_key.cpp:88

References public_ec_point().

◆ _signature_element_size_for_DER_encoding()

std::optional< size_t > Botan::GOST_3410_PublicKey::_signature_element_size_for_DER_encoding ( ) const
overridevirtualinherited

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 from Botan::Asymmetric_Key.

Definition at line 113 of file gost_3410.cpp.

113 {
114 return domain().get_order_bytes();
115}
size_t get_order_bytes() const
Definition ec_group.cpp:733

References Botan::EC_PublicKey::domain(), and Botan::EC_Group::get_order_bytes().

◆ algo_name()

std::string Botan::GOST_3410_PublicKey::algo_name ( ) const
overridevirtualinherited

Get this keys algorithm name.

Returns
this keys algorithm name

Implements Botan::Asymmetric_Key.

Definition at line 133 of file gost_3410.cpp.

133 {
134 const size_t p_bits = domain().get_p_bits();
135
136 if(p_bits == 256 || p_bits == 512) {
137 return fmt("GOST-34.10-2012-{}", p_bits);
138 } else {
139 throw Encoding_Error("GOST-34.10-2012 is not defined for parameters of this size");
140 }
141}
size_t get_p_bits() const
Definition ec_group.cpp:721

References Botan::EC_PublicKey::domain(), Botan::fmt(), and Botan::EC_Group::get_p_bits().

Referenced by Botan::GOST_3410_PrivateKey::_create_signature_op(), _create_verification_op(), and create_x509_verification_op().

◆ algorithm_identifier()

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

Return the X.509 AlgorithmIdentifier for this key

Reimplemented from Botan::EC_PublicKey.

Definition at line 143 of file gost_3410.cpp.

143 {
144 std::vector<uint8_t> params;
145
146 const OID gost_oid = object_identifier();
147 const OID domain_oid = domain().get_curve_oid();
148
149 DER_Encoder(params).start_sequence().encode(domain_oid).end_cons();
150
151 return AlgorithmIdentifier(gost_oid, params);
152}
virtual OID object_identifier() const
Definition pk_keys.cpp:24
const OID & get_curve_oid() const
Definition ec_group.cpp:805

References Botan::EC_PublicKey::domain(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::EC_Group::get_curve_oid(), Botan::Asymmetric_Key::object_identifier(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier().

◆ assert_algorithm_identifier()

const AlgorithmIdentifier & Botan::EC_PublicKey::assert_algorithm_identifier ( const AlgorithmIdentifier & alg_id,
std::string_view alg_name )
staticprotectedinherited

Definition at line 48 of file ecc_key.cpp.

49 {
50 if(alg_id.oid() != OID::from_string(alg_name)) {
51 throw Decoding_Error(
52 fmt("Unexpected AlgorithmIdentifier OID {} in association with {} key", alg_id.oid(), alg_name));
53 }
54
55 return alg_id; // NOLINT(*-return-const-ref-from-parameter)
56}
static OID from_string(std::string_view str)
Definition asn1_oid.cpp:80

References Botan::fmt(), Botan::OID::from_string(), and Botan::AlgorithmIdentifier::oid().

Referenced by Botan::ECDSA_PrivateKey::ECDSA_PrivateKey(), Botan::ECDSA_PublicKey::ECDSA_PublicKey(), Botan::ECGDSA_PrivateKey::ECGDSA_PrivateKey(), Botan::ECGDSA_PublicKey::ECGDSA_PublicKey(), Botan::ECKCDSA_PrivateKey::ECKCDSA_PrivateKey(), and Botan::ECKCDSA_PublicKey::ECKCDSA_PublicKey().

◆ check_key()

bool Botan::EC_PrivateKey::check_key ( RandomNumberGenerator & rng,
bool strong ) const
overridevirtualinherited

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.

Reimplemented in Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, and Botan::SM2_PrivateKey.

Definition at line 237 of file ecc_key.cpp.

237 {
238 if(!m_private_key) {
239 return false;
240 }
241
242 if(!EC_PublicKey::check_key(rng, strong)) {
243 return false;
244 }
245
246 // Verify that the public key is consistent with the private key.
247 // For ECKCDSA/ECGDSA the derivation is g^(x^-1), for all others it is g^x.
248 const auto expected = m_private_key->public_key(m_with_modular_inverse);
249 return expected->public_key() == public_ec_point();
250}
bool m_with_modular_inverse
Definition ecc_key.h:236
bool check_key(RandomNumberGenerator &rng, bool strong) const override
Definition ecc_key.cpp:93

References Botan::EC_PublicKey::check_key(), m_private_key, m_with_modular_inverse, and Botan::EC_PublicKey::public_ec_point().

Referenced by Botan::ECDSA_PrivateKey::check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), and Botan::SM2_PrivateKey::check_key().

◆ 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::GOST_3410_PublicKey::create_x509_verification_op ( const AlgorithmIdentifier & signature_algorithm,
std::string_view provider ) const
overridevirtualinherited

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 from Botan::Public_Key.

Definition at line 343 of file gost_3410.cpp.

344 {
345 if(provider == "base" || provider.empty()) {
346 return std::make_unique<GOST_3410_Verification_Operation>(*this, signature_algorithm);
347 }
348
349 throw Provider_Not_Found(algo_name(), provider);
350}

References algo_name().

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

◆ DER_domain()

std::vector< uint8_t > Botan::EC_PublicKey::DER_domain ( ) const
inherited

Return the DER encoding of this keys domain in whatever format is preset for this particular key

Definition at line 110 of file ecc_key.cpp.

110 {
111 return domain().DER_encode(domain_format());
112}
std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const
Definition ec_group.cpp:831
EC_Group_Encoding domain_format() const
Definition ecc_key.h:96

References Botan::EC_Group::DER_encode(), domain(), and domain_format().

Referenced by algorithm_identifier(), and ~EC_PublicKey().

◆ domain()

const EC_Group & Botan::EC_PublicKey::domain ( ) const
inherited

Get the domain parameters of this key.

Exceptions
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns
the domain parameters of this key

Definition at line 76 of file ecc_key.cpp.

76 {
78 return m_public_key->group();
79}
std::shared_ptr< const EC_PublicKey_Data > m_public_key
Definition ecc_key.h:148

References BOTAN_STATE_CHECK, and m_public_key.

Referenced by Botan::ECDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECGDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECKCDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::_signature_element_size_for_DER_encoding(), Botan::SM2_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_ec_privkey_get_group(), botan_ec_pubkey_get_group(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_sm2_compute_za(), check_key(), Botan::SM2_PrivateKey::check_key(), DER_domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), EC_PublicKey(), EC_PublicKey(), Botan::ECDH_PublicKey::generate_another(), Botan::ECDSA_PublicKey::generate_another(), Botan::ECGDSA_PublicKey::generate_another(), Botan::ECKCDSA_PublicKey::generate_another(), Botan::GOST_3410_PublicKey::generate_another(), Botan::SM2_PublicKey::generate_another(), get_int_field(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), key_length(), Botan::ECDH_PrivateKey::public_key(), Botan::ECDSA_PrivateKey::public_key(), Botan::ECGDSA_PrivateKey::public_key(), Botan::ECKCDSA_PrivateKey::public_key(), Botan::GOST_3410_PrivateKey::public_key(), Botan::SM2_PrivateKey::public_key(), Botan::TPM2::EC_PrivateKey::public_key(), Botan::ECDSA_PublicKey::recovery_param(), set_parameter_encoding(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), and ~EC_PublicKey().

◆ domain_format()

EC_Group_Encoding Botan::EC_PublicKey::domain_format ( ) const
inlineinherited

Get the domain parameter encoding to be used when encoding this key.

Returns
the encoding to use

Definition at line 96 of file ecc_key.h.

96{ return m_domain_encoding; }
EC_Group_Encoding m_domain_encoding
Definition ecc_key.h:149

References domain_format(), and m_domain_encoding.

Referenced by DER_domain(), and domain_format().

◆ estimated_strength()

size_t Botan::EC_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 32 of file ecc_key.cpp.

32 {
34}
size_t key_length() const override
Definition ecc_key.cpp:28
size_t ecp_work_factor(size_t bits)

References Botan::ecp_work_factor(), and key_length().

◆ 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::GOST_3410_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 332 of file gost_3410.cpp.

332 {
333 return std::make_unique<GOST_3410_PrivateKey>(rng, domain());
334}

References Botan::EC_PublicKey::domain().

◆ get_int_field()

const BigInt & Botan::EC_PrivateKey::get_int_field ( std::string_view field) const
finalvirtualinherited

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 274 of file ecc_key.cpp.

274 {
275 if(field == "x") {
276 return this->private_value();
277 } else {
278 return EC_PublicKey::get_int_field(field);
279 }
280}
const BigInt & private_value() const
Definition ecc_key.cpp:130
const BigInt & get_int_field(std::string_view field) const override
Definition ecc_key.cpp:252

References Botan::EC_PublicKey::get_int_field(), and private_value().

Referenced by ~EC_PrivateKey().

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

◆ key_length()

size_t Botan::EC_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 28 of file ecc_key.cpp.

28 {
29 return domain().get_p_bits();
30}

References domain(), and Botan::EC_Group::get_p_bits().

Referenced by estimated_strength().

◆ 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 }
virtual std::optional< size_t > _signature_element_size_for_DER_encoding() const
Definition pk_keys.h:148

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

AlgorithmIdentifier Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier ( ) const
inlineoverridevirtual

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

Definition at line 117 of file gost_3410.h.

117 {
119 }
AlgorithmIdentifier algorithm_identifier() const override

References Botan::GOST_3410_PublicKey::algorithm_identifier().

◆ point_encoding()

EC_Point_Format Botan::EC_PublicKey::point_encoding ( ) const
inlineinherited

Get the point encoding method to be used when encoding this key.

Returns
the encoding to use

Definition at line 102 of file ecc_key.h.

102{ return m_point_encoding; }
EC_Point_Format m_point_encoding
Definition ecc_key.h:150

References m_point_encoding.

Referenced by raw_public_key_bits().

◆ private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::private_key_bits ( ) const
finalvirtualinherited

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 174 of file ecc_key.cpp.

174 {
175 BOTAN_STATE_CHECK(m_private_key != nullptr && m_public_key != nullptr);
176
177 return DER_Encoder()
178 .start_sequence()
179 .encode(static_cast<size_t>(1))
181 .start_explicit_context_specific(1)
182 .encode_octet_aligned_bitstring(m_public_key->public_key().serialize_uncompressed())
183 .end_cons()
184 .end_cons()
185 .get_contents();
186}
secure_vector< uint8_t > raw_private_key_bits() const final
Definition ecc_key.cpp:169

References BOTAN_STATE_CHECK, Botan::DER_Encoder::encode(), Botan::DER_Encoder::encode_octet_aligned_bitstring(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), m_private_key, Botan::EC_PublicKey::m_public_key, Botan::OctetString, raw_private_key_bits(), Botan::DER_Encoder::start_explicit_context_specific(), and Botan::DER_Encoder::start_sequence().

Referenced by EC_PrivateKey().

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

◆ private_value()

const BigInt & Botan::EC_PrivateKey::private_value ( ) const
inherited

Get the private key value of this key object.

Returns
the private key value of this key object

Definition at line 130 of file ecc_key.cpp.

130 {
132 return m_private_key->legacy_bigint();
133}

References BOTAN_STATE_CHECK, and m_private_key.

Referenced by Botan::SM2_PrivateKey::check_key(), and get_int_field().

◆ public_ec_point()

◆ public_key()

std::unique_ptr< Public_Key > Botan::GOST_3410_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 193 of file gost_3410.cpp.

193 {
194 return std::make_unique<GOST_3410_PublicKey>(domain(), public_ec_point());
195}

References Botan::EC_PublicKey::domain(), and Botan::EC_PublicKey::public_ec_point().

◆ public_key_bits()

std::vector< uint8_t > Botan::GOST_3410_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

Reimplemented from Botan::EC_PublicKey.

Definition at line 117 of file gost_3410.cpp.

117 {
118 auto bits = public_ec_point().xy_bytes();
119
120 const size_t part_size = bits.size() / 2;
121
122 // GOST keys are stored in little endian format (WTF)
123 for(size_t i = 0; i != part_size / 2; ++i) {
124 std::swap(bits[i], bits[part_size - 1 - i]);
125 std::swap(bits[part_size + i], bits[2 * part_size - 1 - i]);
126 }
127
128 std::vector<uint8_t> output;
129 DER_Encoder(output).encode(bits, ASN1_Type::OctetString);
130 return output;
131}

References Botan::DER_Encoder::encode(), Botan::OctetString, Botan::EC_PublicKey::public_ec_point(), and Botan::EC_AffinePoint::xy_bytes().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::raw_private_key_bits ( ) const
finalvirtualinherited

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 169 of file ecc_key.cpp.

169 {
171 return m_private_key->serialize<secure_vector<uint8_t>>();
172}
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128

References BOTAN_STATE_CHECK, and m_private_key.

Referenced by private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::EC_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.

Reimplemented in Botan::TPM2::EC_PublicKey.

Definition at line 102 of file ecc_key.cpp.

102 {
104}
std::vector< uint8_t > serialize(EC_Point_Format format) const
Return an encoding depending on the requested format.
EC_Point_Format point_encoding() const
Definition ecc_key.h:102

References point_encoding(), public_ec_point(), and Botan::EC_AffinePoint::serialize().

Referenced by public_key_bits(), Botan::TPM2::EC_PrivateKey::public_key_bits(), Botan::TPM2::EC_PublicKey::public_key_bits(), and ~EC_PublicKey().

◆ 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; }

◆ set_parameter_encoding()

void Botan::EC_PublicKey::set_parameter_encoding ( EC_Group_Encoding enc)
inherited

Set the domain parameter encoding to be used when encoding this key.

Parameters
encthe encoding to use

This function is deprecated; in a future major release only namedCurve encoding of domain parameters will be allowed.

Definition at line 122 of file ecc_key.cpp.

122 {
123 if(form == EC_Group_Encoding::NamedCurve && domain().get_curve_oid().empty()) {
124 throw Invalid_Argument("Cannot used NamedCurve encoding for a curve without an OID");
125 }
126
127 m_domain_encoding = form;
128}

References domain(), m_domain_encoding, and Botan::NamedCurve.

Referenced by ~EC_PublicKey().

◆ set_point_encoding()

void Botan::EC_PublicKey::set_point_encoding ( EC_Point_Format enc)
inherited

Set the point encoding method to be used when encoding this key.

Parameters
encthe encoding to use

Definition at line 114 of file ecc_key.cpp.

114 {
116 throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
117 }
118
119 m_point_encoding = enc;
120}

References Botan::Compressed, Botan::Hybrid, m_point_encoding, and Botan::Uncompressed.

Referenced by ~EC_PublicKey().

◆ 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 AlgorithmIdentifier algorithm_identifier() const =0
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::GOST_3410_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 63 of file gost_3410.h.

References Botan::Signature.

Member Data Documentation

◆ m_domain_encoding

◆ m_point_encoding

EC_Point_Format Botan::EC_PublicKey::m_point_encoding = EC_Point_Format::Uncompressed
protectedinherited

Definition at line 150 of file ecc_key.h.

Referenced by point_encoding(), and set_point_encoding().

◆ m_private_key

std::shared_ptr<const EC_PrivateKey_Data> Botan::EC_PrivateKey::m_private_key
protectedinherited

◆ m_public_key

◆ m_with_modular_inverse

bool Botan::EC_PrivateKey::m_with_modular_inverse
protectedinherited

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