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

#include <mceliece.h>

Inheritance diagram for Botan::McEliece_PrivateKey:
Botan::McEliece_PublicKey Botan::Private_Key Botan::Public_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
std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op (RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const override
std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op (const PK_KEM_Options_Reader &options) const override
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op (RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
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
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
size_t get_code_length () const
size_t get_codimension () const
size_t get_dimension () const
const polyn_gf2m & get_goppa_polyn () const
const std::vector< uint32_t > & get_H_coeffs () const
virtual const BigInt & get_int_field (std::string_view field) const
const std::vector< gf2m > & get_Linv () const
size_t get_message_word_bit_length () const
OID get_oid () const
const std::vector< uint8_t > & get_public_matrix () const
const std::vector< polyn_gf2m > & get_sqrtmod () const
size_t get_t () const
size_t key_length () const override
 McEliece_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
 McEliece_PrivateKey (const McEliece_PrivateKey &)
 McEliece_PrivateKey (const polyn_gf2m &goppa_polyn, const std::vector< uint32_t > &parity_check_matrix_coeffs, const std::vector< polyn_gf2m > &square_root_matrix, const std::vector< gf2m > &inverse_support, const std::vector< uint8_t > &public_matrix)
 McEliece_PrivateKey (McEliece_PrivateKey &&) noexcept
 McEliece_PrivateKey (RandomNumberGenerator &rng, size_t code_length, size_t t)
 McEliece_PrivateKey (std::span< const uint8_t > key_bits)
size_t message_part_size () const
size_t message_parts () const
virtual OID object_identifier () const
bool operator!= (const McEliece_PrivateKey &other) const
bool operator!= (const McEliece_PublicKey &other) const
McEliece_PrivateKey & operator= (const McEliece_PrivateKey &)
McEliece_PrivateKey & operator= (McEliece_PrivateKey &&) noexcept
bool operator== (const McEliece_PrivateKey &other) const
bool operator== (const McEliece_PublicKey &other) 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
secure_vector< uint8_t > random_plaintext_element (RandomNumberGenerator &rng) const
virtual secure_vector< uint8_t > raw_private_key_bits () const
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
 ~McEliece_PrivateKey () override

Protected Attributes

std::shared_ptr< const McEliece_PublicKeyInternal > m_public

Detailed Description

Definition at line 86 of file mceliece.h.

Constructor & Destructor Documentation

◆ McEliece_PrivateKey() [1/6]

Botan::McEliece_PrivateKey::McEliece_PrivateKey ( RandomNumberGenerator & rng,
size_t code_length,
size_t t )

Generate a McEliece key pair

Supported parameters for a given security level (SL)

SL=80 n=1632 t=33 - 59 KB pubkey 140 KB privkey SL=107 n=2480 t=45 - 128 KB pubkey 300 KB privkey SL=128 n=2960 t=57 - 195 KB pubkey 459 KB privkey SL=147 n=3408 t=67 - 265 KB pubkey 622 KB privkey SL=191 n=4624 t=95 - 516 KB pubkey 1234 KB privkey SL=256 n=6624 t=115 - 942 KB pubkey 2184 KB privkey

Definition at line 229 of file mceliece_key.cpp.

229 {
230 const McEliece_Params params = mceliece_validate_keygen_params(code_length, t);
231 *this = generate_mceliece_key(rng, params.ext_deg, code_length, t);
232}
McEliece_PrivateKey generate_mceliece_key(RandomNumberGenerator &rng, size_t ext_deg, size_t code_length, size_t t)
McEliece_Params mceliece_validate_keygen_params(size_t code_length, size_t t)

References Botan::McEliece_Params::ext_deg, Botan::generate_mceliece_key(), and Botan::mceliece_validate_keygen_params().

Referenced by McEliece_PrivateKey(), McEliece_PrivateKey(), McEliece_PrivateKey(), McEliece_PrivateKey(), operator!=(), operator=(), operator=(), and operator==().

◆ McEliece_PrivateKey() [2/6]

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

Definition at line 438 of file mceliece_key.cpp.

438 {
439 // The McEliece parameters are carried in the key bits; no AlgorithmIdentifier
440 // parameters are defined.
441 if(!alg_id.parameters_are_empty()) {
442 throw Decoding_Error("Unexpected parameters for McEliece private key");
443 }
444
445 size_t n = 0;
446 size_t t = 0;
447 std::vector<uint8_t> public_matrix;
449 BER_Decoder dec_base(key_bits, BER_Decoder::Limits::DER());
450 BER_Decoder dec = dec_base.start_sequence();
451 dec.start_sequence().decode(n).decode(t).end_cons();
452 dec.decode(public_matrix, ASN1_Type::OctetString).decode(enc_g, ASN1_Type::OctetString);
453
454 const McEliece_Params params = mceliece_validate_key_params(n, t);
455 validate_public_matrix(public_matrix, params);
456
457 const auto sp_field = std::make_shared<GF2m_Field>(params.ext_deg);
458 std::vector<polyn_gf2m> g = {polyn_gf2m(enc_g, sp_field)};
459 std::vector<polyn_gf2m> sqrtmod;
460 BER_Decoder dec2 = dec.start_sequence();
461 for(uint32_t i = 0; i < t / 2; i++) {
462 secure_vector<uint8_t> sqrt_enc;
463 dec2.decode(sqrt_enc, ASN1_Type::OctetString);
464 while(sqrt_enc.size() < (t * 2)) {
465 // ensure that the length is always t
466 sqrt_enc.push_back(0);
467 sqrt_enc.push_back(0);
468 }
469 if(sqrt_enc.size() != t * 2) {
470 throw Decoding_Error("length of square root polynomial entry is too large");
471 }
472 sqrtmod.push_back(polyn_gf2m(sqrt_enc, sp_field));
473 }
474 secure_vector<uint8_t> enc_support;
475 dec2.end_cons();
476 dec.decode(enc_support, ASN1_Type::OctetString);
477 if(enc_support.size() % 2 != 0) {
478 throw Decoding_Error("encoded support has odd length");
479 }
480 if(enc_support.size() / 2 != n) {
481 throw Decoding_Error("encoded support has length different from code length");
482 }
483 std::vector<gf2m> Linv;
484 for(uint32_t i = 0; i < n * 2; i += 2) {
485 const gf2m el = (enc_support[i] << 8) | enc_support[i + 1];
486 Linv.push_back(el);
487 }
489 dec.decode(enc_H, ASN1_Type::OctetString).end_cons().verify_end();
490 if(enc_H.size() % 4 != 0) {
491 throw Decoding_Error("encoded parity check matrix has length which is not a multiple of four");
492 }
493 if(enc_H.size() / 4 != params.words_per_matrix_row * n) {
494 throw Decoding_Error("encoded parity check matrix has wrong length");
495 }
496
497 std::vector<uint32_t> coeffs;
498 for(uint32_t i = 0; i < enc_H.size(); i += 4) {
499 coeffs.push_back(make_uint32(enc_H[i], enc_H[i + 1], enc_H[i + 2], enc_H[i + 3]));
500 }
501
502 validate_private_components(g[0], coeffs, sqrtmod, Linv, public_matrix, params);
503
504 m_public = std::make_shared<const McEliece_PublicKeyInternal>(std::move(public_matrix), t, n);
505 m_private = std::make_shared<const McEliece_PrivateKeyInternal>(
506 std::move(g), std::move(sqrtmod), std::move(Linv), std::move(coeffs), params.codimension, params.dimension);
507}
static Limits DER()
Definition ber_dec.h:44
std::shared_ptr< const McEliece_PublicKeyInternal > m_public
Definition mceliece.h:80
constexpr uint32_t make_uint32(uint8_t i0, uint8_t i1, uint8_t i2, uint8_t i3)
Definition loadstor.h:104
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128
McEliece_Params mceliece_validate_key_params(size_t code_length, size_t t)
uint16_t gf2m

References Botan::McEliece_Params::codimension, Botan::BER_Decoder::decode(), Botan::BER_Decoder::Limits::DER(), Botan::McEliece_Params::dimension, Botan::BER_Decoder::end_cons(), Botan::McEliece_Params::ext_deg, Botan::McEliece_PublicKey::m_public, Botan::make_uint32(), Botan::mceliece_validate_key_params(), Botan::OctetString, Botan::AlgorithmIdentifier::parameters_are_empty(), Botan::BER_Decoder::push_back(), Botan::BER_Decoder::start_sequence(), Botan::BER_Decoder::verify_end(), and Botan::McEliece_Params::words_per_matrix_row.

◆ McEliece_PrivateKey() [3/6]

Botan::McEliece_PrivateKey::McEliece_PrivateKey ( std::span< const uint8_t > key_bits)
explicit

Definition at line 435 of file mceliece_key.cpp.

435 :
436 McEliece_PrivateKey(AlgorithmIdentifier(), key_bits) {}
McEliece_PrivateKey(RandomNumberGenerator &rng, size_t code_length, size_t t)

References McEliece_PrivateKey().

◆ McEliece_PrivateKey() [4/6]

Botan::McEliece_PrivateKey::McEliece_PrivateKey ( const polyn_gf2m & goppa_polyn,
const std::vector< uint32_t > & parity_check_matrix_coeffs,
const std::vector< polyn_gf2m > & square_root_matrix,
const std::vector< gf2m > & inverse_support,
const std::vector< uint8_t > & public_matrix )

Definition at line 205 of file mceliece_key.cpp.

209 {
210 const int goppa_degree = goppa_polyn.get_degree();
211 if(goppa_degree <= 0) {
212 throw Decoding_Error("invalid McEliece Goppa polynomial degree");
213 }
214
215 const McEliece_Params params = mceliece_validate_key_params(inverse_support.size(), goppa_degree);
216 validate_private_components(
217 goppa_polyn, parity_check_matrix_coeffs, square_root_matrix, inverse_support, public_matrix, params);
218
219 m_public = std::make_shared<const McEliece_PublicKeyInternal>(public_matrix, params.t, params.code_length);
220 m_private = std::make_shared<const McEliece_PrivateKeyInternal>(std::vector<polyn_gf2m>{goppa_polyn},
221 square_root_matrix,
222 inverse_support,
223 parity_check_matrix_coeffs,
224 params.codimension,
225 params.dimension);
226}

References Botan::McEliece_Params::code_length, Botan::McEliece_Params::codimension, Botan::McEliece_Params::dimension, Botan::McEliece_PublicKey::m_public, McEliece_PrivateKey(), Botan::mceliece_validate_key_params(), and Botan::McEliece_Params::t.

◆ ~McEliece_PrivateKey()

Botan::McEliece_PrivateKey::~McEliece_PrivateKey ( )
overridedefault

◆ McEliece_PrivateKey() [5/6]

Botan::McEliece_PrivateKey::McEliece_PrivateKey ( const McEliece_PrivateKey & )
default

References McEliece_PrivateKey().

◆ McEliece_PrivateKey() [6/6]

Botan::McEliece_PrivateKey::McEliece_PrivateKey ( McEliece_PrivateKey && )
defaultnoexcept

References McEliece_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::McEliece_PrivateKey::_create_kem_decryption_op ( RandomNumberGenerator & rng,
const PK_KEM_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 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 from Botan::Private_Key.

Definition at line 633 of file mceliece_key.cpp.

634 {
635 BOTAN_UNUSED(rng);
637
638 return std::make_unique<MCE_KEM_Decryptor>(m_private, options);
639}
std::string algo_name() const override
Definition mceliece.h:44
void require_software_provider(const OptionsT &options, std::string_view algo_name)

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

◆ _create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::McEliece_PublicKey::_create_kem_encryption_op ( const PK_KEM_Options_Reader & options) const
overridevirtualinherited

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

Definition at line 626 of file mceliece_key.cpp.

627 {
629
630 return std::make_unique<MCE_KEM_Encryptor>(m_public, options);
631}

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

◆ _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::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::McEliece_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 44 of file mceliece.h.

44{ return "McEliece"; }

Referenced by Botan::McEliece_PrivateKey::_create_kem_decryption_op(), and _create_kem_encryption_op().

◆ algorithm_identifier()

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

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 318 of file mceliece_key.cpp.

318 {
319 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
320}
virtual OID object_identifier() const
Definition pk_keys.cpp:24

References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

◆ check_key()

bool Botan::McEliece_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 409 of file mceliece_key.cpp.

409 {
410 if(!McEliece_PublicKey::check_key(rng, strong)) {
411 return false;
412 }
413
414 if(!strong) {
415 return true;
416 }
417
418 const secure_vector<uint8_t> plaintext = this->random_plaintext_element(rng);
419
420 secure_vector<uint8_t> ciphertext;
422 mceliece_encrypt(ciphertext, errors, plaintext, *m_public, rng);
423
424 secure_vector<uint8_t> plaintext_out;
425 secure_vector<uint8_t> errors_out;
426 mceliece_decrypt(plaintext_out, errors_out, ciphertext, *m_private);
427
428 if(errors != errors_out || plaintext != plaintext_out) {
429 return false;
430 }
431
432 return true;
433}
secure_vector< uint8_t > random_plaintext_element(RandomNumberGenerator &rng) const
bool check_key(RandomNumberGenerator &rng, bool strong) const override
void mceliece_decrypt(secure_vector< uint8_t > &plaintext_out, secure_vector< uint8_t > &error_mask_out, const secure_vector< uint8_t > &ciphertext, const McEliece_PrivateKeyInternal &key)
void mceliece_encrypt(secure_vector< uint8_t > &ciphertext_out, secure_vector< uint8_t > &error_mask_out, const secure_vector< uint8_t > &plaintext, const McEliece_PublicKeyInternal &key, RandomNumberGenerator &rng)
Definition mceliece.cpp:119

References Botan::McEliece_PublicKey::check_key(), Botan::McEliece_PublicKey::m_public, Botan::mceliece_decrypt(), Botan::mceliece_encrypt(), and Botan::McEliece_PublicKey::random_plaintext_element().

Referenced by operator=().

◆ 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::McEliece_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 343 of file mceliece_key.cpp.

343 {
344 return mceliece_work_factor(m_public->code_length(), m_public->t());
345}
size_t mceliece_work_factor(size_t n, size_t t)

References m_public, and Botan::mceliece_work_factor().

◆ 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::McEliece_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 622 of file mceliece_key.cpp.

622 {
623 return std::make_unique<McEliece_PrivateKey>(rng, get_code_length(), get_t());
624}

References get_code_length(), and get_t().

◆ get_code_length()

size_t Botan::McEliece_PublicKey::get_code_length ( ) const
inherited

Definition at line 264 of file mceliece_key.cpp.

264 {
265 return m_public->code_length();
266}

References m_public.

Referenced by generate_another(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::public_key(), and public_key_bits().

◆ get_codimension()

size_t Botan::McEliece_PrivateKey::get_codimension ( ) const

Definition at line 314 of file mceliece_key.cpp.

314 {
315 return m_private->codimension();
316}

Referenced by operator=().

◆ get_dimension()

size_t Botan::McEliece_PrivateKey::get_dimension ( ) const

Definition at line 310 of file mceliece_key.cpp.

310 {
311 return m_private->dimension();
312}

Referenced by operator=().

◆ get_goppa_polyn()

const polyn_gf2m & Botan::McEliece_PrivateKey::get_goppa_polyn ( ) const

Definition at line 294 of file mceliece_key.cpp.

294 {
295 return m_private->goppa_polyn();
296}

Referenced by operator=().

◆ get_H_coeffs()

const std::vector< uint32_t > & Botan::McEliece_PrivateKey::get_H_coeffs ( ) const

Definition at line 298 of file mceliece_key.cpp.

298 {
299 return m_private->H_coeffs();
300}

Referenced by operator=().

◆ get_int_field()

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

Access an algorithm specific field

If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.

Some algorithms may not implement this method at all.

This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.

TODO(Botan4) Change this to return by value

Reimplemented in Botan::DH_PrivateKey, Botan::DH_PublicKey, Botan::DSA_PrivateKey, Botan::DSA_PublicKey, Botan::EC_PrivateKey, Botan::EC_PublicKey, Botan::ElGamal_PrivateKey, Botan::ElGamal_PublicKey, Botan::RSA_PrivateKey, and Botan::RSA_PublicKey.

Definition at line 20 of file pk_keys.cpp.

20 {
21 throw Unknown_PK_Field_Name(algo_name(), field);
22}

References algo_name().

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

◆ get_Linv()

const std::vector< gf2m > & Botan::McEliece_PrivateKey::get_Linv ( ) const

Definition at line 302 of file mceliece_key.cpp.

302 {
303 return m_private->Linv();
304}

Referenced by operator=().

◆ get_message_word_bit_length()

size_t Botan::McEliece_PublicKey::get_message_word_bit_length ( ) const
inherited

Definition at line 272 of file mceliece_key.cpp.

272 {
273 return m_public->message_word_bit_length();
274}

References m_public.

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

◆ get_public_matrix()

const std::vector< uint8_t > & Botan::McEliece_PublicKey::get_public_matrix ( ) const
inherited

Definition at line 268 of file mceliece_key.cpp.

268 {
269 return m_public->public_matrix();
270}

References m_public.

Referenced by Botan::McEliece_PrivateKey::public_key().

◆ get_sqrtmod()

const std::vector< polyn_gf2m > & Botan::McEliece_PrivateKey::get_sqrtmod ( ) const

Definition at line 306 of file mceliece_key.cpp.

306 {
307 return m_private->sqrtmod();
308}

Referenced by operator=().

◆ get_t()

size_t Botan::McEliece_PublicKey::get_t ( ) const
inherited

◆ key_length()

size_t Botan::McEliece_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 339 of file mceliece_key.cpp.

339 {
340 return m_public->code_length();
341}

References m_public.

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

◆ operator!=() [1/2]

bool Botan::McEliece_PrivateKey::operator!= ( const McEliece_PrivateKey & other) const
inline

Definition at line 142 of file mceliece.h.

142{ return !(*this == other); }

References McEliece_PrivateKey().

◆ operator!=() [2/2]

bool Botan::McEliece_PublicKey::operator!= ( const McEliece_PublicKey & other) const
inlineinherited

Definition at line 66 of file mceliece.h.

66{ return !(*this == other); }

References McEliece_PublicKey().

◆ operator=() [1/2]

McEliece_PrivateKey & Botan::McEliece_PrivateKey::operator= ( const McEliece_PrivateKey & )
default

References McEliece_PrivateKey().

◆ operator=() [2/2]

◆ operator==() [1/2]

bool Botan::McEliece_PrivateKey::operator== ( const McEliece_PrivateKey & other) const

Definition at line 509 of file mceliece_key.cpp.

509 {
510 if(*static_cast<const McEliece_PublicKey*>(this) != *static_cast<const McEliece_PublicKey*>(&other)) {
511 return false;
512 }
513 if(m_private->goppa_polyn_vec() != other.m_private->goppa_polyn_vec()) {
514 return false;
515 }
516
517 if(m_private->sqrtmod() != other.m_private->sqrtmod()) {
518 return false;
519 }
520 if(m_private->Linv() != other.m_private->Linv()) {
521 return false;
522 }
523 if(m_private->H_coeffs() != other.m_private->H_coeffs()) {
524 return false;
525 }
526
527 if(m_private->codimension() != other.m_private->codimension() ||
528 m_private->dimension() != other.m_private->dimension()) {
529 return false;
530 }
531
532 return true;
533}
McEliece_PublicKey(const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)

References McEliece_PrivateKey(), and Botan::McEliece_PublicKey::McEliece_PublicKey().

◆ operator==() [2/2]

bool Botan::McEliece_PublicKey::operator== ( const McEliece_PublicKey & other) const
inherited

Definition at line 539 of file mceliece_key.cpp.

539 {
540 if(m_public->public_matrix() != other.m_public->public_matrix()) {
541 return false;
542 }
543 if(m_public->t() != other.m_public->t()) {
544 return false;
545 }
546 if(m_public->code_length() != other.m_public->code_length()) {
547 return false;
548 }
549 return true;
550}

References m_public, and McEliece_PublicKey().

◆ 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::McEliece_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 376 of file mceliece_key.cpp.

376 {
377 DER_Encoder enc;
378 enc.start_sequence()
379 .start_sequence()
380 .encode(get_code_length())
381 .encode(get_t())
382 .end_cons()
383 .encode(m_public->public_matrix(), ASN1_Type::OctetString)
384 .encode(m_private->goppa_polyn().encode(), ASN1_Type::OctetString); // g as octet string
385 enc.start_sequence();
386 for(const auto& x : m_private->sqrtmod()) {
387 enc.encode(x.encode(), ASN1_Type::OctetString);
388 }
389 enc.end_cons();
390 secure_vector<uint8_t> enc_support;
391
392 for(const uint16_t Linv : m_private->Linv()) {
393 enc_support.push_back(get_byte<0>(Linv));
394 enc_support.push_back(get_byte<1>(Linv));
395 }
396 enc.encode(enc_support, ASN1_Type::OctetString);
398 for(const uint32_t coef : m_private->H_coeffs()) {
399 enc_H.push_back(get_byte<0>(coef));
400 enc_H.push_back(get_byte<1>(coef));
401 enc_H.push_back(get_byte<2>(coef));
402 enc_H.push_back(get_byte<3>(coef));
403 }
404 enc.encode(enc_H, ASN1_Type::OctetString);
405 enc.end_cons();
406 return enc.get_contents();
407}
constexpr uint8_t get_byte(T input)
Definition loadstor.h:79

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::get_byte(), Botan::McEliece_PublicKey::get_code_length(), Botan::DER_Encoder::get_contents(), Botan::McEliece_PublicKey::get_t(), Botan::McEliece_PublicKey::m_public, Botan::OctetString, and Botan::DER_Encoder::start_sequence().

Referenced by operator=().

◆ 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::McEliece_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 535 of file mceliece_key.cpp.

535 {
536 return std::make_unique<McEliece_PublicKey>(get_public_matrix(), get_t(), get_code_length());
537}
const std::vector< uint8_t > & get_public_matrix() const

References Botan::McEliece_PublicKey::get_code_length(), Botan::McEliece_PublicKey::get_public_matrix(), and Botan::McEliece_PublicKey::get_t().

Referenced by operator=().

◆ public_key_bits()

std::vector< uint8_t > Botan::McEliece_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 326 of file mceliece_key.cpp.

326 {
327 std::vector<uint8_t> output;
328 DER_Encoder(output)
329 .start_sequence()
330 .start_sequence()
331 .encode(get_code_length())
332 .encode(get_t())
333 .end_cons()
334 .encode(m_public->public_matrix(), ASN1_Type::OctetString)
335 .end_cons();
336 return output;
337}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_code_length(), get_t(), m_public, Botan::OctetString, and Botan::DER_Encoder::start_sequence().

◆ random_plaintext_element()

secure_vector< uint8_t > Botan::McEliece_PublicKey::random_plaintext_element ( RandomNumberGenerator & rng) const
inherited

Definition at line 276 of file mceliece_key.cpp.

276 {
277 return m_public->random_plaintext_element(rng);
278}

References m_public.

Referenced by Botan::McEliece_PrivateKey::check_key(), and ~McEliece_PublicKey().

◆ raw_private_key_bits()

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

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 in Botan::Classic_McEliece_PrivateKey, Botan::DH_PrivateKey, Botan::DSA_PrivateKey, Botan::EC_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::ElGamal_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Module_Lattice_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 89 of file pk_keys.cpp.

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

References Botan::Asymmetric_Key::algo_name().

Referenced by private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::McEliece_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 322 of file mceliece_key.cpp.

322 {
323 return m_public->public_matrix();
324}

References m_public.

◆ 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::McEliece_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 70 of file mceliece.h.

70 {
72 }

References Botan::KeyEncapsulation.

Member Data Documentation

◆ m_public


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