1 /*
2 * Copyright 1995-2024 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10 /*
11 * DES low level APIs are deprecated for public use, but still ok for internal
12 * use.
13 */
14 #include "internal/deprecated.h"
15
16 #include <stdio.h>
17 #include "internal/cryptlib.h"
18 #ifndef OPENSSL_NO_DES
19 # include <openssl/objects.h>
20 # include "crypto/evp.h"
21 # include "crypto/sha.h"
22 # include <openssl/des.h>
23 # include <openssl/rand.h>
24 # include "evp_local.h"
25
26 typedef struct {
27 union {
28 OSSL_UNION_ALIGN;
29 DES_key_schedule ks[3];
30 } ks;
31 union {
32 void (*cbc) (const void *, void *, size_t,
33 const DES_key_schedule *, unsigned char *);
34 } stream;
35 } DES_EDE_KEY;
36 # define ks1 ks.ks[0]
37 # define ks2 ks.ks[1]
38 # define ks3 ks.ks[2]
39
40 # if defined(AES_ASM) && (defined(__sparc) || defined(__sparc__))
41 /* ---------^^^ this is not a typo, just a way to detect that
42 * assembler support was in general requested... */
43 # include "crypto/sparc_arch.h"
44
45 # define SPARC_DES_CAPABLE (OPENSSL_sparcv9cap_P[1] & CFR_DES)
46
47 void des_t4_key_expand(const void *key, DES_key_schedule *ks);
48 void des_t4_ede3_cbc_encrypt(const void *inp, void *out, size_t len,
49 const DES_key_schedule ks[3], unsigned char iv[8]);
50 void des_t4_ede3_cbc_decrypt(const void *inp, void *out, size_t len,
51 const DES_key_schedule ks[3], unsigned char iv[8]);
52 # endif
53
54 static int des_ede_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
55 const unsigned char *iv, int enc);
56
57 static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
58 const unsigned char *iv, int enc);
59
60 static int des3_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr);
61
62 # define data(ctx) EVP_C_DATA(DES_EDE_KEY,ctx)
63
64 /*
65 * Because of various casts and different args can't use
66 * IMPLEMENT_BLOCK_CIPHER
67 */
68
des_ede_ecb_cipher(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)69 static int des_ede_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
70 const unsigned char *in, size_t inl)
71 {
72 BLOCK_CIPHER_ecb_loop()
73 DES_ecb3_encrypt((const_DES_cblock *)(in + i),
74 (DES_cblock *)(out + i),
75 &data(ctx)->ks1, &data(ctx)->ks2,
76 &data(ctx)->ks3, EVP_CIPHER_CTX_is_encrypting(ctx));
77 return 1;
78 }
79
des_ede_ofb_cipher(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)80 static int des_ede_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
81 const unsigned char *in, size_t inl)
82 {
83 while (inl >= EVP_MAXCHUNK) {
84 int num = EVP_CIPHER_CTX_get_num(ctx);
85 DES_ede3_ofb64_encrypt(in, out, (long)EVP_MAXCHUNK,
86 &data(ctx)->ks1, &data(ctx)->ks2,
87 &data(ctx)->ks3,
88 (DES_cblock *)ctx->iv,
89 &num);
90 EVP_CIPHER_CTX_set_num(ctx, num);
91 inl -= EVP_MAXCHUNK;
92 in += EVP_MAXCHUNK;
93 out += EVP_MAXCHUNK;
94 }
95 if (inl) {
96 int num = EVP_CIPHER_CTX_get_num(ctx);
97 DES_ede3_ofb64_encrypt(in, out, (long)inl,
98 &data(ctx)->ks1, &data(ctx)->ks2,
99 &data(ctx)->ks3,
100 (DES_cblock *)ctx->iv,
101 &num);
102 EVP_CIPHER_CTX_set_num(ctx, num);
103 }
104 return 1;
105 }
106
des_ede_cbc_cipher(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)107 static int des_ede_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
108 const unsigned char *in, size_t inl)
109 {
110 DES_EDE_KEY *dat = data(ctx);
111
112 if (dat->stream.cbc != NULL) {
113 (*dat->stream.cbc) (in, out, inl, dat->ks.ks,
114 ctx->iv);
115 return 1;
116 }
117
118 while (inl >= EVP_MAXCHUNK) {
119 DES_ede3_cbc_encrypt(in, out, (long)EVP_MAXCHUNK,
120 &dat->ks1, &dat->ks2, &dat->ks3,
121 (DES_cblock *)ctx->iv,
122 EVP_CIPHER_CTX_is_encrypting(ctx));
123 inl -= EVP_MAXCHUNK;
124 in += EVP_MAXCHUNK;
125 out += EVP_MAXCHUNK;
126 }
127 if (inl)
128 DES_ede3_cbc_encrypt(in, out, (long)inl,
129 &dat->ks1, &dat->ks2, &dat->ks3,
130 (DES_cblock *)ctx->iv,
131 EVP_CIPHER_CTX_is_encrypting(ctx));
132 return 1;
133 }
134
des_ede_cfb64_cipher(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)135 static int des_ede_cfb64_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
136 const unsigned char *in, size_t inl)
137 {
138 while (inl >= EVP_MAXCHUNK) {
139 int num = EVP_CIPHER_CTX_get_num(ctx);
140 DES_ede3_cfb64_encrypt(in, out, (long)EVP_MAXCHUNK,
141 &data(ctx)->ks1, &data(ctx)->ks2,
142 &data(ctx)->ks3, (DES_cblock *)ctx->iv,
143 &num, EVP_CIPHER_CTX_is_encrypting(ctx));
144 EVP_CIPHER_CTX_set_num(ctx, num);
145 inl -= EVP_MAXCHUNK;
146 in += EVP_MAXCHUNK;
147 out += EVP_MAXCHUNK;
148 }
149 if (inl) {
150 int num = EVP_CIPHER_CTX_get_num(ctx);
151 DES_ede3_cfb64_encrypt(in, out, (long)inl,
152 &data(ctx)->ks1, &data(ctx)->ks2,
153 &data(ctx)->ks3, (DES_cblock *)ctx->iv,
154 &num, EVP_CIPHER_CTX_is_encrypting(ctx));
155 EVP_CIPHER_CTX_set_num(ctx, num);
156 }
157 return 1;
158 }
159
160 /*
161 * Although we have a CFB-r implementation for 3-DES, it doesn't pack the
162 * right way, so wrap it here
163 */
des_ede3_cfb1_cipher(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)164 static int des_ede3_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
165 const unsigned char *in, size_t inl)
166 {
167 size_t n;
168 unsigned char c[1];
169 unsigned char d[1] = { 0 }; /* Appease Coverity */
170
171 if (!EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
172 inl *= 8;
173 for (n = 0; n < inl; ++n) {
174 c[0] = (in[n / 8] & (1 << (7 - n % 8))) ? 0x80 : 0;
175 DES_ede3_cfb_encrypt(c, d, 1, 1,
176 &data(ctx)->ks1, &data(ctx)->ks2,
177 &data(ctx)->ks3, (DES_cblock *)ctx->iv,
178 EVP_CIPHER_CTX_is_encrypting(ctx));
179 out[n / 8] = (out[n / 8] & ~(0x80 >> (unsigned int)(n % 8)))
180 | ((d[0] & 0x80) >> (unsigned int)(n % 8));
181 }
182
183 return 1;
184 }
185
des_ede3_cfb8_cipher(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)186 static int des_ede3_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
187 const unsigned char *in, size_t inl)
188 {
189 while (inl >= EVP_MAXCHUNK) {
190 DES_ede3_cfb_encrypt(in, out, 8, (long)EVP_MAXCHUNK,
191 &data(ctx)->ks1, &data(ctx)->ks2,
192 &data(ctx)->ks3, (DES_cblock *)ctx->iv,
193 EVP_CIPHER_CTX_is_encrypting(ctx));
194 inl -= EVP_MAXCHUNK;
195 in += EVP_MAXCHUNK;
196 out += EVP_MAXCHUNK;
197 }
198 if (inl)
199 DES_ede3_cfb_encrypt(in, out, 8, (long)inl,
200 &data(ctx)->ks1, &data(ctx)->ks2,
201 &data(ctx)->ks3, (DES_cblock *)ctx->iv,
202 EVP_CIPHER_CTX_is_encrypting(ctx));
203 return 1;
204 }
205
206 BLOCK_CIPHER_defs(des_ede, DES_EDE_KEY, NID_des_ede, 8, 16, 8, 64,
207 EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
208 des_ede_init_key, NULL, NULL, NULL, des3_ctrl)
209 # define des_ede3_cfb64_cipher des_ede_cfb64_cipher
210 # define des_ede3_ofb_cipher des_ede_ofb_cipher
211 # define des_ede3_cbc_cipher des_ede_cbc_cipher
212 # define des_ede3_ecb_cipher des_ede_ecb_cipher
213 BLOCK_CIPHER_defs(des_ede3, DES_EDE_KEY, NID_des_ede3, 8, 24, 8, 64,
214 EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
215 des_ede3_init_key, NULL, NULL, NULL, des3_ctrl)
216
217 BLOCK_CIPHER_def_cfb(des_ede3, DES_EDE_KEY, NID_des_ede3, 24, 8, 1,
218 EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
219 des_ede3_init_key, NULL, NULL, NULL, des3_ctrl)
220
221 BLOCK_CIPHER_def_cfb(des_ede3, DES_EDE_KEY, NID_des_ede3, 24, 8, 8,
222 EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
223 des_ede3_init_key, NULL, NULL, NULL, des3_ctrl)
224
des_ede_init_key(EVP_CIPHER_CTX * ctx,const unsigned char * key,const unsigned char * iv,int enc)225 static int des_ede_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
226 const unsigned char *iv, int enc)
227 {
228 DES_cblock *deskey = (DES_cblock *)key;
229 DES_EDE_KEY *dat = data(ctx);
230
231 dat->stream.cbc = NULL;
232 # if defined(SPARC_DES_CAPABLE)
233 if (SPARC_DES_CAPABLE) {
234 int mode = EVP_CIPHER_CTX_get_mode(ctx);
235
236 if (mode == EVP_CIPH_CBC_MODE) {
237 des_t4_key_expand(&deskey[0], &dat->ks1);
238 des_t4_key_expand(&deskey[1], &dat->ks2);
239 memcpy(&dat->ks3, &dat->ks1, sizeof(dat->ks1));
240 dat->stream.cbc = enc ? des_t4_ede3_cbc_encrypt :
241 des_t4_ede3_cbc_decrypt;
242 return 1;
243 }
244 }
245 # endif
246 DES_set_key_unchecked(&deskey[0], &dat->ks1);
247 DES_set_key_unchecked(&deskey[1], &dat->ks2);
248 memcpy(&dat->ks3, &dat->ks1, sizeof(dat->ks1));
249 return 1;
250 }
251
des_ede3_init_key(EVP_CIPHER_CTX * ctx,const unsigned char * key,const unsigned char * iv,int enc)252 static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
253 const unsigned char *iv, int enc)
254 {
255 DES_cblock *deskey = (DES_cblock *)key;
256 DES_EDE_KEY *dat = data(ctx);
257
258 dat->stream.cbc = NULL;
259 # if defined(SPARC_DES_CAPABLE)
260 if (SPARC_DES_CAPABLE) {
261 int mode = EVP_CIPHER_CTX_get_mode(ctx);
262
263 if (mode == EVP_CIPH_CBC_MODE) {
264 des_t4_key_expand(&deskey[0], &dat->ks1);
265 des_t4_key_expand(&deskey[1], &dat->ks2);
266 des_t4_key_expand(&deskey[2], &dat->ks3);
267 dat->stream.cbc = enc ? des_t4_ede3_cbc_encrypt :
268 des_t4_ede3_cbc_decrypt;
269 return 1;
270 }
271 }
272 # endif
273 DES_set_key_unchecked(&deskey[0], &dat->ks1);
274 DES_set_key_unchecked(&deskey[1], &dat->ks2);
275 DES_set_key_unchecked(&deskey[2], &dat->ks3);
276 return 1;
277 }
278
des3_ctrl(EVP_CIPHER_CTX * ctx,int type,int arg,void * ptr)279 static int des3_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
280 {
281
282 DES_cblock *deskey = ptr;
283 int kl;
284
285 switch (type) {
286 case EVP_CTRL_RAND_KEY:
287 kl = EVP_CIPHER_CTX_get_key_length(ctx);
288 if (kl < 0 || RAND_priv_bytes(ptr, kl) <= 0)
289 return 0;
290 DES_set_odd_parity(deskey);
291 if (kl >= 16)
292 DES_set_odd_parity(deskey + 1);
293 if (kl >= 24)
294 DES_set_odd_parity(deskey + 2);
295 return 1;
296
297 default:
298 return -1;
299 }
300 }
301
EVP_des_ede(void)302 const EVP_CIPHER *EVP_des_ede(void)
303 {
304 return &des_ede_ecb;
305 }
306
EVP_des_ede3(void)307 const EVP_CIPHER *EVP_des_ede3(void)
308 {
309 return &des_ede3_ecb;
310 }
311
312
313 # include <openssl/sha.h>
314
315 static const unsigned char wrap_iv[8] = {
316 0x4a, 0xdd, 0xa2, 0x2c, 0x79, 0xe8, 0x21, 0x05
317 };
318
des_ede3_unwrap(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)319 static int des_ede3_unwrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
320 const unsigned char *in, size_t inl)
321 {
322 unsigned char icv[8], iv[8], sha1tmp[SHA_DIGEST_LENGTH];
323 int rv = -1;
324 if (inl < 24)
325 return -1;
326 if (out == NULL)
327 return inl - 16;
328 memcpy(ctx->iv, wrap_iv, 8);
329 /* Decrypt first block which will end up as icv */
330 des_ede_cbc_cipher(ctx, icv, in, 8);
331 /* Decrypt central blocks */
332 /*
333 * If decrypting in place move whole output along a block so the next
334 * des_ede_cbc_cipher is in place.
335 */
336 if (out == in) {
337 memmove(out, out + 8, inl - 8);
338 in -= 8;
339 }
340 des_ede_cbc_cipher(ctx, out, in + 8, inl - 16);
341 /* Decrypt final block which will be IV */
342 des_ede_cbc_cipher(ctx, iv, in + inl - 8, 8);
343 /* Reverse order of everything */
344 BUF_reverse(icv, NULL, 8);
345 BUF_reverse(out, NULL, inl - 16);
346 BUF_reverse(ctx->iv, iv, 8);
347 /* Decrypt again using new IV */
348 des_ede_cbc_cipher(ctx, out, out, inl - 16);
349 des_ede_cbc_cipher(ctx, icv, icv, 8);
350 if (ossl_sha1(out, inl - 16, sha1tmp) /* Work out hash of first portion */
351 && CRYPTO_memcmp(sha1tmp, icv, 8) == 0)
352 rv = inl - 16;
353 OPENSSL_cleanse(icv, 8);
354 OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
355 OPENSSL_cleanse(iv, 8);
356 OPENSSL_cleanse(ctx->iv, 8);
357 if (rv == -1)
358 OPENSSL_cleanse(out, inl - 16);
359
360 return rv;
361 }
362
des_ede3_wrap(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)363 static int des_ede3_wrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
364 const unsigned char *in, size_t inl)
365 {
366 unsigned char sha1tmp[SHA_DIGEST_LENGTH];
367 if (out == NULL)
368 return inl + 16;
369 /* Copy input to output buffer + 8 so we have space for IV */
370 memmove(out + 8, in, inl);
371 /* Work out ICV */
372 if (!ossl_sha1(in, inl, sha1tmp))
373 return -1;
374 memcpy(out + inl + 8, sha1tmp, 8);
375 OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
376 /* Generate random IV */
377 if (RAND_bytes(ctx->iv, 8) <= 0)
378 return -1;
379 memcpy(out, ctx->iv, 8);
380 /* Encrypt everything after IV in place */
381 des_ede_cbc_cipher(ctx, out + 8, out + 8, inl + 8);
382 BUF_reverse(out, NULL, inl + 16);
383 memcpy(ctx->iv, wrap_iv, 8);
384 des_ede_cbc_cipher(ctx, out, out, inl + 16);
385 return inl + 16;
386 }
387
des_ede3_wrap_cipher(EVP_CIPHER_CTX * ctx,unsigned char * out,const unsigned char * in,size_t inl)388 static int des_ede3_wrap_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
389 const unsigned char *in, size_t inl)
390 {
391 /*
392 * Sanity check input length: we typically only wrap keys so EVP_MAXCHUNK
393 * is more than will ever be needed. Also input length must be a multiple
394 * of 8 bits.
395 */
396 if (inl >= EVP_MAXCHUNK || inl % 8)
397 return -1;
398
399 if (ossl_is_partially_overlapping(out, in, inl)) {
400 ERR_raise(ERR_LIB_EVP, EVP_R_PARTIALLY_OVERLAPPING);
401 return 0;
402 }
403
404 if (EVP_CIPHER_CTX_is_encrypting(ctx))
405 return des_ede3_wrap(ctx, out, in, inl);
406 else
407 return des_ede3_unwrap(ctx, out, in, inl);
408 }
409
410 static const EVP_CIPHER des3_wrap = {
411 NID_id_smime_alg_CMS3DESwrap,
412 8, 24, 0,
413 EVP_CIPH_WRAP_MODE | EVP_CIPH_CUSTOM_IV | EVP_CIPH_FLAG_CUSTOM_CIPHER
414 | EVP_CIPH_FLAG_DEFAULT_ASN1,
415 EVP_ORIG_GLOBAL,
416 des_ede3_init_key, des_ede3_wrap_cipher,
417 NULL,
418 sizeof(DES_EDE_KEY),
419 NULL, NULL, NULL, NULL
420 };
421
EVP_des_ede3_wrap(void)422 const EVP_CIPHER *EVP_des_ede3_wrap(void)
423 {
424 return &des3_wrap;
425 }
426
427 #endif
428
