#include <xmss_parameters.h>

Public Types
enum	xmss_algorithm_t { XMSS_SHA2_10_256 = 0x00000001 , XMSS_SHA2_16_256 = 0x00000002 , XMSS_SHA2_20_256 = 0x00000003 , XMSS_SHA2_10_512 = 0x00000004 , XMSS_SHA2_16_512 = 0x00000005 , XMSS_SHA2_20_512 = 0x00000006 , XMSS_SHAKE_10_256 = 0x00000007 , XMSS_SHAKE_16_256 = 0x00000008 , XMSS_SHAKE_20_256 = 0x00000009 , XMSS_SHAKE_10_512 = 0x0000000a , XMSS_SHAKE_16_512 = 0x0000000b , XMSS_SHAKE_20_512 = 0x0000000c }

Public Member Functions
size_t	element_size () const

size_t	estimated_strength () const

const std::string &	hash_function_name () const

size_t	len () const

const std::string &	name () const

xmss_algorithm_t	oid () const

bool	operator== (const XMSS_Parameters &p) const

XMSS_WOTS_Parameters::ots_algorithm_t	ots_oid () const

size_t	tree_height () const

size_t	wots_parameter () const

	XMSS_Parameters (const std::string &algo_name)

	XMSS_Parameters (xmss_algorithm_t oid)

Static Public Member Functions
static xmss_algorithm_t	xmss_id_from_string (const std::string &algo_name)

Detailed Description

Descibes a signature method for XMSS, as defined in: [1] XMSS: Extended Hash-Based Signatures, Request for Comments: 8391 Release: May 2018. https://datatracker.ietf.org/doc/rfc8391/

Definition at line 23 of file xmss_parameters.h.

Member Enumeration Documentation

◆ xmss_algorithm_t

enum Botan::XMSS_Parameters::xmss_algorithm_t

Enumerator
XMSS_SHA2_10_256
XMSS_SHA2_16_256
XMSS_SHA2_20_256
XMSS_SHA2_10_512
XMSS_SHA2_16_512
XMSS_SHA2_20_512
XMSS_SHAKE_10_256
XMSS_SHAKE_16_256
XMSS_SHAKE_20_256
XMSS_SHAKE_10_512
XMSS_SHAKE_16_512
XMSS_SHAKE_20_512

Definition at line 26 of file xmss_parameters.h.

         {
         XMSS_SHA2_10_256 = 0x00000001,
         XMSS_SHA2_16_256 = 0x00000002,
         XMSS_SHA2_20_256 = 0x00000003,
         XMSS_SHA2_10_512 = 0x00000004,
         XMSS_SHA2_16_512 = 0x00000005,
         XMSS_SHA2_20_512 = 0x00000006,
         XMSS_SHAKE_10_256 = 0x00000007,
         XMSS_SHAKE_16_256 = 0x00000008,
         XMSS_SHAKE_20_256 = 0x00000009,
         XMSS_SHAKE_10_512 = 0x0000000a,
         XMSS_SHAKE_16_512 = 0x0000000b,
         XMSS_SHAKE_20_512 = 0x0000000c
         };

Constructor & Destructor Documentation

◆ XMSS_Parameters() [1/2]

Botan::XMSS_Parameters::XMSS_Parameters ( const std::string & algo_name )

Definition at line 48 of file xmss_parameters.cpp.

   : XMSS_Parameters(XMSS_Parameters::xmss_id_from_string(param_set))
   {
   }

◆ XMSS_Parameters() [2/2]

Botan::XMSS_Parameters::XMSS_Parameters ( xmss_algorithm_t oid )

