Path: blob/main/crypto/openssl/providers/implementations/keymgmt/ecx_kmgmt.c
48292 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)) != NULL336&& !OSSL_PARAM_set_utf8_string(p, ""))337return 0;338return 1;339}340341static int x25519_get_params(void *key, OSSL_PARAM params[])342{343return ecx_get_params(key, params, X25519_BITS, X25519_SECURITY_BITS,344X25519_KEYLEN);345}346347static int x448_get_params(void *key, OSSL_PARAM params[])348{349return ecx_get_params(key, params, X448_BITS, X448_SECURITY_BITS,350X448_KEYLEN);351}352353static int ed25519_get_params(void *key, OSSL_PARAM params[])354{355return ecx_get_params(key, params, ED25519_BITS, ED25519_SECURITY_BITS,356ED25519_SIGSIZE)357&& ed_get_params(key, params);358}359360static int ed448_get_params(void *key, OSSL_PARAM params[])361{362return ecx_get_params(key, params, ED448_BITS, ED448_SECURITY_BITS,363ED448_SIGSIZE)364&& ed_get_params(key, params);365}366367static const OSSL_PARAM ecx_gettable_params[] = {368OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),369OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),370OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),371OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),372ECX_KEY_TYPES(),373OSSL_FIPS_IND_GETTABLE_CTX_PARAM()374OSSL_PARAM_END375};376377static const OSSL_PARAM ed_gettable_params[] = {378OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),379OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),380OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),381OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_MANDATORY_DIGEST, NULL, 0),382ECX_KEY_TYPES(),383OSSL_PARAM_END384};385386static const OSSL_PARAM *x25519_gettable_params(void *provctx)387{388return ecx_gettable_params;389}390391static const OSSL_PARAM *x448_gettable_params(void *provctx)392{393return ecx_gettable_params;394}395396static const OSSL_PARAM *ed25519_gettable_params(void *provctx)397{398return ed_gettable_params;399}400401static const OSSL_PARAM *ed448_gettable_params(void *provctx)402{403return ed_gettable_params;404}405406static int set_property_query(ECX_KEY *ecxkey, const char *propq)407{408OPENSSL_free(ecxkey->propq);409ecxkey->propq = NULL;410if (propq != NULL) {411ecxkey->propq = OPENSSL_strdup(propq);412if (ecxkey->propq == NULL)413return 0;414}415return 1;416}417418static int ecx_set_params(void *key, const OSSL_PARAM params[])419{420ECX_KEY *ecxkey = key;421const OSSL_PARAM *p;422423if (ossl_param_is_empty(params))424return 1;425426p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY);427if (p != NULL) {428void *buf = ecxkey->pubkey;429430if (p->data_size != ecxkey->keylen431|| !OSSL_PARAM_get_octet_string(p, &buf, sizeof(ecxkey->pubkey),432NULL))433return 0;434OPENSSL_clear_free(ecxkey->privkey, ecxkey->keylen);435ecxkey->privkey = NULL;436ecxkey->haspubkey = 1;437}438p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PROPERTIES);439if (p != NULL) {440if (p->data_type != OSSL_PARAM_UTF8_STRING441|| !set_property_query(ecxkey, p->data))442return 0;443}444445return 1;446}447448static int x25519_set_params(void *key, const OSSL_PARAM params[])449{450return ecx_set_params(key, params);451}452453static int x448_set_params(void *key, const OSSL_PARAM params[])454{455return ecx_set_params(key, params);456}457458static int ed25519_set_params(void *key, const OSSL_PARAM params[])459{460return 1;461}462463static int ed448_set_params(void *key, const OSSL_PARAM params[])464{465return 1;466}467468static const OSSL_PARAM ecx_settable_params[] = {469OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),470OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),471OSSL_PARAM_END472};473474static const OSSL_PARAM ed_settable_params[] = {475OSSL_PARAM_END476};477478static const OSSL_PARAM *x25519_settable_params(void *provctx)479{480return ecx_settable_params;481}482483static const OSSL_PARAM *x448_settable_params(void *provctx)484{485return ecx_settable_params;486}487488static const OSSL_PARAM *ed25519_settable_params(void *provctx)489{490return ed_settable_params;491}492493static const OSSL_PARAM *ed448_settable_params(void *provctx)494{495return ed_settable_params;496}497498static void *ecx_gen_init(void *provctx, int selection,499const OSSL_PARAM params[], ECX_KEY_TYPE type,500const char *algdesc)501{502OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);503struct ecx_gen_ctx *gctx = NULL;504505if (!ossl_prov_is_running())506return NULL;507508if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {509gctx->libctx = libctx;510gctx->type = type;511gctx->selection = selection;512#ifdef FIPS_MODULE513/* X25519/X448 are not FIPS approved, (ED25519/ED448 are approved) */514if (algdesc != NULL515&& !ossl_FIPS_IND_callback(libctx, algdesc, "KeyGen Init")) {516OPENSSL_free(gctx);517return NULL;518}519#endif520} else {521return NULL;522}523if (!ecx_gen_set_params(gctx, params)) {524ecx_gen_cleanup(gctx);525gctx = NULL;526}527return gctx;528}529530static void *x25519_gen_init(void *provctx, int selection,531const OSSL_PARAM params[])532{533return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_X25519, "X25519");534}535536static void *x448_gen_init(void *provctx, int selection,537const OSSL_PARAM params[])538{539return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_X448, "X448");540}541542static void *ed25519_gen_init(void *provctx, int selection,543const OSSL_PARAM params[])544{545return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_ED25519, NULL);546}547548static void *ed448_gen_init(void *provctx, int selection,549const OSSL_PARAM params[])550{551return ecx_gen_init(provctx, selection, params, ECX_KEY_TYPE_ED448, NULL);552}553554static int ecx_gen_set_params(void *genctx, const OSSL_PARAM params[])555{556struct ecx_gen_ctx *gctx = genctx;557const OSSL_PARAM *p;558559if (gctx == NULL)560return 0;561562p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_GROUP_NAME);563if (p != NULL) {564const char *groupname = NULL;565566/*567* We optionally allow setting a group name - but each algorithm only568* support one such name, so all we do is verify that it is the one we569* expected.570*/571switch (gctx->type) {572case ECX_KEY_TYPE_X25519:573groupname = "x25519";574break;575case ECX_KEY_TYPE_X448:576groupname = "x448";577break;578default:579/* We only support this for key exchange at the moment */580break;581}582if (p->data_type != OSSL_PARAM_UTF8_STRING583|| groupname == NULL584|| OPENSSL_strcasecmp(p->data, groupname) != 0) {585ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);586return 0;587}588}589p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PROPERTIES);590if (p != NULL) {591if (p->data_type != OSSL_PARAM_UTF8_STRING)592return 0;593OPENSSL_free(gctx->propq);594gctx->propq = OPENSSL_strdup(p->data);595if (gctx->propq == NULL)596return 0;597}598p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DHKEM_IKM);599if (p != NULL) {600if (p->data_size != 0 && p->data != NULL) {601OPENSSL_free(gctx->dhkem_ikm);602gctx->dhkem_ikm = NULL;603if (!OSSL_PARAM_get_octet_string(p, (void **)&gctx->dhkem_ikm, 0,604&gctx->dhkem_ikmlen))605return 0;606}607}608609return 1;610}611612static const OSSL_PARAM *ecx_gen_settable_params(ossl_unused void *genctx,613ossl_unused void *provctx)614{615static OSSL_PARAM settable[] = {616OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME, NULL, 0),617OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),618OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_DHKEM_IKM, NULL, 0),619OSSL_PARAM_END620};621return settable;622}623624#ifdef FIPS_MODULE625/*626* Refer: FIPS 140-3 IG 10.3.A Additional Comment 1627* Perform a pairwise test for EDDSA by signing and verifying signature.628*629* The parameter `self_test` is used to indicate whether to create OSSL_SELF_TEST630* instance.631*/632static int ecd_fips140_pairwise_test(const ECX_KEY *ecx, int type, int self_test)633{634int ret = 0;635OSSL_SELF_TEST *st = NULL;636OSSL_CALLBACK *cb = NULL;637void *cbarg = NULL;638639unsigned char msg[16] = {0};640size_t msg_len = sizeof(msg);641unsigned char sig[ED448_SIGSIZE] = {0};642643int is_ed25519 = (type == ECX_KEY_TYPE_ED25519) ? 1 : 0;644int operation_result = 0;645646/*647* The functions `OSSL_SELF_TEST_*` will return directly if parameter `st`648* is NULL.649*/650if (self_test) {651OSSL_SELF_TEST_get_callback(ecx->libctx, &cb, &cbarg);652653st = OSSL_SELF_TEST_new(cb, cbarg);654if (st == NULL)655return 0;656}657658OSSL_SELF_TEST_onbegin(st, OSSL_SELF_TEST_TYPE_PCT,659OSSL_SELF_TEST_DESC_PCT_EDDSA);660661if (is_ed25519)662operation_result = ossl_ed25519_sign(sig, msg, msg_len, ecx->pubkey,663ecx->privkey, 0, 0, 0, NULL, 0,664ecx->libctx, ecx->propq);665else666operation_result = ossl_ed448_sign(ecx->libctx, sig, msg, msg_len,667ecx->pubkey, ecx->privkey, NULL, 0,6680, ecx->propq);669if (operation_result != 1)670goto err;671672OSSL_SELF_TEST_oncorrupt_byte(st, sig);673674if (is_ed25519)675operation_result = ossl_ed25519_verify(msg, msg_len, sig, ecx->pubkey,6760, 0, 0, NULL, 0, ecx->libctx,677ecx->propq);678else679operation_result = ossl_ed448_verify(ecx->libctx, msg, msg_len, sig,680ecx->pubkey, NULL, 0, 0, ecx->propq);681if (operation_result != 1)682goto err;683684ret = 1;685err:686OSSL_SELF_TEST_onend(st, ret);687OSSL_SELF_TEST_free(st);688return ret;689}690#endif691692static void *ecx_gen(struct ecx_gen_ctx *gctx)693{694ECX_KEY *key;695unsigned char *privkey;696697if (gctx == NULL)698return NULL;699if ((key = ossl_ecx_key_new(gctx->libctx, gctx->type, 0,700gctx->propq)) == NULL) {701ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);702return NULL;703}704705/* If we're doing parameter generation then we just return a blank key */706if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)707return key;708709if ((privkey = ossl_ecx_key_allocate_privkey(key)) == NULL) {710ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);711goto err;712}713#ifndef FIPS_MODULE714if (gctx->dhkem_ikm != NULL && gctx->dhkem_ikmlen != 0) {715if (ecx_key_type_is_ed(gctx->type))716goto err;717if (!ossl_ecx_dhkem_derive_private(key, privkey,718gctx->dhkem_ikm, gctx->dhkem_ikmlen))719goto err;720} else721#endif722{723if (RAND_priv_bytes_ex(gctx->libctx, privkey, key->keylen, 0) <= 0)724goto err;725}726727switch (gctx->type) {728case ECX_KEY_TYPE_X25519:729privkey[0] &= 248;730privkey[X25519_KEYLEN - 1] &= 127;731privkey[X25519_KEYLEN - 1] |= 64;732ossl_x25519_public_from_private(key->pubkey, privkey);733break;734case ECX_KEY_TYPE_X448:735privkey[0] &= 252;736privkey[X448_KEYLEN - 1] |= 128;737ossl_x448_public_from_private(key->pubkey, privkey);738break;739case ECX_KEY_TYPE_ED25519:740if (!ossl_ed25519_public_from_private(gctx->libctx, key->pubkey, privkey,741gctx->propq))742goto err;743break;744case ECX_KEY_TYPE_ED448:745if (!ossl_ed448_public_from_private(gctx->libctx, key->pubkey, privkey,746gctx->propq))747goto err;748break;749}750key->haspubkey = 1;751return key;752err:753ossl_ecx_key_free(key);754return NULL;755}756757static void *x25519_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)758{759struct ecx_gen_ctx *gctx = genctx;760761if (!ossl_prov_is_running())762return 0;763764#ifdef S390X_EC_ASM765if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_X25519))766return s390x_ecx_keygen25519(gctx);767#endif768return ecx_gen(gctx);769}770771static void *x448_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)772{773struct ecx_gen_ctx *gctx = genctx;774775if (!ossl_prov_is_running())776return 0;777778#ifdef S390X_EC_ASM779if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_X448))780return s390x_ecx_keygen448(gctx);781#endif782return ecx_gen(gctx);783}784785static void *ed25519_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)786{787ECX_KEY *key = NULL;788struct ecx_gen_ctx *gctx = genctx;789790if (!ossl_prov_is_running())791return 0;792793#ifdef S390X_EC_ASM794if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_ED25519)795&& OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_SIGN_ED25519)796&& OPENSSL_s390xcap_P.kdsa[0]797& S390X_CAPBIT(S390X_EDDSA_VERIFY_ED25519)) {798key = s390x_ecd_keygen25519(gctx);799} else800#endif801{802key = ecx_gen(gctx);803}804805#ifdef FIPS_MODULE806/* Exit if keygen failed OR we are doing parameter generation (blank key) */807if (!key || ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0))808return key;809if (ecd_fips140_pairwise_test(key, ECX_KEY_TYPE_ED25519, 1) != 1) {810ossl_set_error_state(OSSL_SELF_TEST_TYPE_PCT);811ossl_ecx_key_free(key);812return NULL;813}814#endif815816return key;817}818819static void *ed448_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)820{821ECX_KEY *key = NULL;822struct ecx_gen_ctx *gctx = genctx;823824if (!ossl_prov_is_running())825return 0;826827#ifdef S390X_EC_ASM828if (OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_ED448)829&& OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_SIGN_ED448)830&& OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_VERIFY_ED448)) {831key = s390x_ecd_keygen448(gctx);832} else833#endif834{835key = ecx_gen(gctx);836}837838#ifdef FIPS_MODULE839/* Exit if keygen failed OR we are doing parameter generation (blank key) */840if (!key || ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0))841return key;842if (ecd_fips140_pairwise_test(key, ECX_KEY_TYPE_ED448, 1) != 1) {843ossl_set_error_state(OSSL_SELF_TEST_TYPE_PCT);844ossl_ecx_key_free(key);845return NULL;846}847#endif848849return key;850}851852static void ecx_gen_cleanup(void *genctx)853{854struct ecx_gen_ctx *gctx = genctx;855856if (gctx == NULL)857return;858859OPENSSL_clear_free(gctx->dhkem_ikm, gctx->dhkem_ikmlen);860OPENSSL_free(gctx->propq);861OPENSSL_free(gctx);862}863864void *ecx_load(const void *reference, size_t reference_sz)865{866ECX_KEY *key = NULL;867868if (ossl_prov_is_running() && reference_sz == sizeof(key)) {869/* The contents of the reference is the address to our object */870key = *(ECX_KEY **)reference;871/* We grabbed, so we detach it */872*(ECX_KEY **)reference = NULL;873return key;874}875return NULL;876}877878static void *ecx_dup(const void *keydata_from, int selection)879{880if (ossl_prov_is_running())881return ossl_ecx_key_dup(keydata_from, selection);882return NULL;883}884885static int ecx_key_pairwise_check(const ECX_KEY *ecx, int type)886{887uint8_t pub[64];888889switch (type) {890case ECX_KEY_TYPE_X25519:891ossl_x25519_public_from_private(pub, ecx->privkey);892break;893case ECX_KEY_TYPE_X448:894ossl_x448_public_from_private(pub, ecx->privkey);895break;896default:897return 0;898}899return CRYPTO_memcmp(ecx->pubkey, pub, ecx->keylen) == 0;900}901902#ifdef FIPS_MODULE903/*904* FIPS ACVP testing requires the ability to check if the public key is valid905* This is not required normally since the ED signature verify does the test906* internally.907*/908static int ecd_key_pub_check(const ECX_KEY *ecx, int type)909{910switch (type) {911case ECX_KEY_TYPE_ED25519:912return ossl_ed25519_pubkey_verify(ecx->pubkey, ecx->keylen);913case ECX_KEY_TYPE_ED448:914return ossl_ed448_pubkey_verify(ecx->pubkey, ecx->keylen);915default:916return 1;917}918}919#endif920921#ifdef FIPS_MODULE922static int ecd_key_pairwise_check(const ECX_KEY *ecx, int type)923{924return ecd_fips140_pairwise_test(ecx, type, 0);925}926#else927static int ecd_key_pairwise_check(const ECX_KEY *ecx, int type)928{929uint8_t pub[64];930931switch (type) {932case ECX_KEY_TYPE_ED25519:933if (!ossl_ed25519_public_from_private(ecx->libctx, pub, ecx->privkey,934ecx->propq))935return 0;936break;937case ECX_KEY_TYPE_ED448:938if (!ossl_ed448_public_from_private(ecx->libctx, pub, ecx->privkey,939ecx->propq))940return 0;941break;942default:943return 0;944}945return CRYPTO_memcmp(ecx->pubkey, pub, ecx->keylen) == 0;946}947#endif948949static int ecx_validate(const void *keydata, int selection, int type,950size_t keylen)951{952const ECX_KEY *ecx = keydata;953int ok = keylen == ecx->keylen;954955if (!ossl_prov_is_running())956return 0;957958if ((selection & ECX_POSSIBLE_SELECTIONS) == 0)959return 1; /* nothing to validate */960961if (!ok) {962ERR_raise(ERR_LIB_PROV, PROV_R_ALGORITHM_MISMATCH);963return 0;964}965966if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {967ok = ok && ecx->haspubkey;968#ifdef FIPS_MODULE969ok = ok && ecd_key_pub_check(ecx, type);970#endif971}972973if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)974ok = ok && ecx->privkey != NULL;975976if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != OSSL_KEYMGMT_SELECT_KEYPAIR)977return ok;978979if (ecx_key_type_is_ed(type))980ok = ok && ecd_key_pairwise_check(ecx, type);981else982ok = ok && ecx_key_pairwise_check(ecx, type);983984return ok;985}986987static int x25519_validate(const void *keydata, int selection, int checktype)988{989return ecx_validate(keydata, selection, ECX_KEY_TYPE_X25519, X25519_KEYLEN);990}991992static int x448_validate(const void *keydata, int selection, int checktype)993{994return ecx_validate(keydata, selection, ECX_KEY_TYPE_X448, X448_KEYLEN);995}996997static int ed25519_validate(const void *keydata, int selection, int checktype)998{999return ecx_validate(keydata, selection, ECX_KEY_TYPE_ED25519, ED25519_KEYLEN);1000}10011002static int ed448_validate(const void *keydata, int selection, int checktype)1003{1004return ecx_validate(keydata, selection, ECX_KEY_TYPE_ED448, ED448_KEYLEN);1005}10061007#define MAKE_KEYMGMT_FUNCTIONS(alg) \1008const OSSL_DISPATCH ossl_##alg##_keymgmt_functions[] = { \1009{ OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))alg##_new_key }, \1010{ OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))ossl_ecx_key_free }, \1011{ OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))alg##_get_params }, \1012{ OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))alg##_gettable_params }, \1013{ OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))alg##_set_params }, \1014{ OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))alg##_settable_params }, \1015{ OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))ecx_has }, \1016{ OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))ecx_match }, \1017{ OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))alg##_validate }, \1018{ OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))ecx_import }, \1019{ OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))ecx_imexport_types }, \1020{ OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))ecx_export }, \1021{ OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))ecx_imexport_types }, \1022{ OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))alg##_gen_init }, \1023{ OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))ecx_gen_set_params }, \1024{ OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS, \1025(void (*)(void))ecx_gen_settable_params }, \1026{ OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))alg##_gen }, \1027{ OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))ecx_gen_cleanup }, \1028{ OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))ecx_load }, \1029{ OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))ecx_dup }, \1030OSSL_DISPATCH_END \1031};10321033MAKE_KEYMGMT_FUNCTIONS(x25519)1034MAKE_KEYMGMT_FUNCTIONS(x448)1035MAKE_KEYMGMT_FUNCTIONS(ed25519)1036MAKE_KEYMGMT_FUNCTIONS(ed448)10371038#ifdef S390X_EC_ASM1039# include "s390x_arch.h"10401041static void *s390x_ecx_keygen25519(struct ecx_gen_ctx *gctx)1042{1043static const unsigned char generator[] = {10440x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,10450x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,10460x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x001047};1048ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_X25519, 1,1049gctx->propq);1050unsigned char *privkey = NULL, *pubkey;10511052if (key == NULL) {1053ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1054goto err;1055}10561057/* If we're doing parameter generation then we just return a blank key */1058if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1059return key;10601061pubkey = key->pubkey;10621063privkey = ossl_ecx_key_allocate_privkey(key);1064if (privkey == NULL) {1065ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1066goto err;1067}10681069#ifndef FIPS_MODULE1070if (gctx->dhkem_ikm != NULL && gctx->dhkem_ikmlen != 0) {1071if (gctx->type != ECX_KEY_TYPE_X25519)1072goto err;1073if (!ossl_ecx_dhkem_derive_private(key, privkey,1074gctx->dhkem_ikm, gctx->dhkem_ikmlen))1075goto err;1076} else1077#endif1078{1079if (RAND_priv_bytes_ex(gctx->libctx, privkey, X25519_KEYLEN, 0) <= 0)1080goto err;1081}10821083privkey[0] &= 248;1084privkey[31] &= 127;1085privkey[31] |= 64;10861087if (s390x_x25519_mul(pubkey, generator, privkey) != 1)1088goto err;1089key->haspubkey = 1;1090return key;1091err:1092ossl_ecx_key_free(key);1093return NULL;1094}10951096static void *s390x_ecx_keygen448(struct ecx_gen_ctx *gctx)1097{1098static const unsigned char generator[] = {10990x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,11000x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,11010x00, 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, 0x001104};1105ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_X448, 1,1106gctx->propq);1107unsigned char *privkey = NULL, *pubkey;11081109if (key == NULL) {1110ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1111goto err;1112}11131114/* If we're doing parameter generation then we just return a blank key */1115if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1116return key;11171118pubkey = key->pubkey;11191120privkey = ossl_ecx_key_allocate_privkey(key);1121if (privkey == NULL) {1122ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1123goto err;1124}11251126#ifndef FIPS_MODULE1127if (gctx->dhkem_ikm != NULL && gctx->dhkem_ikmlen != 0) {1128if (gctx->type != ECX_KEY_TYPE_X448)1129goto err;1130if (!ossl_ecx_dhkem_derive_private(key, privkey,1131gctx->dhkem_ikm, gctx->dhkem_ikmlen))1132goto err;1133} else1134#endif1135{1136if (RAND_priv_bytes_ex(gctx->libctx, privkey, X448_KEYLEN, 0) <= 0)1137goto err;1138}11391140privkey[0] &= 252;1141privkey[55] |= 128;11421143if (s390x_x448_mul(pubkey, generator, privkey) != 1)1144goto err;1145key->haspubkey = 1;1146return key;1147err:1148ossl_ecx_key_free(key);1149return NULL;1150}11511152static void *s390x_ecd_keygen25519(struct ecx_gen_ctx *gctx)1153{1154static const unsigned char generator_x[] = {11550x1a, 0xd5, 0x25, 0x8f, 0x60, 0x2d, 0x56, 0xc9, 0xb2, 0xa7, 0x25, 0x95,11560x60, 0xc7, 0x2c, 0x69, 0x5c, 0xdc, 0xd6, 0xfd, 0x31, 0xe2, 0xa4, 0xc0,11570xfe, 0x53, 0x6e, 0xcd, 0xd3, 0x36, 0x69, 0x211158};1159static const unsigned char generator_y[] = {11600x58, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66,11610x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66,11620x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66, 0x66,1163};1164unsigned char x_dst[32], buff[SHA512_DIGEST_LENGTH];1165ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_ED25519, 1,1166gctx->propq);1167unsigned char *privkey = NULL, *pubkey;1168unsigned int sz;1169EVP_MD *sha = NULL;1170int j;11711172if (key == NULL) {1173ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1174goto err;1175}11761177/* If we're doing parameter generation then we just return a blank key */1178if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1179return key;11801181pubkey = key->pubkey;11821183privkey = ossl_ecx_key_allocate_privkey(key);1184if (privkey == NULL) {1185ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1186goto err;1187}11881189if (RAND_priv_bytes_ex(gctx->libctx, privkey, ED25519_KEYLEN, 0) <= 0)1190goto err;11911192sha = EVP_MD_fetch(gctx->libctx, "SHA512", gctx->propq);1193if (sha == NULL)1194goto err;1195j = EVP_Digest(privkey, 32, buff, &sz, sha, NULL);1196EVP_MD_free(sha);1197if (!j)1198goto err;11991200buff[0] &= 248;1201buff[31] &= 63;1202buff[31] |= 64;12031204if (s390x_ed25519_mul(x_dst, pubkey,1205generator_x, generator_y, buff) != 1)1206goto err;12071208pubkey[31] |= ((x_dst[0] & 0x01) << 7);1209key->haspubkey = 1;1210return key;1211err:1212ossl_ecx_key_free(key);1213return NULL;1214}12151216static void *s390x_ecd_keygen448(struct ecx_gen_ctx *gctx)1217{1218static const unsigned char generator_x[] = {12190x5e, 0xc0, 0x0c, 0xc7, 0x2b, 0xa8, 0x26, 0x26, 0x8e, 0x93, 0x00, 0x8b,12200xe1, 0x80, 0x3b, 0x43, 0x11, 0x65, 0xb6, 0x2a, 0xf7, 0x1a, 0xae, 0x12,12210x64, 0xa4, 0xd3, 0xa3, 0x24, 0xe3, 0x6d, 0xea, 0x67, 0x17, 0x0f, 0x47,12220x70, 0x65, 0x14, 0x9e, 0xda, 0x36, 0xbf, 0x22, 0xa6, 0x15, 0x1d, 0x22,12230xed, 0x0d, 0xed, 0x6b, 0xc6, 0x70, 0x19, 0x4f, 0x001224};1225static const unsigned char generator_y[] = {12260x14, 0xfa, 0x30, 0xf2, 0x5b, 0x79, 0x08, 0x98, 0xad, 0xc8, 0xd7, 0x4e,12270x2c, 0x13, 0xbd, 0xfd, 0xc4, 0x39, 0x7c, 0xe6, 0x1c, 0xff, 0xd3, 0x3a,12280xd7, 0xc2, 0xa0, 0x05, 0x1e, 0x9c, 0x78, 0x87, 0x40, 0x98, 0xa3, 0x6c,12290x73, 0x73, 0xea, 0x4b, 0x62, 0xc7, 0xc9, 0x56, 0x37, 0x20, 0x76, 0x88,12300x24, 0xbc, 0xb6, 0x6e, 0x71, 0x46, 0x3f, 0x69, 0x001231};1232unsigned char x_dst[57], buff[114];1233ECX_KEY *key = ossl_ecx_key_new(gctx->libctx, ECX_KEY_TYPE_ED448, 1,1234gctx->propq);1235unsigned char *privkey = NULL, *pubkey;1236EVP_MD_CTX *hashctx = NULL;1237EVP_MD *shake = NULL;12381239if (key == NULL) {1240ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1241goto err;1242}12431244/* If we're doing parameter generation then we just return a blank key */1245if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)1246return key;12471248pubkey = key->pubkey;12491250privkey = ossl_ecx_key_allocate_privkey(key);1251if (privkey == NULL) {1252ERR_raise(ERR_LIB_PROV, ERR_R_EC_LIB);1253goto err;1254}12551256shake = EVP_MD_fetch(gctx->libctx, "SHAKE256", gctx->propq);1257if (shake == NULL)1258goto err;1259if (RAND_priv_bytes_ex(gctx->libctx, privkey, ED448_KEYLEN, 0) <= 0)1260goto err;12611262hashctx = EVP_MD_CTX_new();1263if (hashctx == NULL)1264goto err;1265if (EVP_DigestInit_ex(hashctx, shake, NULL) != 1)1266goto err;1267if (EVP_DigestUpdate(hashctx, privkey, 57) != 1)1268goto err;1269if (EVP_DigestFinalXOF(hashctx, buff, sizeof(buff)) != 1)1270goto err;12711272buff[0] &= -4;1273buff[55] |= 0x80;1274buff[56] = 0;12751276if (s390x_ed448_mul(x_dst, pubkey,1277generator_x, generator_y, buff) != 1)1278goto err;12791280pubkey[56] |= ((x_dst[0] & 0x01) << 7);1281EVP_MD_CTX_free(hashctx);1282EVP_MD_free(shake);1283key->haspubkey = 1;1284return key;1285err:1286ossl_ecx_key_free(key);1287EVP_MD_CTX_free(hashctx);1288EVP_MD_free(shake);1289return NULL;1290}1291#endif129212931294