des.h 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  2. * All rights reserved.
  3. *
  4. * This package is an SSL implementation written
  5. * by Eric Young (eay@cryptsoft.com).
  6. * The implementation was written so as to conform with Netscapes SSL.
  7. *
  8. * This library is free for commercial and non-commercial use as long as
  9. * the following conditions are aheared to. The following conditions
  10. * apply to all code found in this distribution, be it the RC4, RSA,
  11. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  12. * included with this distribution is covered by the same copyright terms
  13. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14. *
  15. * Copyright remains Eric Young's, and as such any Copyright notices in
  16. * the code are not to be removed.
  17. * If this package is used in a product, Eric Young should be given attribution
  18. * as the author of the parts of the library used.
  19. * This can be in the form of a textual message at program startup or
  20. * in documentation (online or textual) provided with the package.
  21. *
  22. * Redistribution and use in source and binary forms, with or without
  23. * modification, are permitted provided that the following conditions
  24. * are met:
  25. * 1. Redistributions of source code must retain the copyright
  26. * notice, this list of conditions and the following disclaimer.
  27. * 2. Redistributions in binary form must reproduce the above copyright
  28. * notice, this list of conditions and the following disclaimer in the
  29. * documentation and/or other materials provided with the distribution.
  30. * 3. All advertising materials mentioning features or use of this software
  31. * must display the following acknowledgement:
  32. * "This product includes cryptographic software written by
  33. * Eric Young (eay@cryptsoft.com)"
  34. * The word 'cryptographic' can be left out if the rouines from the library
  35. * being used are not cryptographic related :-).
  36. * 4. If you include any Windows specific code (or a derivative thereof) from
  37. * the apps directory (application code) you must include an acknowledgement:
  38. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50. * SUCH DAMAGE.
  51. *
  52. * The licence and distribution terms for any publically available version or
  53. * derivative of this code cannot be changed. i.e. this code cannot simply be
  54. * copied and put under another distribution licence
  55. * [including the GNU Public Licence.] */
  56. #ifndef OPENSSL_HEADER_DES_H
  57. #define OPENSSL_HEADER_DES_H
  58. #include <openssl/base.h>
  59. #if defined(__cplusplus)
  60. extern "C" {
  61. #endif
  62. // DES.
  63. //
  64. // This module is deprecated and retained for legacy reasons only. It is slow
  65. // and may leak key material with timing or cache side channels. Moreover,
  66. // single-keyed DES is broken and can be brute-forced in under a day.
  67. //
  68. // Use a modern cipher, such as AES-GCM or ChaCha20-Poly1305, instead.
  69. typedef struct DES_cblock_st {
  70. uint8_t bytes[8];
  71. } DES_cblock;
  72. typedef struct DES_ks {
  73. uint32_t subkeys[16][2];
  74. } DES_key_schedule;
  75. #define DES_KEY_SZ (sizeof(DES_cblock))
  76. #define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
  77. #define DES_ENCRYPT 1
  78. #define DES_DECRYPT 0
  79. #define DES_CBC_MODE 0
  80. #define DES_PCBC_MODE 1
  81. // DES_set_key performs a key schedule and initialises |schedule| with |key|.
  82. OPENSSL_EXPORT void DES_set_key(const DES_cblock *key,
  83. DES_key_schedule *schedule);
  84. // DES_set_odd_parity sets the parity bits (the least-significant bits in each
  85. // byte) of |key| given the other bits in each byte.
  86. OPENSSL_EXPORT void DES_set_odd_parity(DES_cblock *key);
  87. // DES_ecb_encrypt encrypts (or decrypts, if |is_encrypt| is |DES_DECRYPT|) a
  88. // single DES block (8 bytes) from in to out, using the key configured in
  89. // |schedule|.
  90. OPENSSL_EXPORT void DES_ecb_encrypt(const DES_cblock *in, DES_cblock *out,
  91. const DES_key_schedule *schedule,
  92. int is_encrypt);
  93. // DES_ncbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
  94. // bytes from |in| to |out| with DES in CBC mode.
  95. OPENSSL_EXPORT void DES_ncbc_encrypt(const uint8_t *in, uint8_t *out,
  96. size_t len,
  97. const DES_key_schedule *schedule,
  98. DES_cblock *ivec, int enc);
  99. // DES_ecb3_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) a single
  100. // block (8 bytes) of data from |input| to |output| using 3DES.
  101. OPENSSL_EXPORT void DES_ecb3_encrypt(const DES_cblock *input,
  102. DES_cblock *output,
  103. const DES_key_schedule *ks1,
  104. const DES_key_schedule *ks2,
  105. const DES_key_schedule *ks3,
  106. int enc);
  107. // DES_ede3_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
  108. // bytes from |in| to |out| with 3DES in CBC mode. 3DES uses three keys, thus
  109. // the function takes three different |DES_key_schedule|s.
  110. OPENSSL_EXPORT void DES_ede3_cbc_encrypt(const uint8_t *in, uint8_t *out,
  111. size_t len,
  112. const DES_key_schedule *ks1,
  113. const DES_key_schedule *ks2,
  114. const DES_key_schedule *ks3,
  115. DES_cblock *ivec, int enc);
  116. // DES_ede2_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
  117. // bytes from |in| to |out| with 3DES in CBC mode. With this keying option, the
  118. // first and third 3DES keys are identical. Thus, this function takes only two
  119. // different |DES_key_schedule|s.
  120. OPENSSL_EXPORT void DES_ede2_cbc_encrypt(const uint8_t *in, uint8_t *out,
  121. size_t len,
  122. const DES_key_schedule *ks1,
  123. const DES_key_schedule *ks2,
  124. DES_cblock *ivec, int enc);
  125. // Deprecated functions.
  126. // DES_set_key_unchecked calls |DES_set_key|.
  127. OPENSSL_EXPORT void DES_set_key_unchecked(const DES_cblock *key,
  128. DES_key_schedule *schedule);
  129. OPENSSL_EXPORT void DES_ede3_cfb64_encrypt(const uint8_t *in, uint8_t *out,
  130. long length, DES_key_schedule *ks1,
  131. DES_key_schedule *ks2,
  132. DES_key_schedule *ks3,
  133. DES_cblock *ivec, int *num, int enc);
  134. OPENSSL_EXPORT void DES_ede3_cfb_encrypt(const uint8_t *in, uint8_t *out,
  135. int numbits, long length,
  136. DES_key_schedule *ks1,
  137. DES_key_schedule *ks2,
  138. DES_key_schedule *ks3,
  139. DES_cblock *ivec, int enc);
  140. // Private functions.
  141. //
  142. // These functions are only exported for use in |decrepit|.
  143. OPENSSL_EXPORT void DES_decrypt3(uint32_t *data, const DES_key_schedule *ks1,
  144. const DES_key_schedule *ks2,
  145. const DES_key_schedule *ks3);
  146. OPENSSL_EXPORT void DES_encrypt3(uint32_t *data, const DES_key_schedule *ks1,
  147. const DES_key_schedule *ks2,
  148. const DES_key_schedule *ks3);
  149. #if defined(__cplusplus)
  150. } // extern C
  151. #endif
  152. #endif // OPENSSL_HEADER_DES_H