crypto/asn1/p5_pbev2.c

   1 /*
   2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   3  * 1999-2004.
   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
  59 #include <stdio.h>
  60 #include "internal/cryptlib.h"
  61 #include <openssl/asn1t.h>
  62 #include <openssl/x509.h>
  63 #include <openssl/rand.h>
  64
  65 /* PKCS#5 v2.0 password based encryption structures */
  66
  67 ASN1_SEQUENCE(PBE2PARAM) = {
  68         ASN1_SIMPLE(PBE2PARAM, keyfunc, X509_ALGOR),
  69         ASN1_SIMPLE(PBE2PARAM, encryption, X509_ALGOR)
  70 } ASN1_SEQUENCE_END(PBE2PARAM)
  71
  72 IMPLEMENT_ASN1_FUNCTIONS(PBE2PARAM)
  73
  74 ASN1_SEQUENCE(PBKDF2PARAM) = {
  75         ASN1_SIMPLE(PBKDF2PARAM, salt, ASN1_ANY),
  76         ASN1_SIMPLE(PBKDF2PARAM, iter, ASN1_INTEGER),
  77         ASN1_OPT(PBKDF2PARAM, keylength, ASN1_INTEGER),
  78         ASN1_OPT(PBKDF2PARAM, prf, X509_ALGOR)
  79 } ASN1_SEQUENCE_END(PBKDF2PARAM)
  80
  81 IMPLEMENT_ASN1_FUNCTIONS(PBKDF2PARAM)
  82
  83 /*
  84  * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm: yes I know
  85  * this is horrible! Extended version to allow application supplied PRF NID
  86  * and IV.
  87  */
  88
  89 X509_ALGOR *PKCS5_pbe2_set_iv(const EVP_CIPHER *cipher, int iter,
  90                               unsigned char *salt, int saltlen,
  91                               unsigned char *aiv, int prf_nid)
  92 {
  93     X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
  94     int alg_nid, keylen;
  95     EVP_CIPHER_CTX *ctx = NULL;
  96     unsigned char iv[EVP_MAX_IV_LENGTH];
  97     PBE2PARAM *pbe2 = NULL;
  98     ASN1_OBJECT *obj;
  99
 100     alg_nid = EVP_CIPHER_type(cipher);
 101     if (alg_nid == NID_undef) {
 102         ASN1err(ASN1_F_PKCS5_PBE2_SET_IV,
 103                 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
 104         goto err;
 105     }
 106     obj = OBJ_nid2obj(alg_nid);
 107
 108     if ((pbe2 = PBE2PARAM_new()) == NULL)
 109         goto merr;
 110
 111     /* Setup the AlgorithmIdentifier for the encryption scheme */
 112     scheme = pbe2->encryption;
 113     scheme->algorithm = obj;
 114     if ((scheme->parameter = ASN1_TYPE_new()) == NULL)
 115         goto merr;
 116
 117     /* Create random IV */
 118     if (EVP_CIPHER_iv_length(cipher)) {
 119         if (aiv)
 120             memcpy(iv, aiv, EVP_CIPHER_iv_length(cipher));
 121         else if (RAND_bytes(iv, EVP_CIPHER_iv_length(cipher)) <= 0)
 122             goto err;
 123     }
 124
 125     ctx = EVP_CIPHER_CTX_new();
 126     if (ctx == NULL)
 127         goto merr;
 128
 129     /* Dummy cipherinit to just setup the IV, and PRF */
 130     if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0))
 131         goto err;
 132     if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) < 0) {
 133         ASN1err(ASN1_F_PKCS5_PBE2_SET_IV, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
 134         goto err;
 135     }
 136     /*
 137      * If prf NID unspecified see if cipher has a preference. An error is OK
 138      * here: just means use default PRF.
 139      */
 140     if ((prf_nid == -1) &&
 141         EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_PBE_PRF_NID, 0, &prf_nid) <= 0) {
 142         ERR_clear_error();
 143         prf_nid = NID_hmacWithSHA1;
 144     }
 145     EVP_CIPHER_CTX_free(ctx);
 146     ctx = NULL;
 147
 148     /* If its RC2 then we'd better setup the key length */
 149
 150     if (alg_nid == NID_rc2_cbc)
 151         keylen = EVP_CIPHER_key_length(cipher);
 152     else
 153         keylen = -1;
 154
 155     /* Setup keyfunc */
 156
 157     X509_ALGOR_free(pbe2->keyfunc);
 158
 159     pbe2->keyfunc = PKCS5_pbkdf2_set(iter, salt, saltlen, prf_nid, keylen);
 160
 161     if (!pbe2->keyfunc)
 162         goto merr;
 163
 164     /* Now set up top level AlgorithmIdentifier */
 165
 166     if ((ret = X509_ALGOR_new()) == NULL)
 167         goto merr;
 168
 169     ret->algorithm = OBJ_nid2obj(NID_pbes2);
 170
 171     /* Encode PBE2PARAM into parameter */
 172
 173     if (!ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
 174                                  &ret->parameter))
 175          goto merr;
 176
 177     PBE2PARAM_free(pbe2);
 178     pbe2 = NULL;
 179
 180     return ret;
 181
 182  merr:
 183     ASN1err(ASN1_F_PKCS5_PBE2_SET_IV, ERR_R_MALLOC_FAILURE);
 184
 185  err:
 186     EVP_CIPHER_CTX_free(ctx);
 187     PBE2PARAM_free(pbe2);
 188     /* Note 'scheme' is freed as part of pbe2 */
 189     X509_ALGOR_free(kalg);
 190     X509_ALGOR_free(ret);
 191
 192     return NULL;
 193
 194 }
 195
 196 X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
 197                            unsigned char *salt, int saltlen)
 198 {
 199     return PKCS5_pbe2_set_iv(cipher, iter, salt, saltlen, NULL, -1);
 200 }
 201
 202 X509_ALGOR *PKCS5_pbkdf2_set(int iter, unsigned char *salt, int saltlen,
 203                              int prf_nid, int keylen)
 204 {
 205     X509_ALGOR *keyfunc = NULL;
 206     PBKDF2PARAM *kdf = NULL;
 207     ASN1_OCTET_STRING *osalt = NULL;
 208
 209     if ((kdf = PBKDF2PARAM_new()) == NULL)
 210         goto merr;
 211     if ((osalt = ASN1_OCTET_STRING_new()) == NULL)
 212         goto merr;
 213
 214     kdf->salt->value.octet_string = osalt;
 215     kdf->salt->type = V_ASN1_OCTET_STRING;
 216
 217     if (saltlen == 0)
 218         saltlen = PKCS5_SALT_LEN;
 219     if ((osalt->data = OPENSSL_malloc(saltlen)) == NULL)
 220         goto merr;
 221
 222     osalt->length = saltlen;
 223
 224     if (salt)
 225         memcpy(osalt->data, salt, saltlen);
 226     else if (RAND_bytes(osalt->data, saltlen) <= 0)
 227         goto merr;
 228
 229     if (iter <= 0)
 230         iter = PKCS5_DEFAULT_ITER;
 231
 232     if (!ASN1_INTEGER_set(kdf->iter, iter))
 233         goto merr;
 234
 235     /* If have a key len set it up */
 236
 237     if (keylen > 0) {
 238         if ((kdf->keylength = ASN1_INTEGER_new()) == NULL)
 239             goto merr;
 240         if (!ASN1_INTEGER_set(kdf->keylength, keylen))
 241             goto merr;
 242     }
 243
 244     /* prf can stay NULL if we are using hmacWithSHA1 */
 245     if (prf_nid > 0 && prf_nid != NID_hmacWithSHA1) {
 246         kdf->prf = X509_ALGOR_new();
 247         if (kdf->prf == NULL)
 248             goto merr;
 249         X509_ALGOR_set0(kdf->prf, OBJ_nid2obj(prf_nid), V_ASN1_NULL, NULL);
 250     }
 251
 252     /* Finally setup the keyfunc structure */
 253
 254     keyfunc = X509_ALGOR_new();
 255     if (keyfunc == NULL)
 256         goto merr;
 257
 258     keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
 259
 260     /* Encode PBKDF2PARAM into parameter of pbe2 */
 261
 262     if (!ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBKDF2PARAM), kdf,
 263                                  &keyfunc->parameter))
 264          goto merr;
 265
 266     PBKDF2PARAM_free(kdf);
 267     return keyfunc;
 268
 269  merr:
 270     ASN1err(ASN1_F_PKCS5_PBKDF2_SET, ERR_R_MALLOC_FAILURE);
 271     PBKDF2PARAM_free(kdf);
 272     X509_ALGOR_free(keyfunc);
 273     return NULL;
 274 }