Crypto++  8.2
Free C++ class library of cryptographic schemes
des.h
Go to the documentation of this file.
1 // des.h - originally written and placed in the public domain by Wei Dai
2 
3 /// \file des.h
4 /// \brief Classes for DES, 2-key Triple-DES, 3-key Triple-DES and DESX
5 
6 #ifndef CRYPTOPP_DES_H
7 #define CRYPTOPP_DES_H
8 
9 #include "seckey.h"
10 #include "secblock.h"
11 
12 NAMESPACE_BEGIN(CryptoPP)
13 
14 /// \brief DES block cipher base class
15 /// \since Crypto++ 1.0
16 class CRYPTOPP_DLL RawDES
17 {
18 public:
19  void RawSetKey(CipherDir direction, const byte *userKey);
20  void RawProcessBlock(word32 &l, word32 &r) const;
21 
22 protected:
23  static const word32 Spbox[8][64];
24 
26 };
27 
28 /// \brief DES block cipher information
29 /// \since Crypto++ 1.0
30 struct DES_Info : public FixedBlockSize<8>, public FixedKeyLength<8>
31 {
32  // disable DES in DLL version by not exporting this function
33  CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "DES";}
34 };
35 
36 /// \brief DES block cipher
37 /// \details The DES implementation in Crypto++ ignores the parity bits
38 /// (the least significant bits of each byte) in the key. However you can use CheckKeyParityBits()
39 /// and CorrectKeyParityBits() to check or correct the parity bits if you wish.
40 /// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES</a>
41 /// \since Crypto++ 1.0
42 class DES : public DES_Info, public BlockCipherDocumentation
43 {
44  /// \brief DES block cipher default operation
45  class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_Info>, public RawDES
46  {
47  public:
48  void UncheckedSetKey(const byte *userKey, unsigned int length, const NameValuePairs &params);
49  void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
50  };
51 
52 public:
53  /// check DES key parity bits
54  static bool CheckKeyParityBits(const byte *key);
55  /// correct DES key parity bits
56  static void CorrectKeyParityBits(byte *key);
57 
60 };
61 
62 /// \brief 2-key TripleDES block cipher information
63 /// \since Crypto++ 1.0
64 struct DES_EDE2_Info : public FixedBlockSize<8>, public FixedKeyLength<16>
65 {
66  CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return "DES-EDE2";}
67 };
68 
69 /// \brief 2-key TripleDES block cipher
70 /// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-EDE2</a>
71 /// \since Crypto++ 1.0
73 {
74  /// \brief DES_EDE2 block cipher default operation
75  class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_EDE2_Info>
76  {
77  public:
78  void UncheckedSetKey(const byte *userKey, unsigned int length, const NameValuePairs &params);
79  void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
80 
81  protected:
82  RawDES m_des1, m_des2;
83  };
84 
85 public:
88 };
89 
90 /// \brief 3-key TripleDES block cipher information
91 /// \since Crypto++ 1.0
92 struct DES_EDE3_Info : public FixedBlockSize<8>, public FixedKeyLength<24>
93 {
94  CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return "DES-EDE3";}
95 };
96 
97 /// \brief 3-key TripleDES block cipher
98 /// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-EDE3</a>
99 /// \since Crypto++ 1.0
101 {
102  /// \brief DES_EDE3 block cipher default operation
103  class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_EDE3_Info>
104  {
105  public:
106  void UncheckedSetKey(const byte *userKey, unsigned int length, const NameValuePairs &params);
107  void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
108 
109  protected:
110  RawDES m_des1, m_des2, m_des3;
111  };
112 
113 public:
116 };
117 
118 /// \brief DESX block cipher information
119 /// \since Crypto++ 3.2
120 struct DES_XEX3_Info : public FixedBlockSize<8>, public FixedKeyLength<24>
121 {
122  CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "DES-XEX3";}
123 };
124 
125 /// \brief DESX block cipher
126 /// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-XEX3</a>, AKA DESX
127 /// \since Crypto++ 3.2
129 {
130  /// \brief DES_XEX3 block cipher default operation
131  class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_XEX3_Info>
132  {
133  public:
134  void UncheckedSetKey(const byte *userKey, unsigned int length, const NameValuePairs &params);
135  void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
136 
137  protected:
139  // VS2005 workaround: calling modules compiled with /clr gets unresolved external symbol DES::Base::ProcessAndXorBlock
140  // if we use DES::Encryption here directly without value_ptr.
142  };
143 
144 public:
147 };
148 
151 
154 
157 
160 
161 NAMESPACE_END
162 
163 #endif
Inherited by keyed algorithms with fixed key length.
Definition: seckey.h:124
Provides Encryption and Decryption typedefs used by derived classes to implement a block cipher...
Definition: seckey.h:398
static void CorrectKeyParityBits(byte *key)
correct DES key parity bits
Definition: des.cpp:428
CipherDir
Specifies a direction for a cipher to operate.
Definition: cryptlib.h:123
DES block cipher base class.
Definition: des.h:16
DES block cipher.
Definition: des.h:42
Classes and functions for secure memory allocations.
Inherited by algorithms with fixed block size.
Definition: seckey.h:40
DESX block cipher.
Definition: des.h:128
3-key TripleDES block cipher
Definition: des.h:100
Classes and functions for implementing secret key algorithms.
2-key TripleDES block cipher information
Definition: des.h:64
Provides class member functions to key a block cipher.
Definition: seckey.h:317
3-key TripleDES block cipher information
Definition: des.h:92
2-key TripleDES block cipher
Definition: des.h:72
DES block cipher information.
Definition: des.h:30
DESX block cipher information.
Definition: des.h:120
static bool CheckKeyParityBits(const byte *key)
check DES key parity bits
Definition: des.cpp:420
Value pointer.
Definition: smartptr.h:75
Provides a base implementation of Algorithm and SimpleKeyingInterface for block ciphers.
Definition: seckey.h:305
Crypto++ library namespace.
Interface for retrieving values given their names.
Definition: cryptlib.h:293