2 * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
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
11 * DSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
18 #include <openssl/crypto.h>
19 #include <openssl/core_dispatch.h>
20 #include <openssl/core_names.h>
21 #include <openssl/err.h>
22 #include <openssl/dsa.h>
23 #include <openssl/params.h>
24 #include <openssl/evp.h>
25 #include <openssl/err.h>
26 #include "internal/nelem.h"
27 #include "internal/sizes.h"
28 #include "internal/cryptlib.h"
29 #include "prov/providercommon.h"
30 #include "prov/implementations.h"
31 #include "prov/providercommonerr.h"
32 #include "prov/provider_ctx.h"
33 #include "prov/securitycheck.h"
34 #include "crypto/dsa.h"
35 #include "prov/der_dsa.h"
37 static OSSL_FUNC_signature_newctx_fn dsa_newctx;
38 static OSSL_FUNC_signature_sign_init_fn dsa_sign_init;
39 static OSSL_FUNC_signature_verify_init_fn dsa_verify_init;
40 static OSSL_FUNC_signature_sign_fn dsa_sign;
41 static OSSL_FUNC_signature_verify_fn dsa_verify;
42 static OSSL_FUNC_signature_digest_sign_init_fn dsa_digest_sign_init;
43 static OSSL_FUNC_signature_digest_sign_update_fn dsa_digest_signverify_update;
44 static OSSL_FUNC_signature_digest_sign_final_fn dsa_digest_sign_final;
45 static OSSL_FUNC_signature_digest_verify_init_fn dsa_digest_verify_init;
46 static OSSL_FUNC_signature_digest_verify_update_fn dsa_digest_signverify_update;
47 static OSSL_FUNC_signature_digest_verify_final_fn dsa_digest_verify_final;
48 static OSSL_FUNC_signature_freectx_fn dsa_freectx;
49 static OSSL_FUNC_signature_dupctx_fn dsa_dupctx;
50 static OSSL_FUNC_signature_get_ctx_params_fn dsa_get_ctx_params;
51 static OSSL_FUNC_signature_gettable_ctx_params_fn dsa_gettable_ctx_params;
52 static OSSL_FUNC_signature_set_ctx_params_fn dsa_set_ctx_params;
53 static OSSL_FUNC_signature_settable_ctx_params_fn dsa_settable_ctx_params;
54 static OSSL_FUNC_signature_get_ctx_md_params_fn dsa_get_ctx_md_params;
55 static OSSL_FUNC_signature_gettable_ctx_md_params_fn dsa_gettable_ctx_md_params;
56 static OSSL_FUNC_signature_set_ctx_md_params_fn dsa_set_ctx_md_params;
57 static OSSL_FUNC_signature_settable_ctx_md_params_fn dsa_settable_ctx_md_params;
60 * What's passed as an actual key is defined by the KEYMGMT interface.
61 * We happen to know that our KEYMGMT simply passes DSA structures, so
62 * we use that here too.
71 * Flag to determine if the hash function can be changed (1) or not (0)
72 * Because it's dangerous to change during a DigestSign or DigestVerify
73 * operation, this flag is cleared by their Init function, and set again
74 * by their Final function.
76 unsigned int flag_allow_md : 1;
78 char mdname[OSSL_MAX_NAME_SIZE];
80 /* The Algorithm Identifier of the combined signature algorithm */
81 unsigned char aid_buf[OSSL_MAX_ALGORITHM_ID_SIZE];
92 static size_t dsa_get_md_size(const PROV_DSA_CTX *pdsactx)
94 if (pdsactx->md != NULL)
95 return EVP_MD_size(pdsactx->md);
99 static void *dsa_newctx(void *provctx, const char *propq)
101 PROV_DSA_CTX *pdsactx;
103 if (!ossl_prov_is_running())
106 pdsactx = OPENSSL_zalloc(sizeof(PROV_DSA_CTX));
110 pdsactx->libctx = PROV_LIBCTX_OF(provctx);
111 pdsactx->flag_allow_md = 1;
112 if (propq != NULL && (pdsactx->propq = OPENSSL_strdup(propq)) == NULL) {
113 OPENSSL_free(pdsactx);
115 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
120 static int dsa_setup_md(PROV_DSA_CTX *ctx,
121 const char *mdname, const char *mdprops)
124 mdprops = ctx->propq;
126 if (mdname != NULL) {
127 int sha1_allowed = (ctx->operation != EVP_PKEY_OP_SIGN);
129 EVP_MD *md = EVP_MD_fetch(ctx->libctx, mdname, mdprops);
130 int md_nid = digest_get_approved_nid_with_sha1(md, sha1_allowed);
131 size_t mdname_len = strlen(mdname);
133 if (md == NULL || md_nid == NID_undef) {
135 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
136 "%s could not be fetched", mdname);
137 if (md_nid == NID_undef)
138 ERR_raise_data(ERR_LIB_PROV, PROV_R_DIGEST_NOT_ALLOWED,
139 "digest=%s", mdname);
140 if (mdname_len >= sizeof(ctx->mdname))
141 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
142 "%s exceeds name buffer length", mdname);
147 EVP_MD_CTX_free(ctx->mdctx);
148 EVP_MD_free(ctx->md);
151 * TODO(3.0) Should we care about DER writing errors?
152 * All it really means is that for some reason, there's no
153 * AlgorithmIdentifier to be had, but the operation itself is
154 * still valid, just as long as it's not used to construct
155 * anything that needs an AlgorithmIdentifier.
158 if (WPACKET_init_der(&pkt, ctx->aid_buf, sizeof(ctx->aid_buf))
159 && ossl_DER_w_algorithmIdentifier_DSA_with_MD(&pkt, -1, ctx->dsa,
161 && WPACKET_finish(&pkt)) {
162 WPACKET_get_total_written(&pkt, &ctx->aid_len);
163 ctx->aid = WPACKET_get_curr(&pkt);
165 WPACKET_cleanup(&pkt);
169 OPENSSL_strlcpy(ctx->mdname, mdname, sizeof(ctx->mdname));
174 static int dsa_signverify_init(void *vpdsactx, void *vdsa, int operation)
176 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
178 if (!ossl_prov_is_running()
181 || !DSA_up_ref(vdsa))
183 DSA_free(pdsactx->dsa);
185 pdsactx->operation = operation;
186 if (!dsa_check_key(vdsa, operation == EVP_PKEY_OP_SIGN)) {
187 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
193 static int dsa_sign_init(void *vpdsactx, void *vdsa)
195 return dsa_signverify_init(vpdsactx, vdsa, EVP_PKEY_OP_SIGN);
198 static int dsa_verify_init(void *vpdsactx, void *vdsa)
200 return dsa_signverify_init(vpdsactx, vdsa, EVP_PKEY_OP_VERIFY);
203 static int dsa_sign(void *vpdsactx, unsigned char *sig, size_t *siglen,
204 size_t sigsize, const unsigned char *tbs, size_t tbslen)
206 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
209 size_t dsasize = DSA_size(pdsactx->dsa);
210 size_t mdsize = dsa_get_md_size(pdsactx);
212 if (!ossl_prov_is_running())
220 if (sigsize < (size_t)dsasize)
223 if (mdsize != 0 && tbslen != mdsize)
226 ret = dsa_sign_int(0, tbs, tbslen, sig, &sltmp, pdsactx->dsa);
234 static int dsa_verify(void *vpdsactx, const unsigned char *sig, size_t siglen,
235 const unsigned char *tbs, size_t tbslen)
237 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
238 size_t mdsize = dsa_get_md_size(pdsactx);
240 if (!ossl_prov_is_running() || (mdsize != 0 && tbslen != mdsize))
243 return DSA_verify(0, tbs, tbslen, sig, siglen, pdsactx->dsa);
246 static int dsa_digest_signverify_init(void *vpdsactx, const char *mdname,
247 void *vdsa, int operation)
249 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
251 if (!ossl_prov_is_running())
254 pdsactx->flag_allow_md = 0;
255 if (!dsa_signverify_init(vpdsactx, vdsa, operation))
258 if (!dsa_setup_md(pdsactx, mdname, NULL))
261 pdsactx->mdctx = EVP_MD_CTX_new();
262 if (pdsactx->mdctx == NULL)
265 if (!EVP_DigestInit_ex(pdsactx->mdctx, pdsactx->md, NULL))
271 EVP_MD_CTX_free(pdsactx->mdctx);
272 EVP_MD_free(pdsactx->md);
273 pdsactx->mdctx = NULL;
278 static int dsa_digest_sign_init(void *vpdsactx, const char *mdname,
281 return dsa_digest_signverify_init(vpdsactx, mdname, vdsa, EVP_PKEY_OP_SIGN);
284 static int dsa_digest_verify_init(void *vpdsactx, const char *mdname, void *vdsa)
286 return dsa_digest_signverify_init(vpdsactx, mdname, vdsa, EVP_PKEY_OP_VERIFY);
289 int dsa_digest_signverify_update(void *vpdsactx, const unsigned char *data,
292 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
294 if (pdsactx == NULL || pdsactx->mdctx == NULL)
297 return EVP_DigestUpdate(pdsactx->mdctx, data, datalen);
300 int dsa_digest_sign_final(void *vpdsactx, unsigned char *sig, size_t *siglen,
303 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
304 unsigned char digest[EVP_MAX_MD_SIZE];
305 unsigned int dlen = 0;
307 if (!ossl_prov_is_running() || pdsactx == NULL || pdsactx->mdctx == NULL)
311 * If sig is NULL then we're just finding out the sig size. Other fields
312 * are ignored. Defer to dsa_sign.
316 * TODO(3.0): There is the possibility that some externally provided
317 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
318 * but that problem is much larger than just in DSA.
320 if (!EVP_DigestFinal_ex(pdsactx->mdctx, digest, &dlen))
324 pdsactx->flag_allow_md = 1;
326 return dsa_sign(vpdsactx, sig, siglen, sigsize, digest, (size_t)dlen);
330 int dsa_digest_verify_final(void *vpdsactx, const unsigned char *sig,
333 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
334 unsigned char digest[EVP_MAX_MD_SIZE];
335 unsigned int dlen = 0;
337 if (!ossl_prov_is_running() || pdsactx == NULL || pdsactx->mdctx == NULL)
341 * TODO(3.0): There is the possibility that some externally provided
342 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
343 * but that problem is much larger than just in DSA.
345 if (!EVP_DigestFinal_ex(pdsactx->mdctx, digest, &dlen))
348 pdsactx->flag_allow_md = 1;
350 return dsa_verify(vpdsactx, sig, siglen, digest, (size_t)dlen);
353 static void dsa_freectx(void *vpdsactx)
355 PROV_DSA_CTX *ctx = (PROV_DSA_CTX *)vpdsactx;
357 OPENSSL_free(ctx->propq);
358 EVP_MD_CTX_free(ctx->mdctx);
359 EVP_MD_free(ctx->md);
367 static void *dsa_dupctx(void *vpdsactx)
369 PROV_DSA_CTX *srcctx = (PROV_DSA_CTX *)vpdsactx;
370 PROV_DSA_CTX *dstctx;
372 if (!ossl_prov_is_running())
375 dstctx = OPENSSL_zalloc(sizeof(*srcctx));
382 dstctx->mdctx = NULL;
383 dstctx->propq = NULL;
385 if (srcctx->dsa != NULL && !DSA_up_ref(srcctx->dsa))
387 dstctx->dsa = srcctx->dsa;
389 if (srcctx->md != NULL && !EVP_MD_up_ref(srcctx->md))
391 dstctx->md = srcctx->md;
393 if (srcctx->mdctx != NULL) {
394 dstctx->mdctx = EVP_MD_CTX_new();
395 if (dstctx->mdctx == NULL
396 || !EVP_MD_CTX_copy_ex(dstctx->mdctx, srcctx->mdctx))
399 if (srcctx->propq != NULL) {
400 dstctx->propq = OPENSSL_strdup(srcctx->propq);
401 if (dstctx->propq == NULL)
411 static int dsa_get_ctx_params(void *vpdsactx, OSSL_PARAM *params)
413 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
416 if (pdsactx == NULL || params == NULL)
419 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_ALGORITHM_ID);
421 && !OSSL_PARAM_set_octet_string(p, pdsactx->aid, pdsactx->aid_len))
424 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_DIGEST);
425 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, pdsactx->mdname))
431 static const OSSL_PARAM known_gettable_ctx_params[] = {
432 OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID, NULL, 0),
433 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
437 static const OSSL_PARAM *dsa_gettable_ctx_params(ossl_unused void *vctx)
439 return known_gettable_ctx_params;
442 static int dsa_set_ctx_params(void *vpdsactx, const OSSL_PARAM params[])
444 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
447 if (pdsactx == NULL || params == NULL)
450 p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_DIGEST);
451 /* Not allowed during certain operations */
452 if (p != NULL && !pdsactx->flag_allow_md)
455 char mdname[OSSL_MAX_NAME_SIZE] = "", *pmdname = mdname;
456 char mdprops[OSSL_MAX_PROPQUERY_SIZE] = "", *pmdprops = mdprops;
457 const OSSL_PARAM *propsp =
458 OSSL_PARAM_locate_const(params,
459 OSSL_SIGNATURE_PARAM_PROPERTIES);
461 if (!OSSL_PARAM_get_utf8_string(p, &pmdname, sizeof(mdname)))
464 && !OSSL_PARAM_get_utf8_string(propsp, &pmdprops, sizeof(mdprops)))
466 if (!dsa_setup_md(pdsactx, mdname, mdprops))
473 static const OSSL_PARAM known_settable_ctx_params[] = {
474 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
475 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_PROPERTIES, NULL, 0),
479 static const OSSL_PARAM *dsa_settable_ctx_params(ossl_unused void *provctx)
482 * TODO(3.0): Should this function return a different set of settable ctx
483 * params if the ctx is being used for a DigestSign/DigestVerify? In that
484 * case it is not allowed to set the digest size/digest name because the
485 * digest is explicitly set as part of the init.
486 * NOTE: Ideally we would check pdsactx->flag_allow_md, but this is
487 * problematic because there is no nice way of passing the
488 * PROV_DSA_CTX down to this function...
489 * Because we have API's that dont know about their parent..
490 * e.g: EVP_SIGNATURE_gettable_ctx_params(const EVP_SIGNATURE *sig).
491 * We could pass NULL for that case (but then how useful is the check?).
493 return known_settable_ctx_params;
496 static int dsa_get_ctx_md_params(void *vpdsactx, OSSL_PARAM *params)
498 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
500 if (pdsactx->mdctx == NULL)
503 return EVP_MD_CTX_get_params(pdsactx->mdctx, params);
506 static const OSSL_PARAM *dsa_gettable_ctx_md_params(void *vpdsactx)
508 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
510 if (pdsactx->md == NULL)
513 return EVP_MD_gettable_ctx_params(pdsactx->md);
516 static int dsa_set_ctx_md_params(void *vpdsactx, const OSSL_PARAM params[])
518 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
520 if (pdsactx->mdctx == NULL)
523 return EVP_MD_CTX_set_params(pdsactx->mdctx, params);
526 static const OSSL_PARAM *dsa_settable_ctx_md_params(void *vpdsactx)
528 PROV_DSA_CTX *pdsactx = (PROV_DSA_CTX *)vpdsactx;
530 if (pdsactx->md == NULL)
533 return EVP_MD_settable_ctx_params(pdsactx->md);
536 const OSSL_DISPATCH ossl_dsa_signature_functions[] = {
537 { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))dsa_newctx },
538 { OSSL_FUNC_SIGNATURE_SIGN_INIT, (void (*)(void))dsa_sign_init },
539 { OSSL_FUNC_SIGNATURE_SIGN, (void (*)(void))dsa_sign },
540 { OSSL_FUNC_SIGNATURE_VERIFY_INIT, (void (*)(void))dsa_verify_init },
541 { OSSL_FUNC_SIGNATURE_VERIFY, (void (*)(void))dsa_verify },
542 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,
543 (void (*)(void))dsa_digest_sign_init },
544 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE,
545 (void (*)(void))dsa_digest_signverify_update },
546 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL,
547 (void (*)(void))dsa_digest_sign_final },
548 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,
549 (void (*)(void))dsa_digest_verify_init },
550 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE,
551 (void (*)(void))dsa_digest_signverify_update },
552 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL,
553 (void (*)(void))dsa_digest_verify_final },
554 { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))dsa_freectx },
555 { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))dsa_dupctx },
556 { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS, (void (*)(void))dsa_get_ctx_params },
557 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,
558 (void (*)(void))dsa_gettable_ctx_params },
559 { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS, (void (*)(void))dsa_set_ctx_params },
560 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS,
561 (void (*)(void))dsa_settable_ctx_params },
562 { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS,
563 (void (*)(void))dsa_get_ctx_md_params },
564 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS,
565 (void (*)(void))dsa_gettable_ctx_md_params },
566 { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS,
567 (void (*)(void))dsa_set_ctx_md_params },
568 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS,
569 (void (*)(void))dsa_settable_ctx_md_params },