Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Types | Public Member Functions | List of all members
SAFER::Enc Class Referenceabstract
+ Inheritance diagram for SAFER::Enc:

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...
 
enum  FlagsForAdvancedProcessBlocks {
  BT_InBlockIsCounter =1, BT_DontIncrementInOutPointers =2, BT_XorInput =4, BT_ReverseDirection =8,
  BT_AllowParallel =16
}
 Bit flags that control AdvancedProcessBlocks() behavior. More...
 

Public Member Functions

void ProcessAndXorBlock (const byte *inBlock, const byte *xorBlock, byte *outBlock) const
 Encrypt or decrypt a block. More...
 
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
void UncheckedSetKey (const byte *userkey, unsigned int length, const NameValuePairs &params)
 Sets the key for this object without performing parameter validation. More...
 
virtual size_t MinKeyLength () const =0
 Returns smallest valid key length in bytes.
 
virtual size_t MaxKeyLength () const =0
 Returns largest valid key length in bytes.
 
virtual size_t DefaultKeyLength () const =0
 Returns default (recommended) key length in bytes.
 
virtual size_t GetValidKeyLength (size_t n) const =0
 
virtual bool IsValidKeyLength (size_t keylength) const
 Returns whether keylength is a valid key length. More...
 
virtual void SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
 Sets or reset the key of this object. More...
 
void SetKeyWithRounds (const byte *key, size_t length, int rounds)
 Sets or reset the key of this object. More...
 
void SetKeyWithIV (const byte *key, size_t length, const byte *iv, size_t ivLength)
 Sets or reset the key of this object. More...
 
void SetKeyWithIV (const byte *key, size_t length, const byte *iv)
 Sets or reset the key of this object. More...
 
virtual IV_Requirement IVRequirement () const =0
 returns the minimal requirement for secure IVs
 
bool IsResynchronizable () const
 returns whether the object can be resynchronized (i.e. supports initialization vectors) More...
 
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)
 
virtual unsigned int IVSize () const
 Returns length of the IV accepted by this object. More...
 
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 Resynchronize (const byte *iv, int ivLength=-1)
 resynchronize with an IV. ivLength=-1 means use IVSize()
 
virtual void GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Gets a secure IV for the next message. More...
 
void ProcessBlock (const byte *inBlock, byte *outBlock) const
 Encrypt or decrypt a block. More...
 
void ProcessBlock (byte *inoutBlock) const
 Encrypt or decrypt a block in place. More...
 
virtual unsigned int BlockSize () const =0
 Provides the block size of the cipher. More...
 
virtual bool IsPermutation () const
 returns true if this is a permutation (i.e. there is an inverse transformation)
 
virtual bool IsForwardTransformation () const =0
 Determines if the cipher is being operated in its forward direction. More...
 
virtual unsigned int OptimalNumberOfParallelBlocks () const
 Determines the number of blocks that can be processed in parallel. More...
 
virtual size_t AdvancedProcessBlocks (const byte *inBlocks, const byte *xorBlocks, byte *outBlocks, size_t length, word32 flags) const
 Encrypt and xor multiple blocks using additional flags. More...
 
CipherDir GetCipherDirection () const
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
virtual ClonableClone () const
 Copies this object. More...
 

Detailed Description

Definition at line 32 of file safer.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.

Bit flags that control AdvancedProcessBlocks() behavior.

Enumerator
BT_InBlockIsCounter 

inBlock is a counter

BT_DontIncrementInOutPointers 

should not modify block pointers

BT_ReverseDirection 

perform the transformation in reverse

Definition at line 719 of file cryptlib.h.

Member Function Documentation

void SAFER::Enc::ProcessAndXorBlock ( const byte *  inBlock,
const byte *  xorBlock,
byte *  outBlock 
) const
virtual

Encrypt or decrypt a block.

Parameters
inBlockthe input message before processing
outBlockthe output message after processing
xorBlockan optional XOR mask

