Security Scol plugin
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Weak1::ARC4_Base Class Reference

ARC4 base class. More...

#include <arc4.h>

Inheritance diagram for Weak1::ARC4_Base:
VariableKeyLength< 16, 1, 256 > RandomNumberGenerator SymmetricCipher SymmetricCipherDocumentation Algorithm SimpleKeyingInterface StreamTransformation Clonable Algorithm Clonable Weak1::MARC4_Base

Public Types

typedef SymmetricCipherFinal< ARC4_BaseEncryption
 
typedef SymmetricCipherFinal< ARC4_BaseDecryption
 
- Public Types inherited from SimpleKeyingInterface
enum  IV_Requirement {
  UNIQUE_IV = 0 , RANDOM_IV , UNPREDICTABLE_RANDOM_IV , INTERNALLY_GENERATED_IV ,
  NOT_RESYNCHRONIZABLE
}
 Secure IVs requirements as enumerated values. More...
 
- Public Types inherited from SymmetricCipherDocumentation
typedef SymmetricCipher Encryption
 implements the SymmetricCipher interface
 
typedef SymmetricCipher Decryption
 implements the SymmetricCipher interface
 

Public Member Functions

CRYPTOPP_STATIC_CONSTEXPR const char * StaticAlgorithmName ()
 
void GenerateBlock (byte *output, size_t size)
 Generate random array of bytes.
 
void DiscardBytes (size_t n)
 Generate and discard n bytes.
 
void ProcessData (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt an array of bytes.
 
bool IsRandomAccess () const
 Determines whether the cipher supports random access.
 
bool IsSelfInverting () const
 Determines whether the cipher is self-inverting.
 
bool IsForwardTransformation () const
 Determines if the cipher is being operated in its forward direction.
 
- Public Member Functions inherited from VariableKeyLength< 16, 1, 256 >
 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=1)
 The key length multiple used by the algorithm provided as a constant.
 
 CRYPTOPP_CONSTANT (IV_REQUIREMENT=SimpleKeyingInterface::NOT_RESYNCHRONIZABLE)
 The default IV requirements for the algorithm provided as a constant.
 
 CRYPTOPP_CONSTANT (IV_LENGTH=0)
 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.
 
- 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.
 
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.
 
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object.
 
- Public Member Functions inherited from SimpleKeyingInterface
virtual size_t MinKeyLength () const =0
 Returns smallest valid key length.
 
virtual size_t MaxKeyLength () const =0
 Returns largest valid key length.
 
virtual size_t DefaultKeyLength () const =0
 Returns default key length.
 
virtual size_t GetValidKeyLength (size_t keylength) const =0
 Returns a valid key length for the algorithm.
 
virtual bool IsValidKeyLength (size_t keylength) const
 Returns whether keylength is a valid key length.
 
virtual void SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
 Sets or reset the key of this object.
 
void SetKeyWithRounds (const byte *key, size_t length, int rounds)
 Sets or reset the key of this object.
 
void SetKeyWithIV (const byte *key, size_t length, const byte *iv, size_t ivLength)
 Sets or reset the key of this object.
 
void SetKeyWithIV (const byte *key, size_t length, const byte *iv)
 Sets or reset the key of this object.
 
virtual IV_Requirement IVRequirement () const =0
 Minimal requirement for secure IVs.
 
bool IsResynchronizable () const
 Determines if the object can be resynchronized.
 
bool CanUseRandomIVs () const
 Determines if the object can use random IVs.
 
bool CanUsePredictableIVs () const
 Determines if the object can use random but possibly predictable IVs.
 
bool CanUseStructuredIVs () const
 Determines if the object can use structured IVs.
 
virtual unsigned int IVSize () const
 Returns length of the IV accepted by this object.
 
unsigned int DefaultIVLength () const
 Provides the default size of an IV.
 
virtual unsigned int MinIVLength () const
 Provides the minimum size of an IV.
 
virtual unsigned int MaxIVLength () const
 Provides the maximum size of an IV.
 
virtual void Resynchronize (const byte *iv, int ivLength=-1)
 Resynchronize with an IV.
 
virtual void GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Retrieves a secure IV for the next message.
 
- Public Member Functions inherited from StreamTransformation
StreamTransformationRef ()
 Provides a reference to this object.
 
virtual unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher.
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher.
 
virtual unsigned int GetOptimalBlockSizeUsed () const
 Provides the number of bytes used in the current block when processing at optimal block size.
 
virtual unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance.
 
virtual size_t ProcessLastBlock (byte *outString, size_t outLength, const byte *inString, size_t inLength)
 Encrypt or decrypt the last block of data.
 
virtual unsigned int MinLastBlockSize () const
 Provides the size of the last block.
 
virtual bool IsLastBlockSpecial () const
 Determines if the last block receives special processing.
 
void ProcessString (byte *inoutString, size_t length)
 Encrypt or decrypt a string of bytes.
 
void ProcessString (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt a string of bytes.
 
byte ProcessByte (byte input)
 Encrypt or decrypt a byte.
 
virtual void Seek (lword pos)
 Seek to an absolute position.
 

Protected Member Functions

void UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)
 Sets the key for this object without performing parameter validation.
 
virtual unsigned int GetDefaultDiscardBytes () const
 
- Protected Member Functions inherited from SymmetricCipher
const AlgorithmGetAlgorithm () const
 Returns the base class Algorithm.
 
