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