/*
- * Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 2020-2023 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
* https://www.openssl.org/source/license.html
*/
+/* We need to use some engine deprecated APIs */
+#define OPENSSL_SUPPRESS_DEPRECATED
+
#include <string.h>
#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/err.h>
#include <openssl/evp.h>
-#include "openssl/param_build.h"
+#include <openssl/proverr.h>
+#include <openssl/param_build.h>
+#ifndef FIPS_MODULE
+# include <openssl/engine.h>
+#endif
#include "internal/param_build_set.h"
#include "prov/implementations.h"
#include "prov/providercommon.h"
#include "prov/provider_ctx.h"
#include "prov/macsignature.h"
-#include "e_os.h" /* strcasecmp */
static OSSL_FUNC_keymgmt_new_fn mac_new;
static OSSL_FUNC_keymgmt_free_fn mac_free;
static OSSL_FUNC_keymgmt_gen_init_fn mac_gen_init;
static OSSL_FUNC_keymgmt_gen_fn mac_gen;
static OSSL_FUNC_keymgmt_gen_cleanup_fn mac_gen_cleanup;
+static OSSL_FUNC_keymgmt_gen_set_params_fn mac_gen_set_params;
+static OSSL_FUNC_keymgmt_gen_settable_params_fn mac_gen_settable_params;
static OSSL_FUNC_keymgmt_get_params_fn mac_get_params;
static OSSL_FUNC_keymgmt_gettable_params_fn mac_gettable_params;
static OSSL_FUNC_keymgmt_set_params_fn mac_set_params;
static OSSL_FUNC_keymgmt_export_fn mac_export;
static OSSL_FUNC_keymgmt_export_types_fn mac_imexport_types;
+static OSSL_FUNC_keymgmt_new_fn mac_new_cmac;
+static OSSL_FUNC_keymgmt_gettable_params_fn cmac_gettable_params;
+static OSSL_FUNC_keymgmt_import_types_fn cmac_imexport_types;
+static OSSL_FUNC_keymgmt_export_types_fn cmac_imexport_types;
+static OSSL_FUNC_keymgmt_gen_init_fn cmac_gen_init;
+static OSSL_FUNC_keymgmt_gen_set_params_fn cmac_gen_set_params;
+static OSSL_FUNC_keymgmt_gen_settable_params_fn cmac_gen_settable_params;
+
struct mac_gen_ctx {
- OPENSSL_CTX *libctx;
+ OSSL_LIB_CTX *libctx;
int selection;
unsigned char *priv_key;
size_t priv_key_len;
- char *cipher_name;
+ PROV_CIPHER cipher;
};
-MAC_KEY *mac_key_new(OPENSSL_CTX *libctx, int cmac)
+MAC_KEY *ossl_mac_key_new(OSSL_LIB_CTX *libctx, int cmac)
{
- MAC_KEY *mackey = OPENSSL_zalloc(sizeof(*mackey));
+ MAC_KEY *mackey;
+
+ if (!ossl_prov_is_running())
+ return NULL;
+ mackey = OPENSSL_zalloc(sizeof(*mackey));
if (mackey == NULL)
return NULL;
- mackey->lock = CRYPTO_THREAD_lock_new();
- if (mackey->lock == NULL) {
+ if (!CRYPTO_NEW_REF(&mackey->refcnt, 1)) {
OPENSSL_free(mackey);
return NULL;
}
mackey->libctx = libctx;
- mackey->refcnt = 1;
mackey->cmac = cmac;
return mackey;
}
-void mac_key_free(MAC_KEY *mackey)
+void ossl_mac_key_free(MAC_KEY *mackey)
{
int ref = 0;
if (mackey == NULL)
return;
- CRYPTO_DOWN_REF(&mackey->refcnt, &ref, mackey->lock);
+ CRYPTO_DOWN_REF(&mackey->refcnt, &ref);
if (ref > 0)
return;
OPENSSL_secure_clear_free(mackey->priv_key, mackey->priv_key_len);
- OPENSSL_free(mackey->cipher_name);
- OPENSSL_free(mackey->engine_name);
- CRYPTO_THREAD_lock_free(mackey->lock);
+ OPENSSL_free(mackey->properties);
+ ossl_prov_cipher_reset(&mackey->cipher);
+ CRYPTO_FREE_REF(&mackey->refcnt);
OPENSSL_free(mackey);
}
-int mac_key_up_ref(MAC_KEY *mackey)
+int ossl_mac_key_up_ref(MAC_KEY *mackey)
{
int ref = 0;
- CRYPTO_UP_REF(&mackey->refcnt, &ref, mackey->lock);
+ /* This is effectively doing a new operation on the MAC_KEY and should be
+ * adequately guarded again modules' error states. However, both current
+ * calls here are guarded properly in signature/mac_legacy.c. Thus, it
+ * could be removed here. The concern is that something in the future
+ * might call this function without adequate guards. It's a cheap call,
+ * it seems best to leave it even though it is currently redundant.
+ */
+ if (!ossl_prov_is_running())
+ return 0;
+
+ CRYPTO_UP_REF(&mackey->refcnt, &ref);
return 1;
}
static void *mac_new(void *provctx)
{
- return mac_key_new(PROV_LIBRARY_CONTEXT_OF(provctx), 0);
+ return ossl_mac_key_new(PROV_LIBCTX_OF(provctx), 0);
}
static void *mac_new_cmac(void *provctx)
{
- return mac_key_new(PROV_LIBRARY_CONTEXT_OF(provctx), 1);
+ return ossl_mac_key_new(PROV_LIBCTX_OF(provctx), 1);
}
static void mac_free(void *mackey)
{
- mac_key_free(mackey);
+ ossl_mac_key_free(mackey);
}
-static int mac_has(void *keydata, int selection)
+static int mac_has(const void *keydata, int selection)
{
- MAC_KEY *key = keydata;
+ const MAC_KEY *key = keydata;
int ok = 0;
- if (key != NULL) {
+ if (ossl_prov_is_running() && key != NULL) {
/*
* MAC keys always have all the parameters they need (i.e. none).
* Therefore we always return with 1, if asked about parameters.
const MAC_KEY *key2 = keydata2;
int ok = 1;
+ if (!ossl_prov_is_running())
+ return 0;
+
if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
if ((key1->priv_key == NULL && key2->priv_key != NULL)
|| (key1->priv_key != NULL && key2->priv_key == NULL)
|| key1->priv_key_len != key2->priv_key_len
- || (key1->cipher_name == NULL && key2->cipher_name != NULL)
- || (key1->cipher_name != NULL && key2->cipher_name == NULL))
+ || (key1->cipher.cipher == NULL && key2->cipher.cipher != NULL)
+ || (key1->cipher.cipher != NULL && key2->cipher.cipher == NULL))
ok = 0;
else
ok = ok && (key1->priv_key == NULL /* implies key2->privkey == NULL */
|| CRYPTO_memcmp(key1->priv_key, key2->priv_key,
key1->priv_key_len) == 0);
- if (key1->cipher_name != NULL)
- ok = ok && (strcasecmp(key1->cipher_name, key2->cipher_name) == 0);
+ if (key1->cipher.cipher != NULL)
+ ok = ok && EVP_CIPHER_is_a(key1->cipher.cipher,
+ EVP_CIPHER_get0_name(key2->cipher.cipher));
}
return ok;
}
return 0;
}
OPENSSL_secure_clear_free(key->priv_key, key->priv_key_len);
- key->priv_key = OPENSSL_secure_malloc(p->data_size);
- if (key->priv_key == NULL) {
- ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
+ /* allocate at least one byte to distinguish empty key from no key set */
+ key->priv_key = OPENSSL_secure_malloc(p->data_size > 0 ? p->data_size : 1);
+ if (key->priv_key == NULL)
return 0;
- }
memcpy(key->priv_key, p->data, p->data_size);
key->priv_key_len = p->data_size;
}
- if (key->cmac) {
- p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_CIPHER);
- if (p != NULL) {
- if (p->data_type != OSSL_PARAM_UTF8_STRING) {
- ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
- return 0;
- }
- key->cipher_name = OPENSSL_strdup(p->data);
- if (key->cipher_name == NULL) {
- ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
- return 0;
- }
- }
- p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_ENGINE);
- if (p != NULL) {
- if (p->data_type != OSSL_PARAM_UTF8_STRING) {
- ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
- return 0;
- }
- key->engine_name = OPENSSL_strdup(p->data);
- if (key->engine_name == NULL) {
- ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
- return 0;
- }
+ p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PROPERTIES);
+ if (p != NULL) {
+ if (p->data_type != OSSL_PARAM_UTF8_STRING) {
+ ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
+ return 0;
}
+ OPENSSL_free(key->properties);
+ key->properties = OPENSSL_strdup(p->data);
+ if (key->properties == NULL)
+ return 0;
}
- if (key->priv_key != NULL && (!key->cmac || key->cipher_name != NULL))
+ if (key->cmac && !ossl_prov_cipher_load_from_params(&key->cipher, params,
+ key->libctx)) {
+ ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
+ return 0;
+ }
+
+ if (key->priv_key != NULL)
return 1;
return 0;
{
MAC_KEY *key = keydata;
- if (key == NULL)
+ if (!ossl_prov_is_running() || key == NULL)
return 0;
if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) == 0)
key->priv_key, key->priv_key_len))
return 0;
- if (key->cipher_name != NULL
+ if (key->cipher.cipher != NULL
&& !ossl_param_build_set_utf8_string(tmpl, params,
OSSL_PKEY_PARAM_CIPHER,
- key->cipher_name))
+ EVP_CIPHER_get0_name(key->cipher.cipher)))
return 0;
- if (key->engine_name != NULL
+#if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
+ if (key->cipher.engine != NULL
&& !ossl_param_build_set_utf8_string(tmpl, params,
OSSL_PKEY_PARAM_ENGINE,
- key->engine_name))
+ ENGINE_get_id(key->cipher.engine)))
return 0;
+#endif
return 1;
}
OSSL_PARAM *params = NULL;
int ret = 0;
- if (key == NULL)
+ if (!ossl_prov_is_running() || key == NULL)
+ return 0;
+
+ if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) == 0)
return 0;
tmpl = OSSL_PARAM_BLD_new();
goto err;
ret = param_cb(params, cbarg);
- OSSL_PARAM_BLD_free_params(params);
+ OSSL_PARAM_free(params);
err:
OSSL_PARAM_BLD_free(tmpl);
return ret;
static const OSSL_PARAM mac_key_types[] = {
OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
+ OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
OSSL_PARAM_END
};
static const OSSL_PARAM *mac_imexport_types(int selection)
OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER, NULL, 0),
OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_ENGINE, NULL, 0),
+ OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
OSSL_PARAM_END
};
static const OSSL_PARAM *cmac_imexport_types(int selection)
return gettable_params;
}
-
static int mac_set_params(void *keydata, const OSSL_PARAM params[])
{
MAC_KEY *key = keydata;
return settable_params;
}
-static void *mac_gen_init(void *provctx, int selection)
+static void *mac_gen_init_common(void *provctx, int selection)
{
- OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
+ OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
struct mac_gen_ctx *gctx = NULL;
+ if (!ossl_prov_is_running())
+ return NULL;
+
if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
gctx->libctx = libctx;
gctx->selection = selection;
return gctx;
}
+static void *mac_gen_init(void *provctx, int selection,
+ const OSSL_PARAM params[])
+{
+ struct mac_gen_ctx *gctx = mac_gen_init_common(provctx, selection);
+
+ if (gctx != NULL && !mac_gen_set_params(gctx, params)) {
+ OPENSSL_free(gctx);
+ gctx = NULL;
+ }
+ return gctx;
+}
+
+static void *cmac_gen_init(void *provctx, int selection,
+ const OSSL_PARAM params[])
+{
+ struct mac_gen_ctx *gctx = mac_gen_init_common(provctx, selection);
+
+ if (gctx != NULL && !cmac_gen_set_params(gctx, params)) {
+ OPENSSL_free(gctx);
+ gctx = NULL;
+ }
+ return gctx;
+}
+
static int mac_gen_set_params(void *genctx, const OSSL_PARAM params[])
{
struct mac_gen_ctx *gctx = genctx;
return 0;
}
gctx->priv_key = OPENSSL_secure_malloc(p->data_size);
- if (gctx->priv_key == NULL) {
- ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
+ if (gctx->priv_key == NULL)
return 0;
- }
memcpy(gctx->priv_key, p->data, p->data_size);
gctx->priv_key_len = p->data_size;
}
static int cmac_gen_set_params(void *genctx, const OSSL_PARAM params[])
{
struct mac_gen_ctx *gctx = genctx;
- const OSSL_PARAM *p;
if (!mac_gen_set_params(genctx, params))
return 0;
- p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_CIPHER);
- if (p != NULL) {
- if (p->data_type != OSSL_PARAM_UTF8_STRING) {
- ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
- return 0;
- }
- gctx->cipher_name = OPENSSL_strdup(p->data);
- if (gctx->cipher_name == NULL) {
- ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
- return 0;
- }
+ if (!ossl_prov_cipher_load_from_params(&gctx->cipher, params,
+ gctx->libctx)) {
+ ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
+ return 0;
}
return 1;
}
-static const OSSL_PARAM *mac_gen_settable_params(void *provctx)
+static const OSSL_PARAM *mac_gen_settable_params(ossl_unused void *genctx,
+ ossl_unused void *provctx)
{
static OSSL_PARAM settable[] = {
OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
return settable;
}
-static const OSSL_PARAM *cmac_gen_settable_params(void *provctx)
+static const OSSL_PARAM *cmac_gen_settable_params(ossl_unused void *genctx,
+ ossl_unused void *provctx)
{
static OSSL_PARAM settable[] = {
OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
struct mac_gen_ctx *gctx = genctx;
MAC_KEY *key;
- if (gctx == NULL)
+ if (!ossl_prov_is_running() || gctx == NULL)
return NULL;
- if ((key = mac_key_new(gctx->libctx, 0)) == NULL) {
- ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
+ if ((key = ossl_mac_key_new(gctx->libctx, 0)) == NULL) {
+ ERR_raise(ERR_LIB_PROV, ERR_R_PROV_LIB);
return NULL;
}
return key;
if (gctx->priv_key == NULL) {
- ERR_raise(ERR_LIB_PROV, EVP_R_INVALID_KEY);
- mac_key_free(key);
+ ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
+ ossl_mac_key_free(key);
return NULL;
}
* previously set in the gctx. Hopefully at some point in the future all
* of this can be removed and we will only support the EVP_KDF APIs.
*/
+ if (!ossl_prov_cipher_copy(&key->cipher, &gctx->cipher)) {
+ ossl_mac_key_free(key);
+ ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
+ return NULL;
+ }
+ ossl_prov_cipher_reset(&gctx->cipher);
key->priv_key = gctx->priv_key;
key->priv_key_len = gctx->priv_key_len;
- key->cipher_name = gctx->cipher_name;
gctx->priv_key_len = 0;
gctx->priv_key = NULL;
- gctx->cipher_name = NULL;
return key;
}
struct mac_gen_ctx *gctx = genctx;
OPENSSL_secure_clear_free(gctx->priv_key, gctx->priv_key_len);
- OPENSSL_free(gctx->cipher_name);
+ ossl_prov_cipher_reset(&gctx->cipher);
OPENSSL_free(gctx);
}
-const OSSL_DISPATCH mac_keymgmt_functions[] = {
+const OSSL_DISPATCH ossl_mac_legacy_keymgmt_functions[] = {
{ OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))mac_new },
{ OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))mac_free },
{ OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))mac_get_params },
(void (*)(void))mac_gen_settable_params },
{ OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))mac_gen },
{ OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))mac_gen_cleanup },
- { 0, NULL }
+ OSSL_DISPATCH_END
};
-const OSSL_DISPATCH cmac_keymgmt_functions[] = {
+const OSSL_DISPATCH ossl_cmac_legacy_keymgmt_functions[] = {
{ OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))mac_new_cmac },
{ OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))mac_free },
{ OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))mac_get_params },
{ OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))cmac_imexport_types },
{ OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))mac_export },
{ OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))cmac_imexport_types },
- { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))mac_gen_init },
+ { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))cmac_gen_init },
{ OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))cmac_gen_set_params },
{ OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
(void (*)(void))cmac_gen_settable_params },
{ OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))mac_gen },
{ OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))mac_gen_cleanup },
- { 0, NULL }
+ OSSL_DISPATCH_END
};
+
projects / openssl.git / blobdiff