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