Coverage Report

Created: 2025-06-22 06:56

/src/openssl/crypto/des/set_key.c
Line
Count
Source (jump to first uncovered line)
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
 * set_key.c v 1.4 eay 24/9/91
12
 * 1.4 Speed up by 400% :-)
13
 * 1.3 added register declarations.
14
 * 1.2 unrolled make_key_sched a bit more
15
 * 1.1 added norm_expand_bits
16
 * 1.0 First working version
17
 */
18
19
/*
20
 * DES low level APIs are deprecated for public use, but still ok for internal
21
 * use.
22
 */
23
#include "internal/deprecated.h"
24
25
#include <openssl/crypto.h>
26
#include "internal/constant_time.h"
27
#include "internal/nelem.h"
28
#include "des_local.h"
29
30
static const unsigned char odd_parity[256] = {
31
    1, 1, 2, 2, 4, 4, 7, 7, 8, 8, 11, 11, 13, 13, 14, 14,
32
    16, 16, 19, 19, 21, 21, 22, 22, 25, 25, 26, 26, 28, 28, 31, 31,
33
    32, 32, 35, 35, 37, 37, 38, 38, 41, 41, 42, 42, 44, 44, 47, 47,
34
    49, 49, 50, 50, 52, 52, 55, 55, 56, 56, 59, 59, 61, 61, 62, 62,
35
    64, 64, 67, 67, 69, 69, 70, 70, 73, 73, 74, 74, 76, 76, 79, 79,
36
    81, 81, 82, 82, 84, 84, 87, 87, 88, 88, 91, 91, 93, 93, 94, 94,
37
    97, 97, 98, 98, 100, 100, 103, 103, 104, 104, 107, 107, 109, 109, 110,
38
    110,
39
    112, 112, 115, 115, 117, 117, 118, 118, 121, 121, 122, 122, 124, 124, 127,
40
    127,
41
    128, 128, 131, 131, 133, 133, 134, 134, 137, 137, 138, 138, 140, 140, 143,
42
    143,
43
    145, 145, 146, 146, 148, 148, 151, 151, 152, 152, 155, 155, 157, 157, 158,
44
    158,
45
    161, 161, 162, 162, 164, 164, 167, 167, 168, 168, 171, 171, 173, 173, 174,
46
    174,
47
    176, 176, 179, 179, 181, 181, 182, 182, 185, 185, 186, 186, 188, 188, 191,
48
    191,
49
    193, 193, 194, 194, 196, 196, 199, 199, 200, 200, 203, 203, 205, 205, 206,
50
    206,
51
    208, 208, 211, 211, 213, 213, 214, 214, 217, 217, 218, 218, 220, 220, 223,
52
    223,
53
    224, 224, 227, 227, 229, 229, 230, 230, 233, 233, 234, 234, 236, 236, 239,
54
    239,
55
    241, 241, 242, 242, 244, 244, 247, 247, 248, 248, 251, 251, 253, 253, 254,
56
    254
57
};
58
59
void DES_set_odd_parity(DES_cblock *key)
60
14.8M
{
61
14.8M
    unsigned int i;
62
63
133M
    for (i = 0; i < DES_KEY_SZ; i++)
64
118M
        (*key)[i] = odd_parity[(*key)[i]];
65
14.8M
}
66
67
/*
68
 * Check that a key has the correct parity.
69
 * Return 1 if parity is okay and 0 if not.
70
 */
71
int DES_check_key_parity(const_DES_cblock *key)
72
0
{
73
0
    unsigned int i;
74
0
    unsigned char res = 0377, b;
75
76
0
    for (i = 0; i < DES_KEY_SZ; i++) {
77
0
        b = (*key)[i];
78
0
        b ^= b >> 4;
79
0
        b ^= b >> 2;
80
0
        b ^= b >> 1;
81
0
        res &= constant_time_eq_8(b & 1, 1);
82
0
    }
83
0
    return (int)(res & 1);
84
0
}
85
86
/*-
87
 * Weak and semi weak keys as taken from
88
 * %A D.W. Davies
89
 * %A W.L. Price
90
 * %T Security for Computer Networks
91
 * %I John Wiley & Sons
92
 * %D 1984
93
 */
