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