2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
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
11 * DES low level APIs are deprecated for public use, but still ok for internal
14 #include "internal/deprecated.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"
29 DES_key_schedule ks[3];
32 void (*cbc) (const void *, void *, size_t,
33 const DES_key_schedule *, unsigned char *);
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"
45 # define SPARC_DES_CAPABLE (OPENSSL_sparcv9cap_P[1] & CFR_DES)
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]);
54 static int des_ede_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
55 const unsigned char *iv, int enc);
57 static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
58 const unsigned char *iv, int enc);
60 static int des3_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr);
62 # define data(ctx) EVP_C_DATA(DES_EDE_KEY,ctx)
65 * Because of various casts and different args can't use
66 * IMPLEMENT_BLOCK_CIPHER
69 static int des_ede_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
70 const unsigned char *in, size_t inl)
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));
80 static int des_ede_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
81 const unsigned char *in, size_t inl)
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,
88 (DES_cblock *)ctx->iv,
90 EVP_CIPHER_CTX_set_num(ctx, num);
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,
100 (DES_cblock *)ctx->iv,
102 EVP_CIPHER_CTX_set_num(ctx, num);
107 static int des_ede_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
108 const unsigned char *in, size_t inl)
110 DES_EDE_KEY *dat = data(ctx);
112 if (dat->stream.cbc != NULL) {
113 (*dat->stream.cbc) (in, out, inl, dat->ks.ks,
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));
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));
135 static int des_ede_cfb64_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
136 const unsigned char *in, size_t inl)
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);
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);
161 * Although we have a CFB-r implementation for 3-DES, it doesn't pack the
162 * right way, so wrap it here
164 static int des_ede3_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
165 const unsigned char *in, size_t inl)
169 unsigned char d[1] = { 0 }; /* Appease Coverity */
171 if (!EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
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));
186 static int des_ede3_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
187 const unsigned char *in, size_t inl)
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));
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));
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)
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)
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)
225 static int des_ede_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
226 const unsigned char *iv, int enc)
228 DES_cblock *deskey = (DES_cblock *)key;
229 DES_EDE_KEY *dat = data(ctx);
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);
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;
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));
252 static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
253 const unsigned char *iv, int enc)
255 DES_cblock *deskey = (DES_cblock *)key;
256 DES_EDE_KEY *dat = data(ctx);
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);
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;
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);
279 static int des3_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
282 DES_cblock *deskey = ptr;
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)
290 DES_set_odd_parity(deskey);
292 DES_set_odd_parity(deskey + 1);
294 DES_set_odd_parity(deskey + 2);
302 const EVP_CIPHER *EVP_des_ede(void)
307 const EVP_CIPHER *EVP_des_ede3(void)
309 return &des_ede3_ecb;
313 # include <openssl/sha.h>
315 static const unsigned char wrap_iv[8] =
316 { 0x4a, 0xdd, 0xa2, 0x2c, 0x79, 0xe8, 0x21, 0x05 };
318 static int des_ede3_unwrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
319 const unsigned char *in, size_t inl)
321 unsigned char icv[8], iv[8], sha1tmp[SHA_DIGEST_LENGTH];
327 memcpy(ctx->iv, wrap_iv, 8);
328 /* Decrypt first block which will end up as icv */
329 des_ede_cbc_cipher(ctx, icv, in, 8);
330 /* Decrypt central blocks */
332 * If decrypting in place move whole output along a block so the next
333 * des_ede_cbc_cipher is in place.
336 memmove(out, out + 8, inl - 8);
339 des_ede_cbc_cipher(ctx, out, in + 8, inl - 16);
340 /* Decrypt final block which will be IV */
341 des_ede_cbc_cipher(ctx, iv, in + inl - 8, 8);
342 /* Reverse order of everything */
343 BUF_reverse(icv, NULL, 8);
344 BUF_reverse(out, NULL, inl - 16);
345 BUF_reverse(ctx->iv, iv, 8);
346 /* Decrypt again using new IV */
347 des_ede_cbc_cipher(ctx, out, out, inl - 16);
348 des_ede_cbc_cipher(ctx, icv, icv, 8);
349 if (ossl_sha1(out, inl - 16, sha1tmp) /* Work out hash of first portion */
350 && CRYPTO_memcmp(sha1tmp, icv, 8) == 0)
352 OPENSSL_cleanse(icv, 8);
353 OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
354 OPENSSL_cleanse(iv, 8);
355 OPENSSL_cleanse(ctx->iv, 8);
357 OPENSSL_cleanse(out, inl - 16);
362 static int des_ede3_wrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
363 const unsigned char *in, size_t inl)
365 unsigned char sha1tmp[SHA_DIGEST_LENGTH];
368 /* Copy input to output buffer + 8 so we have space for IV */
369 memmove(out + 8, in, inl);
371 if (!ossl_sha1(in, inl, sha1tmp))
373 memcpy(out + inl + 8, sha1tmp, 8);
374 OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
375 /* Generate random IV */
376 if (RAND_bytes(ctx->iv, 8) <= 0)
378 memcpy(out, ctx->iv, 8);
379 /* Encrypt everything after IV in place */
380 des_ede_cbc_cipher(ctx, out + 8, out + 8, inl + 8);
381 BUF_reverse(out, NULL, inl + 16);
382 memcpy(ctx->iv, wrap_iv, 8);
383 des_ede_cbc_cipher(ctx, out, out, inl + 16);
387 static int des_ede3_wrap_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
388 const unsigned char *in, size_t inl)
391 * Sanity check input length: we typically only wrap keys so EVP_MAXCHUNK
392 * is more than will ever be needed. Also input length must be a multiple
395 if (inl >= EVP_MAXCHUNK || inl % 8)
398 if (ossl_is_partially_overlapping(out, in, inl)) {
399 ERR_raise(ERR_LIB_EVP, EVP_R_PARTIALLY_OVERLAPPING);
403 if (EVP_CIPHER_CTX_is_encrypting(ctx))
404 return des_ede3_wrap(ctx, out, in, inl);
406 return des_ede3_unwrap(ctx, out, in, inl);
409 static const EVP_CIPHER des3_wrap = {
410 NID_id_smime_alg_CMS3DESwrap,
412 EVP_CIPH_WRAP_MODE | EVP_CIPH_CUSTOM_IV | EVP_CIPH_FLAG_CUSTOM_CIPHER
413 | EVP_CIPH_FLAG_DEFAULT_ASN1,
415 des_ede3_init_key, des_ede3_wrap_cipher,
418 NULL, NULL, NULL, NULL
421 const EVP_CIPHER *EVP_des_ede3_wrap(void)