xref: /openbsd/lib/libcrypto/evp/pmeth_lib.c (revision 76d0caae) 
1 /* $OpenBSD: pmeth_lib.c,v 1.18 2021/12/03 14:19:57 tb Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 2006.
4  */
5 /* ====================================================================
6  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58 
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 
63 #include <openssl/opensslconf.h>
64 
65 #include <openssl/err.h>
66 #include <openssl/evp.h>
67 #include <openssl/objects.h>
68 
69 #ifndef OPENSSL_NO_ENGINE
70 #include <openssl/engine.h>
71 #endif
72 
73 #include "asn1_locl.h"
74 #include "evp_locl.h"
75 
76 typedef int sk_cmp_fn_type(const char * const *a, const char * const *b);
77 
78 DECLARE_STACK_OF(EVP_PKEY_METHOD)
79 STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
80 
81 extern const EVP_PKEY_METHOD rsa_pkey_meth, rsa_pss_pkey_meth;
82 extern const EVP_PKEY_METHOD dh_pkey_meth, dsa_pkey_meth;
83 extern const EVP_PKEY_METHOD ec_pkey_meth, hmac_pkey_meth, cmac_pkey_meth;
84 extern const EVP_PKEY_METHOD gostimit_pkey_meth, gostr01_pkey_meth;
85 
86 static const EVP_PKEY_METHOD *standard_methods[] = {
87 #ifndef OPENSSL_NO_RSA
88 	&rsa_pkey_meth,
89 #endif
90 #ifndef OPENSSL_NO_DH
91 	&dh_pkey_meth,
92 #endif
93 #ifndef OPENSSL_NO_DSA
94 	&dsa_pkey_meth,
95 #endif
96 #ifndef OPENSSL_NO_EC
97 	&ec_pkey_meth,
98 #endif
99 #ifndef OPENSSL_NO_GOST
100 	&gostr01_pkey_meth,
101 	&gostimit_pkey_meth,
102 #endif
103 	&hmac_pkey_meth,
104 	&cmac_pkey_meth,
105 #ifndef OPENSSL_NO_RSA
106 	&rsa_pss_pkey_meth,
107 #endif
108 };
109 
110 static int pmeth_cmp_BSEARCH_CMP_FN(const void *, const void *);
111 static int pmeth_cmp(const EVP_PKEY_METHOD * const *, const EVP_PKEY_METHOD * const *);
112 static const EVP_PKEY_METHOD * *OBJ_bsearch_pmeth(const EVP_PKEY_METHOD * *key, const EVP_PKEY_METHOD * const *base, int num);
113 
114 static int
115 pmeth_cmp(const EVP_PKEY_METHOD * const *a, const EVP_PKEY_METHOD * const *b)
116 {
117 	return ((*a)->pkey_id - (*b)->pkey_id);
118 }
119 
120 
121 static int
122 pmeth_cmp_BSEARCH_CMP_FN(const void *a_, const void *b_)
123 {
124 	const EVP_PKEY_METHOD * const *a = a_;
125 	const EVP_PKEY_METHOD * const *b = b_;
126 	return pmeth_cmp(a, b);
127 }
128 
129 static const EVP_PKEY_METHOD * *
130 OBJ_bsearch_pmeth(const EVP_PKEY_METHOD * *key, const EVP_PKEY_METHOD * const *base, int num)
131 {
132 	return (const EVP_PKEY_METHOD * *)OBJ_bsearch_(key, base, num, sizeof(const EVP_PKEY_METHOD *),
133 	    pmeth_cmp_BSEARCH_CMP_FN);
134 }
135 
136 const EVP_PKEY_METHOD *
137 EVP_PKEY_meth_find(int type)
138 {
139 	EVP_PKEY_METHOD tmp;
140 	const EVP_PKEY_METHOD *t = &tmp, **ret;
141 
142 	tmp.pkey_id = type;
143 	if (app_pkey_methods) {
144 		int idx;
145 		idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
146 		if (idx >= 0)
147 			return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
148 	}
149 	ret = OBJ_bsearch_pmeth(&t, standard_methods,
150 	    sizeof(standard_methods)/sizeof(EVP_PKEY_METHOD *));
151 	if (!ret || !*ret)
152 		return NULL;
153 	return *ret;
154 }
155 
156 static EVP_PKEY_CTX *
157 int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
158 {
159 	EVP_PKEY_CTX *ret;
160 	const EVP_PKEY_METHOD *pmeth;
161 
162 	if (id == -1) {
163 		if (!pkey || !pkey->ameth)
164 			return NULL;
165 		id = pkey->ameth->pkey_id;
166 	}
167 #ifndef OPENSSL_NO_ENGINE
168 	if (pkey && pkey->engine)
169 		e = pkey->engine;
170 	/* Try to find an ENGINE which implements this method */
171 	if (e) {
172 		if (!ENGINE_init(e)) {
173 			EVPerror(ERR_R_ENGINE_LIB);
174 			return NULL;
175 		}
176 	} else
177 		e = ENGINE_get_pkey_meth_engine(id);
178 
179 	/* If an ENGINE handled this method look it up. Othewise
180 	 * use internal tables.
181 	 */
182 
183 	if (e)
184 		pmeth = ENGINE_get_pkey_meth(e, id);
185 	else
186 #endif
187 		pmeth = EVP_PKEY_meth_find(id);
188 
189 	if (pmeth == NULL) {
190 		EVPerror(EVP_R_UNSUPPORTED_ALGORITHM);
191 		return NULL;
192 	}
193 
194 	ret = malloc(sizeof(EVP_PKEY_CTX));
195 	if (ret == NULL) {
196 #ifndef OPENSSL_NO_ENGINE
197 		ENGINE_finish(e);
198 #endif
199 		EVPerror(ERR_R_MALLOC_FAILURE);
200 		return NULL;
201 	}
202 	ret->engine = e;
203 	ret->pmeth = pmeth;
204 	ret->operation = EVP_PKEY_OP_UNDEFINED;
205 	ret->pkey = pkey;
206 	ret->peerkey = NULL;
207 	ret->pkey_gencb = 0;
208 	if (pkey)
209 		CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
210 	ret->data = NULL;
211 
212 	if (pmeth->init) {
213 		if (pmeth->init(ret) <= 0) {
214 			EVP_PKEY_CTX_free(ret);
215 			return NULL;
216 		}
217 	}
218 
219 	return ret;
220 }
221 
222 EVP_PKEY_METHOD*
223 EVP_PKEY_meth_new(int id, int flags)
224 {
225 	EVP_PKEY_METHOD *pmeth;
226 
227 	if ((pmeth = calloc(1, sizeof(EVP_PKEY_METHOD))) == NULL)
228 		return NULL;
229 
230 	pmeth->pkey_id = id;
231 	pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
232 
233 	return pmeth;
234 }
235 
236 void
237 EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags, const EVP_PKEY_METHOD *meth)
238 {
239 	if (ppkey_id)
240 		*ppkey_id = meth->pkey_id;
241 	if (pflags)
242 		*pflags = meth->flags;
243 }
244 
245 void
246 EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
247 {
248 	EVP_PKEY_METHOD preserve;
249 
250 	preserve.pkey_id = dst->pkey_id;
251 	preserve.flags = dst->flags;
252 
253 	*dst = *src;
254 
255 	dst->pkey_id = preserve.pkey_id;
256 	dst->flags = preserve.flags;
257 }
258 
259 void
260 EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
261 {
262 	if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
263 		free(pmeth);
264 }
265 
266 EVP_PKEY_CTX *
267 EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
268 {
269 	return int_ctx_new(pkey, e, -1);
270 }
271 
272 EVP_PKEY_CTX *
273 EVP_PKEY_CTX_new_id(int id, ENGINE *e)
274 {
275 	return int_ctx_new(NULL, e, id);
276 }
277 
278 EVP_PKEY_CTX *
279 EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
280 {
281 	EVP_PKEY_CTX *rctx;
282 
283 	if (!pctx->pmeth || !pctx->pmeth->copy)
284 		return NULL;
285 #ifndef OPENSSL_NO_ENGINE
286 	/* Make sure it's safe to copy a pkey context using an ENGINE */
287 	if (pctx->engine && !ENGINE_init(pctx->engine)) {
288 		EVPerror(ERR_R_ENGINE_LIB);
289 		return 0;
290 	}
291 #endif
292 	rctx = malloc(sizeof(EVP_PKEY_CTX));
293 	if (!rctx)
294 		return NULL;
295 
296 	rctx->pmeth = pctx->pmeth;
297 #ifndef OPENSSL_NO_ENGINE
298 	rctx->engine = pctx->engine;
299 #endif
300 
301 	if (pctx->pkey)
302 		CRYPTO_add(&pctx->pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
303 
304 	rctx->pkey = pctx->pkey;
305 
306 	if (pctx->peerkey)
307 		CRYPTO_add(&pctx->peerkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
308 
309 	rctx->peerkey = pctx->peerkey;
310 
311 	rctx->data = NULL;
312 	rctx->app_data = NULL;
313 	rctx->operation = pctx->operation;
314 
315 	if (pctx->pmeth->copy(rctx, pctx) > 0)
316 		return rctx;
317 
318 	EVP_PKEY_CTX_free(rctx);
319 	return NULL;
320 }
321 
322 int
323 EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
324 {
325 	if (app_pkey_methods == NULL) {
326 		app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
327 		if (!app_pkey_methods)
328 			return 0;
329 	}
330 	if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
331 		return 0;
332 	sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
333 	return 1;
334 }
335 
336 void
337 EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
338 {
339 	if (ctx == NULL)
340 		return;
341 	if (ctx->pmeth && ctx->pmeth->cleanup)
342 		ctx->pmeth->cleanup(ctx);
343 	EVP_PKEY_free(ctx->pkey);
344 	EVP_PKEY_free(ctx->peerkey);
345 #ifndef OPENSSL_NO_ENGINE
346 	ENGINE_finish(ctx->engine);
347 #endif
348 	free(ctx);
349 }
350 
351 int
352 EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype, int cmd,
353     int p1, void *p2)
354 {
355 	int ret;
356 
357 	if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl) {
358 		EVPerror(EVP_R_COMMAND_NOT_SUPPORTED);
359 		return -2;
360 	}
361 	if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
362 		return -1;
363 
364 	if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
365 		EVPerror(EVP_R_NO_OPERATION_SET);
366 		return -1;
367 	}
368 
369 	if ((optype != -1) && !(ctx->operation & optype)) {
370 		EVPerror(EVP_R_INVALID_OPERATION);
371 		return -1;
372 	}
373 
374 	ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
375 
376 	if (ret == -2)
377 		EVPerror(EVP_R_COMMAND_NOT_SUPPORTED);
378 
379 	return ret;
380 
381 }
382 
383 int
384 EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx, const char *name, const char *value)
385 {
386 	if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
387 		EVPerror(EVP_R_COMMAND_NOT_SUPPORTED);
388 		return -2;
389 	}
390 	if (!strcmp(name, "digest")) {
391 		return EVP_PKEY_CTX_md(ctx, EVP_PKEY_OP_TYPE_SIG,
392 		    EVP_PKEY_CTRL_MD, value);
393 	}
394 	return ctx->pmeth->ctrl_str(ctx, name, value);
395 }
396 
397 int
398 EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md_name)
399 {
400 	const EVP_MD *md;
401 
402 	if ((md = EVP_get_digestbyname(md_name)) == NULL) {
403 		EVPerror(EVP_R_INVALID_DIGEST);
404 		return 0;
405 	}
406 	return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)md);
407 }
408 
409 int
410 EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
411 {
412 	return ctx->operation;
413 }
414 
415 void
416 EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
417 {
418 	ctx->keygen_info = dat;
419 	ctx->keygen_info_count = datlen;
420 }
421 
422 void
423 EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
424 {
425 	ctx->data = data;
426 }
427 
428 void *
429 EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
430 {
431 	return ctx->data;
432 }
433 
434 EVP_PKEY *
435 EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
436 {
437 	return ctx->pkey;
438 }
439 
440 EVP_PKEY *
441 EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
442 {
443 	return ctx->peerkey;
444 }
445 
446 void
447 EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
448 {
449 	ctx->app_data = data;
450 }
451 
452 void *
453 EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
454 {
455 	return ctx->app_data;
456 }
457 
458 void
459 EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
460     int (*init)(EVP_PKEY_CTX *ctx))
461 {
462 	pmeth->init = init;
463 }
464 
465 void
466 EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
467     int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src))
468 {
469 	pmeth->copy = copy;
470 }
471 
472 void
473 EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
474     void (*cleanup)(EVP_PKEY_CTX *ctx))
475 {
476 	pmeth->cleanup = cleanup;
477 }
478 
479 void
480 EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
481     int (*paramgen_init)(EVP_PKEY_CTX *ctx),
482     int (*paramgen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
483 {
484 	pmeth->paramgen_init = paramgen_init;
485 	pmeth->paramgen = paramgen;
486 }
487 
488 void
489 EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
490     int (*keygen_init)(EVP_PKEY_CTX *ctx),
491     int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
492 {
493 	pmeth->keygen_init = keygen_init;
494 	pmeth->keygen = keygen;
495 }
496 
497 void
498 EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
499     int (*sign_init)(EVP_PKEY_CTX *ctx),
500     int (*sign)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
501     const unsigned char *tbs, size_t tbslen))
502 {
503 	pmeth->sign_init = sign_init;
504 	pmeth->sign = sign;
505 }
506 
507 void
508 EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
509     int (*verify_init)(EVP_PKEY_CTX *ctx),
510     int (*verify)(EVP_PKEY_CTX *ctx, const unsigned char *sig, size_t siglen,
511     const unsigned char *tbs, size_t tbslen))
512 {
513 	pmeth->verify_init = verify_init;
514 	pmeth->verify = verify;
515 }
516 
517 void
518 EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
519     int (*verify_recover_init)(EVP_PKEY_CTX *ctx),
520     int (*verify_recover)(EVP_PKEY_CTX *ctx,
521     unsigned char *sig, size_t *siglen,
522     const unsigned char *tbs, size_t tbslen))
523 {
524 	pmeth->verify_recover_init = verify_recover_init;
525 	pmeth->verify_recover = verify_recover;
526 }
527 
528 void
529 EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
530     int (*signctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
531     int (*signctx)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
532     EVP_MD_CTX *mctx))
533 {
534 	pmeth->signctx_init = signctx_init;
535 	pmeth->signctx = signctx;
536 }
537 
538 void
539 EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
540     int (*verifyctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
541     int (*verifyctx)(EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
542     EVP_MD_CTX *mctx))
543 {
544 	pmeth->verifyctx_init = verifyctx_init;
545 	pmeth->verifyctx = verifyctx;
546 }
547 
548 void
549 EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
550     int (*encrypt_init)(EVP_PKEY_CTX *ctx),
551     int (*encryptfn)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
552     const unsigned char *in, size_t inlen))
553 {
554 	pmeth->encrypt_init = encrypt_init;
555 	pmeth->encrypt = encryptfn;
556 }
557 
558 void
559 EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
560     int (*decrypt_init)(EVP_PKEY_CTX *ctx),
561     int (*decrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
562     const unsigned char *in, size_t inlen))
563 {
564 	pmeth->decrypt_init = decrypt_init;
565 	pmeth->decrypt = decrypt;
566 }
567 
568 void
569 EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
570     int (*derive_init)(EVP_PKEY_CTX *ctx),
571     int (*derive)(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen))
572 {
573 	pmeth->derive_init = derive_init;
574 	pmeth->derive = derive;
575 }
576 
577 void
578 EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
579     int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2),
580     int (*ctrl_str)(EVP_PKEY_CTX *ctx, const char *type, const char *value))
581 {
582 	pmeth->ctrl = ctrl;
583 	pmeth->ctrl_str = ctrl_str;
584 }
585