PROV: Fix the DSA SIGNATURE implementation for better digests handling
[openssl.git] / providers / implementations / signature / dsa.c
1 /*
2  * Copyright 2019 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 <string.h>
11
12 #include <openssl/crypto.h>
13 #include <openssl/core_numbers.h>
14 #include <openssl/core_names.h>
15 #include <openssl/err.h>
16 #include <openssl/dsa.h>
17 #include <openssl/params.h>
18 #include <openssl/evp.h>
19 #include <openssl/err.h>
20 #include "internal/nelem.h"
21 #include "internal/sizes.h"
22 #include "prov/providercommonerr.h"
23 #include "prov/implementations.h"
24 #include "prov/providercommonerr.h"
25 #include "prov/provider_ctx.h"
26 #include "crypto/dsa.h"
27
28 static OSSL_OP_signature_newctx_fn dsa_newctx;
29 static OSSL_OP_signature_sign_init_fn dsa_signature_init;
30 static OSSL_OP_signature_verify_init_fn dsa_signature_init;
31 static OSSL_OP_signature_sign_fn dsa_sign;
32 static OSSL_OP_signature_verify_fn dsa_verify;
33 static OSSL_OP_signature_digest_sign_init_fn dsa_digest_signverify_init;
34 static OSSL_OP_signature_digest_sign_update_fn dsa_digest_signverify_update;
35 static OSSL_OP_signature_digest_sign_final_fn dsa_digest_sign_final;
36 static OSSL_OP_signature_digest_verify_init_fn dsa_digest_signverify_init;
37 static OSSL_OP_signature_digest_verify_update_fn dsa_digest_signverify_update;
38 static OSSL_OP_signature_digest_verify_final_fn dsa_digest_verify_final;
39 static OSSL_OP_signature_freectx_fn dsa_freectx;
40 static OSSL_OP_signature_dupctx_fn dsa_dupctx;
41 static OSSL_OP_signature_get_ctx_params_fn dsa_get_ctx_params;
42 static OSSL_OP_signature_gettable_ctx_params_fn dsa_gettable_ctx_params;
43 static OSSL_OP_signature_set_ctx_params_fn dsa_set_ctx_params;
44 static OSSL_OP_signature_settable_ctx_params_fn dsa_settable_ctx_params;
45 static OSSL_OP_signature_get_ctx_md_params_fn dsa_get_ctx_md_params;
46 static OSSL_OP_signature_gettable_ctx_md_params_fn dsa_gettable_ctx_md_params;
47 static OSSL_OP_signature_set_ctx_md_params_fn dsa_set_ctx_md_params;
48 static OSSL_OP_signature_settable_ctx_md_params_fn dsa_settable_ctx_md_params;
49
50 /*
51  * What's passed as an actual key is defined by the KEYMGMT interface.
52  * We happen to know that our KEYMGMT simply passes DSA structures, so
53  * we use that here too.
54  */
55
56 typedef struct {
57     OPENSSL_CTX *libctx;
58     DSA *dsa;
59
60     /*
61      * Flag to determine if the hash function can be changed (1) or not (0)
62      * Because it's dangerous to change during a DigestSign or DigestVerify
63      * operation, this flag is cleared by their Init function, and set again
64      * by their Final function.
65      */
66     unsigned int flag_allow_md : 1;
67
68     char mdname[OSSL_MAX_NAME_SIZE];
69
70     /* The Algorithm Identifier of the combined signature agorithm */
71     unsigned char aid[OSSL_MAX_ALGORITHM_ID_SIZE];
72     size_t  aid_len;
73
74     /* main digest */
75     EVP_MD *md;
76     EVP_MD_CTX *mdctx;
77     size_t mdsize;
78 } PROV_DSA_CTX;
79
80 static size_t dsa_get_md_size(const PROV_DSA_CTX *pdsactx)
81 {
82     if (pdsactx->md != NULL)
83         return EVP_MD_size(pdsactx->md);
84     return 0;
85 }
86
87 static int dsa_get_md_nid(const EVP_MD *md)
88 {
89     /*
90      * Because the DSA library deals with NIDs, we need to translate.
91      * We do so using EVP_MD_is_a(), and therefore need a name to NID
92      * map.
93      */
94     static const OSSL_ITEM name_to_nid[] = {
95         { NID_sha1,   OSSL_DIGEST_NAME_SHA1   },
96         { NID_sha224, OSSL_DIGEST_NAME_SHA2_224 },
97         { NID_sha256, OSSL_DIGEST_NAME_SHA2_256 },
98         { NID_sha384, OSSL_DIGEST_NAME_SHA2_384 },
99         { NID_sha512, OSSL_DIGEST_NAME_SHA2_512 },
100         { NID_sha3_224, OSSL_DIGEST_NAME_SHA3_224 },
101         { NID_sha3_256, OSSL_DIGEST_NAME_SHA3_256 },
102         { NID_sha3_384, OSSL_DIGEST_NAME_SHA3_384 },
103         { NID_sha3_512, OSSL_DIGEST_NAME_SHA3_512 },
104     };
105     size_t i;
106     int mdnid = NID_undef;
107
108     if (md == NULL)
109         goto end;
110
111     for (i = 0; i < OSSL_NELEM(name_to_nid); i++) {
112         if (EVP_MD_is_a(md, name_to_nid[i].ptr)) {
113             mdnid = (int)name_to_nid[i].id;
114             break;
115         }
116     }
117
118     if (mdnid == NID_undef)
119         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST);
120
121  end:
122     return mdnid;
123 }
124
125 static void *dsa_newctx(void *provctx)
126 {
127     PROV_DSA_CTX *pdsactx = OPENSSL_zalloc(sizeof(PROV_DSA_CTX));
128
129     if (pdsactx == NULL)
130         return NULL;
131
132     pdsactx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
133     pdsactx->flag_allow_md = 1;
134     return pdsactx;
135 }
136
137 static int dsa_setup_md(PROV_DSA_CTX *ctx,
138                         const char *mdname, const char *mdprops)
139 {
140     if (mdname != NULL) {
141         EVP_MD *md = EVP_MD_fetch(ctx->libctx, mdname, mdprops);
142         int md_nid = dsa_get_md_nid(md);
143         size_t algorithmidentifier_len = 0;
144         const unsigned char *algorithmidentifier;
145
146         EVP_MD_free(ctx->md);
147         ctx->md = NULL;
148         ctx->mdname[0] = '\0';
149
150         algorithmidentifier =
151             dsa_algorithmidentifier_encoding(md_nid, &algorithmidentifier_len);
152
153         if (algorithmidentifier == NULL) {
154             EVP_MD_free(md);
155             return 0;
156         }
157
158         ctx->md = md;
159         OPENSSL_strlcpy(ctx->mdname, mdname, sizeof(ctx->mdname));
160     }
161     return 1;
162 }
163
164 static int dsa_signature_init(void *vpdsactx, void *vdsa)
165 {
166     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
167
168     if (pdsactx == NULL || vdsa == NULL || !DSA_up_ref(vdsa))
169         return 0;
170     DSA_free(pdsactx->dsa);
171     pdsactx->dsa = vdsa;
172     return 1;
173 }
174
175 static int dsa_sign(void *vpdsactx, unsigned char *sig, size_t *siglen,
176                     size_t sigsize, const unsigned char *tbs, size_t tbslen)
177 {
178     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
179     int ret;
180     unsigned int sltmp;
181     size_t dsasize = DSA_size(pdsactx->dsa);
182     size_t mdsize = dsa_get_md_size(pdsactx);
183
184     if (sig == NULL) {
185         *siglen = dsasize;
186         return 1;
187     }
188
189     if (sigsize < (size_t)dsasize)
190         return 0;
191
192     if (mdsize != 0 && tbslen != mdsize)
193         return 0;
194
195     ret = dsa_sign_int(pdsactx->libctx, 0, tbs, tbslen, sig, &sltmp,
196                        pdsactx->dsa);
197     if (ret <= 0)
198         return 0;
199
200     *siglen = sltmp;
201     return 1;
202 }
203
204 static int dsa_verify(void *vpdsactx, const unsigned char *sig, size_t siglen,
205                       const unsigned char *tbs, size_t tbslen)
206 {
207     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
208     size_t mdsize = dsa_get_md_size(pdsactx);
209
210     if (mdsize != 0 && tbslen != mdsize)
211         return 0;
212
213     return DSA_verify(0, tbs, tbslen, sig, siglen, pdsactx->dsa);
214 }
215
216 static int dsa_digest_signverify_init(void *vpdsactx, const char *mdname,
217                                       const char *props, void *vdsa)
218 {
219     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
220
221     pdsactx->flag_allow_md = 0;
222     if (!dsa_signature_init(vpdsactx, vdsa))
223         return 0;
224
225     if (!dsa_setup_md(pdsactx, mdname, props))
226         return 0;
227
228     pdsactx->mdctx = EVP_MD_CTX_new();
229     if (pdsactx->mdctx == NULL)
230         goto error;
231
232     if (!EVP_DigestInit_ex(pdsactx->mdctx, pdsactx->md, NULL))
233         goto error;
234
235     return 1;
236
237  error:
238     EVP_MD_CTX_free(pdsactx->mdctx);
239     EVP_MD_free(pdsactx->md);
240     pdsactx->mdctx = NULL;
241     pdsactx->md = NULL;
242     return 0;
243 }
244
245 int dsa_digest_signverify_update(void *vpdsactx, const unsigned char *data,
246                                  size_t datalen)
247 {
248     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
249
250     if (pdsactx == NULL || pdsactx->mdctx == NULL)
251         return 0;
252
253     return EVP_DigestUpdate(pdsactx->mdctx, data, datalen);
254 }
255
256 int dsa_digest_sign_final(void *vpdsactx, unsigned char *sig, size_t *siglen,
257                           size_t sigsize)
258 {
259     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
260     unsigned char digest[EVP_MAX_MD_SIZE];
261     unsigned int dlen = 0;
262
263     if (pdsactx == NULL || pdsactx->mdctx == NULL)
264         return 0;
265
266     /*
267      * If sig is NULL then we're just finding out the sig size. Other fields
268      * are ignored. Defer to dsa_sign.
269      */
270     if (sig != NULL) {
271         /*
272          * TODO(3.0): There is the possibility that some externally provided
273          * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
274          * but that problem is much larger than just in DSA.
275          */
276         if (!EVP_DigestFinal_ex(pdsactx->mdctx, digest, &dlen))
277             return 0;
278     }
279
280     pdsactx->flag_allow_md = 1;
281
282     return dsa_sign(vpdsactx, sig, siglen, sigsize, digest, (size_t)dlen);
283 }
284
285
286 int dsa_digest_verify_final(void *vpdsactx, const unsigned char *sig,
287                             size_t siglen)
288 {
289     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
290     unsigned char digest[EVP_MAX_MD_SIZE];
291     unsigned int dlen = 0;
292
293     if (pdsactx == NULL || pdsactx->mdctx == NULL)
294         return 0;
295
296     /*
297      * TODO(3.0): There is the possibility that some externally provided
298      * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
299      * but that problem is much larger than just in DSA.
300      */
301     if (!EVP_DigestFinal_ex(pdsactx->mdctx, digest, &dlen))
302         return 0;
303
304     pdsactx->flag_allow_md = 1;
305
306     return dsa_verify(vpdsactx, sig, siglen, digest, (size_t)dlen);
307 }
308
309 static void dsa_freectx(void *vpdsactx)
310 {
311     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
312
313     DSA_free(pdsactx->dsa);
314     EVP_MD_CTX_free(pdsactx->mdctx);
315     EVP_MD_free(pdsactx->md);
316
317     OPENSSL_free(pdsactx);
318 }
319
320 static void *dsa_dupctx(void *vpdsactx)
321 {
322     PROV_DSA_CTX *srcctx = (PROV_DSA_CTX *)vpdsactx;
323     PROV_DSA_CTX *dstctx;
324
325     dstctx = OPENSSL_zalloc(sizeof(*srcctx));
326     if (dstctx == NULL)
327         return NULL;
328
329     *dstctx = *srcctx;
330     dstctx->dsa = NULL;
331     dstctx->md = NULL;
332     dstctx->mdctx = NULL;
333
334     if (srcctx->dsa != NULL && !DSA_up_ref(srcctx->dsa))
335         goto err;
336     dstctx->dsa = srcctx->dsa;
337
338     if (srcctx->md != NULL && !EVP_MD_up_ref(srcctx->md))
339         goto err;
340     dstctx->md = srcctx->md;
341
342     if (srcctx->mdctx != NULL) {
343         dstctx->mdctx = EVP_MD_CTX_new();
344         if (dstctx->mdctx == NULL
345                 || !EVP_MD_CTX_copy_ex(dstctx->mdctx, srcctx->mdctx))
346             goto err;
347     }
348
349     return dstctx;
350  err:
351     dsa_freectx(dstctx);
352     return NULL;
353 }
354
355 static int dsa_get_ctx_params(void *vpdsactx, OSSL_PARAM *params)
356 {
357     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
358     OSSL_PARAM *p;
359
360     if (pdsactx == NULL || params == NULL)
361         return 0;
362
363     p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_ALGORITHM_ID);
364     if (p != NULL
365         && !OSSL_PARAM_set_octet_string(p, pdsactx->aid, pdsactx->aid_len))
366         return 0;
367
368     p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_DIGEST);
369     if (p != NULL && !OSSL_PARAM_set_utf8_string(p, pdsactx->mdname))
370         return 0;
371
372     return 1;
373 }
374
375 static const OSSL_PARAM known_gettable_ctx_params[] = {
376     OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID, NULL, 0),
377     OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
378     OSSL_PARAM_END
379 };
380
381 static const OSSL_PARAM *dsa_gettable_ctx_params(void)
382 {
383     return known_gettable_ctx_params;
384 }
385
386 static int dsa_set_ctx_params(void *vpdsactx, const OSSL_PARAM params[])
387 {
388     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
389     const OSSL_PARAM *p;
390
391     if (pdsactx == NULL || params == NULL)
392         return 0;
393
394     p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_DIGEST);
395     /* Not allowed during certain operations */
396     if (p != NULL && !pdsactx->flag_allow_md)
397         return 0;
398     if (p != NULL) {
399         char mdname[OSSL_MAX_NAME_SIZE] = "", *pmdname = mdname;
400         char mdprops[OSSL_MAX_PROPQUERY_SIZE] = "", *pmdprops = mdprops;
401         const OSSL_PARAM *propsp =
402             OSSL_PARAM_locate_const(params,
403                                     OSSL_SIGNATURE_PARAM_PROPERTIES);
404
405         if (!OSSL_PARAM_get_utf8_string(p, &pmdname, sizeof(mdname)))
406             return 0;
407         if (propsp != NULL
408             && !OSSL_PARAM_get_utf8_string(propsp, &pmdprops, sizeof(mdprops)))
409             return 0;
410         if (!dsa_setup_md(pdsactx, mdname, mdprops))
411             return 0;
412     }
413
414     return 1;
415 }
416
417 static const OSSL_PARAM known_settable_ctx_params[] = {
418     OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
419     OSSL_PARAM_END
420 };
421
422 static const OSSL_PARAM *dsa_settable_ctx_params(void)
423 {
424     /*
425      * TODO(3.0): Should this function return a different set of settable ctx
426      * params if the ctx is being used for a DigestSign/DigestVerify? In that
427      * case it is not allowed to set the digest size/digest name because the
428      * digest is explicitly set as part of the init.
429      */
430     return known_settable_ctx_params;
431 }
432
433 static int dsa_get_ctx_md_params(void *vpdsactx, OSSL_PARAM *params)
434 {
435     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
436
437     if (pdsactx->mdctx == NULL)
438         return 0;
439
440     return EVP_MD_CTX_get_params(pdsactx->mdctx, params);
441 }
442
443 static const OSSL_PARAM *dsa_gettable_ctx_md_params(void *vpdsactx)
444 {
445     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
446
447     if (pdsactx->md == NULL)
448         return 0;
449
450     return EVP_MD_gettable_ctx_params(pdsactx->md);
451 }
452
453 static int dsa_set_ctx_md_params(void *vpdsactx, const OSSL_PARAM params[])
454 {
455     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
456
457     if (pdsactx->mdctx == NULL)
458         return 0;
459
460     return EVP_MD_CTX_set_params(pdsactx->mdctx, params);
461 }
462
463 static const OSSL_PARAM *dsa_settable_ctx_md_params(void *vpdsactx)
464 {
465     PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
466
467     if (pdsactx->md == NULL)
468         return 0;
469
470     return EVP_MD_settable_ctx_params(pdsactx->md);
471 }
472
473 const OSSL_DISPATCH dsa_signature_functions[] = {
474     { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))dsa_newctx },
475     { OSSL_FUNC_SIGNATURE_SIGN_INIT, (void (*)(void))dsa_signature_init },
476     { OSSL_FUNC_SIGNATURE_SIGN, (void (*)(void))dsa_sign },
477     { OSSL_FUNC_SIGNATURE_VERIFY_INIT, (void (*)(void))dsa_signature_init },
478     { OSSL_FUNC_SIGNATURE_VERIFY, (void (*)(void))dsa_verify },
479     { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,
480       (void (*)(void))dsa_digest_signverify_init },
481     { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE,
482       (void (*)(void))dsa_digest_signverify_update },
483     { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL,
484       (void (*)(void))dsa_digest_sign_final },
485     { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,
486       (void (*)(void))dsa_digest_signverify_init },
487     { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE,
488       (void (*)(void))dsa_digest_signverify_update },
489     { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL,
490       (void (*)(void))dsa_digest_verify_final },
491     { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))dsa_freectx },
492     { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))dsa_dupctx },
493     { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS, (void (*)(void))dsa_get_ctx_params },
494     { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,
495       (void (*)(void))dsa_gettable_ctx_params },
496     { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS, (void (*)(void))dsa_set_ctx_params },
497     { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS,
498       (void (*)(void))dsa_settable_ctx_params },
499     { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS,
500       (void (*)(void))dsa_get_ctx_md_params },
501     { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS,
502       (void (*)(void))dsa_gettable_ctx_md_params },
503     { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS,
504       (void (*)(void))dsa_set_ctx_md_params },
505     { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS,
506       (void (*)(void))dsa_settable_ctx_md_params },
507     { 0, NULL }
508 };