HMAC should work with non-provided digests
[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                           OPENSSL_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 (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             }
176         }
177
178         if (mdname != NULL) {
179             /*
180              * We're about to get a new digest so clear anything associated with
181              * an old digest.
182              */
183             evp_md_ctx_clear_digest(ctx, 1);
184
185             /* legacy code support for engines */
186             ERR_set_mark();
187             /*
188              * This might be requested by a later call to EVP_MD_CTX_md().
189              * In that case the "explicit fetch" rules apply for that
190              * function (as per man pages), i.e. the ref count is not updated
191              * so the EVP_MD should not be used beyound the lifetime of the
192              * EVP_MD_CTX.
193              */
194             ctx->fetched_digest = EVP_MD_fetch(locpctx->libctx, mdname, props);
195             if (ctx->fetched_digest != NULL) {
196                 ctx->digest = ctx->reqdigest = ctx->fetched_digest;
197             } else {
198                 /* legacy engine support : remove the mark when this is deleted */
199                 ctx->reqdigest = ctx->digest = EVP_get_digestbyname(mdname);
200                 if (ctx->digest == NULL) {
201                     (void)ERR_clear_last_mark();
202                     ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
203                     goto err;
204                 }
205             }
206             (void)ERR_pop_to_mark();
207         }
208     }
209
210     if (ver) {
211         if (signature->digest_verify_init == NULL) {
212             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
213             goto err;
214         }
215         ret = signature->digest_verify_init(locpctx->op.sig.sigprovctx,
216                                             mdname, provkey);
217     } else {
218         if (signature->digest_sign_init == NULL) {
219             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
220             goto err;
221         }
222         ret = signature->digest_sign_init(locpctx->op.sig.sigprovctx,
223                                           mdname, provkey);
224     }
225
226     goto end;
227
228  err:
229     evp_pkey_ctx_free_old_ops(locpctx);
230     locpctx->operation = EVP_PKEY_OP_UNDEFINED;
231     return 0;
232
233  legacy:
234     /*
235      * TODO remove this when legacy is gone
236      * If we don't have the full support we need with provided methods,
237      * let's go see if legacy does.
238      */
239     ERR_pop_to_mark();
240
241     if (type == NULL && mdname != NULL)
242         type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
243
244     if (ctx->pctx->pmeth == NULL) {
245         EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
246         return 0;
247     }
248
249     if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
250
251         if (type == NULL) {
252             int def_nid;
253             if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
254                 type = EVP_get_digestbynid(def_nid);
255         }
256
257         if (type == NULL) {
258             EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
259             return 0;
260         }
261     }
262
263     if (ver) {
264         if (ctx->pctx->pmeth->verifyctx_init) {
265             if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
266                 return 0;
267             ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
268         } else if (ctx->pctx->pmeth->digestverify != 0) {
269             ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
270             ctx->update = update;
271         } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
272             return 0;
273         }
274     } else {
275         if (ctx->pctx->pmeth->signctx_init) {
276             if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
277                 return 0;
278             ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
279         } else if (ctx->pctx->pmeth->digestsign != 0) {
280             ctx->pctx->operation = EVP_PKEY_OP_SIGN;
281             ctx->update = update;
282         } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
283             return 0;
284         }
285     }
286     if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
287         return 0;
288     if (pctx)
289         *pctx = ctx->pctx;
290     if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
291         return 1;
292     if (!EVP_DigestInit_ex(ctx, type, e))
293         return 0;
294     /*
295      * This indicates the current algorithm requires
296      * special treatment before hashing the tbs-message.
297      */
298     ctx->pctx->flag_call_digest_custom = 0;
299     if (ctx->pctx->pmeth->digest_custom != NULL)
300         ctx->pctx->flag_call_digest_custom = 1;
301
302     ret = 1;
303
304  end:
305 #ifndef FIPS_MODULE
306     if (ret > 0)
307         ret = evp_pkey_ctx_use_cached_data(locpctx);
308 #endif
309
310     return ret > 0 ? 1 : 0;
311 }
312
313 int EVP_DigestSignInit_with_libctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
314                                    const char *mdname,
315                                    OPENSSL_CTX *libctx, const char *props,
316                                    EVP_PKEY *pkey)
317 {
318     return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 0);
319 }
320
321 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
322                        const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
323 {
324     return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 0);
325 }
326
327 int EVP_DigestVerifyInit_with_libctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
328                                      const char *mdname,
329                                      OPENSSL_CTX *libctx, const char *props,
330                                      EVP_PKEY *pkey)
331 {
332     return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 1);
333 }
334
335 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
336                          const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
337 {
338     return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 1);
339 }
340 #endif /* FIPS_MDOE */
341
342 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
343 {
344     EVP_PKEY_CTX *pctx = ctx->pctx;
345
346     if (pctx == NULL
347             || pctx->operation != EVP_PKEY_OP_SIGNCTX
348             || pctx->op.sig.sigprovctx == NULL
349             || pctx->op.sig.signature == NULL)
350         goto legacy;
351
352     if (pctx->op.sig.signature->digest_sign_update == NULL) {
353         ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
354         return 0;
355     }
356
357     return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.sigprovctx,
358                                                       data, dsize);
359
360  legacy:
361     if (pctx != NULL) {
362         /* do_sigver_init() checked that |digest_custom| is non-NULL */
363         if (pctx->flag_call_digest_custom
364             && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
365             return 0;
366         pctx->flag_call_digest_custom = 0;
367     }
368
369     return EVP_DigestUpdate(ctx, data, dsize);
370 }
371
372 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
373 {
374     EVP_PKEY_CTX *pctx = ctx->pctx;
375
376     if (pctx == NULL
377             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
378             || pctx->op.sig.sigprovctx == NULL
379             || pctx->op.sig.signature == NULL)
380         goto legacy;
381
382     if (pctx->op.sig.signature->digest_verify_update == NULL) {
383         ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
384         return 0;
385     }
386
387     return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.sigprovctx,
388                                                         data, dsize);
389
390  legacy:
391     if (pctx != NULL) {
392         /* do_sigver_init() checked that |digest_custom| is non-NULL */
393         if (pctx->flag_call_digest_custom
394             && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
395             return 0;
396         pctx->flag_call_digest_custom = 0;
397     }
398
399     return EVP_DigestUpdate(ctx, data, dsize);
400 }
401
402 #ifndef FIPS_MODULE
403 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
404                         size_t *siglen)
405 {
406     int sctx = 0, r = 0;
407     EVP_PKEY_CTX *pctx = ctx->pctx;
408
409     if (pctx == NULL
410             || pctx->operation != EVP_PKEY_OP_SIGNCTX
411             || pctx->op.sig.sigprovctx == NULL
412             || pctx->op.sig.signature == NULL)
413         goto legacy;
414
415     return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.sigprovctx,
416                                                      sigret, siglen, SIZE_MAX);
417
418  legacy:
419     if (pctx == NULL || pctx->pmeth == NULL) {
420         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
421         return 0;
422     }
423
424     /* do_sigver_init() checked that |digest_custom| is non-NULL */
425     if (pctx->flag_call_digest_custom
426         && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
427         return 0;
428     pctx->flag_call_digest_custom = 0;
429
430     if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
431         if (sigret == NULL)
432             return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
433         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
434             r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
435         else {
436             EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
437
438             if (dctx == NULL)
439                 return 0;
440             r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
441             EVP_PKEY_CTX_free(dctx);
442         }
443         return r;
444     }
445     if (pctx->pmeth->signctx != NULL)
446         sctx = 1;
447     else
448         sctx = 0;
449     if (sigret != NULL) {
450         unsigned char md[EVP_MAX_MD_SIZE];
451         unsigned int mdlen = 0;
452
453         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
454             if (sctx)
455                 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
456             else
457                 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
458         } else {
459             EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
460
461             if (tmp_ctx == NULL)
462                 return 0;
463             if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
464                 EVP_MD_CTX_free(tmp_ctx);
465                 return 0;
466             }
467             if (sctx)
468                 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
469                                                   sigret, siglen, tmp_ctx);
470             else
471                 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
472             EVP_MD_CTX_free(tmp_ctx);
473         }
474         if (sctx || !r)
475             return r;
476         if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
477             return 0;
478     } else {
479         if (sctx) {
480             if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
481                 return 0;
482         } else {
483             int s = EVP_MD_size(ctx->digest);
484
485             if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
486                 return 0;
487         }
488     }
489     return 1;
490 }
491
492 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
493                    const unsigned char *tbs, size_t tbslen)
494 {
495     EVP_PKEY_CTX *pctx = ctx->pctx;
496
497     if (pctx != NULL
498             && pctx->operation == EVP_PKEY_OP_SIGNCTX
499             && pctx->op.sig.sigprovctx != NULL
500             && pctx->op.sig.signature != NULL) {
501         if (pctx->op.sig.signature->digest_sign != NULL)
502             return pctx->op.sig.signature->digest_sign(pctx->op.sig.sigprovctx,
503                                                        sigret, siglen, SIZE_MAX,
504                                                        tbs, tbslen);
505     } else {
506         /* legacy */
507         if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
508             return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
509     }
510
511     if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
512         return 0;
513     return EVP_DigestSignFinal(ctx, sigret, siglen);
514 }
515
516 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
517                           size_t siglen)
518 {
519     unsigned char md[EVP_MAX_MD_SIZE];
520     int r = 0;
521     unsigned int mdlen = 0;
522     int vctx = 0;
523     EVP_PKEY_CTX *pctx = ctx->pctx;
524
525     if (pctx == NULL
526             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
527             || pctx->op.sig.sigprovctx == NULL
528             || pctx->op.sig.signature == NULL)
529         goto legacy;
530
531     return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.sigprovctx,
532                                                        sig, siglen);
533
534  legacy:
535     if (pctx == NULL || pctx->pmeth == NULL) {
536         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
537         return 0;
538     }
539
540     /* do_sigver_init() checked that |digest_custom| is non-NULL */
541     if (pctx->flag_call_digest_custom
542         && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
543         return 0;
544     pctx->flag_call_digest_custom = 0;
545
546     if (pctx->pmeth->verifyctx != NULL)
547         vctx = 1;
548     else
549         vctx = 0;
550     if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
551         if (vctx)
552             r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
553         else
554             r = EVP_DigestFinal_ex(ctx, md, &mdlen);
555     } else {
556         EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
557         if (tmp_ctx == NULL)
558             return -1;
559         if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
560             EVP_MD_CTX_free(tmp_ctx);
561             return -1;
562         }
563         if (vctx)
564             r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
565                                                 sig, siglen, tmp_ctx);
566         else
567             r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
568         EVP_MD_CTX_free(tmp_ctx);
569     }
570     if (vctx || !r)
571         return r;
572     return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
573 }
574
575 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
576                      size_t siglen, const unsigned char *tbs, size_t tbslen)
577 {
578     EVP_PKEY_CTX *pctx = ctx->pctx;
579
580     if (pctx != NULL
581             && pctx->operation == EVP_PKEY_OP_VERIFYCTX
582             && pctx->op.sig.sigprovctx != NULL
583             && pctx->op.sig.signature != NULL) {
584         if (pctx->op.sig.signature->digest_verify != NULL)
585             return pctx->op.sig.signature->digest_verify(pctx->op.sig.sigprovctx,
586                                                          sigret, siglen,
587                                                          tbs, tbslen);
588     } else {
589         /* legacy */
590         if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
591             return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
592     }
593
594     if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
595         return -1;
596     return EVP_DigestVerifyFinal(ctx, sigret, siglen);
597 }
598 #endif /* FIPS_MODULE */