#include <mceliece.h>

Inheritance diagram for Botan::McEliece_PrivateKey:

Public Member Functions
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::Decryption >	create_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const

virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const

std::unique_ptr< PK_Ops::KEM_Decryption >	create_kem_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override

std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override

virtual std::unique_ptr< PK_Ops::Key_Agreement >	create_key_agreement_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const

virtual std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const

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

virtual Signature_Format	default_x509_signature_format () const

size_t	estimated_strength () const override

std::string	fingerprint_private (const std::string &alg) const

std::string	fingerprint_public (const std::string &alg="SHA-256") const

size_t	get_code_length () const

size_t	get_codimension () const

size_t	get_dimension () const

polyn_gf2m const &	get_goppa_polyn () const

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

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

size_t	get_message_word_bit_length () const

virtual OID	get_oid () const

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

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

size_t	get_t () const

size_t	key_length () const override

	McEliece_PrivateKey (const McEliece_PrivateKey &)

	McEliece_PrivateKey (const secure_vector< uint8_t > &key_bits)

	McEliece_PrivateKey (McEliece_PrivateKey &&)

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

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

virtual size_t	message_part_size () const

virtual size_t	message_parts () 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 &&)

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 bool	stateful_operation () const

std::vector< uint8_t >	subject_public_key () const

	~McEliece_PrivateKey ()

Protected Attributes
size_t	m_code_length

std::vector< uint8_t >	m_public_matrix

size_t	m_t

Detailed Description

Definition at line 72 of file mceliece.h.

Constructor & Destructor Documentation

◆ McEliece_PrivateKey() [1/5]

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

Generate a McEliece key pair

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

   {
   uint32_t ext_deg = ceil_log2(code_length);
   *this = generate_mceliece_key(rng, ext_deg, code_length, t);
   }

References Botan::ceil_log2(), and Botan::generate_mceliece_key().

◆ McEliece_PrivateKey() [2/5]

Botan::McEliece_PrivateKey::McEliece_PrivateKey ( const secure_vector< uint8_t > & key_bits )

explicit

Definition at line 181 of file mceliece_key.cpp.

   {
   size_t n, t;
   secure_vector<uint8_t> enc_g;
   BER_Decoder dec_base(key_bits);
   BER_Decoder dec = dec_base.start_sequence()
      .start_sequence()
      .decode(n)
      .decode(t)
      .end_cons()
      .decode(m_public_matrix, ASN1_Type::OctetString)
      .decode(enc_g, ASN1_Type::OctetString);
 
   if(t == 0 || n == 0)
      throw Decoding_Error("invalid McEliece parameters");
 
   uint32_t ext_deg = ceil_log2(n);
   m_code_length = n;
   m_t = t;
   m_codimension = (ext_deg * t);
   m_dimension = (n - m_codimension);
 
   auto sp_field = std::make_shared<GF2m_Field>(ext_deg);
   m_g = { polyn_gf2m(enc_g, sp_field) };
   if(m_g[0].get_degree() != static_cast<int>(t))
      {
      throw Decoding_Error("degree of decoded Goppa polynomial is incorrect");
      }
   BER_Decoder dec2 = dec.start_sequence();
   for(uint32_t i = 0; i < t/2; i++)
      {
      secure_vector<uint8_t> sqrt_enc;
      dec2.decode(sqrt_enc, ASN1_Type::OctetString);
      while(sqrt_enc.size() < (t*2))
         {
         // ensure that the length is always t
         sqrt_enc.push_back(0);
         sqrt_enc.push_back(0);
         }
      if(sqrt_enc.size() != t*2)
         {
         throw Decoding_Error("length of square root polynomial entry is too large");
         }
      m_sqrtmod.push_back(polyn_gf2m(sqrt_enc, sp_field));
      }
   secure_vector<uint8_t> enc_support;
   BER_Decoder dec3 = dec2.end_cons()
      .decode(enc_support, ASN1_Type::OctetString);
   if(enc_support.size() % 2)
      {
      throw Decoding_Error("encoded support has odd length");
      }
   if(enc_support.size() / 2 != n)
      {
      throw Decoding_Error("encoded support has length different from code length");
      }
   for(uint32_t i = 0; i < n*2; i+=2)
      {
      gf2m el = (enc_support[i] << 8) |  enc_support[i+1];
      m_Linv.push_back(el);
      }
   secure_vector<uint8_t> enc_H;
   dec3.decode(enc_H, ASN1_Type::OctetString)
      .end_cons();
   if(enc_H.size() % 4)
      {
      throw Decoding_Error("encoded parity check matrix has length which is not a multiple of four");
      }
   if(enc_H.size() / 4 != bit_size_to_32bit_size(m_codimension) * m_code_length)
      {
      throw Decoding_Error("encoded parity check matrix has wrong length");
      }
 
   for(uint32_t i = 0; i < enc_H.size(); i+=4)
      {
      uint32_t coeff = (enc_H[i] << 24) | (enc_H[i+1] << 16) | (enc_H[i+2] << 8) | enc_H[i+3];
      m_coeffs.push_back(coeff);
      }
 
   }

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

