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     if (!EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
 168             inl *= 8;
 169     for (n = 0; n < inl; ++n) {
 170         c[0] = (in[n / 8] & (1 << (7 - n % 8))) ? 0x80 : 0;
 171         DES_ede3_cfb_encrypt(c, d, 1, 1,
 172                              &data(ctx)->ks1, &data(ctx)->ks2,
 173                              &data(ctx)->ks3,
 174                              (DES_cblock *)EVP_CIPHER_CTX_iv_noconst(ctx),
 175                              EVP_CIPHER_CTX_encrypting(ctx));
 176         out[n / 8] = (out[n / 8] & ~(0x80 >> (unsigned int)(n % 8)))
 177             | ((d[0] & 0x80) >> (unsigned int)(n % 8));
 178     }
 179
 180     return 1;
 181 }
 182
 183 static int des_ede3_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 184                                 const unsigned char *in, size_t inl)
 185 {
 186     while (inl >= EVP_MAXCHUNK) {
 187         DES_ede3_cfb_encrypt(in, out, 8, (long)EVP_MAXCHUNK,
 188                              &data(ctx)->ks1, &data(ctx)->ks2,
 189                              &data(ctx)->ks3,
 190                              (DES_cblock *)EVP_CIPHER_CTX_iv_noconst(ctx),
 191                              EVP_CIPHER_CTX_encrypting(ctx));
 192         inl -= EVP_MAXCHUNK;
 193         in += EVP_MAXCHUNK;
 194         out += EVP_MAXCHUNK;
 195     }
 196     if (inl)
 197         DES_ede3_cfb_encrypt(in, out, 8, (long)inl,
 198                              &data(ctx)->ks1, &data(ctx)->ks2,
 199                              &data(ctx)->ks3,
 200                              (DES_cblock *)EVP_CIPHER_CTX_iv_noconst(ctx),
 201                              EVP_CIPHER_CTX_encrypting(ctx));
 202     return 1;
 203 }
 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 {
 227     DES_cblock *deskey = (DES_cblock *)key;
 228     DES_EDE_KEY *dat = data(ctx);
 229
 230     dat->stream.cbc = NULL;
 231 # if defined(SPARC_DES_CAPABLE)
 232     if (SPARC_DES_CAPABLE) {
 233         int mode = EVP_CIPHER_CTX_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 :
 240                 des_t4_ede3_cbc_decrypt;
 241             return 1;
 242         }
 243     }
 244 # endif
 245     DES_set_key_unchecked(&deskey[0], &dat->ks1);
 246     DES_set_key_unchecked(&deskey[1], &dat->ks2);
 247     memcpy(&dat->ks3, &dat->ks1, sizeof(dat->ks1));
 248     return 1;
 249 }
 250
 251 static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 252                              const unsigned char *iv, int enc)
 253 {
 254     DES_cblock *deskey = (DES_cblock *)key;
 255     DES_EDE_KEY *dat = data(ctx);
 256
 257     dat->stream.cbc = NULL;
 258 # if defined(SPARC_DES_CAPABLE)
 259     if (SPARC_DES_CAPABLE) {
 260         int mode = EVP_CIPHER_CTX_mode(ctx);
 261
 262         if (mode == EVP_CIPH_CBC_MODE) {
 263             des_t4_key_expand(&deskey[0], &dat->ks1);
 264             des_t4_key_expand(&deskey[1], &dat->ks2);
 265             des_t4_key_expand(&deskey[2], &dat->ks3);
 266             dat->stream.cbc = enc ? des_t4_ede3_cbc_encrypt :
 267                 des_t4_ede3_cbc_decrypt;
 268             return 1;
 269         }
 270     }
 271 # endif
 272     DES_set_key_unchecked(&deskey[0], &dat->ks1);
 273     DES_set_key_unchecked(&deskey[1], &dat->ks2);
 274     DES_set_key_unchecked(&deskey[2], &dat->ks3);
 275     return 1;
 276 }
 277
 278 static int des3_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
 279 {
 280
 281     DES_cblock *deskey = ptr;
 282
 283     switch (type) {
 284     case EVP_CTRL_RAND_KEY:
 285         if (RAND_bytes(ptr, EVP_CIPHER_CTX_key_length(ctx)) <= 0)
 286             return 0;
 287         DES_set_odd_parity(deskey);
 288         if (EVP_CIPHER_CTX_key_length(ctx) >= 16)
 289             DES_set_odd_parity(deskey + 1);
 290         if (EVP_CIPHER_CTX_key_length(ctx) >= 24)
 291             DES_set_odd_parity(deskey + 2);
 292         return 1;
 293
 294     default:
 295         return -1;
 296     }
 297 }
 298
 299 const EVP_CIPHER *EVP_des_ede(void)
 300 {
 301     return &des_ede_ecb;
 302 }
 303
 304 const EVP_CIPHER *EVP_des_ede3(void)
 305 {
 306     return &des_ede3_ecb;
 307 }
 308
 309
 310 # include <openssl/sha.h>
 311
 312 static const unsigned char wrap_iv[8] =
 313     { 0x4a, 0xdd, 0xa2, 0x2c, 0x79, 0xe8, 0x21, 0x05 };
 314
 315 static int des_ede3_unwrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
 316                            const unsigned char *in, size_t inl)
 317 {
 318     unsigned char icv[8], iv[8], sha1tmp[SHA_DIGEST_LENGTH];
 319     int rv = -1;
 320     if (inl < 24)
 321         return -1;
 322     if (out == NULL)
 323         return inl - 16;
 324     memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), wrap_iv, 8);
 325     /* Decrypt first block which will end up as icv */
 326     des_ede_cbc_cipher(ctx, icv, in, 8);
 327     /* Decrypt central blocks */
 328     /*
 329      * If decrypting in place move whole output along a block so the next
 330      * des_ede_cbc_cipher is in place.
 331      */
 332     if (out == in) {
 333         memmove(out, out + 8, inl - 8);
 334         in -= 8;
 335     }
 336     des_ede_cbc_cipher(ctx, out, in + 8, inl - 16);
 337     /* Decrypt final block which will be IV */
 338     des_ede_cbc_cipher(ctx, iv, in + inl - 8, 8);
 339     /* Reverse order of everything */
 340     BUF_reverse(icv, NULL, 8);
 341     BUF_reverse(out, NULL, inl - 16);
 342     BUF_reverse(EVP_CIPHER_CTX_iv_noconst(ctx), iv, 8);
 343     /* Decrypt again using new IV */
 344     des_ede_cbc_cipher(ctx, out, out, inl - 16);
 345     des_ede_cbc_cipher(ctx, icv, icv, 8);
 346     /* Work out SHA1 hash of first portion */
 347     SHA1(out, inl - 16, sha1tmp);
 348
 349     if (!CRYPTO_memcmp(sha1tmp, icv, 8))
 350         rv = inl - 16;
 351     OPENSSL_cleanse(icv, 8);
 352     OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
 353     OPENSSL_cleanse(iv, 8);
 354     OPENSSL_cleanse(EVP_CIPHER_CTX_iv_noconst(ctx), 8);
 355     if (rv == -1)
 356         OPENSSL_cleanse(out, inl - 16);
 357
 358     return rv;
 359 }
 360
 361 static int des_ede3_wrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
 362                          const unsigned char *in, size_t inl)
 363 {
 364     unsigned char sha1tmp[SHA_DIGEST_LENGTH];
 365     if (out == NULL)
 366         return inl + 16;
 367     /* Copy input to output buffer + 8 so we have space for IV */
 368     memmove(out + 8, in, inl);
 369     /* Work out ICV */
 370     SHA1(in, inl, sha1tmp);
 371     memcpy(out + inl + 8, sha1tmp, 8);
 372     OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
 373     /* Generate random IV */
 374     if (RAND_bytes(EVP_CIPHER_CTX_iv_noconst(ctx), 8) <= 0)
 375         return -1;
 376     memcpy(out, EVP_CIPHER_CTX_iv_noconst(ctx), 8);
 377     /* Encrypt everything after IV in place */
 378     des_ede_cbc_cipher(ctx, out + 8, out + 8, inl + 8);
 379     BUF_reverse(out, NULL, inl + 16);
 380     memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), wrap_iv, 8);
 381     des_ede_cbc_cipher(ctx, out, out, inl + 16);
 382     return inl + 16;
 383 }
 384
 385 static int des_ede3_wrap_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 386                                 const unsigned char *in, size_t inl)
 387 {
 388     /*
 389      * Sanity check input length: we typically only wrap keys so EVP_MAXCHUNK
 390      * is more than will ever be needed. Also input length must be a multiple
 391      * of 8 bits.
 392      */
 393     if (inl >= EVP_MAXCHUNK || inl % 8)
 394         return -1;
 395     if (EVP_CIPHER_CTX_encrypting(ctx))
 396         return des_ede3_wrap(ctx, out, in, inl);
 397     else
 398         return des_ede3_unwrap(ctx, out, in, inl);
 399 }
 400
 401 static const EVP_CIPHER des3_wrap = {
 402     NID_id_smime_alg_CMS3DESwrap,
 403     8, 24, 0,
 404     EVP_CIPH_WRAP_MODE | EVP_CIPH_CUSTOM_IV | EVP_CIPH_FLAG_CUSTOM_CIPHER
 405         | EVP_CIPH_FLAG_DEFAULT_ASN1,
 406     des_ede3_init_key, des_ede3_wrap_cipher,
 407     NULL,
 408     sizeof(DES_EDE_KEY),
 409     NULL, NULL, NULL, NULL
 410 };
 411
 412 const EVP_CIPHER *EVP_des_ede3_wrap(void)
 413 {
 414     return &des3_wrap;
 415 }
 416
 417 #endif