xref: /openbsd-src/lib/libcrypto/evp/p_lib.c (revision c5e4bc8373b44b3c0ed84cbb48e0d52d472bcdba) 
1 /* $OpenBSD: p_lib.c,v 1.45 2023/12/25 21:36:05 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 /* Setup a public key ASN1 method from a NID or a string.
228  * If pkey is NULL just return 1 or 0 if the algorithm exists.
229  */
230 
231 static int
232 pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
233 {
234 	const EVP_PKEY_ASN1_METHOD *ameth;
235 
236 	if (pkey) {
237 		if (pkey->pkey.ptr)
238 			evp_pkey_free_pkey_ptr(pkey);
239 		/* If key type matches and a method exists then this
240 		 * lookup has succeeded once so just indicate success.
241 		 */
242 		if ((type == pkey->save_type) && pkey->ameth)
243 			return 1;
244 	}
245 	if (str != NULL)
246 		ameth = EVP_PKEY_asn1_find_str(NULL, str, len);
247 	else
248 		ameth = EVP_PKEY_asn1_find(NULL, type);
249 	if (!ameth) {
250 		EVPerror(EVP_R_UNSUPPORTED_ALGORITHM);
251 		return 0;
252 	}
253 	if (pkey) {
254 		pkey->ameth = ameth;
255 
256 		pkey->type = pkey->ameth->pkey_id;
257 		pkey->save_type = type;
258 	}
259 	return 1;
260 }
261 
262 int
263 EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
264 {
265 	return pkey_set_type(pkey, type, NULL, -1);
266 }
267 
268 EVP_PKEY *
269 EVP_PKEY_new_raw_private_key(int type, ENGINE *engine,
270     const unsigned char *private_key, size_t len)
271 {
272 	EVP_PKEY *ret;
273 
274 	if ((ret = EVP_PKEY_new()) == NULL)
275 		goto err;
276 
277 	if (!pkey_set_type(ret, type, NULL, -1))
278 		goto err;
279 
280 	if (ret->ameth->set_priv_key == NULL) {
281 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
282 		goto err;
283 	}
284 	if (!ret->ameth->set_priv_key(ret, private_key, len)) {
285 		EVPerror(EVP_R_KEY_SETUP_FAILED);
286 		goto err;
287 	}
288 
289 	return ret;
290 
291  err:
292 	EVP_PKEY_free(ret);
293 
294 	return NULL;
295 }
296 
297 EVP_PKEY *
298 EVP_PKEY_new_raw_public_key(int type, ENGINE *engine,
299     const unsigned char *public_key, size_t len)
300 {
301 	EVP_PKEY *ret;
302 
303 	if ((ret = EVP_PKEY_new()) == NULL)
304 		goto err;
305 
306 	if (!pkey_set_type(ret, type, NULL, -1))
307 		goto err;
308 
309 	if (ret->ameth->set_pub_key == NULL) {
310 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
311 		goto err;
312 	}
313 	if (!ret->ameth->set_pub_key(ret, public_key, len)) {
314 		EVPerror(EVP_R_KEY_SETUP_FAILED);
315 		goto err;
316 	}
317 
318 	return ret;
319 
320  err:
321 	EVP_PKEY_free(ret);
322 
323 	return NULL;
324 }
325 
326 int
327 EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey,
328     unsigned char *out_private_key, size_t *out_len)
329 {
330 	if (pkey->ameth->get_priv_key == NULL) {
331 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
332 		return 0;
333 	}
334 	if (!pkey->ameth->get_priv_key(pkey, out_private_key, out_len)) {
335 		EVPerror(EVP_R_GET_RAW_KEY_FAILED);
336 		return 0;
337 	}
338 
339 	return 1;
340 }
341 
342 int
343 EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey,
344     unsigned char *out_public_key, size_t *out_len)
345 {
346 	if (pkey->ameth->get_pub_key == NULL) {
347 		EVPerror(EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
348 		return 0;
349 	}
350 	if (!pkey->ameth->get_pub_key(pkey, out_public_key, out_len)) {
351 		EVPerror(EVP_R_GET_RAW_KEY_FAILED);
352 		return 0;
353 	}
354 
355 	return 1;
356 }
357 
358 EVP_PKEY *
359 EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv, size_t len,
360     const EVP_CIPHER *cipher)
361 {
362 	EVP_PKEY *ret = NULL;
363 	CMAC_CTX *cmctx = NULL;
364 
365 	if ((ret = EVP_PKEY_new()) == NULL)
366 		goto err;
367 	if ((cmctx = CMAC_CTX_new()) == NULL)
368 		goto err;
369 
370 	if (!pkey_set_type(ret, EVP_PKEY_CMAC, NULL, -1))
371 		goto err;
372 
373 	if (!CMAC_Init(cmctx, priv, len, cipher, NULL)) {
374 		EVPerror(EVP_R_KEY_SETUP_FAILED);
375 		goto err;
376 	}
377 
378 	ret->pkey.ptr = cmctx;
379 
380 	return ret;
381 
382  err:
383 	EVP_PKEY_free(ret);
384 	CMAC_CTX_free(cmctx);
385 	return NULL;
386 }
387 
388 int
389 EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
390 {
391 	return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
392 }
393 
394 int
395 EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
396 {
397 	if (!EVP_PKEY_set_type(pkey, type))
398 		return 0;
399 	pkey->pkey.ptr = key;
400 	return (key != NULL);
401 }
402 
403 void *
404 EVP_PKEY_get0(const EVP_PKEY *pkey)
405 {
406 	return pkey->pkey.ptr;
407 }
408 
409 const unsigned char *
410 EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
411 {
412 	ASN1_OCTET_STRING *os;
413 
414 	if (pkey->type != EVP_PKEY_HMAC) {
415 		EVPerror(EVP_R_EXPECTING_AN_HMAC_KEY);
416 		return NULL;
417 	}
418 
419 	os = EVP_PKEY_get0(pkey);
420 	*len = os->length;
421 
422 	return os->data;
423 }
424 
425 #ifndef OPENSSL_NO_RSA
426 RSA *
427 EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
428 {
429 	if (pkey->type == EVP_PKEY_RSA || pkey->type == EVP_PKEY_RSA_PSS)
430 		return pkey->pkey.rsa;
431 
432 	EVPerror(EVP_R_EXPECTING_AN_RSA_KEY);
433 	return NULL;
434 }
435 
436 RSA *
437 EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
438 {
439 	RSA *rsa;
440 
441 	if ((rsa = EVP_PKEY_get0_RSA(pkey)) == NULL)
442 		return NULL;
443 
444 	RSA_up_ref(rsa);
445 
446 	return rsa;
447 }
448 
449 int
450 EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
451 {
452 	int ret = EVP_PKEY_assign_RSA(pkey, key);
453 	if (ret != 0)
454 		RSA_up_ref(key);
455 	return ret;
456 }
457 #endif
458 
459 #ifndef OPENSSL_NO_DSA
460 DSA *
461 EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
462 {
463 	if (pkey->type != EVP_PKEY_DSA) {
464 		EVPerror(EVP_R_EXPECTING_A_DSA_KEY);
465 		return NULL;
466 	}
467 	return pkey->pkey.dsa;
468 }
469 
470 DSA *
471 EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
472 {
473 	DSA *dsa;
474 
475 	if ((dsa = EVP_PKEY_get0_DSA(pkey)) == NULL)
476 		return NULL;
477 
478 	DSA_up_ref(dsa);
479 
480 	return dsa;
481 }
482 
483 int
484 EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
485 {
486 	int ret = EVP_PKEY_assign_DSA(pkey, key);
487 	if (ret != 0)
488 		DSA_up_ref(key);
489 	return ret;
490 }
491 #endif
492 
493 #ifndef OPENSSL_NO_EC
494 EC_KEY *
495 EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
496 {
497 	if (pkey->type != EVP_PKEY_EC) {
498 		EVPerror(EVP_R_EXPECTING_A_EC_KEY);
499 		return NULL;
500 	}
501 	return pkey->pkey.ec;
502 }
503 
504 EC_KEY *
505 EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
506 {
507 	EC_KEY *key;
508 
509 	if ((key = EVP_PKEY_get0_EC_KEY(pkey)) == NULL)
510 		return NULL;
511 
512 	EC_KEY_up_ref(key);
513 
514 	return key;
515 }
516 
517 int
518 EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
519 {
520 	int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
521 	if (ret != 0)
522 		EC_KEY_up_ref(key);
523 	return ret;
524 }
525 #endif
526 
527 
528 #ifndef OPENSSL_NO_DH
529 DH *
530 EVP_PKEY_get0_DH(EVP_PKEY *pkey)
531 {
532 	if (pkey->type != EVP_PKEY_DH) {
533 		EVPerror(EVP_R_EXPECTING_A_DH_KEY);
534 		return NULL;
535 	}
536 	return pkey->pkey.dh;
537 }
538 
539 DH *
540 EVP_PKEY_get1_DH(EVP_PKEY *pkey)
541 {
542 	DH *dh;
543 
544 	if ((dh = EVP_PKEY_get0_DH(pkey)) == NULL)
545 		return NULL;
546 
547 	DH_up_ref(dh);
548 
549 	return dh;
550 }
551 
552 int
553 EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
554 {
555 	int ret = EVP_PKEY_assign_DH(pkey, key);
556 	if (ret != 0)
557 		DH_up_ref(key);
558 	return ret;
559 }
560 #endif
561 
562 int
563 EVP_PKEY_type(int type)
564 {
565 	const EVP_PKEY_ASN1_METHOD *ameth;
566 
567 	if ((ameth = EVP_PKEY_asn1_find(NULL, type)) != NULL)
568 		return ameth->pkey_id;
569 
570 	return NID_undef;
571 }
572 
573 int
574 EVP_PKEY_id(const EVP_PKEY *pkey)
575 {
576 	return pkey->type;
577 }
578 
579 int
580 EVP_PKEY_base_id(const EVP_PKEY *pkey)
581 {
582 	return EVP_PKEY_type(pkey->type);
583 }
584 
585 void
586 EVP_PKEY_free(EVP_PKEY *x)
587 {
588 	int i;
589 
590 	if (x == NULL)
591 		return;
592 
593 	i = CRYPTO_add(&x->references, -1, CRYPTO_LOCK_EVP_PKEY);
594 	if (i > 0)
595 		return;
596 
597 	evp_pkey_free_pkey_ptr(x);
598 	if (x->attributes)
599 		sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
600 	free(x);
601 }
602 
603 static int
604 unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent, const char *kstr)
605 {
606 	if (!BIO_indent(out, indent, 128))
607 		return 0;
608 	BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
609 	    kstr, OBJ_nid2ln(pkey->type));
610 	return 1;
611 }
612 
613 int
614 EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey, int indent,
615     ASN1_PCTX *pctx)
616 {
617 	if (pkey->ameth && pkey->ameth->pub_print)
618 		return pkey->ameth->pub_print(out, pkey, indent, pctx);
619 
620 	return unsup_alg(out, pkey, indent, "Public Key");
621 }
622 
623 int
624 EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey, int indent,
625     ASN1_PCTX *pctx)
626 {
627 	if (pkey->ameth && pkey->ameth->priv_print)
628 		return pkey->ameth->priv_print(out, pkey, indent, pctx);
629 
630 	return unsup_alg(out, pkey, indent, "Private Key");
631 }
632 
633 int
634 EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey, int indent,
635     ASN1_PCTX *pctx)
636 {
637 	if (pkey->ameth && pkey->ameth->param_print)
638 		return pkey->ameth->param_print(out, pkey, indent, pctx);
639 	return unsup_alg(out, pkey, indent, "Parameters");
640 }
641 
642 int
643 EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
644 {
645 	if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
646 		return -2;
647 	return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,
648 	    0, pnid);
649 }
650