crypto/evp/evp_pbe.c

   1 /* evp_pbe.c */
   2 /*
   3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   4  * 1999.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 1999-2006 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include <stdio.h>
  61 #include "cryptlib.h"
  62 #include <openssl/evp.h>
  63 #include <openssl/pkcs12.h>
  64 #include <openssl/x509.h>
  65 #include "evp_locl.h"
  66
  67 /* Password based encryption (PBE) functions */
  68
  69 DECLARE_STACK_OF(EVP_PBE_CTL)
  70 static STACK_OF(EVP_PBE_CTL) *pbe_algs;
  71
  72 /* Setup a cipher context from a PBE algorithm */
  73
  74 typedef struct {
  75     int pbe_type;
  76     int pbe_nid;
  77     int cipher_nid;
  78     int md_nid;
  79     EVP_PBE_KEYGEN *keygen;
  80 } EVP_PBE_CTL;
  81
  82 static const EVP_PBE_CTL builtin_pbe[] = {
  83     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndDES_CBC,
  84      NID_des_cbc, NID_md2, PKCS5_PBE_keyivgen},
  85     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndDES_CBC,
  86      NID_des_cbc, NID_md5, PKCS5_PBE_keyivgen},
  87     {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndRC2_CBC,
  88      NID_rc2_64_cbc, NID_sha1, PKCS5_PBE_keyivgen},
  89
  90     {EVP_PBE_TYPE_OUTER, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
  91
  92     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC4,
  93      NID_rc4, NID_sha1, PKCS12_PBE_keyivgen},
  94     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC4,
  95      NID_rc4_40, NID_sha1, PKCS12_PBE_keyivgen},
  96     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And3_Key_TripleDES_CBC,
  97      NID_des_ede3_cbc, NID_sha1, PKCS12_PBE_keyivgen},
  98     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And2_Key_TripleDES_CBC,
  99      NID_des_ede_cbc, NID_sha1, PKCS12_PBE_keyivgen},
 100     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC2_CBC,
 101      NID_rc2_cbc, NID_sha1, PKCS12_PBE_keyivgen},
 102     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC2_CBC,
 103      NID_rc2_40_cbc, NID_sha1, PKCS12_PBE_keyivgen},
 104
 105     {EVP_PBE_TYPE_OUTER, NID_pbes2, -1, -1, PKCS5_v2_PBE_keyivgen},
 106
 107     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndRC2_CBC,
 108      NID_rc2_64_cbc, NID_md2, PKCS5_PBE_keyivgen},
 109     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndRC2_CBC,
 110      NID_rc2_64_cbc, NID_md5, PKCS5_PBE_keyivgen},
 111     {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndDES_CBC,
 112      NID_des_cbc, NID_sha1, PKCS5_PBE_keyivgen},
 113
 114     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA1, -1, NID_sha1, 0},
 115     {EVP_PBE_TYPE_PRF, NID_hmacWithMD5, -1, NID_md5, 0},
 116     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA224, -1, NID_sha224, 0},
 117     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA256, -1, NID_sha256, 0},
 118     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA384, -1, NID_sha384, 0},
 119     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512, -1, NID_sha512, 0},
 120     {EVP_PBE_TYPE_PRF, NID_id_HMACGostR3411_94, -1, NID_id_GostR3411_94, 0},
 121     {EVP_PBE_TYPE_KDF, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen}
 122 };
 123
 124 #ifdef TEST
 125 int main(int argc, char **argv)
 126 {
 127     int i, nid_md, nid_cipher;
 128     EVP_PBE_CTL *tpbe, *tpbe2;
 129     /*
 130      * OpenSSL_add_all_algorithms();
 131      */
 132
 133     for (i = 0; i < OSSL_NELEM(builtin_pbe); i++) {
 134         tpbe = builtin_pbe + i;
 135         fprintf(stderr, "%d %d %s ", tpbe->pbe_type, tpbe->pbe_nid,
 136                 OBJ_nid2sn(tpbe->pbe_nid));
 137         if (EVP_PBE_find(tpbe->pbe_type, tpbe->pbe_nid,
 138                          &nid_cipher, &nid_md, 0))
 139             fprintf(stderr, "Found %s %s\n",
 140                     OBJ_nid2sn(nid_cipher), OBJ_nid2sn(nid_md));
 141         else
 142             fprintf(stderr, "Find ERROR!!\n");
 143     }
 144
 145     return 0;
 146 }
 147 #endif
 148
 149 int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
 150                        ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
 151 {
 152     const EVP_CIPHER *cipher;
 153     const EVP_MD *md;
 154     int cipher_nid, md_nid;
 155     EVP_PBE_KEYGEN *keygen;
 156
 157     if (!EVP_PBE_find(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
 158                       &cipher_nid, &md_nid, &keygen)) {
 159         char obj_tmp[80];
 160         EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_PBE_ALGORITHM);
 161         if (!pbe_obj)
 162             BUF_strlcpy(obj_tmp, "NULL", sizeof obj_tmp);
 163         else
 164             i2t_ASN1_OBJECT(obj_tmp, sizeof obj_tmp, pbe_obj);
 165         ERR_add_error_data(2, "TYPE=", obj_tmp);
 166         return 0;
 167     }
 168
 169     if (!pass)
 170         passlen = 0;
 171     else if (passlen == -1)
 172         passlen = strlen(pass);
 173
 174     if (cipher_nid == -1)
 175         cipher = NULL;
 176     else {
 177         cipher = EVP_get_cipherbynid(cipher_nid);
 178         if (!cipher) {
 179             EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_CIPHER);
 180             return 0;
 181         }
 182     }
 183
 184     if (md_nid == -1)
 185         md = NULL;
 186     else {
 187         md = EVP_get_digestbynid(md_nid);
 188         if (!md) {
 189             EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_DIGEST);
 190             return 0;
 191         }
 192     }
 193
 194     if (!keygen(ctx, pass, passlen, param, cipher, md, en_de)) {
 195         EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_KEYGEN_FAILURE);
 196         return 0;
 197     }
 198     return 1;
 199 }
 200
 201 DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 202
 203 static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
 204 {
 205     int ret = pbe1->pbe_type - pbe2->pbe_type;
 206     if (ret)
 207         return ret;
 208     else
 209         return pbe1->pbe_nid - pbe2->pbe_nid;
 210 }
 211
 212 IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 213
 214 static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
 215 {
 216     int ret = (*a)->pbe_type - (*b)->pbe_type;
 217     if (ret)
 218         return ret;
 219     else
 220         return (*a)->pbe_nid - (*b)->pbe_nid;
 221 }
 222
 223 /* Add a PBE algorithm */
 224
 225 int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
 226                          int md_nid, EVP_PBE_KEYGEN *keygen)
 227 {
 228     EVP_PBE_CTL *pbe_tmp;
 229
 230     if (pbe_algs == NULL)
 231         pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
 232     if ((pbe_tmp = OPENSSL_malloc(sizeof(*pbe_tmp))) == NULL) {
 233         EVPerr(EVP_F_EVP_PBE_ALG_ADD_TYPE, ERR_R_MALLOC_FAILURE);
 234         return 0;
 235     }
 236     pbe_tmp->pbe_type = pbe_type;
 237     pbe_tmp->pbe_nid = pbe_nid;
 238     pbe_tmp->cipher_nid = cipher_nid;
 239     pbe_tmp->md_nid = md_nid;
 240     pbe_tmp->keygen = keygen;
 241
 242     sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp);
 243     return 1;
 244 }
 245
 246 int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
 247                     EVP_PBE_KEYGEN *keygen)
 248 {
 249     int cipher_nid, md_nid;
 250
 251     if (cipher)
 252         cipher_nid = EVP_CIPHER_nid(cipher);
 253     else
 254         cipher_nid = -1;
 255     if (md)
 256         md_nid = EVP_MD_type(md);
 257     else
 258         md_nid = -1;
 259
 260     return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
 261                                 cipher_nid, md_nid, keygen);
 262 }
 263
 264 int EVP_PBE_find(int type, int pbe_nid,
 265                  int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
 266 {
 267     EVP_PBE_CTL *pbetmp = NULL, pbelu;
 268     int i;
 269     if (pbe_nid == NID_undef)
 270         return 0;
 271
 272     pbelu.pbe_type = type;
 273     pbelu.pbe_nid = pbe_nid;
 274
 275     if (pbe_algs) {
 276         i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
 277         if (i != -1)
 278             pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
 279     }
 280     if (pbetmp == NULL) {
 281         pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe, OSSL_NELEM(builtin_pbe));
 282     }
 283     if (pbetmp == NULL)
 284         return 0;
 285     if (pcnid)
 286         *pcnid = pbetmp->cipher_nid;
 287     if (pmnid)
 288         *pmnid = pbetmp->md_nid;
 289     if (pkeygen)
 290         *pkeygen = pbetmp->keygen;
 291     return 1;
 292 }
 293
 294 static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
 295 {
 296     OPENSSL_free(pbe);
 297 }
 298
 299 void EVP_PBE_cleanup(void)
 300 {
 301     sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
 302     pbe_algs = NULL;
 303 }