◆ McEliece_PrivateKey() [3/5]

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

Definition at line 32 of file mceliece_key.cpp.

                                                                                  :
   McEliece_PublicKey(public_matrix, goppa_polyn.get_degree(), inverse_support.size()),
   m_g{goppa_polyn},
   m_sqrtmod(square_root_matrix),
   m_Linv(inverse_support),
   m_coeffs(parity_check_matrix_coeffs),
   m_codimension(static_cast<size_t>(ceil_log2(inverse_support.size())) * goppa_polyn.get_degree()),
   m_dimension(inverse_support.size() - m_codimension)
   {
   }

◆ ~McEliece_PrivateKey()

Botan::McEliece_PrivateKey::~McEliece_PrivateKey ( )

default

◆ McEliece_PrivateKey() [4/5]

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

default

◆ McEliece_PrivateKey() [5/5]

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

default

Member Function Documentation

◆ 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::Public_Key.

Definition at line 39 of file mceliece.h.

39{ return "McEliece"; }

Referenced by create_kem_decryption_op(), and Botan::McEliece_PublicKey::create_kem_encryption_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::McEliece_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 81 of file mceliece_key.cpp.

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

References Botan::Public_Key::get_oid(), 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.

Parameters

rng	rng to use
strong	whether to perform strong and lengthy version of the test

Returns: true if the test is passed

Reimplemented from Botan::McEliece_PublicKey.

Definition at line 163 of file mceliece_key.cpp.

   {
   const secure_vector<uint8_t> plaintext = this->random_plaintext_element(rng);
 
   secure_vector<uint8_t> ciphertext;
   secure_vector<uint8_t> errors;
   mceliece_encrypt(ciphertext, errors, plaintext, *this, rng);
 
   secure_vector<uint8_t> plaintext_out;
   secure_vector<uint8_t> errors_out;
   mceliece_decrypt(plaintext_out, errors_out, ciphertext, *this);
 
   if(errors != errors_out || plaintext != plaintext_out)
      return false;
 
   return true;
   }

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

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op	(	RandomNumberGenerator &	rng,
		const std::string &	params,
		const std::string &	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 decryption 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_PrivateKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.

Definition at line 114 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support decryption");
   }

References Botan::Public_Key::algo_name().

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,
		const std::string &	params,
		const std::string &	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, and Botan::SM2_PublicKey.

Definition at line 91 of file pk_keys.cpp.

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

References Botan::Public_Key::algo_name().

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,
		const std::string &	params,
		const std::string &	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 decryption 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 from Botan::Private_Key.

Definition at line 385 of file mceliece_key.cpp.

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