Definition at line 53 of file xmss_parameters.cpp.

   : m_oid(oid)
   {
   switch(oid)
      {
      case XMSS_SHA2_10_256:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 10;
         m_name = "XMSS-SHA2_10_256";
         m_hash_name = "SHA-256";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_256;
         break;
      case XMSS_SHA2_16_256:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 16;
         m_name = "XMSS-SHA2_16_256";
         m_hash_name = "SHA-256";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_256;
         break;
      case XMSS_SHA2_20_256:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 20;
         m_name = "XMSS-SHA2_20_256";
         m_hash_name = "SHA-256";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_256;
         break;
      case XMSS_SHA2_10_512:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 10;
         m_name = "XMSS-SHA2_10_512";
         m_hash_name = "SHA-512";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_512;
         break;
      case XMSS_SHA2_16_512:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 16;
         m_name = "XMSS-SHA2_16_512";
         m_hash_name = "SHA-512";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_512;
         break;
      case XMSS_SHA2_20_512:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 20;
         m_name = "XMSS-SHA2_20_512";
         m_hash_name = "SHA-512";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_512;
         break;
      case XMSS_SHAKE_10_256:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 10;
         m_name = "XMSS-SHAKE_10_256";
         m_hash_name = "SHAKE-128(256)";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE_256;
         break;
      case XMSS_SHAKE_16_256:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 16;
         m_name = "XMSS-SHAKE_16_256";
         m_hash_name = "SHAKE-128(256)";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE_256;
         break;
      case XMSS_SHAKE_20_256:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 20;
         m_name = "XMSS-SHAKE_20_256";
         m_hash_name = "SHAKE-128(256)";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE_256;
         break;
      case XMSS_SHAKE_10_512:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 10;
         m_name = "XMSS-SHAKE_10_512";
         m_hash_name = "SHAKE-256(512)";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE_512;
         break;
      case XMSS_SHAKE_16_512:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 16;
         m_name = "XMSS-SHAKE_16_512";
         m_hash_name = "SHAKE-256(512)";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE_512;
         break;
      case XMSS_SHAKE_20_512:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 20;
         m_name = "XMSS-SHAKE_20_512";
         m_hash_name = "SHAKE-256(512)";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE_512;
         break;
      default:
         throw Not_Implemented("Algorithm id does not match any known XMSS algorithm id:" + std::to_string(oid));
         break;
      }
   }

Member Function Documentation

◆ element_size()

size_t Botan::XMSS_Parameters::element_size ( ) const

inline

Retrieves the uniform length of a message, and the size of each node. This correlates to XMSS parameter "n" defined in [1].

Returns: element length in bytes.

Definition at line 67 of file xmss_parameters.h.

67{ return m_element_size; }

Referenced by Botan::XMSS_Common_Ops::randomize_tree_hash(), Botan::XMSS_Signature_Operation::signature_length(), Botan::XMSS_PublicKey::XMSS_PublicKey(), and Botan::XMSS_Signature::XMSS_Signature().

◆ estimated_strength()

size_t Botan::XMSS_Parameters::estimated_strength ( ) const

inline

Returns the estimated pre-quantum security level of the chosen algorithm.

Definition at line 95 of file xmss_parameters.h.

         {
         return m_strength;
         }

◆ hash_function_name()

const std::string & Botan::XMSS_Parameters::hash_function_name ( ) const

inline

Definition at line 55 of file xmss_parameters.h.

         {
         return m_hash_name;
         }

◆ len()

size_t Botan::XMSS_Parameters::len ( ) const

inline

Definition at line 82 of file xmss_parameters.h.

82{ return m_len; }

Referenced by Botan::XMSS_Common_Ops::create_l_tree(), Botan::XMSS_Signature_Operation::signature_length(), and Botan::XMSS_Signature::XMSS_Signature().

◆ name()

const std::string & Botan::XMSS_Parameters::name ( ) const

inline

Returns: XMSS registry name for the chosen parameter set.

Definition at line 50 of file xmss_parameters.h.

         {
         return m_name;
         }

◆ oid()

xmss_algorithm_t Botan::XMSS_Parameters::oid ( ) const

inline

Definition at line 84 of file xmss_parameters.h.

84{ return m_oid; }

