Crypto++ 8.9
Free C++ class library of cryptographic schemes
|
Base class for additive stream ciphers with SymmetricCipher interface. More...
#include <strciphr.h>
Public Types | |
typedef BASE::PolicyInterface | PolicyInterface |
Public Types inherited from AbstractPolicyHolder< POLICY_INTERFACE, BASE > | |
typedef POLICY_INTERFACE | PolicyInterface |
Public Member Functions | |
void | GenerateBlock (byte *output, size_t size) |
Generate random array of bytes. | |
void | ProcessData (byte *outString, const byte *inString, size_t length) |
Apply keystream to data. | |
void | Resynchronize (const byte *iv, int length=-1) |
Resynchronize the cipher. | |
unsigned int | OptimalBlockSize () const |
Provides number of ideal bytes to process. | |
unsigned int | GetOptimalNextBlockSize () const |
Provides number of ideal bytes to process. | |
unsigned int | OptimalDataAlignment () const |
Provides number of ideal data alignment. | |
bool | IsSelfInverting () const |
Determines if the cipher is self inverting. | |
bool | IsForwardTransformation () const |
Determines if the cipher is a forward transformation. | |
bool | IsRandomAccess () const |
Flag indicating random access. | |
void | Seek (lword position) |
Seeks to a random position in the stream. | |
std::string | AlgorithmProvider () const |
Retrieve the provider of this algorithm. | |
Public Member Functions inherited from RandomNumberGenerator | |
virtual void | IncorporateEntropy (const byte *input, size_t length) |
Update RNG state with additional unpredictable values. | |
virtual bool | CanIncorporateEntropy () const |
Determines if a generator can accept additional entropy. | |
virtual byte | GenerateByte () |
Generate new random byte and return it. | |
virtual unsigned int | GenerateBit () |
Generate new random bit and return it. | |
virtual word32 | GenerateWord32 (word32 min=0, word32 max=0xffffffffUL) |
Generate a random 32 bit word in the range min to max, inclusive. | |
virtual void | GenerateIntoBufferedTransformation (BufferedTransformation &target, const std::string &channel, lword length) |
Generate random bytes into a BufferedTransformation. | |
virtual void | DiscardBytes (size_t n) |
Generate and discard n bytes. | |
template<class IT > | |
void | Shuffle (IT begin, IT end) |
Randomly shuffle the specified array. | |
Public Member Functions inherited from Algorithm | |
Algorithm (bool checkSelfTestStatus=true) | |
Interface for all crypto algorithms. | |
virtual std::string | AlgorithmName () const |
Provides the name of this algorithm. | |
Public Member Functions inherited from Clonable | |
virtual Clonable * | Clone () const |
Copies this object. | |
Base class for additive stream ciphers with SymmetricCipher interface.
BASE | AbstractPolicyHolder base class |
Definition at line 297 of file strciphr.h.
typedef BASE::PolicyInterface AdditiveCipherTemplate< BASE >::PolicyInterface |
Definition at line 387 of file strciphr.h.
|
inlinevirtual |
Definition at line 300 of file strciphr.h.
|
inline |
Definition at line 301 of file strciphr.h.
|
virtual |
Generate random array of bytes.
output | the byte buffer |
size | the length of the buffer, in bytes |
All generated values are uniformly distributed over the range specified within the constraints of a particular generator.
Reimplemented from RandomNumberGenerator.
void AdditiveCipherTemplate< BASE >::ProcessData | ( | byte * | outString, |
const byte * | inString, | ||
size_t | length ) |
Apply keystream to data.
outString | a buffer to write the transformed data |
inString | a buffer to read the data |
length | the size of the buffers, in bytes |
This is the primary method to operate a stream cipher. For example:
size_t size = 30; byte plain[size] = "Do or do not; there is no try"; byte cipher[size]; ... ChaCha20 chacha(key, keySize); chacha.ProcessData(cipher, plain, size);
You should use distinct buffers for inString and outString. If the buffers are the same, then the data will be copied to an internal buffer to avoid GCC alias violations. The internal copy will impact performance.
void AdditiveCipherTemplate< BASE >::Resynchronize | ( | const byte * | iv, |
int | length = -1 ) |
Resynchronize the cipher.
iv | a byte array used to resynchronize the cipher |
length | the size of the IV array |
|
inline |
Provides number of ideal bytes to process.
Internally, the default implementation returns GetBytesPerIteration()
Definition at line 340 of file strciphr.h.
|
inline |
Provides number of ideal bytes to process.
Internally, the default implementation returns remaining unprocessed bytes
Definition at line 346 of file strciphr.h.
|
inline |
Provides number of ideal data alignment.
Definition at line 351 of file strciphr.h.
|
inline |
Determines if the cipher is self inverting.
Definition at line 355 of file strciphr.h.
|
inline |
Determines if the cipher is a forward transformation.
Definition at line 359 of file strciphr.h.
|
inline |
Flag indicating random access.
Definition at line 364 of file strciphr.h.
void AdditiveCipherTemplate< BASE >::Seek | ( | lword | position | ) |
Seeks to a random position in the stream.
position | the absolute position in the stream |
|
inlinevirtual |
Retrieve the provider of this algorithm.
The algorithm provider can be a name like "C++", "SSE", "NEON", "AESNI", "ARMv8" and "Power8". C++ is standard C++ code. Other labels, like SSE, usually indicate a specialized implementation using instructions from a higher instruction set architecture (ISA). Future labels may include external hardware like a hardware security module (HSM).
Generally speaking Wei Dai's original IA-32 ASM code falls under "SSE2". Labels like "SSSE3" and "SSE4.1" follow after Wei's code and use intrinsics instead of ASM.
Algorithms which combine different instructions or ISAs provide the dominant one. For example on x86 AES/GCM
returns "AESNI" rather than "CLMUL" or "AES+SSE4.1" or "AES+CLMUL" or "AES+SSE4.1+CLMUL".
Reimplemented from Algorithm.
Definition at line 385 of file strciphr.h.