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