94
static const DES_cblock weak_keys[] = {
95
    /* weak keys */
96
    {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01},
97
    {0xFE, 0xFE, 0xFE, 0xFE, 0xFE, 0xFE, 0xFE, 0xFE},
98
    {0x1F, 0x1F, 0x1F, 0x1F, 0x0E, 0x0E, 0x0E, 0x0E},
99
    {0xE0, 0xE0, 0xE0, 0xE0, 0xF1, 0xF1, 0xF1, 0xF1},
100
    /* semi-weak keys */
101
    {0x01, 0xFE, 0x01, 0xFE, 0x01, 0xFE, 0x01, 0xFE},
102
    {0xFE, 0x01, 0xFE, 0x01, 0xFE, 0x01, 0xFE, 0x01},
103
    {0x1F, 0xE0, 0x1F, 0xE0, 0x0E, 0xF1, 0x0E, 0xF1},
104
    {0xE0, 0x1F, 0xE0, 0x1F, 0xF1, 0x0E, 0xF1, 0x0E},
105
    {0x01, 0xE0, 0x01, 0xE0, 0x01, 0xF1, 0x01, 0xF1},
106
    {0xE0, 0x01, 0xE0, 0x01, 0xF1, 0x01, 0xF1, 0x01},
107
    {0x1F, 0xFE, 0x1F, 0xFE, 0x0E, 0xFE, 0x0E, 0xFE},
108
    {0xFE, 0x1F, 0xFE, 0x1F, 0xFE, 0x0E, 0xFE, 0x0E},
109
    {0x01, 0x1F, 0x01, 0x1F, 0x01, 0x0E, 0x01, 0x0E},
110
    {0x1F, 0x01, 0x1F, 0x01, 0x0E, 0x01, 0x0E, 0x01},
111
    {0xE0, 0xFE, 0xE0, 0xFE, 0xF1, 0xFE, 0xF1, 0xFE},
112
    {0xFE, 0xE0, 0xFE, 0xE0, 0xFE, 0xF1, 0xFE, 0xF1}
113
};
114
115
/*
116
 * Check for weak keys.
117
 * Return 1 if the key is weak and 0 otherwise.
118
 */
119
int DES_is_weak_key(const_DES_cblock *key)
120
0
{
121
0
    unsigned int i, res = 0;
122
0
    int j;
123
124
0
    for (i = 0; i < OSSL_NELEM(weak_keys); i++) {
125
0
        j = CRYPTO_memcmp(weak_keys[i], key, sizeof(DES_cblock));
126
0
        res |= constant_time_is_zero((unsigned int)j);
127
0
    }
128
0
    return (int)(res & 1);
129
0
}
130
131
/*-
132
 * NOW DEFINED IN des_local.h
133
 * See ecb_encrypt.c for a pseudo description of these macros.
134
 * #define PERM_OP(a,b,t,n,m) ((t)=((((a)>>(n))^(b))&(m)),\
135
 *      (b)^=(t),\
136
 *      (a)=((a)^((t)<<(n))))
137
 */
138
139
29.6M
#define HPERM_OP(a,t,n,m) ((t)=((((a)<<(16-(n)))^(a))&(m)),\
140
29.6M
        (a)=(a)^(t)^(t>>(16-(n))))
