Botan 3.5.0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::LMS_Params Class Reference

The LMS parameters. More...

#include <lms.h>

Public Member Functions

LMS_Algorithm_Type algorithm_type () const
 Retuns the LMS algorithm type.
 
uint8_t h () const
 Returns the height of the LMS tree.
 
std::unique_ptr< HashFunction > hash () const
 Construct a new hash instance for the LMS instance.
 
const std::string & hash_name () const
 Returns the name of the hash function to use.
 
size_t m () const
 Returns the number of bytes associated with each node.
 

Static Public Member Functions

static LMS_Params create_or_throw (LMS_Algorithm_Type type)
 Create the LMS parameters from a known algorithm type.
 
static LMS_Params create_or_throw (std::string_view hash_name, uint8_t h)
 Create the LMS parameters from a hash function and tree height.
 

Detailed Description

The LMS parameters.

See RFC 8554 Section 5.1.

Definition at line 88 of file lms.h.

Member Function Documentation

◆ algorithm_type()

LMS_Algorithm_Type Botan::LMS_Params::algorithm_type ( ) const
inline

Retuns the LMS algorithm type.

Definition at line 108 of file lms.h.

108{ return m_algorithm_type; }

◆ create_or_throw() [1/2]

LMS_Params Botan::LMS_Params::create_or_throw ( LMS_Algorithm_Type type)
static

Create the LMS parameters from a known algorithm type.

Exceptions
Decoding_ErrorIf the algorithm type is unknown

Definition at line 112 of file lms.cpp.

112 {
113 auto [hash_name, height] = [](const LMS_Algorithm_Type& lms_type) -> std::pair<std::string_view, uint8_t> {
114 switch(lms_type) {
115 case LMS_Algorithm_Type::SHA256_M32_H5:
116 return {"SHA-256", 5};
117 case LMS_Algorithm_Type::SHA256_M32_H10:
118 return {"SHA-256", 10};
119 case LMS_Algorithm_Type::SHA256_M32_H15:
120 return {"SHA-256", 15};
121 case LMS_Algorithm_Type::SHA256_M32_H20:
122 return {"SHA-256", 20};
123 case LMS_Algorithm_Type::SHA256_M32_H25:
124 return {"SHA-256", 25};
125 case LMS_Algorithm_Type::SHA256_M24_H5:
126 return {"Truncated(SHA-256,192)", 5};
127 case LMS_Algorithm_Type::SHA256_M24_H10:
128 return {"Truncated(SHA-256,192)", 10};
129 case LMS_Algorithm_Type::SHA256_M24_H15:
130 return {"Truncated(SHA-256,192)", 15};
131 case LMS_Algorithm_Type::SHA256_M24_H20:
132 return {"Truncated(SHA-256,192)", 20};
133 case LMS_Algorithm_Type::SHA256_M24_H25:
134 return {"Truncated(SHA-256,192)", 25};
135 case LMS_Algorithm_Type::SHAKE_M32_H5:
136 return {"SHAKE-256(256)", 5};
137 case LMS_Algorithm_Type::SHAKE_M32_H10:
138 return {"SHAKE-256(256)", 10};
139 case LMS_Algorithm_Type::SHAKE_M32_H15:
140 return {"SHAKE-256(256)", 15};
141 case LMS_Algorithm_Type::SHAKE_M32_H20:
142 return {"SHAKE-256(256)", 20};
143 case LMS_Algorithm_Type::SHAKE_M32_H25:
144 return {"SHAKE-256(256)", 25};
145 case LMS_Algorithm_Type::SHAKE_M24_H5:
146 return {"SHAKE-256(192)", 5};
147 case LMS_Algorithm_Type::SHAKE_M24_H10:
148 return {"SHAKE-256(192)", 10};
149 case LMS_Algorithm_Type::SHAKE_M24_H15:
150 return {"SHAKE-256(192)", 15};
151 case LMS_Algorithm_Type::SHAKE_M24_H20:
152 return {"SHAKE-256(192)", 20};
153 case LMS_Algorithm_Type::SHAKE_M24_H25:
154 return {"SHAKE-256(192)", 25};
155 default:
156 throw Decoding_Error("Unsupported LMS algorithm type");
157 }
158 }(type);
159
160 return LMS_Params(type, hash_name, height);
161}
Botan::LMS_Params::hash_name
const std::string & hash_name() const
Returns the name of the hash function to use.
Definition lms.h:123
Botan::LMS_Algorithm_Type
LMS_Algorithm_Type
Enum of available LMS algorithm types.
Definition lms.h:29