ProcessAndXorBlock encrypts or decrypts inBlock, xor with xorBlock, and write to outBlock.

The size of the block is determined by the block cipher and its documentation. Use BLOCKSIZE at compile time, or BlockSize() at runtime.

Note
The message can be transformed in-place, or the buffers must not overlap
See also
FixedBlockSize, BlockCipherFinal from seckey.h and BlockSize()

Implements BlockTransformation.

Definition at line 105 of file safer.cpp.

unsigned int SAFER::Base::OptimalDataAlignment ( ) const
inlinevirtualinherited

Provides input and output data alignment for optimal performance.

Returns
the input data alignment that provides optimal performance

Reimplemented from BlockTransformation.

Definition at line 21 of file safer.h.

void SAFER::Base::UncheckedSetKey ( const byte *  key,
unsigned int  length,
const NameValuePairs params 
)
virtualinherited

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 58 of file safer.cpp.

References NameValuePairs::GetIntValueWithDefault(), SecBlock< T, A >::New(), rotlFixed(), and Name::Rounds().

virtual size_t SimpleKeyingInterface::GetValidKeyLength ( size_t  n) const
pure virtualinherited
virtual bool SimpleKeyingInterface::IsValidKeyLength ( size_t  keylength) const
inlinevirtualinherited

Returns whether keylength is a valid key length.

Internally the function calls GetValidKeyLength()

Reimplemented in CipherModeBase, GCM_Base, EAX_Base, and CCM_Base.

Definition at line 515 of file cryptlib.h.

References g_nullNameValuePairs.

void SimpleKeyingInterface::SetKey ( const byte *  key,
size_t  length,
const NameValuePairs params = g_nullNameValuePairs 
)
virtualinherited

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 that cannot be passed directly through the constructor

Reimplemented in ECB_OneWay, and AuthenticatedSymmetricCipherBase.

Definition at line 100 of file cryptlib.cpp.

Referenced by HKDF< T >::DeriveKey(), RandomPool::GenerateIntoBufferedTransformation(), TestDataNameValuePairs::GetVoidValue(), CMAC_Base::UncheckedSetKey(), CBC_MAC_Base::UncheckedSetKey(), VMAC_Base::UncheckedSetKey(), and BlockOrientedCipherModeBase::UncheckedSetKey().

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

Sets or reset the key of this object.

Parameters
keythe key to use when keying the object
lengththe size of the key, in bytes
roundsthe 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(), and Name::Rounds().

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
keythe key to use when keying the object
lengththe size of the key, in bytes
ivthe intiialization vector to use when keying the object
ivLengththe 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 NameValuePairs::GetValue(), IntToString(), Name::IV(), and MakeParameters().

void SimpleKeyingInterface::SetKeyWithIV ( const byte *  key,
size_t  length,
const byte *  iv 
)
inlineinherited

Sets or reset the key of this object.

Parameters
keythe key to use when keying the object
lengththe size of the key, in bytes
ivthe 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.

bool SimpleKeyingInterface::IsResynchronizable ( ) const
inlineinherited

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 CipherModeBase::IVSize(), and BlockOrientedCipherModeBase::UncheckedSetKey().

virtual unsigned int SimpleKeyingInterface::IVSize ( ) const
inlinevirtualinherited
void SimpleKeyingInterface::GetNextIV ( RandomNumberGenerator rng,
byte *  iv 
)
virtualinherited

Gets a secure IV for the next message.

Parameters
rnga RandomNumberGenerator to produce keying material
iva 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().

Referenced by VMAC_Base::GetNextIV(), and FilterTester::Put2().

void BlockTransformation::ProcessBlock ( const byte *  inBlock,
byte *  outBlock 
) const
inlineinherited

Encrypt or decrypt a block.

Parameters
inBlockthe input message before processing
outBlockthe output message after processing

ProcessBlock encrypts or decrypts inBlock and write to outBlock.

The size of the block is determined by the block cipher and its documentation. Use BLOCKSIZE at compile time, or BlockSize() at runtime.

