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 };
 122
 123 #ifdef TEST
 124 int main(int argc, char **argv)
 125 {
 126     int i, nid_md, nid_cipher;
 127     EVP_PBE_CTL *tpbe, *tpbe2;
 128     /*
 129      * OpenSSL_add_all_algorithms();
 130      */
 131
 132     for (i = 0; i < sizeof(builtin_pbe) / sizeof(EVP_PBE_CTL); i++) {
 133         tpbe = builtin_pbe + i;
 134         fprintf(stderr, "%d %d %s ", tpbe->pbe_type, tpbe->pbe_nid,
 135                 OBJ_nid2sn(tpbe->pbe_nid));
 136         if (EVP_PBE_find(tpbe->pbe_type, tpbe->pbe_nid,
 137                          &nid_cipher, &nid_md, 0))
 138             fprintf(stderr, "Found %s %s\n",
 139                     OBJ_nid2sn(nid_cipher), OBJ_nid2sn(nid_md));
 140         else
 141             fprintf(stderr, "Find ERROR!!\n");
 142     }
 143
 144     return 0;
 145 }
 146 #endif
 147
 148 int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
 149                        ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
 150 {
 151     const EVP_CIPHER *cipher;
 152     const EVP_MD *md;
 153     int cipher_nid, md_nid;
 154     EVP_PBE_KEYGEN *keygen;
 155
 156     if (!EVP_PBE_find(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
 157                       &cipher_nid, &md_nid, &keygen)) {
 158         char obj_tmp[80];
 159         EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_PBE_ALGORITHM);
 160         if (!pbe_obj)
 161             BUF_strlcpy(obj_tmp, "NULL", sizeof obj_tmp);
 162         else
 163             i2t_ASN1_OBJECT(obj_tmp, sizeof obj_tmp, pbe_obj);
 164         ERR_add_error_data(2, "TYPE=", obj_tmp);
 165         return 0;
 166     }
 167
 168     if (!pass)
 169         passlen = 0;
 170     else if (passlen == -1)
 171         passlen = strlen(pass);
 172
 173     if (cipher_nid == -1)
 174         cipher = NULL;
 175     else {
 176         cipher = EVP_get_cipherbynid(cipher_nid);
 177         if (!cipher) {
 178             EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_CIPHER);
 179             return 0;
 180         }
 181     }
 182
 183     if (md_nid == -1)
 184         md = NULL;
 185     else {
 186         md = EVP_get_digestbynid(md_nid);
 187         if (!md) {
 188             EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_DIGEST);
 189             return 0;
 190         }
 191     }
 192
 193     if (!keygen(ctx, pass, passlen, param, cipher, md, en_de)) {
 194         EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_KEYGEN_FAILURE);
 195         return 0;
 196     }
 197     return 1;
 198 }
 199
 200 DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 201
 202 static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
 203 {
 204     int ret = pbe1->pbe_type - pbe2->pbe_type;
 205     if (ret)
 206         return ret;
 207     else
 208         return pbe1->pbe_nid - pbe2->pbe_nid;
 209 }
 210
 211 IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 212
 213 static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
 214 {
 215     int ret = (*a)->pbe_type - (*b)->pbe_type;
 216     if (ret)
 217         return ret;
 218     else
 219         return (*a)->pbe_nid - (*b)->pbe_nid;
 220 }
 221
 222 /* Add a PBE algorithm */
 223
 224 int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
 225                          int md_nid, EVP_PBE_KEYGEN *keygen)
 226 {
 227     EVP_PBE_CTL *pbe_tmp;
 228     if (!pbe_algs)
 229         pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
 230     if (!(pbe_tmp = (EVP_PBE_CTL *)OPENSSL_malloc(sizeof(EVP_PBE_CTL)))) {
 231         EVPerr(EVP_F_EVP_PBE_ALG_ADD_TYPE, ERR_R_MALLOC_FAILURE);
 232         return 0;
 233     }
 234     pbe_tmp->pbe_type = pbe_type;
 235     pbe_tmp->pbe_nid = pbe_nid;
 236     pbe_tmp->cipher_nid = cipher_nid;
 237     pbe_tmp->md_nid = md_nid;
 238     pbe_tmp->keygen = keygen;
 239
 240     sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp);
 241     return 1;
 242 }
 243
 244 int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
 245                     EVP_PBE_KEYGEN *keygen)
 246 {
 247     int cipher_nid, md_nid;
 248     if (cipher)
 249         cipher_nid = EVP_CIPHER_nid(cipher);
 250     else
 251         cipher_nid = -1;
 252     if (md)
 253         md_nid = EVP_MD_type(md);
 254     else
 255         md_nid = -1;
 256
 257     return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
 258                                 cipher_nid, md_nid, keygen);
 259 }
 260
 261 int EVP_PBE_find(int type, int pbe_nid,
 262                  int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
 263 {
 264     EVP_PBE_CTL *pbetmp = NULL, pbelu;
 265     int i;
 266     if (pbe_nid == NID_undef)
 267         return 0;
 268
 269     pbelu.pbe_type = type;
 270     pbelu.pbe_nid = pbe_nid;
 271
 272     if (pbe_algs) {
 273         i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
 274         if (i != -1)
 275             pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
 276     }
 277     if (pbetmp == NULL) {
 278         pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe,
 279                                   sizeof(builtin_pbe) / sizeof(EVP_PBE_CTL));
 280     }
 281     if (pbetmp == NULL)
 282         return 0;
 283     if (pcnid)
 284         *pcnid = pbetmp->cipher_nid;
 285     if (pmnid)
 286         *pmnid = pbetmp->md_nid;
 287     if (pkeygen)
 288         *pkeygen = pbetmp->keygen;
 289     return 1;
 290 }
 291
 292 static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
 293 {
 294     OPENSSL_freeFunc(pbe);
 295 }
 296
 297 void EVP_PBE_cleanup(void)
 298 {
 299     sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
 300     pbe_algs = NULL;
 301 }