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