crypto/asn1/ameth_lib.c

   1 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
   2  * project 2006.
   3  */
   4 /* ====================================================================
   5  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. All advertising materials mentioning features or use of this
  20  *    software must display the following acknowledgment:
  21  *    "This product includes software developed by the OpenSSL Project
  22  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  23  *
  24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25  *    endorse or promote products derived from this software without
  26  *    prior written permission. For written permission, please contact
  27  *    licensing@OpenSSL.org.
  28  *
  29  * 5. Products derived from this software may not be called "OpenSSL"
  30  *    nor may "OpenSSL" appear in their names without prior written
  31  *    permission of the OpenSSL Project.
  32  *
  33  * 6. Redistributions of any form whatsoever must retain the following
  34  *    acknowledgment:
  35  *    "This product includes software developed by the OpenSSL Project
  36  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  37  *
  38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49  * OF THE POSSIBILITY OF SUCH DAMAGE.
  50  * ====================================================================
  51  *
  52  * This product includes cryptographic software written by Eric Young
  53  * (eay@cryptsoft.com).  This product includes software written by Tim
  54  * Hudson (tjh@cryptsoft.com).
  55  *
  56  */
  57
  58 #include <stdio.h>
  59 #include "cryptlib.h"
  60 #include <openssl/asn1t.h>
  61 #include <openssl/x509.h>
  62 #ifndef OPENSSL_NO_ENGINE
  63 #include <openssl/engine.h>
  64 #endif
  65 #include "asn1_locl.h"
  66
  67 extern const EVP_PKEY_ASN1_METHOD rsa_asn1_meths[];
  68 extern const EVP_PKEY_ASN1_METHOD dsa_asn1_meths[];
  69 extern const EVP_PKEY_ASN1_METHOD dh_asn1_meth;
  70 extern const EVP_PKEY_ASN1_METHOD eckey_asn1_meth;
  71 extern const EVP_PKEY_ASN1_METHOD hmac_asn1_meth;
  72
  73 /* Keep this sorted in type order !! */
  74 static const EVP_PKEY_ASN1_METHOD *standard_methods[] =
  75         {
  76 #ifndef OPENSSL_NO_RSA
  77         &rsa_asn1_meths[0],
  78         &rsa_asn1_meths[1],
  79 #endif
  80 #ifndef OPENSSL_NO_DH
  81         &dh_asn1_meth,
  82 #endif
  83 #ifndef OPENSSL_NO_DSA
  84         &dsa_asn1_meths[0],
  85         &dsa_asn1_meths[1],
  86         &dsa_asn1_meths[2],
  87         &dsa_asn1_meths[3],
  88         &dsa_asn1_meths[4],
  89 #endif
  90 #ifndef OPENSSL_NO_EC
  91         &eckey_asn1_meth,
  92 #endif
  93         &hmac_asn1_meth
  94         };
  95
  96 typedef int sk_cmp_fn_type(const char * const *a, const char * const *b);
  97 DECLARE_STACK_OF(EVP_PKEY_ASN1_METHOD)
  98 static STACK_OF(EVP_PKEY_ASN1_METHOD) *app_methods = NULL;
  99
 100
 101
 102 #ifdef TEST
 103 void main()
 104         {
 105         int i;
 106         for (i = 0;
 107                 i < sizeof(standard_methods)/sizeof(EVP_PKEY_ASN1_METHOD *);
 108                 i++)
 109                 fprintf(stderr, "Number %d id=%d (%s)\n", i,
 110                         standard_methods[i]->pkey_id,
 111                         OBJ_nid2sn(standard_methods[i]->pkey_id));
 112         }
 113 #endif
 114
 115 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_ASN1_METHOD *,
 116                            const EVP_PKEY_ASN1_METHOD *, ameth_cmp);
 117
 118 static int ameth_cmp(const EVP_PKEY_ASN1_METHOD * const *a,
 119                      const EVP_PKEY_ASN1_METHOD * const *b)
 120         {
 121         return ((*a)->pkey_id - (*b)->pkey_id);
 122         }
 123
 124 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_ASN1_METHOD *,
 125                              const EVP_PKEY_ASN1_METHOD *, ameth_cmp);
 126
 127 int EVP_PKEY_asn1_get_count(void)
 128         {
 129         int num = sizeof(standard_methods)/sizeof(EVP_PKEY_ASN1_METHOD *);
 130         if (app_methods)
 131                 num += sk_EVP_PKEY_ASN1_METHOD_num(app_methods);
 132         return num;
 133         }
 134
 135 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_get0(int idx)
 136         {
 137         int num = sizeof(standard_methods)/sizeof(EVP_PKEY_ASN1_METHOD *);
 138         if (idx < 0)
 139                 return NULL;
 140         if (idx < num)
 141                 return standard_methods[idx];
 142         idx -= num;
 143         return sk_EVP_PKEY_ASN1_METHOD_value(app_methods, idx);
 144         }
 145
 146 static const EVP_PKEY_ASN1_METHOD *pkey_asn1_find(int type)
 147         {
 148         EVP_PKEY_ASN1_METHOD tmp;
 149         const EVP_PKEY_ASN1_METHOD *t = &tmp, **ret;
 150         tmp.pkey_id = type;
 151         if (app_methods)
 152                 {
 153                 int idx;
 154                 idx = sk_EVP_PKEY_ASN1_METHOD_find(app_methods, &tmp);
 155                 if (idx >= 0)
 156                         return sk_EVP_PKEY_ASN1_METHOD_value(app_methods, idx);
 157                 }
 158         ret = OBJ_bsearch(const EVP_PKEY_ASN1_METHOD *, &t,
 159                           const EVP_PKEY_ASN1_METHOD *, standard_methods,
 160                           sizeof(standard_methods)
 161                           /sizeof(EVP_PKEY_ASN1_METHOD *),
 162                           ameth_cmp);
 163         if (!ret || !*ret)
 164                 return NULL;
 165         return *ret;
 166         }
 167
 168 /* Find an implementation of an ASN1 algorithm. If 'pe' is not NULL
 169  * also search through engines and set *pe to a functional reference
 170  * to the engine implementing 'type' or NULL if no engine implements
 171  * it.
 172  */
 173
 174 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find(ENGINE **pe, int type)
 175         {
 176         const EVP_PKEY_ASN1_METHOD *t;
 177         ENGINE *e;
 178
 179         for (;;)
 180                 {
 181                 t = pkey_asn1_find(type);
 182                 if (!t || !(t->pkey_flags & ASN1_PKEY_ALIAS))
 183                         break;
 184                 type = t->pkey_base_id;
 185                 }
 186         if (pe)
 187                 {
 188 #ifndef OPENSSL_NO_ENGINE
 189                 /* type will contain the final unaliased type */
 190                 e = ENGINE_get_pkey_asn1_meth_engine(type);
 191                 if (e)
 192                         {
 193                         *pe = e;
 194                         return ENGINE_get_pkey_asn1_meth(e, type);
 195                         }
 196 #endif
 197                 *pe = NULL;
 198                 }
 199         return t;
 200         }
 201
 202 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find_str(ENGINE **pe,
 203                                         const char *str, int len)
 204         {
 205         int i;
 206         const EVP_PKEY_ASN1_METHOD *ameth;
 207         if (len == -1)
 208                 len = strlen(str);
 209         if (pe)
 210                 {
 211 #ifndef OPENSSL_NO_ENGINE
 212                 ENGINE *e;
 213                 ameth = ENGINE_pkey_asn1_find_str(&e, str, len);
 214                 if (ameth)
 215                         {
 216                         /* Convert structural into
 217                          * functional reference
 218                          */
 219                         if (!ENGINE_init(e))
 220                                 ameth = NULL;
 221                         ENGINE_free(e);
 222                         *pe = e;
 223                         return ameth;
 224                         }
 225 #endif
 226                 *pe = NULL;
 227                 }
 228         for (i = 0; i < EVP_PKEY_asn1_get_count(); i++)
 229                 {
 230                 ameth = EVP_PKEY_asn1_get0(i);
 231                 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
 232                         continue;
 233                 if (((int)strlen(ameth->pem_str) == len) &&
 234                         !strncasecmp(ameth->pem_str, str, len))
 235                         return ameth;
 236                 }
 237         return NULL;
 238         }
 239
 240 int EVP_PKEY_asn1_add0(const EVP_PKEY_ASN1_METHOD *ameth)
 241         {
 242         if (app_methods == NULL)
 243                 {
 244                 app_methods = sk_EVP_PKEY_ASN1_METHOD_new(ameth_cmp);
 245                 if (!app_methods)
 246                         return 0;
 247                 }
 248         if (!sk_EVP_PKEY_ASN1_METHOD_push(app_methods, ameth))
 249                 return 0;
 250         sk_EVP_PKEY_ASN1_METHOD_sort(app_methods);
 251         return 1;
 252         }
 253
 254 int EVP_PKEY_asn1_add_alias(int to, int from)
 255         {
 256         EVP_PKEY_ASN1_METHOD *ameth;
 257         ameth = EVP_PKEY_asn1_new(from, ASN1_PKEY_ALIAS, NULL, NULL);
 258         if (!ameth)
 259                 return 0;
 260         ameth->pkey_base_id = to;
 261         return EVP_PKEY_asn1_add0(ameth);
 262         }
 263
 264 int EVP_PKEY_asn1_get0_info(int *ppkey_id, int *ppkey_base_id, int *ppkey_flags,
 265                                 const char **pinfo, const char **ppem_str,
 266                                         const EVP_PKEY_ASN1_METHOD *ameth)
 267         {
 268         if (!ameth)
 269                 return 0;
 270         if (ppkey_id)
 271                 *ppkey_id = ameth->pkey_id;
 272         if (ppkey_base_id)
 273                 *ppkey_base_id = ameth->pkey_base_id;
 274         if (ppkey_flags)
 275                 *ppkey_flags = ameth->pkey_flags;
 276         if (pinfo)
 277                 *pinfo = ameth->info;
 278         if (ppem_str)
 279                 *ppem_str = ameth->pem_str;
 280         return 1;
 281         }
 282
 283 const EVP_PKEY_ASN1_METHOD* EVP_PKEY_get0_asn1(EVP_PKEY *pkey)
 284         {
 285         return pkey->ameth;
 286         }
 287
 288 EVP_PKEY_ASN1_METHOD* EVP_PKEY_asn1_new(int id, int flags,
 289                                         const char *pem_str, const char *info)
 290         {
 291         EVP_PKEY_ASN1_METHOD *ameth;
 292         ameth = OPENSSL_malloc(sizeof(EVP_PKEY_ASN1_METHOD));
 293         if (!ameth)
 294                 return NULL;
 295
 296         ameth->pkey_id = id;
 297         ameth->pkey_base_id = id;
 298         ameth->pkey_flags = flags | ASN1_PKEY_DYNAMIC;
 299
 300         if (info)
 301                 {
 302                 ameth->info = BUF_strdup(info);
 303                 if (!ameth->info)
 304                         goto err;
 305                 }
 306
 307         if (pem_str)
 308                 {
 309                 ameth->pem_str = BUF_strdup(pem_str);
 310                 if (!ameth->pem_str)
 311                         goto err;
 312                 }
 313
 314         ameth->pub_decode = 0;
 315         ameth->pub_encode = 0;
 316         ameth->pub_cmp = 0;
 317         ameth->pub_print = 0;
 318
 319         ameth->priv_decode = 0;
 320         ameth->priv_encode = 0;
 321         ameth->priv_print = 0;
 322
 323         ameth->old_priv_encode = 0;
 324         ameth->old_priv_decode = 0;
 325
 326         ameth->pkey_size = 0;
 327         ameth->pkey_bits = 0;
 328
 329         ameth->param_decode = 0;
 330         ameth->param_encode = 0;
 331         ameth->param_missing = 0;
 332         ameth->param_copy = 0;
 333         ameth->param_cmp = 0;
 334         ameth->param_print = 0;
 335
 336         ameth->pkey_free = 0;
 337         ameth->pkey_ctrl = 0;
 338
 339         return ameth;
 340
 341         err:
 342
 343         EVP_PKEY_asn1_free(ameth);
 344         return NULL;
 345
 346         }
 347
 348 void EVP_PKEY_asn1_copy(EVP_PKEY_ASN1_METHOD *dst,
 349                         const EVP_PKEY_ASN1_METHOD *src)
 350         {
 351
 352         dst->pub_decode = src->pub_decode;
 353         dst->pub_encode = src->pub_encode;
 354         dst->pub_cmp = src->pub_cmp;
 355         dst->pub_print = src->pub_print;
 356
 357         dst->priv_decode = src->priv_decode;
 358         dst->priv_encode = src->priv_encode;
 359         dst->priv_print = src->priv_print;
 360
 361         dst->old_priv_encode = src->old_priv_encode;
 362         dst->old_priv_decode = src->old_priv_decode;
 363
 364         dst->pkey_size = src->pkey_size;
 365         dst->pkey_bits = src->pkey_bits;
 366
 367         dst->param_decode = src->param_decode;
 368         dst->param_encode = src->param_encode;
 369         dst->param_missing = src->param_missing;
 370         dst->param_copy = src->param_copy;
 371         dst->param_cmp = src->param_cmp;
 372         dst->param_print = src->param_print;
 373
 374         dst->pkey_free = src->pkey_free;
 375         dst->pkey_ctrl = src->pkey_ctrl;
 376
 377         }
 378
 379 void EVP_PKEY_asn1_free(EVP_PKEY_ASN1_METHOD *ameth)
 380         {
 381         if (ameth && (ameth->pkey_flags & ASN1_PKEY_DYNAMIC))
 382                 {
 383                 if (ameth->pem_str)
 384                         OPENSSL_free(ameth->pem_str);
 385                 if (ameth->info)
 386                         OPENSSL_free(ameth->info);
 387                 OPENSSL_free(ameth);
 388                 }
 389         }
 390
 391 void EVP_PKEY_asn1_set_public(EVP_PKEY_ASN1_METHOD *ameth,
 392                 int (*pub_decode)(EVP_PKEY *pk, X509_PUBKEY *pub),
 393                 int (*pub_encode)(X509_PUBKEY *pub, const EVP_PKEY *pk),
 394                 int (*pub_cmp)(const EVP_PKEY *a, const EVP_PKEY *b),
 395                 int (*pub_print)(BIO *out, const EVP_PKEY *pkey, int indent,
 396                                                         ASN1_PCTX *pctx),
 397                 int (*pkey_size)(const EVP_PKEY *pk),
 398                 int (*pkey_bits)(const EVP_PKEY *pk))
 399         {
 400         ameth->pub_decode = pub_decode;
 401         ameth->pub_encode = pub_encode;
 402         ameth->pub_cmp = pub_cmp;
 403         ameth->pub_print = pub_print;
 404         ameth->pkey_size = pkey_size;
 405         ameth->pkey_bits = pkey_bits;
 406         }
 407
 408 void EVP_PKEY_asn1_set_private(EVP_PKEY_ASN1_METHOD *ameth,
 409                 int (*priv_decode)(EVP_PKEY *pk, PKCS8_PRIV_KEY_INFO *p8inf),
 410                 int (*priv_encode)(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pk),
 411                 int (*priv_print)(BIO *out, const EVP_PKEY *pkey, int indent,
 412                                                         ASN1_PCTX *pctx))
 413         {
 414         ameth->priv_decode = priv_decode;
 415         ameth->priv_encode = priv_encode;
 416         ameth->priv_print = priv_print;
 417         }
 418
 419 void EVP_PKEY_asn1_set_param(EVP_PKEY_ASN1_METHOD *ameth,
 420                 int (*param_decode)(EVP_PKEY *pkey,
 421                                 const unsigned char **pder, int derlen),
 422                 int (*param_encode)(const EVP_PKEY *pkey, unsigned char **pder),
 423                 int (*param_missing)(const EVP_PKEY *pk),
 424                 int (*param_copy)(EVP_PKEY *to, const EVP_PKEY *from),
 425                 int (*param_cmp)(const EVP_PKEY *a, const EVP_PKEY *b),
 426                 int (*param_print)(BIO *out, const EVP_PKEY *pkey, int indent,
 427                                                         ASN1_PCTX *pctx))
 428         {
 429         ameth->param_decode = param_decode;
 430         ameth->param_encode = param_encode;
 431         ameth->param_missing = param_missing;
 432         ameth->param_copy = param_copy;
 433         ameth->param_cmp = param_cmp;
 434         ameth->param_print = param_print;
 435         }
 436
 437 void EVP_PKEY_asn1_set_free(EVP_PKEY_ASN1_METHOD *ameth,
 438                 void (*pkey_free)(EVP_PKEY *pkey))
 439         {
 440         ameth->pkey_free = pkey_free;
 441         }
 442
 443 void EVP_PKEY_asn1_set_ctrl(EVP_PKEY_ASN1_METHOD *ameth,
 444                 int (*pkey_ctrl)(EVP_PKEY *pkey, int op,
 445                                                         long arg1, void *arg2))
 446         {
 447         ameth->pkey_ctrl = pkey_ctrl;
 448         }