1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
59 #include "internal/cryptlib.h"
60 #include <openssl/bn.h>
61 #include <openssl/err.h>
62 #include <openssl/objects.h>
63 #include <openssl/evp.h>
64 #include <openssl/x509.h>
65 #include <openssl/rsa.h>
66 #include <openssl/dsa.h>
67 #include <openssl/dh.h>
68 #include <openssl/engine.h>
70 #include "internal/asn1_int.h"
71 #include "internal/evp_int.h"
73 static void EVP_PKEY_free_it(EVP_PKEY *x);
75 int EVP_PKEY_bits(EVP_PKEY *pkey)
77 if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
78 return pkey->ameth->pkey_bits(pkey);
82 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
86 if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
88 return pkey->ameth->pkey_security_bits(pkey);
91 int EVP_PKEY_size(EVP_PKEY *pkey)
93 if (pkey && pkey->ameth && pkey->ameth->pkey_size)
94 return pkey->ameth->pkey_size(pkey);
98 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
100 #ifndef OPENSSL_NO_DSA
101 if (pkey->type == EVP_PKEY_DSA) {
102 int ret = pkey->save_parameters;
105 pkey->save_parameters = mode;
109 #ifndef OPENSSL_NO_EC
110 if (pkey->type == EVP_PKEY_EC) {
111 int ret = pkey->save_parameters;
114 pkey->save_parameters = mode;
121 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
123 if (to->type == EVP_PKEY_NONE) {
124 if (EVP_PKEY_set_type(to, from->type) == 0)
126 } else if (to->type != from->type) {
127 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
131 if (EVP_PKEY_missing_parameters(from)) {
132 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
135 if (from->ameth && from->ameth->param_copy)
136 return from->ameth->param_copy(to, from);
141 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
143 if (pkey->ameth && pkey->ameth->param_missing)
144 return pkey->ameth->param_missing(pkey);
148 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
150 if (a->type != b->type)
152 if (a->ameth && a->ameth->param_cmp)
153 return a->ameth->param_cmp(a, b);
157 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
159 if (a->type != b->type)
164 /* Compare parameters if the algorithm has them */
165 if (a->ameth->param_cmp) {
166 ret = a->ameth->param_cmp(a, b);
171 if (a->ameth->pub_cmp)
172 return a->ameth->pub_cmp(a, b);
178 EVP_PKEY *EVP_PKEY_new(void)
180 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
183 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
186 ret->type = EVP_PKEY_NONE;
187 ret->save_type = EVP_PKEY_NONE;
189 ret->save_parameters = 1;
190 ret->lock = CRYPTO_THREAD_lock_new();
191 if (ret->lock == NULL) {
192 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
199 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
203 if (CRYPTO_atomic_add(&pkey->references, 1, &i, pkey->lock) <= 0)
206 REF_PRINT_COUNT("EVP_PKEY", pkey);
207 REF_ASSERT_ISNT(i < 2);
208 return ((i > 1) ? 1 : 0);
212 * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
213 * is NULL just return 1 or 0 if the algorithm exists.
216 static int pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
218 const EVP_PKEY_ASN1_METHOD *ameth;
222 EVP_PKEY_free_it(pkey);
224 * If key type matches and a method exists then this lookup has
225 * succeeded once so just indicate success.
227 if ((type == pkey->save_type) && pkey->ameth)
229 #ifndef OPENSSL_NO_ENGINE
230 /* If we have an ENGINE release it */
231 ENGINE_finish(pkey->engine);
236 ameth = EVP_PKEY_asn1_find_str(&e, str, len);
238 ameth = EVP_PKEY_asn1_find(&e, type);
239 #ifndef OPENSSL_NO_ENGINE
244 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
251 pkey->type = pkey->ameth->pkey_id;
252 pkey->save_type = type;
257 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
259 return pkey_set_type(pkey, type, NULL, -1);
262 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
264 return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
267 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
269 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
271 pkey->pkey.ptr = key;
272 return (key != NULL);
275 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
277 return pkey->pkey.ptr;
280 #ifndef OPENSSL_NO_RSA
281 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
283 int ret = EVP_PKEY_assign_RSA(pkey, key);
289 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
291 if (pkey->type != EVP_PKEY_RSA) {
292 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
295 return pkey->pkey.rsa;
298 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
300 RSA *ret = EVP_PKEY_get0_RSA(pkey);
307 #ifndef OPENSSL_NO_DSA
308 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
310 int ret = EVP_PKEY_assign_DSA(pkey, key);
316 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
318 if (pkey->type != EVP_PKEY_DSA) {
319 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
322 return pkey->pkey.dsa;
325 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
327 DSA *ret = EVP_PKEY_get0_DSA(pkey);
334 #ifndef OPENSSL_NO_EC
336 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
338 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
344 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
346 if (pkey->type != EVP_PKEY_EC) {
347 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
350 return pkey->pkey.ec;
353 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
355 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
362 #ifndef OPENSSL_NO_DH
364 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
366 int ret = EVP_PKEY_assign_DH(pkey, key);
372 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
374 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
375 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
378 return pkey->pkey.dh;
381 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
383 DH *ret = EVP_PKEY_get0_DH(pkey);
390 int EVP_PKEY_type(int type)
393 const EVP_PKEY_ASN1_METHOD *ameth;
395 ameth = EVP_PKEY_asn1_find(&e, type);
397 ret = ameth->pkey_id;
400 #ifndef OPENSSL_NO_ENGINE
406 int EVP_PKEY_id(const EVP_PKEY *pkey)
411 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
413 return EVP_PKEY_type(pkey->type);
416 void EVP_PKEY_free(EVP_PKEY *x)
423 CRYPTO_atomic_add(&x->references, -1, &i, x->lock);
424 REF_PRINT_COUNT("EVP_PKEY", x);
427 REF_ASSERT_ISNT(i < 0);
429 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
433 static void EVP_PKEY_free_it(EVP_PKEY *x)
435 /* internal function; x is never NULL */
436 if (x->ameth && x->ameth->pkey_free) {
437 x->ameth->pkey_free(x);
440 #ifndef OPENSSL_NO_ENGINE
441 ENGINE_finish(x->engine);
444 CRYPTO_THREAD_lock_free(x->lock);
447 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
450 BIO_indent(out, indent, 128);
451 BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
452 kstr, OBJ_nid2ln(pkey->type));
456 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
457 int indent, ASN1_PCTX *pctx)
459 if (pkey->ameth && pkey->ameth->pub_print)
460 return pkey->ameth->pub_print(out, pkey, indent, pctx);
462 return unsup_alg(out, pkey, indent, "Public Key");
465 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
466 int indent, ASN1_PCTX *pctx)
468 if (pkey->ameth && pkey->ameth->priv_print)
469 return pkey->ameth->priv_print(out, pkey, indent, pctx);
471 return unsup_alg(out, pkey, indent, "Private Key");
474 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
475 int indent, ASN1_PCTX *pctx)
477 if (pkey->ameth && pkey->ameth->param_print)
478 return pkey->ameth->param_print(out, pkey, indent, pctx);
479 return unsup_alg(out, pkey, indent, "Parameters");
482 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
484 if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
486 return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,