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
];
93 static size_t dsa_get_md_size(const PROV_DSA_CTX
*pdsactx
)
95 if (pdsactx
->md
!= NULL
)
96 return EVP_MD_size(pdsactx
->md
);
100 static void *dsa_newctx(void *provctx
, const char *propq
)
102 PROV_DSA_CTX
*pdsactx
;
104 if (!ossl_prov_is_running())
107 pdsactx
= OPENSSL_zalloc(sizeof(PROV_DSA_CTX
));
111 pdsactx
->libctx
= PROV_LIBRARY_CONTEXT_OF(provctx
);
112 pdsactx
->flag_allow_md
= 1;
113 if (propq
!= NULL
&& (pdsactx
->propq
= OPENSSL_strdup(propq
)) == NULL
) {
114 OPENSSL_free(pdsactx
);
116 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
121 static int dsa_setup_md(PROV_DSA_CTX
*ctx
,
122 const char *mdname
, const char *mdprops
)
125 mdprops
= ctx
->propq
;
127 if (mdname
!= NULL
) {
128 int sha1_allowed
= (ctx
->operation
!= EVP_PKEY_OP_SIGN
);
130 EVP_MD
*md
= EVP_MD_fetch(ctx
->libctx
, mdname
, mdprops
);
131 int md_nid
= digest_get_approved_nid_with_sha1(md
, sha1_allowed
);
132 size_t mdname_len
= strlen(mdname
);
134 if (md
== NULL
|| md_nid
== NID_undef
) {
136 ERR_raise_data(ERR_LIB_PROV
, PROV_R_INVALID_DIGEST
,
137 "%s could not be fetched", mdname
);
138 if (md_nid
== NID_undef
)
139 ERR_raise_data(ERR_LIB_PROV
, PROV_R_DIGEST_NOT_ALLOWED
,
140 "digest=%s", mdname
);
141 if (mdname_len
>= sizeof(ctx
->mdname
))
142 ERR_raise_data(ERR_LIB_PROV
, PROV_R_INVALID_DIGEST
,
143 "%s exceeds name buffer length", mdname
);
148 EVP_MD_CTX_free(ctx
->mdctx
);
149 EVP_MD_free(ctx
->md
);
152 * TODO(3.0) Should we care about DER writing errors?
153 * All it really means is that for some reason, there's no
154 * AlgorithmIdentifier to be had, but the operation itself is
155 * still valid, just as long as it's not used to construct
156 * anything that needs an AlgorithmIdentifier.
159 if (WPACKET_init_der(&pkt
, ctx
->aid_buf
, sizeof(ctx
->aid_buf
))
160 && ossl_DER_w_algorithmIdentifier_DSA_with_MD(&pkt
, -1, ctx
->dsa
,
162 && WPACKET_finish(&pkt
)) {
163 WPACKET_get_total_written(&pkt
, &ctx
->aid_len
);
164 ctx
->aid
= WPACKET_get_curr(&pkt
);
166 WPACKET_cleanup(&pkt
);
170 OPENSSL_strlcpy(ctx
->mdname
, mdname
, sizeof(ctx
->mdname
));
175 static int dsa_signverify_init(void *vpdsactx
, void *vdsa
, int operation
)
177 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
179 if (!ossl_prov_is_running()
182 || !DSA_up_ref(vdsa
))
184 DSA_free(pdsactx
->dsa
);
186 pdsactx
->operation
= operation
;
187 if (!dsa_check_key(vdsa
, operation
== EVP_PKEY_OP_SIGN
)) {
188 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY_LENGTH
);
194 static int dsa_sign_init(void *vpdsactx
, void *vdsa
)
196 return dsa_signverify_init(vpdsactx
, vdsa
, EVP_PKEY_OP_SIGN
);
199 static int dsa_verify_init(void *vpdsactx
, void *vdsa
)
201 return dsa_signverify_init(vpdsactx
, vdsa
, EVP_PKEY_OP_VERIFY
);
204 static int dsa_sign(void *vpdsactx
, unsigned char *sig
, size_t *siglen
,
205 size_t sigsize
, const unsigned char *tbs
, size_t tbslen
)
207 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
210 size_t dsasize
= DSA_size(pdsactx
->dsa
);
211 size_t mdsize
= dsa_get_md_size(pdsactx
);
213 if (!ossl_prov_is_running())
221 if (sigsize
< (size_t)dsasize
)
224 if (mdsize
!= 0 && tbslen
!= mdsize
)
227 ret
= dsa_sign_int(0, tbs
, tbslen
, sig
, &sltmp
, pdsactx
->dsa
);
235 static int dsa_verify(void *vpdsactx
, const unsigned char *sig
, size_t siglen
,
236 const unsigned char *tbs
, size_t tbslen
)
238 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
239 size_t mdsize
= dsa_get_md_size(pdsactx
);
241 if (!ossl_prov_is_running() || (mdsize
!= 0 && tbslen
!= mdsize
))
244 return DSA_verify(0, tbs
, tbslen
, sig
, siglen
, pdsactx
->dsa
);
247 static int dsa_digest_signverify_init(void *vpdsactx
, const char *mdname
,
248 void *vdsa
, int operation
)
250 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
252 if (!ossl_prov_is_running())
255 pdsactx
->flag_allow_md
= 0;
256 if (!dsa_signverify_init(vpdsactx
, vdsa
, operation
))
259 if (!dsa_setup_md(pdsactx
, mdname
, NULL
))
262 pdsactx
->mdctx
= EVP_MD_CTX_new();
263 if (pdsactx
->mdctx
== NULL
)
266 if (!EVP_DigestInit_ex(pdsactx
->mdctx
, pdsactx
->md
, NULL
))
272 EVP_MD_CTX_free(pdsactx
->mdctx
);
273 EVP_MD_free(pdsactx
->md
);
274 pdsactx
->mdctx
= NULL
;
279 static int dsa_digest_sign_init(void *vpdsactx
, const char *mdname
,
282 return dsa_digest_signverify_init(vpdsactx
, mdname
, vdsa
, EVP_PKEY_OP_SIGN
);
285 static int dsa_digest_verify_init(void *vpdsactx
, const char *mdname
, void *vdsa
)
287 return dsa_digest_signverify_init(vpdsactx
, mdname
, vdsa
, EVP_PKEY_OP_VERIFY
);
290 int dsa_digest_signverify_update(void *vpdsactx
, const unsigned char *data
,
293 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
295 if (pdsactx
== NULL
|| pdsactx
->mdctx
== NULL
)
298 return EVP_DigestUpdate(pdsactx
->mdctx
, data
, datalen
);
301 int dsa_digest_sign_final(void *vpdsactx
, unsigned char *sig
, size_t *siglen
,
304 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
305 unsigned char digest
[EVP_MAX_MD_SIZE
];
306 unsigned int dlen
= 0;
308 if (!ossl_prov_is_running() || pdsactx
== NULL
|| pdsactx
->mdctx
== NULL
)
312 * If sig is NULL then we're just finding out the sig size. Other fields
313 * are ignored. Defer to dsa_sign.
317 * TODO(3.0): There is the possibility that some externally provided
318 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
319 * but that problem is much larger than just in DSA.
321 if (!EVP_DigestFinal_ex(pdsactx
->mdctx
, digest
, &dlen
))
325 pdsactx
->flag_allow_md
= 1;
327 return dsa_sign(vpdsactx
, sig
, siglen
, sigsize
, digest
, (size_t)dlen
);
331 int dsa_digest_verify_final(void *vpdsactx
, const unsigned char *sig
,
334 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
335 unsigned char digest
[EVP_MAX_MD_SIZE
];
336 unsigned int dlen
= 0;
338 if (!ossl_prov_is_running() || pdsactx
== NULL
|| pdsactx
->mdctx
== NULL
)
342 * TODO(3.0): There is the possibility that some externally provided
343 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
344 * but that problem is much larger than just in DSA.
346 if (!EVP_DigestFinal_ex(pdsactx
->mdctx
, digest
, &dlen
))
349 pdsactx
->flag_allow_md
= 1;
351 return dsa_verify(vpdsactx
, sig
, siglen
, digest
, (size_t)dlen
);
354 static void dsa_freectx(void *vpdsactx
)
356 PROV_DSA_CTX
*ctx
= (PROV_DSA_CTX
*)vpdsactx
;
358 OPENSSL_free(ctx
->propq
);
359 EVP_MD_CTX_free(ctx
->mdctx
);
360 EVP_MD_free(ctx
->md
);
369 static void *dsa_dupctx(void *vpdsactx
)
371 PROV_DSA_CTX
*srcctx
= (PROV_DSA_CTX
*)vpdsactx
;
372 PROV_DSA_CTX
*dstctx
;
374 if (!ossl_prov_is_running())
377 dstctx
= OPENSSL_zalloc(sizeof(*srcctx
));
384 dstctx
->mdctx
= NULL
;
386 if (srcctx
->dsa
!= NULL
&& !DSA_up_ref(srcctx
->dsa
))
388 dstctx
->dsa
= srcctx
->dsa
;
390 if (srcctx
->md
!= NULL
&& !EVP_MD_up_ref(srcctx
->md
))
392 dstctx
->md
= srcctx
->md
;
394 if (srcctx
->mdctx
!= NULL
) {
395 dstctx
->mdctx
= EVP_MD_CTX_new();
396 if (dstctx
->mdctx
== NULL
397 || !EVP_MD_CTX_copy_ex(dstctx
->mdctx
, srcctx
->mdctx
))
407 static int dsa_get_ctx_params(void *vpdsactx
, OSSL_PARAM
*params
)
409 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
412 if (pdsactx
== NULL
|| params
== NULL
)
415 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_ALGORITHM_ID
);
417 && !OSSL_PARAM_set_octet_string(p
, pdsactx
->aid
, pdsactx
->aid_len
))
420 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
421 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_string(p
, pdsactx
->mdname
))
427 static const OSSL_PARAM known_gettable_ctx_params
[] = {
428 OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID
, NULL
, 0),
429 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
433 static const OSSL_PARAM
*dsa_gettable_ctx_params(ossl_unused
void *vctx
)
435 return known_gettable_ctx_params
;
438 static int dsa_set_ctx_params(void *vpdsactx
, const OSSL_PARAM params
[])
440 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
443 if (pdsactx
== NULL
|| params
== NULL
)
446 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
447 /* Not allowed during certain operations */
448 if (p
!= NULL
&& !pdsactx
->flag_allow_md
)
451 char mdname
[OSSL_MAX_NAME_SIZE
] = "", *pmdname
= mdname
;
452 char mdprops
[OSSL_MAX_PROPQUERY_SIZE
] = "", *pmdprops
= mdprops
;
453 const OSSL_PARAM
*propsp
=
454 OSSL_PARAM_locate_const(params
,
455 OSSL_SIGNATURE_PARAM_PROPERTIES
);
457 if (!OSSL_PARAM_get_utf8_string(p
, &pmdname
, sizeof(mdname
)))
460 && !OSSL_PARAM_get_utf8_string(propsp
, &pmdprops
, sizeof(mdprops
)))
462 if (!dsa_setup_md(pdsactx
, mdname
, mdprops
))
469 static const OSSL_PARAM known_settable_ctx_params
[] = {
470 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
471 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_PROPERTIES
, NULL
, 0),
475 static const OSSL_PARAM
*dsa_settable_ctx_params(ossl_unused
void *provctx
)
478 * TODO(3.0): Should this function return a different set of settable ctx
479 * params if the ctx is being used for a DigestSign/DigestVerify? In that
480 * case it is not allowed to set the digest size/digest name because the
481 * digest is explicitly set as part of the init.
482 * NOTE: Ideally we would check pdsactx->flag_allow_md, but this is
483 * problematic because there is no nice way of passing the
484 * PROV_DSA_CTX down to this function...
485 * Because we have API's that dont know about their parent..
486 * e.g: EVP_SIGNATURE_gettable_ctx_params(const EVP_SIGNATURE *sig).
487 * We could pass NULL for that case (but then how useful is the check?).
489 return known_settable_ctx_params
;
492 static int dsa_get_ctx_md_params(void *vpdsactx
, OSSL_PARAM
*params
)
494 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
496 if (pdsactx
->mdctx
== NULL
)
499 return EVP_MD_CTX_get_params(pdsactx
->mdctx
, params
);
502 static const OSSL_PARAM
*dsa_gettable_ctx_md_params(void *vpdsactx
)
504 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
506 if (pdsactx
->md
== NULL
)
509 return EVP_MD_gettable_ctx_params(pdsactx
->md
);
512 static int dsa_set_ctx_md_params(void *vpdsactx
, const OSSL_PARAM params
[])
514 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
516 if (pdsactx
->mdctx
== NULL
)
519 return EVP_MD_CTX_set_params(pdsactx
->mdctx
, params
);
522 static const OSSL_PARAM
*dsa_settable_ctx_md_params(void *vpdsactx
)
524 PROV_DSA_CTX
*pdsactx
= (PROV_DSA_CTX
*)vpdsactx
;
526 if (pdsactx
->md
== NULL
)
529 return EVP_MD_settable_ctx_params(pdsactx
->md
);
532 const OSSL_DISPATCH ossl_dsa_signature_functions
[] = {
533 { OSSL_FUNC_SIGNATURE_NEWCTX
, (void (*)(void))dsa_newctx
},
534 { OSSL_FUNC_SIGNATURE_SIGN_INIT
, (void (*)(void))dsa_sign_init
},
535 { OSSL_FUNC_SIGNATURE_SIGN
, (void (*)(void))dsa_sign
},
536 { OSSL_FUNC_SIGNATURE_VERIFY_INIT
, (void (*)(void))dsa_verify_init
},
537 { OSSL_FUNC_SIGNATURE_VERIFY
, (void (*)(void))dsa_verify
},
538 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT
,
539 (void (*)(void))dsa_digest_sign_init
},
540 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE
,
541 (void (*)(void))dsa_digest_signverify_update
},
542 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL
,
543 (void (*)(void))dsa_digest_sign_final
},
544 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT
,
545 (void (*)(void))dsa_digest_verify_init
},
546 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE
,
547 (void (*)(void))dsa_digest_signverify_update
},
548 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL
,
549 (void (*)(void))dsa_digest_verify_final
},
550 { OSSL_FUNC_SIGNATURE_FREECTX
, (void (*)(void))dsa_freectx
},
551 { OSSL_FUNC_SIGNATURE_DUPCTX
, (void (*)(void))dsa_dupctx
},
552 { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS
, (void (*)(void))dsa_get_ctx_params
},
553 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS
,
554 (void (*)(void))dsa_gettable_ctx_params
},
555 { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS
, (void (*)(void))dsa_set_ctx_params
},
556 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS
,
557 (void (*)(void))dsa_settable_ctx_params
},
558 { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS
,
559 (void (*)(void))dsa_get_ctx_md_params
},
560 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS
,
561 (void (*)(void))dsa_gettable_ctx_md_params
},
562 { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS
,
563 (void (*)(void))dsa_set_ctx_md_params
},
564 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS
,
565 (void (*)(void))dsa_settable_ctx_md_params
},