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, int type, const char *str, int len)
179 const EVP_PKEY_ASN1_METHOD *ameth;
183 EVP_PKEY_free_it(pkey);
185 * If key type matches and a method exists then this lookup has
186 * succeeded once so just indicate success.
188 if ((type == pkey->save_type) && pkey->ameth)
190 #ifndef OPENSSL_NO_ENGINE
191 /* If we have an ENGINE release it */
192 ENGINE_finish(pkey->engine);
197 ameth = EVP_PKEY_asn1_find_str(&e, str, len);
199 ameth = EVP_PKEY_asn1_find(&e, type);
200 #ifndef OPENSSL_NO_ENGINE
205 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
212 pkey->type = pkey->ameth->pkey_id;
213 pkey->save_type = type;
218 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
220 return pkey_set_type(pkey, type, NULL, -1);
223 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
225 return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
228 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
230 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
232 pkey->pkey.ptr = key;
233 return (key != NULL);
236 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
238 return pkey->pkey.ptr;
241 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
243 ASN1_OCTET_STRING *os = NULL;
244 if (pkey->type != EVP_PKEY_HMAC) {
245 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
248 os = EVP_PKEY_get0(pkey);
253 #ifndef OPENSSL_NO_POLY1305
254 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
256 ASN1_OCTET_STRING *os = NULL;
257 if (pkey->type != EVP_PKEY_POLY1305) {
258 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
261 os = EVP_PKEY_get0(pkey);
267 #ifndef OPENSSL_NO_SIPHASH
268 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
270 ASN1_OCTET_STRING *os = NULL;
272 if (pkey->type != EVP_PKEY_SIPHASH) {
273 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
276 os = EVP_PKEY_get0(pkey);
282 #ifndef OPENSSL_NO_RSA
283 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
285 int ret = EVP_PKEY_assign_RSA(pkey, key);
291 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
293 if (pkey->type != EVP_PKEY_RSA) {
294 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
297 return pkey->pkey.rsa;
300 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
302 RSA *ret = EVP_PKEY_get0_RSA(pkey);
309 #ifndef OPENSSL_NO_DSA
310 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
312 int ret = EVP_PKEY_assign_DSA(pkey, key);
318 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
320 if (pkey->type != EVP_PKEY_DSA) {
321 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
324 return pkey->pkey.dsa;
327 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
329 DSA *ret = EVP_PKEY_get0_DSA(pkey);
336 #ifndef OPENSSL_NO_EC
338 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
340 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
346 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
348 if (pkey->type != EVP_PKEY_EC) {
349 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
352 return pkey->pkey.ec;
355 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
357 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
364 #ifndef OPENSSL_NO_DH
366 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
368 int ret = EVP_PKEY_assign_DH(pkey, key);
374 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
376 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
377 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
380 return pkey->pkey.dh;
383 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
385 DH *ret = EVP_PKEY_get0_DH(pkey);
392 int EVP_PKEY_type(int type)
395 const EVP_PKEY_ASN1_METHOD *ameth;
397 ameth = EVP_PKEY_asn1_find(&e, type);
399 ret = ameth->pkey_id;
402 #ifndef OPENSSL_NO_ENGINE
408 int EVP_PKEY_id(const EVP_PKEY *pkey)
413 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
415 return EVP_PKEY_type(pkey->type);
418 void EVP_PKEY_free(EVP_PKEY *x)
425 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
426 REF_PRINT_COUNT("EVP_PKEY", x);
429 REF_ASSERT_ISNT(i < 0);
431 CRYPTO_THREAD_lock_free(x->lock);
432 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
436 static void EVP_PKEY_free_it(EVP_PKEY *x)
438 /* internal function; x is never NULL */
439 if (x->ameth && x->ameth->pkey_free) {
440 x->ameth->pkey_free(x);
443 #ifndef OPENSSL_NO_ENGINE
444 ENGINE_finish(x->engine);
449 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
452 BIO_indent(out, indent, 128);
453 BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
454 kstr, OBJ_nid2ln(pkey->type));
458 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
459 int indent, ASN1_PCTX *pctx)
461 if (pkey->ameth && pkey->ameth->pub_print)
462 return pkey->ameth->pub_print(out, pkey, indent, pctx);
464 return unsup_alg(out, pkey, indent, "Public Key");
467 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
468 int indent, ASN1_PCTX *pctx)
470 if (pkey->ameth && pkey->ameth->priv_print)
471 return pkey->ameth->priv_print(out, pkey, indent, pctx);
473 return unsup_alg(out, pkey, indent, "Private Key");
476 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
477 int indent, ASN1_PCTX *pctx)
479 if (pkey->ameth && pkey->ameth->param_print)
480 return pkey->ameth->param_print(out, pkey, indent, pctx);
481 return unsup_alg(out, pkey, indent, "Parameters");
484 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
486 if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
488 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
491 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
493 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
496 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
497 const unsigned char *pt, size_t ptlen)
501 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
507 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
510 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);