Botan::XMSS_Parameters Class Reference

#include <xmss_parameters.h>

Public Types
enum	xmss_algorithm_t {   XMSS_SHA2_256_W16_H10 = 0x01000001, XMSS_SHA2_256_W16_H16 = 0x02000002, XMSS_SHA2_256_W16_H20 = 0x03000003, XMSS_SHA2_512_W16_H10 = 0x04000004,   XMSS_SHA2_512_W16_H16 = 0x05000005, XMSS_SHA2_512_W16_H20 = 0x06000006, XMSS_SHAKE128_W16_H10 = 0x07000007, XMSS_SHAKE128_W16_H16 = 0x08000008,   XMSS_SHAKE128_W16_H20 = 0x09000009, XMSS_SHAKE256_W16_H10 = 0x0a00000a, XMSS_SHAKE256_W16_H16 = 0x0b00000b, XMSS_SHAKE256_W16_H20 = 0x0c00000c }

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, draft-itrf-cfrg-xmss-hash-based-signatures-06 Release: July 2016. https://datatracker.ietf.org/doc/ draft-irtf-cfrg-xmss-hash-based-signatures/?include_text=1

Definition at line 24 of file xmss_parameters.h.

Member Enumeration Documentation

xmss_algorithm_t

enum Botan::XMSS_Parameters::xmss_algorithm_t

Enumerator
XMSS_SHA2_256_W16_H10
XMSS_SHA2_256_W16_H16
XMSS_SHA2_256_W16_H20
XMSS_SHA2_512_W16_H10
XMSS_SHA2_512_W16_H16
XMSS_SHA2_512_W16_H20
XMSS_SHAKE128_W16_H10
XMSS_SHAKE128_W16_H16
XMSS_SHAKE128_W16_H20
XMSS_SHAKE256_W16_H10
XMSS_SHAKE256_W16_H16
XMSS_SHAKE256_W16_H20

Definition at line 27 of file xmss_parameters.h.

         {
         XMSS_SHA2_256_W16_H10 = 0x01000001,
         XMSS_SHA2_256_W16_H16 = 0x02000002,
         XMSS_SHA2_256_W16_H20 = 0x03000003,
         XMSS_SHA2_512_W16_H10 = 0x04000004,
         XMSS_SHA2_512_W16_H16 = 0x05000005,
         XMSS_SHA2_512_W16_H20 = 0x06000006,
         XMSS_SHAKE128_W16_H10 = 0x07000007,
         XMSS_SHAKE128_W16_H16 = 0x08000008,
         XMSS_SHAKE128_W16_H20 = 0x09000009,
         XMSS_SHAKE256_W16_H10 = 0x0a00000a,
         XMSS_SHAKE256_W16_H16 = 0x0b00000b,
         XMSS_SHAKE256_W16_H20 = 0x0c00000c
         };

Constructor & Destructor Documentation

XMSS_Parameters() [1/2]

Botan::XMSS_Parameters::XMSS_Parameters

(

const std::string &

algo_name

)

