Botan 3.3.0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::Key_Length_Specification Class Referencefinal

#include <sym_algo.h>

Public Member Functions

 Key_Length_Specification (size_t keylen)
 
 Key_Length_Specification (size_t min_k, size_t max_k, size_t k_mod=1)
 
size_t keylength_multiple () const
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
Key_Length_Specification multiple (size_t n) const
 
bool valid_keylength (size_t length) const
 

Detailed Description

Represents the length requirements on an algorithm key

Definition at line 21 of file sym_algo.h.

Constructor & Destructor Documentation

◆ Key_Length_Specification() [1/2]

Botan::Key_Length_Specification::Key_Length_Specification ( size_t keylen)
inlineexplicit

Constructor for fixed length keys

Parameters
keylenthe supported key length

Definition at line 27 of file sym_algo.h.

27: m_min_keylen(keylen), m_max_keylen(keylen), m_keylen_mod(1) {}

◆ Key_Length_Specification() [2/2]

Botan::Key_Length_Specification::Key_Length_Specification ( size_t min_k,
size_t max_k,
size_t k_mod = 1 )
inline

Constructor for variable length keys

Parameters
min_kthe smallest supported key length
max_kthe largest supported key length
k_modthe number of bytes the key must be a multiple of

Definition at line 35 of file sym_algo.h.

35 :
36 m_min_keylen(min_k), m_max_keylen(max_k ? max_k : min_k), m_keylen_mod(k_mod) {}

Member Function Documentation

◆ keylength_multiple()

size_t Botan::Key_Length_Specification::keylength_multiple ( ) const
inline
Returns
key length multiple in bytes

Definition at line 59 of file sym_algo.h.

59{ return m_keylen_mod; }

◆ maximum_keylength()

size_t Botan::Key_Length_Specification::maximum_keylength ( ) const
inline
Returns
maximum key length in bytes

Definition at line 54 of file sym_algo.h.

54{ return m_max_keylen; }

◆ minimum_keylength()

size_t Botan::Key_Length_Specification::minimum_keylength ( ) const
inline
Returns
minimum key length in bytes

Definition at line 49 of file sym_algo.h.

49{ return m_min_keylen; }

◆ multiple()

Key_Length_Specification Botan::Key_Length_Specification::multiple ( size_t n) const
inline

Definition at line 66 of file sym_algo.h.

66 {
67 return Key_Length_Specification(n * m_min_keylen, n * m_max_keylen, n * m_keylen_mod);
68 }
Key_Length_Specification(size_t keylen)
Definition sym_algo.h:27

Referenced by Botan::XTS_Mode::key_spec().

◆ valid_keylength()

bool Botan::Key_Length_Specification::valid_keylength ( size_t length) const
inline
Parameters
lengthis a key length in bytes
Returns
true iff this length is a valid length for this algo

Definition at line 42 of file sym_algo.h.

42 {
43 return ((length >= m_min_keylen) && (length <= m_max_keylen) && (length % m_keylen_mod == 0));
44 }

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