Referenced by Botan::create_private_key(), Botan::XMSS_Verification_Operation::is_valid_signature(), and Botan::XMSS_PublicKey::raw_public_key().

◆ operator==()

bool Botan::XMSS_Parameters::operator== ( const XMSS_Parameters & p ) const

inline

Definition at line 100 of file xmss_parameters.h.

         {
         return m_oid == p.m_oid;
         }

◆ ots_oid()

XMSS_WOTS_Parameters::ots_algorithm_t Botan::XMSS_Parameters::ots_oid ( ) const

inline

Definition at line 86 of file xmss_parameters.h.

         {
         return m_wots_oid;
         }

◆ tree_height()

size_t Botan::XMSS_Parameters::tree_height ( ) const

inline

Returns: The height (number of levels - 1) of the tree

Definition at line 72 of file xmss_parameters.h.

72{ return m_tree_height; }

Referenced by Botan::XMSS_Signature_Operation::signature_length(), and Botan::XMSS_Signature::XMSS_Signature().

◆ wots_parameter()

size_t Botan::XMSS_Parameters::wots_parameter ( ) const

inline

The Winternitz parameter.

Returns: numeric base used for internal representation of data.

Definition at line 80 of file xmss_parameters.h.

80{ return m_w; }

◆ xmss_id_from_string()

XMSS_Parameters::xmss_algorithm_t Botan::XMSS_Parameters::xmss_id_from_string ( const std::string & algo_name )

static

Definition at line 19 of file xmss_parameters.cpp.

   {
   if(param_set == "XMSS-SHA2_10_256")
      { return XMSS_SHA2_10_256; }
   if(param_set == "XMSS-SHA2_16_256")
      { return XMSS_SHA2_16_256; }
   if(param_set == "XMSS-SHA2_20_256")
      { return XMSS_SHA2_20_256; }
   if(param_set == "XMSS-SHA2_10_512")
      { return XMSS_SHA2_10_512; }
   if(param_set == "XMSS-SHA2_16_512")
      { return XMSS_SHA2_16_512; }
   if(param_set == "XMSS-SHA2_20_512")
      { return XMSS_SHA2_20_512; }
   if(param_set == "XMSS-SHAKE_10_256")
      { return XMSS_SHAKE_10_256; }
   if(param_set == "XMSS-SHAKE_16_256")
      { return XMSS_SHAKE_16_256; }
   if(param_set == "XMSS-SHAKE_20_256")
      { return XMSS_SHAKE_20_256; }
   if(param_set == "XMSS-SHAKE_10_512")
      { return XMSS_SHAKE_10_512; }
   if(param_set == "XMSS-SHAKE_16_512")
      { return XMSS_SHAKE_16_512; }
   if(param_set == "XMSS-SHAKE_20_512")
      { return XMSS_SHAKE_20_512; }
   throw Lookup_Error("Unknown XMSS algorithm param '" + param_set + "'");
   }

References XMSS_SHA2_10_256, XMSS_SHA2_10_512, XMSS_SHA2_16_256, XMSS_SHA2_16_512, XMSS_SHA2_20_256, XMSS_SHA2_20_512, XMSS_SHAKE_10_256, XMSS_SHAKE_10_512, XMSS_SHAKE_16_256, XMSS_SHAKE_16_512, XMSS_SHAKE_20_256, and XMSS_SHAKE_20_512.

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

src/lib/pubkey/xmss/xmss_parameters.h
src/lib/pubkey/xmss/xmss_parameters.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ xmss_algorithm_t

Constructor & Destructor Documentation

◆ XMSS_Parameters() [1/2]

◆ XMSS_Parameters() [2/2]

Member Function Documentation

◆ element_size()

◆ estimated_strength()

◆ hash_function_name()

◆ len()

◆ name()

◆ oid()

◆ operator==()

◆ ots_oid()

◆ tree_height()

◆ wots_parameter()

◆ xmss_id_from_string()