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