#include <arc4.h>
Inheritance diagram for ARC4_Base:
You can #ARC4 typedef rather than this class directly.
Definition at line 10 of file arc4.h.
Public Types | |
typedef SymmetricCipherFinalTemplate< ARC4_Base > | Encryption |
typedef SymmetricCipherFinalTemplate< ARC4_Base > | Decryption |
enum | IV_Requirement { STRUCTURED_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV, NOT_RESYNCHRONIZABLE } |
Public Member Functions | |
byte | GenerateByte () |
generate new random byte and return it | |
void | DiscardBytes (unsigned int n) |
generate and discard n bytes | |
void | ProcessData (byte *outString, const byte *inString, unsigned int length) |
encrypt or decrypt an array of bytes of specified length | |
bool | IsRandomAccess () const |
returns whether this cipher supports random access | |
bool | IsSelfInverting () const |
returns whether this transformation is self-inverting (e.g. xor with a keystream) | |
bool | IsForwardTransformation () const |
returns whether this is an encryption object | |
virtual unsigned int | GenerateBit () |
generate new random bit and return it | |
virtual word32 | GenerateWord32 (word32 a=0, word32 b=0xffffffffL) |
generate a random 32 bit word in the range min to max, inclusive | |
virtual void | GenerateBlock (byte *output, unsigned int size) |
generate random array of bytes | |
template<class IT> void | Shuffle (IT begin, IT end) |
randomly shuffle the specified array, resulting permutation is uniformly distributed | |
virtual std::string | AlgorithmName () const |
returns name of this algorithm, not universally implemented yet | |
virtual Clonable * | Clone () const |
this is not implemented by most classes yet | |
StreamTransformation & | Ref () |
return a reference to this object, | |
virtual unsigned int | MandatoryBlockSize () const |
returns block size, if input must be processed in blocks, otherwise 1 | |
virtual unsigned int | OptimalBlockSize () const |
returns the input block size that is most efficient for this cipher | |
virtual unsigned int | GetOptimalBlockSizeUsed () const |
returns how much of the current block is used up | |
virtual unsigned int | OptimalDataAlignment () const |
returns how input should be aligned for optimal performance | |
virtual void | ProcessLastBlock (byte *outString, const byte *inString, unsigned int length) |
for ciphers where the last block of data is special, encrypt or decrypt the last block of data | |
virtual unsigned int | MinLastBlockSize () const |
returns the minimum size of the last block, 0 indicating the last block is not special | |
void | ProcessString (byte *inoutString, unsigned int length) |
same as ProcessData(inoutString, inoutString, length) | |
void | ProcessString (byte *outString, const byte *inString, unsigned int length) |
same as ProcessData(outString, inString, length) | |
byte | ProcessByte (byte input) |
implemented as {ProcessData(&input, &input, 1); return input;} | |
virtual void | Seek (dword n) |
for random access ciphers, seek to an absolute position | |
virtual unsigned int | MinKeyLength () const =0 |
returns smallest valid key length in bytes */ | |
virtual unsigned int | MaxKeyLength () const =0 |
returns largest valid key length in bytes */ | |
virtual unsigned int | DefaultKeyLength () const =0 |
returns default (recommended) key length in bytes */ | |
virtual unsigned int | GetValidKeyLength (unsigned int n) const =0 |
returns the smallest valid key length in bytes that is >= min(n, GetMaxKeyLength()) | |
virtual bool | IsValidKeyLength (unsigned int n) const |
returns whether n is a valid key length | |
virtual void | SetKey (const byte *key, unsigned int length, const NameValuePairs ¶ms=g_nullNameValuePairs)=0 |
set or reset the key of this object | |
void | SetKeyWithRounds (const byte *key, unsigned int length, int rounds) |
calls SetKey() with an NameValuePairs object that just specifies "Rounds" | |
void | SetKeyWithIV (const byte *key, unsigned int length, const byte *iv) |
calls SetKey() with an NameValuePairs object that just specifies "IV" | |
virtual IV_Requirement | IVRequirement () const =0 |
returns the minimal requirement for secure IVs | |
bool | IsResynchronizable () const |
returns whether this object can be resynchronized (i.e. supports initialization vectors) | |
bool | CanUseRandomIVs () const |
returns whether this object can use random IVs (in addition to ones returned by GetNextIV) | |
bool | CanUsePredictableIVs () const |
returns whether this object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV) | |
bool | CanUseStructuredIVs () const |
returns whether this object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV) | |
virtual unsigned int | IVSize () const |
returns size of IVs used by this object | |
virtual void | Resynchronize (const byte *IV) |
resynchronize with an IV | |
virtual void | GetNextIV (byte *IV) |
get a secure IV for the next message | |
Static Public Member Functions | |
const char * | StaticAlgorithmName () |
unsigned int | StaticGetValidKeyLength (unsigned int n) |
Protected Member Functions | |
void | UncheckedSetKey (const NameValuePairs ¶ms, const byte *key, unsigned int length) |
virtual unsigned int | GetDefaultDiscardBytes () const |
void | ThrowIfInvalidKeyLength (const Algorithm &algorithm, unsigned int length) |
void | AssertValidKeyLength (unsigned int length) const |
Protected Attributes | |
FixedSizeSecBlock< byte, 256 > | m_state |
byte | m_x |
byte | m_y |
|
generate and discard n bytes Default implementation is to call GenerateByte() n times. Reimplemented from RandomNumberGenerator. Definition at line 97 of file arc4.cpp. References DiscardBytes(). Referenced by DiscardBytes(). |
|
encrypt or decrypt an array of bytes of specified length
Implements StreamTransformation. Definition at line 68 of file arc4.cpp. References ProcessData(). Referenced by ProcessData(). |
|
generate new random bit and return it Default implementation is to call GenerateByte() and return its parity. Reimplemented in PublicBlumBlumShub. Definition at line 83 of file cryptlib.cpp. References RandomNumberGenerator::GenerateByte(). |
|
generate random array of bytes Default implementation is to call GenerateByte() size times. Reimplemented in NonblockingRng, and RandomPool. Definition at line 88 of file cryptlib.cpp. References RandomNumberGenerator::GenerateBlock(), and RandomNumberGenerator::GenerateByte(). Referenced by RandomNumberGenerator::GenerateBlock(), and DL_GroupParameters_DSA::GenerateRandom(). |
|
return a reference to this object, This function is useful for passing a temporary StreamTransformation object to a function that takes a non-const reference. Definition at line 441 of file cryptlib.h. |
|
returns the input block size that is most efficient for this cipher
Definition at line 448 of file cryptlib.h. References StreamTransformation::MandatoryBlockSize(). |
|
for ciphers where the last block of data is special, encrypt or decrypt the last block of data For now the only use of this function is for CBC-CTS mode. Definition at line 73 of file cryptlib.cpp. References StreamTransformation::MandatoryBlockSize(), StreamTransformation::MinLastBlockSize(), StreamTransformation::ProcessData(), and StreamTransformation::ProcessLastBlock(). Referenced by StreamTransformation::ProcessLastBlock(). |
|
set or reset the key of this object
Implemented in MessageAuthenticationCodeTemplate< BASE >, MessageAuthenticationCodeTemplate< CBC_MAC_Base< T > >, MessageAuthenticationCodeTemplate< HMAC_Base< T > >, MessageAuthenticationCodeTemplate< XMACC_Base< T > >, MessageAuthenticationCodeTemplate< DMAC_Base< T > >, and MessageAuthenticationCodeTemplate< PanamaMAC_Base< B > >. Referenced by SimpleKeyingInterface::SetKeyWithIV(), and SimpleKeyingInterface::SetKeyWithRounds(). |
|
returns whether this object can be resynchronized (i.e. supports initialization vectors) If this function returns true, and no IV is passed to SetKey() and CanUseStructuredIVs()==true, an IV of all 0's will be assumed. Definition at line 364 of file cryptlib.h. References SimpleKeyingInterface::IVRequirement(). |
|
get a secure IV for the next message This method should be called after you finish encrypting one message and are ready to start the next one. After calling it, you must call SetKey() or Resynchronize() before using this object again. This method is not implemented on decryption objects. Definition at line 380 of file cryptlib.h. References SimpleKeyingInterface::GetNextIV(). Referenced by SimpleKeyingInterface::GetNextIV(). |