Security Scol plugin
Public Member Functions | List of all members
FixedKeyLength< N, IV_REQ, IV_L > Class Template Reference

Inherited by keyed algorithms with fixed key length. More...

#include <seckey.h>

Public Member Functions

 CRYPTOPP_CONSTANT (KEYLENGTH=N)
 The default key length used by the algorithm provided as a constant.
 
 CRYPTOPP_CONSTANT (MIN_KEYLENGTH=N)
 The minimum key length used by the algorithm provided as a constant.
 
 CRYPTOPP_CONSTANT (MAX_KEYLENGTH=N)
 The maximum key length used by the algorithm provided as a constant.
 
 CRYPTOPP_CONSTANT (DEFAULT_KEYLENGTH=N)
 The default key length used by the algorithm provided as a constant.
 
 CRYPTOPP_CONSTANT (IV_REQUIREMENT=IV_REQ)
 The default IV requirements for the algorithm provided as a constant.
 
 CRYPTOPP_CONSTANT (IV_LENGTH=IV_L)
 The default IV length used by the algorithm provided as a constant.
 
CRYPTOPP_STATIC_CONSTEXPR size_t CRYPTOPP_API StaticGetValidKeyLength (size_t keylength)
 The default key length for the algorithm provided by a static function.
 

Detailed Description

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
class FixedKeyLength< N, IV_REQ, IV_L >

Inherited by keyed algorithms with fixed key length.

Template Parameters
NDefault key length, in bytes
IV_REQthe IV requirements
IV_Ldefault IV length, in bytes
See also
SimpleKeyingInterface

Definition at line 124 of file seckey.h.

Member Function Documentation

◆ CRYPTOPP_CONSTANT() [1/6]

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
FixedKeyLength< N, IV_REQ, IV_L >::CRYPTOPP_CONSTANT ( DEFAULT_KEYLENGTH  = N)

The default key length used by the algorithm provided as a constant.

DEFAULT_KEYLENGTH is provided in bytes, not bits

◆ CRYPTOPP_CONSTANT() [2/6]

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
FixedKeyLength< N, IV_REQ, IV_L >::CRYPTOPP_CONSTANT ( IV_LENGTH  = IV_L)

The default IV length used by the algorithm provided as a constant.

IV_LENGTH is provided in bytes, not bits. The default implementation uses 0.

◆ CRYPTOPP_CONSTANT() [3/6]

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
FixedKeyLength< N, IV_REQ, IV_L >::CRYPTOPP_CONSTANT ( IV_REQUIREMENT  = IV_REQ)

The default IV requirements for the algorithm provided as a constant.

The default value is NOT_RESYNCHRONIZABLE. See IV_Requirement in cryptlib.h for allowed values.

◆ CRYPTOPP_CONSTANT() [4/6]

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
FixedKeyLength< N, IV_REQ, IV_L >::CRYPTOPP_CONSTANT ( KEYLENGTH  = N)

The default key length used by the algorithm provided as a constant.

KEYLENGTH is provided in bytes, not bits

◆ CRYPTOPP_CONSTANT() [5/6]

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
FixedKeyLength< N, IV_REQ, IV_L >::CRYPTOPP_CONSTANT ( MAX_KEYLENGTH  = N)

The maximum key length used by the algorithm provided as a constant.

MAX_KEYLENGTH is provided in bytes, not bits

◆ CRYPTOPP_CONSTANT() [6/6]

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
FixedKeyLength< N, IV_REQ, IV_L >::CRYPTOPP_CONSTANT ( MIN_KEYLENGTH  = N)

The minimum key length used by the algorithm provided as a constant.

MIN_KEYLENGTH is provided in bytes, not bits

◆ StaticGetValidKeyLength()

template<unsigned int N, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0>
CRYPTOPP_STATIC_CONSTEXPR size_t CRYPTOPP_API FixedKeyLength< N, IV_REQ, IV_L >::StaticGetValidKeyLength ( size_t  keylength)
inline

The default key length for the algorithm provided by a static function.

Parameters
keylengththe size of the key, in bytes

The default implementation returns KEYLENGTH. keylength is unused in the default implementation.

Definition at line 150 of file seckey.h.


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