ECB_OneWay Class Reference

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

List of all members.

Public Types

enum  IV_Requirement {
  UNIQUE_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV,
  NOT_RESYNCHRONIZABLE
}
 

Provides IV requirements as an enumerated value.

More...

Public Member Functions

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
 returns the 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.
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. ivLength=-1 means use IVSize()
size_t MinKeyLength () const
 Returns smallest valid key length in bytes.
size_t MaxKeyLength () const
 Returns largest valid key length in bytes.
size_t DefaultKeyLength () const
 Returns default (recommended) key length in bytes.
size_t GetValidKeyLength (size_t n) const
bool IsValidKeyLength (size_t n) 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)
void SetCipherWithIV (BlockCipher &cipher, const byte *iv, int feedbackSize=0)
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
 returns whether the object can be resynchronized (i.e. supports initialization vectors)
bool CanUseRandomIVs () const
 returns whether the object can use random IVs (in addition to ones returned by GetNextIV)
bool CanUsePredictableIVs () const
 returns whether the object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV)
bool CanUseStructuredIVs () const
 returns whether the object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV)
unsigned int DefaultIVLength () const
 returns default length of IVs accepted by this object
virtual unsigned int MinIVLength () const
 returns minimal length of IVs accepted by this object
virtual unsigned int MaxIVLength () const
 returns maximal length of IVs accepted by this object
virtual void GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Gets a secure IV for the next message.
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 void ProcessLastBlock (byte *outString, const byte *inString, size_t length)
 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, 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.
virtual std::string AlgorithmName () const
 Provides the name of this algorithm.
virtual ClonableClone () const
 Copies this object.

Static Public Member Functions

static const char * StaticAlgorithmName ()

Detailed Description

Definition at line 196 of file modes.h.


Member Enumeration Documentation

Provides IV requirements as an enumerated value.

Enumerator:
UNIQUE_IV 

The IV must be unique.

RANDOM_IV 

The IV must be random.

UNPREDICTABLE_RANDOM_IV 

The IV must be unpredictable.

INTERNALLY_GENERATED_IV 

The IV is set by the object.

NOT_RESYNCHRONIZABLE 

The object does not use an IV.

Definition at line 555 of file cryptlib.h.


Member Function Documentation

void ECB_OneWay::SetKey ( const byte *  key,
size_t  length,
const NameValuePairs params = g_nullNameValuePairs 
) [inline, virtual]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
params additional initialization parameters that cannot be passed directly through the constructor

Reimplemented from SimpleKeyingInterface.

Definition at line 199 of file modes.h.

unsigned int ECB_OneWay::OptimalBlockSize (  )  const [inline, virtual]

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 implemnetation returns MandatoryBlockSize().

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

Reimplemented from StreamTransformation.

Definition at line 202 of file modes.h.

References BlockSize().

void ECB_OneWay::ProcessData ( byte *  outString,
const byte *  inString,
size_t  length 
) [virtual]

Encrypt or decrypt an array of bytes.

Parameters:
outString the output byte buffer
inString the input byte buffer
length the size of the input and output byte buffers, in bytes

Either inString == outString, or they must not overlap.

Implements StreamTransformation.

Definition at line 175 of file modes.cpp.

References BlockSize().

void BlockOrientedCipherModeBase::UncheckedSetKey ( const byte *  key,
unsigned int  length,
const NameValuePairs params 
) [virtual, inherited]

Sets the key for this object without performing parameter validation.

Parameters:
key a byte buffer used to key the cipher
length the length of the byte buffer
params additional parameters passed as NameValuePairs

key must be at least DEFAULT_KEYLENGTH in length.

Implements SimpleKeyingInterface.

Definition at line 154 of file modes.cpp.

References SimpleKeyingInterface::IsResynchronizable(), and BlockOrientedCipherModeBase::Resynchronize().

unsigned int BlockOrientedCipherModeBase::MandatoryBlockSize (  )  const [inline, virtual, inherited]

Provides the mandatory block size of the cipher.

Returns:
The block size of the cipher if input must be processed in blocks, 1 otherwise