References hash_name(), Botan::SHA256_M24_H10, Botan::SHA256_M24_H15, Botan::SHA256_M24_H20, Botan::SHA256_M24_H25, Botan::SHA256_M24_H5, Botan::SHA256_M32_H10, Botan::SHA256_M32_H15, Botan::SHA256_M32_H20, Botan::SHA256_M32_H25, Botan::SHA256_M32_H5, Botan::SHAKE_M24_H10, Botan::SHAKE_M24_H15, Botan::SHAKE_M24_H20, Botan::SHAKE_M24_H25, Botan::SHAKE_M24_H5, Botan::SHAKE_M32_H10, Botan::SHAKE_M32_H15, Botan::SHAKE_M32_H20, Botan::SHAKE_M32_H25, and Botan::SHAKE_M32_H5.

Referenced by Botan::HSS_LMS_PrivateKeyInternal::from_bytes_or_throw(), Botan::LMS_PublicKey::from_bytes_or_throw(), Botan::LMS_Signature::from_bytes_or_throw(), and Botan::HSS_LMS_Params::HSS_LMS_Params().

◆ create_or_throw() [2/2]

LMS_Params Botan::LMS_Params::create_or_throw ( std::string_view hash_name,
uint8_t h )
static

Create the LMS parameters from a hash function and tree height.

Parameters
hash_nameThe name of the hash function to use.
hThe height of the tree.
Exceptions
Decoding_ErrorIf the algorithm type is unknown

Definition at line 163 of file lms.cpp.

163 {
164 LMS_Algorithm_Type type = [](std::string_view hash, uint8_t h) -> LMS_Algorithm_Type {
165 if(hash == "SHA-256") {
166 switch(h) {
167 case 5:
168 return LMS_Algorithm_Type::SHA256_M32_H5;
169 case 10:
170 return LMS_Algorithm_Type::SHA256_M32_H10;
171 case 15:
172 return LMS_Algorithm_Type::SHA256_M32_H15;
173 case 20:
174 return LMS_Algorithm_Type::SHA256_M32_H20;
175 case 25:
176 return LMS_Algorithm_Type::SHA256_M32_H25;
177 default:
178 throw Decoding_Error("Unsupported height for hash function");
179 }
180 }
181 if(hash == "Truncated(SHA-256,192)") {
182 switch(h) {
183 case 5:
184 return LMS_Algorithm_Type::SHA256_M24_H5;
185 case 10:
186 return LMS_Algorithm_Type::SHA256_M24_H10;
187 case 15:
188 return LMS_Algorithm_Type::SHA256_M24_H15;
189 case 20:
190 return LMS_Algorithm_Type::SHA256_M24_H20;
191 case 25:
192 return LMS_Algorithm_Type::SHA256_M24_H25;
193 default:
194 throw Decoding_Error("Unsupported height for hash function");
195 }
196 }
197 if(hash == "SHAKE-256(256)") {
198 switch(h) {
199 case 5:
200 return LMS_Algorithm_Type::SHAKE_M32_H5;
201 case 10:
202 return LMS_Algorithm_Type::SHAKE_M32_H10;
203 case 15:
204 return LMS_Algorithm_Type::SHAKE_M32_H15;
205 case 20:
206 return LMS_Algorithm_Type::SHAKE_M32_H20;
207 case 25:
208 return LMS_Algorithm_Type::SHAKE_M32_H25;
209 default:
210 throw Decoding_Error("Unsupported height for hash function");
211 }
212 }
213 if(hash == "SHAKE-256(192)") {
214 switch(h) {
215 case 5:
216 return LMS_Algorithm_Type::SHAKE_M24_H5;
217 case 10:
218 return LMS_Algorithm_Type::SHAKE_M24_H10;
219 case 15:
220 return LMS_Algorithm_Type::SHAKE_M24_H15;
221 case 20:
222 return LMS_Algorithm_Type::SHAKE_M24_H20;
223 case 25:
224 return LMS_Algorithm_Type::SHAKE_M24_H25;
225 default:
226 throw Decoding_Error("Unsupported height for hash function");
227 }
228 }
229 throw Decoding_Error("Unsupported hash function");
230 }(hash_name, height);
231
232 return LMS_Params(type, hash_name, height);
233}
Botan::LMS_Params::hash
std::unique_ptr< HashFunction > hash() const
Construct a new hash instance for the LMS instance.
Definition lms.h:128
Botan::LMS_Params::h
uint8_t h() const
Returns the height of the LMS tree.
Definition lms.h:113

