crypto/asn1/p5_pbev2.c

   1 /*
   2  * Copyright 1999-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdio.h>
  11 #include "internal/cryptlib.h"
  12 #include <openssl/asn1t.h>
  13 #include <openssl/x509.h>
  14 #include <openssl/rand.h>
  15
  16 /* PKCS#5 v2.0 password based encryption structures */
  17
  18 ASN1_SEQUENCE(PBE2PARAM) = {
  19         ASN1_SIMPLE(PBE2PARAM, keyfunc, X509_ALGOR),
  20         ASN1_SIMPLE(PBE2PARAM, encryption, X509_ALGOR)
  21 } ASN1_SEQUENCE_END(PBE2PARAM)
  22
  23 IMPLEMENT_ASN1_FUNCTIONS(PBE2PARAM)
  24
  25 ASN1_SEQUENCE(PBKDF2PARAM) = {
  26         ASN1_SIMPLE(PBKDF2PARAM, salt, ASN1_ANY),
  27         ASN1_SIMPLE(PBKDF2PARAM, iter, ASN1_INTEGER),
  28         ASN1_OPT(PBKDF2PARAM, keylength, ASN1_INTEGER),
  29         ASN1_OPT(PBKDF2PARAM, prf, X509_ALGOR)
  30 } ASN1_SEQUENCE_END(PBKDF2PARAM)
  31
  32 IMPLEMENT_ASN1_FUNCTIONS(PBKDF2PARAM)
  33
  34 /*
  35  * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm: yes I know
  36  * this is horrible! Extended version to allow application supplied PRF NID
  37  * and IV.
  38  */
  39
  40 X509_ALGOR *PKCS5_pbe2_set_iv(const EVP_CIPHER *cipher, int iter,
  41                               unsigned char *salt, int saltlen,
  42                               unsigned char *aiv, int prf_nid)
  43 {
  44     X509_ALGOR *scheme = NULL, *ret = NULL;
  45     int alg_nid, keylen;
  46     EVP_CIPHER_CTX *ctx = NULL;
  47     unsigned char iv[EVP_MAX_IV_LENGTH];
  48     PBE2PARAM *pbe2 = NULL;
  49
  50     alg_nid = EVP_CIPHER_type(cipher);
  51     if (alg_nid == NID_undef) {
  52         ERR_raise(ERR_LIB_ASN1, ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
  53         goto err;
  54     }
  55
  56     if ((pbe2 = PBE2PARAM_new()) == NULL)
  57         goto merr;
  58
  59     /* Setup the AlgorithmIdentifier for the encryption scheme */
  60     scheme = pbe2->encryption;
  61     scheme->algorithm = OBJ_nid2obj(alg_nid);
  62     if ((scheme->parameter = ASN1_TYPE_new()) == NULL)
  63         goto merr;
  64
  65     /* Create random IV */
  66     if (EVP_CIPHER_iv_length(cipher)) {
  67         if (aiv)
  68             memcpy(iv, aiv, EVP_CIPHER_iv_length(cipher));
  69         else if (RAND_bytes(iv, EVP_CIPHER_iv_length(cipher)) <= 0)
  70             goto err;
  71     }
  72
  73     ctx = EVP_CIPHER_CTX_new();
  74     if (ctx == NULL)
  75         goto merr;
  76
  77     /* Dummy cipherinit to just setup the IV, and PRF */
  78     if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0))
  79         goto err;
  80     if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) <= 0) {
  81         ERR_raise(ERR_LIB_ASN1, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
  82         goto err;
  83     }
  84     /*
  85      * If prf NID unspecified see if cipher has a preference. An error is OK
  86      * here: just means use default PRF.
  87      */
  88     if ((prf_nid == -1) &&
  89         EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_PBE_PRF_NID, 0, &prf_nid) <= 0) {
  90         ERR_clear_error();
  91         prf_nid = NID_hmacWithSHA256;
  92     }
  93     EVP_CIPHER_CTX_free(ctx);
  94     ctx = NULL;
  95
  96     /* If its RC2 then we'd better setup the key length */
  97
  98     if (alg_nid == NID_rc2_cbc)
  99         keylen = EVP_CIPHER_key_length(cipher);
 100     else
 101         keylen = -1;
 102
 103     /* Setup keyfunc */
 104
 105     X509_ALGOR_free(pbe2->keyfunc);
 106
 107     pbe2->keyfunc = PKCS5_pbkdf2_set(iter, salt, saltlen, prf_nid, keylen);
 108
 109     if (pbe2->keyfunc == NULL)
 110         goto merr;
 111
 112     /* Now set up top level AlgorithmIdentifier */
 113
 114     if ((ret = X509_ALGOR_new()) == NULL)
 115         goto merr;
 116
 117     ret->algorithm = OBJ_nid2obj(NID_pbes2);
 118
 119     /* Encode PBE2PARAM into parameter */
 120
 121     if (!ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
 122                                  &ret->parameter))
 123          goto merr;
 124
 125     PBE2PARAM_free(pbe2);
 126     pbe2 = NULL;
 127
 128     return ret;
 129
 130  merr:
 131     ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
 132
 133  err:
 134     EVP_CIPHER_CTX_free(ctx);
 135     PBE2PARAM_free(pbe2);
 136     /* Note 'scheme' is freed as part of pbe2 */
 137     X509_ALGOR_free(ret);
 138
 139     return NULL;
 140 }
 141
 142 X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
 143                            unsigned char *salt, int saltlen)
 144 {
 145     return PKCS5_pbe2_set_iv(cipher, iter, salt, saltlen, NULL, -1);
 146 }
 147
 148 X509_ALGOR *PKCS5_pbkdf2_set(int iter, unsigned char *salt, int saltlen,
 149                              int prf_nid, int keylen)
 150 {
 151     X509_ALGOR *keyfunc = NULL;
 152     PBKDF2PARAM *kdf = NULL;
 153     ASN1_OCTET_STRING *osalt = NULL;
 154
 155     if ((kdf = PBKDF2PARAM_new()) == NULL)
 156         goto merr;
 157     if ((osalt = ASN1_OCTET_STRING_new()) == NULL)
 158         goto merr;
 159
 160     kdf->salt->value.octet_string = osalt;
 161     kdf->salt->type = V_ASN1_OCTET_STRING;
 162
 163     if (saltlen == 0)
 164         saltlen = PKCS5_SALT_LEN;
 165     if ((osalt->data = OPENSSL_malloc(saltlen)) == NULL)
 166         goto merr;
 167
 168     osalt->length = saltlen;
 169
 170     if (salt)
 171         memcpy(osalt->data, salt, saltlen);
 172     else if (RAND_bytes(osalt->data, saltlen) <= 0)
 173         goto merr;
 174
 175     if (iter <= 0)
 176         iter = PKCS5_DEFAULT_ITER;
 177
 178     if (!ASN1_INTEGER_set(kdf->iter, iter))
 179         goto merr;
 180
 181     /* If have a key len set it up */
 182
 183     if (keylen > 0) {
 184         if ((kdf->keylength = ASN1_INTEGER_new()) == NULL)
 185             goto merr;
 186         if (!ASN1_INTEGER_set(kdf->keylength, keylen))
 187             goto merr;
 188     }
 189
 190     /* prf can stay NULL if we are using hmacWithSHA1 */
 191     if (prf_nid > 0 && prf_nid != NID_hmacWithSHA1) {
 192         kdf->prf = X509_ALGOR_new();
 193         if (kdf->prf == NULL)
 194             goto merr;
 195         X509_ALGOR_set0(kdf->prf, OBJ_nid2obj(prf_nid), V_ASN1_NULL, NULL);
 196     }
 197
 198     /* Finally setup the keyfunc structure */
 199
 200     keyfunc = X509_ALGOR_new();
 201     if (keyfunc == NULL)
 202         goto merr;
 203
 204     keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
 205
 206     /* Encode PBKDF2PARAM into parameter of pbe2 */
 207
 208     if (!ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBKDF2PARAM), kdf,
 209                                  &keyfunc->parameter))
 210          goto merr;
 211
 212     PBKDF2PARAM_free(kdf);
 213     return keyfunc;
 214
 215  merr:
 216     ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
 217     PBKDF2PARAM_free(kdf);
 218     X509_ALGOR_free(keyfunc);
 219     return NULL;
 220 }