2 * Copyright 2020-2022 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
12 * internal use - SM2 implementation uses ECDSA_size() function.
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 <openssl/proverr.h>
25 #include "internal/nelem.h"
26 #include "internal/sizes.h"
27 #include "internal/cryptlib.h"
28 #include "internal/sm3.h"
29 #include "prov/implementations.h"
30 #include "prov/providercommon.h"
31 #include "prov/provider_ctx.h"
32 #include "crypto/ec.h"
33 #include "crypto/sm2.h"
34 #include "prov/der_sm2.h"
36 static OSSL_FUNC_signature_newctx_fn sm2sig_newctx;
37 static OSSL_FUNC_signature_sign_init_fn sm2sig_signature_init;
38 static OSSL_FUNC_signature_verify_init_fn sm2sig_signature_init;
39 static OSSL_FUNC_signature_sign_fn sm2sig_sign;
40 static OSSL_FUNC_signature_verify_fn sm2sig_verify;
41 static OSSL_FUNC_signature_digest_sign_init_fn sm2sig_digest_signverify_init;
42 static OSSL_FUNC_signature_digest_sign_update_fn sm2sig_digest_signverify_update;
43 static OSSL_FUNC_signature_digest_sign_final_fn sm2sig_digest_sign_final;
44 static OSSL_FUNC_signature_digest_verify_init_fn sm2sig_digest_signverify_init;
45 static OSSL_FUNC_signature_digest_verify_update_fn sm2sig_digest_signverify_update;
46 static OSSL_FUNC_signature_digest_verify_final_fn sm2sig_digest_verify_final;
47 static OSSL_FUNC_signature_freectx_fn sm2sig_freectx;
48 static OSSL_FUNC_signature_dupctx_fn sm2sig_dupctx;
49 static OSSL_FUNC_signature_get_ctx_params_fn sm2sig_get_ctx_params;
50 static OSSL_FUNC_signature_gettable_ctx_params_fn sm2sig_gettable_ctx_params;
51 static OSSL_FUNC_signature_set_ctx_params_fn sm2sig_set_ctx_params;
52 static OSSL_FUNC_signature_settable_ctx_params_fn sm2sig_settable_ctx_params;
53 static OSSL_FUNC_signature_get_ctx_md_params_fn sm2sig_get_ctx_md_params;
54 static OSSL_FUNC_signature_gettable_ctx_md_params_fn sm2sig_gettable_ctx_md_params;
55 static OSSL_FUNC_signature_set_ctx_md_params_fn sm2sig_set_ctx_md_params;
56 static OSSL_FUNC_signature_settable_ctx_md_params_fn sm2sig_settable_ctx_md_params;
59 * What's passed as an actual key is defined by the KEYMGMT interface.
60 * We happen to know that our KEYMGMT simply passes EC structures, so
61 * we use that here too.
69 * Flag to determine if the 'z' digest needs to be computed and fed to the
71 * This flag should be set on initialization and the computation should
72 * be performed only once, on first update.
74 unsigned int flag_compute_z_digest : 1;
76 char mdname[OSSL_MAX_NAME_SIZE];
78 /* The Algorithm Identifier of the combined signature algorithm */
79 unsigned char aid_buf[OSSL_MAX_ALGORITHM_ID_SIZE];
88 /* SM2 ID used for calculating the Z value */
93 static int sm2sig_set_mdname(PROV_SM2_CTX *psm2ctx, const char *mdname)
95 if (psm2ctx->md == NULL) /* We need an SM3 md to compare with */
96 psm2ctx->md = EVP_MD_fetch(psm2ctx->libctx, psm2ctx->mdname,
98 if (psm2ctx->md == NULL)
104 if (strlen(mdname) >= sizeof(psm2ctx->mdname)
105 || !EVP_MD_is_a(psm2ctx->md, mdname)) {
106 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST, "digest=%s",
111 OPENSSL_strlcpy(psm2ctx->mdname, mdname, sizeof(psm2ctx->mdname));
115 static void *sm2sig_newctx(void *provctx, const char *propq)
117 PROV_SM2_CTX *ctx = OPENSSL_zalloc(sizeof(PROV_SM2_CTX));
122 ctx->libctx = PROV_LIBCTX_OF(provctx);
123 if (propq != NULL && (ctx->propq = OPENSSL_strdup(propq)) == NULL) {
125 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
128 ctx->mdsize = SM3_DIGEST_LENGTH;
129 strcpy(ctx->mdname, OSSL_DIGEST_NAME_SM3);
133 static int sm2sig_signature_init(void *vpsm2ctx, void *ec,
134 const OSSL_PARAM params[])
136 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
138 if (!ossl_prov_is_running()
142 if (ec == NULL && psm2ctx->ec == NULL) {
143 ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
148 if (!EC_KEY_up_ref(ec))
150 EC_KEY_free(psm2ctx->ec);
154 return sm2sig_set_ctx_params(psm2ctx, params);
157 static int sm2sig_sign(void *vpsm2ctx, unsigned char *sig, size_t *siglen,
158 size_t sigsize, const unsigned char *tbs, size_t tbslen)
160 PROV_SM2_CTX *ctx = (PROV_SM2_CTX *)vpsm2ctx;
163 /* SM2 uses ECDSA_size as well */
164 size_t ecsize = ECDSA_size(ctx->ec);
171 if (sigsize < (size_t)ecsize)
174 if (ctx->mdsize != 0 && tbslen != ctx->mdsize)
177 ret = ossl_sm2_internal_sign(tbs, tbslen, sig, &sltmp, ctx->ec);
185 static int sm2sig_verify(void *vpsm2ctx, const unsigned char *sig, size_t siglen,
186 const unsigned char *tbs, size_t tbslen)
188 PROV_SM2_CTX *ctx = (PROV_SM2_CTX *)vpsm2ctx;
190 if (ctx->mdsize != 0 && tbslen != ctx->mdsize)
193 return ossl_sm2_internal_verify(tbs, tbslen, sig, siglen, ctx->ec);
196 static void free_md(PROV_SM2_CTX *ctx)
198 EVP_MD_CTX_free(ctx->mdctx);
199 EVP_MD_free(ctx->md);
204 static int sm2sig_digest_signverify_init(void *vpsm2ctx, const char *mdname,
205 void *ec, const OSSL_PARAM params[])
207 PROV_SM2_CTX *ctx = (PROV_SM2_CTX *)vpsm2ctx;
212 if (!sm2sig_signature_init(vpsm2ctx, ec, params)
213 || !sm2sig_set_mdname(ctx, mdname))
216 if (ctx->mdctx == NULL) {
217 ctx->mdctx = EVP_MD_CTX_new();
218 if (ctx->mdctx == NULL)
222 md_nid = EVP_MD_get_type(ctx->md);
225 * We do not care about DER writing errors.
226 * All it really means is that for some reason, there's no
227 * AlgorithmIdentifier to be had, but the operation itself is
228 * still valid, just as long as it's not used to construct
229 * anything that needs an AlgorithmIdentifier.
232 if (WPACKET_init_der(&pkt, ctx->aid_buf, sizeof(ctx->aid_buf))
233 && ossl_DER_w_algorithmIdentifier_SM2_with_MD(&pkt, -1, ctx->ec, md_nid)
234 && WPACKET_finish(&pkt)) {
235 WPACKET_get_total_written(&pkt, &ctx->aid_len);
236 ctx->aid = WPACKET_get_curr(&pkt);
238 WPACKET_cleanup(&pkt);
240 if (!EVP_DigestInit_ex2(ctx->mdctx, ctx->md, params))
243 ctx->flag_compute_z_digest = 1;
251 static int sm2sig_compute_z_digest(PROV_SM2_CTX *ctx)
256 if (ctx->flag_compute_z_digest) {
257 /* Only do this once */
258 ctx->flag_compute_z_digest = 0;
260 if ((z = OPENSSL_zalloc(ctx->mdsize)) == NULL
261 /* get hashed prefix 'z' of tbs message */
262 || !ossl_sm2_compute_z_digest(z, ctx->md, ctx->id, ctx->id_len,
264 || !EVP_DigestUpdate(ctx->mdctx, z, ctx->mdsize))
272 int sm2sig_digest_signverify_update(void *vpsm2ctx, const unsigned char *data,
275 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
277 if (psm2ctx == NULL || psm2ctx->mdctx == NULL)
280 return sm2sig_compute_z_digest(psm2ctx)
281 && EVP_DigestUpdate(psm2ctx->mdctx, data, datalen);
284 int sm2sig_digest_sign_final(void *vpsm2ctx, unsigned char *sig, size_t *siglen,
287 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
288 unsigned char digest[EVP_MAX_MD_SIZE];
289 unsigned int dlen = 0;
291 if (psm2ctx == NULL || psm2ctx->mdctx == NULL)
295 * If sig is NULL then we're just finding out the sig size. Other fields
296 * are ignored. Defer to sm2sig_sign.
299 if (!(sm2sig_compute_z_digest(psm2ctx)
300 && EVP_DigestFinal_ex(psm2ctx->mdctx, digest, &dlen)))
304 return sm2sig_sign(vpsm2ctx, sig, siglen, sigsize, digest, (size_t)dlen);
308 int sm2sig_digest_verify_final(void *vpsm2ctx, const unsigned char *sig,
311 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
312 unsigned char digest[EVP_MAX_MD_SIZE];
313 unsigned int dlen = 0;
316 || psm2ctx->mdctx == NULL
317 || EVP_MD_get_size(psm2ctx->md) > (int)sizeof(digest))
320 if (!(sm2sig_compute_z_digest(psm2ctx)
321 && EVP_DigestFinal_ex(psm2ctx->mdctx, digest, &dlen)))
324 return sm2sig_verify(vpsm2ctx, sig, siglen, digest, (size_t)dlen);
327 static void sm2sig_freectx(void *vpsm2ctx)
329 PROV_SM2_CTX *ctx = (PROV_SM2_CTX *)vpsm2ctx;
332 EC_KEY_free(ctx->ec);
333 OPENSSL_free(ctx->id);
337 static void *sm2sig_dupctx(void *vpsm2ctx)
339 PROV_SM2_CTX *srcctx = (PROV_SM2_CTX *)vpsm2ctx;
340 PROV_SM2_CTX *dstctx;
342 dstctx = OPENSSL_zalloc(sizeof(*srcctx));
349 dstctx->mdctx = NULL;
351 if (srcctx->ec != NULL && !EC_KEY_up_ref(srcctx->ec))
353 dstctx->ec = srcctx->ec;
355 if (srcctx->md != NULL && !EVP_MD_up_ref(srcctx->md))
357 dstctx->md = srcctx->md;
359 if (srcctx->mdctx != NULL) {
360 dstctx->mdctx = EVP_MD_CTX_new();
361 if (dstctx->mdctx == NULL
362 || !EVP_MD_CTX_copy_ex(dstctx->mdctx, srcctx->mdctx))
366 if (srcctx->id != NULL) {
367 dstctx->id = OPENSSL_malloc(srcctx->id_len);
368 if (dstctx->id == NULL)
370 dstctx->id_len = srcctx->id_len;
371 memcpy(dstctx->id, srcctx->id, srcctx->id_len);
376 sm2sig_freectx(dstctx);
380 static int sm2sig_get_ctx_params(void *vpsm2ctx, OSSL_PARAM *params)
382 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
388 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_ALGORITHM_ID);
390 && !OSSL_PARAM_set_octet_string(p, psm2ctx->aid, psm2ctx->aid_len))
393 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_DIGEST_SIZE);
394 if (p != NULL && !OSSL_PARAM_set_size_t(p, psm2ctx->mdsize))
397 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_DIGEST);
398 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, psm2ctx->md == NULL
400 : EVP_MD_get0_name(psm2ctx->md)))
406 static const OSSL_PARAM known_gettable_ctx_params[] = {
407 OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID, NULL, 0),
408 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE, NULL),
409 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
413 static const OSSL_PARAM *sm2sig_gettable_ctx_params(ossl_unused void *vpsm2ctx,
414 ossl_unused void *provctx)
416 return known_gettable_ctx_params;
419 static int sm2sig_set_ctx_params(void *vpsm2ctx, const OSSL_PARAM params[])
421 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
430 p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DIST_ID);
433 size_t tmp_idlen = 0;
436 * If the 'z' digest has already been computed, the ID is set too late
438 if (!psm2ctx->flag_compute_z_digest)
441 if (p->data_size != 0
442 && !OSSL_PARAM_get_octet_string(p, &tmp_id, 0, &tmp_idlen))
444 OPENSSL_free(psm2ctx->id);
445 psm2ctx->id = tmp_id;
446 psm2ctx->id_len = tmp_idlen;
450 * The following code checks that the size is the same as the SM3 digest
451 * size returning an error otherwise.
452 * If there is ever any different digest algorithm allowed with SM2
453 * this needs to be adjusted accordingly.
455 p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_DIGEST_SIZE);
456 if (p != NULL && (!OSSL_PARAM_get_size_t(p, &mdsize)
457 || mdsize != psm2ctx->mdsize))
460 p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_DIGEST);
464 if (!OSSL_PARAM_get_utf8_string(p, &mdname, 0))
466 if (!sm2sig_set_mdname(psm2ctx, mdname)) {
467 OPENSSL_free(mdname);
470 OPENSSL_free(mdname);
476 static const OSSL_PARAM known_settable_ctx_params[] = {
477 OSSL_PARAM_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE, NULL),
478 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
479 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_DIST_ID, NULL, 0),
483 static const OSSL_PARAM *sm2sig_settable_ctx_params(ossl_unused void *vpsm2ctx,
484 ossl_unused void *provctx)
486 return known_settable_ctx_params;
489 static int sm2sig_get_ctx_md_params(void *vpsm2ctx, OSSL_PARAM *params)
491 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
493 if (psm2ctx->mdctx == NULL)
496 return EVP_MD_CTX_get_params(psm2ctx->mdctx, params);
499 static const OSSL_PARAM *sm2sig_gettable_ctx_md_params(void *vpsm2ctx)
501 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
503 if (psm2ctx->md == NULL)
506 return EVP_MD_gettable_ctx_params(psm2ctx->md);
509 static int sm2sig_set_ctx_md_params(void *vpsm2ctx, const OSSL_PARAM params[])
511 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
513 if (psm2ctx->mdctx == NULL)
516 return EVP_MD_CTX_set_params(psm2ctx->mdctx, params);
519 static const OSSL_PARAM *sm2sig_settable_ctx_md_params(void *vpsm2ctx)
521 PROV_SM2_CTX *psm2ctx = (PROV_SM2_CTX *)vpsm2ctx;
523 if (psm2ctx->md == NULL)
526 return EVP_MD_settable_ctx_params(psm2ctx->md);
529 const OSSL_DISPATCH ossl_sm2_signature_functions[] = {
530 { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))sm2sig_newctx },
531 { OSSL_FUNC_SIGNATURE_SIGN_INIT, (void (*)(void))sm2sig_signature_init },
532 { OSSL_FUNC_SIGNATURE_SIGN, (void (*)(void))sm2sig_sign },
533 { OSSL_FUNC_SIGNATURE_VERIFY_INIT, (void (*)(void))sm2sig_signature_init },
534 { OSSL_FUNC_SIGNATURE_VERIFY, (void (*)(void))sm2sig_verify },
535 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,
536 (void (*)(void))sm2sig_digest_signverify_init },
537 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE,
538 (void (*)(void))sm2sig_digest_signverify_update },
539 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL,
540 (void (*)(void))sm2sig_digest_sign_final },
541 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,
542 (void (*)(void))sm2sig_digest_signverify_init },
543 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE,
544 (void (*)(void))sm2sig_digest_signverify_update },
545 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL,
546 (void (*)(void))sm2sig_digest_verify_final },
547 { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))sm2sig_freectx },
548 { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))sm2sig_dupctx },
549 { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS, (void (*)(void))sm2sig_get_ctx_params },
550 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,
551 (void (*)(void))sm2sig_gettable_ctx_params },
552 { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS, (void (*)(void))sm2sig_set_ctx_params },
553 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS,
554 (void (*)(void))sm2sig_settable_ctx_params },
555 { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS,
556 (void (*)(void))sm2sig_get_ctx_md_params },
557 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS,
558 (void (*)(void))sm2sig_gettable_ctx_md_params },
559 { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS,
560 (void (*)(void))sm2sig_set_ctx_md_params },
561 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS,
562 (void (*)(void))sm2sig_settable_ctx_md_params },