Reimplemented from StreamTransformation.

Definition at line 173 of file modes.h.

References BlockSize().

bool BlockOrientedCipherModeBase::IsRandomAccess (  )  const [inline, virtual, inherited]

Determines whether the cipher supports random access.

Returns:
true if the cipher supports random access, false otherwise

Implements StreamTransformation.

Definition at line 174 of file modes.h.

bool BlockOrientedCipherModeBase::IsSelfInverting (  )  const [inline, virtual, inherited]

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 175 of file modes.h.

bool BlockOrientedCipherModeBase::IsForwardTransformation (  )  const [inline, virtual, inherited]

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 176 of file modes.h.

size_t CipherModeBase::GetValidKeyLength ( size_t  n  )  const [inline, virtual, inherited]
Returns:
the smallest valid key length in bytes that is greater than or equal to min(n, GetMaxKeyLength())

Implements SimpleKeyingInterface.

Definition at line 40 of file modes.h.

bool CipherModeBase::IsValidKeyLength ( size_t  keylength  )  const [inline, virtual, inherited]

Returns whether keylength is a valid key length.

Internally the function calls GetValidKeyLength()

Reimplemented from SimpleKeyingInterface.

Definition at line 41 of file modes.h.

unsigned int CipherModeBase::OptimalDataAlignment (  )  const [inline, virtual, inherited]

Provides input and output data alignment for optimal performance.

Returns:
the input data alignment that provides optimal performance

Reimplemented from StreamTransformation.

Definition at line 43 of file modes.h.

unsigned int CipherModeBase::IVSize (  )  const [inline, virtual, inherited]

Returns length of the IV accepted by this object.

The default implementation throws NotImplemented

Reimplemented from SimpleKeyingInterface.

Definition at line 45 of file modes.h.

References BlockSize().

void SimpleKeyingInterface::SetKeyWithRounds ( const byte *  key,
size_t  length,
int  rounds 
) [inherited]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
rounds the number of rounds to apply the transformation function, if applicable

SetKeyWithRounds calls SetKey with an NameValuePairs object that just specifies rounds. rounds is an integer parameter, and -1 means use the default number of rounds.

Definition at line 106 of file cryptlib.cpp.

References MakeParameters(), Rounds(), and SimpleKeyingInterface::SetKey().

void SimpleKeyingInterface::SetKeyWithIV ( const byte *  key,
size_t  length,
const byte *  iv,
size_t  ivLength 
) [inherited]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
iv the intiialization vector to use when keying the object
ivLength the size of the iv, in bytes

SetKeyWithIV calls SetKey with an NameValuePairs object that just specifies iv. iv is a byte buffer with size ivLength.

Definition at line 111 of file cryptlib.cpp.

References IV(), MakeParameters(), and SimpleKeyingInterface::SetKey().

void SimpleKeyingInterface::SetKeyWithIV ( const byte *  key,
size_t  length,
const byte *  iv 
) [inline, inherited]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
iv the intiialization vector to use when keying the object

SetKeyWithIV calls SetKey with an NameValuePairs object that just specifies iv. iv is a byte buffer, and it must have a size IVSize.

Definition at line 551 of file cryptlib.h.

References SimpleKeyingInterface::SetKeyWithIV().

Referenced by SimpleKeyingInterface::SetKeyWithIV().

bool SimpleKeyingInterface::IsResynchronizable (  )  const [inline, inherited]

returns whether the 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 573 of file cryptlib.h.

Referenced by BlockOrientedCipherModeBase::UncheckedSetKey().

void SimpleKeyingInterface::GetNextIV ( RandomNumberGenerator rng,
byte *  iv 
) [virtual, inherited]

Gets a secure IV for the next message.

Parameters:
rng a RandomNumberGenerator to produce keying material
iv a block of bytes to receive the IV

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.

key must be at least IVSize() in length.

Note:
This method is not implemented on decryption objects.

Reimplemented in VMAC_Base.

Definition at line 176 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateBlock(), and SimpleKeyingInterface::IVSize().

StreamTransformation& StreamTransformation::Ref (  )  [inline, inherited]

