Botan 3.13.0
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 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
virtual std::unique_ptr< PK_Ops::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::KEM_Decryptioncreate_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const override
virtual std::unique_ptr< PK_Ops::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Verificationcreate_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_Keygenerate_another (RandomNumberGenerator &rng) const final
size_t get_code_length () const
size_t get_codimension () const
size_t get_dimension () const
const polyn_gf2mget_goppa_polyn () const
const std::vector< uint32_t > & get_H_coeffs () const
virtual const BigIntget_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_PrivateKeyoperator= (const McEliece_PrivateKey &)
McEliece_PrivateKeyoperator= (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_Keypublic_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_PublicKeyInternalm_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 248 of file mceliece_key.cpp.

248 {
249 const McEliece_Params params = mceliece_validate_keygen_params(code_length, t);
250 *this = generate_mceliece_key(rng, params.ext_deg, code_length, t);
251}
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 449 of file mceliece_key.cpp.

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

446 :
447 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 219 of file mceliece_key.cpp.

223 {
224 const int goppa_degree = goppa_polyn.get_degree();
225 if(goppa_degree <= 0) {
226 throw Invalid_Argument("invalid McEliece Goppa polynomial degree");
227 }
228
229 const McEliece_Params params = mceliece_validate_keygen_params(inverse_support.size(), goppa_degree);
230 validate_private_components(goppa_polyn,
231 parity_check_matrix_coeffs,
232 square_root_matrix,
233 inverse_support,
234 public_matrix,
235 params,
236 McEliece_Key_Source::Raw);
237
238 m_public = std::make_shared<const McEliece_PublicKeyInternal>(public_matrix, params.t, params.code_length);
239 m_private = std::make_shared<const McEliece_PrivateKeyInternal>(std::vector<polyn_gf2m>{goppa_polyn},
240 square_root_matrix,
241 inverse_support,
242 parity_check_matrix_coeffs,
243 params.codimension,
244 params.dimension);
245}

References Botan::McEliece_Params::code_length, Botan::McEliece_Params::codimension, Botan::McEliece_Params::dimension, Botan::McEliece_PublicKey::m_public, McEliece_PrivateKey(), Botan::mceliece_validate_keygen_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

◆ _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 144 of file pk_keys.h.

144{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), 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 337 of file mceliece_key.cpp.

337 {
338 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
339}
virtual OID object_identifier() const
Definition pk_keys.cpp:22

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 428 of file mceliece_key.cpp.

428 {
429 const secure_vector<uint8_t> plaintext = this->random_plaintext_element(rng);
430
431 secure_vector<uint8_t> ciphertext;
433 mceliece_encrypt(ciphertext, errors, plaintext, *m_public, rng);
434
435 secure_vector<uint8_t> plaintext_out;
436 secure_vector<uint8_t> errors_out;
437 mceliece_decrypt(plaintext_out, errors_out, ciphertext, *m_private);
438
439 if(errors != errors_out || plaintext != plaintext_out) {
440 return false;
441 }
442
443 return true;
444}
secure_vector< uint8_t > random_plaintext_element(RandomNumberGenerator &rng) const
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::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
virtualinherited

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

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

Definition at line 126 of file pk_keys.cpp.

128 {
129 throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
130}
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(), and Botan::fmt().

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

◆ create_encryption_op()

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

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

Return an encryption operation for this key/params or throw

Parameters
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

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

Definition at line 105 of file pk_keys.cpp.

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

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

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

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::McEliece_PrivateKey::create_kem_decryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) 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/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

Reimplemented from Botan::Private_Key.

Definition at line 644 of file mceliece_key.cpp.

646 {
647 if(provider == "base" || provider.empty()) {
648 return std::make_unique<MCE_KEM_Decryptor>(m_private, params);
649 }
650 throw Provider_Not_Found(algo_name(), provider);
651}
std::string algo_name() const override
Definition mceliece.h:44

References Botan::McEliece_PublicKey::algo_name().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::McEliece_PublicKey::create_kem_encryption_op ( std::string_view params,
std::string_view provider ) 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/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 636 of file mceliece_key.cpp.

637 {
638 if(provider == "base" || provider.empty()) {
639 return std::make_unique<MCE_KEM_Encryptor>(m_public, params);
640 }
641 throw Provider_Not_Found(algo_name(), provider);
642}

References algo_name(), and m_public.

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

Reimplemented in Botan::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 144 of file pk_keys.cpp.

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

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

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

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
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.
paramsadditional parameters
providerthe provider to use

Reimplemented in Botan::Dilithium_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::RSA_PrivateKey, Botan::TPM_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 138 of file pk_keys.cpp.

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

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

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

◆ create_verification_op()

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

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

Return a verification operation for this key/params or throw

Parameters
paramsadditional parameters
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::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 116 of file pk_keys.cpp.

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

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

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

◆ create_x509_verification_op()

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

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

Return a verification operation for this combination of key and signature algorithm or throw.

Parameters
signature_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 121 of file pk_keys.cpp.

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

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

