Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl30/crypto/evp/e_des3.c
Line
Count
Source
1
/*
2
 * Copyright 1995-2021 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
0
#define ks1 ks.ks[0]
37
0
#define ks2 ks.ks[1]
38
0
#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
0
#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
69
static int des_ede_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
70
    const unsigned char *in, size_t inl)
71
0
{
72
0
    BLOCK_CIPHER_ecb_loop()
73
0
        DES_ecb3_encrypt((const_DES_cblock *)(in + i),
74
0
            (DES_cblock *)(out + i),
75
0
            &data(ctx)->ks1, &data(ctx)->ks2,
76
0
            &data(ctx)->ks3, EVP_CIPHER_CTX_is_encrypting(ctx));
77
0
    return 1;
78
0
}
79
80
static int des_ede_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
81
    const unsigned char *in, size_t inl)
82
0
{
83
0
    while (inl >= EVP_MAXCHUNK) {
84
0
        int num = EVP_CIPHER_CTX_get_num(ctx);
85
0
        DES_ede3_ofb64_encrypt(in, out, (long)EVP_MAXCHUNK,
86
0
            &data(ctx)->ks1, &data(ctx)->ks2,
87
0
            &data(ctx)->ks3,
88
0
            (DES_cblock *)ctx->iv,
89
0
            &num);
90
0
        EVP_CIPHER_CTX_set_num(ctx, num);
91
0
        inl -= EVP_MAXCHUNK;
92
0
        in += EVP_MAXCHUNK;
93
0
        out += EVP_MAXCHUNK;
94
0
    }
95
0
    if (inl) {
96
0
        int num = EVP_CIPHER_CTX_get_num(ctx);
97
0
        DES_ede3_ofb64_encrypt(in, out, (long)inl,
98
0
            &data(ctx)->ks1, &data(ctx)->ks2,
99
0
            &data(ctx)->ks3,
100
0
            (DES_cblock *)ctx->iv,
101
0
            &num);
102
0
        EVP_CIPHER_CTX_set_num(ctx, num);
103
0
    }
104
0
    return 1;
105
0
}
106
107
static int des_ede_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
108
    const unsigned char *in, size_t inl)
109
0
{
110
0
    DES_EDE_KEY *dat = data(ctx);
111
112
0
    if (dat->stream.cbc != NULL) {
113
0
        (*dat->stream.cbc)(in, out, inl, dat->ks.ks,
114
0
            ctx->iv);
115
0
        return 1;
116
0
    }
117
118
0
    while (inl >= EVP_MAXCHUNK) {
119
0
        DES_ede3_cbc_encrypt(in, out, (long)EVP_MAXCHUNK,
120
0
            &dat->ks1, &dat->ks2, &dat->ks3,
121
0
            (DES_cblock *)ctx->iv,
122
0
            EVP_CIPHER_CTX_is_encrypting(ctx));
123
0
        inl -= EVP_MAXCHUNK;
124
0
        in += EVP_MAXCHUNK;
125
0
        out += EVP_MAXCHUNK;
126
0
    }
127
0
    if (inl)
128
0
        DES_ede3_cbc_encrypt(in, out, (long)inl,
129
0
            &dat->ks1, &dat->ks2, &dat->ks3,
130
0
            (DES_cblock *)ctx->iv,
131
0
            EVP_CIPHER_CTX_is_encrypting(ctx));
132
0
    return 1;
133
0
}
134
135
static int des_ede_cfb64_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
136
    const unsigned char *in, size_t inl)
137
0
{
138
0
    while (inl >= EVP_MAXCHUNK) {
139
0
        int num = EVP_CIPHER_CTX_get_num(ctx);
140
0
        DES_ede3_cfb64_encrypt(in, out, (long)EVP_MAXCHUNK,
141
0
            &data(ctx)->ks1, &data(ctx)->ks2,
142
0
            &data(ctx)->ks3, (DES_cblock *)ctx->iv,
143
0
            &num, EVP_CIPHER_CTX_is_encrypting(ctx));
144
0
        EVP_CIPHER_CTX_set_num(ctx, num);
145
0
        inl -= EVP_MAXCHUNK;
146
0
        in += EVP_MAXCHUNK;
147
0
        out += EVP_MAXCHUNK;
148
0
    }
149
0
    if (inl) {
150
0
        int num = EVP_CIPHER_CTX_get_num(ctx);
151
0
        DES_ede3_cfb64_encrypt(in, out, (long)inl,
152
0
            &data(ctx)->ks1, &data(ctx)->ks2,
153
0
            &data(ctx)->ks3, (DES_cblock *)ctx->iv,
154
0
            &num, EVP_CIPHER_CTX_is_encrypting(ctx));
155
0
        EVP_CIPHER_CTX_set_num(ctx, num);
156
0
    }
157
0
    return 1;
158
0
}
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
 */
