#include <openssl/engine.h>
#include <openssl/params.h>
#include <openssl/param_build.h>
-#include <openssl/serializer.h>
+#include <openssl/encoder.h>
#include <openssl/core_names.h>
#include "crypto/asn1.h"
if (keymgmt1 != keymgmt2)
return -2;
+ /* If the keymgmt implementations are NULL, the export failed */
+ if (keymgmt1 == NULL)
+ return -2;
+
return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
}
strtype != NULL ? strtype
: OBJ_nid2sn(nidtype),
propq);
- if (ctx == NULL) {
- EVPerr(0, ERR_R_MALLOC_FAILURE);
+ if (ctx == NULL)
goto err;
- }
/* May fail if no provider available */
ERR_set_mark();
if (EVP_PKEY_key_fromdata_init(ctx) == 1) {
return 1;
}
-EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
- size_t len, const EVP_CIPHER *cipher)
+static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
+ const char *cipher_name,
+ const EVP_CIPHER *cipher, OPENSSL_CTX *libctx,
+ const char *propq, ENGINE *e)
{
# ifndef OPENSSL_NO_CMAC
# ifndef OPENSSL_NO_ENGINE
const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
# endif
- const char *cipher_name = EVP_CIPHER_name(cipher);
- const OSSL_PROVIDER *prov = EVP_CIPHER_provider(cipher);
- OPENSSL_CTX *libctx =
- prov == NULL ? NULL : ossl_provider_library_context(prov);
- EVP_PKEY *ret = EVP_PKEY_new();
- EVP_MAC *cmac = EVP_MAC_fetch(libctx, OSSL_MAC_NAME_CMAC, NULL);
- EVP_MAC_CTX *cmctx = cmac != NULL ? EVP_MAC_CTX_new(cmac) : NULL;
- OSSL_PARAM params[4];
- size_t paramsn = 0;
-
- if (ret == NULL
- || cmctx == NULL
- || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1, NULL)) {
- /* EVPerr already called */
+ OSSL_PARAM params[5], *p = params;
+ EVP_PKEY *pkey = NULL;
+ EVP_PKEY_CTX *ctx;
+
+ if (cipher != NULL)
+ cipher_name = EVP_CIPHER_name(cipher);
+
+ if (cipher_name == NULL) {
+ EVPerr(0, EVP_R_KEY_SETUP_FAILED);
+ return NULL;
+ }
+
+ ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
+ if (ctx == NULL)
+ goto err;
+
+ if (!EVP_PKEY_key_fromdata_init(ctx)) {
+ EVPerr(0, EVP_R_KEY_SETUP_FAILED);
goto err;
}
+ *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
+ (void *)priv, len);
+ *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
+ (char *)cipher_name, 0);
+ if (propq != NULL)
+ *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
+ (char *)propq, 0);
# ifndef OPENSSL_NO_ENGINE
if (engine_id != NULL)
- params[paramsn++] =
- OSSL_PARAM_construct_utf8_string("engine", (char *)engine_id, 0);
+ *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
+ (char *)engine_id, 0);
# endif
+ *p = OSSL_PARAM_construct_end();
- params[paramsn++] =
- OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_CIPHER,
- (char *)cipher_name, 0);
- params[paramsn++] =
- OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY,
- (char *)priv, len);
- params[paramsn] = OSSL_PARAM_construct_end();
-
- if (!EVP_MAC_CTX_set_params(cmctx, params)) {
- EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
+ if (!EVP_PKEY_fromdata(ctx, &pkey, params)) {
+ EVPerr(0, EVP_R_KEY_SETUP_FAILED);
goto err;
}
- ret->pkey.ptr = cmctx;
- return ret;
-
err:
- EVP_PKEY_free(ret);
- EVP_MAC_CTX_free(cmctx);
- EVP_MAC_free(cmac);
- return NULL;
+ EVP_PKEY_CTX_free(ctx);
+
+ return pkey;
# else
- EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
- EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
+ EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
return NULL;
# endif
}
+EVP_PKEY *EVP_PKEY_new_CMAC_key_with_libctx(const unsigned char *priv,
+ size_t len,
+ const char *cipher_name,
+ OPENSSL_CTX *libctx,
+ const char *propq)
+{
+ return new_cmac_key_int(priv, len, cipher_name, NULL, libctx, propq, NULL);
+}
+
+EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
+ size_t len, const EVP_CIPHER *cipher)
+{
+ return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
+}
+
int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
{
return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
void *EVP_PKEY_get0(const EVP_PKEY *pkey)
{
+ if (pkey == NULL)
+ return NULL;
if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
return NULL;
return EVP_PKEY_type(pkey->type);
}
+#ifndef FIPS_MODULE
+int evp_pkey_name2type(const char *name)
+{
+ /*
+ * These hard coded cases are pure hackery to get around the fact
+ * that names in crypto/objects/objects.txt are a mess. There is
+ * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
+ * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
+ * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
+ * "DSA" is accurate... but still, better be safe and hard-code
+ * names that we know.
+ * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
+ * EVP_PKEY_EC, because of aliasing.
+ * TODO Clean this away along with all other #legacy support.
+ */
+ int type = NID_undef;
+
+ if (strcasecmp(name, "RSA") == 0)
+ type = EVP_PKEY_RSA;
+ else if (strcasecmp(name, "RSA-PSS") == 0)
+ type = EVP_PKEY_RSA_PSS;
+ else if (strcasecmp(name, "EC") == 0)
+ type = EVP_PKEY_EC;
+ else if (strcasecmp(name, "ED25519") == 0)
+ type = EVP_PKEY_ED25519;
+ else if (strcasecmp(name, "ED448") == 0)
+ type = EVP_PKEY_ED448;
+ else if (strcasecmp(name, "X25519") == 0)
+ type = EVP_PKEY_X25519;
+ else if (strcasecmp(name, "X448") == 0)
+ type = EVP_PKEY_X448;
+ else if (strcasecmp(name, "SM2") == 0)
+ type = EVP_PKEY_SM2;
+ else if (strcasecmp(name, "DH") == 0)
+ type = EVP_PKEY_DH;
+ else if (strcasecmp(name, "X9.42 DH") == 0)
+ type = EVP_PKEY_DHX;
+ else if (strcasecmp(name, "DSA") == 0)
+ type = EVP_PKEY_DSA;
+
+ if (type == NID_undef)
+ type = EVP_PKEY_type(OBJ_sn2nid(name));
+ if (type == NID_undef)
+ type = EVP_PKEY_type(OBJ_ln2nid(name));
+
+ return type;
+}
+#endif
+
int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
{
#ifndef FIPS_MODULE
if (pkey->keymgmt == NULL) {
- /*
- * These hard coded cases are pure hackery to get around the fact
- * that names in crypto/objects/objects.txt are a mess. There is
- * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
- * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
- * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
- * "DSA" is accurate... but still, better be safe and hard-code
- * names that we know.
- * TODO Clean this away along with all other #legacy support.
- */
- int type;
+ int type = evp_pkey_name2type(name);
- if (strcasecmp(name, "RSA") == 0)
- type = EVP_PKEY_RSA;
- else if (strcasecmp(name, "RSA-PSS") == 0)
- type = EVP_PKEY_RSA_PSS;
-#ifndef OPENSSL_NO_EC
- else if (strcasecmp(name, "EC") == 0)
- type = EVP_PKEY_EC;
- else if (strcasecmp(name, "ED25519") == 0)
- type = EVP_PKEY_ED25519;
- else if (strcasecmp(name, "ED448") == 0)
- type = EVP_PKEY_ED448;
- else if (strcasecmp(name, "X25519") == 0)
- type = EVP_PKEY_X25519;
- else if (strcasecmp(name, "X448") == 0)
- type = EVP_PKEY_X448;
-#endif
-#ifndef OPENSSL_NO_DH
- else if (strcasecmp(name, "DH") == 0)
- type = EVP_PKEY_DH;
-#endif
-#ifndef OPENSSL_NO_DSA
- else if (strcasecmp(name, "DSA") == 0)
- type = EVP_PKEY_DSA;
-#endif
- else
- type = EVP_PKEY_type(OBJ_sn2nid(name));
- return EVP_PKEY_type(pkey->type) == type;
+ return pkey->type == type;
}
#endif
return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
}
static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
- const char *propquery /* For provided serialization */,
+ const char *propquery /* For provided encoding */,
int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
int indent, ASN1_PCTX *pctx),
ASN1_PCTX *legacy_pctx /* For legacy print */)
{
int pop_f_prefix;
long saved_indent;
- OSSL_SERIALIZER_CTX *ctx = NULL;
+ OSSL_ENCODER_CTX *ctx = NULL;
int ret = -2; /* default to unsupported */
if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
return 0;
- ctx = OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, propquery);
- if (OSSL_SERIALIZER_CTX_get_serializer(ctx) != NULL)
- ret = OSSL_SERIALIZER_to_bio(ctx, out);
- OSSL_SERIALIZER_CTX_free(ctx);
+ ctx = OSSL_ENCODER_CTX_new_by_EVP_PKEY(pkey, propquery);
+ if (OSSL_ENCODER_CTX_get_encoder(ctx) != NULL)
+ ret = OSSL_ENCODER_to_bio(ctx, out);
+ OSSL_ENCODER_CTX_free(ctx);
if (ret != -2)
goto end;
int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
int indent, ASN1_PCTX *pctx)
{
- return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PUBKEY_TO_TEXT_PQ,
+ return print_pkey(pkey, out, indent, OSSL_ENCODER_PUBKEY_TO_TEXT_PQ,
(pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
pctx);
}
int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
int indent, ASN1_PCTX *pctx)
{
- return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PrivateKey_TO_TEXT_PQ,
+ return print_pkey(pkey, out, indent, OSSL_ENCODER_PrivateKey_TO_TEXT_PQ,
(pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
pctx);
}
int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
int indent, ASN1_PCTX *pctx)
{
- return print_pkey(pkey, out, indent, OSSL_SERIALIZER_Parameters_TO_TEXT_PQ,
+ return print_pkey(pkey, out, indent, OSSL_ENCODER_Parameters_TO_TEXT_PQ,
(pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
pctx);
}
/*- All methods below can also be used in FIPS_MODULE */
+static int evp_pkey_reset_unlocked(EVP_PKEY *pk)
+{
+ if (pk == NULL)
+ return 0;
+
+ memset(pk, 0, sizeof(*pk));
+ pk->type = EVP_PKEY_NONE;
+ pk->save_type = EVP_PKEY_NONE;
+ pk->references = 1;
+ pk->save_parameters = 1;
+ return 1;
+}
+
EVP_PKEY *EVP_PKEY_new(void)
{
EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
return NULL;
}
- ret->type = EVP_PKEY_NONE;
- ret->save_type = EVP_PKEY_NONE;
- ret->references = 1;
- ret->save_parameters = 1;
+
+ if (!evp_pkey_reset_unlocked(ret))
+ goto err;
+
ret->lock = CRYPTO_THREAD_lock_new();
if (ret->lock == NULL) {
EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
}
#ifndef FIPS_MODULE
-int evp_pkey_downgrade(EVP_PKEY *pk)
+int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
{
- EVP_KEYMGMT *keymgmt = pk->keymgmt;
- void *keydata = pk->keydata;
- int type = pk->type;
- const char *keytype = NULL;
+ if (!ossl_assert(dest != NULL))
+ return 0;
- /* If this isn't a provider side key, we're done */
- if (keymgmt == NULL)
- return 1;
+ if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
+ EVP_KEYMGMT *keymgmt = src->keymgmt;
+ void *keydata = src->keydata;
+ int type = src->type;
+ const char *keytype = NULL;
- keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt), keymgmt->name_id);
+ keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt),
+ keymgmt->name_id);
- /*
- * If the type is EVP_PKEY_NONE, then we have a problem somewhere else
- * in our code. If it's not one of the well known EVP_PKEY_xxx values,
- * it should at least be EVP_PKEY_KEYMGMT at this point.
- * TODO(3.0) remove this check when we're confident that the rest of the
- * code treats this correctly.
- */
- if (!ossl_assert(type != EVP_PKEY_NONE)) {
- ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
- "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
- keytype);
- return 0;
- }
+ /*
+ * If the type is EVP_PKEY_NONE, then we have a problem somewhere
+ * else in our code. If it's not one of the well known EVP_PKEY_xxx
+ * values, it should at least be EVP_PKEY_KEYMGMT at this point.
+ * TODO(3.0) remove this check when we're confident that the rest
+ * of the code treats this correctly.
+ */
+ if (!ossl_assert(type != EVP_PKEY_NONE)) {
+ ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
+ "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
+ keytype);
+ return 0;
+ }
- /* Prefer the legacy key type name for error reporting */
- if (type != EVP_PKEY_KEYMGMT)
- keytype = OBJ_nid2sn(type);
+ /* Prefer the legacy key type name for error reporting */
+ if (type != EVP_PKEY_KEYMGMT)
+ keytype = OBJ_nid2sn(type);
- /*
- * To be able to downgrade, we steal the provider side "origin" keymgmt
- * and keydata. We've already grabbed the pointers, so all we need to
- * do is clear those pointers in |pk| and then call evp_pkey_free_it().
- * That way, we can restore |pk| if we need to.
- */
- pk->keymgmt = NULL;
- pk->keydata = NULL;
- evp_pkey_free_it(pk);
- if (EVP_PKEY_set_type(pk, type)) {
- /* If the key is typed but empty, we're done */
- if (keydata == NULL) {
- /* We're dropping the EVP_KEYMGMT */
- EVP_KEYMGMT_free(keymgmt);
- return 1;
- }
+ /* Make sure we have a clean slate to copy into */
+ if (*dest == NULL)
+ *dest = EVP_PKEY_new();
+ else
+ evp_pkey_free_it(*dest);
- if (pk->ameth->import_from == NULL) {
- ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
- "key type = %s", keytype);
- } else {
- /*
- * We perform the export in the same libctx as the keymgmt that we
- * are using.
- */
- OPENSSL_CTX *libctx = ossl_provider_library_context(keymgmt->prov);
- EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, NULL);
- if (pctx == NULL)
- ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
+ if (EVP_PKEY_set_type(*dest, type)) {
+ /* If the key is typed but empty, we're done */
+ if (keydata == NULL)
+ return 1;
- if (pctx != NULL
- && evp_keymgmt_export(keymgmt, keydata,
- OSSL_KEYMGMT_SELECT_ALL,
- pk->ameth->import_from, pctx)) {
+ if ((*dest)->ameth->import_from == NULL) {
+ ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
+ "key type = %s", keytype);
+ } else {
/*
- * Save the provider side data in the operation cache, so they'll
- * find it again. evp_pkey_free_it() cleared the cache, so it's
- * safe to assume slot zero is free.
- * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
- * reference count.
+ * We perform the export in the same libctx as the keymgmt
+ * that we are using.
*/
- evp_keymgmt_util_cache_keydata(pk, 0, keymgmt, keydata);
- EVP_PKEY_CTX_free(pctx);
+ OPENSSL_CTX *libctx =
+ ossl_provider_library_context(keymgmt->prov);
+ EVP_PKEY_CTX *pctx =
+ EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
- /* Synchronize the dirty count */
- pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
+ if (pctx == NULL)
+ ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
- /* evp_keymgmt_export() increased the refcount... */
- EVP_KEYMGMT_free(keymgmt);
- return 1;
+ if (pctx != NULL
+ && evp_keymgmt_export(keymgmt, keydata,
+ OSSL_KEYMGMT_SELECT_ALL,
+ (*dest)->ameth->import_from,
+ pctx)) {
+ /* Synchronize the dirty count */
+ (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
+
+ EVP_PKEY_CTX_free(pctx);
+ return 1;
+ }
+ EVP_PKEY_CTX_free(pctx);
}
- EVP_PKEY_CTX_free(pctx);
- }
- ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
- "key type = %s", keytype);
+ ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
+ "key type = %s", keytype);
+ }
}
+ return 0;
+}
+
+int evp_pkey_downgrade(EVP_PKEY *pk)
+{
+ EVP_PKEY tmp_copy; /* Stack allocated! */
+
+ /* If this isn't an assigned provider side key, we're done */
+ if (!evp_pkey_is_assigned(pk) || !evp_pkey_is_provided(pk))
+ return 1;
+
/*
- * Something went wrong. This could for example happen if the keymgmt
- * turns out to be an HSM implementation that refuses to let go of some
- * of the key data, typically the private bits. In this case, we restore
- * the provider side internal "origin" and leave it at that.
+ * To be able to downgrade, we steal the contents of |pk|, then reset
+ * it, and finally try to make it a downgraded copy. If any of that
+ * fails, we restore the copied contents into |pk|.
*/
- if (!ossl_assert(evp_keymgmt_util_assign_pkey(pk, keymgmt, keydata))) {
- /* This should not be impossible */
- ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
- return 0;
+ tmp_copy = *pk;
+
+ if (evp_pkey_reset_unlocked(pk)
+ && evp_pkey_copy_downgraded(&pk, &tmp_copy)) {
+ /* Restore the common attributes, then empty |tmp_copy| */
+ pk->references = tmp_copy.references;
+ pk->lock = tmp_copy.lock;
+ pk->attributes = tmp_copy.attributes;
+ pk->save_parameters = tmp_copy.save_parameters;
+ pk->ex_data = tmp_copy.ex_data;
+
+ /* Ensure that stuff we've copied won't be freed */
+ tmp_copy.lock = NULL;
+ tmp_copy.attributes = NULL;
+ memset(&tmp_copy.ex_data, 0, sizeof(tmp_copy.ex_data));
+
+ /*
+ * Save the provider side data in the operation cache, so they'll
+ * find it again. |pk| is new, so it's safe to assume slot zero
+ * is free.
+ * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
+ * reference count, so we need to decrement it, or there will be a
+ * leak.
+ */
+ evp_keymgmt_util_cache_keydata(pk, 0, tmp_copy.keymgmt,
+ tmp_copy.keydata);
+ EVP_KEYMGMT_free(tmp_copy.keymgmt);
+
+ /*
+ * Clear keymgmt and keydata from |tmp_copy|, or they'll get
+ * inadvertently freed.
+ */
+ tmp_copy.keymgmt = NULL;
+ tmp_copy.keydata = NULL;
+
+ evp_pkey_free_it(&tmp_copy);
+
+ return 1;
}
- /* evp_keymgmt_util_assign_pkey() increased the refcount... */
- EVP_KEYMGMT_free(keymgmt);
- return 0; /* No downgrade, but at least the key is restored */
+
+ *pk = tmp_copy;
+ return 0;
}
#endif /* FIPS_MODULE */
|| pkey->keymgmt == NULL
|| pkey->keydata == NULL)
return 0;
- return evp_keymgmt_gettable_params(pkey->keymgmt);
+ return EVP_KEYMGMT_gettable_params(pkey->keymgmt);
}
int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)