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