164
static int des_ede3_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
165
    const unsigned char *in, size_t inl)
166
0
{
167
0
    size_t n;
168
0
    unsigned char c[1], d[1];
169
170
0
    if (!EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
171
0
        inl *= 8;
172
0
    for (n = 0; n < inl; ++n) {
173
0
        c[0] = (in[n / 8] & (1 << (7 - n % 8))) ? 0x80 : 0;
174
0
        DES_ede3_cfb_encrypt(c, d, 1, 1,
175
0
            &data(ctx)->ks1, &data(ctx)->ks2,
176
0
            &data(ctx)->ks3, (DES_cblock *)ctx->iv,
177
0
            EVP_CIPHER_CTX_is_encrypting(ctx));
178
0
        out[n / 8] = (out[n / 8] & ~(0x80 >> (unsigned int)(n % 8)))
179
0
            | ((d[0] & 0x80) >> (unsigned int)(n % 8));
180
0
    }
181
182
0
    return 1;
183
0
}
184
185
static int des_ede3_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
186
    const unsigned char *in, size_t inl)
187
0
{
188
0
    while (inl >= EVP_MAXCHUNK) {
189
0
        DES_ede3_cfb_encrypt(in, out, 8, (long)EVP_MAXCHUNK,
190
0
            &data(ctx)->ks1, &data(ctx)->ks2,
191
0
            &data(ctx)->ks3, (DES_cblock *)ctx->iv,
192
0
            EVP_CIPHER_CTX_is_encrypting(ctx));
193
0
        inl -= EVP_MAXCHUNK;
194
0
        in += EVP_MAXCHUNK;
195
0
        out += EVP_MAXCHUNK;
196
0
    }
197
0
    if (inl)
198
0
        DES_ede3_cfb_encrypt(in, out, 8, (long)inl,
199
0
            &data(ctx)->ks1, &data(ctx)->ks2,
200
0
            &data(ctx)->ks3, (DES_cblock *)ctx->iv,
201
0
            EVP_CIPHER_CTX_is_encrypting(ctx));
202
0
    return 1;
203
0
}
204
205
BLOCK_CIPHER_defs(des_ede, DES_EDE_KEY, NID_des_ede, 8, 16, 8, 64,
206
    EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
207
    des_ede_init_key, NULL, NULL, NULL, des3_ctrl)
208
#define des_ede3_cfb64_cipher des_ede_cfb64_cipher
209
#define des_ede3_ofb_cipher des_ede_ofb_cipher
210
#define des_ede3_cbc_cipher des_ede_cbc_cipher
211
#define des_ede3_ecb_cipher des_ede_ecb_cipher
212
    BLOCK_CIPHER_defs(des_ede3, DES_EDE_KEY, NID_des_ede3, 8, 24, 8, 64,
213
        EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
214
        des_ede3_init_key, NULL, NULL, NULL, des3_ctrl)
215
216
        BLOCK_CIPHER_def_cfb(des_ede3, DES_EDE_KEY, NID_des_ede3, 24, 8, 1,
217
            EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
218
            des_ede3_init_key, NULL, NULL, NULL, des3_ctrl)
219
220
            BLOCK_CIPHER_def_cfb(des_ede3, DES_EDE_KEY, NID_des_ede3, 24, 8, 8,
221
                EVP_CIPH_RAND_KEY | EVP_CIPH_FLAG_DEFAULT_ASN1,
222
                des_ede3_init_key, NULL, NULL, NULL, des3_ctrl)
223
224
                static int des_ede_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
225
                    const unsigned char *iv, int enc)
