Crypto++  8.2
Free C++ class library of cryptographic schemes
List of all members
XTS_Final< CIPHER > Class Template Reference

XTS block cipher mode of operation implementation. More...

+ Inheritance diagram for XTS_Final< CIPHER >:

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 Member Functions inherited from XTS_ModeBase
std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm. More...
 
size_t MinKeyLength () const
 Returns smallest valid key length. More...
 
size_t MaxKeyLength () const
 Returns largest valid key length. More...
 
size_t DefaultKeyLength () const
 Returns default key length. More...
 
size_t GetValidKeyLength (size_t n) const
 Returns a valid key length for the algorithm. More...
 
bool IsValidKeyLength (size_t keylength) const
 Returns whether keylength is a valid key length. More...
 
void ThrowIfInvalidKeyLength (size_t length)
 Validates the key length. More...
 
unsigned int BlockSize () const
 Provides the block size of the cipher. More...
 
unsigned int GetOptimalBlockSize () const
 Provides the input block size most efficient for this cipher. More...
 
unsigned int MinLastBlockSize () const
 Provides the size of the last block. More...
 
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
void ThrowIfInvalidBlockSize (size_t length)
 Validates the block size. More...
 
void SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
 Sets or reset the key of this object. More...
 
IV_Requirement IVRequirement () const
 Minimal requirement for secure IVs. More...
 
void Resynchronize (const byte *iv, int ivLength=-1)
 Resynchronize with an IV. More...
 
void ProcessData (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt an array of bytes. More...
 
size_t ProcessLastBlock (byte *outString, size_t outLength, const byte *inString, size_t inLength)
 Encrypt or decrypt the last block of data. More...
 
void Resynchronize (word64 sector, ByteOrder order=BIG_ENDIAN_ORDER)
 Resynchronize the cipher. More...
 
- 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. More...
 
unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher. More...
 
bool IsRandomAccess () const
 Determines whether the cipher supports random access. More...
 
bool IsSelfInverting () const
 Determines whether the cipher is self-inverting. More...
 
bool IsForwardTransformation () const
 Determines if the cipher is being operated in its forward direction. More...
 
- Public Member Functions inherited from CipherModeBase
unsigned int IVSize () const
 Returns length of the IV accepted by this object. More...
 
void SetCipher (BlockCipher &cipher)
 Set external block cipher. More...
 
void SetCipherWithIV (BlockCipher &cipher, const byte *iv, int feedbackSize=0)
 Set external block cipher and IV. More...
 
- Public Member Functions inherited from SimpleKeyingInterface
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...
 
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. 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 GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Retrieves a secure IV for the next message. More...
 
- Public Member Functions inherited from StreamTransformation
StreamTransformationRef ()
 Provides a reference to this object. More...
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher. More...
 
virtual unsigned int GetOptimalBlockSizeUsed () const
 Provides the number of bytes used in the current block when processing at optimal block size. More...
 
virtual bool IsLastBlockSpecial () const
 Determines if the last block receives special processing. More...
 
void ProcessString (byte *inoutString, size_t length)
 Encrypt or decrypt a string of bytes. More...
 
void ProcessString (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt a string of bytes. More...
 
byte ProcessByte (byte input)
 Encrypt or decrypt a byte. More...
 
virtual void Seek (lword pos)
 Seek to an absolute position. More...
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms. More...
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object. More...
 
- Static Public Member Functions inherited from XTS_ModeBase
static const char * StaticAlgorithmName ()
 The algorithm name. More...
 

Detailed Description

template<class CIPHER>
class XTS_Final< CIPHER >

XTS block cipher mode of operation implementation.

Template Parameters
CIPHERBlockCipher derived class or type

XTS_Final() provides access to CIPHER in base class XTS_ModeBase() through an interface. AccessBlockCipher() and AccessTweakCipher() allow the XTS_ModeBase() base class to access the user's block cipher without recompiling the library.

If CRYPTOPP_XTS_WIDE_BLOCK_CIPHERS is 0, then CIPHER must be a 16-byte block cipher. If CRYPTOPP_XTS_WIDE_BLOCK_CIPHERS is non-zero then CIPHER can be 16, 32, 64, or 128-byte block cipher. There is risk involved with using XTS with wider block ciphers. According to Phillip Rogaway, "The narrow width of the underlying PRP and the poor treatment of fractional final blocks are problems." To enable wide block cipher support define CRYPTOPP_XTS_WIDE_BLOCK_CIPHERS to non-zero.

See also
Modes of Operation on the Crypto++ wiki, Evaluation of Some Blockcipher Modes of Operation, Recommendation for Block Cipher Modes of Operation: The XTS-AES Mode for Confidentiality on Storage Devices, IEEE P1619-2007 and IEEE P1619/XTS, inconsistent reference implementation and test vectors.
Since
Crypto++ 8.3

Definition at line 175 of file xts.h.


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