crypto/evp/p5_crpt2.c

   1 /* p5_crpt2.c */
   2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
   3  * project 1999.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999 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 <openssl/x509.h>
  61 #include <openssl/evp.h>
  62 #include <openssl/hmac.h>
  63 #include "cryptlib.h"
  64
  65 /* This is an implementation of PKCS#5 v2.0 password based encryption key
  66  * derivation function PBKDF2 using the only currently defined function HMAC
  67  * with SHA1. Verified against test vectors posted by Peter Gutmann
  68  * <pgut001@cs.auckland.ac.nz> to the PKCS-TNG <pkcs-tng@rsa.com> mailing list.
  69  */
  70
  71 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
  72                                 unsigned char *salt, int saltlen, int iter,
  73                                          int keylen, unsigned char *out)
  74 {
  75         unsigned char digtmp[SHA_DIGEST_LENGTH], *p, itmp[4];
  76         int cplen, j, k;
  77         unsigned long i = 1;
  78         HMAC_CTX hctx;
  79         p = out;
  80         if(passlen == -1) passlen = strlen(pass);
  81         while(keylen) {
  82                 if(keylen > SHA_DIGEST_LENGTH) cplen = SHA_DIGEST_LENGTH;
  83                 else cplen = keylen;
  84                 /* We are unlikely to ever use more than 256 blocks (5120 bits!)
  85                  * but just in case...
  86                  */
  87                 itmp[0] = (i >> 24) & 0xff;
  88                 itmp[1] = (i >> 16) & 0xff;
  89                 itmp[2] = (i >> 8) & 0xff;
  90                 itmp[3] = i & 0xff;
  91                 HMAC_Init(&hctx, pass, passlen, EVP_sha1());
  92                 HMAC_Update(&hctx, salt, saltlen);
  93                 HMAC_Update(&hctx, itmp, 4);
  94                 HMAC_Final(&hctx, digtmp, NULL);
  95                 memcpy(p, digtmp, cplen);
  96                 for(j = 1; j < iter; j++) {
  97                         HMAC(EVP_sha1(), pass, passlen,
  98                                  digtmp, SHA_DIGEST_LENGTH, digtmp, NULL);
  99                         for(k = 0; k < cplen; k++) p[k] ^= digtmp[k];
 100                 }
 101                 keylen-= cplen;
 102                 i++;
 103                 p+= cplen;
 104         }
 105         HMAC_cleanup(&hctx);
 106         return 1;
 107 }
 108
 109 #ifdef DO_TEST
 110 main()
 111 {
 112         unsigned char out[4];
 113         unsigned char salt[] = {0x12, 0x34, 0x56, 0x78};
 114         PKCS5_PBKDF2_HMAC_SHA1("password", -1, salt, 4, 5, 4, out);
 115         fprintf(stderr, "Out %02X %02X %02X %02X\n",
 116                                          out[0], out[1], out[2], out[3]);
 117 }
 118
 119 #endif
 120
 121 /* Now the key derivation function itself. This is a bit evil because
 122  * it has to check the ASN1 parameters are valid: and there are quite a
 123  * few of them...
 124  */
 125
 126 int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 127                          ASN1_TYPE *param, EVP_CIPHER *c, EVP_MD *md,
 128                          int en_de)
 129 {
 130         unsigned char *pbuf, *salt, key[EVP_MAX_KEY_LENGTH];
 131         int saltlen, keylen, iter, plen;
 132         PBE2PARAM *pbe2 = NULL;
 133         const EVP_CIPHER *cipher;
 134         PBKDF2PARAM *kdf = NULL;
 135
 136         pbuf = param->value.sequence->data;
 137         plen = param->value.sequence->length;
 138         if(!param || (param->type != V_ASN1_SEQUENCE) ||
 139                                    !(pbe2 = d2i_PBE2PARAM(NULL, &pbuf, plen))) {
 140                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
 141                 return 0;
 142         }
 143
 144         /* See if we recognise the key derivation function */
 145
 146         if(OBJ_obj2nid(pbe2->keyfunc->algorithm) != NID_id_pbkdf2) {
 147                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 148                                 EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION);
 149                 goto err;
 150         }
 151
 152         /* lets see if we recognise the encryption algorithm.
 153          */
 154
 155         cipher = EVP_get_cipherbyname(
 156                         OBJ_nid2sn(OBJ_obj2nid(pbe2->encryption->algorithm)));
 157
 158         if(!cipher) {
 159                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 160                                                 EVP_R_UNSUPPORTED_CIPHER);
 161                 goto err;
 162         }
 163
 164         /* Fixup cipher based on AlgorithmIdentifier */
 165         EVP_CipherInit(ctx, cipher, NULL, NULL, en_de);
 166         if(EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) < 0) {
 167                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 168                                         EVP_R_CIPHER_PARAMETER_ERROR);
 169                 goto err;
 170         }
 171         keylen = EVP_CIPHER_CTX_key_length(ctx);
 172
 173         /* Now decode key derivation function */
 174
 175         pbuf = pbe2->keyfunc->parameter->value.sequence->data;
 176         plen = pbe2->keyfunc->parameter->value.sequence->length;
 177         if(!pbe2->keyfunc->parameter ||
 178                  (pbe2->keyfunc->parameter->type != V_ASN1_SEQUENCE) ||
 179                                 !(kdf = d2i_PBKDF2PARAM(NULL, &pbuf, plen)) ) {
 180                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
 181                 goto err;
 182         }
 183
 184         PBE2PARAM_free(pbe2);
 185         pbe2 = NULL;
 186
 187         /* Now check the parameters of the kdf */
 188
 189         if(kdf->keylength && (ASN1_INTEGER_get(kdf->keylength) != keylen)){
 190                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 191                                                 EVP_R_UNSUPPORTED_KEYLENGTH);
 192                 goto err;
 193         }
 194
 195         if(kdf->prf && (OBJ_obj2nid(kdf->prf->algorithm) != NID_hmacWithSHA1)) {
 196                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
 197                 goto err;
 198         }
 199
 200         if(kdf->salt->type != V_ASN1_OCTET_STRING) {
 201                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
 202                                                 EVP_R_UNSUPPORTED_SALT_TYPE);
 203                 goto err;
 204         }
 205
 206         /* it seems that its all OK */
 207         salt = kdf->salt->value.octet_string->data;
 208         saltlen = kdf->salt->value.octet_string->length;
 209         iter = ASN1_INTEGER_get(kdf->iter);
 210         PKCS5_PBKDF2_HMAC_SHA1(pass, passlen, salt, saltlen, iter, keylen, key);
 211         EVP_CipherInit(ctx, NULL, key, NULL, en_de);
 212         memset(key, 0, keylen);
 213         PBKDF2PARAM_free(kdf);
 214         return 1;
 215
 216         err:
 217         PBE2PARAM_free(pbe2);
 218         PBKDF2PARAM_free(kdf);
 219         return 0;
 220 }
 221