crypto/libressl/crypto/evp/p5_crpt2.c

   1 /* $OpenBSD: p5_crpt2.c,v 1.24 2021/12/12 21:27:37 tb Exp $ */
   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
  59 #include <stdio.h>
  60 #include <stdlib.h>
  61 #include <string.h>
  62
  63 #include <openssl/opensslconf.h>
  64
  65 #if !defined(OPENSSL_NO_HMAC) && !defined(OPENSSL_NO_SHA)
  66
  67 #include <openssl/err.h>
  68 #include <openssl/evp.h>
  69 #include <openssl/hmac.h>
  70 #include <openssl/x509.h>
  71
  72 #include "evp_locl.h"
  73 #include "hmac_local.h"
  74
  75 /* This is an implementation of PKCS#5 v2.0 password based encryption key
  76  * derivation function PBKDF2.
  77  * SHA1 version verified against test vectors posted by Peter Gutmann
  78  * <pgut001@cs.auckland.ac.nz> to the PKCS-TNG <pkcs-tng@rsa.com> mailing list.
  79  */
  80
  81 int
  82 PKCS5_PBKDF2_HMAC(const char *pass, int passlen, const unsigned char *salt,
  83     int saltlen, int iter, const EVP_MD *digest, int keylen, unsigned char *out)
  84 {
  85         unsigned char digtmp[EVP_MAX_MD_SIZE], *p, itmp[4];
  86         int cplen, j, k, tkeylen, mdlen;
  87         unsigned long i = 1;
  88         HMAC_CTX hctx_tpl, hctx;
  89
  90         mdlen = EVP_MD_size(digest);
  91         if (mdlen < 0)
  92                 return 0;
  93
  94         HMAC_CTX_init(&hctx_tpl);
  95         p = out;
  96         tkeylen = keylen;
  97         if (!pass)
  98                 passlen = 0;
  99         else if (passlen == -1)
 100                 passlen = strlen(pass);
 101         if (!HMAC_Init_ex(&hctx_tpl, pass, passlen, digest, NULL)) {
 102                 HMAC_CTX_cleanup(&hctx_tpl);
 103                 return 0;
 104         }
 105         while (tkeylen) {
 106                 if (tkeylen > mdlen)
 107                         cplen = mdlen;
 108                 else
 109                         cplen = tkeylen;
 110                 /* We are unlikely to ever use more than 256 blocks (5120 bits!)
 111                  * but just in case...
 112                  */
 113                 itmp[0] = (unsigned char)((i >> 24) & 0xff);
 114                 itmp[1] = (unsigned char)((i >> 16) & 0xff);
 115                 itmp[2] = (unsigned char)((i >> 8) & 0xff);
 116                 itmp[3] = (unsigned char)(i & 0xff);
 117                 if (!HMAC_CTX_copy(&hctx, &hctx_tpl)) {
 118                         HMAC_CTX_cleanup(&hctx_tpl);
 119                         return 0;
 120                 }
 121                 if (!HMAC_Update(&hctx, salt, saltlen) ||
 122                     !HMAC_Update(&hctx, itmp, 4) ||
 123                     !HMAC_Final(&hctx, digtmp, NULL)) {
 124                         HMAC_CTX_cleanup(&hctx_tpl);
 125                         HMAC_CTX_cleanup(&hctx);
 126                         return 0;
 127                 }
 128                 HMAC_CTX_cleanup(&hctx);
 129                 memcpy(p, digtmp, cplen);
 130                 for (j = 1; j < iter; j++) {
 131                         if (!HMAC_CTX_copy(&hctx, &hctx_tpl)) {
 132                                 HMAC_CTX_cleanup(&hctx_tpl);
 133                                 return 0;
 134                         }
 135                         if (!HMAC_Update(&hctx, digtmp, mdlen) ||
 136                             !HMAC_Final(&hctx, digtmp, NULL)) {
 137                                 HMAC_CTX_cleanup(&hctx_tpl);
 138                                 HMAC_CTX_cleanup(&hctx);
 139                                 return 0;
 140                         }
 141                         HMAC_CTX_cleanup(&hctx);
 142                         for (k = 0; k < cplen; k++)
 143                                 p[k] ^= digtmp[k];
 144                 }
 145                 tkeylen -= cplen;
 146                 i++;
 147                 p += cplen;
 148         }
 149         HMAC_CTX_cleanup(&hctx_tpl);
 150         return 1;
 151 }
 152
 153 int
 154 PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen, const unsigned char *salt,
 155     int saltlen, int iter, int keylen, unsigned char *out)
 156 {
 157         return PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter,
 158             EVP_sha1(), keylen, out);
 159 }
 160
 161 /* Now the key derivation function itself. This is a bit evil because
 162  * it has to check the ASN1 parameters are valid: and there are quite a
 163  * few of them...
 164  */
 165
 166 int
 167 PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 168     ASN1_TYPE *param, const EVP_CIPHER *c, const EVP_MD *md, int en_de)
 169 {
 170         const unsigned char *pbuf;
 171         int plen;
 172         PBE2PARAM *pbe2 = NULL;
 173         const EVP_CIPHER *cipher;
 174
 175         int rv = 0;
 176
 177         if (param == NULL || param->type != V_ASN1_SEQUENCE ||
 178             param->value.sequence == NULL) {
 179                 EVPerror(EVP_R_DECODE_ERROR);
 180                 goto err;
 181         }
 182
 183         pbuf = param->value.sequence->data;
 184         plen = param->value.sequence->length;
 185         if (!(pbe2 = d2i_PBE2PARAM(NULL, &pbuf, plen))) {
 186                 EVPerror(EVP_R_DECODE_ERROR);
 187                 goto err;
 188         }
 189
 190         /* See if we recognise the key derivation function */
 191
 192         if (OBJ_obj2nid(pbe2->keyfunc->algorithm) != NID_id_pbkdf2) {
 193                 EVPerror(EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION);
 194                 goto err;
 195         }
 196
 197         /* lets see if we recognise the encryption algorithm.
 198          */
 199
 200         cipher = EVP_get_cipherbyobj(pbe2->encryption->algorithm);
 201
 202         if (!cipher) {
 203                 EVPerror(EVP_R_UNSUPPORTED_CIPHER);
 204                 goto err;
 205         }
 206
 207         /* Fixup cipher based on AlgorithmIdentifier */
 208         if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, en_de))
 209                 goto err;
 210         if (EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) < 0) {
 211                 EVPerror(EVP_R_CIPHER_PARAMETER_ERROR);
 212                 goto err;
 213         }
 214         rv = PKCS5_v2_PBKDF2_keyivgen(ctx, pass, passlen,
 215             pbe2->keyfunc->parameter, c, md, en_de);
 216
 217 err:
 218         PBE2PARAM_free(pbe2);
 219         return rv;
 220 }
 221
 222 int
 223 PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 224     ASN1_TYPE *param, const EVP_CIPHER *c, const EVP_MD *md, int en_de)
 225 {
 226         unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
 227         const unsigned char *pbuf;
 228         int saltlen, iter, plen;
 229         int rv = 0;
 230         unsigned int keylen = 0;
 231         int prf_nid, hmac_md_nid;
 232         PBKDF2PARAM *kdf = NULL;
 233         const EVP_MD *prfmd;
 234
 235         if (EVP_CIPHER_CTX_cipher(ctx) == NULL) {
 236                 EVPerror(EVP_R_NO_CIPHER_SET);
 237                 return 0;
 238         }
 239         keylen = EVP_CIPHER_CTX_key_length(ctx);
 240         if (keylen > sizeof key) {
 241                 EVPerror(EVP_R_BAD_KEY_LENGTH);
 242                 return 0;
 243         }
 244
 245         /* Decode parameter */
 246
 247         if (!param || (param->type != V_ASN1_SEQUENCE)) {
 248                 EVPerror(EVP_R_DECODE_ERROR);
 249                 return 0;
 250         }
 251
 252         pbuf = param->value.sequence->data;
 253         plen = param->value.sequence->length;
 254
 255         if (!(kdf = d2i_PBKDF2PARAM(NULL, &pbuf, plen)) ) {
 256                 EVPerror(EVP_R_DECODE_ERROR);
 257                 return 0;
 258         }
 259
 260         /* Now check the parameters of the kdf */
 261
 262         if (kdf->keylength &&
 263             (ASN1_INTEGER_get(kdf->keylength) != (int)keylen)){
 264                 EVPerror(EVP_R_UNSUPPORTED_KEYLENGTH);
 265                 goto err;
 266         }
 267
 268         if (kdf->prf)
 269                 prf_nid = OBJ_obj2nid(kdf->prf->algorithm);
 270         else
 271                 prf_nid = NID_hmacWithSHA1;
 272
 273         if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, prf_nid, NULL, &hmac_md_nid, 0)) {
 274                 EVPerror(EVP_R_UNSUPPORTED_PRF);
 275                 goto err;
 276         }
 277
 278         prfmd = EVP_get_digestbynid(hmac_md_nid);
 279         if (prfmd == NULL) {
 280                 EVPerror(EVP_R_UNSUPPORTED_PRF);
 281                 goto err;
 282         }
 283
 284         if (kdf->salt->type != V_ASN1_OCTET_STRING) {
 285                 EVPerror(EVP_R_UNSUPPORTED_SALT_TYPE);
 286                 goto err;
 287         }
 288
 289         /* it seems that its all OK */
 290         salt = kdf->salt->value.octet_string->data;
 291         saltlen = kdf->salt->value.octet_string->length;
 292         if ((iter = ASN1_INTEGER_get(kdf->iter)) <= 0) {
 293                 EVPerror(EVP_R_UNSUPORTED_NUMBER_OF_ROUNDS);
 294                 goto err;
 295         }
 296         if (!PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, prfmd,
 297             keylen, key))
 298                 goto err;
 299         rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
 300
 301 err:
 302         explicit_bzero(key, keylen);
 303         PBKDF2PARAM_free(kdf);
 304         return rv;
 305 }
 306
 307 #endif