arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

pull/795/head
Jeffrey Walton 2019-01-26 00:12:11 -05:00
parent b9d2310beb
commit 83f41e0d76
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
strciphr.h
View File

@ -200,7 +200,14 @@ struct CRYPTOPP_DLL CRYPTOPP_NO_VTABLE AdditiveCipherAbstractPolicy
template <typename WT, unsigned int W, unsigned int X = 1, class BASE = AdditiveCipherAbstractPolicy> template <typename WT, unsigned int W, unsigned int X = 1, class BASE = AdditiveCipherAbstractPolicy>
struct CRYPTOPP_NO_VTABLE AdditiveCipherConcretePolicy : public BASE struct CRYPTOPP_NO_VTABLE AdditiveCipherConcretePolicy : public BASE
{ {
/// \brief Word type for the cipher
typedef WT WordType; typedef WT WordType;
/// \brief Number of bytes for an iteration
/// \details BYTES_PER_ITERATION is the product <tt>sizeof(WordType) * W</tt>.
/// For example, ChaCha uses 16 each <tt>word32</tt>, and the value of
/// BYTES_PER_ITERATION is 64. Each invocation of the ChaCha block function
/// produces 64 bytes of keystream.
CRYPTOPP_CONSTANT(BYTES_PER_ITERATION = sizeof(WordType) * W) CRYPTOPP_CONSTANT(BYTES_PER_ITERATION = sizeof(WordType) * W)
virtual ~AdditiveCipherConcretePolicy() {} virtual ~AdditiveCipherConcretePolicy() {}
@ -208,8 +215,9 @@ struct CRYPTOPP_NO_VTABLE AdditiveCipherConcretePolicy : public BASE
#if !(CRYPTOPP_BOOL_X86 || CRYPTOPP_BOOL_X64) #if !(CRYPTOPP_BOOL_X86 || CRYPTOPP_BOOL_X64)
/// \brief Provides data alignment requirements /// \brief Provides data alignment requirements
/// \returns data alignment requirements, in bytes /// \returns data alignment requirements, in bytes
/// \details Internally, the default implementation returns 1. If the stream cipher is implemented /// \details Internally, the default implementation returns 1. If the stream
/// using an SSE2 ASM or intrinsics, then the value returned is usually 16. /// cipher is implemented using an SSE2 ASM or intrinsics, then the value
/// returned is usually 16.
unsigned int GetAlignment() const {return GetAlignmentOf<WordType>();} unsigned int GetAlignment() const {return GetAlignmentOf<WordType>();}
#endif #endif
@ -223,7 +231,8 @@ struct CRYPTOPP_NO_VTABLE AdditiveCipherConcretePolicy : public BASE
unsigned int GetIterationsToBuffer() const {return X;} unsigned int GetIterationsToBuffer() const {return X;}
/// \brief Flag indicating /// \brief Flag indicating
/// \returns true if the stream can be generated independent of the transformation input, false otherwise /// \returns true if the stream can be generated independent of the
/// transformation input, false otherwise
/// \sa CanOperateKeystream(), OperateKeystream(), WriteKeystream() /// \sa CanOperateKeystream(), OperateKeystream(), WriteKeystream()
bool CanOperateKeystream() const {return true;} bool CanOperateKeystream() const {return true;}