2 * Copyright 1995-2017 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/engine.h>
23 #include "internal/asn1_int.h"
24 #include "internal/evp_int.h"
26 static void EVP_PKEY_free_it(EVP_PKEY *x);
28 int EVP_PKEY_bits(const EVP_PKEY *pkey)
30 if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
31 return pkey->ameth->pkey_bits(pkey);
35 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
39 if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
41 return pkey->ameth->pkey_security_bits(pkey);
44 int EVP_PKEY_size(EVP_PKEY *pkey)
46 if (pkey && pkey->ameth && pkey->ameth->pkey_size)
47 return pkey->ameth->pkey_size(pkey);
51 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
53 #ifndef OPENSSL_NO_DSA
54 if (pkey->type == EVP_PKEY_DSA) {
55 int ret = pkey->save_parameters;
58 pkey->save_parameters = mode;
63 if (pkey->type == EVP_PKEY_EC) {
64 int ret = pkey->save_parameters;
67 pkey->save_parameters = mode;
74 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
76 if (to->type == EVP_PKEY_NONE) {
77 if (EVP_PKEY_set_type(to, from->type) == 0)
79 } else if (to->type != from->type) {
80 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
84 if (EVP_PKEY_missing_parameters(from)) {
85 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
89 if (!EVP_PKEY_missing_parameters(to)) {
90 if (EVP_PKEY_cmp_parameters(to, from) == 1)
92 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
96 if (from->ameth && from->ameth->param_copy)
97 return from->ameth->param_copy(to, from);
102 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
104 if (pkey->ameth && pkey->ameth->param_missing)
105 return pkey->ameth->param_missing(pkey);
109 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
111 if (a->type != b->type)
113 if (a->ameth && a->ameth->param_cmp)
114 return a->ameth->param_cmp(a, b);
118 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
120 if (a->type != b->type)
125 /* Compare parameters if the algorithm has them */
126 if (a->ameth->param_cmp) {
127 ret = a->ameth->param_cmp(a, b);
132 if (a->ameth->pub_cmp)
133 return a->ameth->pub_cmp(a, b);
139 EVP_PKEY *EVP_PKEY_new(void)
141 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
144 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
147 ret->type = EVP_PKEY_NONE;
148 ret->save_type = EVP_PKEY_NONE;
150 ret->save_parameters = 1;
151 ret->lock = CRYPTO_THREAD_lock_new();
152 if (ret->lock == NULL) {
153 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
160 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
164 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
167 REF_PRINT_COUNT("EVP_PKEY", pkey);
168 REF_ASSERT_ISNT(i < 2);
169 return ((i > 1) ? 1 : 0);
173 * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
174 * is NULL just return 1 or 0 if the algorithm exists.
177 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
180 const EVP_PKEY_ASN1_METHOD *ameth;
181 ENGINE **eptr = (e == NULL) ? &e : NULL;
185 EVP_PKEY_free_it(pkey);
187 * If key type matches and a method exists then this lookup has
188 * succeeded once so just indicate success.
190 if ((type == pkey->save_type) && pkey->ameth)
192 #ifndef OPENSSL_NO_ENGINE
193 /* If we have ENGINEs release them */
194 ENGINE_finish(pkey->engine);
196 ENGINE_finish(pkey->pmeth_engine);
197 pkey->pmeth_engine = NULL;
201 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
203 ameth = EVP_PKEY_asn1_find(eptr, type);
204 #ifndef OPENSSL_NO_ENGINE
205 if (pkey == NULL && eptr != NULL)
209 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
216 pkey->type = pkey->ameth->pkey_id;
217 pkey->save_type = type;
222 EVP_PKEY *EVP_PKEY_new_private_key(int type, ENGINE *e, unsigned char *priv,
225 EVP_PKEY *ret = EVP_PKEY_new();
228 || !pkey_set_type(ret, e, type, NULL, -1)) {
229 /* EVPerr already called */
233 if (ret->ameth->set_priv_key == NULL) {
234 EVPerr(EVP_F_EVP_PKEY_NEW_PRIVATE_KEY,
235 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
239 if (!ret->ameth->set_priv_key(ret, priv, len)) {
240 /* We assume the method function calls EVPerr */
251 EVP_PKEY *EVP_PKEY_new_public_key(int type, ENGINE *e, unsigned char *pub,
254 EVP_PKEY *ret = EVP_PKEY_new();
257 || !pkey_set_type(ret, e, type, NULL, -1)) {
258 /* EVPerr already called */
262 if (ret->ameth->set_pub_key == NULL) {
263 EVPerr(EVP_F_EVP_PKEY_NEW_PUBLIC_KEY,
264 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
268 if (!ret->ameth->set_pub_key(ret, pub, len)) {
269 /* We assume the method function calls EVPerr */
281 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
283 return pkey_set_type(pkey, NULL, type, NULL, -1);
286 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
288 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len);
290 #ifndef OPENSSL_NO_ENGINE
291 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
294 if (!ENGINE_init(e)) {
295 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
298 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
300 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
304 ENGINE_finish(pkey->pmeth_engine);
305 pkey->pmeth_engine = e;
309 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
311 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
313 pkey->pkey.ptr = key;
314 return (key != NULL);
317 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
319 return pkey->pkey.ptr;
322 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
324 ASN1_OCTET_STRING *os = NULL;
325 if (pkey->type != EVP_PKEY_HMAC) {
326 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
329 os = EVP_PKEY_get0(pkey);
334 #ifndef OPENSSL_NO_POLY1305
335 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
337 ASN1_OCTET_STRING *os = NULL;
338 if (pkey->type != EVP_PKEY_POLY1305) {
339 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
342 os = EVP_PKEY_get0(pkey);
348 #ifndef OPENSSL_NO_SIPHASH
349 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
351 ASN1_OCTET_STRING *os = NULL;
353 if (pkey->type != EVP_PKEY_SIPHASH) {
354 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
357 os = EVP_PKEY_get0(pkey);
363 #ifndef OPENSSL_NO_RSA
364 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
366 int ret = EVP_PKEY_assign_RSA(pkey, key);
372 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
374 if (pkey->type != EVP_PKEY_RSA) {
375 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
378 return pkey->pkey.rsa;
381 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
383 RSA *ret = EVP_PKEY_get0_RSA(pkey);
390 #ifndef OPENSSL_NO_DSA
391 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
393 int ret = EVP_PKEY_assign_DSA(pkey, key);
399 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
401 if (pkey->type != EVP_PKEY_DSA) {
402 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
405 return pkey->pkey.dsa;
408 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
410 DSA *ret = EVP_PKEY_get0_DSA(pkey);
417 #ifndef OPENSSL_NO_EC
419 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
421 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
427 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
429 if (pkey->type != EVP_PKEY_EC) {
430 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
433 return pkey->pkey.ec;
436 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
438 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
445 #ifndef OPENSSL_NO_DH
447 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
449 int ret = EVP_PKEY_assign_DH(pkey, key);
455 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
457 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
458 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
461 return pkey->pkey.dh;
464 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
466 DH *ret = EVP_PKEY_get0_DH(pkey);
473 int EVP_PKEY_type(int type)
476 const EVP_PKEY_ASN1_METHOD *ameth;
478 ameth = EVP_PKEY_asn1_find(&e, type);
480 ret = ameth->pkey_id;
483 #ifndef OPENSSL_NO_ENGINE
489 int EVP_PKEY_id(const EVP_PKEY *pkey)
494 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
496 return EVP_PKEY_type(pkey->type);
499 void EVP_PKEY_free(EVP_PKEY *x)
506 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
507 REF_PRINT_COUNT("EVP_PKEY", x);
510 REF_ASSERT_ISNT(i < 0);
512 CRYPTO_THREAD_lock_free(x->lock);
513 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
517 static void EVP_PKEY_free_it(EVP_PKEY *x)
519 /* internal function; x is never NULL */
520 if (x->ameth && x->ameth->pkey_free) {
521 x->ameth->pkey_free(x);
524 #ifndef OPENSSL_NO_ENGINE
525 ENGINE_finish(x->engine);
527 ENGINE_finish(x->pmeth_engine);
528 x->pmeth_engine = NULL;
532 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
535 BIO_indent(out, indent, 128);
536 BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
537 kstr, OBJ_nid2ln(pkey->type));
541 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
542 int indent, ASN1_PCTX *pctx)
544 if (pkey->ameth && pkey->ameth->pub_print)
545 return pkey->ameth->pub_print(out, pkey, indent, pctx);
547 return unsup_alg(out, pkey, indent, "Public Key");
550 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
551 int indent, ASN1_PCTX *pctx)
553 if (pkey->ameth && pkey->ameth->priv_print)
554 return pkey->ameth->priv_print(out, pkey, indent, pctx);
556 return unsup_alg(out, pkey, indent, "Private Key");
559 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
560 int indent, ASN1_PCTX *pctx)
562 if (pkey->ameth && pkey->ameth->param_print)
563 return pkey->ameth->param_print(out, pkey, indent, pctx);
564 return unsup_alg(out, pkey, indent, "Parameters");
567 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
569 if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
571 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
574 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
576 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
579 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
580 const unsigned char *pt, size_t ptlen)
584 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
590 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
593 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);