Provides a reference to this object.

Returns:
A reference to this object

Useful for passing a temporary object to a function that takes a non-const reference

Definition at line 758 of file cryptlib.h.

virtual unsigned int StreamTransformation::GetOptimalBlockSizeUsed (  )  const [inline, virtual, inherited]

Provides the number of bytes used in the current block when processing at optimal block size.

Returns:
the number of bytes used in the current block when processing at the optimal block size

Definition at line 773 of file cryptlib.h.

void StreamTransformation::ProcessLastBlock ( byte *  outString,
const byte *  inString,
size_t  length 
) [virtual, inherited]

Encrypt or decrypt the last block of data.

Parameters:
outString the output byte buffer
inString the input byte buffer
length the size of the input and output byte buffers, in bytes ProcessLastBlock is used when the last block of data is special. Currently the only use of this function is CBC-CTS mode.

Reimplemented in CBC_CTS_Encryption, and CBC_CTS_Decryption.

Definition at line 247 of file cryptlib.cpp.

References Algorithm::AlgorithmName(), StreamTransformation::MandatoryBlockSize(), StreamTransformation::MinLastBlockSize(), and StreamTransformation::ProcessData().

void StreamTransformation::ProcessString ( byte *  inoutString,
size_t  length 
) [inline, inherited]

Encrypt or decrypt a string of bytes.

Parameters:
inoutString the string to process
length the size of the inoutString, in bytes

Internally, the base class implementation calls ProcessData().

Definition at line 801 of file cryptlib.h.

Referenced by AuthenticatedSymmetricCipher::DecryptAndVerify(), and AuthenticatedSymmetricCipher::EncryptAndAuthenticate().

void StreamTransformation::ProcessString ( byte *  outString,
const byte *  inString,
size_t  length 
) [inline, inherited]

Encrypt or decrypt a string of bytes.

Parameters:
outString the output string to process
inString the input string to process
length the size of the input and output strings, in bytes

Internally, the base class implementation calls ProcessData().

Definition at line 809 of file cryptlib.h.

byte StreamTransformation::ProcessByte ( byte  input  )  [inline, inherited]

Encrypt or decrypt a byte.

Parameters:
input the input byte to process

Internally, the base class implementation calls ProcessData() with a size of 1.

Definition at line 815 of file cryptlib.h.

virtual void StreamTransformation::Seek ( lword  pos  )  [inline, virtual, inherited]

Seek to an absolute position.

Parameters:
pos position to seek
Exceptions:
NotImplemented 

The base class implementation throws NotImplemented. The function asserts IsRandomAccess() in debug builds.

Reimplemented in BlumBlumShub.

Definition at line 827 of file cryptlib.h.

virtual std::string Algorithm::AlgorithmName (  )  const [inline, virtual, inherited]

Provides the name of this algorithm.

Returns:
the standard algorithm name

The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.

Note:
AlgorithmName is not universally implemented yet

Reimplemented in Adler32, CCM_Base, CRC32, ClassNullRNG, AuthenticatedSymmetricCipher, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, EAX_Base, StreamTransformationFilter, HashFilter, HashVerificationFilter, AuthenticatedDecryptionFilter, SignerFilter, SignatureVerificationFilter, GCM_Base, HMAC< T >, RDRAND, RDSEED, SHA3, BitBucket, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

Referenced by BufferedTransformation::ChannelCreatePutSpace(), BufferedTransformation::ChannelFlush(), BufferedTransformation::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelPut2(), TF_DecryptorBase::Decrypt(), TF_EncryptorBase::Encrypt(), StreamTransformation::ProcessLastBlock(), and PK_DefaultDecryptionFilter::Put2().

virtual Clonable* Clonable::Clone (  )  const [inline, virtual, inherited]

Copies this object.

Returns:
a copy of this object
Exceptions:
NotImplemented 
Note:
this is not implemented by most classes
See also:
NotCopyable

Definition at line 464 of file cryptlib.h.


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

Generated on 24 Mar 2016 for Crypto++ by  doxygen 1.6.1