d78f1d2d841178b08bebf82c3fe4232bdc93086a
[openssl.git] / crypto / evp / p_lib.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #include <stdio.h>
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/cmac.h>
22 #include <openssl/engine.h>
23
24 #include "internal/asn1_int.h"
25 #include "internal/evp_int.h"
26
27 static void EVP_PKEY_free_it(EVP_PKEY *x);
28
29 int EVP_PKEY_bits(const EVP_PKEY *pkey)
30 {
31     if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
32         return pkey->ameth->pkey_bits(pkey);
33     return 0;
34 }
35
36 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
37 {
38     if (pkey == NULL)
39         return 0;
40     if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
41         return -2;
42     return pkey->ameth->pkey_security_bits(pkey);
43 }
44
45 int EVP_PKEY_size(EVP_PKEY *pkey)
46 {
47     if (pkey && pkey->ameth && pkey->ameth->pkey_size)
48         return pkey->ameth->pkey_size(pkey);
49     return 0;
50 }
51
52 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
53 {
54 #ifndef OPENSSL_NO_DSA
55     if (pkey->type == EVP_PKEY_DSA) {
56         int ret = pkey->save_parameters;
57
58         if (mode >= 0)
59             pkey->save_parameters = mode;
60         return ret;
61     }
62 #endif
63 #ifndef OPENSSL_NO_EC
64     if (pkey->type == EVP_PKEY_EC) {
65         int ret = pkey->save_parameters;
66
67         if (mode >= 0)
68             pkey->save_parameters = mode;
69         return ret;
70     }
71 #endif
72     return 0;
73 }
74
75 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
76 {
77     if (to->type == EVP_PKEY_NONE) {
78         if (EVP_PKEY_set_type(to, from->type) == 0)
79             return 0;
80     } else if (to->type != from->type) {
81         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
82         goto err;
83     }
84
85     if (EVP_PKEY_missing_parameters(from)) {
86         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
87         goto err;
88     }
89
90     if (!EVP_PKEY_missing_parameters(to)) {
91         if (EVP_PKEY_cmp_parameters(to, from) == 1)
92             return 1;
93         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
94         return 0;
95     }
96
97     if (from->ameth && from->ameth->param_copy)
98         return from->ameth->param_copy(to, from);
99  err:
100     return 0;
101 }
102
103 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
104 {
105     if (pkey->ameth && pkey->ameth->param_missing)
106         return pkey->ameth->param_missing(pkey);
107     return 0;
108 }
109
110 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
111 {
112     if (a->type != b->type)
113         return -1;
114     if (a->ameth && a->ameth->param_cmp)
115         return a->ameth->param_cmp(a, b);
116     return -2;
117 }
118
119 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
120 {
121     if (a->type != b->type)
122         return -1;
123
124     if (a->ameth) {
125         int ret;
126         /* Compare parameters if the algorithm has them */
127         if (a->ameth->param_cmp) {
128             ret = a->ameth->param_cmp(a, b);
129             if (ret <= 0)
130                 return ret;
131         }
132
133         if (a->ameth->pub_cmp)
134             return a->ameth->pub_cmp(a, b);
135     }
136
137     return -2;
138 }
139
140 EVP_PKEY *EVP_PKEY_new(void)
141 {
142     EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
143
144     if (ret == NULL) {
145         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
146         return NULL;
147     }
148     ret->type = EVP_PKEY_NONE;
149     ret->save_type = EVP_PKEY_NONE;
150     ret->references = 1;
151     ret->save_parameters = 1;
152     ret->lock = CRYPTO_THREAD_lock_new();
153     if (ret->lock == NULL) {
154         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
155         OPENSSL_free(ret);
156         return NULL;
157     }
158     return ret;
159 }
160
161 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
162 {
163     int i;
164
165     if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
166         return 0;
167
168     REF_PRINT_COUNT("EVP_PKEY", pkey);
169     REF_ASSERT_ISNT(i < 2);
170     return ((i > 1) ? 1 : 0);
171 }
172
173 /*
174  * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
175  * is NULL just return 1 or 0 if the algorithm exists.
176  */
177
178 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
179                          int len)
180 {
181     const EVP_PKEY_ASN1_METHOD *ameth;
182     ENGINE **eptr = (e == NULL) ? &e :  NULL;
183
184     if (pkey) {
185         if (pkey->pkey.ptr)
186             EVP_PKEY_free_it(pkey);
187         /*
188          * If key type matches and a method exists then this lookup has
189          * succeeded once so just indicate success.
190          */
191         if ((type == pkey->save_type) && pkey->ameth)
192             return 1;
193 #ifndef OPENSSL_NO_ENGINE
194         /* If we have ENGINEs release them */
195         ENGINE_finish(pkey->engine);
196         pkey->engine = NULL;
197         ENGINE_finish(pkey->pmeth_engine);
198         pkey->pmeth_engine = NULL;
199 #endif
200     }
201     if (str)
202         ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
203     else
204         ameth = EVP_PKEY_asn1_find(eptr, type);
205 #ifndef OPENSSL_NO_ENGINE
206     if (pkey == NULL && eptr != NULL)
207         ENGINE_finish(e);
208 #endif
209     if (ameth == NULL) {
210         EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
211         return 0;
212     }
213     if (pkey) {
214         pkey->ameth = ameth;
215         pkey->engine = e;
216
217         pkey->type = pkey->ameth->pkey_id;
218         pkey->save_type = type;
219     }
220     return 1;
221 }
222
223 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
224                                        const unsigned char *priv,
225                                        size_t len)
226 {
227     EVP_PKEY *ret = EVP_PKEY_new();
228
229     if (ret == NULL
230             || !pkey_set_type(ret, e, type, NULL, -1)) {
231         /* EVPerr already called */
232         goto err;
233     }
234
235     if (ret->ameth->set_priv_key == NULL) {
236         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PRIVATE_KEY,
237                EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
238         goto err;
239     }
240
241     if (!ret->ameth->set_priv_key(ret, priv, len)) {
242         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PRIVATE_KEY, EVP_R_KEY_SETUP_FAILED);
243         goto err;
244     }
245
246     return ret;
247
248  err:
249     EVP_PKEY_free(ret);
250     return NULL;
251 }
252
253 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
254                                       const unsigned char *pub,
255                                       size_t len)
256 {
257     EVP_PKEY *ret = EVP_PKEY_new();
258
259     if (ret == NULL
260             || !pkey_set_type(ret, e, type, NULL, -1)) {
261         /* EVPerr already called */
262         goto err;
263     }
264
265     if (ret->ameth->set_pub_key == NULL) {
266         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PUBLIC_KEY,
267                EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
268         goto err;
269     }
270
271     if (!ret->ameth->set_pub_key(ret, pub, len)) {
272         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PUBLIC_KEY, EVP_R_KEY_SETUP_FAILED);
273         goto err;
274     }
275
276     return ret;
277
278  err:
279     EVP_PKEY_free(ret);
280     return NULL;
281 }
282
283 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
284                                  size_t *len)
285 {
286      if (pkey->ameth->get_priv_key == NULL) {
287         EVPerr(EVP_F_EVP_PKEY_GET_RAW_PRIVATE_KEY,
288                EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
289         return 0;
290     }
291
292     if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
293         EVPerr(EVP_F_EVP_PKEY_GET_RAW_PRIVATE_KEY, EVP_R_GET_RAW_KEY_FAILED);
294         return 0;
295     }
296
297     return 1;
298 }
299
300 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
301                                 size_t *len)
302 {
303      if (pkey->ameth->get_pub_key == NULL) {
304         EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
305                EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
306         return 0;
307     }
308
309     if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
310         EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
311         return 0;
312     }
313
314     return 1;
315 }
316
317 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
318                                 size_t len, const EVP_CIPHER *cipher)
319 {
320 #ifndef OPENSSL_NO_CMAC
321     EVP_PKEY *ret = EVP_PKEY_new();
322     CMAC_CTX *cmctx = CMAC_CTX_new();
323
324     if (ret == NULL
325             || cmctx == NULL
326             || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1)) {
327         /* EVPerr already called */
328         goto err;
329     }
330
331     if (!CMAC_Init(cmctx, priv, len, cipher, e)) {
332         EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
333         goto err;
334     }
335
336     ret->pkey.ptr = cmctx;
337     return ret;
338
339  err:
340     EVP_PKEY_free(ret);
341     CMAC_CTX_free(cmctx);
342     return NULL;
343 #else
344     EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
345            EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
346     return NULL;
347 #endif
348 }
349
350 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
351 {
352     return pkey_set_type(pkey, NULL, type, NULL, -1);
353 }
354
355 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
356 {
357     return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len);
358 }
359 #ifndef OPENSSL_NO_ENGINE
360 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
361 {
362     if (e != NULL) {
363         if (!ENGINE_init(e)) {
364             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
365             return 0;
366         }
367         if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
368             ENGINE_finish(e);
369             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
370             return 0;
371         }
372     }
373     ENGINE_finish(pkey->pmeth_engine);
374     pkey->pmeth_engine = e;
375     return 1;
376 }
377 #endif
378 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
379 {
380     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
381         return 0;
382     pkey->pkey.ptr = key;
383     return (key != NULL);
384 }
385
386 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
387 {
388     return pkey->pkey.ptr;
389 }
390
391 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
392 {
393     ASN1_OCTET_STRING *os = NULL;
394     if (pkey->type != EVP_PKEY_HMAC) {
395         EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
396         return NULL;
397     }
398     os = EVP_PKEY_get0(pkey);
399     *len = os->length;
400     return os->data;
401 }
402
403 #ifndef OPENSSL_NO_POLY1305
404 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
405 {
406     ASN1_OCTET_STRING *os = NULL;
407     if (pkey->type != EVP_PKEY_POLY1305) {
408         EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
409         return NULL;
410     }
411     os = EVP_PKEY_get0(pkey);
412     *len = os->length;
413     return os->data;
414 }
415 #endif
416
417 #ifndef OPENSSL_NO_SIPHASH
418 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
419 {
420     ASN1_OCTET_STRING *os = NULL;
421
422     if (pkey->type != EVP_PKEY_SIPHASH) {
423         EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
424         return NULL;
425     }
426     os = EVP_PKEY_get0(pkey);
427     *len = os->length;
428     return os->data;
429 }
430 #endif
431
432 #ifndef OPENSSL_NO_RSA
433 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
434 {
435     int ret = EVP_PKEY_assign_RSA(pkey, key);
436     if (ret)
437         RSA_up_ref(key);
438     return ret;
439 }
440
441 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
442 {
443     if (pkey->type != EVP_PKEY_RSA) {
444         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
445         return NULL;
446     }
447     return pkey->pkey.rsa;
448 }
449
450 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
451 {
452     RSA *ret = EVP_PKEY_get0_RSA(pkey);
453     if (ret != NULL)
454         RSA_up_ref(ret);
455     return ret;
456 }
457 #endif
458
459 #ifndef OPENSSL_NO_DSA
460 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
461 {
462     int ret = EVP_PKEY_assign_DSA(pkey, key);
463     if (ret)
464         DSA_up_ref(key);
465     return ret;
466 }
467
468 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
469 {
470     if (pkey->type != EVP_PKEY_DSA) {
471         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
472         return NULL;
473     }
474     return pkey->pkey.dsa;
475 }
476
477 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
478 {
479     DSA *ret = EVP_PKEY_get0_DSA(pkey);
480     if (ret != NULL)
481         DSA_up_ref(ret);
482     return ret;
483 }
484 #endif
485
486 #ifndef OPENSSL_NO_EC
487
488 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
489 {
490     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
491     if (ret)
492         EC_KEY_up_ref(key);
493     return ret;
494 }
495
496 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
497 {
498     if (pkey->type != EVP_PKEY_EC) {
499         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
500         return NULL;
501     }
502     return pkey->pkey.ec;
503 }
504
505 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
506 {
507     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
508     if (ret != NULL)
509         EC_KEY_up_ref(ret);
510     return ret;
511 }
512 #endif
513
514 #ifndef OPENSSL_NO_DH
515
516 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
517 {
518     int ret = EVP_PKEY_assign_DH(pkey, key);
519     if (ret)
520         DH_up_ref(key);
521     return ret;
522 }
523
524 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
525 {
526     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
527         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
528         return NULL;
529     }
530     return pkey->pkey.dh;
531 }
532
533 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
534 {
535     DH *ret = EVP_PKEY_get0_DH(pkey);
536     if (ret != NULL)
537         DH_up_ref(ret);
538     return ret;
539 }
540 #endif
541
542 int EVP_PKEY_type(int type)
543 {
544     int ret;
545     const EVP_PKEY_ASN1_METHOD *ameth;
546     ENGINE *e;
547     ameth = EVP_PKEY_asn1_find(&e, type);
548     if (ameth)
549         ret = ameth->pkey_id;
550     else
551         ret = NID_undef;
552 #ifndef OPENSSL_NO_ENGINE
553     ENGINE_finish(e);
554 #endif
555     return ret;
556 }
557
558 int EVP_PKEY_id(const EVP_PKEY *pkey)
559 {
560     return pkey->type;
561 }
562
563 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
564 {
565     return EVP_PKEY_type(pkey->type);
566 }
567
568 void EVP_PKEY_free(EVP_PKEY *x)
569 {
570     int i;
571
572     if (x == NULL)
573         return;
574
575     CRYPTO_DOWN_REF(&x->references, &i, x->lock);
576     REF_PRINT_COUNT("EVP_PKEY", x);
577     if (i > 0)
578         return;
579     REF_ASSERT_ISNT(i < 0);
580     EVP_PKEY_free_it(x);
581     CRYPTO_THREAD_lock_free(x->lock);
582     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
583     OPENSSL_free(x);
584 }
585
586 static void EVP_PKEY_free_it(EVP_PKEY *x)
587 {
588     /* internal function; x is never NULL */
589     if (x->ameth && x->ameth->pkey_free) {
590         x->ameth->pkey_free(x);
591         x->pkey.ptr = NULL;
592     }
593 #ifndef OPENSSL_NO_ENGINE
594     ENGINE_finish(x->engine);
595     x->engine = NULL;
596     ENGINE_finish(x->pmeth_engine);
597     x->pmeth_engine = NULL;
598 #endif
599 }
600
601 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
602                      const char *kstr)
603 {
604     BIO_indent(out, indent, 128);
605     BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
606                kstr, OBJ_nid2ln(pkey->type));
607     return 1;
608 }
609
610 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
611                           int indent, ASN1_PCTX *pctx)
612 {
613     if (pkey->ameth && pkey->ameth->pub_print)
614         return pkey->ameth->pub_print(out, pkey, indent, pctx);
615
616     return unsup_alg(out, pkey, indent, "Public Key");
617 }
618
619 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
620                            int indent, ASN1_PCTX *pctx)
621 {
622     if (pkey->ameth && pkey->ameth->priv_print)
623         return pkey->ameth->priv_print(out, pkey, indent, pctx);
624
625     return unsup_alg(out, pkey, indent, "Private Key");
626 }
627
628 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
629                           int indent, ASN1_PCTX *pctx)
630 {
631     if (pkey->ameth && pkey->ameth->param_print)
632         return pkey->ameth->param_print(out, pkey, indent, pctx);
633     return unsup_alg(out, pkey, indent, "Parameters");
634 }
635
636 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
637 {
638     if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
639         return -2;
640     return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
641 }
642
643 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
644 {
645     return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
646 }
647
648 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
649                                const unsigned char *pt, size_t ptlen)
650 {
651     if (ptlen > INT_MAX)
652         return 0;
653     if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
654                            (void *)pt) <= 0)
655         return 0;
656     return 1;
657 }
658
659 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
660 {
661     int rv;
662     rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
663     if (rv <= 0)
664         return 0;
665     return rv;
666 }