Inherited by keyed algorithms with variable key length. More...
#include <seckey.h>
Public Member Functions | |
| CRYPTOPP_CONSTANT (MIN_KEYLENGTH=N) | |
| The minimum key length used by the algorithm provided as a constant. | |
| CRYPTOPP_CONSTANT (MAX_KEYLENGTH=M) | |
| The maximum key length used by the algorithm provided as a constant. | |
| CRYPTOPP_CONSTANT (DEFAULT_KEYLENGTH=D) | |
| The default key length used by the algorithm provided as a constant. | |
| CRYPTOPP_CONSTANT (KEYLENGTH_MULTIPLE=Q) | |
| The key length multiple 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 initialization vector length for the algorithm provided as a constant. | |
| CRYPTOPP_STATIC_CONSTEXPR size_t CRYPTOPP_API | StaticGetValidKeyLength (size_t keylength) |
| Provides a valid key length for the algorithm provided by a static function. | |
Detailed Description
class VariableKeyLength< D, N, M, Q, IV_REQ, IV_L >
Inherited by keyed algorithms with variable key length.
- Template Parameters
-
D Default key length, in bytes N Minimum key length, in bytes M Maximum key length, in bytes Q Default key length multiple, in bytes. The default multiple is 1. IV_REQ the IV requirements IV_L default IV length, in bytes. The default length is 0.
- See also
- SimpleKeyingInterface
Member Function Documentation
◆ CRYPTOPP_CONSTANT() [1/6]
| VariableKeyLength< D, N, M, Q, IV_REQ, IV_L >::CRYPTOPP_CONSTANT | ( | DEFAULT_KEYLENGTH | = D | ) |
The default key length used by the algorithm provided as a constant.
DEFAULT_KEYLENGTH is provided in bytes, not bits
◆ CRYPTOPP_CONSTANT() [2/6]
| VariableKeyLength< D, N, M, Q, IV_REQ, IV_L >::CRYPTOPP_CONSTANT | ( | IV_LENGTH | = IV_L | ) |
The default initialization vector length for the algorithm provided as a constant.
IV_LENGTH is provided in bytes, not bits. The default implementation uses 0.
◆ CRYPTOPP_CONSTANT() [3/6]
| VariableKeyLength< D, N, M, Q, 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]
| VariableKeyLength< D, N, M, Q, IV_REQ, IV_L >::CRYPTOPP_CONSTANT | ( | KEYLENGTH_MULTIPLE | = Q | ) |
The key length multiple used by the algorithm provided as a constant.
MAX_KEYLENGTH is provided in bytes, not bits
◆ CRYPTOPP_CONSTANT() [5/6]
| VariableKeyLength< D, N, M, Q, IV_REQ, IV_L >::CRYPTOPP_CONSTANT | ( | MAX_KEYLENGTH | = M | ) |
The maximum key length used by the algorithm provided as a constant.
MAX_KEYLENGTH is provided in bytes, not bits
◆ CRYPTOPP_CONSTANT() [6/6]
| VariableKeyLength< D, N, M, Q, 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()
|
inline |
Provides a valid key length for the algorithm provided by a static function.
- Parameters
-
keylength the size of the key, in bytes
If keylength is less than MIN_KEYLENGTH, then the function returns MIN_KEYLENGTH. If keylength is greater than MAX_KEYLENGTH, then the function returns MAX_KEYLENGTH. If keylength is a multiple of KEYLENGTH_MULTIPLE, then keylength is returned. Otherwise, the function returns keylength rounded down to the next smaller multiple of KEYLENGTH_MULTIPLE.
keylength is provided in bytes, not bits.
The documentation for this class was generated from the following file:
- G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/seckey.h