226
0
{
227
0
    DES_cblock *deskey = (DES_cblock *)key;
228
0
    DES_EDE_KEY *dat = data(ctx);
229
230
0
    dat->stream.cbc = NULL;
231
#if defined(SPARC_DES_CAPABLE)
232
    if (SPARC_DES_CAPABLE) {
233
        int mode = EVP_CIPHER_CTX_get_mode(ctx);
234
235
        if (mode == EVP_CIPH_CBC_MODE) {
236
            des_t4_key_expand(&deskey[0], &dat->ks1);
237
            des_t4_key_expand(&deskey[1], &dat->ks2);
238
            memcpy(&dat->ks3, &dat->ks1, sizeof(dat->ks1));
239
            dat->stream.cbc = enc ? des_t4_ede3_cbc_encrypt : des_t4_ede3_cbc_decrypt;
240
            return 1;
241
        }
242
    }
243
#endif
244
0
    DES_set_key_unchecked(&deskey[0], &dat->ks1);
245
0
    DES_set_key_unchecked(&deskey[1], &dat->ks2);
246
0
    memcpy(&dat->ks3, &dat->ks1, sizeof(dat->ks1));
247
0
    return 1;
248
0
}
249
250
static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
251
    const unsigned char *iv, int enc)
252
0
{
253
0
    DES_cblock *deskey = (DES_cblock *)key;
254
0
    DES_EDE_KEY *dat = data(ctx);
255
256
0
    dat->stream.cbc = NULL;
257
#if defined(SPARC_DES_CAPABLE)
258
    if (SPARC_DES_CAPABLE) {
259
        int mode = EVP_CIPHER_CTX_get_mode(ctx);
260
261
        if (mode == EVP_CIPH_CBC_MODE) {
262
            des_t4_key_expand(&deskey[0], &dat->ks1);
263
            des_t4_key_expand(&deskey[1], &dat->ks2);
264
            des_t4_key_expand(&deskey[2], &dat->ks3);
265
            dat->stream.cbc = enc ? des_t4_ede3_cbc_encrypt : des_t4_ede3_cbc_decrypt;
266
            return 1;
267
        }
268
    }
269
#endif
270
0
    DES_set_key_unchecked(&deskey[0], &dat->ks1);
271
0
    DES_set_key_unchecked(&deskey[1], &dat->ks2);
272
0
    DES_set_key_unchecked(&deskey[2], &dat->ks3);
273
0
    return 1;
274
0
}
275
276
static int des3_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
277
0
{
278
279
0
    DES_cblock *deskey = ptr;
280
0
    int kl;
281
282
0
    switch (type) {
283
0
    case EVP_CTRL_RAND_KEY:
284
0
        kl = EVP_CIPHER_CTX_get_key_length(ctx);
285
0
        if (kl < 0 || RAND_priv_bytes(ptr, kl) <= 0)
286
0
            return 0;
287
0
        DES_set_odd_parity(deskey);
288
0
        if (kl >= 16)
289
0
            DES_set_odd_parity(deskey + 1);
290
0
        if (kl >= 24)
291
0
            DES_set_odd_parity(deskey + 2);
292
0
        return 1;
293
294
0
    default:
295
0
        return -1;
296
0
    }
297
0
}
298
299
const EVP_CIPHER *EVP_des_ede(void)
300
164
{
301
164
    return &des_ede_ecb;
302
164
}
303
304
const EVP_CIPHER *EVP_des_ede3(void)
305
164
{
306
164
    return &des_ede3_ecb;
307
164
}
308
309
#include <openssl/sha.h>
310
311
static const unsigned char wrap_iv[8] = { 0x4a, 0xdd, 0xa2, 0x2c, 0x79, 0xe8, 0x21, 0x05 };
312
313
static int des_ede3_unwrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
314
    const unsigned char *in, size_t inl)
