#include <mceliece.h>

Inheritance diagram for Botan::McEliece_PublicKey:

Public Member Functions
std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

bool	check_key (RandomNumberGenerator &, bool) const override

virtual 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_Encryption >	create_kem_encryption_op (std::string_view params, std::string_view provider) const override

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

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

virtual Signature_Format	default_x509_signature_format () const

size_t	estimated_strength () const override

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

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

size_t	get_message_word_bit_length () const

OID	get_oid () const

const std::vector< uint8_t > &	get_public_matrix () const

size_t	get_t () const

size_t	key_length () const override

	McEliece_PublicKey (const McEliece_PublicKey &other)=default

	McEliece_PublicKey (const std::vector< uint8_t > &pub_matrix, size_t t, size_t the_code_length)

	McEliece_PublicKey (std::span< const uint8_t > key_bits)

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

virtual OID	object_identifier () const

bool	operator!= (const McEliece_PublicKey &other) const

McEliece_PublicKey &	operator= (const McEliece_PublicKey &other)=default

bool	operator== (const McEliece_PublicKey &other) const

std::vector< uint8_t >	public_key_bits () const override

secure_vector< uint8_t >	random_plaintext_element (RandomNumberGenerator &rng) const

std::vector< uint8_t >	raw_public_key_bits () const override

std::vector< uint8_t >	subject_public_key () const

bool	supports_operation (PublicKeyOperation op) const override

	~McEliece_PublicKey () override=default

Protected Member Functions
	McEliece_PublicKey ()

Protected Attributes
size_t	m_code_length

std::vector< uint8_t >	m_public_matrix

size_t	m_t

Detailed Description

Definition at line 25 of file mceliece.h.

Constructor & Destructor Documentation

◆ McEliece_PublicKey() [1/4]

Botan::McEliece_PublicKey::McEliece_PublicKey ( std::span< const uint8_t > key_bits )

explicit

Definition at line 105 of file mceliece_key.cpp.

                                                                      {
   BER_Decoder dec(key_bits);
   size_t n;
   size_t t;
   dec.start_sequence()
      .start_sequence()
      .decode(n)
      .decode(t)
      .end_cons()
      .decode(m_public_matrix, ASN1_Type::OctetString)
      .end_cons();
   m_t = t;
   m_code_length = n;
}

References Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), m_code_length, m_public_matrix, m_t, Botan::OctetString, and Botan::BER_Decoder::start_sequence().

◆ McEliece_PublicKey() [2/4]

Botan::McEliece_PublicKey::McEliece_PublicKey	(	const std::vector< uint8_t > &	pub_matrix,
		size_t	t,
		size_t	the_code_length )

inline

Definition at line 29 of file mceliece.h.

29 :

30 m_public_matrix(pub_matrix), m_t(t), m_code_length(the_code_length) {}

◆ McEliece_PublicKey() [3/4]

Botan::McEliece_PublicKey::McEliece_PublicKey ( const McEliece_PublicKey & other )

default

◆ ~McEliece_PublicKey()

Botan::McEliece_PublicKey::~McEliece_PublicKey ( )

overridedefault

◆ McEliece_PublicKey() [4/4]

Botan::McEliece_PublicKey::McEliece_PublicKey ( )

inlineprotected

Definition at line 72 of file mceliece.h.

72: m_t(0), m_code_length(0) {}

Member Function Documentation

◆ algo_name()

std::string Botan::McEliece_PublicKey::algo_name ( ) const

inlineoverridevirtual

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 38 of file mceliece.h.

