crypto/evp/p5_crpt2.c

   1 /* p5_crpt2.c */
   2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
   3  * project 1999.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999-2006 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58 #include <stdio.h>
  59 #include <stdlib.h>
  60 #include "cryptlib.h"
  61 #if !defined(OPENSSL_NO_HMAC) && !defined(OPENSSL_NO_SHA)
  62 #include <openssl/x509.h>
  63 #include <openssl/evp.h>
  64 #include <openssl/hmac.h>
  65
  66 /* set this to print out info about the keygen algorithm */
  67 /* #define DEBUG_PKCS5V2 */
  68
  69 #ifdef DEBUG_PKCS5V2
  70         static void h__dump (const unsigned char *p, int len);
  71 #endif
  72
  73 /* This is an implementation of PKCS#5 v2.0 password based encryption key
  74  * derivation function PBKDF2.
  75  * SHA1 version verified against test vectors posted by Peter Gutmann
  76  * <pgut001@cs.auckland.ac.nz> to the PKCS-TNG <pkcs-tng@rsa.com> mailing list.
  77  */
  78
  79 int PKCS5_PBKDF2_HMAC(const char *pass, int passlen,
  80                            const unsigned char *salt, int saltlen, int iter,
  81                            const EVP_MD *digest,
  82                            int keylen, unsigned char *out)
  83         {
  84         unsigned char digtmp[EVP_MAX_MD_SIZE], *p, itmp[4];
  85         int cplen, j, k, tkeylen, mdlen;
  86         unsigned long i = 1;
  87         HMAC_CTX hctx_tpl, hctx;
  88
  89         mdlen = EVP_MD_size(digest);
  90         if (mdlen < 0)
  91                 return 0;
  92
  93         HMAC_CTX_init(&hctx);
  94         p = out;
  95         tkeylen = keylen;
  96         if(!pass)
  97                 passlen = 0;
  98         else if(passlen == -1)
  99                 passlen = strlen(pass);
 100         if (!HMAC_Init_ex(&hctx_tpl, pass, passlen, digest, NULL))
 101                 {
 102                 HMAC_CTX_cleanup(&hctx_tpl);
 103                 return 0;
 104                 }
 105         while(tkeylen)
 106                 {
 107                 if(tkeylen > mdlen)
 108                         cplen = mdlen;
 109                 else
 110                         cplen = tkeylen;
 111                 /* We are unlikely to ever use more than 256 blocks (5120 bits!)
 112                  * but just in case...
 113                  */
 114                 itmp[0] = (unsigned char)((i >> 24) & 0xff);
 115                 itmp[1] = (unsigned char)((i >> 16) & 0xff);
 116                 itmp[2] = (unsigned char)((i >> 8) & 0xff);
 117                 itmp[3] = (unsigned char)(i & 0xff);
 118                 if (!HMAC_CTX_copy(&hctx, &hctx_tpl))
 119                         {
 120                         HMAC_CTX_cleanup(&hctx_tpl);
 121                         return 0;
 122                         }
 123                 if (!HMAC_Update(&hctx, salt, saltlen)
 124                     || !HMAC_Update(&hctx, itmp, 4)
 125                     || !HMAC_Final(&hctx, digtmp, NULL))
 126                         {
 127                         HMAC_CTX_cleanup(&hctx_tpl);
 128                         HMAC_CTX_cleanup(&hctx);
 129                         return 0;
 130                         }
 131                 memcpy(p, digtmp, cplen);
 132                 for(j = 1; j < iter; j++)
 133                         {
 134                         if (!HMAC_CTX_copy(&hctx, &hctx_tpl))
 135                                 {
 136                                 HMAC_CTX_cleanup(&hctx_tpl);
 137                                 return 0;
 138                                 }
 139                         if (!HMAC_Update(&hctx, digtmp, mdlen)
 140                             || !HMAC_Final(&hctx, digtmp, NULL))
 141                                 {
 142                                 HMAC_CTX_cleanup(&hctx_tpl);
 143                                 HMAC_CTX_cleanup(&hctx);
 144                                 return 0;
 145                                 }
 146                         HMAC_CTX_cleanup(&hctx);
 147                         for(k = 0; k < cplen; k++)
 148                                 p[k] ^= digtmp[k];
 149                         }
 150                 tkeylen-= cplen;
 151                 i++;
 152                 p+= cplen;
 153                 }
 154         HMAC_CTX_cleanup(&hctx_tpl);
 155 #ifdef DEBUG_PKCS5V2
 156         fprintf(stderr, "Password:\n");
 157         h__dump (pass, passlen);
 158         fprintf(stderr, "Salt:\n");
 159         h__dump (salt, saltlen);
 160         fprintf(stderr, "Iteration count %d\n", iter);
 161         fprintf(stderr, "Key:\n");
 162         h__dump (out, keylen);
 163 #endif
 164         return 1;
 165         }
 166
 167 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
 168                            const unsigned char *salt, int saltlen, int iter,
 169                            int keylen, unsigned char *out)
 170         {
 171         return PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, EVP_sha1(),
 172                                         keylen, out);
 173         }
 174
 175 #ifdef DO_TEST
 176 main()
 177 {
 178         unsigned char out[4];
 179         unsigned char salt[] = {0x12, 0x34, 0x56, 0x78};
 180         PKCS5_PBKDF2_HMAC_SHA1("password", -1, salt, 4, 5, 4, out);
 181         fprintf(stderr, "Out %02X %02X %02X %02X\n",
 182                                          out[0], out[1], out[2], out[3]);
 183 }
 184
 185 #endif
 186
 187 /* Now the key derivation function itself. This is a bit evil because
 188  * it has to check the ASN1 parameters are valid: and there are quite a
 189  * few of them...
 190  */
 191
 192 int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 193                          ASN1_TYPE *param, const EVP_CIPHER *c, const EVP_MD *md,
 194                          int en_de)
 195 {
 196         unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
 197         const unsigned char *pbuf;
 198         int saltlen, iter, plen;
 199         unsigned int keylen;
 200         PBE2PARAM *pbe2 = NULL;
 201         const EVP_CIPHER *cipher;
 202         PBKDF2PARAM *kdf = NULL;
 203         const EVP_MD *prfmd;
 204         int prf_nid, hmac_md_nid;
 205
 206         if (param == NULL || param->type != V_ASN1_SEQUENCE ||
 207             param->value.sequence == NULL) {
 208                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
 209                 return 0;
 210         }
 211
 212         pbuf = param->value.sequence->data;
 213         plen = param->value.sequence->length;
 214         if(!(pbe2 = d2i_PBE2PARAM(NULL, &pbuf, plen))) {
 215                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
 216                 return 0;
 217         }
 218
 219         /* See if we recognise the key derivation function */
 220
 221         if(OBJ_obj2nid(pbe2->keyfunc->algorithm) != NID_id_pbkdf2) {
 222                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 223                                 EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION);
 224                 goto err;
 225         }
 226
 227         /* lets see if we recognise the encryption algorithm.
 228          */
 229
 230         cipher = EVP_get_cipherbyobj(pbe2->encryption->algorithm);
 231
 232         if(!cipher) {
 233                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 234                                                 EVP_R_UNSUPPORTED_CIPHER);
 235                 goto err;
 236         }
 237
 238         /* Fixup cipher based on AlgorithmIdentifier */
 239         EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, en_de);
 240         if(EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) < 0) {
 241                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 242                                         EVP_R_CIPHER_PARAMETER_ERROR);
 243                 goto err;
 244         }
 245         keylen = EVP_CIPHER_CTX_key_length(ctx);
 246         OPENSSL_assert(keylen <= sizeof key);
 247
 248         /* Now decode key derivation function */
 249
 250         if(!pbe2->keyfunc->parameter ||
 251                  (pbe2->keyfunc->parameter->type != V_ASN1_SEQUENCE))
 252                 {
 253                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
 254                 goto err;
 255                 }
 256
 257         pbuf = pbe2->keyfunc->parameter->value.sequence->data;
 258         plen = pbe2->keyfunc->parameter->value.sequence->length;
 259         if(!(kdf = d2i_PBKDF2PARAM(NULL, &pbuf, plen)) ) {
 260                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
 261                 goto err;
 262         }
 263
 264         PBE2PARAM_free(pbe2);
 265         pbe2 = NULL;
 266
 267         /* Now check the parameters of the kdf */
 268
 269         if(kdf->keylength && (ASN1_INTEGER_get(kdf->keylength) != (int)keylen)){
 270                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 271                                                 EVP_R_UNSUPPORTED_KEYLENGTH);
 272                 goto err;
 273         }
 274
 275         if (kdf->prf)
 276                 prf_nid = OBJ_obj2nid(kdf->prf->algorithm);
 277         else
 278                 prf_nid = NID_hmacWithSHA1;
 279
 280         if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, prf_nid, NULL, &hmac_md_nid, 0))
 281                 {
 282                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
 283                 goto err;
 284                 }
 285
 286         prfmd = EVP_get_digestbynid(hmac_md_nid);
 287         if (prfmd == NULL)
 288                 {
 289                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
 290                 goto err;
 291                 }
 292
 293         if(kdf->salt->type != V_ASN1_OCTET_STRING) {
 294                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 295                                                 EVP_R_UNSUPPORTED_SALT_TYPE);
 296                 goto err;
 297         }
 298
 299         /* it seems that its all OK */
 300         salt = kdf->salt->value.octet_string->data;
 301         saltlen = kdf->salt->value.octet_string->length;
 302         iter = ASN1_INTEGER_get(kdf->iter);
 303         if(!PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, prfmd,
 304                                                    keylen, key))
 305                 goto err;
 306         EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
 307         OPENSSL_cleanse(key, keylen);
 308         PBKDF2PARAM_free(kdf);
 309         return 1;
 310
 311         err:
 312         PBE2PARAM_free(pbe2);
 313         PBKDF2PARAM_free(kdf);
 314         return 0;
 315 }
 316
 317 #ifdef DEBUG_PKCS5V2
 318 static void h__dump (const unsigned char *p, int len)
 319 {
 320         for (; len --; p++) fprintf(stderr, "%02X ", *p);
 321         fprintf(stderr, "\n");
 322 }
 323 #endif
 324 #endif