// modes.h - originally written and placed in the public domain by Wei Dai /// \file modes.h /// \brief Classes for block cipher modes of operation #ifndef CRYPTOPP_MODES_H #define CRYPTOPP_MODES_H #include "cryptlib.h" #include "secblock.h" #include "misc.h" #include "strciphr.h" #include "argnames.h" #include "algparam.h" // Issue 340 #if CRYPTOPP_GCC_DIAGNOSTIC_AVAILABLE # pragma GCC diagnostic push # pragma GCC diagnostic ignored "-Wconversion" # pragma GCC diagnostic ignored "-Wsign-conversion" #endif #if CRYPTOPP_MSC_VERSION # pragma warning(push) # pragma warning(disable: 4231 4275) # if (CRYPTOPP_MSC_VERSION >= 1400) # pragma warning(disable: 6011 6386 28193) # endif #endif NAMESPACE_BEGIN(CryptoPP) /// \class CipherModeDocumentation /// \brief Block cipher mode of operation information /// \details Each class derived from this one defines two types, Encryption and Decryption, /// both of which implement the SymmetricCipher interface. /// For each mode there are two classes, one of which is a template class, /// and the other one has a name that ends in "_ExternalCipher". /// The "external cipher" mode objects hold a reference to the underlying block cipher, /// instead of holding an instance of it. The reference must be passed in to the constructor. /// For the "cipher holder" classes, the CIPHER template parameter should be a class /// derived from BlockCipherDocumentation, for example DES or AES. /// \details See NIST SP 800-38A for definitions of these modes. See /// AuthenticatedSymmetricCipherDocumentation for authenticated encryption modes. struct CipherModeDocumentation : public SymmetricCipherDocumentation { }; /// \class CipherModeBase /// \brief Block cipher mode of operation information class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CipherModeBase : public SymmetricCipher { public: virtual ~CipherModeBase() {} size_t MinKeyLength() const {return m_cipher->MinKeyLength();} size_t MaxKeyLength() const {return m_cipher->MaxKeyLength();} size_t DefaultKeyLength() const {return m_cipher->DefaultKeyLength();} size_t GetValidKeyLength(size_t n) const {return m_cipher->GetValidKeyLength(n);} bool IsValidKeyLength(size_t n) const {return m_cipher->IsValidKeyLength(n);} unsigned int OptimalDataAlignment() const {return m_cipher->OptimalDataAlignment();} unsigned int IVSize() const {return BlockSize();} virtual IV_Requirement IVRequirement() const =0; void SetCipher(BlockCipher &cipher) { this->ThrowIfResynchronizable(); this->m_cipher = &cipher; this->ResizeBuffers(); } void SetCipherWithIV(BlockCipher &cipher, const byte *iv, int feedbackSize = 0) { this->ThrowIfInvalidIV(iv); this->m_cipher = &cipher; this->ResizeBuffers(); this->SetFeedbackSize(feedbackSize); if (this->IsResynchronizable()) this->Resynchronize(iv); } protected: CipherModeBase() : m_cipher(NULLPTR) {} inline unsigned int BlockSize() const {CRYPTOPP_ASSERT(m_register.size() > 0); return (unsigned int)m_register.size();} virtual void SetFeedbackSize(unsigned int feedbackSize) { if (!(feedbackSize == 0 || feedbackSize == BlockSize())) throw InvalidArgument("CipherModeBase: feedback size cannot be specified for this cipher mode"); } virtual void ResizeBuffers(); BlockCipher *m_cipher; AlignedSecByteBlock m_register; }; /// \class ModePolicyCommonTemplate /// \brief Block cipher mode of operation common operations /// \tparam POLICY_INTERFACE common operations template class CRYPTOPP_NO_VTABLE ModePolicyCommonTemplate : public CipherModeBase, public POLICY_INTERFACE { unsigned int GetAlignment() const {return m_cipher->OptimalDataAlignment();} void CipherSetKey(const NameValuePairs ¶ms, const byte *key, size_t length); }; template void ModePolicyCommonTemplate::CipherSetKey(const NameValuePairs ¶ms, const byte *key, size_t length) { m_cipher->SetKey(key, length, params); ResizeBuffers(); int feedbackSize = params.GetIntValueWithDefault(Name::FeedbackSize(), 0); SetFeedbackSize(feedbackSize); } /// \class CFB_ModePolicy /// \brief CFB block cipher mode of operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CFB_ModePolicy : public ModePolicyCommonTemplate { public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "CFB";} virtual ~CFB_ModePolicy() {} IV_Requirement IVRequirement() const {return RANDOM_IV;} protected: unsigned int GetBytesPerIteration() const {return m_feedbackSize;} byte * GetRegisterBegin() {return m_register + BlockSize() - m_feedbackSize;} bool CanIterate() const {return m_feedbackSize == BlockSize();} void Iterate(byte *output, const byte *input, CipherDir dir, size_t iterationCount); void TransformRegister(); void CipherResynchronize(const byte *iv, size_t length); void SetFeedbackSize(unsigned int feedbackSize); void ResizeBuffers(); SecByteBlock m_temp; unsigned int m_feedbackSize; }; inline void CopyOrZero(void *dest, size_t d, const void *src, size_t s) { CRYPTOPP_ASSERT(dest); CRYPTOPP_ASSERT(d >= s); if (src) memcpy_s(dest, d, src, s); else memset(dest, 0, d); } /// \class OFB_ModePolicy /// \brief OFB block cipher mode of operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE OFB_ModePolicy : public ModePolicyCommonTemplate { public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "OFB";} bool CipherIsRandomAccess() const {return false;} IV_Requirement IVRequirement() const {return UNIQUE_IV;} private: unsigned int GetBytesPerIteration() const {return BlockSize();} unsigned int GetIterationsToBuffer() const {return m_cipher->OptimalNumberOfParallelBlocks();} void WriteKeystream(byte *keystreamBuffer, size_t iterationCount); void CipherResynchronize(byte *keystreamBuffer, const byte *iv, size_t length); }; /// \class CTR_ModePolicy /// \brief CTR block cipher mode of operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CTR_ModePolicy : public ModePolicyCommonTemplate { public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "CTR";} virtual ~CTR_ModePolicy() {} bool CipherIsRandomAccess() const {return true;} IV_Requirement IVRequirement() const {return RANDOM_IV;} protected: virtual void IncrementCounterBy256(); unsigned int GetAlignment() const {return m_cipher->OptimalDataAlignment();} unsigned int GetBytesPerIteration() const {return BlockSize();} unsigned int GetIterationsToBuffer() const {return m_cipher->OptimalNumberOfParallelBlocks();} void WriteKeystream(byte *buffer, size_t iterationCount) {OperateKeystream(WRITE_KEYSTREAM, buffer, NULLPTR, iterationCount);} bool CanOperateKeystream() const {return true;} void OperateKeystream(KeystreamOperation operation, byte *output, const byte *input, size_t iterationCount); void CipherResynchronize(byte *keystreamBuffer, const byte *iv, size_t length); void SeekToIteration(lword iterationCount); AlignedSecByteBlock m_counterArray; }; /// \class BlockOrientedCipherModeBase /// \brief Block cipher mode of operation default implementation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE BlockOrientedCipherModeBase : public CipherModeBase { public: virtual ~BlockOrientedCipherModeBase() {} void UncheckedSetKey(const byte *key, unsigned int length, const NameValuePairs ¶ms); unsigned int MandatoryBlockSize() const {return BlockSize();} bool IsRandomAccess() const {return false;} bool IsSelfInverting() const {return false;} bool IsForwardTransformation() const {return m_cipher->IsForwardTransformation();} void Resynchronize(const byte *iv, int length=-1) {memcpy_s(m_register, m_register.size(), iv, ThrowIfInvalidIVLength(length));} protected: bool RequireAlignedInput() const {return true;} virtual void ResizeBuffers(); SecByteBlock m_buffer; }; /// \class ECB_OneWay /// \brief ECB block cipher mode of operation default implementation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE ECB_OneWay : public BlockOrientedCipherModeBase { public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "ECB";} void SetKey(const byte *key, size_t length, const NameValuePairs ¶ms = g_nullNameValuePairs) {m_cipher->SetKey(key, length, params); BlockOrientedCipherModeBase::ResizeBuffers();} IV_Requirement IVRequirement() const {return NOT_RESYNCHRONIZABLE;} unsigned int OptimalBlockSize() const {return BlockSize() * m_cipher->OptimalNumberOfParallelBlocks();} void ProcessData(byte *outString, const byte *inString, size_t length); }; /// \class CBC_ModeBase /// \brief CBC block cipher mode of operation default implementation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_ModeBase : public BlockOrientedCipherModeBase { public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "CBC";} IV_Requirement IVRequirement() const {return UNPREDICTABLE_RANDOM_IV;} bool RequireAlignedInput() const {return false;} unsigned int MinLastBlockSize() const {return 0;} }; /// \class CBC_Encryption /// \brief CBC block cipher mode of operation encryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_Encryption : public CBC_ModeBase { public: void ProcessData(byte *outString, const byte *inString, size_t length); }; /// \class CBC_CTS_Encryption /// \brief CBC-CTS block cipher mode of operation encryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_CTS_Encryption : public CBC_Encryption { public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "CBC/CTS";} void SetStolenIV(byte *iv) {m_stolenIV = iv;} unsigned int MinLastBlockSize() const {return BlockSize()+1;} size_t ProcessLastBlock(byte *outString, size_t outLength, const byte *inString, size_t inLength); protected: void UncheckedSetKey(const byte *key, unsigned int length, const NameValuePairs ¶ms) { CBC_Encryption::UncheckedSetKey(key, length, params); m_stolenIV = params.GetValueWithDefault(Name::StolenIV(), (byte *)NULLPTR); } byte *m_stolenIV; }; /// \class CBC_Decryption /// \brief CBC block cipher mode of operation decryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_Decryption : public CBC_ModeBase { public: virtual ~CBC_Decryption() {} void ProcessData(byte *outString, const byte *inString, size_t length); protected: virtual void ResizeBuffers(); AlignedSecByteBlock m_temp; }; /// \class CBC_CTS_Decryption /// \brief CBC-CTS block cipher mode of operation decryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_CTS_Decryption : public CBC_Decryption { public: unsigned int MinLastBlockSize() const {return BlockSize()+1;} size_t ProcessLastBlock(byte *outString, size_t outLength, const byte *inString, size_t inLength); }; /// \class CipherModeFinalTemplate_CipherHolder /// \brief Block cipher mode of operation aggregate template class CipherModeFinalTemplate_CipherHolder : protected ObjectHolder, public AlgorithmImpl > { public: static std::string CRYPTOPP_API StaticAlgorithmName() {return CIPHER::StaticAlgorithmName() + "/" + BASE::StaticAlgorithmName();} CipherModeFinalTemplate_CipherHolder() { this->m_cipher = &this->m_object; this->ResizeBuffers(); } CipherModeFinalTemplate_CipherHolder(const byte *key, size_t length) { this->m_cipher = &this->m_object; this->SetKey(key, length); } CipherModeFinalTemplate_CipherHolder(const byte *key, size_t length, const byte *iv) { this->m_cipher = &this->m_object; this->SetKey(key, length, MakeParameters(Name::IV(), ConstByteArrayParameter(iv, this->m_cipher->BlockSize()))); } CipherModeFinalTemplate_CipherHolder(const byte *key, size_t length, const byte *iv, int feedbackSize) { this->m_cipher = &this->m_object; this->SetKey(key, length, MakeParameters(Name::IV(), ConstByteArrayParameter(iv, this->m_cipher->BlockSize()))(Name::FeedbackSize(), feedbackSize)); } }; /// \class CipherModeFinalTemplate_ExternalCipher /// \tparam BASE CipherModeFinalTemplate_CipherHolder base class /// \details Base class for external mode cipher combinations template class CipherModeFinalTemplate_ExternalCipher : public BASE { public: CipherModeFinalTemplate_ExternalCipher() {} CipherModeFinalTemplate_ExternalCipher(BlockCipher &cipher) {this->SetCipher(cipher);} CipherModeFinalTemplate_ExternalCipher(BlockCipher &cipher, const byte *iv, int feedbackSize = 0) {this->SetCipherWithIV(cipher, iv, feedbackSize);} std::string AlgorithmName() const {return (this->m_cipher ? this->m_cipher->AlgorithmName() + "/" : std::string("")) + BASE::StaticAlgorithmName();} }; CRYPTOPP_DLL_TEMPLATE_CLASS CFB_CipherTemplate >; CRYPTOPP_DLL_TEMPLATE_CLASS CFB_EncryptionTemplate >; CRYPTOPP_DLL_TEMPLATE_CLASS CFB_DecryptionTemplate >; /// \class CFB_Mode /// \brief CFB block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. template struct CFB_Mode : public CipherModeDocumentation { typedef CipherModeFinalTemplate_CipherHolder > > > Encryption; typedef CipherModeFinalTemplate_CipherHolder > > > Decryption; }; /// \class CFB_Mode_ExternalCipher /// \brief CFB mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. struct CFB_Mode_ExternalCipher : public CipherModeDocumentation { typedef CipherModeFinalTemplate_ExternalCipher > > > Encryption; typedef CipherModeFinalTemplate_ExternalCipher > > > Decryption; }; /// \class CFB_FIPS_Mode /// \brief CFB block cipher mode of operation providing FIPS validated cryptography. /// \details Requires full block plaintext according to FIPS 800-38A /// \sa Modes of Operation /// on the Crypto++ wiki. template struct CFB_FIPS_Mode : public CipherModeDocumentation { typedef CipherModeFinalTemplate_CipherHolder > > > > Encryption; typedef CipherModeFinalTemplate_CipherHolder > > > > Decryption; }; /// \class CFB_FIPS_Mode_ExternalCipher /// \brief CFB mode, external cipher, providing FIPS validated cryptography. /// \details Requires full block plaintext according to FIPS 800-38A /// \sa Modes of Operation /// on the Crypto++ wiki. struct CFB_FIPS_Mode_ExternalCipher : public CipherModeDocumentation { typedef CipherModeFinalTemplate_ExternalCipher > > > > Encryption; typedef CipherModeFinalTemplate_ExternalCipher > > > > Decryption; }; CRYPTOPP_DLL_TEMPLATE_CLASS AdditiveCipherTemplate >; /// \class OFB_Mode /// \brief OFB block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. template struct OFB_Mode : public CipherModeDocumentation { typedef CipherModeFinalTemplate_CipherHolder > > > Encryption; typedef Encryption Decryption; }; /// \class OFB_Mode_ExternalCipher /// \brief OFB mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. struct OFB_Mode_ExternalCipher : public CipherModeDocumentation { typedef CipherModeFinalTemplate_ExternalCipher > > > Encryption; typedef Encryption Decryption; }; CRYPTOPP_DLL_TEMPLATE_CLASS AdditiveCipherTemplate >; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher > > >; /// \class CTR_Mode /// \brief CTR block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. template struct CTR_Mode : public CipherModeDocumentation { typedef CipherModeFinalTemplate_CipherHolder > > > Encryption; typedef Encryption Decryption; }; /// \class CTR_Mode_ExternalCipher /// \brief CTR mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. struct CTR_Mode_ExternalCipher : public CipherModeDocumentation { typedef CipherModeFinalTemplate_ExternalCipher > > > Encryption; typedef Encryption Decryption; }; /// \class ECB_Mode /// \brief ECB block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. template struct ECB_Mode : public CipherModeDocumentation { typedef CipherModeFinalTemplate_CipherHolder Encryption; typedef CipherModeFinalTemplate_CipherHolder Decryption; }; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; /// \class ECB_Mode_ExternalCipher /// \brief ECB mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. struct ECB_Mode_ExternalCipher : public CipherModeDocumentation { typedef CipherModeFinalTemplate_ExternalCipher Encryption; typedef Encryption Decryption; }; /// \class CBC_Mode /// \brief CBC block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. template struct CBC_Mode : public CipherModeDocumentation { typedef CipherModeFinalTemplate_CipherHolder Encryption; typedef CipherModeFinalTemplate_CipherHolder Decryption; }; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; /// \class CBC_Mode_ExternalCipher /// \brief CBC mode, external cipher /// \sa Modes of Operation /// on the Crypto++ wiki. struct CBC_Mode_ExternalCipher : public CipherModeDocumentation { typedef CipherModeFinalTemplate_ExternalCipher Encryption; typedef CipherModeFinalTemplate_ExternalCipher Decryption; }; /// \class CBC_CTS_Mode /// \brief CBC-CTS block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. template struct CBC_CTS_Mode : public CipherModeDocumentation { typedef CipherModeFinalTemplate_CipherHolder Encryption; typedef CipherModeFinalTemplate_CipherHolder Decryption; }; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; /// \class CBC_CTS_Mode_ExternalCipher /// \brief CBC mode with ciphertext stealing, external cipher /// \sa Modes of Operation /// on the Crypto++ wiki. struct CBC_CTS_Mode_ExternalCipher : public CipherModeDocumentation { typedef CipherModeFinalTemplate_ExternalCipher Encryption; typedef CipherModeFinalTemplate_ExternalCipher Decryption; }; NAMESPACE_END // Issue 340 #if CRYPTOPP_MSC_VERSION # pragma warning(pop) #endif #if CRYPTOPP_GCC_DIAGNOSTIC_AVAILABLE # pragma GCC diagnostic pop #endif #endif