1 /* crypto/evp/p_lib.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
60 #include "internal/cryptlib.h"
61 #include <openssl/bn.h>
62 #include <openssl/err.h>
63 #include <openssl/objects.h>
64 #include <openssl/evp.h>
65 #include <openssl/x509.h>
66 #ifndef OPENSSL_NO_RSA
67 # include <openssl/rsa.h>
69 #ifndef OPENSSL_NO_DSA
70 # include <openssl/dsa.h>
73 # include <openssl/dh.h>
76 #ifndef OPENSSL_NO_ENGINE
77 # include <openssl/engine.h>
80 #include "internal/asn1_int.h"
81 #include "internal/evp_int.h"
83 static void EVP_PKEY_free_it(EVP_PKEY *x);
85 int EVP_PKEY_bits(EVP_PKEY *pkey)
87 if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
88 return pkey->ameth->pkey_bits(pkey);
92 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
96 if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
98 return pkey->ameth->pkey_security_bits(pkey);
101 int EVP_PKEY_size(EVP_PKEY *pkey)
103 if (pkey && pkey->ameth && pkey->ameth->pkey_size)
104 return pkey->ameth->pkey_size(pkey);
108 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
110 #ifndef OPENSSL_NO_DSA
111 if (pkey->type == EVP_PKEY_DSA) {
112 int ret = pkey->save_parameters;
115 pkey->save_parameters = mode;
119 #ifndef OPENSSL_NO_EC
120 if (pkey->type == EVP_PKEY_EC) {
121 int ret = pkey->save_parameters;
124 pkey->save_parameters = mode;
131 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
133 if (to->type == EVP_PKEY_NONE) {
134 if (EVP_PKEY_set_type(to, from->type) == 0)
136 } else if (to->type != from->type) {
137 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
141 if (EVP_PKEY_missing_parameters(from)) {
142 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
145 if (from->ameth && from->ameth->param_copy)
146 return from->ameth->param_copy(to, from);
151 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
153 if (pkey->ameth && pkey->ameth->param_missing)
154 return pkey->ameth->param_missing(pkey);
158 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
160 if (a->type != b->type)
162 if (a->ameth && a->ameth->param_cmp)
163 return a->ameth->param_cmp(a, b);
167 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
169 if (a->type != b->type)
174 /* Compare parameters if the algorithm has them */
175 if (a->ameth->param_cmp) {
176 ret = a->ameth->param_cmp(a, b);
181 if (a->ameth->pub_cmp)
182 return a->ameth->pub_cmp(a, b);
188 EVP_PKEY *EVP_PKEY_new(void)
192 ret = OPENSSL_malloc(sizeof(*ret));
194 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
197 ret->type = EVP_PKEY_NONE;
198 ret->save_type = EVP_PKEY_NONE;
202 ret->pkey.ptr = NULL;
203 ret->attributes = NULL;
204 ret->save_parameters = 1;
208 void EVP_PKEY_up_ref(EVP_PKEY *pkey)
210 CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
214 * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
215 * is NULL just return 1 or 0 if the algorithm exists.
218 static int pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
220 const EVP_PKEY_ASN1_METHOD *ameth;
224 EVP_PKEY_free_it(pkey);
226 * If key type matches and a method exists then this lookup has
227 * succeeded once so just indicate success.
229 if ((type == pkey->save_type) && pkey->ameth)
231 #ifndef OPENSSL_NO_ENGINE
232 /* If we have an ENGINE release it */
234 ENGINE_finish(pkey->engine);
240 ameth = EVP_PKEY_asn1_find_str(&e, str, len);
242 ameth = EVP_PKEY_asn1_find(&e, type);
243 #ifndef OPENSSL_NO_ENGINE
248 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
255 pkey->type = pkey->ameth->pkey_id;
256 pkey->save_type = type;
261 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
263 return pkey_set_type(pkey, type, NULL, -1);
266 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
268 return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
271 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
273 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
275 pkey->pkey.ptr = key;
276 return (key != NULL);
279 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
281 return pkey->pkey.ptr;
284 #ifndef OPENSSL_NO_RSA
285 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
287 int ret = EVP_PKEY_assign_RSA(pkey, key);
293 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
295 if (pkey->type != EVP_PKEY_RSA) {
296 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
299 return pkey->pkey.rsa;
302 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
304 RSA *ret = EVP_PKEY_get0_RSA(pkey);
311 #ifndef OPENSSL_NO_DSA
312 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
314 int ret = EVP_PKEY_assign_DSA(pkey, key);
320 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
322 if (pkey->type != EVP_PKEY_DSA) {
323 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
326 return pkey->pkey.dsa;
329 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
331 DSA *ret = EVP_PKEY_get0_DSA(pkey);
338 #ifndef OPENSSL_NO_EC
340 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
342 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
348 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
350 if (pkey->type != EVP_PKEY_EC) {
351 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
354 return pkey->pkey.ec;
357 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
359 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
366 #ifndef OPENSSL_NO_DH
368 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
370 int ret = EVP_PKEY_assign_DH(pkey, key);
376 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
378 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
379 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
382 return pkey->pkey.dh;
385 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
387 DH *ret = EVP_PKEY_get0_DH(pkey);
394 int EVP_PKEY_type(int type)
397 const EVP_PKEY_ASN1_METHOD *ameth;
399 ameth = EVP_PKEY_asn1_find(&e, type);
401 ret = ameth->pkey_id;
404 #ifndef OPENSSL_NO_ENGINE
411 int EVP_PKEY_id(const EVP_PKEY *pkey)
416 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
418 return EVP_PKEY_type(pkey->type);
421 void EVP_PKEY_free(EVP_PKEY *x)
428 i = CRYPTO_add(&x->references, -1, CRYPTO_LOCK_EVP_PKEY);
430 REF_PRINT("EVP_PKEY", x);
436 fprintf(stderr, "EVP_PKEY_free, bad reference count\n");
441 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
445 static void EVP_PKEY_free_it(EVP_PKEY *x)
447 /* internal function; x is never NULL */
448 if (x->ameth && x->ameth->pkey_free) {
449 x->ameth->pkey_free(x);
452 #ifndef OPENSSL_NO_ENGINE
454 ENGINE_finish(x->engine);
460 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
463 BIO_indent(out, indent, 128);
464 BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
465 kstr, OBJ_nid2ln(pkey->type));
469 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
470 int indent, ASN1_PCTX *pctx)
472 if (pkey->ameth && pkey->ameth->pub_print)
473 return pkey->ameth->pub_print(out, pkey, indent, pctx);
475 return unsup_alg(out, pkey, indent, "Public Key");
478 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
479 int indent, ASN1_PCTX *pctx)
481 if (pkey->ameth && pkey->ameth->priv_print)
482 return pkey->ameth->priv_print(out, pkey, indent, pctx);
484 return unsup_alg(out, pkey, indent, "Private Key");
487 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
488 int indent, ASN1_PCTX *pctx)
490 if (pkey->ameth && pkey->ameth->param_print)
491 return pkey->ameth->param_print(out, pkey, indent, pctx);
492 return unsup_alg(out, pkey, indent, "Parameters");
495 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
497 if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
499 return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,