See also
FixedBlockSize, BlockCipherFinal from seckey.h and BlockSize()
Note
The message can be transformed in-place, or the buffers must not overlap

Definition at line 685 of file cryptlib.h.

Referenced by RandomPool::GenerateIntoBufferedTransformation(), X917RNG::GenerateIntoBufferedTransformation(), CBC_CTS_Encryption::ProcessLastBlock(), CBC_CTS_Decryption::ProcessLastBlock(), VMAC_Base::Resynchronize(), CBC_MAC_Base::TruncatedFinal(), CMAC_Base::UncheckedSetKey(), VMAC_Base::UncheckedSetKey(), CMAC_Base::Update(), and X917RNG::X917RNG().

void BlockTransformation::ProcessBlock ( byte *  inoutBlock) const
inlineinherited

Encrypt or decrypt a block in place.

Parameters
inoutBlockthe input message before processing

ProcessBlock encrypts or decrypts inoutBlock in-place.

The size of the block is determined by the block cipher and its documentation. Use BLOCKSIZE at compile time, or BlockSize() at runtime.

See also
FixedBlockSize, BlockCipherFinal from seckey.h and BlockSize()

Definition at line 694 of file cryptlib.h.

References Name::BlockSize().

virtual unsigned int BlockTransformation::BlockSize ( ) const
pure virtualinherited

Provides the block size of the cipher.

Returns
the block size of the cipher, in bytes

Referenced by CMAC_Base::TruncatedFinal(), CMAC_Base::UncheckedSetKey(), VMAC_Base::UncheckedSetKey(), CMAC_Base::Update(), and CBC_MAC_Base::Update().

virtual bool BlockTransformation::IsForwardTransformation ( ) const
pure virtualinherited

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

Returns
true if DIR is ENCRYPTION, false otherwise
See also
IsForwardTransformation(), IsPermutation(), GetCipherDirection()
virtual unsigned int BlockTransformation::OptimalNumberOfParallelBlocks ( ) const
inlinevirtualinherited

Determines the number of blocks that can be processed in parallel.

Returns
the number of blocks that can be processed in parallel, for bit-slicing implementations

Bit-slicing is often used to improve throughput and minimize timing attacks.

Definition at line 716 of file cryptlib.h.

size_t BlockTransformation::AdvancedProcessBlocks ( const byte *  inBlocks,
const byte *  xorBlocks,
byte *  outBlocks,
size_t  length,
word32  flags 
) const
virtualinherited

Encrypt and xor multiple blocks using additional flags.

Parameters
inBlocksthe input message before processing
xorBlocksan optional XOR mask
outBlocksthe output message after processing
lengththe size of the blocks, in bytes
flagsadditional flags to control processing

Encrypt and xor multiple blocks according to FlagsForAdvancedProcessBlocks flags.

Note
If BT_InBlockIsCounter is set, then the last byte of inBlocks may be modified.

Definition at line 181 of file cryptlib.cpp.

References Name::BlockSize(), and xorbuf().

Referenced by ECB_OneWay::ProcessData(), CBC_Encryption::ProcessData(), CBC_Decryption::ProcessData(), CMAC_Base::TruncatedFinal(), VMAC_Base::UncheckedSetKey(), CBC_MAC_Base::Update(), and CMAC_Base::Update().

CipherDir BlockTransformation::GetCipherDirection ( ) const
inlineinherited
virtual std::string Algorithm::AlgorithmName ( ) const
inlinevirtualinherited

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 AuthenticatedSymmetricCipher, SignatureVerificationFilter, SignerFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, HashFilter, StreamTransformationFilter, ClassNullRNG, BitBucket, RDSEED, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, HMAC< T >, RDRAND, CRC32, GCM_Base, Adler32, EAX_Base, CCM_Base, SHA3, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

Referenced by VariableRounds< 6, 2 >::StaticGetDefaultRounds().

virtual Clonable* Clonable::Clone ( ) const
inlinevirtualinherited

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: