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.]
61 #include <openssl/bn.h>
62 #include <openssl/err.h>
63 #include <openssl/objects.h>
64 #include <openssl/evp.h>
65 #include <openssl/asn1_mac.h>
66 #include <openssl/x509.h>
67 #ifndef OPENSSL_NO_RSA
68 # include <openssl/rsa.h>
70 #ifndef OPENSSL_NO_DSA
71 # include <openssl/dsa.h>
74 # include <openssl/dh.h>
77 #ifndef OPENSSL_NO_ENGINE
78 # include <openssl/engine.h>
81 #include "asn1_locl.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 != from->type) {
134 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
138 if (EVP_PKEY_missing_parameters(from)) {
139 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
142 if (from->ameth && from->ameth->param_copy)
143 return from->ameth->param_copy(to, from);
148 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
150 if (pkey->ameth && pkey->ameth->param_missing)
151 return pkey->ameth->param_missing(pkey);
155 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
157 if (a->type != b->type)
159 if (a->ameth && a->ameth->param_cmp)
160 return a->ameth->param_cmp(a, b);
164 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
166 if (a->type != b->type)
171 /* Compare parameters if the algorithm has them */
172 if (a->ameth->param_cmp) {
173 ret = a->ameth->param_cmp(a, b);
178 if (a->ameth->pub_cmp)
179 return a->ameth->pub_cmp(a, b);
185 EVP_PKEY *EVP_PKEY_new(void)
189 ret = (EVP_PKEY *)OPENSSL_malloc(sizeof(EVP_PKEY));
191 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
194 ret->type = EVP_PKEY_NONE;
195 ret->save_type = EVP_PKEY_NONE;
199 ret->pkey.ptr = NULL;
200 ret->attributes = NULL;
201 ret->save_parameters = 1;
206 * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
207 * is NULL just return 1 or 0 if the algorithm exists.
210 static int pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
212 const EVP_PKEY_ASN1_METHOD *ameth;
216 EVP_PKEY_free_it(pkey);
218 * If key type matches and a method exists then this lookup has
219 * succeeded once so just indicate success.
221 if ((type == pkey->save_type) && pkey->ameth)
223 #ifndef OPENSSL_NO_ENGINE
224 /* If we have an ENGINE release it */
226 ENGINE_finish(pkey->engine);
232 ameth = EVP_PKEY_asn1_find_str(&e, str, len);
234 ameth = EVP_PKEY_asn1_find(&e, type);
235 #ifndef OPENSSL_NO_ENGINE
240 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
247 pkey->type = pkey->ameth->pkey_id;
248 pkey->save_type = type;
253 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
255 return pkey_set_type(pkey, type, NULL, -1);
258 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
260 return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
263 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
265 if (!EVP_PKEY_set_type(pkey, type))
267 pkey->pkey.ptr = key;
268 return (key != NULL);
271 void *EVP_PKEY_get0(EVP_PKEY *pkey)
273 return pkey->pkey.ptr;
276 #ifndef OPENSSL_NO_RSA
277 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
279 int ret = EVP_PKEY_assign_RSA(pkey, key);
285 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
287 if (pkey->type != EVP_PKEY_RSA) {
288 EVPerr(EVP_F_EVP_PKEY_GET1_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
291 RSA_up_ref(pkey->pkey.rsa);
292 return pkey->pkey.rsa;
296 #ifndef OPENSSL_NO_DSA
297 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
299 int ret = EVP_PKEY_assign_DSA(pkey, key);
305 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
307 if (pkey->type != EVP_PKEY_DSA) {
308 EVPerr(EVP_F_EVP_PKEY_GET1_DSA, EVP_R_EXPECTING_A_DSA_KEY);
311 DSA_up_ref(pkey->pkey.dsa);
312 return pkey->pkey.dsa;
316 #ifndef OPENSSL_NO_EC
318 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
320 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
326 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
328 if (pkey->type != EVP_PKEY_EC) {
329 EVPerr(EVP_F_EVP_PKEY_GET1_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
332 EC_KEY_up_ref(pkey->pkey.ec);
333 return pkey->pkey.ec;
337 #ifndef OPENSSL_NO_DH
339 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
341 int ret = EVP_PKEY_assign_DH(pkey, key);
347 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
349 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
350 EVPerr(EVP_F_EVP_PKEY_GET1_DH, EVP_R_EXPECTING_A_DH_KEY);
353 DH_up_ref(pkey->pkey.dh);
354 return pkey->pkey.dh;
358 int EVP_PKEY_type(int type)
361 const EVP_PKEY_ASN1_METHOD *ameth;
363 ameth = EVP_PKEY_asn1_find(&e, type);
365 ret = ameth->pkey_id;
368 #ifndef OPENSSL_NO_ENGINE
375 int EVP_PKEY_id(const EVP_PKEY *pkey)
380 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
382 return EVP_PKEY_type(pkey->type);
385 void EVP_PKEY_free(EVP_PKEY *x)
392 i = CRYPTO_add(&x->references, -1, CRYPTO_LOCK_EVP_PKEY);
394 REF_PRINT("EVP_PKEY", x);
400 fprintf(stderr, "EVP_PKEY_free, bad reference count\n");
406 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
410 static void EVP_PKEY_free_it(EVP_PKEY *x)
412 if (x->ameth && x->ameth->pkey_free) {
413 x->ameth->pkey_free(x);
416 #ifndef OPENSSL_NO_ENGINE
418 ENGINE_finish(x->engine);
424 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
427 BIO_indent(out, indent, 128);
428 BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
429 kstr, OBJ_nid2ln(pkey->type));
433 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
434 int indent, ASN1_PCTX *pctx)
436 if (pkey->ameth && pkey->ameth->pub_print)
437 return pkey->ameth->pub_print(out, pkey, indent, pctx);
439 return unsup_alg(out, pkey, indent, "Public Key");
442 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
443 int indent, ASN1_PCTX *pctx)
445 if (pkey->ameth && pkey->ameth->priv_print)
446 return pkey->ameth->priv_print(out, pkey, indent, pctx);
448 return unsup_alg(out, pkey, indent, "Private Key");
451 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
452 int indent, ASN1_PCTX *pctx)
454 if (pkey->ameth && pkey->ameth->param_print)
455 return pkey->ameth->param_print(out, pkey, indent, pctx);
456 return unsup_alg(out, pkey, indent, "Parameters");
459 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
461 if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
463 return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,