38{ 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

overridevirtual

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 76 of file mceliece_key.cpp.

                                                                   {
   return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
}

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

◆ check_key()

bool Botan::McEliece_PublicKey::check_key	(	RandomNumberGenerator &	,
		bool	) const

inlineoverridevirtual

Implements Botan::Public_Key.

Definition at line 48 of file mceliece.h.

48{ return true; }

◆ create_encryption_op()

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

virtualinherited

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

Return an encryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

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

Definition at line 90 of file pk_keys.cpp.

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

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

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

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

overridevirtual

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

Return a KEM encryption operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 352 of file mceliece_key.cpp.

                                                                                                                    {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<MCE_KEM_Encryptor>(*this, params);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

References algo_name().

◆ create_verification_op()

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

virtualinherited

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

Return a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 101 of file pk_keys.cpp.

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

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

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

◆ create_x509_verification_op()

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

virtualinherited

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

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

Parameters

signature_algorithm	is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
provider	the provider to use

Reimplemented in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 106 of file pk_keys.cpp.

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

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

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

◆ default_x509_signature_format()

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

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 201 of file pk_keys.h.

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

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

◆ estimated_strength()

size_t Botan::McEliece_PublicKey::estimated_strength ( ) const

overridevirtual

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

                                                    {
   return mceliece_work_factor(m_code_length, m_t);
}

References m_code_length, m_t, and Botan::mceliece_work_factor().

◆ fingerprint_public()

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

inherited

Returns: Hash of the subject public key

Definition at line 79 of file pk_keys.cpp.

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

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

◆ generate_another()

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

finalvirtual

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

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

References get_code_length(), and get_t().

◆ get_code_length()

size_t Botan::McEliece_PublicKey::get_code_length ( ) const

inline

Definition at line 52 of file mceliece.h.

52{ return m_code_length; }

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

◆ get_int_field()

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

virtualinherited

Access an algorithm specific field

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

Some algorithms may not implement this method at all.

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

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

Definition at line 18 of file pk_keys.cpp.

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

References Botan::Asymmetric_Key::algo_name().

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

◆ get_message_word_bit_length()

size_t Botan::McEliece_PublicKey::get_message_word_bit_length ( ) const

Definition at line 56 of file mceliece_key.cpp.

                                                             {
   size_t codimension = ceil_log2(m_code_length) * m_t;
   return m_code_length - codimension;
}

References Botan::ceil_log2(), m_code_length, and m_t.

Referenced by Botan::mceliece_decrypt(), and random_plaintext_element().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 132 of file pk_keys.h.

132{ return this->object_identifier(); }

◆ get_public_matrix()

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

inline

Definition at line 56 of file mceliece.h.

56{ return m_public_matrix; }

Referenced by Botan::mceliece_encrypt(), and Botan::McEliece_PrivateKey::public_key().

◆ get_t()

size_t Botan::McEliece_PublicKey::get_t ( ) const

inline

Definition at line 50 of file mceliece.h.

50{ return m_t; }

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

◆ key_length()

size_t Botan::McEliece_PublicKey::key_length ( ) const

overridevirtual

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

                                            {
   return m_code_length;
}

References m_code_length.

◆ message_part_size()

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

inlinevirtualinherited

Returns how large each of the message parts refered to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns: size of the message parts in bits

Reimplemented in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 199 of file pk_keys.h.

199{ return 0; }

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

◆ message_parts()

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

inlinevirtualinherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns: number of message parts

Reimplemented in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 188 of file pk_keys.h.

188{ return 1; }

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

◆ object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in Botan::Dilithium_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, and Botan::SphincsPlus_PublicKey.

Definition at line 22 of file pk_keys.cpp.

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

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

◆ operator!=()

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

inline

Definition at line 60 of file mceliece.h.

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

◆ operator=()

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

default

◆ operator==()

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

Definition at line 268 of file mceliece_key.cpp.

                                                                         {
   if(m_public_matrix != other.m_public_matrix) {
      return false;
   }
   if(m_t != other.m_t) {
      return false;
   }
   if(m_code_length != other.m_code_length) {
      return false;
   }
   return true;
}

References m_code_length, m_public_matrix, and m_t.

◆ public_key_bits()

std::vector< uint8_t > Botan::McEliece_PublicKey::public_key_bits ( ) const

overridevirtual

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 84 of file mceliece_key.cpp.

                                                             {
   std::vector<uint8_t> output;
   DER_Encoder(output)
      .start_sequence()
      .start_sequence()
      .encode(static_cast<size_t>(get_code_length()))
      .encode(static_cast<size_t>(get_t()))
      .end_cons()
      .encode(m_public_matrix, ASN1_Type::OctetString)
      .end_cons();
   return output;
}

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

◆ random_plaintext_element()

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

Definition at line 61 of file mceliece_key.cpp.

                                                                                                    {
   const size_t bits = get_message_word_bit_length();
 
   secure_vector<uint8_t> plaintext((bits + 7) / 8);
   rng.randomize(plaintext.data(), plaintext.size());
 
   // unset unused bits in the last plaintext byte
   if(uint32_t used = bits % 8) {
      const uint8_t mask = (1 << used) - 1;
      plaintext[plaintext.size() - 1] &= mask;
   }
 
   return plaintext;
}

References get_message_word_bit_length(), and Botan::RandomNumberGenerator::randomize().

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

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::McEliece_PublicKey::raw_public_key_bits ( ) const

overridevirtual

Returns: binary public key bits, with no additional encoding

For key agreements this is an alias for PK_Key_Agreement_Key::public_value.

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.

Implements Botan::Public_Key.

Definition at line 80 of file mceliece_key.cpp.

                                                                 {
   return m_public_matrix;
}

References m_public_matrix.

◆ subject_public_key()

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

inherited

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

Definition at line 48 of file pk_keys.cpp.

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

References Botan::Public_Key::algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().

◆ supports_operation()

bool Botan::McEliece_PublicKey::supports_operation ( PublicKeyOperation op ) const

inlineoverridevirtual

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

Implements Botan::Asymmetric_Key.

Definition at line 64 of file mceliece.h.

                                                                    {
         return (op == PublicKeyOperation::KeyEncapsulation);
      }

Member Data Documentation

◆ m_code_length

size_t Botan::McEliece_PublicKey::m_code_length

protected

Definition at line 76 of file mceliece.h.

Referenced by estimated_strength(), get_message_word_bit_length(), key_length(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), McEliece_PublicKey(), and operator==().

◆ m_public_matrix

std::vector<uint8_t> Botan::McEliece_PublicKey::m_public_matrix

protected

Definition at line 74 of file mceliece.h.

Referenced by Botan::McEliece_PrivateKey::McEliece_PrivateKey(), McEliece_PublicKey(), operator==(), Botan::McEliece_PrivateKey::private_key_bits(), public_key_bits(), and raw_public_key_bits().

◆ m_t

size_t Botan::McEliece_PublicKey::m_t

protected

Definition at line 75 of file mceliece.h.

Referenced by estimated_strength(), get_message_word_bit_length(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), McEliece_PublicKey(), and operator==().

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

src/lib/pubkey/mce/mceliece.h
src/lib/pubkey/mce/mceliece_key.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ McEliece_PublicKey() [1/4]

◆ McEliece_PublicKey() [2/4]

◆ McEliece_PublicKey() [3/4]

◆ ~McEliece_PublicKey()

◆ McEliece_PublicKey() [4/4]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_encryption_op()

◆ create_kem_encryption_op()

◆ create_verification_op()

◆ create_x509_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_public()

◆ generate_another()

◆ get_code_length()

◆ get_int_field()

◆ get_message_word_bit_length()

◆ get_oid()

◆ get_public_matrix()

◆ get_t()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ object_identifier()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ public_key_bits()

◆ random_plaintext_element()

◆ raw_public_key_bits()

◆ subject_public_key()

◆ supports_operation()

Member Data Documentation

◆ m_code_length

◆ m_public_matrix

◆ m_t