241 {
243 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

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 362 of file mceliece_key.cpp.

362 {
363 return mceliece_work_factor(m_public->code_length(), m_public->t());
364}
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 PKCS #8 encoding for this key object

Definition at line 101 of file pk_keys.cpp.

101 {
102 return create_hex_fingerprint(private_key_bits(), hash_algo);
103}
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:38

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

94 {
95 return create_hex_fingerprint(subject_public_key(), hash_algo);
96}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:63

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 632 of file mceliece_key.cpp.

632 {
633 return std::make_unique<McEliece_PrivateKey>(rng, get_code_length(), get_t());
634}

References get_code_length(), and get_t().

◆ get_code_length()

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

Definition at line 283 of file mceliece_key.cpp.

283 {
284 return m_public->code_length();
285}

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 333 of file mceliece_key.cpp.

333 {
334 return m_private->codimension();
335}

Referenced by operator=().

◆ get_dimension()

size_t Botan::McEliece_PrivateKey::get_dimension ( ) const

Definition at line 329 of file mceliece_key.cpp.

329 {
330 return m_private->dimension();
331}

Referenced by operator=().

◆ get_goppa_polyn()

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

Definition at line 313 of file mceliece_key.cpp.

313 {
314 return m_private->goppa_polyn();
315}

Referenced by operator=().

◆ get_H_coeffs()

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

Definition at line 317 of file mceliece_key.cpp.

317 {
318 return m_private->H_coeffs();
319}

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

18 {
19 throw Unknown_PK_Field_Name(algo_name(), field);
20}

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 321 of file mceliece_key.cpp.

321 {
322 return m_private->Linv();
323}

Referenced by operator=().

◆ get_message_word_bit_length()

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

Definition at line 291 of file mceliece_key.cpp.

291 {
292 return m_public->message_word_bit_length();
293}

References m_public.

◆ get_oid()

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

Deprecated version of object_identifier

Definition at line 168 of file pk_keys.h.

168{ 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 287 of file mceliece_key.cpp.

287 {
288 return m_public->public_matrix();
289}

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 325 of file mceliece_key.cpp.

325 {
326 return m_private->sqrtmod();
327}

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 358 of file mceliece_key.cpp.

358 {
359 return m_public->code_length();
360}

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

232 {
233 return _signature_element_size_for_DER_encoding().value_or(0);
234 }

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

219 {
221 }

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 520 of file mceliece_key.cpp.

520 {
521 if(*static_cast<const McEliece_PublicKey*>(this) != *static_cast<const McEliece_PublicKey*>(&other)) {
522 return false;
523 }
524 if(m_private->goppa_polyn_vec() != other.m_private->goppa_polyn_vec()) {
525 return false;
526 }
527
528 if(m_private->sqrtmod() != other.m_private->sqrtmod()) {
529 return false;
530 }
531 if(m_private->Linv() != other.m_private->Linv()) {
532 return false;
533 }
534 if(m_private->H_coeffs() != other.m_private->H_coeffs()) {
535 return false;
536 }
537
538 if(m_private->codimension() != other.m_private->codimension() ||
539 m_private->dimension() != other.m_private->dimension()) {
540 return false;
541 }
542
543 return true;
544}
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 550 of file mceliece_key.cpp.

550 {
551 if(m_public->public_matrix() != other.m_public->public_matrix()) {
552 return false;
553 }
554 if(m_public->t() != other.m_public->t()) {
555 return false;
556 }
557 if(m_public->code_length() != other.m_public->code_length()) {
558 return false;
559 }
560 return true;
561}

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

343{ 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 395 of file mceliece_key.cpp.

395 {
396 DER_Encoder enc;
397 enc.start_sequence()
398 .start_sequence()
399 .encode(get_code_length())
400 .encode(get_t())
401 .end_cons()
402 .encode(m_public->public_matrix(), ASN1_Type::OctetString)
403 .encode(m_private->goppa_polyn().encode(), ASN1_Type::OctetString); // g as octet string
404 enc.start_sequence();
405 for(const auto& x : m_private->sqrtmod()) {
406 enc.encode(x.encode(), ASN1_Type::OctetString);
407 }
408 enc.end_cons();
409 secure_vector<uint8_t> enc_support;
410
411 for(const uint16_t Linv : m_private->Linv()) {
412 enc_support.push_back(get_byte<0>(Linv));
413 enc_support.push_back(get_byte<1>(Linv));
414 }
415 enc.encode(enc_support, ASN1_Type::OctetString);
417 for(const uint32_t coef : m_private->H_coeffs()) {
418 enc_H.push_back(get_byte<0>(coef));
419 enc_H.push_back(get_byte<1>(coef));
420 enc_H.push_back(get_byte<2>(coef));
421 enc_H.push_back(get_byte<3>(coef));
422 }
423 enc.encode(enc_H, ASN1_Type::OctetString);
424 enc.end_cons();
425 return enc.get_contents();
426}
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 75 of file pk_keys.cpp.

75 {
76 const size_t PKCS8_VERSION = 0;
77
78 return DER_Encoder()
79 .start_sequence()
80 .encode(PKCS8_VERSION)
83 .end_cons()
84 .get_contents();
85}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:343

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 546 of file mceliece_key.cpp.

546 {
547 return std::make_unique<McEliece_PublicKey>(get_public_matrix(), get_t(), get_code_length());
548}
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 345 of file mceliece_key.cpp.

345 {
346 std::vector<uint8_t> output;
347 DER_Encoder(output)
348 .start_sequence()
349 .start_sequence()
350 .encode(get_code_length())
351 .encode(get_t())
352 .end_cons()
353 .encode(m_public->public_matrix(), ASN1_Type::OctetString)
354 .end_cons();
355 return output;
356}

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 295 of file mceliece_key.cpp.

295 {
296 return m_public->random_plaintext_element(rng);
297}

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

Definition at line 87 of file pk_keys.cpp.

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

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 341 of file mceliece_key.cpp.

341 {
342 return m_public->public_matrix();
343}

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

356{ 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 349 of file pk_keys.h.

349{ 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 63 of file pk_keys.cpp.

63 {
64 std::vector<uint8_t> output;
65
66 DER_Encoder(output)
67 .start_sequence()
68 .encode(algorithm_identifier())
69 .encode_octet_aligned_bitstring(public_key_bits())
70 .end_cons();
71
72 return output;
73}
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: