Security Scol plugin
Public Member Functions | List of all members
ECB_OneWay Class Reference

ECB block cipher mode of operation default implementation. More...

#include <modes.h>

Inheritance diagram for ECB_OneWay:
BlockOrientedCipherModeBase CipherModeBase SymmetricCipher SimpleKeyingInterface StreamTransformation Algorithm Clonable

Public Member Functions

CRYPTOPP_STATIC_CONSTEXPR const char *CRYPTOPP_API StaticAlgorithmName ()
 
void SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
 Sets or reset the key of this object.
 
IV_Requirement IVRequirement () const
 Minimal requirement for secure IVs.
 
unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher.
 
void ProcessData (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt an array of bytes.
 
- Public Member Functions inherited from BlockOrientedCipherModeBase
void UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)
 Sets the key for this object without performing parameter validation.
 
unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher.
 
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.
 
void Resynchronize (const byte *iv, int length=-1)
 Resynchronize with an IV.
 
- Public Member Functions inherited from CipherModeBase
std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 
size_t MinKeyLength () const
 Returns smallest valid key length.
 
size_t MaxKeyLength () const
 Returns largest valid key length.
 
size_t DefaultKeyLength () const
 Returns default key length.
 
size_t GetValidKeyLength (size_t keylength) const
 Returns a valid key length for the algorithm.
 
bool IsValidKeyLength (size_t keylength) const
 Returns whether keylength is a valid key length.
 
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance.
 
unsigned int IVSize () const
 Returns length of the IV accepted by this object.
 
void SetCipher (BlockCipher &cipher)
 Set external block cipher.
 
void SetCipherWithIV (BlockCipher &cipher, const byte *iv, int feedbackSize=0)
 Set external block cipher and IV.
 
- Public Member Functions inherited from SimpleKeyingInterface
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.
 
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.
 
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 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 GetOptimalBlockSizeUsed () const
 Provides the number of bytes used in the current block when processing at optimal block size.
 
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.
 
- 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 ClonableClone () const
 Copies this object.
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from BlockOrientedCipherModeBase
bool RequireAlignedInput () const
 
virtual void ResizeBuffers ()
 
- Protected Member Functions inherited from CipherModeBase
unsigned int BlockSize () const
 
virtual void SetFeedbackSize (unsigned int feedbackSize)
 
- 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 inherited from BlockOrientedCipherModeBase
SecByteBlock m_buffer
 
- Protected Attributes inherited from CipherModeBase
BlockCipherm_cipher
 
SecByteBlock m_register
 

Detailed Description

ECB block cipher mode of operation default implementation.

Definition at line 271 of file modes.h.

Member Function Documentation

◆ IVRequirement()

IV_Requirement ECB_OneWay::IVRequirement ( ) const
inlinevirtual

Minimal requirement for secure IVs.

Returns
the secure IV requirement of the algorithm

Implements CipherModeBase.

Definition at line 278 of file modes.h.

◆ OptimalBlockSize()

unsigned int ECB_OneWay::OptimalBlockSize ( ) const
inlinevirtual

Provides the input block size most efficient for this cipher.

Returns
The input block size that is most efficient for the cipher

The base class implementation returns MandatoryBlockSize().

Note
Optimal input length is n * OptimalBlockSize() - GetOptimalBlockSizeUsed() for any n > 0.

Reimplemented from StreamTransformation.

Definition at line 279 of file modes.h.

◆ ProcessData()

void ECB_OneWay::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 191 of file modes.cpp.

◆ SetKey()

void ECB_OneWay::SetKey ( const byte key,
size_t  length,
const NameValuePairs params = g_nullNameValuePairs 
)
inlinevirtual

Sets or reset the key of this object.

Parameters
keythe key to use when keying the object
lengththe size of the key, in bytes
paramsadditional initialization parameters to configure this object

Reimplemented from SimpleKeyingInterface.

Definition at line 276 of file modes.h.

◆ StaticAlgorithmName()

CRYPTOPP_STATIC_CONSTEXPR const char *CRYPTOPP_API ECB_OneWay::StaticAlgorithmName ( )
inline

Definition at line 274 of file modes.h.


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