2 * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #include "internal/cryptlib.h"
12 #include "internal/refcount.h"
13 #include <openssl/bn.h>
14 #include <openssl/err.h>
15 #include <openssl/objects.h>
16 #include <openssl/evp.h>
17 #include <openssl/x509.h>
18 #include <openssl/rsa.h>
19 #include <openssl/dsa.h>
20 #include <openssl/dh.h>
21 #include <openssl/cmac.h>
22 #include <openssl/engine.h>
24 #include "internal/asn1_int.h"
25 #include "internal/evp_int.h"
27 static void EVP_PKEY_free_it(EVP_PKEY *x);
29 int EVP_PKEY_bits(const EVP_PKEY *pkey)
31 if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
32 return pkey->ameth->pkey_bits(pkey);
36 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
40 if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
42 return pkey->ameth->pkey_security_bits(pkey);
45 int EVP_PKEY_size(const EVP_PKEY *pkey)
47 if (pkey && pkey->ameth && pkey->ameth->pkey_size)
48 return pkey->ameth->pkey_size(pkey);
52 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
54 #ifndef OPENSSL_NO_DSA
55 if (pkey->type == EVP_PKEY_DSA) {
56 int ret = pkey->save_parameters;
59 pkey->save_parameters = mode;
64 if (pkey->type == EVP_PKEY_EC) {
65 int ret = pkey->save_parameters;
68 pkey->save_parameters = mode;
75 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
77 if (to->type == EVP_PKEY_NONE) {
78 if (EVP_PKEY_set_type(to, from->type) == 0)
80 } else if (to->type != from->type) {
81 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
85 if (EVP_PKEY_missing_parameters(from)) {
86 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
90 if (!EVP_PKEY_missing_parameters(to)) {
91 if (EVP_PKEY_cmp_parameters(to, from) == 1)
93 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
97 if (from->ameth && from->ameth->param_copy)
98 return from->ameth->param_copy(to, from);
103 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
105 if (pkey->ameth && pkey->ameth->param_missing)
106 return pkey->ameth->param_missing(pkey);
110 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
112 if (a->type != b->type)
114 if (a->ameth && a->ameth->param_cmp)
115 return a->ameth->param_cmp(a, b);
119 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
121 if (a->type != b->type)
126 /* Compare parameters if the algorithm has them */
127 if (a->ameth->param_cmp) {
128 ret = a->ameth->param_cmp(a, b);
133 if (a->ameth->pub_cmp)
134 return a->ameth->pub_cmp(a, b);
140 EVP_PKEY *EVP_PKEY_new(void)
142 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
145 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
148 ret->type = EVP_PKEY_NONE;
149 ret->save_type = EVP_PKEY_NONE;
151 ret->save_parameters = 1;
152 ret->lock = CRYPTO_THREAD_lock_new();
153 if (ret->lock == NULL) {
154 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
161 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
165 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
168 REF_PRINT_COUNT("EVP_PKEY", pkey);
169 REF_ASSERT_ISNT(i < 2);
170 return ((i > 1) ? 1 : 0);
174 * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
175 * is NULL just return 1 or 0 if the algorithm exists.
178 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
181 const EVP_PKEY_ASN1_METHOD *ameth;
182 ENGINE **eptr = (e == NULL) ? &e : NULL;
186 EVP_PKEY_free_it(pkey);
188 * If key type matches and a method exists then this lookup has
189 * succeeded once so just indicate success.
191 if ((type == pkey->save_type) && pkey->ameth)
193 #ifndef OPENSSL_NO_ENGINE
194 /* If we have ENGINEs release them */
195 ENGINE_finish(pkey->engine);
197 ENGINE_finish(pkey->pmeth_engine);
198 pkey->pmeth_engine = NULL;
202 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
204 ameth = EVP_PKEY_asn1_find(eptr, type);
205 #ifndef OPENSSL_NO_ENGINE
206 if (pkey == NULL && eptr != NULL)
210 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
217 pkey->type = pkey->ameth->pkey_id;
218 pkey->save_type = type;
223 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
224 const unsigned char *priv,
227 EVP_PKEY *ret = EVP_PKEY_new();
230 || !pkey_set_type(ret, e, type, NULL, -1)) {
231 /* EVPerr already called */
235 if (ret->ameth->set_priv_key == NULL) {
236 EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PRIVATE_KEY,
237 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
241 if (!ret->ameth->set_priv_key(ret, priv, len)) {
242 EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PRIVATE_KEY, EVP_R_KEY_SETUP_FAILED);
253 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
254 const unsigned char *pub,
257 EVP_PKEY *ret = EVP_PKEY_new();
260 || !pkey_set_type(ret, e, type, NULL, -1)) {
261 /* EVPerr already called */
265 if (ret->ameth->set_pub_key == NULL) {
266 EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PUBLIC_KEY,
267 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
271 if (!ret->ameth->set_pub_key(ret, pub, len)) {
272 EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PUBLIC_KEY, EVP_R_KEY_SETUP_FAILED);
283 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
286 if (pkey->ameth->get_priv_key == NULL) {
287 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PRIVATE_KEY,
288 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
292 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
293 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PRIVATE_KEY, EVP_R_GET_RAW_KEY_FAILED);
300 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
303 if (pkey->ameth->get_pub_key == NULL) {
304 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
305 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
309 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
310 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
317 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
318 size_t len, const EVP_CIPHER *cipher)
320 #ifndef OPENSSL_NO_CMAC
321 EVP_PKEY *ret = EVP_PKEY_new();
322 CMAC_CTX *cmctx = CMAC_CTX_new();
326 || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1)) {
327 /* EVPerr already called */
331 if (!CMAC_Init(cmctx, priv, len, cipher, e)) {
332 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
336 ret->pkey.ptr = cmctx;
341 CMAC_CTX_free(cmctx);
344 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
345 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
350 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
352 return pkey_set_type(pkey, NULL, type, NULL, -1);
355 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
357 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len);
360 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
362 if (pkey->type == type) {
363 return 1; /* it already is that type */
367 * The application is requesting to alias this to a different pkey type,
368 * but not one that resolves to the base type.
370 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
371 EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
379 #ifndef OPENSSL_NO_ENGINE
380 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
383 if (!ENGINE_init(e)) {
384 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
387 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
389 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
393 ENGINE_finish(pkey->pmeth_engine);
394 pkey->pmeth_engine = e;
398 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
403 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
405 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
407 pkey->pkey.ptr = key;
408 return (key != NULL);
411 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
413 return pkey->pkey.ptr;
416 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
418 ASN1_OCTET_STRING *os = NULL;
419 if (pkey->type != EVP_PKEY_HMAC) {
420 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
423 os = EVP_PKEY_get0(pkey);
428 #ifndef OPENSSL_NO_POLY1305
429 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
431 ASN1_OCTET_STRING *os = NULL;
432 if (pkey->type != EVP_PKEY_POLY1305) {
433 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
436 os = EVP_PKEY_get0(pkey);
442 #ifndef OPENSSL_NO_SIPHASH
443 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
445 ASN1_OCTET_STRING *os = NULL;
447 if (pkey->type != EVP_PKEY_SIPHASH) {
448 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
451 os = EVP_PKEY_get0(pkey);
457 #ifndef OPENSSL_NO_RSA
458 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
460 int ret = EVP_PKEY_assign_RSA(pkey, key);
466 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
468 if (pkey->type != EVP_PKEY_RSA) {
469 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
472 return pkey->pkey.rsa;
475 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
477 RSA *ret = EVP_PKEY_get0_RSA(pkey);
484 #ifndef OPENSSL_NO_DSA
485 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
487 int ret = EVP_PKEY_assign_DSA(pkey, key);
493 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
495 if (pkey->type != EVP_PKEY_DSA) {
496 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
499 return pkey->pkey.dsa;
502 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
504 DSA *ret = EVP_PKEY_get0_DSA(pkey);
511 #ifndef OPENSSL_NO_EC
513 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
515 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
521 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
523 if (pkey->type != EVP_PKEY_EC) {
524 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
527 return pkey->pkey.ec;
530 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
532 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
539 #ifndef OPENSSL_NO_DH
541 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
543 int ret = EVP_PKEY_assign_DH(pkey, key);
549 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
551 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
552 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
555 return pkey->pkey.dh;
558 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
560 DH *ret = EVP_PKEY_get0_DH(pkey);
567 int EVP_PKEY_type(int type)
570 const EVP_PKEY_ASN1_METHOD *ameth;
572 ameth = EVP_PKEY_asn1_find(&e, type);
574 ret = ameth->pkey_id;
577 #ifndef OPENSSL_NO_ENGINE
583 int EVP_PKEY_id(const EVP_PKEY *pkey)
588 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
590 return EVP_PKEY_type(pkey->type);
593 void EVP_PKEY_free(EVP_PKEY *x)
600 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
601 REF_PRINT_COUNT("EVP_PKEY", x);
604 REF_ASSERT_ISNT(i < 0);
606 CRYPTO_THREAD_lock_free(x->lock);
607 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
611 static void EVP_PKEY_free_it(EVP_PKEY *x)
613 /* internal function; x is never NULL */
614 if (x->ameth && x->ameth->pkey_free) {
615 x->ameth->pkey_free(x);
618 #ifndef OPENSSL_NO_ENGINE
619 ENGINE_finish(x->engine);
621 ENGINE_finish(x->pmeth_engine);
622 x->pmeth_engine = NULL;
626 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
629 BIO_indent(out, indent, 128);
630 BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
631 kstr, OBJ_nid2ln(pkey->type));
635 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
636 int indent, ASN1_PCTX *pctx)
638 if (pkey->ameth && pkey->ameth->pub_print)
639 return pkey->ameth->pub_print(out, pkey, indent, pctx);
641 return unsup_alg(out, pkey, indent, "Public Key");
644 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
645 int indent, ASN1_PCTX *pctx)
647 if (pkey->ameth && pkey->ameth->priv_print)
648 return pkey->ameth->priv_print(out, pkey, indent, pctx);
650 return unsup_alg(out, pkey, indent, "Private Key");
653 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
654 int indent, ASN1_PCTX *pctx)
656 if (pkey->ameth && pkey->ameth->param_print)
657 return pkey->ameth->param_print(out, pkey, indent, pctx);
658 return unsup_alg(out, pkey, indent, "Parameters");
661 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
663 if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
665 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
668 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
670 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
673 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
674 const unsigned char *pt, size_t ptlen)
678 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
684 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
687 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);