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