Definition at line 49 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 54 of file xmss_parameters.cpp.

   : m_oid(oid)
   {
   switch(oid)
      {
      case XMSS_SHA2_256_W16_H10:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 10;
         m_name = "XMSS_SHA2-256_W16_H10";
         m_hash_name = "SHA-256";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_256_W16;
         break;
      case XMSS_SHA2_256_W16_H16:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 16;
         m_name = "XMSS_SHA2-256_W16_H16";
         m_hash_name = "SHA-256";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_256_W16;
         break;
      case XMSS_SHA2_256_W16_H20:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 20;
         m_name = "XMSS_SHA2-256_W16_H20";
         m_hash_name = "SHA-256";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_256_W16;
         break;
      case XMSS_SHA2_512_W16_H10:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 10;
         m_name = "XMSS_SHA2-512_W16_H10";
         m_hash_name = "SHA-512";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_512_W16;
         break;
      case XMSS_SHA2_512_W16_H16:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 16;
         m_name = "XMSS_SHA2-512_W16_H16";
         m_hash_name = "SHA-512";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_512_W16;
         break;
      case XMSS_SHA2_512_W16_H20:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 20;
         m_name = "XMSS_SHA2-512_W16_H20";
         m_hash_name = "SHA-512";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHA2_512_W16;
         break;
      case XMSS_SHAKE128_W16_H10:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 10;
         m_name = "XMSS_SHAKE128_W16_H10";
         m_hash_name = "SHAKE-128(256)";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE128_W16;
         break;
      case XMSS_SHAKE128_W16_H16:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 16;
         m_name = "XMSS_SHAKE128_W16_H16";
         m_hash_name = "SHAKE-128(256)";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE128_W16;
         break;
      case XMSS_SHAKE128_W16_H20:
         m_element_size = 32;
         m_w = 16;
         m_len = 67;
         m_tree_height = 20;
         m_name = "XMSS_SHAKE128_W16_H20";
         m_hash_name = "SHAKE-128(256)";
         m_strength = 256;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE128_W16;
         break;
      case XMSS_SHAKE256_W16_H10:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 10;
         m_name = "XMSS_SHAKE256_W16_H10";
         m_hash_name = "SHAKE-256(512)";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE256_W16;
         break;
      case XMSS_SHAKE256_W16_H16:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 16;
         m_name = "XMSS_SHAKE256_W16_H16";
         m_hash_name = "SHAKE-256(512)";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE256_W16;
         break;
      case XMSS_SHAKE256_W16_H20:
         m_element_size = 64;
         m_w = 16;
         m_len = 131;
         m_tree_height = 20;
         m_name = "XMSS_SHAKE256_W16_H20";
         m_hash_name = "SHAKE-256(512)";
         m_strength = 512;
         m_wots_oid = XMSS_WOTS_Parameters::ots_algorithm_t::WOTSP_SHAKE256_W16;
         break;
      default:
         throw Unsupported_Argument(
            "Algorithm id does not match any XMSS algorithm id.");
         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 68 of file xmss_parameters.h.

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

{ return m_element_size; }

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 96 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 56 of file xmss_parameters.h.

         {
         return m_hash_name;
         }

len()

size_t Botan::XMSS_Parameters::len ( ) const

inline

Definition at line 83 of file xmss_parameters.h.

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

{ return m_len; }

name()

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

inline

Returns

XMSS registry name for the chosen parameter set.

Definition at line 51 of file xmss_parameters.h.

         {
         return m_name;
         }

oid()

xmss_algorithm_t Botan::XMSS_Parameters::oid ( ) const

inline

Definition at line 85 of file xmss_parameters.h.

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

{ return m_oid; }

operator==()

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

inline

Definition at line 101 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 87 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 73 of file xmss_parameters.h.

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

{ return m_tree_height; }

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 81 of file xmss_parameters.h.

{ 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 20 of file xmss_parameters.cpp.

References XMSS_SHA2_256_W16_H10, XMSS_SHA2_256_W16_H16, XMSS_SHA2_256_W16_H20, XMSS_SHA2_512_W16_H10, XMSS_SHA2_512_W16_H16, XMSS_SHA2_512_W16_H20, XMSS_SHAKE128_W16_H10, XMSS_SHAKE128_W16_H16, XMSS_SHAKE128_W16_H20, XMSS_SHAKE256_W16_H10, XMSS_SHAKE256_W16_H16, and XMSS_SHAKE256_W16_H20.

   {
   if(param_set == "XMSS_SHA2-256_W16_H10")
      { return XMSS_SHA2_256_W16_H10; }
   if(param_set == "XMSS_SHA2-256_W16_H16")
      { return XMSS_SHA2_256_W16_H16; }
   if(param_set == "XMSS_SHA2-256_W16_H20")
      { return XMSS_SHA2_256_W16_H20; }
   if(param_set == "XMSS_SHA2-512_W16_H10")
      { return XMSS_SHA2_512_W16_H10; }
   if(param_set == "XMSS_SHA2-512_W16_H16")
      { return XMSS_SHA2_512_W16_H16; }
   if(param_set == "XMSS_SHA2-512_W16_H20")
      { return XMSS_SHA2_512_W16_H20; }
   if(param_set == "XMSS_SHAKE128_W16_H10")
      { return XMSS_SHAKE128_W16_H10; }
   if(param_set == "XMSS_SHAKE128_W16_H16")
      { return XMSS_SHAKE128_W16_H16; }
   if(param_set == "XMSS_SHAKE128_W16_H20")
      { return XMSS_SHAKE128_W16_H20; }
   if(param_set == "XMSS_SHAKE256_W16_H10")
      { return XMSS_SHAKE256_W16_H10; }
   if(param_set == "XMSS_SHAKE256_W16_H16")
      { return XMSS_SHAKE256_W16_H16; }
   if(param_set == "XMSS_SHAKE256_W16_H20")
      { return XMSS_SHAKE256_W16_H20; }
   throw Lookup_Error("Unknown XMSS algorithm param '" + param_set + "'");
   }

---

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