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

Public Member Functions

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...
 
- Public Member Functions inherited from SimpleKeyingInterface
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
 Minimal requirement for secure IVs. More...
 
bool IsResynchronizable () const
 Determines if the object can be resynchronized. More...
 
bool CanUseRandomIVs () const
 Determines if the object can use random IVs. More...
 
bool CanUsePredictableIVs () const
 Determines if the object can use random but possibly predictable IVs. More...
 
bool CanUseStructuredIVs () const
 Determines if the object can use structured IVs returns whether the object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV), false otherwise.
 
virtual unsigned int IVSize () const
 Returns length of the IV accepted by this object. More...
 
unsigned int DefaultIVLength () const
 Provides the default size of an IV. More...
 
virtual unsigned int MinIVLength () const
 Provides the minimum size of an IV. More...
 
virtual unsigned int MaxIVLength () const
 Provides the maximum size of an IV. More...
 
virtual void Resynchronize (const byte *iv, int ivLength=-1)
 Resynchronize with an IV. More...
 
virtual void GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Retrieves a secure IV for the next message. More...
 
- Public Member Functions inherited from BlockTransformation
virtual void ProcessAndXorBlock (const byte *inBlock, const byte *xorBlock, byte *outBlock) const =0
 Encrypt or decrypt a block. 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
 Provides the direction of the cipher. More...
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms. More...
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object. More...
 

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

Detailed Description

Definition at line 19 of file safer.h.

Member Function Documentation

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

Provides input and output data alignment for optimal performance.

Returns
the input data alignment that provides optimal performance

Reimplemented from BlockTransformation.

Definition at line 22 of file safer.h.

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

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.


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