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_numbers.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.
64 char mdname
[OSSL_MAX_NAME_SIZE
];
66 /* The Algorithm Identifier of the combined signature algorithm */
67 unsigned char aid_buf
[OSSL_MAX_ALGORITHM_ID_SIZE
];
75 * This indicates that KAT (CAVS) test is running. Externally an app will
76 * override the random callback such that the generated private key and k
78 * Normal operation will loop to choose a new k if the signature is not
79 * valid - but for this mode of operation it forces a failure instead.
83 * Internally used to cache the results of calling the EC group
84 * sign_setup() methods which are then passed to the sign operation.
85 * This is used by CAVS failure tests to terminate a loop if the signature
87 * This could of also been done with a simple flag.
93 static void *ecdsa_newctx(void *provctx
)
95 PROV_ECDSA_CTX
*ctx
= OPENSSL_zalloc(sizeof(PROV_ECDSA_CTX
));
100 ctx
->libctx
= PROV_LIBRARY_CONTEXT_OF(provctx
);
104 static int ecdsa_signature_init(void *vctx
, void *ec
)
106 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
108 if (ctx
== NULL
|| ec
== NULL
|| !EC_KEY_up_ref(ec
))
110 EC_KEY_free(ctx
->ec
);
115 static int ecdsa_sign(void *vctx
, unsigned char *sig
, size_t *siglen
,
116 size_t sigsize
, const unsigned char *tbs
, size_t tbslen
)
118 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
121 size_t ecsize
= ECDSA_size(ctx
->ec
);
128 if (ctx
->kattest
&& !ECDSA_sign_setup(ctx
->ec
, NULL
, &ctx
->kinv
, &ctx
->r
))
131 if (sigsize
< (size_t)ecsize
)
134 if (ctx
->mdsize
!= 0 && tbslen
!= ctx
->mdsize
)
137 ret
= ECDSA_sign_ex(0, tbs
, tbslen
, sig
, &sltmp
, ctx
->kinv
, ctx
->r
, ctx
->ec
);
145 static int ecdsa_verify(void *vctx
, const unsigned char *sig
, size_t siglen
,
146 const unsigned char *tbs
, size_t tbslen
)
148 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
150 if (ctx
->mdsize
!= 0 && tbslen
!= ctx
->mdsize
)
153 return ECDSA_verify(0, tbs
, tbslen
, sig
, siglen
, ctx
->ec
);
156 static int get_md_nid(const EVP_MD
*md
)
159 * Because the ECDSA library deals with NIDs, we need to translate.
160 * We do so using EVP_MD_is_a(), and therefore need a name to NID
163 static const OSSL_ITEM name_to_nid
[] = {
164 { NID_sha1
, OSSL_DIGEST_NAME_SHA1
},
165 { NID_sha224
, OSSL_DIGEST_NAME_SHA2_224
},
166 { NID_sha256
, OSSL_DIGEST_NAME_SHA2_256
},
167 { NID_sha384
, OSSL_DIGEST_NAME_SHA2_384
},
168 { NID_sha512
, OSSL_DIGEST_NAME_SHA2_512
},
169 { NID_sha3_224
, OSSL_DIGEST_NAME_SHA3_224
},
170 { NID_sha3_256
, OSSL_DIGEST_NAME_SHA3_256
},
171 { NID_sha3_384
, OSSL_DIGEST_NAME_SHA3_384
},
172 { NID_sha3_512
, OSSL_DIGEST_NAME_SHA3_512
},
173 /* TODO - Add SHAKE OIDS when they are standardized */
177 int mdnid
= NID_undef
;
182 for (i
= 0; i
< OSSL_NELEM(name_to_nid
); i
++) {
183 if (EVP_MD_is_a(md
, name_to_nid
[i
].ptr
)) {
184 mdnid
= (int)name_to_nid
[i
].id
;
189 if (mdnid
== NID_undef
)
190 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_DIGEST
);
196 static void free_md(PROV_ECDSA_CTX
*ctx
)
198 EVP_MD_CTX_free(ctx
->mdctx
);
199 EVP_MD_free(ctx
->md
);
205 static int ecdsa_digest_signverify_init(void *vctx
, const char *mdname
,
206 const char *props
, void *ec
)
208 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
209 int md_nid
= NID_undef
;
214 if (!ecdsa_signature_init(vctx
, ec
))
217 ctx
->md
= EVP_MD_fetch(ctx
->libctx
, mdname
, props
);
218 if ((md_nid
= get_md_nid(ctx
->md
)) == NID_undef
)
221 ctx
->mdsize
= EVP_MD_size(ctx
->md
);
222 ctx
->mdctx
= EVP_MD_CTX_new();
223 if (ctx
->mdctx
== NULL
)
227 * TODO(3.0) Should we care about DER writing errors?
228 * All it really means is that for some reason, there's no
229 * AlgorithmIdentifier to be had, but the operation itself is
230 * still valid, just as long as it's not used to construct
231 * anything that needs an AlgorithmIdentifier.
234 if (WPACKET_init_der(&pkt
, ctx
->aid_buf
, sizeof(ctx
->aid_buf
))
235 && DER_w_algorithmIdentifier_ECDSA_with(&pkt
, -1, ctx
->ec
, md_nid
)
236 && WPACKET_finish(&pkt
)) {
237 WPACKET_get_total_written(&pkt
, &ctx
->aid_len
);
238 ctx
->aid
= WPACKET_get_curr(&pkt
);
240 WPACKET_cleanup(&pkt
);
242 if (!EVP_DigestInit_ex(ctx
->mdctx
, ctx
->md
, NULL
))
250 int ecdsa_digest_signverify_update(void *vctx
, const unsigned char *data
,
253 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
255 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
258 return EVP_DigestUpdate(ctx
->mdctx
, data
, datalen
);
261 int ecdsa_digest_sign_final(void *vctx
, unsigned char *sig
, size_t *siglen
,
264 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
265 unsigned char digest
[EVP_MAX_MD_SIZE
];
266 unsigned int dlen
= 0;
268 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
272 * If sig is NULL then we're just finding out the sig size. Other fields
273 * are ignored. Defer to ecdsa_sign.
277 * TODO(3.0): There is the possibility that some externally provided
278 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
279 * but that problem is much larger than just in DSA.
281 if (!EVP_DigestFinal_ex(ctx
->mdctx
, digest
, &dlen
))
285 return ecdsa_sign(vctx
, sig
, siglen
, sigsize
, digest
, (size_t)dlen
);
288 int ecdsa_digest_verify_final(void *vctx
, const unsigned char *sig
,
291 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
292 unsigned char digest
[EVP_MAX_MD_SIZE
];
293 unsigned int dlen
= 0;
295 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
299 * TODO(3.0): There is the possibility that some externally provided
300 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
301 * but that problem is much larger than just in DSA.
303 if (!EVP_DigestFinal_ex(ctx
->mdctx
, digest
, &dlen
))
306 return ecdsa_verify(ctx
, sig
, siglen
, digest
, (size_t)dlen
);
309 static void ecdsa_freectx(void *vctx
)
311 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
314 EC_KEY_free(ctx
->ec
);
315 BN_clear_free(ctx
->kinv
);
316 BN_clear_free(ctx
->r
);
320 static void *ecdsa_dupctx(void *vctx
)
322 PROV_ECDSA_CTX
*srcctx
= (PROV_ECDSA_CTX
*)vctx
;
323 PROV_ECDSA_CTX
*dstctx
;
325 dstctx
= OPENSSL_zalloc(sizeof(*srcctx
));
332 dstctx
->mdctx
= NULL
;
334 if (srcctx
->ec
!= NULL
&& !EC_KEY_up_ref(srcctx
->ec
))
336 /* Test KATS should not need to be supported */
337 if (srcctx
->kinv
!= NULL
|| srcctx
->r
!= NULL
)
339 dstctx
->ec
= srcctx
->ec
;
341 if (srcctx
->md
!= NULL
&& !EVP_MD_up_ref(srcctx
->md
))
343 dstctx
->md
= srcctx
->md
;
345 if (srcctx
->mdctx
!= NULL
) {
346 dstctx
->mdctx
= EVP_MD_CTX_new();
347 if (dstctx
->mdctx
== NULL
348 || !EVP_MD_CTX_copy_ex(dstctx
->mdctx
, srcctx
->mdctx
))
354 ecdsa_freectx(dstctx
);
358 static int ecdsa_get_ctx_params(void *vctx
, OSSL_PARAM
*params
)
360 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
363 if (ctx
== NULL
|| params
== NULL
)
366 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_ALGORITHM_ID
);
367 if (p
!= NULL
&& !OSSL_PARAM_set_octet_string(p
, ctx
->aid
, ctx
->aid_len
))
370 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_DIGEST_SIZE
);
371 if (p
!= NULL
&& !OSSL_PARAM_set_size_t(p
, ctx
->mdsize
))
374 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
375 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_string(p
, ctx
->md
== NULL
377 : EVP_MD_name(ctx
->md
)))
383 static const OSSL_PARAM known_gettable_ctx_params
[] = {
384 OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID
, NULL
, 0),
385 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE
, NULL
),
386 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
390 static const OSSL_PARAM
*ecdsa_gettable_ctx_params(void)
392 return known_gettable_ctx_params
;
395 static int ecdsa_set_ctx_params(void *vctx
, const OSSL_PARAM params
[])
397 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
401 if (ctx
== NULL
|| params
== NULL
)
404 if (ctx
->md
!= NULL
) {
406 * You cannot set the digest name/size when doing a DigestSign or
412 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_KAT
);
413 if (p
!= NULL
&& !OSSL_PARAM_get_uint(p
, &ctx
->kattest
))
416 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_DIGEST_SIZE
);
417 if (p
!= NULL
&& !OSSL_PARAM_get_size_t(p
, &ctx
->mdsize
))
421 * We never actually use the mdname, but we do support getting it later.
422 * This can be useful for applications that want to know the MD that they
425 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
426 mdname
= ctx
->mdname
;
428 && !OSSL_PARAM_get_utf8_string(p
, &mdname
, sizeof(ctx
->mdname
)))
434 static const OSSL_PARAM known_settable_ctx_params
[] = {
435 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE
, NULL
),
436 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
437 OSSL_PARAM_uint(OSSL_SIGNATURE_PARAM_KAT
, NULL
),
441 static const OSSL_PARAM
*ecdsa_settable_ctx_params(void)
444 * TODO(3.0): Should this function return a different set of settable ctx
445 * params if the ctx is being used for a DigestSign/DigestVerify? In that
446 * case it is not allowed to set the digest size/digest name because the
447 * digest is explicitly set as part of the init.
449 return known_settable_ctx_params
;
452 static int ecdsa_get_ctx_md_params(void *vctx
, OSSL_PARAM
*params
)
454 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
456 if (ctx
->mdctx
== NULL
)
459 return EVP_MD_CTX_get_params(ctx
->mdctx
, params
);
462 static const OSSL_PARAM
*ecdsa_gettable_ctx_md_params(void *vctx
)
464 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
469 return EVP_MD_gettable_ctx_params(ctx
->md
);
472 static int ecdsa_set_ctx_md_params(void *vctx
, const OSSL_PARAM params
[])
474 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
476 if (ctx
->mdctx
== NULL
)
479 return EVP_MD_CTX_set_params(ctx
->mdctx
, params
);
482 static const OSSL_PARAM
*ecdsa_settable_ctx_md_params(void *vctx
)
484 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
489 return EVP_MD_settable_ctx_params(ctx
->md
);
492 const OSSL_DISPATCH ecdsa_signature_functions
[] = {
493 { OSSL_FUNC_SIGNATURE_NEWCTX
, (void (*)(void))ecdsa_newctx
},
494 { OSSL_FUNC_SIGNATURE_SIGN_INIT
, (void (*)(void))ecdsa_signature_init
},
495 { OSSL_FUNC_SIGNATURE_SIGN
, (void (*)(void))ecdsa_sign
},
496 { OSSL_FUNC_SIGNATURE_VERIFY_INIT
, (void (*)(void))ecdsa_signature_init
},
497 { OSSL_FUNC_SIGNATURE_VERIFY
, (void (*)(void))ecdsa_verify
},
498 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT
,
499 (void (*)(void))ecdsa_digest_signverify_init
},
500 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE
,
501 (void (*)(void))ecdsa_digest_signverify_update
},
502 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL
,
503 (void (*)(void))ecdsa_digest_sign_final
},
504 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT
,
505 (void (*)(void))ecdsa_digest_signverify_init
},
506 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE
,
507 (void (*)(void))ecdsa_digest_signverify_update
},
508 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL
,
509 (void (*)(void))ecdsa_digest_verify_final
},
510 { OSSL_FUNC_SIGNATURE_FREECTX
, (void (*)(void))ecdsa_freectx
},
511 { OSSL_FUNC_SIGNATURE_DUPCTX
, (void (*)(void))ecdsa_dupctx
},
512 { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS
, (void (*)(void))ecdsa_get_ctx_params
},
513 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS
,
514 (void (*)(void))ecdsa_gettable_ctx_params
},
515 { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS
, (void (*)(void))ecdsa_set_ctx_params
},
516 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS
,
517 (void (*)(void))ecdsa_settable_ctx_params
},
518 { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS
,
519 (void (*)(void))ecdsa_get_ctx_md_params
},
520 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS
,
521 (void (*)(void))ecdsa_gettable_ctx_md_params
},
522 { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS
,
523 (void (*)(void))ecdsa_set_ctx_md_params
},
524 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS
,
525 (void (*)(void))ecdsa_settable_ctx_md_params
},