2 * Copyright 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 * ECDSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
16 #include <string.h> /* memcpy */
17 #include <openssl/crypto.h>
18 #include <openssl/core_dispatch.h>
19 #include <openssl/core_names.h>
20 #include <openssl/dsa.h>
21 #include <openssl/params.h>
22 #include <openssl/evp.h>
23 #include <openssl/err.h>
24 #include "internal/nelem.h"
25 #include "internal/sizes.h"
26 #include "internal/cryptlib.h"
27 #include "prov/providercommonerr.h"
28 #include "prov/implementations.h"
29 #include "prov/provider_ctx.h"
30 #include "crypto/ec.h"
31 #include "prov/der_ec.h"
33 static OSSL_OP_signature_newctx_fn ecdsa_newctx
;
34 static OSSL_OP_signature_sign_init_fn ecdsa_signature_init
;
35 static OSSL_OP_signature_verify_init_fn ecdsa_signature_init
;
36 static OSSL_OP_signature_sign_fn ecdsa_sign
;
37 static OSSL_OP_signature_verify_fn ecdsa_verify
;
38 static OSSL_OP_signature_digest_sign_init_fn ecdsa_digest_signverify_init
;
39 static OSSL_OP_signature_digest_sign_update_fn ecdsa_digest_signverify_update
;
40 static OSSL_OP_signature_digest_sign_final_fn ecdsa_digest_sign_final
;
41 static OSSL_OP_signature_digest_verify_init_fn ecdsa_digest_signverify_init
;
42 static OSSL_OP_signature_digest_verify_update_fn ecdsa_digest_signverify_update
;
43 static OSSL_OP_signature_digest_verify_final_fn ecdsa_digest_verify_final
;
44 static OSSL_OP_signature_freectx_fn ecdsa_freectx
;
45 static OSSL_OP_signature_dupctx_fn ecdsa_dupctx
;
46 static OSSL_OP_signature_get_ctx_params_fn ecdsa_get_ctx_params
;
47 static OSSL_OP_signature_gettable_ctx_params_fn ecdsa_gettable_ctx_params
;
48 static OSSL_OP_signature_set_ctx_params_fn ecdsa_set_ctx_params
;
49 static OSSL_OP_signature_settable_ctx_params_fn ecdsa_settable_ctx_params
;
50 static OSSL_OP_signature_get_ctx_md_params_fn ecdsa_get_ctx_md_params
;
51 static OSSL_OP_signature_gettable_ctx_md_params_fn ecdsa_gettable_ctx_md_params
;
52 static OSSL_OP_signature_set_ctx_md_params_fn ecdsa_set_ctx_md_params
;
53 static OSSL_OP_signature_settable_ctx_md_params_fn ecdsa_settable_ctx_md_params
;
56 * What's passed as an actual key is defined by the KEYMGMT interface.
57 * We happen to know that our KEYMGMT simply passes DSA structures, so
58 * we use that here too.
65 char mdname
[OSSL_MAX_NAME_SIZE
];
67 /* The Algorithm Identifier of the combined signature algorithm */
68 unsigned char aid_buf
[OSSL_MAX_ALGORITHM_ID_SIZE
];
76 * Internally used to cache the results of calling the EC group
77 * sign_setup() methods which are then passed to the sign operation.
78 * This is used by CAVS failure tests to terminate a loop if the signature
80 * This could of also been done with a simple flag.
84 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
86 * This indicates that KAT (CAVS) test is running. Externally an app will
87 * override the random callback such that the generated private key and k
89 * Normal operation will loop to choose a new k if the signature is not
90 * valid - but for this mode of operation it forces a failure instead.
96 static void *ecdsa_newctx(void *provctx
, const char *propq
)
98 PROV_ECDSA_CTX
*ctx
= OPENSSL_zalloc(sizeof(PROV_ECDSA_CTX
));
103 ctx
->libctx
= PROV_LIBRARY_CONTEXT_OF(provctx
);
104 if (propq
!= NULL
&& (ctx
->propq
= OPENSSL_strdup(propq
)) == NULL
) {
107 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
112 static int ecdsa_signature_init(void *vctx
, void *ec
)
114 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
116 if (ctx
== NULL
|| ec
== NULL
|| !EC_KEY_up_ref(ec
))
118 EC_KEY_free(ctx
->ec
);
123 static int ecdsa_sign(void *vctx
, unsigned char *sig
, size_t *siglen
,
124 size_t sigsize
, const unsigned char *tbs
, size_t tbslen
)
126 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
129 size_t ecsize
= ECDSA_size(ctx
->ec
);
136 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
137 if (ctx
->kattest
&& !ECDSA_sign_setup(ctx
->ec
, NULL
, &ctx
->kinv
, &ctx
->r
))
141 if (sigsize
< (size_t)ecsize
)
144 if (ctx
->mdsize
!= 0 && tbslen
!= ctx
->mdsize
)
147 ret
= ECDSA_sign_ex(0, tbs
, tbslen
, sig
, &sltmp
, ctx
->kinv
, ctx
->r
, ctx
->ec
);
155 static int ecdsa_verify(void *vctx
, const unsigned char *sig
, size_t siglen
,
156 const unsigned char *tbs
, size_t tbslen
)
158 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
160 if (ctx
->mdsize
!= 0 && tbslen
!= ctx
->mdsize
)
163 return ECDSA_verify(0, tbs
, tbslen
, sig
, siglen
, ctx
->ec
);
166 static int get_md_nid(const EVP_MD
*md
)
169 * Because the ECDSA library deals with NIDs, we need to translate.
170 * We do so using EVP_MD_is_a(), and therefore need a name to NID
173 static const OSSL_ITEM name_to_nid
[] = {
174 { NID_sha1
, OSSL_DIGEST_NAME_SHA1
},
175 { NID_sha224
, OSSL_DIGEST_NAME_SHA2_224
},
176 { NID_sha256
, OSSL_DIGEST_NAME_SHA2_256
},
177 { NID_sha384
, OSSL_DIGEST_NAME_SHA2_384
},
178 { NID_sha512
, OSSL_DIGEST_NAME_SHA2_512
},
179 { NID_sha3_224
, OSSL_DIGEST_NAME_SHA3_224
},
180 { NID_sha3_256
, OSSL_DIGEST_NAME_SHA3_256
},
181 { NID_sha3_384
, OSSL_DIGEST_NAME_SHA3_384
},
182 { NID_sha3_512
, OSSL_DIGEST_NAME_SHA3_512
},
183 /* TODO - Add SHAKE OIDS when they are standardized */
187 int mdnid
= NID_undef
;
192 for (i
= 0; i
< OSSL_NELEM(name_to_nid
); i
++) {
193 if (EVP_MD_is_a(md
, name_to_nid
[i
].ptr
)) {
194 mdnid
= (int)name_to_nid
[i
].id
;
199 if (mdnid
== NID_undef
)
200 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_DIGEST
);
206 static void free_md(PROV_ECDSA_CTX
*ctx
)
208 OPENSSL_free(ctx
->propq
);
209 EVP_MD_CTX_free(ctx
->mdctx
);
210 EVP_MD_free(ctx
->md
);
217 static int ecdsa_digest_signverify_init(void *vctx
, const char *mdname
,
220 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
221 int md_nid
= NID_undef
;
226 if (!ecdsa_signature_init(vctx
, ec
))
229 ctx
->md
= EVP_MD_fetch(ctx
->libctx
, mdname
, ctx
->propq
);
230 if ((md_nid
= get_md_nid(ctx
->md
)) == NID_undef
)
233 ctx
->mdsize
= EVP_MD_size(ctx
->md
);
234 ctx
->mdctx
= EVP_MD_CTX_new();
235 if (ctx
->mdctx
== NULL
)
239 * TODO(3.0) Should we care about DER writing errors?
240 * All it really means is that for some reason, there's no
241 * AlgorithmIdentifier to be had, but the operation itself is
242 * still valid, just as long as it's not used to construct
243 * anything that needs an AlgorithmIdentifier.
246 if (WPACKET_init_der(&pkt
, ctx
->aid_buf
, sizeof(ctx
->aid_buf
))
247 && DER_w_algorithmIdentifier_ECDSA_with_MD(&pkt
, -1, ctx
->ec
, md_nid
)
248 && WPACKET_finish(&pkt
)) {
249 WPACKET_get_total_written(&pkt
, &ctx
->aid_len
);
250 ctx
->aid
= WPACKET_get_curr(&pkt
);
252 WPACKET_cleanup(&pkt
);
254 if (!EVP_DigestInit_ex(ctx
->mdctx
, ctx
->md
, NULL
))
262 int ecdsa_digest_signverify_update(void *vctx
, const unsigned char *data
,
265 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
267 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
270 return EVP_DigestUpdate(ctx
->mdctx
, data
, datalen
);
273 int ecdsa_digest_sign_final(void *vctx
, unsigned char *sig
, size_t *siglen
,
276 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
277 unsigned char digest
[EVP_MAX_MD_SIZE
];
278 unsigned int dlen
= 0;
280 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
284 * If sig is NULL then we're just finding out the sig size. Other fields
285 * are ignored. Defer to ecdsa_sign.
289 * TODO(3.0): There is the possibility that some externally provided
290 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
291 * but that problem is much larger than just in DSA.
293 if (!EVP_DigestFinal_ex(ctx
->mdctx
, digest
, &dlen
))
297 return ecdsa_sign(vctx
, sig
, siglen
, sigsize
, digest
, (size_t)dlen
);
300 int ecdsa_digest_verify_final(void *vctx
, const unsigned char *sig
,
303 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
304 unsigned char digest
[EVP_MAX_MD_SIZE
];
305 unsigned int dlen
= 0;
307 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
311 * TODO(3.0): There is the possibility that some externally provided
312 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
313 * but that problem is much larger than just in DSA.
315 if (!EVP_DigestFinal_ex(ctx
->mdctx
, digest
, &dlen
))
318 return ecdsa_verify(ctx
, sig
, siglen
, digest
, (size_t)dlen
);
321 static void ecdsa_freectx(void *vctx
)
323 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
326 EC_KEY_free(ctx
->ec
);
327 BN_clear_free(ctx
->kinv
);
328 BN_clear_free(ctx
->r
);
332 static void *ecdsa_dupctx(void *vctx
)
334 PROV_ECDSA_CTX
*srcctx
= (PROV_ECDSA_CTX
*)vctx
;
335 PROV_ECDSA_CTX
*dstctx
;
337 dstctx
= OPENSSL_zalloc(sizeof(*srcctx
));
344 dstctx
->mdctx
= NULL
;
346 if (srcctx
->ec
!= NULL
&& !EC_KEY_up_ref(srcctx
->ec
))
348 /* Test KATS should not need to be supported */
349 if (srcctx
->kinv
!= NULL
|| srcctx
->r
!= NULL
)
351 dstctx
->ec
= srcctx
->ec
;
353 if (srcctx
->md
!= NULL
&& !EVP_MD_up_ref(srcctx
->md
))
355 dstctx
->md
= srcctx
->md
;
357 if (srcctx
->mdctx
!= NULL
) {
358 dstctx
->mdctx
= EVP_MD_CTX_new();
359 if (dstctx
->mdctx
== NULL
360 || !EVP_MD_CTX_copy_ex(dstctx
->mdctx
, srcctx
->mdctx
))
366 ecdsa_freectx(dstctx
);
370 static int ecdsa_get_ctx_params(void *vctx
, OSSL_PARAM
*params
)
372 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
375 if (ctx
== NULL
|| params
== NULL
)
378 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_ALGORITHM_ID
);
379 if (p
!= NULL
&& !OSSL_PARAM_set_octet_string(p
, ctx
->aid
, ctx
->aid_len
))
382 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_DIGEST_SIZE
);
383 if (p
!= NULL
&& !OSSL_PARAM_set_size_t(p
, ctx
->mdsize
))
386 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
387 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_string(p
, ctx
->md
== NULL
389 : EVP_MD_name(ctx
->md
)))
395 static const OSSL_PARAM known_gettable_ctx_params
[] = {
396 OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID
, NULL
, 0),
397 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE
, NULL
),
398 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
402 static const OSSL_PARAM
*ecdsa_gettable_ctx_params(void)
404 return known_gettable_ctx_params
;
407 static int ecdsa_set_ctx_params(void *vctx
, const OSSL_PARAM params
[])
409 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
413 if (ctx
== NULL
|| params
== NULL
)
416 if (ctx
->md
!= NULL
) {
418 * You cannot set the digest name/size when doing a DigestSign or
423 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
424 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_KAT
);
425 if (p
!= NULL
&& !OSSL_PARAM_get_uint(p
, &ctx
->kattest
))
429 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_DIGEST_SIZE
);
430 if (p
!= NULL
&& !OSSL_PARAM_get_size_t(p
, &ctx
->mdsize
))
434 * We never actually use the mdname, but we do support getting it later.
435 * This can be useful for applications that want to know the MD that they
438 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
439 mdname
= ctx
->mdname
;
441 && !OSSL_PARAM_get_utf8_string(p
, &mdname
, sizeof(ctx
->mdname
)))
447 static const OSSL_PARAM known_settable_ctx_params
[] = {
448 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE
, NULL
),
449 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
450 OSSL_PARAM_uint(OSSL_SIGNATURE_PARAM_KAT
, NULL
),
454 static const OSSL_PARAM
*ecdsa_settable_ctx_params(void)
457 * TODO(3.0): Should this function return a different set of settable ctx
458 * params if the ctx is being used for a DigestSign/DigestVerify? In that
459 * case it is not allowed to set the digest size/digest name because the
460 * digest is explicitly set as part of the init.
462 return known_settable_ctx_params
;
465 static int ecdsa_get_ctx_md_params(void *vctx
, OSSL_PARAM
*params
)
467 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
469 if (ctx
->mdctx
== NULL
)
472 return EVP_MD_CTX_get_params(ctx
->mdctx
, params
);
475 static const OSSL_PARAM
*ecdsa_gettable_ctx_md_params(void *vctx
)
477 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
482 return EVP_MD_gettable_ctx_params(ctx
->md
);
485 static int ecdsa_set_ctx_md_params(void *vctx
, const OSSL_PARAM params
[])
487 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
489 if (ctx
->mdctx
== NULL
)
492 return EVP_MD_CTX_set_params(ctx
->mdctx
, params
);
495 static const OSSL_PARAM
*ecdsa_settable_ctx_md_params(void *vctx
)
497 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
502 return EVP_MD_settable_ctx_params(ctx
->md
);
505 const OSSL_DISPATCH ecdsa_signature_functions
[] = {
506 { OSSL_FUNC_SIGNATURE_NEWCTX
, (void (*)(void))ecdsa_newctx
},
507 { OSSL_FUNC_SIGNATURE_SIGN_INIT
, (void (*)(void))ecdsa_signature_init
},
508 { OSSL_FUNC_SIGNATURE_SIGN
, (void (*)(void))ecdsa_sign
},
509 { OSSL_FUNC_SIGNATURE_VERIFY_INIT
, (void (*)(void))ecdsa_signature_init
},
510 { OSSL_FUNC_SIGNATURE_VERIFY
, (void (*)(void))ecdsa_verify
},
511 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT
,
512 (void (*)(void))ecdsa_digest_signverify_init
},
513 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE
,
514 (void (*)(void))ecdsa_digest_signverify_update
},
515 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL
,
516 (void (*)(void))ecdsa_digest_sign_final
},
517 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT
,
518 (void (*)(void))ecdsa_digest_signverify_init
},
519 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE
,
520 (void (*)(void))ecdsa_digest_signverify_update
},
521 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL
,
522 (void (*)(void))ecdsa_digest_verify_final
},
523 { OSSL_FUNC_SIGNATURE_FREECTX
, (void (*)(void))ecdsa_freectx
},
524 { OSSL_FUNC_SIGNATURE_DUPCTX
, (void (*)(void))ecdsa_dupctx
},
525 { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS
, (void (*)(void))ecdsa_get_ctx_params
},
526 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS
,
527 (void (*)(void))ecdsa_gettable_ctx_params
},
528 { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS
, (void (*)(void))ecdsa_set_ctx_params
},
529 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS
,
530 (void (*)(void))ecdsa_settable_ctx_params
},
531 { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS
,
532 (void (*)(void))ecdsa_get_ctx_md_params
},
533 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS
,
534 (void (*)(void))ecdsa_gettable_ctx_md_params
},
535 { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS
,
536 (void (*)(void))ecdsa_set_ctx_md_params
},
537 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS
,
538 (void (*)(void))ecdsa_settable_ctx_md_params
},