crypto/evp/e_des3.c

   1 /* crypto/evp/e_des3.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #include <stdio.h>
  60 #include "cryptlib.h"
  61 #ifndef OPENSSL_NO_DES
  62 #include <openssl/evp.h>
  63 #include <openssl/objects.h>
  64 #include "evp_locl.h"
  65 #include <openssl/des.h>
  66 #include <openssl/rand.h>
  67
  68 /* Block use of implementations in FIPS mode */
  69 #undef EVP_CIPH_FLAG_FIPS
  70 #define EVP_CIPH_FLAG_FIPS      0
  71
  72 typedef struct
  73         {
  74         union { double align; DES_key_schedule ks[3]; } ks;
  75         union {
  76                 void (*cbc)(const void *,void *,size_t,const void *,void *);
  77         } stream;
  78         } DES_EDE_KEY;
  79 #define ks1 ks.ks[0]
  80 #define ks2 ks.ks[1]
  81 #define ks3 ks.ks[2]
  82
  83 #if defined(AES_ASM) && (defined(__sparc) || defined(__sparc__))
  84 /* ---------^^^ this is not a typo, just a way to detect that
  85  * assembler support was in general requested... */
  86 #include "sparc_arch.h"
  87
  88 extern unsigned int OPENSSL_sparcv9cap_P[];
  89
  90 #define SPARC_DES_CAPABLE       (OPENSSL_sparcv9cap_P[1] & CFR_DES)
  91
  92 void    des_t4_key_expand(const void *key, DES_key_schedule *ks);
  93 void    des_t4_ede3_cbc_encrypt(const void *inp,void *out,size_t len,
  94                                 DES_key_schedule *ks,unsigned char iv[8]);
  95 void    des_t4_ede3_cbc_decrypt(const void *inp,void *out,size_t len,
  96                                 DES_key_schedule *ks,unsigned char iv[8]);
  97 #endif
  98
  99 static int des_ede_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 100                             const unsigned char *iv,int enc);
 101
 102 static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 103                              const unsigned char *iv,int enc);
 104
 105 static int des3_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr);
 106
 107 #define data(ctx) ((DES_EDE_KEY *)(ctx)->cipher_data)
 108
 109 /* Because of various casts and different args can't use IMPLEMENT_BLOCK_CIPHER */
 110
 111 static int des_ede_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 112                               const unsigned char *in, size_t inl)
 113 {
 114         BLOCK_CIPHER_ecb_loop()
 115                 DES_ecb3_encrypt((const_DES_cblock *)(in + i),
 116                                  (DES_cblock *)(out + i),
 117                                  &data(ctx)->ks1, &data(ctx)->ks2,
 118                                  &data(ctx)->ks3,
 119                                  ctx->encrypt);
 120         return 1;
 121 }
 122
 123 static int des_ede_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 124                               const unsigned char *in, size_t inl)
 125 {
 126         while (inl>=EVP_MAXCHUNK)
 127                 {
 128                 DES_ede3_ofb64_encrypt(in, out, (long)EVP_MAXCHUNK,
 129                                &data(ctx)->ks1, &data(ctx)->ks2, &data(ctx)->ks3,
 130                                (DES_cblock *)ctx->iv, &ctx->num);
 131                 inl-=EVP_MAXCHUNK;
 132                 in +=EVP_MAXCHUNK;
 133                 out+=EVP_MAXCHUNK;
 134                 }
 135         if (inl)
 136                 DES_ede3_ofb64_encrypt(in, out, (long)inl,
 137                                 &data(ctx)->ks1, &data(ctx)->ks2, &data(ctx)->ks3,
 138                                (DES_cblock *)ctx->iv, &ctx->num);
 139
 140         return 1;
 141 }
 142
 143 static int des_ede_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 144                               const unsigned char *in, size_t inl)
 145 {
 146         DES_EDE_KEY *dat = data(ctx);
 147
 148 #ifdef KSSL_DEBUG
 149         {
 150         int i;
 151         char *cp;
 152         printf("des_ede_cbc_cipher(ctx=%lx, buflen=%d)\n", ctx, ctx->buf_len);
 153         printf("\t iv= ");
 154         for(i=0;i<8;i++)
 155                 printf("%02X",ctx->iv[i]);
 156         printf("\n");
 157         }
 158 #endif    /* KSSL_DEBUG */
 159         if (dat->stream.cbc)
 160                 {
 161                 (*dat->stream.cbc)(in,out,inl,&dat->ks,ctx->iv);
 162                 return 1;
 163                 }
 164
 165         while (inl>=EVP_MAXCHUNK)
 166                 {
 167                 DES_ede3_cbc_encrypt(in, out, (long)EVP_MAXCHUNK,
 168                              &dat->ks1, &dat->ks2, &dat->ks3,
 169                              (DES_cblock *)ctx->iv, ctx->encrypt);
 170                 inl-=EVP_MAXCHUNK;
 171                 in +=EVP_MAXCHUNK;
 172                 out+=EVP_MAXCHUNK;
 173                 }
 174         if (inl)
 175                 DES_ede3_cbc_encrypt(in, out, (long)inl,
 176                              &dat->ks1, &dat->ks2, &dat->ks3,
 177                              (DES_cblock *)ctx->iv, ctx->encrypt);
 178         return 1;
 179 }
 180
 181 static int des_ede_cfb64_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 182                               const unsigned char *in, size_t inl)
 183 {
 184         while (inl>=EVP_MAXCHUNK)
 185                 {
 186                 DES_ede3_cfb64_encrypt(in, out, (long)EVP_MAXCHUNK,
 187                                &data(ctx)->ks1, &data(ctx)->ks2, &data(ctx)->ks3,
 188                                (DES_cblock *)ctx->iv, &ctx->num, ctx->encrypt);
 189                 inl-=EVP_MAXCHUNK;
 190                 in +=EVP_MAXCHUNK;
 191                 out+=EVP_MAXCHUNK;
 192                 }
 193         if (inl)
 194                 DES_ede3_cfb64_encrypt(in, out, (long)inl,
 195                                &data(ctx)->ks1, &data(ctx)->ks2, &data(ctx)->ks3,
 196                                (DES_cblock *)ctx->iv, &ctx->num, ctx->encrypt);
 197         return 1;
 198 }
 199
 200 /* Although we have a CFB-r implementation for 3-DES, it doesn't pack the right
 201    way, so wrap it here */
 202 static int des_ede3_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 203                                 const unsigned char *in, size_t inl)
 204     {
 205     size_t n;
 206     unsigned char c[1],d[1];
 207
 208     for(n=0 ; n < inl ; ++n)
 209         {
 210         c[0]=(in[n/8]&(1 << (7-n%8))) ? 0x80 : 0;
 211         DES_ede3_cfb_encrypt(c,d,1,1,
 212                              &data(ctx)->ks1,&data(ctx)->ks2,&data(ctx)->ks3,
 213                              (DES_cblock *)ctx->iv,ctx->encrypt);
 214         out[n/8]=(out[n/8]&~(0x80 >> (unsigned int)(n%8))) |
 215                  ((d[0]&0x80) >> (unsigned int)(n%8));
 216         }
 217
 218     return 1;
 219     }
 220
 221 static int des_ede3_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 222                                 const unsigned char *in, size_t inl)
 223     {
 224     while (inl>=EVP_MAXCHUNK)
 225         {
 226         DES_ede3_cfb_encrypt(in,out,8,(long)EVP_MAXCHUNK,
 227                          &data(ctx)->ks1,&data(ctx)->ks2,&data(ctx)->ks3,
 228                          (DES_cblock *)ctx->iv,ctx->encrypt);
 229         inl-=EVP_MAXCHUNK;
 230         in +=EVP_MAXCHUNK;
 231         out+=EVP_MAXCHUNK;
 232         }
 233     if (inl)
 234         DES_ede3_cfb_encrypt(in,out,8,(long)inl,
 235                         &data(ctx)->ks1,&data(ctx)->ks2,&data(ctx)->ks3,
 236                         (DES_cblock *)ctx->iv,ctx->encrypt);
 237     return 1;
 238     }
 239
 240 BLOCK_CIPHER_defs(des_ede, DES_EDE_KEY, NID_des_ede, 8, 16, 8, 64,
 241                         EVP_CIPH_RAND_KEY|EVP_CIPH_FLAG_DEFAULT_ASN1,
 242                         des_ede_init_key, NULL, NULL, NULL,
 243                         des3_ctrl)
 244
 245 #define des_ede3_cfb64_cipher des_ede_cfb64_cipher
 246 #define des_ede3_ofb_cipher des_ede_ofb_cipher
 247 #define des_ede3_cbc_cipher des_ede_cbc_cipher
 248 #define des_ede3_ecb_cipher des_ede_ecb_cipher
 249
 250 BLOCK_CIPHER_defs(des_ede3, DES_EDE_KEY, NID_des_ede3, 8, 24, 8, 64,
 251                 EVP_CIPH_RAND_KEY|EVP_CIPH_FLAG_FIPS|EVP_CIPH_FLAG_DEFAULT_ASN1,
 252                   des_ede3_init_key, NULL, NULL, NULL,
 253                   des3_ctrl)
 254
 255 BLOCK_CIPHER_def_cfb(des_ede3,DES_EDE_KEY,NID_des_ede3,24,8,1,
 256                 EVP_CIPH_RAND_KEY|EVP_CIPH_FLAG_FIPS|EVP_CIPH_FLAG_DEFAULT_ASN1,
 257                         des_ede3_init_key, NULL, NULL, NULL,
 258                         des3_ctrl)
 259
 260 BLOCK_CIPHER_def_cfb(des_ede3,DES_EDE_KEY,NID_des_ede3,24,8,8,
 261                 EVP_CIPH_RAND_KEY|EVP_CIPH_FLAG_FIPS|EVP_CIPH_FLAG_DEFAULT_ASN1,
 262                         des_ede3_init_key, NULL, NULL, NULL,
 263                         des3_ctrl)
 264
 265 static int des_ede_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 266                             const unsigned char *iv, int enc)
 267         {
 268         DES_cblock *deskey = (DES_cblock *)key;
 269         DES_EDE_KEY *dat = data(ctx);
 270
 271         dat->stream.cbc = NULL;
 272 #if defined(SPARC_DES_CAPABLE)
 273         if (SPARC_DES_CAPABLE)
 274                 {
 275                 int mode = ctx->cipher->flags & EVP_CIPH_MODE;
 276
 277                 if (mode == EVP_CIPH_CBC_MODE)
 278                         {
 279                         des_t4_key_expand(&deskey[0],&dat->ks1);
 280                         des_t4_key_expand(&deskey[1],&dat->ks2);
 281                         memcpy(&dat->ks3,&dat->ks1,sizeof(dat->ks1));
 282                         dat->stream.cbc = enc ? des_t4_ede3_cbc_encrypt :
 283                                                 des_t4_ede3_cbc_decrypt;
 284                         return 1;
 285                         }
 286                 }
 287 #endif
 288 #ifdef EVP_CHECK_DES_KEY
 289         if (DES_set_key_checked(&deskey[0],&dat->ks1)
 290                 !! DES_set_key_checked(&deskey[1],&dat->ks2))
 291                 return 0;
 292 #else
 293         DES_set_key_unchecked(&deskey[0],&dat->ks1);
 294         DES_set_key_unchecked(&deskey[1],&dat->ks2);
 295 #endif
 296         memcpy(&dat->ks3,&dat->ks1,
 297                sizeof(dat->ks1));
 298         return 1;
 299         }
 300
 301 static int des_ede3_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 302                              const unsigned char *iv, int enc)
 303         {
 304         DES_cblock *deskey = (DES_cblock *)key;
 305         DES_EDE_KEY *dat = data(ctx);
 306
 307 #ifdef KSSL_DEBUG
 308         {
 309         int i;
 310         printf("des_ede3_init_key(ctx=%lx)\n", ctx);
 311         printf("\tKEY= ");
 312         for(i=0;i<24;i++) printf("%02X",key[i]); printf("\n");
 313         printf("\t IV= ");
 314         for(i=0;i<8;i++) printf("%02X",iv[i]); printf("\n");
 315         }
 316 #endif  /* KSSL_DEBUG */
 317
 318         dat->stream.cbc = NULL;
 319 #if defined(SPARC_DES_CAPABLE)
 320         if (SPARC_DES_CAPABLE)
 321                 {
 322                 int mode = ctx->cipher->flags & EVP_CIPH_MODE;
 323
 324                 if (mode == EVP_CIPH_CBC_MODE)
 325                         {
 326                         des_t4_key_expand(&deskey[0],&dat->ks1);
 327                         des_t4_key_expand(&deskey[1],&dat->ks2);
 328                         des_t4_key_expand(&deskey[2],&dat->ks3);
 329                         dat->stream.cbc = enc ? des_t4_ede3_cbc_encrypt :
 330                                                 des_t4_ede3_cbc_decrypt;
 331                         return 1;
 332                         }
 333                 }
 334 #endif
 335 #ifdef EVP_CHECK_DES_KEY
 336         if (DES_set_key_checked(&deskey[0],&dat->ks1)
 337                 || DES_set_key_checked(&deskey[1],&dat->ks2)
 338                 || DES_set_key_checked(&deskey[2],&dat->ks3))
 339                 return 0;
 340 #else
 341         DES_set_key_unchecked(&deskey[0],&dat->ks1);
 342         DES_set_key_unchecked(&deskey[1],&dat->ks2);
 343         DES_set_key_unchecked(&deskey[2],&dat->ks3);
 344 #endif
 345         return 1;
 346         }
 347
 348 static int des3_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
 349         {
 350
 351         DES_cblock *deskey = ptr;
 352
 353         switch(type)
 354                 {
 355         case EVP_CTRL_RAND_KEY:
 356                 if (RAND_bytes(ptr, c->key_len) <= 0)
 357                         return 0;
 358                 DES_set_odd_parity(deskey);
 359                 if (c->key_len >= 16)
 360                         DES_set_odd_parity(deskey + 1);
 361                 if (c->key_len >= 24)
 362                         DES_set_odd_parity(deskey + 2);
 363                 return 1;
 364
 365         default:
 366                 return -1;
 367                 }
 368         }
 369
 370 const EVP_CIPHER *EVP_des_ede(void)
 371 {
 372         return &des_ede_ecb;
 373 }
 374
 375 const EVP_CIPHER *EVP_des_ede3(void)
 376 {
 377         return &des_ede3_ecb;
 378 }
 379
 380 #ifndef OPENSSL_NO_SHA
 381
 382 #include <openssl/sha.h>
 383
 384 static const unsigned char wrap_iv[8] = {0x4a,0xdd,0xa2,0x2c,0x79,0xe8,0x21,0x05};
 385
 386 static int des_ede3_unwrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
 387                                 const unsigned char *in, size_t inl)
 388         {
 389         unsigned char icv[8], iv[8], sha1tmp[SHA_DIGEST_LENGTH];
 390         int rv = -1;
 391         if (inl < 24)
 392                 return -1;
 393         if (!out)
 394                 return inl - 16;
 395         memcpy(ctx->iv, wrap_iv, 8);
 396         /* Decrypt first block which will end up as icv */
 397         des_ede_cbc_cipher(ctx, icv, in, 8);
 398         /* Decrypt central blocks */
 399         /* If decrypting in place move whole output along a block
 400          * so the next des_ede_cbc_cipher is in place.
 401          */
 402         if (out == in)
 403                 {
 404                 memmove(out, out + 8, inl - 8);
 405                 in -= 8;
 406                 }
 407         des_ede_cbc_cipher(ctx, out, in + 8, inl - 16);
 408         /* Decrypt final block which will be IV */
 409         des_ede_cbc_cipher(ctx, iv, in + inl - 8, 8);
 410         /* Reverse order of everything */
 411         BUF_reverse(icv, NULL, 8);
 412         BUF_reverse(out, NULL, inl - 16);
 413         BUF_reverse(ctx->iv, iv, 8);
 414         /* Decrypt again using new IV */
 415         des_ede_cbc_cipher(ctx, out, out, inl - 16);
 416         des_ede_cbc_cipher(ctx, icv, icv, 8);
 417         /* Work out SHA1 hash of first portion */
 418         SHA1(out, inl - 16, sha1tmp);
 419
 420         if (!CRYPTO_memcmp(sha1tmp, icv, 8))
 421                 rv = inl - 16;
 422         OPENSSL_cleanse(icv, 8);
 423         OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
 424         OPENSSL_cleanse(iv, 8);
 425         OPENSSL_cleanse(ctx->iv, 8);
 426         if (rv == -1)
 427                 OPENSSL_cleanse(out, inl - 16);
 428
 429         return rv;
 430         }
 431
 432 static int des_ede3_wrap(EVP_CIPHER_CTX *ctx, unsigned char *out,
 433                                 const unsigned char *in, size_t inl)
 434         {
 435         unsigned char sha1tmp[SHA_DIGEST_LENGTH];
 436         if (!out)
 437                 return inl + 16;
 438         /* Copy input to output buffer + 8 so we have space for IV */
 439         memmove(out + 8, in, inl);
 440         /* Work out ICV */
 441         SHA1(in, inl, sha1tmp);
 442         memcpy(out + inl + 8, sha1tmp, 8);
 443         OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
 444         /* Generate random IV */
 445         RAND_bytes(ctx->iv, 8);
 446         memcpy(out, ctx->iv, 8);
 447         /* Encrypt everything after IV in place */
 448         des_ede_cbc_cipher(ctx, out + 8, out + 8, inl + 8);
 449         BUF_reverse(out, NULL, inl + 16);
 450         memcpy(ctx->iv, wrap_iv, 8);
 451         des_ede_cbc_cipher(ctx, out, out, inl + 16);
 452         return inl + 16;
 453         }
 454
 455 static int des_ede3_wrap_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 456                                 const unsigned char *in, size_t inl)
 457         {
 458         /* Sanity check input length: we typically only wrap keys
 459          * so EVP_MAXCHUNK is more than will ever be needed. Also
 460          * input length must be a multiple of 8 bits.
 461          */
 462         if (inl >= EVP_MAXCHUNK || inl % 8)
 463                 return -1;
 464         if (ctx->encrypt)
 465                 return des_ede3_wrap(ctx, out, in, inl);
 466         else
 467                 return des_ede3_unwrap(ctx, out, in, inl);
 468         }
 469
 470 static const EVP_CIPHER des3_wrap = {
 471         NID_id_smime_alg_CMS3DESwrap,
 472         8, 24, 0,
 473         EVP_CIPH_WRAP_MODE|EVP_CIPH_CUSTOM_IV|EVP_CIPH_FLAG_CUSTOM_CIPHER
 474                 |EVP_CIPH_FLAG_DEFAULT_ASN1,
 475         des_ede3_init_key, des_ede3_wrap_cipher,
 476         NULL,
 477         sizeof(DES_EDE_KEY),
 478         NULL,NULL,NULL,NULL };
 479
 480
 481 const EVP_CIPHER *EVP_des_ede3_wrap(void)
 482         {
 483         return &des3_wrap;
 484         }
 485
 486 # endif
 487 #endif