Botan::Classic_McEliece_PublicKeyInternal Class Reference

Representation of a Classic McEliece public key. More...

#include <cmce_keys_internal.h>

Public Member Functions
constexpr void	_const_time_unpoison () const
	Classic_McEliece_PublicKeyInternal (const Classic_McEliece_Parameters &params, Classic_McEliece_Matrix matrix)
	Construct a Classic McEliece public key.
const Classic_McEliece_Matrix &	matrix () const
	The Classic McEliece matrix.
const Classic_McEliece_Parameters &	params () const
	The Classic McEliece parameters.
std::vector< uint8_t >	serialize () const
	Serializes the Classic McEliece public key as defined in Classic McEliece ISO Section 9.2.7.

Static Public Member Functions
static std::shared_ptr< Classic_McEliece_PublicKeyInternal >	create_from_private_key (const Classic_McEliece_PrivateKeyInternal &sk)
	Create a Classic McEliece public key from a private key.

Detailed Description

Representation of a Classic McEliece public key.

This class represents a Classic McEliece public key. It is used internally by the Classic McEliece public key class and contains the following data:

• The Classic McEliece parameters
• The public key matrix

Definition at line 30 of file cmce_keys_internal.h.

Constructor & Destructor Documentation

Classic_McEliece_PublicKeyInternal()

Botan::Classic_McEliece_PublicKeyInternal::Classic_McEliece_PublicKeyInternal ( const Classic_McEliece_Parameters & params, Classic_McEliece_Matrix matrix )

inline

Construct a Classic McEliece public key.

Parameters

params	The Classic McEliece parameters
matrix	The public key matrix

Definition at line 38 of file cmce_keys_internal.h.

                                                                                                                    :
            m_params(params), m_matrix(std::move(matrix)) {
         BOTAN_ASSERT_NOMSG(m_matrix.bytes().size() == m_params.pk_size_bytes());
      }

References BOTAN_ASSERT_NOMSG.

Member Function Documentation

_const_time_unpoison()

void Botan::Classic_McEliece_PublicKeyInternal::_const_time_unpoison ( ) const

inlineconstexpr

Definition at line 70 of file cmce_keys_internal.h.

{ CT::unpoison(m_matrix); }

create_from_private_key()

std::shared_ptr< Classic_McEliece_PublicKeyInternal > Botan::Classic_McEliece_PublicKeyInternal::create_from_private_key ( const Classic_McEliece_PrivateKeyInternal & sk )

static

Create a Classic McEliece public key from a private key.

Create the matrix from the private key values. Expects that the private key is valid, i.e. the matrix creation works.

Parameters

sk	The private key

Returns

The public key as a shared pointer

Definition at line 132 of file cmce_keys_internal.cpp.

                                                  {
   auto pk_matrix_and_pivot = Classic_McEliece_Matrix::create_matrix(sk.params(), sk.field_ordering(), sk.g());
   if(!pk_matrix_and_pivot.has_value()) {
      throw Decoding_Error("Cannot create public key from private key. Private key is invalid.");
   }
   auto& [pk_matrix, pivot] = pk_matrix_and_pivot.value();
 
   // There should not be a pivot of any other form. Otherwise the gauss
   // algorithm failed effectively.
   if(!CT::driveby_unpoison(pivot.equals(bitvector{0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00}))) {
      throw Decoding_Error("Cannot create public key from private key. Private key is invalid.");
   }
 
   return std::make_shared<Classic_McEliece_PublicKeyInternal>(sk.params(), std::move(pk_matrix));
}

References Botan::Classic_McEliece_Matrix::create_matrix(), Botan::CT::driveby_unpoison(), Botan::Classic_McEliece_PrivateKeyInternal::field_ordering(), Botan::Classic_McEliece_PrivateKeyInternal::g(), and Botan::Classic_McEliece_PrivateKeyInternal::params().

Referenced by Botan::Classic_McEliece_PrivateKey::Classic_McEliece_PrivateKey().

matrix()

const Classic_McEliece_Matrix & Botan::Classic_McEliece_PublicKeyInternal::matrix ( ) const

inline

The Classic McEliece matrix.

Definition at line 63 of file cmce_keys_internal.h.

{ return m_matrix; }

params()

const Classic_McEliece_Parameters & Botan::Classic_McEliece_PublicKeyInternal::params ( ) const

inline

The Classic McEliece parameters.

Definition at line 68 of file cmce_keys_internal.h.

{ return m_params; }

serialize()

std::vector< uint8_t > Botan::Classic_McEliece_PublicKeyInternal::serialize ( ) const

inline

Serializes the Classic McEliece public key as defined in Classic McEliece ISO Section 9.2.7.

Definition at line 58 of file cmce_keys_internal.h.

{ return m_matrix.bytes(); }

---

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

• src/lib/pubkey/classic_mceliece/cmce_keys_internal.h
• src/lib/pubkey/classic_mceliece/cmce_keys_internal.cpp