2 * Copyright 1995-2016 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 <openssl/bn.h>
13 #include <openssl/err.h>
14 #include <openssl/objects.h>
15 #include <openssl/evp.h>
16 #include <openssl/x509.h>
17 #include <openssl/rsa.h>
18 #include <openssl/dsa.h>
19 #include <openssl/dh.h>
20 #include <openssl/engine.h>
22 #include "internal/asn1_int.h"
23 #include "internal/evp_int.h"
25 static void EVP_PKEY_free_it(EVP_PKEY *x);
27 int EVP_PKEY_bits(const EVP_PKEY *pkey)
29 if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
30 return pkey->ameth->pkey_bits(pkey);
34 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
38 if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
40 return pkey->ameth->pkey_security_bits(pkey);
43 int EVP_PKEY_size(EVP_PKEY *pkey)
45 if (pkey && pkey->ameth && pkey->ameth->pkey_size)
46 return pkey->ameth->pkey_size(pkey);
50 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
52 #ifndef OPENSSL_NO_DSA
53 if (pkey->type == EVP_PKEY_DSA) {
54 int ret = pkey->save_parameters;
57 pkey->save_parameters = mode;
62 if (pkey->type == EVP_PKEY_EC) {
63 int ret = pkey->save_parameters;
66 pkey->save_parameters = mode;
73 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
75 if (to->type == EVP_PKEY_NONE) {
76 if (EVP_PKEY_set_type(to, from->type) == 0)
78 } else if (to->type != from->type) {
79 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
83 if (EVP_PKEY_missing_parameters(from)) {
84 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
88 if (!EVP_PKEY_missing_parameters(to)) {
89 if (EVP_PKEY_cmp_parameters(to, from) == 1)
91 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
95 if (from->ameth && from->ameth->param_copy)
96 return from->ameth->param_copy(to, from);
101 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
103 if (pkey->ameth && pkey->ameth->param_missing)
104 return pkey->ameth->param_missing(pkey);
108 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
110 if (a->type != b->type)
112 if (a->ameth && a->ameth->param_cmp)
113 return a->ameth->param_cmp(a, b);
117 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
119 if (a->type != b->type)
124 /* Compare parameters if the algorithm has them */
125 if (a->ameth->param_cmp) {
126 ret = a->ameth->param_cmp(a, b);
131 if (a->ameth->pub_cmp)
132 return a->ameth->pub_cmp(a, b);
138 EVP_PKEY *EVP_PKEY_new(void)
140 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
143 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
146 ret->type = EVP_PKEY_NONE;
147 ret->save_type = EVP_PKEY_NONE;
149 ret->save_parameters = 1;
150 ret->lock = CRYPTO_THREAD_lock_new();
151 if (ret->lock == NULL) {
152 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
159 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
163 if (CRYPTO_atomic_add(&pkey->references, 1, &i, pkey->lock) <= 0)
166 REF_PRINT_COUNT("EVP_PKEY", pkey);
167 REF_ASSERT_ISNT(i < 2);
168 return ((i > 1) ? 1 : 0);
172 * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
173 * is NULL just return 1 or 0 if the algorithm exists.
176 static int pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
178 const EVP_PKEY_ASN1_METHOD *ameth;
182 EVP_PKEY_free_it(pkey);
184 * If key type matches and a method exists then this lookup has
185 * succeeded once so just indicate success.
187 if ((type == pkey->save_type) && pkey->ameth)
189 #ifndef OPENSSL_NO_ENGINE
190 /* If we have ENGINEs release them */
191 ENGINE_finish(pkey->engine);
193 ENGINE_finish(pkey->pmeth_engine);
194 pkey->pmeth_engine = NULL;
198 ameth = EVP_PKEY_asn1_find_str(&e, str, len);
200 ameth = EVP_PKEY_asn1_find(&e, type);
201 #ifndef OPENSSL_NO_ENGINE
206 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
213 pkey->type = pkey->ameth->pkey_id;
214 pkey->save_type = type;
219 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
221 return pkey_set_type(pkey, type, NULL, -1);
224 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
226 return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
228 #ifndef OPENSSL_NO_ENGINE
229 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
232 if (!ENGINE_init(e)) {
233 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
236 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
238 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
242 ENGINE_finish(pkey->pmeth_engine);
243 pkey->pmeth_engine = e;
247 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
249 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
251 pkey->pkey.ptr = key;
252 return (key != NULL);
255 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
257 return pkey->pkey.ptr;
260 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
262 ASN1_OCTET_STRING *os = NULL;
263 if (pkey->type != EVP_PKEY_HMAC) {
264 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
267 os = EVP_PKEY_get0(pkey);
272 #ifndef OPENSSL_NO_RSA
273 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
275 int ret = EVP_PKEY_assign_RSA(pkey, key);
281 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
283 if (pkey->type != EVP_PKEY_RSA) {
284 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
287 return pkey->pkey.rsa;
290 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
292 RSA *ret = EVP_PKEY_get0_RSA(pkey);
299 #ifndef OPENSSL_NO_DSA
300 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
302 int ret = EVP_PKEY_assign_DSA(pkey, key);
308 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
310 if (pkey->type != EVP_PKEY_DSA) {
311 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
314 return pkey->pkey.dsa;
317 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
319 DSA *ret = EVP_PKEY_get0_DSA(pkey);
326 #ifndef OPENSSL_NO_EC
328 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
330 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
336 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
338 if (pkey->type != EVP_PKEY_EC) {
339 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
342 return pkey->pkey.ec;
345 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
347 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
354 #ifndef OPENSSL_NO_DH
356 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
358 int ret = EVP_PKEY_assign_DH(pkey, key);
364 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
366 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
367 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
370 return pkey->pkey.dh;
373 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
375 DH *ret = EVP_PKEY_get0_DH(pkey);
382 int EVP_PKEY_type(int type)
385 const EVP_PKEY_ASN1_METHOD *ameth;
387 ameth = EVP_PKEY_asn1_find(&e, type);
389 ret = ameth->pkey_id;
392 #ifndef OPENSSL_NO_ENGINE
398 int EVP_PKEY_id(const EVP_PKEY *pkey)
403 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
405 return EVP_PKEY_type(pkey->type);
408 void EVP_PKEY_free(EVP_PKEY *x)
415 CRYPTO_atomic_add(&x->references, -1, &i, x->lock);
416 REF_PRINT_COUNT("EVP_PKEY", x);
419 REF_ASSERT_ISNT(i < 0);
421 CRYPTO_THREAD_lock_free(x->lock);
422 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
426 static void EVP_PKEY_free_it(EVP_PKEY *x)
428 /* internal function; x is never NULL */
429 if (x->ameth && x->ameth->pkey_free) {
430 x->ameth->pkey_free(x);
433 #ifndef OPENSSL_NO_ENGINE
434 ENGINE_finish(x->engine);
436 ENGINE_finish(x->pmeth_engine);
437 x->pmeth_engine = NULL;
441 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
444 BIO_indent(out, indent, 128);
445 BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
446 kstr, OBJ_nid2ln(pkey->type));
450 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
451 int indent, ASN1_PCTX *pctx)
453 if (pkey->ameth && pkey->ameth->pub_print)
454 return pkey->ameth->pub_print(out, pkey, indent, pctx);
456 return unsup_alg(out, pkey, indent, "Public Key");
459 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
460 int indent, ASN1_PCTX *pctx)
462 if (pkey->ameth && pkey->ameth->priv_print)
463 return pkey->ameth->priv_print(out, pkey, indent, pctx);
465 return unsup_alg(out, pkey, indent, "Private Key");
468 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
469 int indent, ASN1_PCTX *pctx)
471 if (pkey->ameth && pkey->ameth->param_print)
472 return pkey->ameth->param_print(out, pkey, indent, pctx);
473 return unsup_alg(out, pkey, indent, "Parameters");
476 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
478 if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
480 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
483 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
485 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
488 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
489 const unsigned char *pt, size_t ptlen)
493 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
499 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
502 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);