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