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