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