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 57 #ifndef OPENSSL_HEADER_DES_H 58 #define OPENSSL_HEADER_DES_H 59 60 #include <openssl/base.h> 61 62 #if defined(__cplusplus) 63 extern "C" { 64 #endif 65 66 67 // DES. 68 // 69 // This module is deprecated and retained for legacy reasons only. It is slow 70 // and may leak key material with timing or cache side channels. Moreover, 71 // single-keyed DES is broken and can be brute-forced in under a day. 72 // 73 // Use a modern cipher, such as AES-GCM or ChaCha20-Poly1305, instead. 74 75 76 typedef struct DES_cblock_st { 77 uint8_t bytes[8]; 78 } DES_cblock; 79 80 typedef struct DES_ks { 81 uint32_t subkeys[16][2]; 82 } DES_key_schedule; 83 84 85 #define DES_KEY_SZ (sizeof(DES_cblock)) 86 #define DES_SCHEDULE_SZ (sizeof(DES_key_schedule)) 87 88 #define DES_ENCRYPT 1 89 #define DES_DECRYPT 0 90 91 #define DES_CBC_MODE 0 92 #define DES_PCBC_MODE 1 93 94 // DES_set_key performs a key schedule and initialises |schedule| with |key|. 95 OPENSSL_EXPORT void DES_set_key(const DES_cblock *key, 96 DES_key_schedule *schedule); 97 98 // DES_set_odd_parity sets the parity bits (the least-significant bits in each 99 // byte) of |key| given the other bits in each byte. 100 OPENSSL_EXPORT void DES_set_odd_parity(DES_cblock *key); 101 102 // DES_ecb_encrypt encrypts (or decrypts, if |is_encrypt| is |DES_DECRYPT|) a 103 // single DES block (8 bytes) from in to out, using the key configured in 104 // |schedule|. 105 OPENSSL_EXPORT void DES_ecb_encrypt(const DES_cblock *in, DES_cblock *out, 106 const DES_key_schedule *schedule, 107 int is_encrypt); 108 109 // DES_ncbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len| 110 // bytes from |in| to |out| with DES in CBC mode. 111 OPENSSL_EXPORT void DES_ncbc_encrypt(const uint8_t *in, uint8_t *out, 112 size_t len, 113 const DES_key_schedule *schedule, 114 DES_cblock *ivec, int enc); 115 116 // DES_ecb3_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) a single 117 // block (8 bytes) of data from |input| to |output| using 3DES. 118 OPENSSL_EXPORT void DES_ecb3_encrypt(const DES_cblock *input, 119 DES_cblock *output, 120 const DES_key_schedule *ks1, 121 const DES_key_schedule *ks2, 122 const DES_key_schedule *ks3, 123 int enc); 124 125 // DES_ede3_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len| 126 // bytes from |in| to |out| with 3DES in CBC mode. 3DES uses three keys, thus 127 // the function takes three different |DES_key_schedule|s. 128 OPENSSL_EXPORT void DES_ede3_cbc_encrypt(const uint8_t *in, uint8_t *out, 129 size_t len, 130 const DES_key_schedule *ks1, 131 const DES_key_schedule *ks2, 132 const DES_key_schedule *ks3, 133 DES_cblock *ivec, int enc); 134 135 // DES_ede2_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len| 136 // bytes from |in| to |out| with 3DES in CBC mode. With this keying option, the 137 // first and third 3DES keys are identical. Thus, this function takes only two 138 // different |DES_key_schedule|s. 139 OPENSSL_EXPORT void DES_ede2_cbc_encrypt(const uint8_t *in, uint8_t *out, 140 size_t len, 141 const DES_key_schedule *ks1, 142 const DES_key_schedule *ks2, 143 DES_cblock *ivec, int enc); 144 145 146 // Deprecated functions. 147 148 // DES_set_key_unchecked calls |DES_set_key|. 149 OPENSSL_EXPORT void DES_set_key_unchecked(const DES_cblock *key, 150 DES_key_schedule *schedule); 151 152 OPENSSL_EXPORT void DES_ede3_cfb64_encrypt(const uint8_t *in, uint8_t *out, 153 long length, DES_key_schedule *ks1, 154 DES_key_schedule *ks2, 155 DES_key_schedule *ks3, 156 DES_cblock *ivec, int *num, int enc); 157 158 OPENSSL_EXPORT void DES_ede3_cfb_encrypt(const uint8_t *in, uint8_t *out, 159 int numbits, long length, 160 DES_key_schedule *ks1, 161 DES_key_schedule *ks2, 162 DES_key_schedule *ks3, 163 DES_cblock *ivec, int enc); 164 165 166 // Private functions. 167 // 168 // These functions are only exported for use in |decrepit|. 169 170 OPENSSL_EXPORT void DES_decrypt3(uint32_t *data, const DES_key_schedule *ks1, 171 const DES_key_schedule *ks2, 172 const DES_key_schedule *ks3); 173 174 OPENSSL_EXPORT void DES_encrypt3(uint32_t *data, const DES_key_schedule *ks1, 175 const DES_key_schedule *ks2, 176 const DES_key_schedule *ks3); 177 178 179 #if defined(__cplusplus) 180 } // extern C 181 #endif 182 183 #endif // OPENSSL_HEADER_DES_H 184