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 "prov/providercommonerr.h"
27 #include "prov/implementations.h"
28 #include "prov/provider_ctx.h"
29 #include "crypto/ec.h"
31 static OSSL_OP_signature_newctx_fn ecdsa_newctx
;
32 static OSSL_OP_signature_sign_init_fn ecdsa_signature_init
;
33 static OSSL_OP_signature_verify_init_fn ecdsa_signature_init
;
34 static OSSL_OP_signature_sign_fn ecdsa_sign
;
35 static OSSL_OP_signature_verify_fn ecdsa_verify
;
36 static OSSL_OP_signature_digest_sign_init_fn ecdsa_digest_signverify_init
;
37 static OSSL_OP_signature_digest_sign_update_fn ecdsa_digest_signverify_update
;
38 static OSSL_OP_signature_digest_sign_final_fn ecdsa_digest_sign_final
;
39 static OSSL_OP_signature_digest_verify_init_fn ecdsa_digest_signverify_init
;
40 static OSSL_OP_signature_digest_verify_update_fn ecdsa_digest_signverify_update
;
41 static OSSL_OP_signature_digest_verify_final_fn ecdsa_digest_verify_final
;
42 static OSSL_OP_signature_freectx_fn ecdsa_freectx
;
43 static OSSL_OP_signature_dupctx_fn ecdsa_dupctx
;
44 static OSSL_OP_signature_get_ctx_params_fn ecdsa_get_ctx_params
;
45 static OSSL_OP_signature_gettable_ctx_params_fn ecdsa_gettable_ctx_params
;
46 static OSSL_OP_signature_set_ctx_params_fn ecdsa_set_ctx_params
;
47 static OSSL_OP_signature_settable_ctx_params_fn ecdsa_settable_ctx_params
;
48 static OSSL_OP_signature_get_ctx_md_params_fn ecdsa_get_ctx_md_params
;
49 static OSSL_OP_signature_gettable_ctx_md_params_fn ecdsa_gettable_ctx_md_params
;
50 static OSSL_OP_signature_set_ctx_md_params_fn ecdsa_set_ctx_md_params
;
51 static OSSL_OP_signature_settable_ctx_md_params_fn ecdsa_settable_ctx_md_params
;
54 * What's passed as an actual key is defined by the KEYMGMT interface.
55 * We happen to know that our KEYMGMT simply passes DSA structures, so
56 * we use that here too.
62 char mdname
[OSSL_MAX_NAME_SIZE
];
64 /* The Algorithm Identifier of the combined signature algorithm */
65 unsigned char aid
[OSSL_MAX_ALGORITHM_ID_SIZE
];
72 * This indicates that KAT (CAVS) test is running. Externally an app will
73 * override the random callback such that the generated private key and k
75 * Normal operation will loop to choose a new k if the signature is not
76 * valid - but for this mode of operation it forces a failure instead.
80 * Internally used to cache the results of calling the EC group
81 * sign_setup() methods which are then passed to the sign operation.
82 * This is used by CAVS failure tests to terminate a loop if the signature
84 * This could of also been done with a simple flag.
90 static void *ecdsa_newctx(void *provctx
)
92 PROV_ECDSA_CTX
*ctx
= OPENSSL_zalloc(sizeof(PROV_ECDSA_CTX
));
97 ctx
->libctx
= PROV_LIBRARY_CONTEXT_OF(provctx
);
101 static int ecdsa_signature_init(void *vctx
, void *ec
)
103 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
105 if (ctx
== NULL
|| ec
== NULL
|| !EC_KEY_up_ref(ec
))
107 EC_KEY_free(ctx
->ec
);
112 static int ecdsa_sign(void *vctx
, unsigned char *sig
, size_t *siglen
,
113 size_t sigsize
, const unsigned char *tbs
, size_t tbslen
)
115 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
118 size_t ecsize
= ECDSA_size(ctx
->ec
);
125 if (ctx
->kattest
&& !ECDSA_sign_setup(ctx
->ec
, NULL
, &ctx
->kinv
, &ctx
->r
))
128 if (sigsize
< (size_t)ecsize
)
131 if (ctx
->mdsize
!= 0 && tbslen
!= ctx
->mdsize
)
134 ret
= ECDSA_sign_ex(0, tbs
, tbslen
, sig
, &sltmp
, ctx
->kinv
, ctx
->r
, ctx
->ec
);
142 static int ecdsa_verify(void *vctx
, const unsigned char *sig
, size_t siglen
,
143 const unsigned char *tbs
, size_t tbslen
)
145 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
147 if (ctx
->mdsize
!= 0 && tbslen
!= ctx
->mdsize
)
150 return ECDSA_verify(0, tbs
, tbslen
, sig
, siglen
, ctx
->ec
);
153 static int get_md_nid(const EVP_MD
*md
)
156 * Because the ECDSA library deals with NIDs, we need to translate.
157 * We do so using EVP_MD_is_a(), and therefore need a name to NID
160 static const OSSL_ITEM name_to_nid
[] = {
161 { NID_sha1
, OSSL_DIGEST_NAME_SHA1
},
162 { NID_sha224
, OSSL_DIGEST_NAME_SHA2_224
},
163 { NID_sha256
, OSSL_DIGEST_NAME_SHA2_256
},
164 { NID_sha384
, OSSL_DIGEST_NAME_SHA2_384
},
165 { NID_sha512
, OSSL_DIGEST_NAME_SHA2_512
},
166 { NID_sha3_224
, OSSL_DIGEST_NAME_SHA3_224
},
167 { NID_sha3_256
, OSSL_DIGEST_NAME_SHA3_256
},
168 { NID_sha3_384
, OSSL_DIGEST_NAME_SHA3_384
},
169 { NID_sha3_512
, OSSL_DIGEST_NAME_SHA3_512
},
170 /* TODO - Add SHAKE OIDS when they are standardized */
174 int mdnid
= NID_undef
;
179 for (i
= 0; i
< OSSL_NELEM(name_to_nid
); i
++) {
180 if (EVP_MD_is_a(md
, name_to_nid
[i
].ptr
)) {
181 mdnid
= (int)name_to_nid
[i
].id
;
186 if (mdnid
== NID_undef
)
187 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_DIGEST
);
193 static void free_md(PROV_ECDSA_CTX
*ctx
)
195 EVP_MD_CTX_free(ctx
->mdctx
);
196 EVP_MD_free(ctx
->md
);
202 static int ecdsa_digest_signverify_init(void *vctx
, const char *mdname
,
203 const char *props
, void *ec
)
205 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
206 size_t algorithmidentifier_len
= 0;
207 const unsigned char *algorithmidentifier
;
211 if (!ecdsa_signature_init(vctx
, ec
))
214 ctx
->md
= EVP_MD_fetch(ctx
->libctx
, mdname
, props
);
215 algorithmidentifier
=
216 ecdsa_algorithmidentifier_encoding(get_md_nid(ctx
->md
),
217 &algorithmidentifier_len
);
218 if (algorithmidentifier
== NULL
)
221 ctx
->mdsize
= EVP_MD_size(ctx
->md
);
222 ctx
->mdctx
= EVP_MD_CTX_new();
223 if (ctx
->mdctx
== NULL
)
226 memcpy(ctx
->aid
, algorithmidentifier
, algorithmidentifier_len
);
227 ctx
->aid_len
= algorithmidentifier_len
;
229 if (!EVP_DigestInit_ex(ctx
->mdctx
, ctx
->md
, NULL
))
237 int ecdsa_digest_signverify_update(void *vctx
, const unsigned char *data
,
240 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
242 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
245 return EVP_DigestUpdate(ctx
->mdctx
, data
, datalen
);
248 int ecdsa_digest_sign_final(void *vctx
, unsigned char *sig
, size_t *siglen
,
251 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
252 unsigned char digest
[EVP_MAX_MD_SIZE
];
253 unsigned int dlen
= 0;
255 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
259 * If sig is NULL then we're just finding out the sig size. Other fields
260 * are ignored. Defer to ecdsa_sign.
264 * TODO(3.0): There is the possibility that some externally provided
265 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
266 * but that problem is much larger than just in DSA.
268 if (!EVP_DigestFinal_ex(ctx
->mdctx
, digest
, &dlen
))
272 return ecdsa_sign(vctx
, sig
, siglen
, sigsize
, digest
, (size_t)dlen
);
275 int ecdsa_digest_verify_final(void *vctx
, const unsigned char *sig
,
278 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
279 unsigned char digest
[EVP_MAX_MD_SIZE
];
280 unsigned int dlen
= 0;
282 if (ctx
== NULL
|| ctx
->mdctx
== NULL
)
286 * TODO(3.0): There is the possibility that some externally provided
287 * digests exceed EVP_MAX_MD_SIZE. We should probably handle that somehow -
288 * but that problem is much larger than just in DSA.
290 if (!EVP_DigestFinal_ex(ctx
->mdctx
, digest
, &dlen
))
293 return ecdsa_verify(ctx
, sig
, siglen
, digest
, (size_t)dlen
);
296 static void ecdsa_freectx(void *vctx
)
298 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
301 EC_KEY_free(ctx
->ec
);
302 BN_clear_free(ctx
->kinv
);
303 BN_clear_free(ctx
->r
);
307 static void *ecdsa_dupctx(void *vctx
)
309 PROV_ECDSA_CTX
*srcctx
= (PROV_ECDSA_CTX
*)vctx
;
310 PROV_ECDSA_CTX
*dstctx
;
312 dstctx
= OPENSSL_zalloc(sizeof(*srcctx
));
319 dstctx
->mdctx
= NULL
;
321 if (srcctx
->ec
!= NULL
&& !EC_KEY_up_ref(srcctx
->ec
))
323 /* Test KATS should not need to be supported */
324 if (srcctx
->kinv
!= NULL
|| srcctx
->r
!= NULL
)
326 dstctx
->ec
= srcctx
->ec
;
328 if (srcctx
->md
!= NULL
&& !EVP_MD_up_ref(srcctx
->md
))
330 dstctx
->md
= srcctx
->md
;
332 if (srcctx
->mdctx
!= NULL
) {
333 dstctx
->mdctx
= EVP_MD_CTX_new();
334 if (dstctx
->mdctx
== NULL
335 || !EVP_MD_CTX_copy_ex(dstctx
->mdctx
, srcctx
->mdctx
))
341 ecdsa_freectx(dstctx
);
345 static int ecdsa_get_ctx_params(void *vctx
, OSSL_PARAM
*params
)
347 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
350 if (ctx
== NULL
|| params
== NULL
)
353 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_ALGORITHM_ID
);
354 if (p
!= NULL
&& !OSSL_PARAM_set_octet_string(p
, ctx
->aid
, ctx
->aid_len
))
357 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_DIGEST_SIZE
);
358 if (p
!= NULL
&& !OSSL_PARAM_set_size_t(p
, ctx
->mdsize
))
361 p
= OSSL_PARAM_locate(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
362 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_string(p
, ctx
->md
== NULL
364 : EVP_MD_name(ctx
->md
)))
370 static const OSSL_PARAM known_gettable_ctx_params
[] = {
371 OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID
, NULL
, 0),
372 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE
, NULL
),
373 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
377 static const OSSL_PARAM
*ecdsa_gettable_ctx_params(void)
379 return known_gettable_ctx_params
;
382 static int ecdsa_set_ctx_params(void *vctx
, const OSSL_PARAM params
[])
384 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
388 if (ctx
== NULL
|| params
== NULL
)
391 if (ctx
->md
!= NULL
) {
393 * You cannot set the digest name/size when doing a DigestSign or
399 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_KAT
);
400 if (p
!= NULL
&& !OSSL_PARAM_get_uint(p
, &ctx
->kattest
))
403 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_DIGEST_SIZE
);
404 if (p
!= NULL
&& !OSSL_PARAM_get_size_t(p
, &ctx
->mdsize
))
408 * We never actually use the mdname, but we do support getting it later.
409 * This can be useful for applications that want to know the MD that they
412 p
= OSSL_PARAM_locate_const(params
, OSSL_SIGNATURE_PARAM_DIGEST
);
413 mdname
= ctx
->mdname
;
415 && !OSSL_PARAM_get_utf8_string(p
, &mdname
, sizeof(ctx
->mdname
)))
421 static const OSSL_PARAM known_settable_ctx_params
[] = {
422 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE
, NULL
),
423 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
, NULL
, 0),
424 OSSL_PARAM_uint(OSSL_SIGNATURE_PARAM_KAT
, NULL
),
428 static const OSSL_PARAM
*ecdsa_settable_ctx_params(void)
431 * TODO(3.0): Should this function return a different set of settable ctx
432 * params if the ctx is being used for a DigestSign/DigestVerify? In that
433 * case it is not allowed to set the digest size/digest name because the
434 * digest is explicitly set as part of the init.
436 return known_settable_ctx_params
;
439 static int ecdsa_get_ctx_md_params(void *vctx
, OSSL_PARAM
*params
)
441 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
443 if (ctx
->mdctx
== NULL
)
446 return EVP_MD_CTX_get_params(ctx
->mdctx
, params
);
449 static const OSSL_PARAM
*ecdsa_gettable_ctx_md_params(void *vctx
)
451 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
456 return EVP_MD_gettable_ctx_params(ctx
->md
);
459 static int ecdsa_set_ctx_md_params(void *vctx
, const OSSL_PARAM params
[])
461 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
463 if (ctx
->mdctx
== NULL
)
466 return EVP_MD_CTX_set_params(ctx
->mdctx
, params
);
469 static const OSSL_PARAM
*ecdsa_settable_ctx_md_params(void *vctx
)
471 PROV_ECDSA_CTX
*ctx
= (PROV_ECDSA_CTX
*)vctx
;
476 return EVP_MD_settable_ctx_params(ctx
->md
);
479 const OSSL_DISPATCH ecdsa_signature_functions
[] = {
480 { OSSL_FUNC_SIGNATURE_NEWCTX
, (void (*)(void))ecdsa_newctx
},
481 { OSSL_FUNC_SIGNATURE_SIGN_INIT
, (void (*)(void))ecdsa_signature_init
},
482 { OSSL_FUNC_SIGNATURE_SIGN
, (void (*)(void))ecdsa_sign
},
483 { OSSL_FUNC_SIGNATURE_VERIFY_INIT
, (void (*)(void))ecdsa_signature_init
},
484 { OSSL_FUNC_SIGNATURE_VERIFY
, (void (*)(void))ecdsa_verify
},
485 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT
,
486 (void (*)(void))ecdsa_digest_signverify_init
},
487 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE
,
488 (void (*)(void))ecdsa_digest_signverify_update
},
489 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL
,
490 (void (*)(void))ecdsa_digest_sign_final
},
491 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT
,
492 (void (*)(void))ecdsa_digest_signverify_init
},
493 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE
,
494 (void (*)(void))ecdsa_digest_signverify_update
},
495 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL
,
496 (void (*)(void))ecdsa_digest_verify_final
},
497 { OSSL_FUNC_SIGNATURE_FREECTX
, (void (*)(void))ecdsa_freectx
},
498 { OSSL_FUNC_SIGNATURE_DUPCTX
, (void (*)(void))ecdsa_dupctx
},
499 { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS
, (void (*)(void))ecdsa_get_ctx_params
},
500 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS
,
501 (void (*)(void))ecdsa_gettable_ctx_params
},
502 { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS
, (void (*)(void))ecdsa_set_ctx_params
},
503 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS
,
504 (void (*)(void))ecdsa_settable_ctx_params
},
505 { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS
,
506 (void (*)(void))ecdsa_get_ctx_md_params
},
507 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS
,
508 (void (*)(void))ecdsa_gettable_ctx_md_params
},
509 { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS
,
510 (void (*)(void))ecdsa_set_ctx_md_params
},
511 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS
,
512 (void (*)(void))ecdsa_settable_ctx_md_params
},