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