141
142
static const DES_LONG des_skb[8][64] = {
143
    {
144
     /* for C bits (numbered as per FIPS 46) 1 2 3 4 5 6 */
145
     0x00000000L, 0x00000010L, 0x20000000L, 0x20000010L,
146
     0x00010000L, 0x00010010L, 0x20010000L, 0x20010010L,
147
     0x00000800L, 0x00000810L, 0x20000800L, 0x20000810L,
148
     0x00010800L, 0x00010810L, 0x20010800L, 0x20010810L,
149
     0x00000020L, 0x00000030L, 0x20000020L, 0x20000030L,
150
     0x00010020L, 0x00010030L, 0x20010020L, 0x20010030L,
151
     0x00000820L, 0x00000830L, 0x20000820L, 0x20000830L,
152
     0x00010820L, 0x00010830L, 0x20010820L, 0x20010830L,
153
     0x00080000L, 0x00080010L, 0x20080000L, 0x20080010L,
154
     0x00090000L, 0x00090010L, 0x20090000L, 0x20090010L,
155
     0x00080800L, 0x00080810L, 0x20080800L, 0x20080810L,
156
     0x00090800L, 0x00090810L, 0x20090800L, 0x20090810L,
157
     0x00080020L, 0x00080030L, 0x20080020L, 0x20080030L,
158
     0x00090020L, 0x00090030L, 0x20090020L, 0x20090030L,
159
     0x00080820L, 0x00080830L, 0x20080820L, 0x20080830L,
160
     0x00090820L, 0x00090830L, 0x20090820L, 0x20090830L,
161
     },
162
    {
163
     /* for C bits (numbered as per FIPS 46) 7 8 10 11 12 13 */
164
     0x00000000L, 0x02000000L, 0x00002000L, 0x02002000L,
165
     0x00200000L, 0x02200000L, 0x00202000L, 0x02202000L,
166
     0x00000004L, 0x02000004L, 0x00002004L, 0x02002004L,
167
     0x00200004L, 0x02200004L, 0x00202004L, 0x02202004L,
168
     0x00000400L, 0x02000400L, 0x00002400L, 0x02002400L,
169
     0x00200400L, 0x02200400L, 0x00202400L, 0x02202400L,
170
     0x00000404L, 0x02000404L, 0x00002404L, 0x02002404L,
171
     0x00200404L, 0x02200404L, 0x00202404L, 0x02202404L,
172
     0x10000000L, 0x12000000L, 0x10002000L, 0x12002000L,
173
     0x10200000L, 0x12200000L, 0x10202000L, 0x12202000L,
174
     0x10000004L, 0x12000004L, 0x10002004L, 0x12002004L,
175
     0x10200004L, 0x12200004L, 0x10202004L, 0x12202004L,
176
     0x10000400L, 0x12000400L, 0x10002400L, 0x12002400L,
177
     0x10200400L, 0x12200400L, 0x10202400L, 0x12202400L,
178
     0x10000404L, 0x12000404L, 0x10002404L, 0x12002404L,
179
     0x10200404L, 0x12200404L, 0x10202404L, 0x12202404L,
180
     },
181
    {
182
     /* for C bits (numbered as per FIPS 46) 14 15 16 17 19 20 */
183
     0x00000000L, 0x00000001L, 0x00040000L, 0x00040001L,
184
     0x01000000L, 0x01000001L, 0x01040000L, 0x01040001L,
185
     0x00000002L, 0x00000003L, 0x00040002L, 0x00040003L,
186
     0x01000002L, 0x01000003L, 0x01040002L, 0x01040003L,
187
     0x00000200L, 0x00000201L, 0x00040200L, 0x00040201L,
188
     0x01000200L, 0x01000201L, 0x01040200L, 0x01040201L,
189
     0x00000202L, 0x00000203L, 0x00040202L, 0x00040203L,
190
     0x01000202L, 0x01000203L, 0x01040202L, 0x01040203L,
191
     0x08000000L, 0x08000001L, 0x08040000L, 0x08040001L,
192
     0x09000000L, 0x09000001L, 0x09040000L, 0x09040001L,
193
     0x08000002L, 0x08000003L, 0x08040002L, 0x08040003L,
194
     0x09000002L, 0x09000003L, 0x09040002L, 0x09040003L,
195
     0x08000200L, 0x08000201L, 0x08040200L, 0x08040201L,
196
     0x09000200L, 0x09000201L, 0x09040200L, 0x09040201L,
197
     0x08000202L, 0x08000203L, 0x08040202L, 0x08040203L,
198
     0x09000202L, 0x09000203L, 0x09040202L, 0x09040203L,
199
     },
200
    {
201
     /* for C bits (numbered as per FIPS 46) 21 23 24 26 27 28 */
202
     0x00000000L, 0x00100000L, 0x00000100L, 0x00100100L,
203
     0x00000008L, 0x00100008L, 0x00000108L, 0x00100108L,
204
     0x00001000L, 0x00101000L, 0x00001100L, 0x00101100L,
205
     0x00001008L, 0x00101008L, 0x00001108L, 0x00101108L,
206
     0x04000000L, 0x04100000L, 0x04000100L, 0x04100100L,
207
     0x04000008L, 0x04100008L, 0x04000108L, 0x04100108L,
208
     0x04001000L, 0x04101000L, 0x04001100L, 0x04101100L,
209
     0x04001008L, 0x04101008L, 0x04001108L, 0x04101108L,
210
     0x00020000L, 0x00120000L, 0x00020100L, 0x00120100L,
211
     0x00020008L, 0x00120008L, 0x00020108L, 0x00120108L,
212
     0x00021000L, 0x00121000L, 0x00021100L, 0x00121100L,
213
     0x00021008L, 0x00121008L, 0x00021108L, 0x00121108L,
214
     0x04020000L, 0x04120000L, 0x04020100L, 0x04120100L,
215
     0x04020008L, 0x04120008L, 0x04020108L, 0x04120108L,
216
     0x04021000L, 0x04121000L, 0x04021100L, 0x04121100L,
217
     0x04021008L, 0x04121008L, 0x04021108L, 0x04121108L,
218
     },
219
    {
220
     /* for D bits (numbered as per FIPS 46) 1 2 3 4 5 6 */
221
     0x00000000L, 0x10000000L, 0x00010000L, 0x10010000L,
222
     0x00000004L, 0x10000004L, 0x00010004L, 0x10010004L,
223
     0x20000000L, 0x30000000L, 0x20010000L, 0x30010000L,
224
     0x20000004L, 0x30000004L, 0x20010004L, 0x30010004L,
225
     0x00100000L, 0x10100000L, 0x00110000L, 0x10110000L,
226
     0x00100004L, 0x10100004L, 0x00110004L, 0x10110004L,
227
     0x20100000L, 0x30100000L, 0x20110000L, 0x30110000L,
228
     0x20100004L, 0x30100004L, 0x20110004L, 0x30110004L,
229
     0x00001000L, 0x10001000L, 0x00011000L, 0x10011000L,
230
     0x00001004L, 0x10001004L, 0x00011004L, 0x10011004L,
231
     0x20001000L, 0x30001000L, 0x20011000L, 0x30011000L,
232
     0x20001004L, 0x30001004L, 0x20011004L, 0x30011004L,
233
     0x00101000L, 0x10101000L, 0x00111000L, 0x10111000L,
234
     0x00101004L, 0x10101004L, 0x00111004L, 0x10111004L,
235
     0x20101000L, 0x30101000L, 0x20111000L, 0x30111000L,
236
     0x20101004L, 0x30101004L, 0x20111004L, 0x30111004L,
237
     },
238
    {
239
     /* for D bits (numbered as per FIPS 46) 8 9 11 12 13 14 */
240
     0x00000000L, 0x08000000L, 0x00000008L, 0x08000008L,
241
     0x00000400L, 0x08000400L, 0x00000408L, 0x08000408L,
242
     0x00020000L, 0x08020000L, 0x00020008L, 0x08020008L,
243
     0x00020400L, 0x08020400L, 0x00020408L, 0x08020408L,
244
     0x00000001L, 0x08000001L, 0x00000009L, 0x08000009L,
245
     0x00000401L, 0x08000401L, 0x00000409L, 0x08000409L,
246
     0x00020001L, 0x08020001L, 0x00020009L, 0x08020009L,
247
     0x00020401L, 0x08020401L, 0x00020409L, 0x08020409L,
248
     0x02000000L, 0x0A000000L, 0x02000008L, 0x0A000008L,
249
     0x02000400L, 0x0A000400L, 0x02000408L, 0x0A000408L,
250
     0x02020000L, 0x0A020000L, 0x02020008L, 0x0A020008L,
251
     0x02020400L, 0x0A020400L, 0x02020408L, 0x0A020408L,
252
     0x02000001L, 0x0A000001L, 0x02000009L, 0x0A000009L,
253
     0x02000401L, 0x0A000401L, 0x02000409L, 0x0A000409L,
254
     0x02020001L, 0x0A020001L, 0x02020009L, 0x0A020009L,
255
     0x02020401L, 0x0A020401L, 0x02020409L, 0x0A020409L,
256
     },
257
    {
258
     /* for D bits (numbered as per FIPS 46) 16 17 18 19 20 21 */
259
     0x00000000L, 0x00000100L, 0x00080000L, 0x00080100L,
260
     0x01000000L, 0x01000100L, 0x01080000L, 0x01080100L,
261
     0x00000010L, 0x00000110L, 0x00080010L, 0x00080110L,
262
     0x01000010L, 0x01000110L, 0x01080010L, 0x01080110L,
263
     0x00200000L, 0x00200100L, 0x00280000L, 0x00280100L,
264
     0x01200000L, 0x01200100L, 0x01280000L, 0x01280100L,
265
     0x00200010L, 0x00200110L, 0x00280010L, 0x00280110L,
266
     0x01200010L, 0x01200110L, 0x01280010L, 0x01280110L,
267
     0x00000200L, 0x00000300L, 0x00080200L, 0x00080300L,
268
     0x01000200L, 0x01000300L, 0x01080200L, 0x01080300L,
269
     0x00000210L, 0x00000310L, 0x00080210L, 0x00080310L,
270
     0x01000210L, 0x01000310L, 0x01080210L, 0x01080310L,
271
     0x00200200L, 0x00200300L, 0x00280200L, 0x00280300L,
272
     0x01200200L, 0x01200300L, 0x01280200L, 0x01280300L,
273
     0x00200210L, 0x00200310L, 0x00280210L, 0x00280310L,
274
     0x01200210L, 0x01200310L, 0x01280210L, 0x01280310L,
275
     },
276
    {
277
     /* for D bits (numbered as per FIPS 46) 22 23 24 25 27 28 */
278
     0x00000000L, 0x04000000L, 0x00040000L, 0x04040000L,
279
     0x00000002L, 0x04000002L, 0x00040002L, 0x04040002L,
280
     0x00002000L, 0x04002000L, 0x00042000L, 0x04042000L,
281
     0x00002002L, 0x04002002L, 0x00042002L, 0x04042002L,
282
     0x00000020L, 0x04000020L, 0x00040020L, 0x04040020L,
283
     0x00000022L, 0x04000022L, 0x00040022L, 0x04040022L,
284
     0x00002020L, 0x04002020L, 0x00042020L, 0x04042020L,
285
     0x00002022L, 0x04002022L, 0x00042022L, 0x04042022L,
286
     0x00000800L, 0x04000800L, 0x00040800L, 0x04040800L,
287
     0x00000802L, 0x04000802L, 0x00040802L, 0x04040802L,
288
     0x00002800L, 0x04002800L, 0x00042800L, 0x04042800L,
289
     0x00002802L, 0x04002802L, 0x00042802L, 0x04042802L,
290
     0x00000820L, 0x04000820L, 0x00040820L, 0x04040820L,
291
     0x00000822L, 0x04000822L, 0x00040822L, 0x04040822L,
292
     0x00002820L, 0x04002820L, 0x00042820L, 0x04042820L,
293
     0x00002822L, 0x04002822L, 0x00042822L, 0x04042822L,
294
     }
295
};
296
297
/* Return values as DES_set_key_checked() but always set the key */
298
int DES_set_key(const_DES_cblock *key, DES_key_schedule *schedule)
299
0
{
300
0
    int ret = 0;
301
302
0
    if (!DES_check_key_parity(key))
303
0
        ret = -1;
304
0
    if (DES_is_weak_key(key))
305
0
        ret = -2;
306
0
    DES_set_key_unchecked(key, schedule);
307
0
    return ret;
308
0
}
309
310
/*-
311
 * return 0 if key parity is odd (correct),
312
 * return -1 if key parity error,
313
 * return -2 if illegal weak key.
314
 */