References h(), hash(), hash_name(), Botan::SHA256_M24_H10, Botan::SHA256_M24_H15, Botan::SHA256_M24_H20, Botan::SHA256_M24_H25, Botan::SHA256_M24_H5, Botan::SHA256_M32_H10, Botan::SHA256_M32_H15, Botan::SHA256_M32_H20, Botan::SHA256_M32_H25, Botan::SHA256_M32_H5, Botan::SHAKE_M24_H10, Botan::SHAKE_M24_H15, Botan::SHAKE_M24_H20, Botan::SHAKE_M24_H25, Botan::SHAKE_M24_H5, Botan::SHAKE_M32_H10, Botan::SHAKE_M32_H15, Botan::SHAKE_M32_H20, Botan::SHAKE_M32_H25, and Botan::SHAKE_M32_H5.

◆ h()

uint8_t Botan::LMS_Params::h ( ) const
inline

Returns the height of the LMS tree.

Definition at line 113 of file lms.h.

113{ return m_h; }

Referenced by create_or_throw(), Botan::LMS_Signature::from_bytes_or_throw(), Botan::LMS_PrivateKey::sign_and_get_pk(), and Botan::LMS_Signature::size().

◆ hash()

std::unique_ptr< HashFunction > Botan::LMS_Params::hash ( ) const
inline

Construct a new hash instance for the LMS instance.

Definition at line 128 of file lms.h.

128{ return HashFunction::create_or_throw(hash_name()); }
Botan::HashFunction::create_or_throw
static std::unique_ptr< HashFunction > create_or_throw(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:298

Referenced by create_or_throw().

◆ hash_name()

const std::string & Botan::LMS_Params::hash_name ( ) const
inline

Returns the name of the hash function to use.

Definition at line 123 of file lms.h.

123{ return m_hash_name; }

Referenced by create_or_throw(), create_or_throw(), Botan::LMS_PublicKey::from_bytes_or_throw(), and Botan::HSS_LMS_PublicKeyInternal::verify_signature().

◆ m()

size_t Botan::LMS_Params::m ( ) const
inline

Returns the number of bytes associated with each node.

Definition at line 118 of file lms.h.

118{ return m_m; }

Referenced by Botan::LMS_PublicKey::from_bytes_or_throw(), Botan::LMS_Signature::from_bytes_or_throw(), Botan::HSS_LMS_PrivateKeyInternal::HSS_LMS_PrivateKeyInternal(), Botan::LMS_PrivateKey::sign_and_get_pk(), Botan::LMS_PublicKey::size(), and Botan::LMS_Signature::size().

The documentation for this class was generated from the following files:
Generated by doxygen 1.11.0