315
0
{
316
0
    unsigned char icv[8], iv[8], sha1tmp[SHA_DIGEST_LENGTH];
317
0
    int rv = -1;
318
0
    if (inl < 24)
319
0
        return -1;
320
0
    if (out == NULL)
321
0
        return inl - 16;
322
0
    memcpy(ctx->iv, wrap_iv, 8);
323
    /* Decrypt first block which will end up as icv */
324
0
    des_ede_cbc_cipher(ctx, icv, in, 8);
325
    /* Decrypt central blocks */
326
    /*
327
     * If decrypting in place move whole output along a block so the next
328
     * des_ede_cbc_cipher is in place.
329
     */
330
0
    if (out == in) {
331
0
        memmove(out, out + 8, inl - 8);
332
0
        in -= 8;
333
0
    }
334
0
    des_ede_cbc_cipher(ctx, out, in + 8, inl - 16);
335
    /* Decrypt final block which will be IV */
336
0
    des_ede_cbc_cipher(ctx, iv, in + inl - 8, 8);
337
    /* Reverse order of everything */
338
0
    BUF_reverse(icv, NULL, 8);
339
0
    BUF_reverse(out, NULL, inl - 16);
340
0
    BUF_reverse(ctx->iv, iv, 8);
341
    /* Decrypt again using new IV */
342
0
    des_ede_cbc_cipher(ctx, out, out, inl - 16);
343
0
    des_ede_cbc_cipher(ctx, icv, icv, 8);
344
0
    if (ossl_sha1(out, inl - 16, sha1tmp) /* Work out hash of first portion */
345
0
        && CRYPTO_memcmp(sha1tmp, icv, 8) == 0)
346
0
        rv = inl - 16;
347
0
    OPENSSL_cleanse(icv, 8);
348
0
    OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
349
0
    OPENSSL_cleanse(iv, 8);
350
0
    OPENSSL_cleanse(ctx->iv, 8);
351
0
    if (rv == -1)
352
0
        OPENSSL_cleanse(out, inl - 16);
353
354
0
    return rv;
355
0
}
356
357
static int des_ede3_wrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
358
    const unsigned char *in, size_t inl)
359
0
{
360
0
    unsigned char sha1tmp[SHA_DIGEST_LENGTH];
361
0
    if (out == NULL)
362
0
        return inl + 16;
363
    /* Copy input to output buffer + 8 so we have space for IV */
364
0
    memmove(out + 8, in, inl);
365
    /* Work out ICV */
366
0
    if (!ossl_sha1(in, inl, sha1tmp))
367
0
        return -1;
368
0
    memcpy(out + inl + 8, sha1tmp, 8);
369
0
    OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
370
    /* Generate random IV */
371
0
    if (RAND_bytes(ctx->iv, 8) <= 0)
372
0
        return -1;
373
0
    memcpy(out, ctx->iv, 8);
374
    /* Encrypt everything after IV in place */
375
0
    des_ede_cbc_cipher(ctx, out + 8, out + 8, inl + 8);
376
0
    BUF_reverse(out, NULL, inl + 16);
377
0
    memcpy(ctx->iv, wrap_iv, 8);
378
0
    des_ede_cbc_cipher(ctx, out, out, inl + 16);
379
0
    return inl + 16;
380
0
}
381
382
static int des_ede3_wrap_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
383
    const unsigned char *in, size_t inl)
384
0
{
385
    /*
386
     * Sanity check input length: we typically only wrap keys so EVP_MAXCHUNK
387
     * is more than will ever be needed. Also input length must be a multiple
388
     * of 8 bits.
389
     */
390
0
    if (inl >= EVP_MAXCHUNK || inl % 8)
391
0
        return -1;
392
393
0
    if (ossl_is_partially_overlapping(out, in, inl)) {
394
0
        ERR_raise(ERR_LIB_EVP, EVP_R_PARTIALLY_OVERLAPPING);
395
0
        return 0;
396
0
    }
397
398
0
    if (EVP_CIPHER_CTX_is_encrypting(ctx))
399
0
        return des_ede3_wrap(ctx, out, in, inl);
400
0
    else
401
0
        return des_ede3_unwrap(ctx, out, in, inl);
402
0
}
403
404
static const EVP_CIPHER des3_wrap = {
405
    NID_id_smime_alg_CMS3DESwrap,
406
    8, 24, 0,
407
    EVP_CIPH_WRAP_MODE | EVP_CIPH_CUSTOM_IV | EVP_CIPH_FLAG_CUSTOM_CIPHER
408
        | EVP_CIPH_FLAG_DEFAULT_ASN1,
409
    EVP_ORIG_GLOBAL,
410
    des_ede3_init_key, des_ede3_wrap_cipher,
411
    NULL,
412
    sizeof(DES_EDE_KEY),
413
    NULL, NULL, NULL, NULL
414
};
415
416
const EVP_CIPHER *EVP_des_ede3_wrap(void)
417
164
{
418
164
    return &des3_wrap;
419
164
}
420
421
#endif