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