EVP: clear error when falling back from failed EVP_KEYMGMT_fetch()
[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 static int do_sigver_init(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
28                           const EVP_MD *type, const char *mdname,
29                           const char *props, ENGINE *e, EVP_PKEY *pkey,
30                           int ver)
31 {
32     EVP_PKEY_CTX *locpctx = NULL;
33     EVP_SIGNATURE *signature = NULL;
34     EVP_KEYMGMT *tmp_keymgmt = NULL;
35     const char *supported_sig = NULL;
36     void *provkey = NULL;
37     int ret;
38
39     if (ctx->provctx != NULL) {
40         if (!ossl_assert(ctx->digest != NULL)) {
41             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
42             return 0;
43         }
44         if (ctx->digest->freectx != NULL)
45             ctx->digest->freectx(ctx->provctx);
46         ctx->provctx = NULL;
47     }
48
49     if (ctx->pctx == NULL)
50         ctx->pctx = EVP_PKEY_CTX_new(pkey, e);
51     if (ctx->pctx == NULL)
52         return 0;
53
54     locpctx = ctx->pctx;
55     evp_pkey_ctx_free_old_ops(locpctx);
56
57     /*
58      * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark()
59      * calls can be removed.
60      */
61     ERR_set_mark();
62
63     if (locpctx->keytype == NULL)
64         goto legacy;
65
66     if (mdname == NULL) {
67         if (type != NULL) {
68             mdname = EVP_MD_name(type);
69         } else if (pkey != NULL) {
70             /*
71              * TODO(v3.0) work out a better way for EVP_PKEYs with no legacy
72              * component.
73              */
74             if (pkey->pkey.ptr != NULL) {
75                 int def_nid;
76                 if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
77                     mdname = OBJ_nid2sn(def_nid);
78             }
79         }
80     }
81
82     /* Ensure that the key is provided.  If not, go legacy */
83     tmp_keymgmt = locpctx->keymgmt;
84     provkey = evp_pkey_make_provided(locpctx->pkey, locpctx->libctx,
85                                      &tmp_keymgmt, locpctx->propquery, 0);
86     if (provkey == NULL)
87         goto legacy;
88     if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
89         ERR_clear_last_mark();
90         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
91         goto err;
92     }
93     EVP_KEYMGMT_free(locpctx->keymgmt);
94     locpctx->keymgmt = tmp_keymgmt;
95
96     if (locpctx->keymgmt->query_operation_name != NULL)
97         supported_sig =
98             locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
99
100     /*
101      * If we didn't get a supported sig, assume there is one with the
102      * same name as the key type.
103      */
104     if (supported_sig == NULL)
105         supported_sig = locpctx->keytype;
106
107     /*
108      * Because we cleared out old ops, we shouldn't need to worry about
109      * checking if signature is already there.
110      */
111     signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
112                                     locpctx->propquery);
113
114     if (signature == NULL
115         || (EVP_KEYMGMT_provider(locpctx->keymgmt)
116             != EVP_SIGNATURE_provider(signature))) {
117         /*
118          * We don't need to free ctx->keymgmt here, as it's not necessarily
119          * tied to this operation.  It will be freed by EVP_PKEY_CTX_free().
120          */
121         EVP_SIGNATURE_free(signature);
122         goto legacy;
123     }
124
125     /*
126      * TODO remove this when legacy is gone
127      * If we don't have the full support we need with provided methods,
128      * let's go see if legacy does.
129      */
130     ERR_pop_to_mark();
131
132     /* No more legacy from here down to legacy: */
133
134     locpctx->op.sig.signature = signature;
135     locpctx->operation = ver ? EVP_PKEY_OP_VERIFYCTX
136                              : EVP_PKEY_OP_SIGNCTX;
137     locpctx->op.sig.sigprovctx
138         = signature->newctx(ossl_provider_ctx(signature->prov));
139     if (locpctx->op.sig.sigprovctx == NULL) {
140         ERR_raise(ERR_LIB_EVP,  EVP_R_INITIALIZATION_ERROR);
141         goto err;
142     }
143     if (type != NULL) {
144         ctx->reqdigest = type;
145     } else {
146         /*
147          * This might be requested by a later call to EVP_MD_CTX_md(). In that
148          * case the "explicit fetch" rules apply for that function (as per
149          * man pages), i.e. the ref count is not updated so the EVP_MD should
150          * not be used beyound the lifetime of the EVP_MD_CTX.
151          */
152         ctx->reqdigest = ctx->fetched_digest =
153             EVP_MD_fetch(locpctx->libctx, mdname, props);
154     }
155
156     if (ver) {
157         if (signature->digest_verify_init == NULL) {
158             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
159             goto err;
160         }
161         ret = signature->digest_verify_init(locpctx->op.sig.sigprovctx,
162                                             mdname, props, provkey);
163     } else {
164         if (signature->digest_sign_init == NULL) {
165             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
166             goto err;
167         }
168         ret = signature->digest_sign_init(locpctx->op.sig.sigprovctx,
169                                           mdname, props, provkey);
170     }
171
172     return ret ? 1 : 0;
173  err:
174     evp_pkey_ctx_free_old_ops(locpctx);
175     locpctx->operation = EVP_PKEY_OP_UNDEFINED;
176     return 0;
177
178  legacy:
179     /*
180      * TODO remove this when legacy is gone
181      * If we don't have the full support we need with provided methods,
182      * let's go see if legacy does.
183      */
184     ERR_pop_to_mark();
185
186     if (ctx->pctx->pmeth == NULL) {
187         EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
188         return 0;
189     }
190
191     if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
192
193         if (type == NULL) {
194             int def_nid;
195             if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
196                 type = EVP_get_digestbynid(def_nid);
197         }
198
199         if (type == NULL) {
200             EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
201             return 0;
202         }
203     }
204
205     if (ver) {
206         if (ctx->pctx->pmeth->verifyctx_init) {
207             if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
208                 return 0;
209             ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
210         } else if (ctx->pctx->pmeth->digestverify != 0) {
211             ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
212             ctx->update = update;
213         } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
214             return 0;
215         }
216     } else {
217         if (ctx->pctx->pmeth->signctx_init) {
218             if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
219                 return 0;
220             ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
221         } else if (ctx->pctx->pmeth->digestsign != 0) {
222             ctx->pctx->operation = EVP_PKEY_OP_SIGN;
223             ctx->update = update;
224         } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
225             return 0;
226         }
227     }
228     if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
229         return 0;
230     if (pctx)
231         *pctx = ctx->pctx;
232     if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
233         return 1;
234     if (!EVP_DigestInit_ex(ctx, type, e))
235         return 0;
236     /*
237      * This indicates the current algorithm requires
238      * special treatment before hashing the tbs-message.
239      */
240     if (ctx->pctx->pmeth->digest_custom != NULL)
241         return ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx);
242
243     return 1;
244 }
245
246 int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
247                           const char *mdname, const char *props, EVP_PKEY *pkey)
248 {
249     return do_sigver_init(ctx, pctx, NULL, mdname, props, NULL, pkey, 0);
250 }
251
252 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
253                        const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
254 {
255     return do_sigver_init(ctx, pctx, type, NULL, NULL, e, pkey, 0);
256 }
257
258 int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
259                             const char *mdname, const char *props,
260                             EVP_PKEY *pkey)
261 {
262     return do_sigver_init(ctx, pctx, NULL, mdname, props, NULL, pkey, 1);
263 }
264
265 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
266                          const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
267 {
268     return do_sigver_init(ctx, pctx, type, NULL, NULL, e, pkey, 1);
269 }
270 #endif /* FIPS_MDOE */
271
272 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
273 {
274     EVP_PKEY_CTX *pctx = ctx->pctx;
275
276     if (pctx == NULL
277             || pctx->operation != EVP_PKEY_OP_SIGNCTX
278             || pctx->op.sig.sigprovctx == NULL
279             || pctx->op.sig.signature == NULL)
280         goto legacy;
281
282     return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.sigprovctx,
283                                                       data, dsize);
284
285  legacy:
286     return EVP_DigestUpdate(ctx, data, dsize);
287 }
288
289 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
290 {
291     EVP_PKEY_CTX *pctx = ctx->pctx;
292
293     if (pctx == NULL
294             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
295             || pctx->op.sig.sigprovctx == NULL
296             || pctx->op.sig.signature == NULL)
297         goto legacy;
298
299     return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.sigprovctx,
300                                                         data, dsize);
301
302  legacy:
303     return EVP_DigestUpdate(ctx, data, dsize);
304 }
305
306 #ifndef FIPS_MODE
307 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
308                         size_t *siglen)
309 {
310     int sctx = 0, r = 0;
311     EVP_PKEY_CTX *pctx = ctx->pctx;
312
313     if (pctx == NULL
314             || pctx->operation != EVP_PKEY_OP_SIGNCTX
315             || pctx->op.sig.sigprovctx == NULL
316             || pctx->op.sig.signature == NULL)
317         goto legacy;
318
319     return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.sigprovctx,
320                                                      sigret, siglen, SIZE_MAX);
321
322  legacy:
323     if (pctx == NULL || pctx->pmeth == NULL) {
324         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
325         return 0;
326     }
327
328     if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
329         if (sigret == NULL)
330             return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
331         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
332             r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
333         else {
334             EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
335
336             if (dctx == NULL)
337                 return 0;
338             r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
339             EVP_PKEY_CTX_free(dctx);
340         }
341         return r;
342     }
343     if (pctx->pmeth->signctx != NULL)
344         sctx = 1;
345     else
346         sctx = 0;
347     if (sigret != NULL) {
348         unsigned char md[EVP_MAX_MD_SIZE];
349         unsigned int mdlen = 0;
350
351         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
352             if (sctx)
353                 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
354             else
355                 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
356         } else {
357             EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
358
359             if (tmp_ctx == NULL)
360                 return 0;
361             if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
362                 EVP_MD_CTX_free(tmp_ctx);
363                 return 0;
364             }
365             if (sctx)
366                 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
367                                                   sigret, siglen, tmp_ctx);
368             else
369                 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
370             EVP_MD_CTX_free(tmp_ctx);
371         }
372         if (sctx || !r)
373             return r;
374         if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
375             return 0;
376     } else {
377         if (sctx) {
378             if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
379                 return 0;
380         } else {
381             int s = EVP_MD_size(ctx->digest);
382
383             if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
384                 return 0;
385         }
386     }
387     return 1;
388 }
389
390 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
391                    const unsigned char *tbs, size_t tbslen)
392 {
393     if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
394         return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
395     if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
396         return 0;
397     return EVP_DigestSignFinal(ctx, sigret, siglen);
398 }
399
400 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
401                           size_t siglen)
402 {
403     unsigned char md[EVP_MAX_MD_SIZE];
404     int r = 0;
405     unsigned int mdlen = 0;
406     int vctx = 0;
407     EVP_PKEY_CTX *pctx = ctx->pctx;
408
409     if (pctx == NULL
410             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
411             || pctx->op.sig.sigprovctx == NULL
412             || pctx->op.sig.signature == NULL)
413         goto legacy;
414
415     return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.sigprovctx,
416                                                        sig, siglen);
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     if (pctx->pmeth->verifyctx != NULL)
425         vctx = 1;
426     else
427         vctx = 0;
428     if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
429         if (vctx)
430             r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
431         else
432             r = EVP_DigestFinal_ex(ctx, md, &mdlen);
433     } else {
434         EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
435         if (tmp_ctx == NULL)
436             return -1;
437         if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
438             EVP_MD_CTX_free(tmp_ctx);
439             return -1;
440         }
441         if (vctx)
442             r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
443                                                 sig, siglen, tmp_ctx);
444         else
445             r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
446         EVP_MD_CTX_free(tmp_ctx);
447     }
448     if (vctx || !r)
449         return r;
450     return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
451 }
452
453 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
454                      size_t siglen, const unsigned char *tbs, size_t tbslen)
455 {
456     if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
457         return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
458     if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
459         return -1;
460     return EVP_DigestVerifyFinal(ctx, sigret, siglen);
461 }
462 #endif /* FIPS_MODE */