221178dd31d40831033f1baaea524971477a25ee
[openssl.git] / crypto / evp / p_lib.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include "internal/cryptlib.h"
60 #include <openssl/bn.h>
61 #include <openssl/err.h>
62 #include <openssl/objects.h>
63 #include <openssl/evp.h>
64 #include <openssl/x509.h>
65 #ifndef OPENSSL_NO_RSA
66 # include <openssl/rsa.h>
67 #endif
68 #ifndef OPENSSL_NO_DSA
69 # include <openssl/dsa.h>
70 #endif
71 #ifndef OPENSSL_NO_DH
72 # include <openssl/dh.h>
73 #endif
74
75 #ifndef OPENSSL_NO_ENGINE
76 # include <openssl/engine.h>
77 #endif
78
79 #include "internal/asn1_int.h"
80 #include "internal/evp_int.h"
81
82 static void EVP_PKEY_free_it(EVP_PKEY *x);
83
84 int EVP_PKEY_bits(EVP_PKEY *pkey)
85 {
86     if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
87         return pkey->ameth->pkey_bits(pkey);
88     return 0;
89 }
90
91 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
92 {
93     if (pkey == NULL)
94         return 0;
95     if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
96         return -2;
97     return pkey->ameth->pkey_security_bits(pkey);
98 }
99
100 int EVP_PKEY_size(EVP_PKEY *pkey)
101 {
102     if (pkey && pkey->ameth && pkey->ameth->pkey_size)
103         return pkey->ameth->pkey_size(pkey);
104     return 0;
105 }
106
107 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
108 {
109 #ifndef OPENSSL_NO_DSA
110     if (pkey->type == EVP_PKEY_DSA) {
111         int ret = pkey->save_parameters;
112
113         if (mode >= 0)
114             pkey->save_parameters = mode;
115         return (ret);
116     }
117 #endif
118 #ifndef OPENSSL_NO_EC
119     if (pkey->type == EVP_PKEY_EC) {
120         int ret = pkey->save_parameters;
121
122         if (mode >= 0)
123             pkey->save_parameters = mode;
124         return (ret);
125     }
126 #endif
127     return (0);
128 }
129
130 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
131 {
132     if (to->type == EVP_PKEY_NONE) {
133         if (EVP_PKEY_set_type(to, from->type) == 0)
134             return 0;
135     } else if (to->type != from->type) {
136         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
137         goto err;
138     }
139
140     if (EVP_PKEY_missing_parameters(from)) {
141         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
142         goto err;
143     }
144     if (from->ameth && from->ameth->param_copy)
145         return from->ameth->param_copy(to, from);
146  err:
147     return 0;
148 }
149
150 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
151 {
152     if (pkey->ameth && pkey->ameth->param_missing)
153         return pkey->ameth->param_missing(pkey);
154     return 0;
155 }
156
157 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
158 {
159     if (a->type != b->type)
160         return -1;
161     if (a->ameth && a->ameth->param_cmp)
162         return a->ameth->param_cmp(a, b);
163     return -2;
164 }
165
166 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
167 {
168     if (a->type != b->type)
169         return -1;
170
171     if (a->ameth) {
172         int ret;
173         /* Compare parameters if the algorithm has them */
174         if (a->ameth->param_cmp) {
175             ret = a->ameth->param_cmp(a, b);
176             if (ret <= 0)
177                 return ret;
178         }
179
180         if (a->ameth->pub_cmp)
181             return a->ameth->pub_cmp(a, b);
182     }
183
184     return -2;
185 }
186
187 EVP_PKEY *EVP_PKEY_new(void)
188 {
189     EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
190
191     if (ret == NULL) {
192         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
193         return (NULL);
194     }
195     ret->type = EVP_PKEY_NONE;
196     ret->save_type = EVP_PKEY_NONE;
197     ret->references = 1;
198     ret->save_parameters = 1;
199     return (ret);
200 }
201
202 void EVP_PKEY_up_ref(EVP_PKEY *pkey)
203 {
204     CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
205 }
206
207 /*
208  * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
209  * is NULL just return 1 or 0 if the algorithm exists.
210  */
211
212 static int pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
213 {
214     const EVP_PKEY_ASN1_METHOD *ameth;
215     ENGINE *e = NULL;
216     if (pkey) {
217         if (pkey->pkey.ptr)
218             EVP_PKEY_free_it(pkey);
219         /*
220          * If key type matches and a method exists then this lookup has
221          * succeeded once so just indicate success.
222          */
223         if ((type == pkey->save_type) && pkey->ameth)
224             return 1;
225 #ifndef OPENSSL_NO_ENGINE
226         /* If we have an ENGINE release it */
227         if (pkey->engine) {
228             ENGINE_finish(pkey->engine);
229             pkey->engine = NULL;
230         }
231 #endif
232     }
233     if (str)
234         ameth = EVP_PKEY_asn1_find_str(&e, str, len);
235     else
236         ameth = EVP_PKEY_asn1_find(&e, type);
237 #ifndef OPENSSL_NO_ENGINE
238     if (!pkey && e)
239         ENGINE_finish(e);
240 #endif
241     if (!ameth) {
242         EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
243         return 0;
244     }
245     if (pkey) {
246         pkey->ameth = ameth;
247         pkey->engine = e;
248
249         pkey->type = pkey->ameth->pkey_id;
250         pkey->save_type = type;
251     }
252     return 1;
253 }
254
255 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
256 {
257     return pkey_set_type(pkey, type, NULL, -1);
258 }
259
260 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
261 {
262     return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
263 }
264
265 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
266 {
267     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
268         return 0;
269     pkey->pkey.ptr = key;
270     return (key != NULL);
271 }
272
273 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
274 {
275     return pkey->pkey.ptr;
276 }
277
278 #ifndef OPENSSL_NO_RSA
279 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
280 {
281     int ret = EVP_PKEY_assign_RSA(pkey, key);
282     if (ret)
283         RSA_up_ref(key);
284     return ret;
285 }
286
287 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
288 {
289     if (pkey->type != EVP_PKEY_RSA) {
290         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
291         return NULL;
292     }
293     return pkey->pkey.rsa;
294 }
295
296 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
297 {
298     RSA *ret = EVP_PKEY_get0_RSA(pkey);
299     if (ret != NULL)
300         RSA_up_ref(ret);
301     return ret;
302 }
303 #endif
304
305 #ifndef OPENSSL_NO_DSA
306 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
307 {
308     int ret = EVP_PKEY_assign_DSA(pkey, key);
309     if (ret)
310         DSA_up_ref(key);
311     return ret;
312 }
313
314 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
315 {
316     if (pkey->type != EVP_PKEY_DSA) {
317         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
318         return NULL;
319     }
320     return pkey->pkey.dsa;
321 }
322
323 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
324 {
325     DSA *ret = EVP_PKEY_get0_DSA(pkey);
326     if (ret != NULL)
327         DSA_up_ref(ret);
328     return ret;
329 }
330 #endif
331
332 #ifndef OPENSSL_NO_EC
333
334 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
335 {
336     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
337     if (ret)
338         EC_KEY_up_ref(key);
339     return ret;
340 }
341
342 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
343 {
344     if (pkey->type != EVP_PKEY_EC) {
345         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
346         return NULL;
347     }
348     return pkey->pkey.ec;
349 }
350
351 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
352 {
353     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
354     if (ret != NULL)
355         EC_KEY_up_ref(ret);
356     return ret;
357 }
358 #endif
359
360 #ifndef OPENSSL_NO_DH
361
362 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
363 {
364     int ret = EVP_PKEY_assign_DH(pkey, key);
365     if (ret)
366         DH_up_ref(key);
367     return ret;
368 }
369
370 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
371 {
372     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
373         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
374         return NULL;
375     }
376     return pkey->pkey.dh;
377 }
378
379 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
380 {
381     DH *ret = EVP_PKEY_get0_DH(pkey);
382     if (ret != NULL)
383         DH_up_ref(ret);
384     return ret;
385 }
386 #endif
387
388 int EVP_PKEY_type(int type)
389 {
390     int ret;
391     const EVP_PKEY_ASN1_METHOD *ameth;
392     ENGINE *e;
393     ameth = EVP_PKEY_asn1_find(&e, type);
394     if (ameth)
395         ret = ameth->pkey_id;
396     else
397         ret = NID_undef;
398 #ifndef OPENSSL_NO_ENGINE
399     if (e)
400         ENGINE_finish(e);
401 #endif
402     return ret;
403 }
404
405 int EVP_PKEY_id(const EVP_PKEY *pkey)
406 {
407     return pkey->type;
408 }
409
410 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
411 {
412     return EVP_PKEY_type(pkey->type);
413 }
414
415 void EVP_PKEY_free(EVP_PKEY *x)
416 {
417     int i;
418
419     if (x == NULL)
420         return;
421
422     i = CRYPTO_add(&x->references, -1, CRYPTO_LOCK_EVP_PKEY);
423     REF_PRINT_COUNT("EVP_PKEY", x);
424     if (i > 0)
425         return;
426     REF_ASSERT_ISNT(i < 0);
427     EVP_PKEY_free_it(x);
428     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
429     OPENSSL_free(x);
430 }
431
432 static void EVP_PKEY_free_it(EVP_PKEY *x)
433 {
434     /* internal function; x is never NULL */
435     if (x->ameth && x->ameth->pkey_free) {
436         x->ameth->pkey_free(x);
437         x->pkey.ptr = NULL;
438     }
439 #ifndef OPENSSL_NO_ENGINE
440     if (x->engine) {
441         ENGINE_finish(x->engine);
442         x->engine = NULL;
443     }
444 #endif
445 }
446
447 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
448                      const char *kstr)
449 {
450     BIO_indent(out, indent, 128);
451     BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
452                kstr, OBJ_nid2ln(pkey->type));
453     return 1;
454 }
455
456 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
457                           int indent, ASN1_PCTX *pctx)
458 {
459     if (pkey->ameth && pkey->ameth->pub_print)
460         return pkey->ameth->pub_print(out, pkey, indent, pctx);
461
462     return unsup_alg(out, pkey, indent, "Public Key");
463 }
464
465 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
466                            int indent, ASN1_PCTX *pctx)
467 {
468     if (pkey->ameth && pkey->ameth->priv_print)
469         return pkey->ameth->priv_print(out, pkey, indent, pctx);
470
471     return unsup_alg(out, pkey, indent, "Private Key");
472 }
473
474 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
475                           int indent, ASN1_PCTX *pctx)
476 {
477     if (pkey->ameth && pkey->ameth->param_print)
478         return pkey->ameth->param_print(out, pkey, indent, pctx);
479     return unsup_alg(out, pkey, indent, "Parameters");
480 }
481
482 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
483 {
484     if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
485         return -2;
486     return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,
487                                   0, pnid);
488 }