Botan  2.6.0
Crypto and TLS for C++11
Public Member Functions | List of all members
Botan::Key_Length_Specification Class Referencefinal

#include <key_spec.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 18 of file key_spec.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 25 of file key_spec.h.

25  :
26  m_min_keylen(keylen),
27  m_max_keylen(keylen),
28  m_keylen_mod(1)
29  {
30  }

◆ 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 38 of file key_spec.h.

40  :
41  m_min_keylen(min_k),
42  m_max_keylen(max_k ? max_k : min_k),
43  m_keylen_mod(k_mod)
44  {
45  }

Member Function Documentation

◆ keylength_multiple()

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

Definition at line 77 of file key_spec.h.

78  {
79  return m_keylen_mod;
80  }

◆ maximum_keylength()

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

Definition at line 69 of file key_spec.h.

70  {
71  return m_max_keylen;
72  }

◆ minimum_keylength()

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

Definition at line 61 of file key_spec.h.

Referenced by botan_cipher_query_keylen().

62  {
63  return m_min_keylen;
64  }

◆ multiple()

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

Definition at line 87 of file key_spec.h.

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

88  {
89  return Key_Length_Specification(n * m_min_keylen,
90  n * m_max_keylen,
91  n * m_keylen_mod);
92  }
Key_Length_Specification(size_t keylen)
Definition: key_spec.h:25

◆ 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 51 of file key_spec.h.

52  {
53  return ((length >= m_min_keylen) &&
54  (length <= m_max_keylen) &&
55  (length % m_keylen_mod == 0));
56  }

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