Updated documentation
parent
22400b2ad1
commit
4bee0519f5
20
cryptlib.h
20
cryptlib.h
|
|
@ -531,16 +531,24 @@ class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE SimpleKeyingInterface
|
||||||
public:
|
public:
|
||||||
virtual ~SimpleKeyingInterface() {}
|
virtual ~SimpleKeyingInterface() {}
|
||||||
|
|
||||||
//! \brief Returns smallest valid key length in bytes
|
//! \brief Returns smallest valid key length
|
||||||
|
//! \returns the minimum key length, in bytes
|
||||||
virtual size_t MinKeyLength() const =0;
|
virtual size_t MinKeyLength() const =0;
|
||||||
//! \brief Returns largest valid key length in bytes
|
//! \brief Returns largest valid key length
|
||||||
|
//! \returns the maximum key length, in bytes
|
||||||
virtual size_t MaxKeyLength() const =0;
|
virtual size_t MaxKeyLength() const =0;
|
||||||
//! \brief Returns default (recommended) key length in bytes
|
//! \brief Returns default key length
|
||||||
|
//! \returns the default (recommended) key length, in bytes
|
||||||
virtual size_t DefaultKeyLength() const =0;
|
virtual size_t DefaultKeyLength() const =0;
|
||||||
|
|
||||||
//! \brief
|
//! \brief Returns a valid key length for the algorithm
|
||||||
//! \param n the desired keylength
|
//! \param keylength the size of the key, in bytes
|
||||||
//! \return the smallest valid key length in bytes that is greater than or equal to <tt>min(n, GetMaxKeyLength())</tt>
|
//! \returns the valid key length, in bytes
|
||||||
|
//! \details keylength is provided in bytes, not bits. 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 If keylength is a multiple of KEYLENGTH_MULTIPLE,
|
||||||
|
//! then keylength is returned. Otherwise, the function returns a \a lower multiple of
|
||||||
|
//! KEYLENGTH_MULTIPLE.
|
||||||
virtual size_t GetValidKeyLength(size_t n) const =0;
|
virtual size_t GetValidKeyLength(size_t n) const =0;
|
||||||
|
|
||||||
//! \brief Returns whether keylength is a valid key length
|
//! \brief Returns whether keylength is a valid key length
|
||||||
|
|
|
||||||
2
seckey.h
2
seckey.h
|
|
@ -295,7 +295,7 @@ public:
|
||||||
|
|
||||||
//! \brief Provides a valid key length for the algorithm
|
//! \brief Provides a valid key length for the algorithm
|
||||||
//! \param keylength the size of the key, in bytes
|
//! \param keylength the size of the key, in bytes
|
||||||
//! \returns the valid key lenght, in bytes
|
//! \returns the valid key length, in bytes
|
||||||
//! \details keylength is provided in bytes, not bits. If keylength is less than MIN_KEYLENGTH,
|
//! \details keylength is provided in bytes, not bits. If keylength is less than MIN_KEYLENGTH,
|
||||||
//! then the function returns MIN_KEYLENGTH. If keylength is greater than MAX_KEYLENGTH,
|
//! then the function returns MIN_KEYLENGTH. If keylength is greater than MAX_KEYLENGTH,
|
||||||
//! then the function returns MAX_KEYLENGTH. if If keylength is a multiple of KEYLENGTH_MULTIPLE,
|
//! then the function returns MAX_KEYLENGTH. if If keylength is a multiple of KEYLENGTH_MULTIPLE,
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue