Home | History | Annotate | Download | only in asn1
      1 /* p5_pbev2.c */
      2 /* Written by Dr Stephen N Henson (steve (at) openssl.org) for the OpenSSL
      3  * project 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 (at) 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 (at) cryptsoft.com).  This product includes software written by Tim
     55  * Hudson (tjh (at) cryptsoft.com).
     56  *
     57  */
     58 
     59 #include <stdio.h>
     60 #include "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 /* Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm:
     84  * yes I know this is horrible!
     85  *
     86  * Extended version to allow application supplied PRF NID 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;
     95 	EVP_CIPHER_CTX ctx;
     96 	unsigned char iv[EVP_MAX_IV_LENGTH];
     97 	PBKDF2PARAM *kdf = NULL;
     98 	PBE2PARAM *pbe2 = NULL;
     99 	ASN1_OCTET_STRING *osalt = NULL;
    100 	ASN1_OBJECT *obj;
    101 
    102 	alg_nid = EVP_CIPHER_type(cipher);
    103 	if(alg_nid == NID_undef) {
    104 		ASN1err(ASN1_F_PKCS5_PBE2_SET_IV,
    105 				ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
    106 		goto err;
    107 	}
    108 	obj = OBJ_nid2obj(alg_nid);
    109 
    110 	if(!(pbe2 = PBE2PARAM_new())) goto merr;
    111 
    112 	/* Setup the AlgorithmIdentifier for the encryption scheme */
    113 	scheme = pbe2->encryption;
    114 
    115 	scheme->algorithm = obj;
    116 	if(!(scheme->parameter = ASN1_TYPE_new())) goto merr;
    117 
    118 	/* Create random IV */
    119 	if (EVP_CIPHER_iv_length(cipher))
    120 		{
    121 		if (aiv)
    122 			memcpy(iv, aiv, EVP_CIPHER_iv_length(cipher));
    123 		else if (RAND_pseudo_bytes(iv, EVP_CIPHER_iv_length(cipher)) < 0)
    124   			goto err;
    125 		}
    126 
    127 	EVP_CIPHER_CTX_init(&ctx);
    128 
    129 	/* Dummy cipherinit to just setup the IV, and PRF */
    130 	EVP_CipherInit_ex(&ctx, cipher, NULL, NULL, iv, 0);
    131 	if(EVP_CIPHER_param_to_asn1(&ctx, scheme->parameter) < 0) {
    132 		ASN1err(ASN1_F_PKCS5_PBE2_SET_IV,
    133 					ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
    134 		EVP_CIPHER_CTX_cleanup(&ctx);
    135 		goto err;
    136 	}
    137 	/* If prf NID unspecified see if cipher has a preference.
    138 	 * An error is OK 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 		{
    143 		ERR_clear_error();
    144 		prf_nid = NID_hmacWithSHA1;
    145 		}
    146 	EVP_CIPHER_CTX_cleanup(&ctx);
    147 
    148 	if(!(kdf = PBKDF2PARAM_new())) goto merr;
    149 	if(!(osalt = M_ASN1_OCTET_STRING_new())) goto merr;
    150 
    151 	if (!saltlen) saltlen = PKCS5_SALT_LEN;
    152 	if (!(osalt->data = OPENSSL_malloc (saltlen))) goto merr;
    153 	osalt->length = saltlen;
    154 	if (salt) memcpy (osalt->data, salt, saltlen);
    155 	else if (RAND_pseudo_bytes (osalt->data, saltlen) < 0) goto merr;
    156 
    157 	if(iter <= 0) iter = PKCS5_DEFAULT_ITER;
    158 	if(!ASN1_INTEGER_set(kdf->iter, iter)) goto merr;
    159 
    160 	/* Now include salt in kdf structure */
    161 	kdf->salt->value.octet_string = osalt;
    162 	kdf->salt->type = V_ASN1_OCTET_STRING;
    163 	osalt = NULL;
    164 
    165 	/* If its RC2 then we'd better setup the key length */
    166 
    167 	if(alg_nid == NID_rc2_cbc) {
    168 		if(!(kdf->keylength = M_ASN1_INTEGER_new())) goto merr;
    169 		if(!ASN1_INTEGER_set (kdf->keylength,
    170 				 EVP_CIPHER_key_length(cipher))) goto merr;
    171 	}
    172 
    173 	/* prf can stay NULL if we are using hmacWithSHA1 */
    174 	if (prf_nid != NID_hmacWithSHA1)
    175 		{
    176 		kdf->prf = X509_ALGOR_new();
    177 		if (!kdf->prf)
    178 			goto merr;
    179 		X509_ALGOR_set0(kdf->prf, OBJ_nid2obj(prf_nid),
    180 					V_ASN1_NULL, NULL);
    181 		}
    182 
    183 	/* Now setup the PBE2PARAM keyfunc structure */
    184 
    185 	pbe2->keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
    186 
    187 	/* Encode PBKDF2PARAM into parameter of pbe2 */
    188 
    189 	if(!(pbe2->keyfunc->parameter = ASN1_TYPE_new())) goto merr;
    190 
    191 	if(!ASN1_item_pack(kdf, ASN1_ITEM_rptr(PBKDF2PARAM),
    192 			 &pbe2->keyfunc->parameter->value.sequence)) goto merr;
    193 	pbe2->keyfunc->parameter->type = V_ASN1_SEQUENCE;
    194 
    195 	PBKDF2PARAM_free(kdf);
    196 	kdf = NULL;
    197 
    198 	/* Now set up top level AlgorithmIdentifier */
    199 
    200 	if(!(ret = X509_ALGOR_new())) goto merr;
    201 	if(!(ret->parameter = ASN1_TYPE_new())) goto merr;
    202 
    203 	ret->algorithm = OBJ_nid2obj(NID_pbes2);
    204 
    205 	/* Encode PBE2PARAM into parameter */
    206 
    207 	if(!ASN1_item_pack(pbe2, ASN1_ITEM_rptr(PBE2PARAM),
    208 				 &ret->parameter->value.sequence)) goto merr;
    209 	ret->parameter->type = V_ASN1_SEQUENCE;
    210 
    211 	PBE2PARAM_free(pbe2);
    212 	pbe2 = NULL;
    213 
    214 	return ret;
    215 
    216 	merr:
    217 	ASN1err(ASN1_F_PKCS5_PBE2_SET_IV,ERR_R_MALLOC_FAILURE);
    218 
    219 	err:
    220 	PBE2PARAM_free(pbe2);
    221 	/* Note 'scheme' is freed as part of pbe2 */
    222 	M_ASN1_OCTET_STRING_free(osalt);
    223 	PBKDF2PARAM_free(kdf);
    224 	X509_ALGOR_free(kalg);
    225 	X509_ALGOR_free(ret);
    226 
    227 	return NULL;
    228 
    229 }
    230 
    231 X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
    232 				 unsigned char *salt, int saltlen)
    233 	{
    234 	return PKCS5_pbe2_set_iv(cipher, iter, salt, saltlen, NULL, -1);
    235 	}
    236