xref: /openbsd-src/lib/libcrypto/evp/p_lib.c (revision ca270c0af014226ef0d076452fa4b2b38e6235eb) 
1 /* $OpenBSD: p_lib.c,v 1.48 2023/12/25 21:51:57 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 #include <stdio.h>
60 
61 #include <openssl/opensslconf.h>
62 
63 #include <openssl/bn.h>
64 #include <openssl/cmac.h>
65 #include <openssl/err.h>
66 #include <openssl/evp.h>
67 #include <openssl/objects.h>
68 #include <openssl/x509.h>
69 
70 #ifndef OPENSSL_NO_DH
71 #include <openssl/dh.h>
72 #endif
73 #ifndef OPENSSL_NO_DSA
74 #include <openssl/dsa.h>
75 #endif
76 #ifndef OPENSSL_NO_RSA
77 #include <openssl/rsa.h>
78 #endif
79 
80 #include "asn1_local.h"
81 #include "evp_local.h"
82 
83 int
84 EVP_PKEY_bits(const 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
92 EVP_PKEY_security_bits(const EVP_PKEY *pkey)
93 {
94 	if (pkey == NULL)
95 		return 0;
96 	if (pkey->ameth == NULL || pkey->ameth->pkey_security_bits == NULL)
97 		return -2;
98 
99 	return pkey->ameth->pkey_security_bits(pkey);
100 }
101 
102 int
103 EVP_PKEY_size(const EVP_PKEY *pkey)
104 {
105 	if (pkey && pkey->ameth && pkey->ameth->pkey_size)
106 		return pkey->ameth->pkey_size(pkey);
107 	return 0;
108 }
109 
110 int
111 EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
112 {
113 #ifndef OPENSSL_NO_DSA
114 	if (pkey->type == EVP_PKEY_DSA) {
115 		int ret = pkey->save_parameters;
116 
117 		if (mode >= 0)
118 			pkey->save_parameters = mode;
119 		return (ret);
120 	}
121 #endif
122 #ifndef OPENSSL_NO_EC
123 	if (pkey->type == EVP_PKEY_EC) {
124 		int ret = pkey->save_parameters;
125 
126 		if (mode >= 0)
127 			pkey->save_parameters = mode;
128 		return (ret);
129 	}
130 #endif
131 	return (0);
132 }
133 
134 int
135 EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
136 {
137 	if (to->type != from->type) {
138 		EVPerror(EVP_R_DIFFERENT_KEY_TYPES);
139 		goto err;
140 	}
141 
142 	if (EVP_PKEY_missing_parameters(from)) {
143 		EVPerror(EVP_R_MISSING_PARAMETERS);
144 		goto err;
145 	}
146 	if (from->ameth && from->ameth->param_copy)
147 		return from->ameth->param_copy(to, from);
148 
149 err:
150 	return 0;
151 }
152 
153 int
154 EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
155 {
156 	if (pkey->ameth && pkey->ameth->param_missing)
157 		return pkey->ameth->param_missing(pkey);
158 	return 0;
159 }
160 
161 int
162 EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
163 {
164 	if (a->type != b->type)
165 		return -1;
166 	if (a->ameth && a->ameth->param_cmp)
167 		return a->ameth->param_cmp(a, b);
168 	return -2;
169 }
170 
171 int
172 EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
173 {
174 	if (a->type != b->type)
175 		return -1;
176 
177 	if (a->ameth) {
178 		int ret;
179 		/* Compare parameters if the algorithm has them */
180 		if (a->ameth->param_cmp) {
181 			ret = a->ameth->param_cmp(a, b);
182 			if (ret <= 0)
183 				return ret;
184 		}
185 
186 		if (a->ameth->pub_cmp)
187 			return a->ameth->pub_cmp(a, b);
188 	}
189 
190 	return -2;
191 }
192 
193 EVP_PKEY *
194 EVP_PKEY_new(void)
195 {
196 	EVP_PKEY *ret;
197 
198 	if ((ret = calloc(1, sizeof(*ret))) == NULL) {
199 		EVPerror(ERR_R_MALLOC_FAILURE);
200 		return NULL;
201 	}
202 
203 	ret->type = EVP_PKEY_NONE;
204 	ret->save_type = EVP_PKEY_NONE;
205 	ret->references = 1;
206 	ret->save_parameters = 1;
207 
208 	return ret;
209 }
210 
211 int
212 EVP_PKEY_up_ref(EVP_PKEY *pkey)
213 {
214 	return CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY) > 1;
215 }
216 
217 static void
218 evp_pkey_free_pkey_ptr(EVP_PKEY *pkey)
219 {
220 	if (pkey == NULL || pkey->ameth == NULL || pkey->ameth->pkey_free == NULL)
221 		return;
222 
223 	pkey->ameth->pkey_free(pkey);
224 	pkey->pkey.ptr = NULL;
225 }
226 
227 void
228 EVP_PKEY_free(EVP_PKEY *pkey)
229 {
230 	if (pkey == NULL)
231 		return;
232 
233 	if (CRYPTO_add(&pkey->references, -1, CRYPTO_LOCK_EVP_PKEY) > 0)
234 		return;
235 
236 	evp_pkey_free_pkey_ptr(pkey);
237 	sk_X509_ATTRIBUTE_pop_free(pkey->attributes, X509_ATTRIBUTE_free);
238 	freezero(pkey, sizeof(*pkey));
239 }
240 
241 int
242 EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
243 {
244 	const EVP_PKEY_ASN1_METHOD *ameth;
245 
246 	evp_pkey_free_pkey_ptr(pkey);
247 
248 	if ((ameth = EVP_PKEY_asn1_find(NULL, type)) == NULL) {
249 		EVPerror(EVP_R_UNSUPPORTED_ALGORITHM);
250 		return 0;
251 	}
252 	if (pkey != NULL) {
253 		pkey->ameth = ameth;
254 		pkey->type = pkey->ameth->pkey_id;
255 		pkey->save_type = type;
256 	}
257 
258 	return 1;
259 }
260 
261 int
262 EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
263 {
264 	const EVP_PKEY_ASN1_METHOD *ameth;
265 
266 	evp_pkey_free_pkey_ptr(pkey);
267 
268 	if ((ameth = EVP_PKEY_asn1_find_str(NULL, str, len)) == NULL) {
269 		EVPerror(EVP_R_UNSUPPORTED_ALGORITHM);
270 		return 0;
271 	}
272 	if (pkey != NULL) {
273 		pkey->ameth = ameth;
274 		pkey->type = pkey->ameth->pkey_id;
275 		pkey->save_type = EVP_PKEY_NONE;
276 	}
277 
278 	return 1;
279 }
280 
281 EVP_PKEY *
282 EVP_PKEY_new_raw_private_key(int type, ENGINE *engine,
283     const unsigned char *private_key, size_t len)
284 {
285 	EVP_PKEY *ret;
286 
287 	if ((ret = EVP_PKEY_new()) == NULL)
288 		goto err;
289 
290 	if (!EVP_PKEY_set_type(ret, type))
291 		goto err;
292 
293 	if (ret->ameth->set_priv_key == NULL) {
294 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
295 		goto err;
296 	}
297 	if (!ret->ameth->set_priv_key(ret, private_key, len)) {
298 		EVPerror(EVP_R_KEY_SETUP_FAILED);
299 		goto err;
300 	}
301 
302 	return ret;
303 
304  err:
305 	EVP_PKEY_free(ret);
306 
307 	return NULL;
308 }
309 
310 EVP_PKEY *
311 EVP_PKEY_new_raw_public_key(int type, ENGINE *engine,
312     const unsigned char *public_key, size_t len)
313 {
314 	EVP_PKEY *ret;
315 
316 	if ((ret = EVP_PKEY_new()) == NULL)
317 		goto err;
318 
319 	if (!EVP_PKEY_set_type(ret, type))
320 		goto err;
321 
322 	if (ret->ameth->set_pub_key == NULL) {
323 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
324 		goto err;
325 	}
326 	if (!ret->ameth->set_pub_key(ret, public_key, len)) {
327 		EVPerror(EVP_R_KEY_SETUP_FAILED);
328 		goto err;
329 	}
330 
331 	return ret;
332 
333  err:
334 	EVP_PKEY_free(ret);
335 
336 	return NULL;
337 }
338 
339 int
340 EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey,
341     unsigned char *out_private_key, size_t *out_len)
342 {
343 	if (pkey->ameth->get_priv_key == NULL) {
344 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
345 		return 0;
346 	}
347 	if (!pkey->ameth->get_priv_key(pkey, out_private_key, out_len)) {
348 		EVPerror(EVP_R_GET_RAW_KEY_FAILED);
349 		return 0;
350 	}
351 
352 	return 1;
353 }
354 
355 int
356 EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey,
357     unsigned char *out_public_key, size_t *out_len)
358 {
359 	if (pkey->ameth->get_pub_key == NULL) {
360 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
361 		return 0;
362 	}
363 	if (!pkey->ameth->get_pub_key(pkey, out_public_key, out_len)) {
364 		EVPerror(EVP_R_GET_RAW_KEY_FAILED);
365 		return 0;
366 	}
367 
368 	return 1;
369 }
370 
371 EVP_PKEY *
372 EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv, size_t len,
373     const EVP_CIPHER *cipher)
374 {
375 	EVP_PKEY *ret = NULL;
376 	CMAC_CTX *cmctx = NULL;
377 
378 	if ((ret = EVP_PKEY_new()) == NULL)
379 		goto err;
380 	if ((cmctx = CMAC_CTX_new()) == NULL)
381 		goto err;
382 
383 	if (!EVP_PKEY_set_type(ret, EVP_PKEY_CMAC))
384 		goto err;
385 
386 	if (!CMAC_Init(cmctx, priv, len, cipher, NULL)) {
387 		EVPerror(EVP_R_KEY_SETUP_FAILED);
388 		goto err;
389 	}
390 
391 	ret->pkey.ptr = cmctx;
392 
393 	return ret;
394 
395  err:
396 	EVP_PKEY_free(ret);
397 	CMAC_CTX_free(cmctx);
398 	return NULL;
399 }
400 
401 int
402 EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
403 {
404 	if (!EVP_PKEY_set_type(pkey, type))
405 		return 0;
406 	pkey->pkey.ptr = key;
407 	return (key != NULL);
408 }
409 
410 void *
411 EVP_PKEY_get0(const EVP_PKEY *pkey)
412 {
413 	return pkey->pkey.ptr;
414 }
415 
416 const unsigned char *
417 EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
418 {
419 	ASN1_OCTET_STRING *os;
420 
421 	if (pkey->type != EVP_PKEY_HMAC) {
422 		EVPerror(EVP_R_EXPECTING_AN_HMAC_KEY);
423 		return NULL;
424 	}
425 
426 	os = EVP_PKEY_get0(pkey);
427 	*len = os->length;
428 
429 	return os->data;
430 }
431 
432 #ifndef OPENSSL_NO_RSA
433 RSA *
434 EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
435 {
436 	if (pkey->type == EVP_PKEY_RSA || pkey->type == EVP_PKEY_RSA_PSS)
437 		return pkey->pkey.rsa;
438 
439 	EVPerror(EVP_R_EXPECTING_AN_RSA_KEY);
440 	return NULL;
441 }
442 
443 RSA *
444 EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
445 {
446 	RSA *rsa;
447 
448 	if ((rsa = EVP_PKEY_get0_RSA(pkey)) == NULL)
449 		return NULL;
450 
451 	RSA_up_ref(rsa);
452 
453 	return rsa;
454 }
455 
456 int
457 EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
458 {
459 	int ret = EVP_PKEY_assign_RSA(pkey, key);
460 	if (ret != 0)
461 		RSA_up_ref(key);
462 	return ret;
463 }
464 #endif
465 
466 #ifndef OPENSSL_NO_DSA
467 DSA *
468 EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
469 {
470 	if (pkey->type != EVP_PKEY_DSA) {
471 		EVPerror(EVP_R_EXPECTING_A_DSA_KEY);
472 		return NULL;
473 	}
474 	return pkey->pkey.dsa;
475 }
476 
477 DSA *
478 EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
479 {
480 	DSA *dsa;
481 
482 	if ((dsa = EVP_PKEY_get0_DSA(pkey)) == NULL)
483 		return NULL;
484 
485 	DSA_up_ref(dsa);
486 
487 	return dsa;
488 }
489 
490 int
491 EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
492 {
493 	int ret = EVP_PKEY_assign_DSA(pkey, key);
494 	if (ret != 0)
495 		DSA_up_ref(key);
496 	return ret;
497 }
498 #endif
499 
500 #ifndef OPENSSL_NO_EC
501 EC_KEY *
502 EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
503 {
504 	if (pkey->type != EVP_PKEY_EC) {
505 		EVPerror(EVP_R_EXPECTING_A_EC_KEY);
506 		return NULL;
507 	}
508 	return pkey->pkey.ec;
509 }
510 
511 EC_KEY *
512 EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
513 {
514 	EC_KEY *key;
515 
516 	if ((key = EVP_PKEY_get0_EC_KEY(pkey)) == NULL)
517 		return NULL;
518 
519 	EC_KEY_up_ref(key);
520 
521 	return key;
522 }
523 
524 int
525 EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
526 {
527 	int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
528 	if (ret != 0)
529 		EC_KEY_up_ref(key);
530 	return ret;
531 }
532 #endif
533 
534 
535 #ifndef OPENSSL_NO_DH
536 DH *
537 EVP_PKEY_get0_DH(EVP_PKEY *pkey)
538 {
539 	if (pkey->type != EVP_PKEY_DH) {
540 		EVPerror(EVP_R_EXPECTING_A_DH_KEY);
541 		return NULL;
542 	}
543 	return pkey->pkey.dh;
544 }
545 
546 DH *
547 EVP_PKEY_get1_DH(EVP_PKEY *pkey)
548 {
549 	DH *dh;
550 
551 	if ((dh = EVP_PKEY_get0_DH(pkey)) == NULL)
552 		return NULL;
553 
554 	DH_up_ref(dh);
555 
556 	return dh;
557 }
558 
559 int
560 EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
561 {
562 	int ret = EVP_PKEY_assign_DH(pkey, key);
563 	if (ret != 0)
564 		DH_up_ref(key);
565 	return ret;
566 }
567 #endif
568 
569 int
570 EVP_PKEY_type(int type)
571 {
572 	const EVP_PKEY_ASN1_METHOD *ameth;
573 
574 	if ((ameth = EVP_PKEY_asn1_find(NULL, type)) != NULL)
575 		return ameth->pkey_id;
576 
577 	return NID_undef;
578 }
579 
580 int
581 EVP_PKEY_id(const EVP_PKEY *pkey)
582 {
583 	return pkey->type;
584 }
585 
586 int
587 EVP_PKEY_base_id(const EVP_PKEY *pkey)
588 {
589 	return EVP_PKEY_type(pkey->type);
590 }
591 
592 static int
593 unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent, const char *kstr)
594 {
595 	if (!BIO_indent(out, indent, 128))
596 		return 0;
597 	BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
598 	    kstr, OBJ_nid2ln(pkey->type));
599 	return 1;
600 }
601 
602 int
603 EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey, int indent,
604     ASN1_PCTX *pctx)
605 {
606 	if (pkey->ameth && pkey->ameth->pub_print)
607 		return pkey->ameth->pub_print(out, pkey, indent, pctx);
608 
609 	return unsup_alg(out, pkey, indent, "Public Key");
610 }
611 
612 int
613 EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey, int indent,
614     ASN1_PCTX *pctx)
615 {
616 	if (pkey->ameth && pkey->ameth->priv_print)
617 		return pkey->ameth->priv_print(out, pkey, indent, pctx);
618 
619 	return unsup_alg(out, pkey, indent, "Private Key");
620 }
621 
622 int
623 EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey, int indent,
624     ASN1_PCTX *pctx)
625 {
626 	if (pkey->ameth && pkey->ameth->param_print)
627 		return pkey->ameth->param_print(out, pkey, indent, pctx);
628 	return unsup_alg(out, pkey, indent, "Parameters");
629 }
630 
631 int
632 EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
633 {
634 	if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
635 		return -2;
636 	return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,
637 	    0, pnid);
638 }
639