fips module header inclusion fine-tunning
[openssl.git] / crypto / evp / m_sigver.c
1 /*
2  * Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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 <openssl/evp.h>
13 #include <openssl/objects.h>
14 #include "crypto/evp.h"
15 #include "internal/provider.h"
16 #include "internal/numbers.h"   /* includes SIZE_MAX */
17 #include "evp_local.h"
18
19 #ifndef FIPS_MODULE
20
21 static int update(EVP_MD_CTX *ctx, const void *data, size_t datalen)
22 {
23     ERR_raise(ERR_LIB_EVP, EVP_R_ONLY_ONESHOT_SUPPORTED);
24     return 0;
25 }
26
27 /*
28  * If we get the "NULL" md then the name comes back as "UNDEF". We want to use
29  * NULL for this.
30  */
31 static const char *canon_mdname(const char *mdname)
32 {
33     if (mdname != NULL && strcmp(mdname, "UNDEF") == 0)
34         return NULL;
35
36     return mdname;
37 }
38
39 static int do_sigver_init(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
40                           const EVP_MD *type, const char *mdname,
41                           OSSL_LIB_CTX *libctx, const char *props,
42                           ENGINE *e, EVP_PKEY *pkey, int ver,
43                           OSSL_PARAM params[])
44 {
45     EVP_PKEY_CTX *locpctx = NULL;
46     EVP_SIGNATURE *signature = NULL;
47     EVP_KEYMGMT *tmp_keymgmt = NULL;
48     const char *supported_sig = NULL;
49     char locmdname[80] = "";     /* 80 chars should be enough */
50     void *provkey = NULL;
51     int ret;
52
53     if (ctx->algctx != NULL) {
54         if (!ossl_assert(ctx->digest != NULL)) {
55             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
56             return 0;
57         }
58         if (ctx->digest->freectx != NULL)
59             ctx->digest->freectx(ctx->algctx);
60         ctx->algctx = NULL;
61     }
62
63     if (ctx->pctx == NULL) {
64         if (e == NULL)
65             ctx->pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, props);
66         else
67             ctx->pctx = EVP_PKEY_CTX_new(pkey, e);
68     }
69     if (ctx->pctx == NULL)
70         return 0;
71
72     locpctx = ctx->pctx;
73     evp_pkey_ctx_free_old_ops(locpctx);
74
75     if (props == NULL)
76         props = locpctx->propquery;
77
78     ERR_set_mark();
79
80     if (evp_pkey_ctx_is_legacy(locpctx))
81         goto legacy;
82
83     /*
84      * Ensure that the key is provided, either natively, or as a cached export.
85      */
86     tmp_keymgmt = locpctx->keymgmt;
87     provkey = evp_pkey_export_to_provider(locpctx->pkey, locpctx->libctx,
88                                           &tmp_keymgmt, locpctx->propquery);
89     if (provkey == NULL) {
90         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
91         goto err;
92     }
93     if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
94         ERR_clear_last_mark();
95         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
96         goto err;
97     }
98     EVP_KEYMGMT_free(locpctx->keymgmt);
99     locpctx->keymgmt = tmp_keymgmt;
100
101     if (locpctx->keymgmt->query_operation_name != NULL)
102         supported_sig =
103             locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
104
105     /*
106      * If we didn't get a supported sig, assume there is one with the
107      * same name as the key type.
108      */
109     if (supported_sig == NULL)
110         supported_sig = locpctx->keytype;
111
112     /*
113      * Because we cleared out old ops, we shouldn't need to worry about
114      * checking if signature is already there.
115      */
116     signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
117                                     locpctx->propquery);
118
119     if (signature == NULL
120         || (EVP_KEYMGMT_get0_provider(locpctx->keymgmt)
121             != EVP_SIGNATURE_get0_provider(signature))) {
122         /*
123          * We don't need to free ctx->keymgmt here, as it's not necessarily
124          * tied to this operation.  It will be freed by EVP_PKEY_CTX_free().
125          */
126         EVP_SIGNATURE_free(signature);
127         goto legacy;
128     }
129
130     /*
131      * If we don't have the full support we need with provided methods,
132      * let's go see if legacy does.
133      */
134     ERR_pop_to_mark();
135
136     /* No more legacy from here down to legacy: */
137
138     if (pctx != NULL)
139         *pctx = locpctx;
140
141     locpctx->op.sig.signature = signature;
142     locpctx->operation = ver ? EVP_PKEY_OP_VERIFYCTX
143                              : EVP_PKEY_OP_SIGNCTX;
144     locpctx->op.sig.algctx
145         = signature->newctx(ossl_provider_ctx(signature->prov), props);
146     if (locpctx->op.sig.algctx == NULL) {
147         ERR_raise(ERR_LIB_EVP,  EVP_R_INITIALIZATION_ERROR);
148         goto err;
149     }
150     if (type != NULL) {
151         ctx->reqdigest = type;
152         if (mdname == NULL)
153             mdname = canon_mdname(EVP_MD_get0_name(type));
154     } else {
155         if (mdname == NULL) {
156             if (evp_keymgmt_util_get_deflt_digest_name(tmp_keymgmt, provkey,
157                                                        locmdname,
158                                                        sizeof(locmdname)) > 0) {
159                 mdname = canon_mdname(locmdname);
160             }
161         }
162
163         if (mdname != NULL) {
164             /*
165              * We're about to get a new digest so clear anything associated with
166              * an old digest.
167              */
168             evp_md_ctx_clear_digest(ctx, 1);
169
170             /* legacy code support for engines */
171             ERR_set_mark();
172             /*
173              * This might be requested by a later call to EVP_MD_CTX_get0_md().
174              * In that case the "explicit fetch" rules apply for that
175              * function (as per man pages), i.e. the ref count is not updated
176              * so the EVP_MD should not be used beyound the lifetime of the
177              * EVP_MD_CTX.
178              */
179             ctx->fetched_digest = EVP_MD_fetch(locpctx->libctx, mdname, props);
180             if (ctx->fetched_digest != NULL) {
181                 ctx->digest = ctx->reqdigest = ctx->fetched_digest;
182             } else {
183                 /* legacy engine support : remove the mark when this is deleted */
184                 ctx->reqdigest = ctx->digest = EVP_get_digestbyname(mdname);
185                 if (ctx->digest == NULL) {
186                     (void)ERR_clear_last_mark();
187                     ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
188                     goto err;
189                 }
190             }
191             (void)ERR_pop_to_mark();
192         }
193     }
194
195     if (ver) {
196         if (signature->digest_verify_init == NULL) {
197             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
198             goto err;
199         }
200         ret = signature->digest_verify_init(locpctx->op.sig.algctx,
201                                             mdname, provkey, params);
202     } else {
203         if (signature->digest_sign_init == NULL) {
204             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
205             goto err;
206         }
207         ret = signature->digest_sign_init(locpctx->op.sig.algctx,
208                                           mdname, provkey, params);
209     }
210
211     goto end;
212
213  err:
214     evp_pkey_ctx_free_old_ops(locpctx);
215     locpctx->operation = EVP_PKEY_OP_UNDEFINED;
216     return 0;
217
218  legacy:
219     /*
220      * If we don't have the full support we need with provided methods,
221      * let's go see if legacy does.
222      */
223     ERR_pop_to_mark();
224
225     if (type == NULL && mdname != NULL)
226         type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
227
228     if (ctx->pctx->pmeth == NULL) {
229         ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
230         return 0;
231     }
232
233     if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
234
235         if (type == NULL) {
236             int def_nid;
237             if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
238                 type = EVP_get_digestbynid(def_nid);
239         }
240
241         if (type == NULL) {
242             ERR_raise(ERR_LIB_EVP, EVP_R_NO_DEFAULT_DIGEST);
243             return 0;
244         }
245     }
246
247     if (ver) {
248         if (ctx->pctx->pmeth->verifyctx_init) {
249             if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
250                 return 0;
251             ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
252         } else if (ctx->pctx->pmeth->digestverify != 0) {
253             ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
254             ctx->update = update;
255         } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
256             return 0;
257         }
258     } else {
259         if (ctx->pctx->pmeth->signctx_init) {
260             if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
261                 return 0;
262             ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
263         } else if (ctx->pctx->pmeth->digestsign != 0) {
264             ctx->pctx->operation = EVP_PKEY_OP_SIGN;
265             ctx->update = update;
266         } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
267             return 0;
268         }
269     }
270     if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
271         return 0;
272     if (pctx)
273         *pctx = ctx->pctx;
274     if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
275         return 1;
276     if (!EVP_DigestInit_ex(ctx, type, e))
277         return 0;
278     /*
279      * This indicates the current algorithm requires
280      * special treatment before hashing the tbs-message.
281      */
282     ctx->pctx->flag_call_digest_custom = 0;
283     if (ctx->pctx->pmeth->digest_custom != NULL)
284         ctx->pctx->flag_call_digest_custom = 1;
285
286     ret = 1;
287
288  end:
289 #ifndef FIPS_MODULE
290     if (ret > 0)
291         ret = evp_pkey_ctx_use_cached_data(locpctx);
292 #endif
293
294     return ret > 0 ? 1 : 0;
295 }
296
297 int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
298                           const char *mdname, OSSL_LIB_CTX *libctx,
299                           const char *props, EVP_PKEY *pkey,
300                           OSSL_PARAM params[])
301 {
302     return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 0,
303                           params);
304 }
305
306 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
307                        const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
308 {
309     return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 0,
310                           NULL);
311 }
312
313 int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
314                             const char *mdname, OSSL_LIB_CTX *libctx,
315                             const char *props, EVP_PKEY *pkey,
316                             OSSL_PARAM params[])
317 {
318     return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 1,
319                           params);
320 }
321
322 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
323                          const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
324 {
325     return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 1,
326                           NULL);
327 }
328 #endif /* FIPS_MDOE */
329
330 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
331 {
332     EVP_PKEY_CTX *pctx = ctx->pctx;
333
334     if (pctx == NULL
335             || pctx->operation != EVP_PKEY_OP_SIGNCTX
336             || pctx->op.sig.algctx == NULL
337             || pctx->op.sig.signature == NULL)
338         goto legacy;
339
340     if (pctx->op.sig.signature->digest_sign_update == NULL) {
341         ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
342         return 0;
343     }
344
345     return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.algctx,
346                                                       data, dsize);
347
348  legacy:
349     if (pctx != NULL) {
350         /* do_sigver_init() checked that |digest_custom| is non-NULL */
351         if (pctx->flag_call_digest_custom
352             && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
353             return 0;
354         pctx->flag_call_digest_custom = 0;
355     }
356
357     return EVP_DigestUpdate(ctx, data, dsize);
358 }
359
360 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
361 {
362     EVP_PKEY_CTX *pctx = ctx->pctx;
363
364     if (pctx == NULL
365             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
366             || pctx->op.sig.algctx == NULL
367             || pctx->op.sig.signature == NULL)
368         goto legacy;
369
370     if (pctx->op.sig.signature->digest_verify_update == NULL) {
371         ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
372         return 0;
373     }
374
375     return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.algctx,
376                                                         data, dsize);
377
378  legacy:
379     if (pctx != NULL) {
380         /* do_sigver_init() checked that |digest_custom| is non-NULL */
381         if (pctx->flag_call_digest_custom
382             && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
383             return 0;
384         pctx->flag_call_digest_custom = 0;
385     }
386
387     return EVP_DigestUpdate(ctx, data, dsize);
388 }
389
390 #ifndef FIPS_MODULE
391 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
392                         size_t *siglen)
393 {
394     int sctx = 0, r = 0;
395     EVP_PKEY_CTX *pctx = ctx->pctx;
396
397     if (pctx == NULL
398             || pctx->operation != EVP_PKEY_OP_SIGNCTX
399             || pctx->op.sig.algctx == NULL
400             || pctx->op.sig.signature == NULL)
401         goto legacy;
402
403     return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.algctx,
404                                                      sigret, siglen, SIZE_MAX);
405
406  legacy:
407     if (pctx == NULL || pctx->pmeth == NULL) {
408         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
409         return 0;
410     }
411
412     /* do_sigver_init() checked that |digest_custom| is non-NULL */
413     if (pctx->flag_call_digest_custom
414         && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
415         return 0;
416     pctx->flag_call_digest_custom = 0;
417
418     if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
419         if (sigret == NULL)
420             return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
421         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
422             r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
423         else {
424             EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
425
426             if (dctx == NULL)
427                 return 0;
428             r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
429             EVP_PKEY_CTX_free(dctx);
430         }
431         return r;
432     }
433     if (pctx->pmeth->signctx != NULL)
434         sctx = 1;
435     else
436         sctx = 0;
437     if (sigret != NULL) {
438         unsigned char md[EVP_MAX_MD_SIZE];
439         unsigned int mdlen = 0;
440
441         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
442             if (sctx)
443                 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
444             else
445                 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
446         } else {
447             EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
448
449             if (tmp_ctx == NULL)
450                 return 0;
451             if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
452                 EVP_MD_CTX_free(tmp_ctx);
453                 return 0;
454             }
455             if (sctx)
456                 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
457                                                   sigret, siglen, tmp_ctx);
458             else
459                 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
460             EVP_MD_CTX_free(tmp_ctx);
461         }
462         if (sctx || !r)
463             return r;
464         if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
465             return 0;
466     } else {
467         if (sctx) {
468             if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
469                 return 0;
470         } else {
471             int s = EVP_MD_get_size(ctx->digest);
472
473             if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
474                 return 0;
475         }
476     }
477     return 1;
478 }
479
480 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
481                    const unsigned char *tbs, size_t tbslen)
482 {
483     EVP_PKEY_CTX *pctx = ctx->pctx;
484
485     if (pctx != NULL
486             && pctx->operation == EVP_PKEY_OP_SIGNCTX
487             && pctx->op.sig.algctx != NULL
488             && pctx->op.sig.signature != NULL) {
489         if (pctx->op.sig.signature->digest_sign != NULL)
490             return pctx->op.sig.signature->digest_sign(pctx->op.sig.algctx,
491                                                        sigret, siglen, SIZE_MAX,
492                                                        tbs, tbslen);
493     } else {
494         /* legacy */
495         if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
496             return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
497     }
498
499     if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
500         return 0;
501     return EVP_DigestSignFinal(ctx, sigret, siglen);
502 }
503
504 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
505                           size_t siglen)
506 {
507     unsigned char md[EVP_MAX_MD_SIZE];
508     int r = 0;
509     unsigned int mdlen = 0;
510     int vctx = 0;
511     EVP_PKEY_CTX *pctx = ctx->pctx;
512
513     if (pctx == NULL
514             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
515             || pctx->op.sig.algctx == NULL
516             || pctx->op.sig.signature == NULL)
517         goto legacy;
518
519     return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.algctx,
520                                                        sig, siglen);
521
522  legacy:
523     if (pctx == NULL || pctx->pmeth == NULL) {
524         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
525         return 0;
526     }
527
528     /* do_sigver_init() checked that |digest_custom| is non-NULL */
529     if (pctx->flag_call_digest_custom
530         && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
531         return 0;
532     pctx->flag_call_digest_custom = 0;
533
534     if (pctx->pmeth->verifyctx != NULL)
535         vctx = 1;
536     else
537         vctx = 0;
538     if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
539         if (vctx)
540             r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
541         else
542             r = EVP_DigestFinal_ex(ctx, md, &mdlen);
543     } else {
544         EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
545         if (tmp_ctx == NULL)
546             return -1;
547         if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
548             EVP_MD_CTX_free(tmp_ctx);
549             return -1;
550         }
551         if (vctx)
552             r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
553                                                 sig, siglen, tmp_ctx);
554         else
555             r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
556         EVP_MD_CTX_free(tmp_ctx);
557     }
558     if (vctx || !r)
559         return r;
560     return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
561 }
562
563 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
564                      size_t siglen, const unsigned char *tbs, size_t tbslen)
565 {
566     EVP_PKEY_CTX *pctx = ctx->pctx;
567
568     if (pctx != NULL
569             && pctx->operation == EVP_PKEY_OP_VERIFYCTX
570             && pctx->op.sig.algctx != NULL
571             && pctx->op.sig.signature != NULL) {
572         if (pctx->op.sig.signature->digest_verify != NULL)
573             return pctx->op.sig.signature->digest_verify(pctx->op.sig.algctx,
574                                                          sigret, siglen,
575                                                          tbs, tbslen);
576     } else {
577         /* legacy */
578         if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
579             return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
580     }
581
582     if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
583         return -1;
584     return EVP_DigestVerifyFinal(ctx, sigret, siglen);
585 }
586 #endif /* FIPS_MODULE */