crypto/openssl/crypto/asn1/ameth_lib.c

   1 /*
   2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   3  * 2006.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2006 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@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@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #include <stdio.h>
  60 #include "cryptlib.h"
  61 #include <openssl/asn1t.h>
  62 #include <openssl/x509.h>
  63 #ifndef OPENSSL_NO_ENGINE
  64 # include <openssl/engine.h>
  65 #endif
  66 #include "asn1_locl.h"
  67
  68 extern const EVP_PKEY_ASN1_METHOD rsa_asn1_meths[];
  69 extern const EVP_PKEY_ASN1_METHOD dsa_asn1_meths[];
  70 extern const EVP_PKEY_ASN1_METHOD dh_asn1_meth;
  71 extern const EVP_PKEY_ASN1_METHOD eckey_asn1_meth;
  72 extern const EVP_PKEY_ASN1_METHOD hmac_asn1_meth;
  73 extern const EVP_PKEY_ASN1_METHOD cmac_asn1_meth;
  74
  75 /* Keep this sorted in type order !! */
  76 static const EVP_PKEY_ASN1_METHOD *standard_methods[] = {
  77 #ifndef OPENSSL_NO_RSA
  78     &rsa_asn1_meths[0],
  79     &rsa_asn1_meths[1],
  80 #endif
  81 #ifndef OPENSSL_NO_DH
  82     &dh_asn1_meth,
  83 #endif
  84 #ifndef OPENSSL_NO_DSA
  85     &dsa_asn1_meths[0],
  86     &dsa_asn1_meths[1],
  87     &dsa_asn1_meths[2],
  88     &dsa_asn1_meths[3],
  89     &dsa_asn1_meths[4],
  90 #endif
  91 #ifndef OPENSSL_NO_EC
  92     &eckey_asn1_meth,
  93 #endif
  94     &hmac_asn1_meth,
  95     &cmac_asn1_meth
  96 };
  97
  98 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
  99 DECLARE_STACK_OF(EVP_PKEY_ASN1_METHOD)
 100 static STACK_OF(EVP_PKEY_ASN1_METHOD) *app_methods = NULL;
 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 *); i++)
 108         fprintf(stderr, "Number %d id=%d (%s)\n", i,
 109                 standard_methods[i]->pkey_id,
 110                 OBJ_nid2sn(standard_methods[i]->pkey_id));
 111 }
 112 #endif
 113
 114 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_ASN1_METHOD *,
 115                            const EVP_PKEY_ASN1_METHOD *, ameth);
 116
 117 static int ameth_cmp(const EVP_PKEY_ASN1_METHOD *const *a,
 118                      const EVP_PKEY_ASN1_METHOD *const *b)
 119 {
 120     return ((*a)->pkey_id - (*b)->pkey_id);
 121 }
 122
 123 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_ASN1_METHOD *,
 124                              const EVP_PKEY_ASN1_METHOD *, ameth);
 125
 126 int EVP_PKEY_asn1_get_count(void)
 127 {
 128     int num = sizeof(standard_methods) / sizeof(EVP_PKEY_ASN1_METHOD *);
 129     if (app_methods)
 130         num += sk_EVP_PKEY_ASN1_METHOD_num(app_methods);
 131     return num;
 132 }
 133
 134 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_get0(int idx)
 135 {
 136     int num = sizeof(standard_methods) / sizeof(EVP_PKEY_ASN1_METHOD *);
 137     if (idx < 0)
 138         return NULL;
 139     if (idx < num)
 140         return standard_methods[idx];
 141     idx -= num;
 142     return sk_EVP_PKEY_ASN1_METHOD_value(app_methods, idx);
 143 }
 144
 145 static const EVP_PKEY_ASN1_METHOD *pkey_asn1_find(int type)
 146 {
 147     EVP_PKEY_ASN1_METHOD tmp;
 148     const EVP_PKEY_ASN1_METHOD *t = &tmp, **ret;
 149     tmp.pkey_id = type;
 150     if (app_methods) {
 151         int idx;
 152         idx = sk_EVP_PKEY_ASN1_METHOD_find(app_methods, &tmp);
 153         if (idx >= 0)
 154             return sk_EVP_PKEY_ASN1_METHOD_value(app_methods, idx);
 155     }
 156     ret = OBJ_bsearch_ameth(&t, standard_methods, sizeof(standard_methods)
 157                             / sizeof(EVP_PKEY_ASN1_METHOD *));
 158     if (!ret || !*ret)
 159         return NULL;
 160     return *ret;
 161 }
 162
 163 /*
 164  * Find an implementation of an ASN1 algorithm. If 'pe' is not NULL also
 165  * search through engines and set *pe to a functional reference to the engine
 166  * implementing 'type' or NULL if no engine implements it.
 167  */
 168
 169 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find(ENGINE **pe, int type)
 170 {
 171     const EVP_PKEY_ASN1_METHOD *t;
 172
 173     for (;;) {
 174         t = pkey_asn1_find(type);
 175         if (!t || !(t->pkey_flags & ASN1_PKEY_ALIAS))
 176             break;
 177         type = t->pkey_base_id;
 178     }
 179     if (pe) {
 180 #ifndef OPENSSL_NO_ENGINE
 181         ENGINE *e;
 182         /* type will contain the final unaliased type */
 183         e = ENGINE_get_pkey_asn1_meth_engine(type);
 184         if (e) {
 185             *pe = e;
 186             return ENGINE_get_pkey_asn1_meth(e, type);
 187         }
 188 #endif
 189         *pe = NULL;
 190     }
 191     return t;
 192 }
 193
 194 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find_str(ENGINE **pe,
 195                                                    const char *str, int len)
 196 {
 197     int i;
 198     const EVP_PKEY_ASN1_METHOD *ameth;
 199     if (len == -1)
 200         len = strlen(str);
 201     if (pe) {
 202 #ifndef OPENSSL_NO_ENGINE
 203         ENGINE *e;
 204         ameth = ENGINE_pkey_asn1_find_str(&e, str, len);
 205         if (ameth) {
 206             /*
 207              * Convert structural into functional reference
 208              */
 209             if (!ENGINE_init(e))
 210                 ameth = NULL;
 211             ENGINE_free(e);
 212             *pe = e;
 213             return ameth;
 214         }
 215 #endif
 216         *pe = NULL;
 217     }
 218     for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
 219         ameth = EVP_PKEY_asn1_get0(i);
 220         if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
 221             continue;
 222         if (((int)strlen(ameth->pem_str) == len) &&
 223             !strncasecmp(ameth->pem_str, str, len))
 224             return ameth;
 225     }
 226     return NULL;
 227 }
 228
 229 int EVP_PKEY_asn1_add0(const EVP_PKEY_ASN1_METHOD *ameth)
 230 {
 231     if (app_methods == NULL) {
 232         app_methods = sk_EVP_PKEY_ASN1_METHOD_new(ameth_cmp);
 233         if (!app_methods)
 234             return 0;
 235     }
 236     if (!sk_EVP_PKEY_ASN1_METHOD_push(app_methods, ameth))
 237         return 0;
 238     sk_EVP_PKEY_ASN1_METHOD_sort(app_methods);
 239     return 1;
 240 }
 241
 242 int EVP_PKEY_asn1_add_alias(int to, int from)
 243 {
 244     EVP_PKEY_ASN1_METHOD *ameth;
 245     ameth = EVP_PKEY_asn1_new(from, ASN1_PKEY_ALIAS, NULL, NULL);
 246     if (!ameth)
 247         return 0;
 248     ameth->pkey_base_id = to;
 249     if (!EVP_PKEY_asn1_add0(ameth)) {
 250         EVP_PKEY_asn1_free(ameth);
 251         return 0;
 252     }
 253     return 1;
 254 }
 255
 256 int EVP_PKEY_asn1_get0_info(int *ppkey_id, int *ppkey_base_id,
 257                             int *ppkey_flags, const char **pinfo,
 258                             const char **ppem_str,
 259                             const EVP_PKEY_ASN1_METHOD *ameth)
 260 {
 261     if (!ameth)
 262         return 0;
 263     if (ppkey_id)
 264         *ppkey_id = ameth->pkey_id;
 265     if (ppkey_base_id)
 266         *ppkey_base_id = ameth->pkey_base_id;
 267     if (ppkey_flags)
 268         *ppkey_flags = ameth->pkey_flags;
 269     if (pinfo)
 270         *pinfo = ameth->info;
 271     if (ppem_str)
 272         *ppem_str = ameth->pem_str;
 273     return 1;
 274 }
 275
 276 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_get0_asn1(EVP_PKEY *pkey)
 277 {
 278     return pkey->ameth;
 279 }
 280
 281 EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_new(int id, int flags,
 282                                         const char *pem_str, const char *info)
 283 {
 284     EVP_PKEY_ASN1_METHOD *ameth;
 285     ameth = OPENSSL_malloc(sizeof(EVP_PKEY_ASN1_METHOD));
 286     if (!ameth)
 287         return NULL;
 288
 289     memset(ameth, 0, sizeof(EVP_PKEY_ASN1_METHOD));
 290
 291     ameth->pkey_id = id;
 292     ameth->pkey_base_id = id;
 293     ameth->pkey_flags = flags | ASN1_PKEY_DYNAMIC;
 294
 295     if (info) {
 296         ameth->info = BUF_strdup(info);
 297         if (!ameth->info)
 298             goto err;
 299     } else
 300         ameth->info = NULL;
 301
 302     if (pem_str) {
 303         ameth->pem_str = BUF_strdup(pem_str);
 304         if (!ameth->pem_str)
 305             goto err;
 306     } else
 307         ameth->pem_str = NULL;
 308
 309     ameth->pub_decode = 0;
 310     ameth->pub_encode = 0;
 311     ameth->pub_cmp = 0;
 312     ameth->pub_print = 0;
 313
 314     ameth->priv_decode = 0;
 315     ameth->priv_encode = 0;
 316     ameth->priv_print = 0;
 317
 318     ameth->old_priv_encode = 0;
 319     ameth->old_priv_decode = 0;
 320
 321     ameth->item_verify = 0;
 322     ameth->item_sign = 0;
 323
 324     ameth->pkey_size = 0;
 325     ameth->pkey_bits = 0;
 326
 327     ameth->param_decode = 0;
 328     ameth->param_encode = 0;
 329     ameth->param_missing = 0;
 330     ameth->param_copy = 0;
 331     ameth->param_cmp = 0;
 332     ameth->param_print = 0;
 333
 334     ameth->pkey_free = 0;
 335     ameth->pkey_ctrl = 0;
 336
 337     return ameth;
 338
 339  err:
 340
 341     EVP_PKEY_asn1_free(ameth);
 342     return NULL;
 343
 344 }
 345
 346 void EVP_PKEY_asn1_copy(EVP_PKEY_ASN1_METHOD *dst,
 347                         const EVP_PKEY_ASN1_METHOD *src)
 348 {
 349
 350     dst->pub_decode = src->pub_decode;
 351     dst->pub_encode = src->pub_encode;
 352     dst->pub_cmp = src->pub_cmp;
 353     dst->pub_print = src->pub_print;
 354
 355     dst->priv_decode = src->priv_decode;
 356     dst->priv_encode = src->priv_encode;
 357     dst->priv_print = src->priv_print;
 358
 359     dst->old_priv_encode = src->old_priv_encode;
 360     dst->old_priv_decode = src->old_priv_decode;
 361
 362     dst->pkey_size = src->pkey_size;
 363     dst->pkey_bits = src->pkey_bits;
 364
 365     dst->param_decode = src->param_decode;
 366     dst->param_encode = src->param_encode;
 367     dst->param_missing = src->param_missing;
 368     dst->param_copy = src->param_copy;
 369     dst->param_cmp = src->param_cmp;
 370     dst->param_print = src->param_print;
 371
 372     dst->pkey_free = src->pkey_free;
 373     dst->pkey_ctrl = src->pkey_ctrl;
 374
 375     dst->item_sign = src->item_sign;
 376     dst->item_verify = src->item_verify;
 377
 378 }
 379
 380 void EVP_PKEY_asn1_free(EVP_PKEY_ASN1_METHOD *ameth)
 381 {
 382     if (ameth && (ameth->pkey_flags & ASN1_PKEY_DYNAMIC)) {
 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,
 393                                                  X509_PUBKEY *pub),
 394                               int (*pub_encode) (X509_PUBKEY *pub,
 395                                                  const EVP_PKEY *pk),
 396                               int (*pub_cmp) (const EVP_PKEY *a,
 397                                               const EVP_PKEY *b),
 398                               int (*pub_print) (BIO *out,
 399                                                 const EVP_PKEY *pkey,
 400                                                 int indent, ASN1_PCTX *pctx),
 401                               int (*pkey_size) (const EVP_PKEY *pk),
 402                               int (*pkey_bits) (const EVP_PKEY *pk))
 403 {
 404     ameth->pub_decode = pub_decode;
 405     ameth->pub_encode = pub_encode;
 406     ameth->pub_cmp = pub_cmp;
 407     ameth->pub_print = pub_print;
 408     ameth->pkey_size = pkey_size;
 409     ameth->pkey_bits = pkey_bits;
 410 }
 411
 412 void EVP_PKEY_asn1_set_private(EVP_PKEY_ASN1_METHOD *ameth,
 413                                int (*priv_decode) (EVP_PKEY *pk,
 414                                                    PKCS8_PRIV_KEY_INFO
 415                                                    *p8inf),
 416                                int (*priv_encode) (PKCS8_PRIV_KEY_INFO *p8,
 417                                                    const EVP_PKEY *pk),
 418                                int (*priv_print) (BIO *out,
 419                                                   const EVP_PKEY *pkey,
 420                                                   int indent,
 421                                                   ASN1_PCTX *pctx))
 422 {
 423     ameth->priv_decode = priv_decode;
 424     ameth->priv_encode = priv_encode;
 425     ameth->priv_print = priv_print;
 426 }
 427
 428 void EVP_PKEY_asn1_set_param(EVP_PKEY_ASN1_METHOD *ameth,
 429                              int (*param_decode) (EVP_PKEY *pkey,
 430                                                   const unsigned char **pder,
 431                                                   int derlen),
 432                              int (*param_encode) (const EVP_PKEY *pkey,
 433                                                   unsigned char **pder),
 434                              int (*param_missing) (const EVP_PKEY *pk),
 435                              int (*param_copy) (EVP_PKEY *to,
 436                                                 const EVP_PKEY *from),
 437                              int (*param_cmp) (const EVP_PKEY *a,
 438                                                const EVP_PKEY *b),
 439                              int (*param_print) (BIO *out,
 440                                                  const EVP_PKEY *pkey,
 441                                                  int indent, ASN1_PCTX *pctx))
 442 {
 443     ameth->param_decode = param_decode;
 444     ameth->param_encode = param_encode;
 445     ameth->param_missing = param_missing;
 446     ameth->param_copy = param_copy;
 447     ameth->param_cmp = param_cmp;
 448     ameth->param_print = param_print;
 449 }
 450
 451 void EVP_PKEY_asn1_set_free(EVP_PKEY_ASN1_METHOD *ameth,
 452                             void (*pkey_free) (EVP_PKEY *pkey))
 453 {
 454     ameth->pkey_free = pkey_free;
 455 }
 456
 457 void EVP_PKEY_asn1_set_ctrl(EVP_PKEY_ASN1_METHOD *ameth,
 458                             int (*pkey_ctrl) (EVP_PKEY *pkey, int op,
 459                                               long arg1, void *arg2))
 460 {
 461     ameth->pkey_ctrl = pkey_ctrl;
 462 }