- Protected Member Functions inherited from SimpleKeyingInterface
void ThrowIfInvalidKeyLength (size_t length)
 Validates the key length.
 
void ThrowIfResynchronizable ()
 Validates the object.
 
void ThrowIfInvalidIV (const byte *iv)
 Validates the IV.
 
size_t ThrowIfInvalidIVLength (int length)
 Validates the IV length.
 
const byteGetIVAndThrowIfInvalid (const NameValuePairs &params, size_t &size)
 Retrieves and validates the IV.
 
void AssertValidKeyLength (size_t length) const
 Validates the key length.
 

Protected Attributes

FixedSizeSecBlock< byte, 256 > m_state
 
byte m_x
 
byte m_y
 

Detailed Description

ARC4 base class.

Implementations and overrides in Base apply to both ENCRYPTION and DECRYPTION directions

Since
Crypto++ 3.1

Definition at line 22 of file arc4.h.

Member Typedef Documentation

◆ Decryption

Definition at line 39 of file arc4.h.

◆ Encryption

Definition at line 38 of file arc4.h.

Constructor & Destructor Documentation

◆ ~ARC4_Base()

Weak1::ARC4_Base::~ARC4_Base ( )

Definition at line 23 of file arc4.cpp.

Member Function Documentation

◆ DiscardBytes()

void Weak1::ARC4_Base::DiscardBytes ( size_t  n)
virtual

Generate and discard n bytes.

Parameters
nthe number of bytes to generate and discard

Reimplemented from RandomNumberGenerator.

Definition at line 102 of file arc4.cpp.

◆ GenerateBlock()

void Weak1::ARC4_Base::GenerateBlock ( byte output,
size_t  size 
)
virtual

Generate random array of bytes.

Parameters
outputthe byte buffer
sizethe length of the buffer, in bytes

All generated values are uniformly distributed over the range specified within the the constraints of a particular generator.

Note
A derived generator must override either GenerateBlock() or GenerateIntoBufferedTransformation(). They can override both, or have one call the other.

Reimplemented from RandomNumberGenerator.

Definition at line 67 of file arc4.cpp.

◆ GetDefaultDiscardBytes()

virtual unsigned int Weak1::ARC4_Base::GetDefaultDiscardBytes ( ) const
inlineprotectedvirtual

Definition at line 43 of file arc4.h.

◆ IsForwardTransformation()

bool Weak1::ARC4_Base::IsForwardTransformation ( ) const
inlinevirtual

Determines if the cipher is being operated in its forward direction.

Returns
true if DIR is ENCRYPTION, false otherwise
See also
IsForwardTransformation(), IsPermutation(), GetCipherDirection()

Implements StreamTransformation.

Definition at line 36 of file arc4.h.

◆ IsRandomAccess()

bool Weak1::ARC4_Base::IsRandomAccess ( ) const
inlinevirtual

Determines whether the cipher supports random access.

Returns
true if the cipher supports random access, false otherwise

Implements StreamTransformation.

Definition at line 34 of file arc4.h.

◆ IsSelfInverting()

bool Weak1::ARC4_Base::IsSelfInverting ( ) const
inlinevirtual

Determines whether the cipher is self-inverting.

Returns
true if the cipher is self-inverting, false otherwise

IsSelfInverting determines whether this transformation is self-inverting (e.g. xor with a keystream).

Implements StreamTransformation.

Definition at line 35 of file arc4.h.

◆ ProcessData()

void Weak1::ARC4_Base::ProcessData ( byte outString,
const byte inString,
size_t  length 
)
virtual

Encrypt or decrypt an array of bytes.

Parameters
outStringthe output byte buffer
inStringthe input byte buffer
lengththe size of the input and output byte buffers, in bytes

ProcessData is called with a string of bytes whose size depends on MandatoryBlockSize. Either inString == outString, or they must not overlap.

See also
ProcessData, ProcessLastBlock, MandatoryBlockSize, MinLastBlockSize, BlockPaddingSchemeDef, IsLastBlockSpecial

Implements StreamTransformation.

Definition at line 73 of file arc4.cpp.

◆ StaticAlgorithmName()

CRYPTOPP_STATIC_CONSTEXPR const char * Weak1::ARC4_Base::StaticAlgorithmName ( )
inline

Definition at line 27 of file arc4.h.

◆ UncheckedSetKey()

void Weak1::ARC4_Base::UncheckedSetKey ( const byte key,
unsigned int  length,
const NameValuePairs params 
)
protectedvirtual

Sets the key for this object without performing parameter validation.

Parameters
keya byte buffer used to key the cipher
lengththe length of the byte buffer
paramsadditional parameters passed as NameValuePairs

key must be at least DEFAULT_KEYLENGTH in length.

Implements SimpleKeyingInterface.

Definition at line 28 of file arc4.cpp.

Member Data Documentation

◆ m_state

FixedSizeSecBlock<byte, 256> Weak1::ARC4_Base::m_state
protected

Definition at line 45 of file arc4.h.

◆ m_x

byte Weak1::ARC4_Base::m_x
protected

Definition at line 46 of file arc4.h.

◆ m_y

byte Weak1::ARC4_Base::m_y
protected

Definition at line 46 of file arc4.h.


The documentation for this class was generated from the following files: