#include <openssl/rsa.h>
#include <openssl/dsa.h>
#include <openssl/dh.h>
+#include <openssl/ec.h>
#include <openssl/cmac.h>
#include <openssl/engine.h>
#include <openssl/params.h>
#include "crypto/asn1.h"
#include "crypto/evp.h"
+#include "internal/evp.h"
#include "internal/provider.h"
#include "evp_local.h"
+#include "crypto/ec.h"
+
+/* TODO remove this when the EVP_PKEY_is_a() #legacy support hack is removed */
+#include "e_os.h" /* strcasecmp on Windows */
+
+static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
+ int len, EVP_KEYMGMT *keymgmt);
static void evp_pkey_free_it(EVP_PKEY *key);
#ifndef FIPS_MODE
+/* The type of parameters selected in key parameter functions */
+# define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
+
int EVP_PKEY_bits(const EVP_PKEY *pkey)
{
if (pkey != NULL) {
*/
/*
- * Only check that type match this early when both keys are legacy.
- * If either of them is provided, we let evp_keymgmt_util_copy()
- * do this check, after having exported either of them that isn't
- * provided.
+ * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
+ * If that fails, this function fails.
*/
- if (to->keymgmt == NULL && from->keymgmt == NULL) {
- if (to->type == EVP_PKEY_NONE) {
+ if (to->type != EVP_PKEY_NONE && from->keymgmt != NULL)
+ if (!evp_pkey_downgrade((EVP_PKEY *)from))
+ return 0;
+
+ /*
+ * Make sure |to| is typed. Content is less important at this early
+ * stage.
+ *
+ * 1. If |to| is untyped, assign |from|'s key type to it.
+ * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
+ * (|from| was already downgraded above)
+ *
+ * If |to| is a provided key, there's nothing more to do here, functions
+ * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
+ * further down help us find out if they are the same or not.
+ */
+ if (to->type == EVP_PKEY_NONE && to->keymgmt == NULL) {
+ if (from->type != EVP_PKEY_NONE) {
if (EVP_PKEY_set_type(to, from->type) == 0)
return 0;
- } else if (to->type != from->type) {
+ } else {
+ if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
+ return 0;
+ }
+ } else if (to->type != EVP_PKEY_NONE) {
+ if (to->type != from->type) {
EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
goto err;
}
return 0;
}
- /*
- * If |from| is provided, we upgrade |to| to be provided as well.
- * This drops the legacy key from |to|.
- * evp_pkey_upgrade_to_provider() checks if |to| is already provided,
- * we don't need to do that here.
- *
- * TODO(3.0) We should investigate if that's too aggressive and make
- * this scenario unsupported instead.
- */
- if (from->keymgmt != NULL) {
- EVP_KEYMGMT *tmp_keymgmt = from->keymgmt;
-
- /*
- * The returned pointer is known to be cached, so we don't have to
- * save it. However, if it's NULL, something went wrong and we can't
- * copy.
- */
- if (evp_pkey_upgrade_to_provider(to, NULL,
- &tmp_keymgmt, NULL) == NULL) {
- ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
- return 0;
- }
- }
-
/* For purely provided keys, we just call the keymgmt utility */
if (to->keymgmt != NULL && from->keymgmt != NULL)
- return evp_keymgmt_util_copy(to, (EVP_PKEY *)from,
- OSSL_KEYMGMT_SELECT_ALL_PARAMETERS);
+ return evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
/*
* If |to| is provided, we know that |from| is legacy at this point.
evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
NULL);
+ /*
+ * If we get a NULL, it could be an internal error, or it could be
+ * that there's a key mismatch. We're pretending the latter...
+ */
if (from_keydata == NULL) {
- ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
+ ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
return 0;
}
return evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
- OSSL_KEYMGMT_SELECT_ALL_PARAMETERS);
+ SELECT_PARAMETERS);
}
/* Both keys are legacy */
{
if (pkey != NULL) {
if (pkey->keymgmt != NULL)
- return !evp_keymgmt_util_has((EVP_PKEY *)pkey,
- OSSL_KEYMGMT_SELECT_ALL_PARAMETERS);
+ return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
return pkey->ameth->param_missing(pkey);
}
return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
/*
- * Here, we know that we have a mixture of legacy and provided keys.
- * Try cross export and compare the resulting key data.
+ * At this point, one of them is provided, the other not. This allows
+ * us to compare types using legacy NIDs.
+ */
+ if ((a->type != EVP_PKEY_NONE
+ && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
+ || (b->type != EVP_PKEY_NONE
+ && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type))))
+ return -1; /* not the same key type */
+
+ /*
+ * We've determined that they both are the same keytype, so the next
+ * step is to do a bit of cross export to ensure we have keydata for
+ * both keys in the same keymgmt.
*/
keymgmt1 = a->keymgmt;
keydata1 = a->keydata;
keymgmt2 = b->keymgmt;
keydata2 = b->keydata;
- if ((keymgmt1 == NULL
- && !EVP_KEYMGMT_is_a(keymgmt2, OBJ_nid2sn(a->type)))
- || (keymgmt2 == NULL
- && !EVP_KEYMGMT_is_a(keymgmt1, OBJ_nid2sn(b->type))))
- return -1; /* not the same key type */
-
if (keymgmt2 != NULL && keymgmt2->match != NULL) {
tmp_keydata =
evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
*/
if (a->keymgmt != NULL || b->keymgmt != NULL)
- return evp_pkey_cmp_any(a, b, OSSL_KEYMGMT_SELECT_ALL_PARAMETERS);
+ return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
/* All legacy keys */
if (a->type != b->type)
*/
if (a->keymgmt != NULL || b->keymgmt != NULL)
- return evp_pkey_cmp_any(a, b,
- OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
- | OSSL_KEYMGMT_SELECT_PUBLIC_KEY);
+ return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
+ | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
/* All legacy keys */
if (a->type != b->type)
return -2;
}
-
-/*
- * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
- * is NULL just return 1 or 0 if the algorithm exists.
- */
-
-static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
- int len)
-{
- const EVP_PKEY_ASN1_METHOD *ameth;
- ENGINE **eptr = (e == NULL) ? &e : NULL;
-
- if (pkey) {
- if (pkey->pkey.ptr)
- evp_pkey_free_it(pkey);
- /*
- * If key type matches and a method exists then this lookup has
- * succeeded once so just indicate success.
- */
- if ((type == pkey->save_type) && pkey->ameth)
- return 1;
-# ifndef OPENSSL_NO_ENGINE
- /* If we have ENGINEs release them */
- ENGINE_finish(pkey->engine);
- pkey->engine = NULL;
- ENGINE_finish(pkey->pmeth_engine);
- pkey->pmeth_engine = NULL;
-# endif
- }
- if (str)
- ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
- else
- ameth = EVP_PKEY_asn1_find(eptr, type);
-# ifndef OPENSSL_NO_ENGINE
- if (pkey == NULL && eptr != NULL)
- ENGINE_finish(e);
-# endif
- if (ameth == NULL) {
- EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
- return 0;
- }
- if (pkey) {
- pkey->ameth = ameth;
- pkey->engine = e;
-
- pkey->type = pkey->ameth->pkey_id;
- pkey->save_type = type;
- }
- return 1;
-}
-
EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
const unsigned char *priv,
size_t len)
EVP_PKEY *ret = EVP_PKEY_new();
if (ret == NULL
- || !pkey_set_type(ret, e, type, NULL, -1)) {
+ || !pkey_set_type(ret, e, type, NULL, -1, NULL)) {
/* EVPerr already called */
goto err;
}
EVP_PKEY *ret = EVP_PKEY_new();
if (ret == NULL
- || !pkey_set_type(ret, e, type, NULL, -1)) {
+ || !pkey_set_type(ret, e, type, NULL, -1, NULL)) {
/* EVPerr already called */
goto err;
}
int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
size_t *len)
{
+ /* TODO(3.0) Do we need to do anything about provider side keys? */
if (pkey->ameth->get_priv_key == NULL) {
EVPerr(EVP_F_EVP_PKEY_GET_RAW_PRIVATE_KEY,
EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
size_t *len)
{
+ /* TODO(3.0) Do we need to do anything about provider side keys? */
if (pkey->ameth->get_pub_key == NULL) {
EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
size_t paramsn = 0;
if (ret == NULL
- || cmctx == NULL
- || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1)) {
+ || cmctx == NULL
+ || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1, NULL)) {
/* EVPerr already called */
goto err;
}
int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
{
- return pkey_set_type(pkey, NULL, type, NULL, -1);
+ return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
}
int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
{
- return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len);
+ return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
}
int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
void *EVP_PKEY_get0(const EVP_PKEY *pkey)
{
+ if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
+ ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
+ return NULL;
+ }
return pkey->pkey.ptr;
}
RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey)
{
+ if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
+ ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
+ return NULL;
+ }
if (pkey->type != EVP_PKEY_RSA && pkey->type != EVP_PKEY_RSA_PSS) {
EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
return NULL;
DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
{
+ if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
+ ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
+ return NULL;
+ }
if (pkey->type != EVP_PKEY_DSA) {
EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
return NULL;
EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
{
+ if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
+ ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
+ return NULL;
+ }
if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
return NULL;
DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
{
+ if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
+ ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
+ return NULL;
+ }
if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
return NULL;
return EVP_PKEY_type(pkey->type);
}
+int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
+{
+#ifndef FIPS_MODE
+ 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;
+
+ if (strcasecmp(name, "RSA") == 0)
+ type = EVP_PKEY_RSA;
+#ifndef OPENSSL_NO_EC
+ else if (strcasecmp(name, "EC") == 0)
+ type = EVP_PKEY_EC;
+#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;
+ }
+#endif
+ return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
+}
+
+int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
+{
+ if (pkey->keymgmt == NULL) {
+ switch (EVP_PKEY_base_id(pkey)) {
+ case EVP_PKEY_RSA:
+ return 1;
+#ifndef OPENSSL_NO_DSA
+ case EVP_PKEY_DSA:
+ return 1;
+#endif
+#ifndef OPENSSL_NO_EC
+ case EVP_PKEY_ED25519:
+ case EVP_PKEY_ED448:
+ return 1;
+ case EVP_PKEY_EC: /* Including SM2 */
+ return EC_KEY_can_sign(pkey->pkey.ec);
+#endif
+ default:
+ break;
+ }
+ } else {
+ const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
+ OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
+ const char *supported_sig =
+ pkey->keymgmt->query_operation_name != NULL
+ ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
+ : evp_first_name(prov, pkey->keymgmt->name_id);
+ EVP_SIGNATURE *signature = NULL;
+
+ signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
+ if (signature != NULL) {
+ EVP_SIGNATURE_free(signature);
+ return 1;
+ }
+ }
+ return 0;
+}
+
+#ifndef OPENSSL_NO_EC
+/*
+ * TODO rewrite when we have proper data extraction functions
+ * Note: an octet pointer would be desirable!
+ */
+static OSSL_CALLBACK get_ec_curve_name_cb;
+static int get_ec_curve_name_cb(const OSSL_PARAM params[], void *arg)
+{
+ const OSSL_PARAM *p = NULL;
+
+ if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_EC_NAME)) != NULL)
+ return OSSL_PARAM_get_utf8_string(p, arg, 0);
+
+ /* If there is no curve name, this is not an EC key */
+ return 0;
+}
+
+int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY *pkey)
+{
+ int ret = NID_undef;
+
+ if (pkey->keymgmt == NULL) {
+ if (EVP_PKEY_base_id(pkey) == EVP_PKEY_EC) {
+ EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
+
+ ret = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
+ }
+ } else if (EVP_PKEY_is_a(pkey, "EC") || EVP_PKEY_is_a(pkey, "SM2")) {
+ char *curve_name = NULL;
+
+ ret = evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
+ OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
+ get_ec_curve_name_cb, &curve_name);
+ if (ret)
+ ret = ec_curve_name2nid(curve_name);
+ OPENSSL_free(curve_name);
+ }
+
+ return ret;
+}
+#endif
static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
{
return ret;
}
+/*
+ * Setup a public key management method.
+ *
+ * For legacy keys, either |type| or |str| is expected to have the type
+ * information. In this case, the setup consists of finding an ASN1 method
+ * and potentially an ENGINE, and setting those fields in |pkey|.
+ *
+ * For provider side keys, |keymgmt| is expected to be non-NULL. In this
+ * case, the setup consists of setting the |keymgmt| field in |pkey|.
+ *
+ * If pkey is NULL just return 1 or 0 if the key management method exists.
+ */
+
+static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
+ int len, EVP_KEYMGMT *keymgmt)
+{
+#ifndef FIPS_MODE
+ const EVP_PKEY_ASN1_METHOD *ameth = NULL;
+ ENGINE **eptr = (e == NULL) ? &e : NULL;
+#endif
+
+ /*
+ * The setups can't set both legacy and provider side methods.
+ * It is forbidden
+ */
+ if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
+ || !ossl_assert(e == NULL || keymgmt == NULL)) {
+ ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
+ return 0;
+ }
+
+ if (pkey != NULL) {
+ int free_it = 0;
+
+#ifndef FIPS_MODE
+ free_it = free_it || pkey->pkey.ptr != NULL;
+#endif
+ free_it = free_it || pkey->keydata != NULL;
+ if (free_it)
+ evp_pkey_free_it(pkey);
+#ifndef FIPS_MODE
+ /*
+ * If key type matches and a method exists then this lookup has
+ * succeeded once so just indicate success.
+ */
+ if (pkey->type != EVP_PKEY_NONE
+ && type == pkey->save_type
+ && pkey->ameth != NULL)
+ return 1;
+# ifndef OPENSSL_NO_ENGINE
+ /* If we have ENGINEs release them */
+ ENGINE_finish(pkey->engine);
+ pkey->engine = NULL;
+ ENGINE_finish(pkey->pmeth_engine);
+ pkey->pmeth_engine = NULL;
+# endif
+#endif
+ }
+#ifndef FIPS_MODE
+ if (str != NULL)
+ ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
+ else if (type != EVP_PKEY_NONE)
+ ameth = EVP_PKEY_asn1_find(eptr, type);
+# ifndef OPENSSL_NO_ENGINE
+ if (pkey == NULL && eptr != NULL)
+ ENGINE_finish(e);
+# endif
+#endif
+
+
+ {
+ int check = 1;
+
+#ifndef FIPS_MODE
+ check = check && ameth == NULL;
+#endif
+ check = check && keymgmt == NULL;
+ if (check) {
+ EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
+ return 0;
+ }
+ }
+ if (pkey != NULL) {
+ if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
+ ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
+ return 0;
+ }
+
+ pkey->keymgmt = keymgmt;
+
+ pkey->save_type = type;
+ pkey->type = type;
+
+#ifndef FIPS_MODE
+ /*
+ * If the internal "origin" key is provider side, don't save |ameth|.
+ * The main reason is that |ameth| is one factor to detect that the
+ * internal "origin" key is a legacy one.
+ */
+ if (keymgmt == NULL)
+ pkey->ameth = ameth;
+ pkey->engine = e;
+
+ /*
+ * The EVP_PKEY_ASN1_METHOD |pkey_id| serves different purposes,
+ * depending on if we're setting this key to contain a legacy or
+ * a provider side "origin" key. For a legacy key, we assign it
+ * to the |type| field, but for a provider side key, we assign it
+ * to the |save_type| field, because |type| is supposed to be set
+ * to EVP_PKEY_NONE in that case.
+ */
+ if (keymgmt != NULL)
+ pkey->save_type = ameth->pkey_id;
+ else if (pkey->ameth != NULL)
+ pkey->type = ameth->pkey_id;
+#endif
+ }
+ return 1;
+}
+
+#ifndef FIPS_MODE
+static void find_ameth(const char *name, void *data)
+{
+ const char **str = data;
+
+ /*
+ * The error messages from pkey_set_type() are uninteresting here,
+ * and misleading.
+ */
+ ERR_set_mark();
+
+ if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
+ NULL)) {
+ if (str[0] == NULL)
+ str[0] = name;
+ else if (str[1] == NULL)
+ str[1] = name;
+ }
+
+ ERR_pop_to_mark();
+}
+#endif
+
+int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
+{
+#ifndef FIPS_MODE
+# define EVP_PKEY_TYPE_STR str[0]
+# define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
+ /*
+ * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
+ * Ideally, only one should be found. If two (or more) are found, the
+ * match is ambiguous. This should never happen, but...
+ */
+ const char *str[2] = { NULL, NULL };
+
+ EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
+ if (str[1] != NULL) {
+ ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
+ return 0;
+ }
+#else
+# define EVP_PKEY_TYPE_STR NULL
+# define EVP_PKEY_TYPE_STRLEN -1
+#endif
+ return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
+ EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
+ keymgmt);
+
+#undef EVP_PKEY_TYPE_STR
+#undef EVP_PKEY_TYPE_STRLEN
+}
+
int EVP_PKEY_up_ref(EVP_PKEY *pkey)
{
int i;
if (x->ameth->pkey_free != NULL)
x->ameth->pkey_free(x);
x->pkey.ptr = NULL;
- x->ameth = NULL;
}
# ifndef OPENSSL_NO_ENGINE
ENGINE_finish(x->engine);
ENGINE_finish(x->pmeth_engine);
x->pmeth_engine = NULL;
# endif
- x->type = x->save_type = EVP_PKEY_NONE;
+ x->type = EVP_PKEY_NONE;
}
#endif /* FIPS_MODE */
if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
goto end;
- if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt)) {
+ if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
evp_keymgmt_freedata(tmp_keymgmt, keydata);
keydata = NULL;
goto end;
}
#ifndef FIPS_MODE
-/*
- * This differs from exporting in that it releases the legacy key and assigns
- * the export keymgmt and keydata to the "origin" provider side key instead
- * of the operation cache.
- */
-void *evp_pkey_upgrade_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
- EVP_KEYMGMT **keymgmt,
- const char *propquery)
+int evp_pkey_downgrade(EVP_PKEY *pk)
{
- EVP_KEYMGMT *allocated_keymgmt = NULL;
- EVP_KEYMGMT *tmp_keymgmt = NULL;
- void *keydata = NULL;
+ EVP_KEYMGMT *keymgmt = pk->keymgmt;
+ void *keydata = pk->keydata;
+ int type = pk->save_type;
+ const char *keytype = NULL;
- if (pk == NULL)
- return NULL;
+ /* If this isn't a provider side key, we're done */
+ if (keymgmt == NULL)
+ return 1;
+
+ /* Get the key type name for error reporting */
+ if (type != EVP_PKEY_NONE)
+ keytype = OBJ_nid2sn(type);
+ else
+ keytype =
+ evp_first_name(EVP_KEYMGMT_provider(keymgmt), keymgmt->name_id);
/*
- * If this key is already "upgraded", this function shouldn't have been
- * called.
+ * |save_type| was set when any of the EVP_PKEY_set_type functions
+ * was called. It was set to EVP_PKEY_NONE if the key type wasn't
+ * recognised to be any of the legacy key types, and the downgrade
+ * isn't possible.
*/
- if (!ossl_assert(pk->keymgmt == NULL))
- return NULL;
-
- if (keymgmt != NULL) {
- tmp_keymgmt = *keymgmt;
- *keymgmt = NULL;
+ if (type == EVP_PKEY_NONE) {
+ ERR_raise_data(ERR_LIB_EVP, EVP_R_UNKNOWN_KEY_TYPE,
+ "key type = %s, can't downgrade", keytype);
+ return 0;
}
- /* If the key isn't a legacy one, bail out, but with proper values */
- if (pk->pkey.ptr == NULL) {
- tmp_keymgmt = pk->keymgmt;
- keydata = pk->keydata;
- } else {
- /* If the legacy key doesn't have an export function, give up */
- if (pk->ameth->export_to == NULL)
- return NULL;
+ /*
+ * 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)
+ return 1;
- /*
- * If no keymgmt was given or found, get a default keymgmt. We do
- * so by letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we
- * steal it.
- */
- if (tmp_keymgmt == NULL) {
- EVP_PKEY_CTX *ctx =
- EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
+ if (pk->ameth->import_from == NULL) {
+ ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
+ "key type = %s", keytype);
+ } else if (evp_keymgmt_export(keymgmt, keydata,
+ OSSL_KEYMGMT_SELECT_ALL,
+ pk->ameth->import_from, pk)) {
+ /*
+ * 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.
+ */
+ evp_keymgmt_util_cache_keydata(pk, 0, keymgmt, keydata);
- tmp_keymgmt = ctx->keymgmt;
- ctx->keymgmt = NULL;
- EVP_PKEY_CTX_free(ctx);
+ /* Synchronize the dirty count */
+ pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
+ return 1;
}
- /* If we still don't have a keymgmt, give up */
- if (tmp_keymgmt == NULL)
- goto end;
+ ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
+ "key type = %s", keytype);
+ }
- /* Make sure that the keymgmt key type matches the legacy NID */
- if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
- goto end;
+ /*
+ * 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.
+ */
+ if (!ossl_assert(EVP_PKEY_set_type_by_keymgmt(pk, keymgmt))) {
+ /* This should not be impossible */
+ ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
+ return 0;
+ }
+ pk->keydata = keydata;
+ evp_keymgmt_util_cache_keyinfo(pk);
+ return 0; /* No downgrade, but at least the key is restored */
+}
+#endif /* FIPS_MODE */
- if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
- goto end;
+const OSSL_PARAM *EVP_PKEY_gettable_params(EVP_PKEY *pkey)
+{
+ if (pkey == NULL
+ || pkey->keymgmt == NULL
+ || pkey->keydata == NULL)
+ return 0;
+ return evp_keymgmt_gettable_params(pkey->keymgmt);
+}
- if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt)
- || !EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
- evp_keymgmt_freedata(tmp_keymgmt, keydata);
- keydata = NULL;
- goto end;
- }
+/*
+ * For the following methods param->return_size is set to a value
+ * larger than can be returned by the call to evp_keymgmt_get_params().
+ * If it is still this value then the parameter was ignored - and in this
+ * case it returns an error..
+ */
+
+int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)
+{
+ int ret = 0;
+ OSSL_PARAM params[2];
+ unsigned char buffer[2048];
+ /*
+ * Use -1 as the terminator here instead of sizeof(buffer) + 1 since
+ * -1 is less likely to be a valid value.
+ */
+ const size_t not_set = (size_t)-1;
+ unsigned char *buf = NULL;
+ size_t buf_sz = 0;
+
+ if (pkey == NULL
+ || pkey->keymgmt == NULL
+ || pkey->keydata == NULL
+ || key_name == NULL
+ || bn == NULL)
+ return 0;
+ memset(buffer, 0, sizeof(buffer));
+ params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
+ /* If the return_size is still not_set then we know it was not found */
+ params[0].return_size = not_set;
+ params[1] = OSSL_PARAM_construct_end();
+ if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
+ if (params[0].return_size == not_set
+ || params[0].return_size == 0)
+ return 0;
+ buf_sz = params[0].return_size;
/*
- * Clear the operation cache, all the legacy data, as well as the
- * dirty counters
+ * If it failed because the buffer was too small then allocate the
+ * required buffer size and retry.
*/
- evp_pkey_free_legacy(pk);
- pk->dirty_cnt_copy = 0;
+ buf = OPENSSL_zalloc(buf_sz);
+ if (buf == NULL)
+ return 0;
+ params[0].data = buf;
+ params[0].data_size = buf_sz;
- evp_keymgmt_util_clear_operation_cache(pk);
- pk->keymgmt = tmp_keymgmt;
- pk->keydata = keydata;
- evp_keymgmt_util_cache_keyinfo(pk);
+ if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
+ goto err;
}
+ /* Fail if the param was not found */
+ if (params[0].return_size == not_set)
+ goto err;
+ ret = OSSL_PARAM_get_BN(params, bn);
+err:
+ OPENSSL_free(buf);
+ return ret;
+}
- end:
- /*
- * If nothing was upgraded, |tmp_keymgmt| might point at a freed
- * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
- * the caller either way in that case.
- */
- if (keydata == NULL)
- tmp_keymgmt = NULL;
+int EVP_PKEY_get_octet_string_param(EVP_PKEY *pkey, const char *key_name,
+ unsigned char *buf, size_t max_buf_sz,
+ size_t *out_sz)
+{
+ OSSL_PARAM params[2];
+ const size_t not_set = max_buf_sz + 1;
- if (keymgmt != NULL)
- *keymgmt = tmp_keymgmt;
+ if (pkey == NULL
+ || pkey->keymgmt == NULL
+ || pkey->keydata == NULL
+ || key_name == NULL)
+ return 0;
- EVP_KEYMGMT_free(allocated_keymgmt);
- return keydata;
+ params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
+ params[0].return_size = not_set;
+ params[1] = OSSL_PARAM_construct_end();
+ if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
+ return 0;
+ if (params[0].return_size == not_set)
+ return 0;
+ if (out_sz != NULL)
+ *out_sz = params[0].return_size;
+ return 1;
+}
+
+int EVP_PKEY_get_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
+ char *str, size_t max_buf_sz,
+ size_t *out_sz)
+{
+ OSSL_PARAM params[2];
+ const size_t not_set = max_buf_sz + 1;
+
+ if (pkey == NULL
+ || pkey->keymgmt == NULL
+ || pkey->keydata == NULL
+ || key_name == NULL)
+ return 0;
+
+ params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
+ params[0].return_size = not_set;
+ params[1] = OSSL_PARAM_construct_end();
+ if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
+ return 0;
+ if (params[0].return_size == not_set)
+ return 0;
+ if (out_sz != NULL)
+ *out_sz = params[0].return_size;
+ return 1;
+}
+
+int EVP_PKEY_get_int_param(EVP_PKEY *pkey, const char *key_name, int *out)
+{
+ OSSL_PARAM params[2];
+ const size_t not_set = sizeof(int) + 1;
+
+ if (pkey == NULL
+ || pkey->keymgmt == NULL
+ || pkey->keydata == NULL
+ || key_name == NULL)
+ return 0;
+
+ params[0] = OSSL_PARAM_construct_int(key_name, out);
+ params[0].return_size = not_set;
+ params[1] = OSSL_PARAM_construct_end();
+ if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
+ return 0;
+ if (params[0].return_size == not_set)
+ return 0;
+ return 1;
+}
+
+int EVP_PKEY_get_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t *out)
+{
+ OSSL_PARAM params[2];
+ const size_t not_set = sizeof(size_t) + 1;
+
+ if (pkey == NULL
+ || pkey->keymgmt == NULL
+ || pkey->keydata == NULL
+ || key_name == NULL)
+ return 0;
+
+ params[0] = OSSL_PARAM_construct_size_t(key_name, out);
+ params[0].return_size = not_set;
+ params[1] = OSSL_PARAM_construct_end();
+ if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
+ return 0;
+ if (params[0].return_size == not_set)
+ return 0;
+ return 1;
}
-#endif /* FIPS_MODE */
projects / openssl.git / blobdiff