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