315
int DES_set_key_checked(const_DES_cblock *key, DES_key_schedule *schedule)
316
0
{
317
0
    if (!DES_check_key_parity(key))
318
0
        return -1;
319
0
    if (DES_is_weak_key(key))
320
0
        return -2;
321
0
    DES_set_key_unchecked(key, schedule);
322
0
    return 0;
323
0
}
324
325
void DES_set_key_unchecked(const_DES_cblock *key, DES_key_schedule *schedule)
326
14.8M
{
327
14.8M
    static const int shifts2[16] = {
328
14.8M
         0, 0, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 0
329
14.8M
     };
330
14.8M
    register DES_LONG c, d, t, s, t2;
331
14.8M
    register const unsigned char *in;
332
14.8M
    register DES_LONG *k;
333
14.8M
    register int i;
334
335
#ifdef OPENBSD_DEV_CRYPTO
336
    memcpy(schedule->key, key, sizeof(schedule->key));
337
    schedule->session = NULL;
338
#endif
339
14.8M
    k = &schedule->ks->deslong[0];
340
14.8M
    in = &(*key)[0];
341
342
14.8M
    c2l(in, c);
343
14.8M
    c2l(in, d);
344
345
    /*
346
     * do PC1 in 47 simple operations. Thanks to John Fletcher
347
     * for the inspiration.
348
     */
349
14.8M
    PERM_OP(d, c, t, 4, 0x0f0f0f0fL);
350
14.8M
    HPERM_OP(c, t, -2, 0xcccc0000L);
351
14.8M
    HPERM_OP(d, t, -2, 0xcccc0000L);
352
14.8M
    PERM_OP(d, c, t, 1, 0x55555555L);
353
14.8M
    PERM_OP(c, d, t, 8, 0x00ff00ffL);
354
14.8M
    PERM_OP(d, c, t, 1, 0x55555555L);
355
14.8M
    d = (((d & 0x000000ffL) << 16L) | (d & 0x0000ff00L) |
356
14.8M
         ((d & 0x00ff0000L) >> 16L) | ((c & 0xf0000000L) >> 4L));
357
14.8M
    c &= 0x0fffffffL;
358
359
251M
    for (i = 0; i < ITERATIONS; i++) {
360
236M
        if (shifts2[i]) {
361
177M
            c = ((c >> 2L) | (c << 26L));
362
177M
            d = ((d >> 2L) | (d << 26L));
363
177M
        } else {
364
59.2M
            c = ((c >> 1L) | (c << 27L));
365
59.2M
            d = ((d >> 1L) | (d << 27L));
366
59.2M
        }
367
236M
        c &= 0x0fffffffL;
368
236M
        d &= 0x0fffffffL;
369
        /*
370
         * could be a few less shifts but I am to lazy at this point in time
371
         * to investigate
372
         */
373
236M
        s = des_skb[0][(c) & 0x3f] |
374
236M
            des_skb[1][((c >> 6L) & 0x03) | ((c >> 7L) & 0x3c)] |
375
236M
            des_skb[2][((c >> 13L) & 0x0f) | ((c >> 14L) & 0x30)] |
376
236M
            des_skb[3][((c >> 20L) & 0x01) | ((c >> 21L) & 0x06) |
377
236M
                       ((c >> 22L) & 0x38)];
378
236M
        t = des_skb[4][(d) & 0x3f] |
379
236M
            des_skb[5][((d >> 7L) & 0x03) | ((d >> 8L) & 0x3c)] |
380
236M
            des_skb[6][(d >> 15L) & 0x3f] |
381
236M
            des_skb[7][((d >> 21L) & 0x0f) | ((d >> 22L) & 0x30)];
382
383
        /* table contained 0213 4657 */
384
236M
        t2 = ((t << 16L) | (s & 0x0000ffffL)) & 0xffffffffL;
385
236M
        *(k++) = ROTATE(t2, 30) & 0xffffffffL;
386
387
236M
        t2 = ((s >> 16L) | (t & 0xffff0000L));
388
236M
        *(k++) = ROTATE(t2, 26) & 0xffffffffL;
389
236M
    }
390
14.8M
}
391
392
int DES_key_sched(const_DES_cblock *key, DES_key_schedule *schedule)
393
0
{
394
0
    return DES_set_key(key, schedule);
395
0
}