Botan::Key_Length_Specification Class Reference

#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 22 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

keylen

the supported key length

Definition at line 28 of file sym_algo.h.

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

Referenced by multiple().

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_k	the smallest supported key length
max_k	the largest supported key length
k_mod	the number of bytes the key must be a multiple of

Definition at line 36 of file sym_algo.h.

                                                                           :
            m_min_keylen(min_k), m_max_keylen(max_k > 0 ? max_k : min_k), m_keylen_mod(k_mod) {}

Member Function Documentation

keylength_multiple()

size_t Botan::Key_Length_Specification::keylength_multiple ( ) const

inline

Return the granularity of acceptable key lengths

Returns

key length multiple in bytes

Definition at line 64 of file sym_algo.h.

{ return m_keylen_mod; }

maximum_keylength()

size_t Botan::Key_Length_Specification::maximum_keylength ( ) const

inline

Return the largest acceptable key length

Returns

maximum key length in bytes

Definition at line 58 of file sym_algo.h.

{ return m_max_keylen; }

minimum_keylength()

size_t Botan::Key_Length_Specification::minimum_keylength ( ) const

inline

Return the smallest acceptable key length

Returns

minimum key length in bytes

Definition at line 52 of file sym_algo.h.

{ return m_min_keylen; }

multiple()

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

inline

Scale all length requirements by a factor Multiplies all length requirements with the given factor

Parameters

n	the multiplication factor

Returns

a key length specification multiplied by the factor

Definition at line 72 of file sym_algo.h.

                                                        {
         return Key_Length_Specification(n * m_min_keylen, n * m_max_keylen, n * m_keylen_mod);
      }

References Key_Length_Specification().

Referenced by Botan::SIV_Mode::key_spec(), and Botan::XTS_Mode::key_spec().

valid_keylength()

bool Botan::Key_Length_Specification::valid_keylength ( size_t length ) const

inline

Test if a key length is acceptable

Parameters

length

is a key length in bytes

Returns

true iff this length is a valid length for this algo

Definition at line 44 of file sym_algo.h.

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

---

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

• src/lib/base/sym_algo.h