Botan::Classic_McEliece_Parameter_Set Class Reference

#include <cmce_parameter_set.h>

Public Types
enum class	Code {   ClassicMcEliece_348864 , ClassicMcEliece_348864f , ClassicMcEliece_460896 , ClassicMcEliece_460896f ,   ClassicMcEliece_6688128 , ClassicMcEliece_6688128f , ClassicMcEliece_6688128pc , ClassicMcEliece_6688128pcf ,   ClassicMcEliece_6960119 , ClassicMcEliece_6960119f , ClassicMcEliece_6960119pc , ClassicMcEliece_6960119pcf ,   ClassicMcEliece_8192128 , ClassicMcEliece_8192128f , ClassicMcEliece_8192128pc , ClassicMcEliece_8192128pcf }

Public Member Functions
	Classic_McEliece_Parameter_Set (Code code)
Code	code () const
	Get the code for a given parameter set.
bool	operator== (const Classic_McEliece_Parameter_Set &other) const
std::string	to_string () const
	Get the parameter set name for a given parameter set.

Static Public Member Functions
static Classic_McEliece_Parameter_Set	from_oid (const OID &oid)
	Get the parameter set for a given OID.
static Classic_McEliece_Parameter_Set	from_string (std::string_view param_name)
	Get the parameter set for a given parameter set name.

Detailed Description

All Classic McEliece parameter sets defined in the NIST Round 4 submission and the Classic McEliece ISO Draft.

Instances are defined in the following format: mceliece{n}{t}{[pc]}{[f]}

Instance with 'pc' use plaintext confirmation as defined in the ISO Draft. Instance with 'f' use matrix reduction with the semi-systematic form.

Definition at line 26 of file cmce_parameter_set.h.

Member Enumeration Documentation

Code

enum class Botan::Classic_McEliece_Parameter_Set::Code

strong

Enumerator
ClassicMcEliece_348864
ClassicMcEliece_348864f
ClassicMcEliece_460896
ClassicMcEliece_460896f
ClassicMcEliece_6688128
ClassicMcEliece_6688128f
ClassicMcEliece_6688128pc
ClassicMcEliece_6688128pcf
ClassicMcEliece_6960119
ClassicMcEliece_6960119f
ClassicMcEliece_6960119pc
ClassicMcEliece_6960119pcf
ClassicMcEliece_8192128
ClassicMcEliece_8192128f
ClassicMcEliece_8192128pc
ClassicMcEliece_8192128pcf

Definition at line 28 of file cmce_parameter_set.h.

                      {
         ClassicMcEliece_348864,   // NIST
         ClassicMcEliece_348864f,  // NIST
 
         ClassicMcEliece_460896,   // NIST
         ClassicMcEliece_460896f,  // NIST
 
         ClassicMcEliece_6688128,     // ISO + NIST
         ClassicMcEliece_6688128f,    // ISO + NIST
         ClassicMcEliece_6688128pc,   // ISO
         ClassicMcEliece_6688128pcf,  // ISO
 
         ClassicMcEliece_6960119,     // ISO + NIST
         ClassicMcEliece_6960119f,    // ISO + NIST
         ClassicMcEliece_6960119pc,   // ISO
         ClassicMcEliece_6960119pcf,  // ISO
 
         ClassicMcEliece_8192128,     // ISO + NIST
         ClassicMcEliece_8192128f,    // ISO + NIST
         ClassicMcEliece_8192128pc,   // ISO
         ClassicMcEliece_8192128pcf,  // ISO
      };

Constructor & Destructor Documentation

Classic_McEliece_Parameter_Set()

Botan::Classic_McEliece_Parameter_Set::Classic_McEliece_Parameter_Set ( Code code )

inline

Definition at line 53 of file cmce_parameter_set.h.

: m_code(code) {}

Referenced by from_string().

Member Function Documentation

code()

Code Botan::Classic_McEliece_Parameter_Set::code ( ) const

inline

Get the code for a given parameter set.

Definition at line 73 of file cmce_parameter_set.h.

{ return m_code; }

Referenced by Botan::Classic_McEliece_Parameters::create(), Botan::Classic_McEliece_Parameters::estimated_strength(), and from_string().

from_oid()

Classic_McEliece_Parameter_Set Botan::Classic_McEliece_Parameter_Set::from_oid ( const OID & oid )

static

Get the parameter set for a given OID.

Definition at line 110 of file cmce_parameter_set.cpp.

                                                                                      {
   return from_string(oid.to_formatted_string());
}

References from_string(), and Botan::OID::to_formatted_string().

Referenced by Botan::Classic_McEliece_Parameters::create().

from_string()

Classic_McEliece_Parameter_Set Botan::Classic_McEliece_Parameter_Set::from_string ( std::string_view param_name )

static

Get the parameter set for a given parameter set name.

