crypto/asn1/p5_pbev2.c

   1 /* p5_pbev2.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
  59 #include <stdio.h>
  60 #include "cryptlib.h"
  61 #include <openssl/asn1_mac.h>
  62 #include <openssl/rand.h>
  63
  64 /* PKCS#5 v2.0 password based encryption structures */
  65
  66 int i2d_PBE2PARAM(PBE2PARAM *a, unsigned char **pp)
  67 {
  68         M_ASN1_I2D_vars(a);
  69         M_ASN1_I2D_len (a->keyfunc, i2d_X509_ALGOR);
  70         M_ASN1_I2D_len (a->encryption, i2d_X509_ALGOR);
  71
  72         M_ASN1_I2D_seq_total ();
  73
  74         M_ASN1_I2D_put (a->keyfunc, i2d_X509_ALGOR);
  75         M_ASN1_I2D_put (a->encryption, i2d_X509_ALGOR);
  76
  77         M_ASN1_I2D_finish();
  78 }
  79
  80 PBE2PARAM *PBE2PARAM_new(void)
  81 {
  82         PBE2PARAM *ret=NULL;
  83         ASN1_CTX c;
  84         M_ASN1_New_Malloc(ret, PBE2PARAM);
  85         M_ASN1_New(ret->keyfunc,X509_ALGOR_new);
  86         M_ASN1_New(ret->encryption,X509_ALGOR_new);
  87         return (ret);
  88         M_ASN1_New_Error(ASN1_F_PBE2PARAM_NEW);
  89 }
  90
  91 PBE2PARAM *d2i_PBE2PARAM(PBE2PARAM **a, unsigned char **pp, long length)
  92 {
  93         M_ASN1_D2I_vars(a,PBE2PARAM *,PBE2PARAM_new);
  94         M_ASN1_D2I_Init();
  95         M_ASN1_D2I_start_sequence();
  96         M_ASN1_D2I_get (ret->keyfunc, d2i_X509_ALGOR);
  97         M_ASN1_D2I_get (ret->encryption, d2i_X509_ALGOR);
  98         M_ASN1_D2I_Finish(a, PBE2PARAM_free, ASN1_F_D2I_PBE2PARAM);
  99 }
 100
 101 void PBE2PARAM_free (PBE2PARAM *a)
 102 {
 103         if(a==NULL) return;
 104         X509_ALGOR_free(a->keyfunc);
 105         X509_ALGOR_free(a->encryption);
 106         Free ((char *)a);
 107 }
 108
 109 int i2d_PBKDF2PARAM(PBKDF2PARAM *a, unsigned char **pp)
 110 {
 111         M_ASN1_I2D_vars(a);
 112         M_ASN1_I2D_len (a->salt, i2d_ASN1_TYPE);
 113         M_ASN1_I2D_len (a->iter, i2d_ASN1_INTEGER);
 114         M_ASN1_I2D_len (a->keylength, i2d_ASN1_INTEGER);
 115         M_ASN1_I2D_len (a->prf, i2d_X509_ALGOR);
 116
 117         M_ASN1_I2D_seq_total ();
 118
 119         M_ASN1_I2D_put (a->salt, i2d_ASN1_TYPE);
 120         M_ASN1_I2D_put (a->iter, i2d_ASN1_INTEGER);
 121         M_ASN1_I2D_put (a->keylength, i2d_ASN1_INTEGER);
 122         M_ASN1_I2D_put (a->prf, i2d_X509_ALGOR);
 123
 124         M_ASN1_I2D_finish();
 125 }
 126
 127 PBKDF2PARAM *PBKDF2PARAM_new(void)
 128 {
 129         PBKDF2PARAM *ret=NULL;
 130         ASN1_CTX c;
 131         M_ASN1_New_Malloc(ret, PBKDF2PARAM);
 132         M_ASN1_New(ret->salt, ASN1_TYPE_new);
 133         M_ASN1_New(ret->iter, ASN1_INTEGER_new);
 134         ret->keylength = NULL;
 135         ret->prf = NULL;
 136         return (ret);
 137         M_ASN1_New_Error(ASN1_F_PBKDF2PARAM_NEW);
 138 }
 139
 140 PBKDF2PARAM *d2i_PBKDF2PARAM(PBKDF2PARAM **a, unsigned char **pp,
 141              long length)
 142 {
 143         M_ASN1_D2I_vars(a,PBKDF2PARAM *,PBKDF2PARAM_new);
 144         M_ASN1_D2I_Init();
 145         M_ASN1_D2I_start_sequence();
 146         M_ASN1_D2I_get (ret->salt, d2i_ASN1_TYPE);
 147         M_ASN1_D2I_get (ret->iter, d2i_ASN1_INTEGER);
 148         M_ASN1_D2I_get_opt (ret->keylength, d2i_ASN1_INTEGER, V_ASN1_INTEGER);
 149         M_ASN1_D2I_get_opt (ret->prf, d2i_X509_ALGOR, V_ASN1_SEQUENCE);
 150         M_ASN1_D2I_Finish(a, PBKDF2PARAM_free, ASN1_F_D2I_PBKDF2PARAM);
 151 }
 152
 153 void PBKDF2PARAM_free (PBKDF2PARAM *a)
 154 {
 155         if(a==NULL) return;
 156         ASN1_OCTET_STRING_free(a->salt);
 157         ASN1_INTEGER_free(a->iter);
 158         ASN1_INTEGER_free(a->keylength);
 159         X509_ALGOR_free(a->prf);
 160         Free ((char *)a);
 161 }
 162
 163 /* Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm:
 164  * yes I know this is horrible!
 165  */
 166
 167 X509_ALGOR *PKCS5_pbe2_set(EVP_CIPHER *cipher, int iter, unsigned char *salt,
 168              int saltlen)
 169 {
 170         X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
 171         int alg_nid;
 172         EVP_CIPHER_CTX ctx;
 173         unsigned char iv[EVP_MAX_IV_LENGTH];
 174         PBKDF2PARAM *kdf = NULL;
 175         PBE2PARAM *pbe2 = NULL;
 176         ASN1_OCTET_STRING *osalt = NULL;
 177
 178         if(!(pbe2 = PBE2PARAM_new())) goto merr;
 179
 180         /* Setup the AlgorithmIdentifier for the encryption scheme */
 181         scheme = pbe2->encryption;
 182
 183         alg_nid = EVP_CIPHER_type(cipher);
 184
 185         scheme->algorithm = OBJ_nid2obj(alg_nid);
 186         if(!(scheme->parameter = ASN1_TYPE_new())) goto merr;
 187
 188         /* Create random IV */
 189         RAND_bytes(iv, EVP_CIPHER_iv_length(cipher));
 190
 191         /* Dummy cipherinit to just setup the IV */
 192         EVP_CipherInit(&ctx, cipher, NULL, iv, 0);
 193         if(EVP_CIPHER_param_to_asn1(&ctx, scheme->parameter) < 0) {
 194                 ASN1err(ASN1_F_PKCS5_PBE2_SET,
 195                                         ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
 196                 goto err;
 197         }
 198         EVP_CIPHER_CTX_cleanup(&ctx);
 199
 200         if(!(kdf = PBKDF2PARAM_new())) goto merr;
 201         if(!(osalt = ASN1_OCTET_STRING_new())) goto merr;
 202
 203         if (!saltlen) saltlen = PKCS5_SALT_LEN;
 204         if (!(osalt->data = Malloc (saltlen))) goto merr;
 205         osalt->length = saltlen;
 206         if (salt) memcpy (osalt->data, salt, saltlen);
 207         else RAND_bytes (osalt->data, saltlen);
 208
 209         if(!ASN1_INTEGER_set(kdf->iter, iter)) goto merr;
 210
 211         /* Now include salt in kdf structure */
 212         kdf->salt->value.octet_string = osalt;
 213         kdf->salt->type = V_ASN1_OCTET_STRING;
 214         osalt = NULL;
 215
 216         /* If its RC2 then we'd better setup the key length */
 217
 218         if(alg_nid == NID_rc2_cbc) {
 219                 if(!(kdf->keylength = ASN1_INTEGER_new())) goto merr;
 220                 if(!ASN1_INTEGER_set (kdf->keylength,
 221                                  EVP_CIPHER_key_length(cipher))) goto merr;
 222         }
 223
 224         /* prf can stay NULL because we are using hmacWithSHA1 */
 225
 226         /* Now setup the PBE2PARAM keyfunc structure */
 227
 228         pbe2->keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
 229
 230         /* Encode PBKDF2PARAM into parameter of pbe2 */
 231
 232         if(!(pbe2->keyfunc->parameter = ASN1_TYPE_new())) goto merr;
 233
 234         if(!ASN1_pack_string(kdf, i2d_PBKDF2PARAM,
 235                          &pbe2->keyfunc->parameter->value.sequence)) goto merr;
 236         pbe2->keyfunc->parameter->type = V_ASN1_SEQUENCE;
 237
 238         PBKDF2PARAM_free(kdf);
 239         kdf = NULL;
 240
 241         /* Now set up top level AlgorithmIdentifier */
 242
 243         if(!(ret = X509_ALGOR_new())) goto merr;
 244         if(!(ret->parameter = ASN1_TYPE_new())) goto merr;
 245
 246         ret->algorithm = OBJ_nid2obj(NID_pbes2);
 247
 248         /* Encode PBE2PARAM into parameter */
 249
 250         if(!ASN1_pack_string(pbe2, i2d_PBE2PARAM,
 251                                  &ret->parameter->value.sequence)) goto merr;
 252         ret->parameter->type = V_ASN1_SEQUENCE;
 253
 254         PBE2PARAM_free(pbe2);
 255         pbe2 = NULL;
 256
 257         return ret;
 258
 259         merr:
 260         ASN1err(ASN1_F_PKCS5_PBE2_SET,ERR_R_MALLOC_FAILURE);
 261
 262         err:
 263         PBE2PARAM_free(pbe2);
 264         /* Note 'scheme' is freed as part of pbe2 */
 265         ASN1_OCTET_STRING_free(osalt);
 266         PBKDF2PARAM_free(kdf);
 267         X509_ALGOR_free(kalg);
 268         X509_ALGOR_free(ret);
 269
 270         return NULL;
 271
 272 }