Path: blob/main/crypto/openssl/providers/implementations/keymgmt/ecx_kmgmt.c
101200 views
/*1* Copyright 2020-2025 The OpenSSL Project Authors. All Rights Reserved.2*3* Licensed under the Apache License 2.0 (the "License"). You may not use4* this file except in compliance with the License. You can obtain a copy5* in the file LICENSE in the source distribution or at6* https://www.openssl.org/source/license.html7*/89#include <assert.h>10#include <string.h>11#include <openssl/core_dispatch.h>12#include <openssl/core_names.h>13#include <openssl/params.h>14#include <openssl/err.h>15#include <openssl/proverr.h>16#include <openssl/evp.h>17#include <openssl/rand.h>18#include <openssl/self_test.h>19#include "internal/fips.h"20#include "internal/param_build_set.h"21#include <openssl/param_build.h>22#include "crypto/ecx.h"23#include "prov/implementations.h"24#include "prov/providercommon.h"25#include "prov/provider_ctx.h"26#include "prov/ecx.h"27#include "prov/securitycheck.h"28#ifdef S390X_EC_ASM29#include "s390x_arch.h"30#include <openssl/sha.h> /* For SHA512_DIGEST_LENGTH */31#endif3233static OSSL_FUNC_keymgmt_new_fn x25519_new_key;34static OSSL_FUNC_keymgmt_new_fn x448_new_key;35static OSSL_FUNC_keymgmt_new_fn ed25519_new_key;36static OSSL_FUNC_keymgmt_new_fn ed448_new_key;37static OSSL_FUNC_keymgmt_gen_init_fn x25519_gen_init;38static OSSL_FUNC_keymgmt_gen_init_fn x448_gen_init;39static OSSL_FUNC_keymgmt_gen_init_fn ed25519_gen_init;40static OSSL_FUNC_keymgmt_gen_init_fn ed448_gen_init;41static OSSL_FUNC_keymgmt_gen_fn x25519_gen;42static OSSL_FUNC_keymgmt_gen_fn x448_gen;43static OSSL_FUNC_keymgmt_gen_fn ed25519_gen;44static OSSL_FUNC_keymgmt_gen_fn ed448_gen;45static OSSL_FUNC_keymgmt_gen_cleanup_fn ecx_gen_cleanup;46static OSSL_FUNC_keymgmt_gen_set_params_fn ecx_gen_set_params;47static OSSL_FUNC_keymgmt_gen_settable_params_fn ecx_gen_settable_params;48static OSSL_FUNC_keymgmt_load_fn ecx_load;49static OSSL_FUNC_keymgmt_get_params_fn x25519_get_params;50static OSSL_FUNC_keymgmt_get_params_fn x448_get_params;51static OSSL_FUNC_keymgmt_get_params_fn ed25519_get_params;52static OSSL_FUNC_keymgmt_get_params_fn ed448_get_params;53static OSSL_FUNC_keymgmt_gettable_params_fn x25519_gettable_params;54static OSSL_FUNC_keymgmt_gettable_params_fn x448_gettable_params;55static OSSL_FUNC_keymgmt_gettable_params_fn ed25519_gettable_params;56static OSSL_FUNC_keymgmt_gettable_params_fn ed448_gettable_params;57static OSSL_FUNC_keymgmt_set_params_fn x25519_set_params;58static OSSL_FUNC_keymgmt_set_params_fn x448_set_params;59static OSSL_FUNC_keymgmt_set_params_fn ed25519_set_params;60static OSSL_FUNC_keymgmt_set_params_fn ed448_set_params;61static OSSL_FUNC_keymgmt_settable_params_fn x25519_settable_params;62static OSSL_FUNC_keymgmt_settable_params_fn x448_settable_params;63static OSSL_FUNC_keymgmt_settable_params_fn ed25519_settable_params;64static OSSL_FUNC_keymgmt_settable_params_fn ed448_settable_params;65static OSSL_FUNC_keymgmt_has_fn ecx_has;66static OSSL_FUNC_keymgmt_match_fn ecx_match;67static OSSL_FUNC_keymgmt_validate_fn x25519_validate;68static OSSL_FUNC_keymgmt_validate_fn x448_validate;69static OSSL_FUNC_keymgmt_validate_fn ed25519_validate;70static OSSL_FUNC_keymgmt_validate_fn ed448_validate;71static OSSL_FUNC_keymgmt_import_fn ecx_import;72static OSSL_FUNC_keymgmt_import_types_fn ecx_imexport_types;73static OSSL_FUNC_keymgmt_export_fn ecx_export;74static OSSL_FUNC_keymgmt_export_types_fn ecx_imexport_types;75static OSSL_FUNC_keymgmt_dup_fn ecx_dup;7677#define ECX_POSSIBLE_SELECTIONS (OSSL_KEYMGMT_SELECT_KEYPAIR)7879struct ecx_gen_ctx {80OSSL_LIB_CTX *libctx;81char *propq;82ECX_KEY_TYPE type;83int selection;84unsigned char *dhkem_ikm;85size_t dhkem_ikmlen;86};8788#ifdef S390X_EC_ASM89static void *s390x_ecx_keygen25519(struct ecx_gen_ctx *gctx);90static void *s390x_ecx_keygen448(struct ecx_gen_ctx *gctx);91static void *s390x_ecd_keygen25519(struct ecx_gen_ctx *gctx);92static void *s390x_ecd_keygen448(struct ecx_gen_ctx *gctx);93#endif9495#ifdef FIPS_MODULE96static int ecd_fips140_pairwise_test(const ECX_KEY *ecx, int type, int self_test);97#endif /* FIPS_MODULE */9899static ossl_inline int ecx_key_type_is_ed(ECX_KEY_TYPE type)100{101return type == ECX_KEY_TYPE_ED25519 || type == ECX_KEY_TYPE_ED448;102}103104static void *x25519_new_key(void *provctx)105{106if (!ossl_prov_is_running())107return 0;108return ossl_ecx_key_new(PROV_LIBCTX_OF(provctx), ECX_KEY_TYPE_X25519, 0,109NULL);110}111112static void *x448_new_key(void *provctx)113{114if (!ossl_prov_is_running())115return 0;116return ossl_ecx_key_new(PROV_LIBCTX_OF(provctx), ECX_KEY_TYPE_X448, 0,117NULL);118}119120static void *ed25519_new_key(void *provctx)121{122if (!ossl_prov_is_running())123return 0;124return ossl_ecx_key_new(PROV_LIBCTX_OF(provctx), ECX_KEY_TYPE_ED25519, 0,125NULL);126}127128static void *ed448_new_key(void *provctx)129{130if (!ossl_prov_is_running())131return 0;132return ossl_ecx_key_new(PROV_LIBCTX_OF(provctx), ECX_KEY_TYPE_ED448, 0,133NULL);134}135136static int ecx_has(const void *keydata, int selection)137{138const ECX_KEY *key = keydata;139int ok = 0;140141if (ossl_prov_is_running() && key != NULL) {142/*143* ECX keys always have all the parameters they need (i.e. none).144* Therefore we always return with 1, if asked about parameters.145*/146ok = 1;147148if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)149ok = ok && key->haspubkey;150151if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)152ok = ok && key->privkey != NULL;153}154return ok;155}156157static int ecx_match(const void *keydata1, const void *keydata2, int selection)158{159const ECX_KEY *key1 = keydata1;160const ECX_KEY *key2 = keydata2;161int ok = 1;162163if (!ossl_prov_is_running())164return 0;165166if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)167ok = ok && key1->type == key2->type;168if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {169int key_checked = 0;170171if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {172const unsigned char *pa = key1->haspubkey ? key1->pubkey : NULL;173const unsigned char *pb = key2->haspubkey ? key2->pubkey : NULL;174size_t pal = key1->keylen;175size_t pbl = key2->keylen;176177if (pa != NULL && pb != NULL) {178ok = ok179&& key1->type == key2->type180&& pal == pbl181&& CRYPTO_memcmp(pa, pb, pal) == 0;182key_checked = 1;183}184}185if (!key_checked186&& (selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {187const unsigned char *pa = key1->privkey;188const unsigned char *pb = key2->privkey;189size_t pal = key1->keylen;190size_t pbl = key2->keylen;191192if (pa != NULL && pb != NULL) {193ok = ok194&& key1->type == key2->type195&& pal == pbl196&& CRYPTO_memcmp(pa, pb, pal) == 0;197key_checked = 1;198}199}200ok = ok && key_checked;201}202return ok;203}204205static int ecx_import(void *keydata, int selection, const OSSL_PARAM params[])206{207ECX_KEY *key = keydata;208int ok = 1;209int include_private;210211if (!ossl_prov_is_running() || key == NULL)212return 0;213214if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)215return 0;216217include_private = selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;218ok = ok && ossl_ecx_key_fromdata(key, params, include_private);219220return ok;221}222223static int key_to_params(ECX_KEY *key, OSSL_PARAM_BLD *tmpl,224OSSL_PARAM params[], int include_private)225{226if (key == NULL)227return 0;228229if (!ossl_param_build_set_octet_string(tmpl, params,230OSSL_PKEY_PARAM_PUB_KEY,231key->pubkey, key->keylen))232return 0;233234if (include_private235&& key->privkey != NULL236&& !ossl_param_build_set_octet_string(tmpl, params,237OSSL_PKEY_PARAM_PRIV_KEY,238key->privkey, key->keylen))239return 0;240241return 1;242}243244static int ecx_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,245void *cbarg)246{247ECX_KEY *key = keydata;248OSSL_PARAM_BLD *tmpl;249OSSL_PARAM *params = NULL;250int ret = 0;251252if (!ossl_prov_is_running() || key == NULL)253return 0;254255if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)256return 0;257258tmpl = OSSL_PARAM_BLD_new();259if (tmpl == NULL)260return 0;261262if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {263int include_private = ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0);264265if (!key_to_params(key, tmpl, NULL, include_private))266goto err;267}268269params = OSSL_PARAM_BLD_to_param(tmpl);270if (params == NULL)271goto err;272273ret = param_cb(params, cbarg);274OSSL_PARAM_free(params);275err:276OSSL_PARAM_BLD_free(tmpl);277return ret;278}279280#define ECX_KEY_TYPES() \281OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0), \282OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0)283284static const OSSL_PARAM ecx_key_types[] = {285ECX_KEY_TYPES(),286OSSL_PARAM_END287};288static const OSSL_PARAM *ecx_imexport_types(int selection)289{290if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)291return ecx_key_types;292return NULL;293}294295static int ecx_get_params(void *key, OSSL_PARAM params[], int bits, int secbits,296int size)297{298ECX_KEY *ecx = key;299OSSL_PARAM *p;300301if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL302&& !OSSL_PARAM_set_int(p, bits))303return 0;304if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL305&& !OSSL_PARAM_set_int(p, secbits))306return 0;307if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL308&& !OSSL_PARAM_set_int(p, size))309return 0;310if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY)) != NULL311&& (ecx->type == ECX_KEY_TYPE_X25519312|| ecx->type == ECX_KEY_TYPE_X448)) {313if (!OSSL_PARAM_set_octet_string(p, ecx->pubkey, ecx->keylen))314return 0;315}316#ifdef FIPS_MODULE317{318/* X25519 and X448 are not approved */319int approved = 0;320321p = OSSL_PARAM_locate(params, OSSL_ALG_PARAM_FIPS_APPROVED_INDICATOR);322if (p != NULL && !OSSL_PARAM_set_int(p, approved))323return 0;324}325#endif326327return key_to_params(ecx, NULL, params, 1);328}329330static int ed_get_params(void *key, OSSL_PARAM params[])331{332OSSL_PARAM *p;333334if ((p = OSSL_PARAM_locate(params,335OSSL_PKEY_PARAM_MANDATORY_DIGEST))336!= NULL337&& !OSSL_PARAM_set_utf8_string(p, ""))338return 0;339return 1;340}341342static int x25519_get_params(void *key, OSSL_PARAM params[])343{344return ecx_get_params(key, params, X25519_BITS, X25519_SECURITY_BITS,345X25519_KEYLEN);346}347348static int x448_get_params(void *key, OSSL_PARAM params[])349{350return ecx_get_params(key, params, X448_BITS, X448_SECURITY_BITS,351X448_KEYLEN);352}353354static int ed25519_get_params(void *key, OSSL_PARAM params[])355{356return ecx_get_params(key, params, ED25519_BITS, ED25519_SECURITY_BITS,357ED25519_SIGSIZE)358&& ed_get_params(key, params);359}360361static int ed448_get_params(void *key, OSSL_PARAM params[])362{363return ecx_get_params(key, params, ED448_BITS, ED448_SECURITY_BITS,364ED448_SIGSIZE)365&& ed_get_params(key, params);366}367368static const OSSL_PARAM ecx_gettable_params[] = {369OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),370OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),371OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),372OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),373ECX_KEY_TYPES(),374OSSL_FIPS_IND_GETTABLE_CTX_PARAM()375OSSL_PARAM_END376};377378static const OSSL_PARAM ed_gettable_params[] = {379OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),380OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),381OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),382OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_MANDATORY_DIGEST, NULL, 0),383ECX_KEY_TYPES(),384OSSL_PARAM_END385};386387static const OSSL_PARAM *x25519_gettable_params(void *provctx)388{389return ecx_gettable_params;390}391392static const OSSL_PARAM *x448_gettable_params(void *provctx)393{394return ecx_gettable_params;395}396397static const OSSL_PARAM *ed25519_gettable_params(void *provctx)398{399return ed_gettable_params;400}401402static const OSSL_PARAM *ed448_gettable_params(void *provctx)403{404return ed_gettable_params;405}406407static int set_property_query(ECX_KEY *ecxkey, const char *propq)408{409OPENSSL_free(ecxkey->propq);410ecxkey->propq = NULL;411if (propq != NULL) {412ecxkey->propq = OPENSSL_strdup(propq);413if (ecxkey->propq == NULL)414return 0;415}416return 1;417}418419static int ecx_set_params(void *key, const OSSL_PARAM params[])420{421ECX_KEY *ecxkey = key;422const OSSL_PARAM *p;423424if (ossl_param_is_empty(params))425return 1;426427p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY);428if (p != NULL) {429void *buf = ecxkey->pubkey;430431if (p->data_size != ecxkey->keylen432|| !OSSL_PARAM_get_octet_string(p, &buf, sizeof(ecxkey->pubkey),433NULL))434return 0;435OPENSSL_clear_free(ecxkey->privkey, ecxkey->keylen);436ecxkey->privkey = NULL;437ecxkey->haspubkey = 1;438}439p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PROPERTIES);440if (p != NULL) {441if (p->data_type != OSSL_PARAM_UTF8_STRING442|| !set_property_query(ecxkey, p->data))443return 0;444}445446return 1;447}448449static int x25519_set_params(void *key, const OSSL_PARAM params[])450{451return ecx_set_params(key, params);452}453454static int x448_set_params(void *key, const OSSL_PARAM params[])455{456return ecx_set_params(key, params);457}458459static int ed25519_set_params(void *key, const OSSL_PARAM params[])460{461return 1;462}463464static int ed448_set_params(void *key, const OSSL_PARAM params[])465{466return 1;467}468469static const OSSL_PARAM ecx_settable_params[] = {470OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),471OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),472OSSL_PARAM_END473};474475static const OSSL_PARAM ed_settable_params[] = {476OSSL_PARAM_END477};478479static const OSSL_PARAM *x25519_settable_params(void *provctx)480{481return ecx_settable_params;482}483484static const OSSL_PARAM *x448_settable_params(void *provctx)485{486return ecx_settable_params;487}488489static const OSSL_PARAM *ed25519_settable_params(void *provctx)490{491return ed_settable_params;492}493494static const OSSL_PARAM *ed448_settable_params(void *provctx)495{496return ed_settable_params;497}498499static void *ecx_gen_init(void *provctx, int selection,500const OSSL_PARAM params[], ECX_KEY_TYPE type,501const char *algdesc)502{503OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);504struct ecx_gen_ctx *gctx = NULL;505506if (!ossl_prov_is_running())507return NULL;508509if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {510gctx->libctx = libctx;511gctx->type = type;512gctx->selection = selection;513#ifdef FIPS_MODULE514/* X25519/X448 are not FIPS approved, (ED25519/ED448 are approved) */515if (algdesc != NULL516&& !ossl_FIPS_IND_callback(libctx, algdesc, "KeyGen Init")) {517OPENSSL_free(gctx);518return NULL;519}520#endif521} else {522return NULL;523}524if (!ecx_gen_set_params(gctx, params)) {525ecx_gen_cleanup(gctx);526gctx = NULL;527}528return gctx;529}530531static void *x25519_gen_init(void *provctx, int selection,532const OSSL_PARAM params[])533{534return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_X25519, "X25519");535}536537static void *x448_gen_init(void *provctx, int selection,538const OSSL_PARAM params[])539{540return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_X448, "X448");541}542543static void *ed25519_gen_init(void *provctx, int selection,544const OSSL_PARAM params[])545{546return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_ED25519, NULL);547}548549static void *ed448_gen_init(void *provctx, int selection,550const OSSL_PARAM params[])551{552return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_ED448, NULL);553}554555static int ecx_gen_set_params(void *genctx, const OSSL_PARAM params[])556{557struct ecx_gen_ctx *gctx = genctx;558const OSSL_PARAM *p;559560if (gctx == NULL)561return 0;562563p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_GROUP_NAME);564if (p != NULL) {565const char *groupname = NULL;566567/*568* We optionally allow setting a group name - but each algorithm only569* support one such name, so all we do is verify that it is the one we570* expected.571*/572switch (gctx->type) {573case ECX_KEY_TYPE_X25519:574groupname = "x25519";575break;576case ECX_KEY_TYPE_X448:577groupname = "x448";578break;579default:580/* We only support this for key exchange at the moment */581break;582}583if (p->data_type != OSSL_PARAM_UTF8_STRING584|| groupname == NULL585|| OPENSSL_strcasecmp(p->data, groupname) != 0) {586ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);587return 0;588}589}590p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PROPERTIES);591if (p != NULL) {592if (p->data_type != OSSL_PARAM_UTF8_STRING)593return 0;594OPENSSL_free(gctx->propq);595gctx->propq = OPENSSL_strdup(p->data);596if (gctx->propq == NULL)597return 0;598}599p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DHKEM_IKM);600if (p != NULL) {601if (p->data_size != 0 && p->data != NULL) {602OPENSSL_free(gctx->dhkem_ikm);603gctx->dhkem_ikm = NULL;604if (!OSSL_PARAM_get_octet_string(p, (void **)&gctx->dhkem_ikm, 0,605&gctx->dhkem_ikmlen))606return 0;607}608}609610return 1;611}612613static const OSSL_PARAM *ecx_gen_settable_params(ossl_unused void *genctx,614ossl_unused void *provctx)615{616static OSSL_PARAM settable[] = {617OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME, NULL, 0),618OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),619OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_DHKEM_IKM, NULL, 0),620OSSL_PARAM_END621};622return settable;623}624625#ifdef FIPS_MODULE626/*627* Refer: FIPS 140-3 IG 10.3.A Additional Comment 1628* Perform a pairwise test for EDDSA by signing and verifying signature.629*630* The parameter `self_test` is used to indicate whether to create OSSL_SELF_TEST631* instance.632*/633static int ecd_fips140_pairwise_test(const ECX_KEY *ecx, int type, int self_test)634{635int ret = 0;636OSSL_SELF_TEST *st = NULL;637OSSL_CALLBACK *cb = NULL;638void *cbarg = NULL;639640unsigned char msg[16] = { 0 };641size_t msg_len = sizeof(msg);642unsigned char sig[ED448_SIGSIZE] = { 0 };643644int is_ed25519 = (type == ECX_KEY_TYPE_ED25519) ? 1 : 0;645int operation_result = 0;646647/*648* The functions `OSSL_SELF_TEST_*` will return directly if parameter `st`649* is NULL.650*/651if (self_test) {652OSSL_SELF_TEST_get_callback(ecx->libctx, &cb, &cbarg);653654st = OSSL_SELF_TEST_new(cb, cbarg);655if (st == NULL)656return 0;657}658659OSSL_SELF_TEST_onbegin(st, OSSL_SELF_TEST_TYPE_PCT,660OSSL_SELF_TEST_DESC_PCT_EDDSA);661662if (is_ed25519)663operation_result = ossl_ed25519_sign(sig, msg, msg_len, ecx->pubkey,664ecx->privkey, 0, 0, 0, NULL, 0,665ecx->libctx, ecx->propq);666else667operation_result = ossl_ed448_sign(ecx->libctx, sig, msg, msg_len,668ecx->pubkey, ecx->privkey, NULL, 0,6690, ecx->propq);670if (operation_result != 1)671goto err;672673OSSL_SELF_TEST_oncorrupt_byte(st, sig);674675if (is_ed25519)676operation_result = ossl_ed25519_verify(msg, msg_len, sig, ecx->pubkey,6770, 0, 0, NULL, 0, ecx->libctx,678ecx->propq);679else680operation_result = ossl_ed448_verify(ecx->libctx, msg, msg_len, sig,681ecx->pubkey, NULL, 0, 0, ecx->propq);682if (operation_result != 1)683goto err;684685ret = 1;686err:687OSSL_SELF_TEST_onend(st, ret);688OSSL_SELF_TEST_free(st);689return ret;690}691#endif692693static void *ecx_gen(struct ecx_gen_ctx *gctx)694{695ECX_KEY *key;696unsigned char *privkey;697698if (gctx == NULL)699return NULL;700if ((key = ossl_ecx_key_new(gctx->libctx, gctx->type, 0,701gctx->propq))702== NULL) {703ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);704return NULL;705}706707/* If we're doing parameter generation then we just return a blank key */708if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)709return key;710711if ((privkey = ossl_ecx_key_allocate_privkey(key)) == NULL) {712ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);713goto err;714}715#ifndef FIPS_MODULE716if (gctx->dhkem_ikm != NULL && gctx->dhkem_ikmlen != 0) {717if (ecx_key_type_is_ed(gctx->type))718goto err;719if (!ossl_ecx_dhkem_derive_private(key, privkey,720gctx->dhkem_ikm, gctx->dhkem_ikmlen))721goto err;722} else723#endif724{725if (RAND_priv_bytes_ex(gctx->libctx, privkey, key->keylen, 0) <= 0)726goto err;727}728729switch (gctx->type) {730case ECX_KEY_TYPE_X25519:731privkey[0] &= 248;732privkey[X25519_KEYLEN - 1] &= 127;733privkey[X25519_KEYLEN - 1] |= 64;734ossl_x25519_public_from_private(key->pubkey, privkey);735break;736case ECX_KEY_TYPE_X448:737privkey[0] &= 252;738privkey[X448_KEYLEN - 1] |= 128;739ossl_x448_public_from_private(key->pubkey, privkey);740break;741case ECX_KEY_TYPE_ED25519:742if (!ossl_ed25519_public_from_private(gctx->libctx, key->pubkey, privkey,743gctx->propq))744goto err;745break;746case ECX_KEY_TYPE_ED448:747if (!ossl_ed448_public_from_private(gctx->libctx, key->pubkey, privkey,748gctx->propq))749goto err;750break;751}752key->haspubkey = 1;753return key;754err:755ossl_ecx_key_free(key);756return NULL;757}758759static void *x25519_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)760{761struct ecx_gen_ctx *gctx = genctx;762763if (!ossl_prov_is_running())764return 0;765766#ifdef S390X_EC_ASM767if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_X25519))768return s390x_ecx_keygen25519(gctx);769#endif770return ecx_gen(gctx);771}772773static void *x448_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)774{775struct ecx_gen_ctx *gctx = genctx;776777if (!ossl_prov_is_running())778return 0;779780#ifdef S390X_EC_ASM781if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_X448))782return s390x_ecx_keygen448(gctx);783#endif784return ecx_gen(gctx);785}786787static void *ed25519_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)788{789ECX_KEY *key = NULL;790struct ecx_gen_ctx *gctx = genctx;791792if (!ossl_prov_is_running())793return 0;794795#ifdef S390X_EC_ASM796if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_ED25519)797&& OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_SIGN_ED25519)798&& OPENSSL_s390xcap_P.kdsa[0]799& S390X_CAPBIT(S390X_EDDSA_VERIFY_ED25519)) {800key = s390x_ecd_keygen25519(gctx);801} else802#endif803{804key = ecx_gen(gctx);805}806807#ifdef FIPS_MODULE808/* Exit if keygen failed OR we are doing parameter generation (blank key) */809if (!key || ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0))810return key;811if (ecd_fips140_pairwise_test(key, ECX_KEY_TYPE_ED25519, 1) != 1) {812ossl_set_error_state(OSSL_SELF_TEST_TYPE_PCT);813ossl_ecx_key_free(key);814return NULL;815}816#endif817818return key;819}820821static void *ed448_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)822{823ECX_KEY *key = NULL;824struct ecx_gen_ctx *gctx = genctx;825826if (!ossl_prov_is_running())827return 0;828829#ifdef S390X_EC_ASM830if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_ED448)831&& OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_SIGN_ED448)832&& OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_VERIFY_ED448)) {833key = s390x_ecd_keygen448(gctx);834} else835#endif836{837key = ecx_gen(gctx);838}839840#ifdef FIPS_MODULE841/* Exit if keygen failed OR we are doing parameter generation (blank key) */842if (!key || ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0))843return key;844if (ecd_fips140_pairwise_test(key, ECX_KEY_TYPE_ED448, 1) != 1) {845ossl_set_error_state(OSSL_SELF_TEST_TYPE_PCT);846ossl_ecx_key_free(key);847return NULL;848}849#endif850851return key;852}853854static void ecx_gen_cleanup(void *genctx)855{856struct ecx_gen_ctx *gctx = genctx;857858if (gctx == NULL)859return;860861OPENSSL_clear_free(gctx->dhkem_ikm, gctx->dhkem_ikmlen);862OPENSSL_free(gctx->propq);863OPENSSL_free(gctx);864}865866void *ecx_load(const void *reference, size_t reference_sz)867{868ECX_KEY *key = NULL;869870if (ossl_prov_is_running() && reference_sz == sizeof(key)) {871/* The contents of the reference is the address to our object */872key = *(ECX_KEY **)reference;873/* We grabbed, so we detach it */874*(ECX_KEY **)reference = NULL;875return key;876}877return NULL;878}879880static void *ecx_dup(const void *keydata_from, int selection)881{882if (ossl_prov_is_running())883return ossl_ecx_key_dup(keydata_from, selection);884return NULL;885}886887static int ecx_key_pairwise_check(const ECX_KEY *ecx, int type)888{889uint8_t pub[64];890891switch (type) {892case ECX_KEY_TYPE_X25519:893ossl_x25519_public_from_private(pub, ecx->privkey);894break;895case ECX_KEY_TYPE_X448:896ossl_x448_public_from_private(pub, ecx->privkey);897break;898default:899return 0;900}901return CRYPTO_memcmp(ecx->pubkey, pub, ecx->keylen) == 0;902}903904#ifdef FIPS_MODULE905/*906* FIPS ACVP testing requires the ability to check if the public key is valid907* This is not required normally since the ED signature verify does the test908* internally.909*/910static int ecd_key_pub_check(const ECX_KEY *ecx, int type)911{912switch (type) {913case ECX_KEY_TYPE_ED25519:914return ossl_ed25519_pubkey_verify(ecx->pubkey, ecx->keylen);915case ECX_KEY_TYPE_ED448:916return ossl_ed448_pubkey_verify(ecx->pubkey, ecx->keylen);917default:918return 1;919}920}921#endif922923#ifdef FIPS_MODULE924static int ecd_key_pairwise_check(const ECX_KEY *ecx, int type)925{926return ecd_fips140_pairwise_test(ecx, type, 0);927}928#else929static int ecd_key_pairwise_check(const ECX_KEY *ecx, int type)930{931uint8_t pub[64];932933switch (type) {934case ECX_KEY_TYPE_ED25519:935if (!ossl_ed25519_public_from_private(ecx->libctx, pub, ecx->privkey,936ecx->propq))937return 0;938break;939case ECX_KEY_TYPE_ED448:940if (!ossl_ed448_public_from_private(ecx->libctx, pub, ecx->privkey,941ecx->propq))942return 0;943break;944default:945return 0;946}947return CRYPTO_memcmp(ecx->pubkey, pub, ecx->keylen) == 0;948}949#endif950951static int ecx_validate(const void *keydata, int selection, int type,952size_t keylen)953{954const ECX_KEY *ecx = keydata;955int ok = keylen == ecx->keylen;956957if (!ossl_prov_is_running())958return 0;959960if ((selection & ECX_POSSIBLE_SELECTIONS) == 0)961return 1; /* nothing to validate */962963if (!ok) {964ERR_raise(ERR_LIB_PROV, PROV_R_ALGORITHM_MISMATCH);965return 0;966}967968if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {969ok = ok && ecx->haspubkey;970#ifdef FIPS_MODULE971ok = ok && ecd_key_pub_check(ecx, type);972#endif973}974975if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)976ok = ok && ecx->privkey != NULL;977978if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != OSSL_KEYMGMT_SELECT_KEYPAIR)979return ok;980981if (ecx_key_type_is_ed(type))982ok = ok && ecd_key_pairwise_check(ecx, type);983else984ok = ok && ecx_key_pairwise_check(ecx, type);985986return ok;987}988989static int x25519_validate(const void *keydata, int selection, int checktype)990{991return ecx_validate(keydata, selection, ECX_KEY_TYPE_X25519, X25519_KEYLEN);992}993994static int x448_validate(const void *keydata, int selection, int checktype)995{996return ecx_validate(keydata, selection, ECX_KEY_TYPE_X448, X448_KEYLEN);997}998999static int ed25519_validate(const void *keydata, int selection, int checktype)1000{1001return ecx_validate(keydata, selection, ECX_KEY_TYPE_ED25519, ED25519_KEYLEN);1002}10031004static int ed448_validate(const void *keydata, int selection, int checktype)1005{1006return ecx_validate(keydata, selection, ECX_KEY_TYPE_ED448, ED448_KEYLEN);1007}10081009#define MAKE_KEYMGMT_FUNCTIONS(alg) \1010const OSSL_DISPATCH ossl_##alg##_keymgmt_functions[] = { \1011{ OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))alg##_new_key }, \1012{ OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))ossl_ecx_key_free }, \1013{ OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*)(void))alg##_get_params }, \1014{ OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*)(void))alg##_gettable_params }, \1015{ OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*)(void))alg##_set_params }, \1016{ OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*)(void))alg##_settable_params }, \1017{ OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))ecx_has }, \1018{ OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))ecx_match }, \1019{ OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))alg##_validate }, \1020{ OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))ecx_import }, \1021{ OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))ecx_imexport_types }, \1022{ OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))ecx_export }, \1023{ OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))ecx_imexport_types }, \1024{ OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))alg##_gen_init }, \1025{ OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))ecx_gen_set_params }, \1026{ OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS, \1027(void (*)(void))ecx_gen_settable_params }, \1028{ OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))alg##_gen }, \1029{ OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))ecx_gen_cleanup }, \1030{ OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))ecx_load }, \1031{ OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))ecx_dup }, \1032OSSL_DISPATCH_END \1033};10341035MAKE_KEYMGMT_FUNCTIONS(x25519)1036MAKE_KEYMGMT_FUNCTIONS(x448)1037MAKE_KEYMGMT_FUNCTIONS(ed25519)1038MAKE_KEYMGMT_FUNCTIONS(ed448)10391040#ifdef S390X_EC_ASM1041#include "s390x_arch.h"10421043static void *s390x_ecx_keygen25519(struct ecx_gen_ctx *gctx)1044{1045static const unsigned char generator[] = {10460x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,10470x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,10480x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x001049};1050ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_X25519, 1,1051gctx->propq);1052unsigned char *privkey = NULL, *pubkey;10531054if (key == NULL) {1055ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1056goto err;1057}10581059/* If we're doing parameter generation then we just return a blank key */1060if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1061return key;10621063pubkey = key->pubkey;10641065privkey = ossl_ecx_key_allocate_privkey(key);1066if (privkey == NULL) {1067ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1068goto err;1069}10701071#ifndef FIPS_MODULE1072if (gctx->dhkem_ikm != NULL && gctx->dhkem_ikmlen != 0) {1073if (gctx->type != ECX_KEY_TYPE_X25519)1074goto err;1075if (!ossl_ecx_dhkem_derive_private(key, privkey,1076gctx->dhkem_ikm, gctx->dhkem_ikmlen))1077goto err;1078} else1079#endif1080{1081if (RAND_priv_bytes_ex(gctx->libctx, privkey, X25519_KEYLEN, 0) <= 0)1082goto err;1083}10841085privkey[0] &= 248;1086privkey[31] &= 127;1087privkey[31] |= 64;10881089if (s390x_x25519_mul(pubkey, generator, privkey) != 1)1090goto err;1091key->haspubkey = 1;1092return key;1093err:1094ossl_ecx_key_free(key);1095return NULL;1096}10971098static void *s390x_ecx_keygen448(struct ecx_gen_ctx *gctx)1099{1100static const unsigned char generator[] = {11010x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,11020x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,11030x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,11040x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,11050x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x001106};1107ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_X448, 1,1108gctx->propq);1109unsigned char *privkey = NULL, *pubkey;11101111if (key == NULL) {1112ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1113goto err;1114}11151116/* If we're doing parameter generation then we just return a blank key */1117if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1118return key;11191120pubkey = key->pubkey;11211122privkey = ossl_ecx_key_allocate_privkey(key);1123if (privkey == NULL) {1124ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1125goto err;1126}11271128#ifndef FIPS_MODULE1129if (gctx->dhkem_ikm != NULL && gctx->dhkem_ikmlen != 0) {1130if (gctx->type != ECX_KEY_TYPE_X448)1131goto err;1132if (!ossl_ecx_dhkem_derive_private(key, privkey,1133gctx->dhkem_ikm, gctx->dhkem_ikmlen))1134goto err;1135} else1136#endif1137{1138if (RAND_priv_bytes_ex(gctx->libctx, privkey, X448_KEYLEN, 0) <= 0)1139goto err;1140}11411142privkey[0] &= 252;1143privkey[55] |= 128;11441145if (s390x_x448_mul(pubkey, generator, privkey) != 1)1146goto err;1147key->haspubkey = 1;1148return key;1149err:1150ossl_ecx_key_free(key);1151return NULL;1152}11531154static void *s390x_ecd_keygen25519(struct ecx_gen_ctx *gctx)1155{1156static const unsigned char generator_x[] = {11570x1a, 0xd5, 0x25, 0x8f, 0x60, 0x2d, 0x56, 0xc9, 0xb2, 0xa7, 0x25, 0x95,11580x60, 0xc7, 0x2c, 0x69, 0x5c, 0xdc, 0xd6, 0xfd, 0x31, 0xe2, 0xa4, 0xc0,11590xfe, 0x53, 0x6e, 0xcd, 0xd3, 0x36, 0x69, 0x211160};1161static const unsigned char generator_y[] = {11620x58,11630x66,11640x66,11650x66,11660x66,11670x66,11680x66,11690x66,11700x66,11710x66,11720x66,11730x66,11740x66,11750x66,11760x66,11770x66,11780x66,11790x66,11800x66,11810x66,11820x66,11830x66,11840x66,11850x66,11860x66,11870x66,11880x66,11890x66,11900x66,11910x66,11920x66,11930x66,1194};1195unsigned char x_dst[32], buff[SHA512_DIGEST_LENGTH];1196ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_ED25519, 1,1197gctx->propq);1198unsigned char *privkey = NULL, *pubkey;1199unsigned int sz;1200EVP_MD *sha = NULL;1201int j;12021203if (key == NULL) {1204ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1205goto err;1206}12071208/* If we're doing parameter generation then we just return a blank key */1209if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1210return key;12111212pubkey = key->pubkey;12131214privkey = ossl_ecx_key_allocate_privkey(key);1215if (privkey == NULL) {1216ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1217goto err;1218}12191220if (RAND_priv_bytes_ex(gctx->libctx, privkey, ED25519_KEYLEN, 0) <= 0)1221goto err;12221223sha = EVP_MD_fetch(gctx->libctx, "SHA512", gctx->propq);1224if (sha == NULL)1225goto err;1226j = EVP_Digest(privkey, 32, buff, &sz, sha, NULL);1227EVP_MD_free(sha);1228if (!j)1229goto err;12301231buff[0] &= 248;1232buff[31] &= 63;1233buff[31] |= 64;12341235if (s390x_ed25519_mul(x_dst, pubkey,1236generator_x, generator_y, buff)1237!= 1)1238goto err;12391240pubkey[31] |= ((x_dst[0] & 0x01) << 7);1241key->haspubkey = 1;1242return key;1243err:1244ossl_ecx_key_free(key);1245return NULL;1246}12471248static void *s390x_ecd_keygen448(struct ecx_gen_ctx *gctx)1249{1250static const unsigned char generator_x[] = {12510x5e, 0xc0, 0x0c, 0xc7, 0x2b, 0xa8, 0x26, 0x26, 0x8e, 0x93, 0x00, 0x8b,12520xe1, 0x80, 0x3b, 0x43, 0x11, 0x65, 0xb6, 0x2a, 0xf7, 0x1a, 0xae, 0x12,12530x64, 0xa4, 0xd3, 0xa3, 0x24, 0xe3, 0x6d, 0xea, 0x67, 0x17, 0x0f, 0x47,12540x70, 0x65, 0x14, 0x9e, 0xda, 0x36, 0xbf, 0x22, 0xa6, 0x15, 0x1d, 0x22,12550xed, 0x0d, 0xed, 0x6b, 0xc6, 0x70, 0x19, 0x4f, 0x001256};1257static const unsigned char generator_y[] = {12580x14, 0xfa, 0x30, 0xf2, 0x5b, 0x79, 0x08, 0x98, 0xad, 0xc8, 0xd7, 0x4e,12590x2c, 0x13, 0xbd, 0xfd, 0xc4, 0x39, 0x7c, 0xe6, 0x1c, 0xff, 0xd3, 0x3a,12600xd7, 0xc2, 0xa0, 0x05, 0x1e, 0x9c, 0x78, 0x87, 0x40, 0x98, 0xa3, 0x6c,12610x73, 0x73, 0xea, 0x4b, 0x62, 0xc7, 0xc9, 0x56, 0x37, 0x20, 0x76, 0x88,12620x24, 0xbc, 0xb6, 0x6e, 0x71, 0x46, 0x3f, 0x69, 0x001263};1264unsigned char x_dst[57], buff[114];1265ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_ED448, 1,1266gctx->propq);1267unsigned char *privkey = NULL, *pubkey;1268EVP_MD_CTX *hashctx = NULL;1269EVP_MD *shake = NULL;12701271if (key == NULL) {1272ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1273goto err;1274}12751276/* If we're doing parameter generation then we just return a blank key */1277if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1278return key;12791280pubkey = key->pubkey;12811282privkey = ossl_ecx_key_allocate_privkey(key);1283if (privkey == NULL) {1284ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1285goto err;1286}12871288shake = EVP_MD_fetch(gctx->libctx, "SHAKE256", gctx->propq);1289if (shake == NULL)1290goto err;1291if (RAND_priv_bytes_ex(gctx->libctx, privkey, ED448_KEYLEN, 0) <= 0)1292goto err;12931294hashctx = EVP_MD_CTX_new();1295if (hashctx == NULL)1296goto err;1297if (EVP_DigestInit_ex(hashctx, shake, NULL) != 1)1298goto err;1299if (EVP_DigestUpdate(hashctx, privkey, 57) != 1)1300goto err;1301if (EVP_DigestFinalXOF(hashctx, buff, sizeof(buff)) != 1)1302goto err;13031304buff[0] &= -4;1305buff[55] |= 0x80;1306buff[56] = 0;13071308if (s390x_ed448_mul(x_dst, pubkey,1309generator_x, generator_y, buff)1310!= 1)1311goto err;13121313pubkey[56] |= ((x_dst[0] & 0x01) << 7);1314EVP_MD_CTX_free(hashctx);1315EVP_MD_free(shake);1316key->haspubkey = 1;1317return key;1318err:1319ossl_ecx_key_free(key);1320EVP_MD_CTX_free(hashctx);1321EVP_MD_free(shake);1322return NULL;1323}1324#endif132513261327