Definition at line 16 of file cmce_parameter_set.cpp.

                                                                                            {
   Code code = [&] {
      if(nm == "ClassicMcEliece_348864" || nm == "348864") {
         return ClassicMcEliece_348864;
      }
      if(nm == "ClassicMcEliece_348864f" || nm == "348864f") {
         return ClassicMcEliece_348864f;
      }
      if(nm == "ClassicMcEliece_460896" || nm == "460896") {
         return ClassicMcEliece_460896;
      }
      if(nm == "ClassicMcEliece_460896f" || nm == "460896f") {
         return ClassicMcEliece_460896f;
      }
      if(nm == "ClassicMcEliece_6688128" || nm == "6688128") {
         return ClassicMcEliece_6688128;
      }
      if(nm == "ClassicMcEliece_6688128f" || nm == "6688128f") {
         return ClassicMcEliece_6688128f;
      }
      if(nm == "ClassicMcEliece_6688128pc" || nm == "6688128pc") {
         return ClassicMcEliece_6688128pc;
      }
      if(nm == "ClassicMcEliece_6688128pcf" || nm == "6688128pcf") {
         return ClassicMcEliece_6688128pcf;
      }
      if(nm == "ClassicMcEliece_6960119" || nm == "6960119") {
         return ClassicMcEliece_6960119;
      }
      if(nm == "ClassicMcEliece_6960119f" || nm == "6960119f") {
         return ClassicMcEliece_6960119f;
      }
      if(nm == "ClassicMcEliece_6960119pc" || nm == "6960119pc") {
         return ClassicMcEliece_6960119pc;
      }
      if(nm == "ClassicMcEliece_6960119pcf" || nm == "6960119pcf") {
         return ClassicMcEliece_6960119pcf;
      }
      if(nm == "ClassicMcEliece_8192128" || nm == "8192128") {
         return ClassicMcEliece_8192128;
      }
      if(nm == "ClassicMcEliece_8192128f" || nm == "8192128f") {
         return ClassicMcEliece_8192128f;
      }
      if(nm == "ClassicMcEliece_8192128pc" || nm == "8192128pc") {
         return ClassicMcEliece_8192128pc;
      }
      if(nm == "ClassicMcEliece_8192128pcf" || nm == "8192128pcf") {
         return ClassicMcEliece_8192128pcf;
      }
 
      throw Invalid_Argument(fmt("Cannot convert '{}' to ClassicMcEliece parameter set", nm));
   }();
   return Classic_McEliece_Parameter_Set(code);
}

References Classic_McEliece_Parameter_Set(), ClassicMcEliece_348864, ClassicMcEliece_348864f, ClassicMcEliece_460896, ClassicMcEliece_460896f, ClassicMcEliece_6688128, ClassicMcEliece_6688128f, ClassicMcEliece_6688128pc, ClassicMcEliece_6688128pcf, ClassicMcEliece_6960119, ClassicMcEliece_6960119f, ClassicMcEliece_6960119pc, ClassicMcEliece_6960119pcf, ClassicMcEliece_8192128, ClassicMcEliece_8192128f, ClassicMcEliece_8192128pc, ClassicMcEliece_8192128pcf, code(), and Botan::fmt().

Referenced by botan_privkey_load_classic_mceliece(), botan_pubkey_load_classic_mceliece(), Botan::Classic_McEliece_Parameters::create(), Botan::create_private_key(), and from_oid().

operator==()

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

inline

Definition at line 75 of file cmce_parameter_set.h.

{ return m_code == other.m_code; }

to_string()

std::string Botan::Classic_McEliece_Parameter_Set::to_string

(

)

const

Get the parameter set name for a given parameter set.

Definition at line 72 of file cmce_parameter_set.cpp.

                                                          {
   switch(m_code) {
      case ClassicMcEliece_348864:
         return "ClassicMcEliece_348864";
      case ClassicMcEliece_348864f:
         return "ClassicMcEliece_348864f";
      case ClassicMcEliece_460896:
         return "ClassicMcEliece_460896";
      case ClassicMcEliece_460896f:
         return "ClassicMcEliece_460896f";
      case ClassicMcEliece_6688128:
         return "ClassicMcEliece_6688128";
      case ClassicMcEliece_6688128f:
         return "ClassicMcEliece_6688128f";
      case ClassicMcEliece_6688128pc:
         return "ClassicMcEliece_6688128pc";
      case ClassicMcEliece_6688128pcf:
         return "ClassicMcEliece_6688128pcf";
      case ClassicMcEliece_6960119:
         return "ClassicMcEliece_6960119";
      case ClassicMcEliece_6960119f:
         return "ClassicMcEliece_6960119f";
      case ClassicMcEliece_6960119pc:
         return "ClassicMcEliece_6960119pc";
      case ClassicMcEliece_6960119pcf:
         return "ClassicMcEliece_6960119pcf";
      case ClassicMcEliece_8192128:
         return "ClassicMcEliece_8192128";
      case ClassicMcEliece_8192128f:
         return "ClassicMcEliece_8192128f";
      case ClassicMcEliece_8192128pc:
         return "ClassicMcEliece_8192128pc";
      case ClassicMcEliece_8192128pcf:
         return "ClassicMcEliece_8192128pcf";
   }
   BOTAN_ASSERT_UNREACHABLE();
}

References BOTAN_ASSERT_UNREACHABLE, ClassicMcEliece_348864, ClassicMcEliece_348864f, ClassicMcEliece_460896, ClassicMcEliece_460896f, ClassicMcEliece_6688128, ClassicMcEliece_6688128f, ClassicMcEliece_6688128pc, ClassicMcEliece_6688128pcf, ClassicMcEliece_6960119, ClassicMcEliece_6960119f, ClassicMcEliece_6960119pc, ClassicMcEliece_6960119pcf, ClassicMcEliece_8192128, ClassicMcEliece_8192128f, ClassicMcEliece_8192128pc, and ClassicMcEliece_8192128pcf.

Referenced by Botan::Classic_McEliece_Parameters::object_identifier().

---

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

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