References Botan::McEliece_PublicKey::algo_name().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::McEliece_PublicKey::create_kem_encryption_op	(	RandomNumberGenerator &	rng,
		const std::string &	params,
		const std::string &	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

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

Definition at line 375 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 Botan::McEliece_PublicKey::algo_name().

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op	(	RandomNumberGenerator &	rng,
		const std::string &	params,
		const std::string &	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 a key agreement 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::Curve25519_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.

Definition at line 138 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support key agreement");
   }

References Botan::Public_Key::algo_name().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_op	(	RandomNumberGenerator &	rng,
		const std::string &	params,
		const std::string &	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 a signature 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::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.

Definition at line 130 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support signatures");
   }

References Botan::Public_Key::algo_name().

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

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op	(	const std::string &	params,
		const std::string &	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 a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::XMSS_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 107 of file pk_keys.cpp.

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

References Botan::Public_Key::algo_name().

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::create_verification_op(), and 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 125 of file pk_keys.h.

         {
         return (this->message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
         }

References Botan::DER_SEQUENCE, and Botan::IEEE_1363.

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

◆ 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::Public_Key.

Definition at line 105 of file mceliece_key.cpp.

   {
   return mceliece_work_factor(m_code_length, m_t);
   }

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

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( const std::string & alg ) const

inherited

Returns: Hash of the PKCS #8 encoding for this key object

Definition at line 85 of file pk_keys.cpp.

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

References Botan::create_hex_fingerprint(), hash_algo, and Botan::Private_Key::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 ( const std::string & alg = "SHA-256" ) const

inherited

Returns: Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

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

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

◆ get_code_length()

size_t Botan::McEliece_PublicKey::get_code_length ( ) const

inlineinherited

Definition at line 52 of file mceliece.h.

52{ return m_code_length; }

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

◆ get_codimension()

size_t Botan::McEliece_PrivateKey::get_codimension ( ) const

inline

Definition at line 116 of file mceliece.h.

116{ return m_codimension; }

Referenced by Botan::mceliece_decrypt().

◆ get_dimension()

size_t Botan::McEliece_PrivateKey::get_dimension ( ) const

inline

Definition at line 114 of file mceliece.h.

114{ return m_dimension; }

Referenced by Botan::mceliece_decrypt().

◆ get_goppa_polyn()

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

Definition at line 53 of file mceliece_key.cpp.

   {
   return m_g[0];
   }

Referenced by Botan::mceliece_decrypt().

◆ get_H_coeffs()

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

inline

Definition at line 110 of file mceliece.h.

110{ return m_coeffs; }

References m_coeffs.

Referenced by Botan::mceliece_decrypt().

◆ get_Linv()

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

inline

Definition at line 111 of file mceliece.h.

111{ return m_Linv; }

Referenced by Botan::mceliece_decrypt().

◆ get_message_word_bit_length()

size_t Botan::McEliece_PublicKey::get_message_word_bit_length ( ) const

inherited

Definition at line 58 of file mceliece_key.cpp.

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

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

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

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 53 of file pk_keys.cpp.

   {
   OID o = OIDS::str2oid_or_empty(algo_name());
   if(o.empty())
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
   return o;
   }

References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().

◆ get_public_matrix()

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

inlineinherited

Definition at line 54 of file mceliece.h.

54{ return m_public_matrix; }

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

◆ get_sqrtmod()

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

inline

Definition at line 112 of file mceliece.h.

112{ return m_sqrtmod; }

Referenced by Botan::mceliece_decrypt().

◆ get_t()

size_t Botan::McEliece_PublicKey::get_t ( ) const

inlineinherited

Definition at line 51 of file mceliece.h.

51{ return m_t; }

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

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

   {
   return m_code_length;
   }

References Botan::McEliece_PublicKey::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 123 of file pk_keys.h.

123{ return 0; }

Referenced by Botan::PK_Signer::PK_Signer(), 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 112 of file pk_keys.h.

112{ return 1; }

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

◆ operator!=() [1/2]

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

inline

Definition at line 124 of file mceliece.h.

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

◆ operator!=() [2/2]

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

inlineinherited

Definition at line 57 of file mceliece.h.

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

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

default

◆ operator==() [1/2]

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

Definition at line 262 of file mceliece_key.cpp.

   {
   if(*static_cast<const McEliece_PublicKey*>(this) != *static_cast<const McEliece_PublicKey*>(&other))
      {
      return false;
      }
   if(m_g != other.m_g)
      {
      return false;
      }
 
   if( m_sqrtmod != other.m_sqrtmod)
      {
      return false;
      }
   if( m_Linv != other.m_Linv)
      {
      return false;
      }
   if( m_coeffs != other.m_coeffs)
      {
      return false;
      }
 
   if(m_codimension != other.m_codimension || m_dimension != other.m_dimension)
      {
      return false;
      }
 
   return true;
   }

◆ operator==() [2/2]

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

inherited

Definition at line 300 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 Botan::McEliece_PublicKey::m_code_length, Botan::McEliece_PublicKey::m_public_matrix, and Botan::McEliece_PublicKey::m_t.

◆ pkcs8_algorithm_identifier()

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

inlinevirtualinherited

Returns: PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Reimplemented in Botan::GOST_3410_PrivateKey, Botan::XMSS_WOTS_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.

Definition at line 212 of file pk_keys.h.

213 { return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

Referenced by Botan::Private_Key::private_key_info().

◆ private_key_bits()

secure_vector< uint8_t > Botan::McEliece_PrivateKey::private_key_bits ( ) const

overridevirtual

Returns: BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 126 of file mceliece_key.cpp.

   {
   DER_Encoder enc;
   enc.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)
      .encode(m_g[0].encode(), ASN1_Type::OctetString); // g as octet string
   enc.start_sequence();
   for(size_t i = 0; i < m_sqrtmod.size(); i++)
      {
      enc.encode(m_sqrtmod[i].encode(), ASN1_Type::OctetString);
      }
   enc.end_cons();
   secure_vector<uint8_t> enc_support;
 
   for(uint16_t Linv : m_Linv)
      {
      enc_support.push_back(get_byte<0>(Linv));
      enc_support.push_back(get_byte<1>(Linv));
      }
   enc.encode(enc_support, ASN1_Type::OctetString);
   secure_vector<uint8_t> enc_H;
   for(uint32_t coef : m_coeffs)
      {
      enc_H.push_back(get_byte<0>(coef));
      enc_H.push_back(get_byte<1>(coef));
      enc_H.push_back(get_byte<2>(coef));
      enc_H.push_back(get_byte<3>(coef));
      }
   enc.encode(enc_H, ASN1_Type::OctetString);
   enc.end_cons();
   return enc.get_contents();
   }

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

◆ private_key_info()

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

inherited

Returns: PKCS #8 private key encoding for this key object

Definition at line 61 of file pk_keys.cpp.

   {
   const size_t PKCS8_VERSION = 0;
 
   return DER_Encoder()
         .start_sequence()
            .encode(PKCS8_VERSION)
            .encode(pkcs8_algorithm_identifier())
            .encode(private_key_bits(), ASN1_Type::OctetString)
         .end_cons()
      .get_contents();
   }

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::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(), and Botan::PKCS8::PEM_encode().

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

   {
   return std::make_unique<McEliece_PublicKey>(
      get_public_matrix(), get_t(), get_code_length());
   }

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

◆ public_key_bits()

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

overridevirtualinherited

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 86 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(), Botan::McEliece_PublicKey::get_code_length(), Botan::McEliece_PublicKey::get_t(), Botan::McEliece_PublicKey::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

inherited

Definition at line 64 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 Botan::McEliece_PublicKey::get_message_word_bit_length(), and Botan::RandomNumberGenerator::randomize().

Referenced by check_key().

◆ stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const

inlinevirtualinherited

Reimplemented in Botan::XMSS_PrivateKey.

Definition at line 188 of file pk_keys.h.

188{ return false; }

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

Member Data Documentation

◆ m_code_length

size_t Botan::McEliece_PublicKey::m_code_length

protectedinherited

Definition at line 69 of file mceliece.h.

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

◆ m_public_matrix

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

protectedinherited

Definition at line 67 of file mceliece.h.

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

◆ m_t

size_t Botan::McEliece_PublicKey::m_t

protectedinherited

Definition at line 68 of file mceliece.h.

Referenced by Botan::McEliece_PublicKey::estimated_strength(), Botan::McEliece_PublicKey::get_message_word_bit_length(), McEliece_PrivateKey(), Botan::McEliece_PublicKey::McEliece_PublicKey(), and Botan::McEliece_PublicKey::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 Attributes

Detailed Description

Constructor & Destructor Documentation

◆ McEliece_PrivateKey() [1/5]

◆ McEliece_PrivateKey() [2/5]

◆ McEliece_PrivateKey() [3/5]

◆ ~McEliece_PrivateKey()

◆ McEliece_PrivateKey() [4/5]

◆ McEliece_PrivateKey() [5/5]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_decryption_op()

◆ create_encryption_op()

◆ create_kem_decryption_op()

◆ create_kem_encryption_op()

◆ create_key_agreement_op()

◆ create_signature_op()

◆ create_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_private()

◆ fingerprint_public()

◆ get_code_length()

◆ get_codimension()

◆ get_dimension()

◆ get_goppa_polyn()

◆ get_H_coeffs()

◆ get_Linv()

◆ get_message_word_bit_length()

◆ get_oid()

◆ get_public_matrix()

◆ get_sqrtmod()

◆ get_t()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ pkcs8_algorithm_identifier()

◆ private_key_bits()

◆ private_key_info()

◆ public_key()

◆ public_key_bits()

◆ random_plaintext_element()

◆ stateful_operation()

◆ subject_public_key()

Member Data Documentation

◆ m_code_length

◆ m_public_matrix

◆ m_t