* https://www.openssl.org/source/license.html
*/
+/*
+ * DH low level APIs are deprecated for public use, but still ok for
+ * internal use.
+ */
+#include "internal/deprecated.h"
+
#include <openssl/core_numbers.h>
#include <openssl/core_names.h>
#include <openssl/bn.h>
#include <openssl/dh.h>
#include <openssl/params.h>
-#include "internal/param_build.h"
#include "prov/implementations.h"
#include "prov/providercommon.h"
-
-static OSSL_OP_keymgmt_importdomparams_fn dh_importdomparams;
-static OSSL_OP_keymgmt_exportdomparams_fn dh_exportdomparams;
-static OSSL_OP_keymgmt_importkey_fn dh_importkey;
-static OSSL_OP_keymgmt_exportkey_fn dh_exportkey;
-
-static int params_to_domparams(DH *dh, const OSSL_PARAM params[])
-{
- const OSSL_PARAM *param_p, *param_g;
- BIGNUM *p = NULL, *g = NULL;
-
- if (dh == NULL)
- return 0;
-
- param_p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_P);
- param_g = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_G);
-
- if ((param_p != NULL && !OSSL_PARAM_get_BN(param_p, &p))
- || (param_g != NULL && !OSSL_PARAM_get_BN(param_g, &g)))
- goto err;
-
- if (!DH_set0_pqg(dh, p, NULL, g))
- goto err;
-
- return 1;
-
- err:
- BN_free(p);
- BN_free(g);
- return 0;
-}
+#include "prov/provider_ctx.h"
+#include "crypto/dh.h"
+#include "openssl/param_build.h"
+
+static OSSL_OP_keymgmt_new_fn dh_newdata;
+static OSSL_OP_keymgmt_free_fn dh_freedata;
+static OSSL_OP_keymgmt_get_params_fn dh_get_params;
+static OSSL_OP_keymgmt_gettable_params_fn dh_gettable_params;
+static OSSL_OP_keymgmt_has_fn dh_has;
+static OSSL_OP_keymgmt_match_fn dh_match;
+static OSSL_OP_keymgmt_validate_fn dh_validate;
+static OSSL_OP_keymgmt_import_fn dh_import;
+static OSSL_OP_keymgmt_import_types_fn dh_import_types;
+static OSSL_OP_keymgmt_export_fn dh_export;
+static OSSL_OP_keymgmt_export_types_fn dh_export_types;
+
+#define DH_POSSIBLE_SELECTIONS \
+ (OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS)
static int domparams_to_params(DH *dh, OSSL_PARAM_BLD *tmpl)
{
DH_get0_pqg(dh, &dh_p, NULL, &dh_g);
if (dh_p != NULL
- && !ossl_param_bld_push_BN(tmpl, OSSL_PKEY_PARAM_FFC_P, dh_p))
+ && !OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_FFC_P, dh_p))
return 0;
if (dh_g != NULL
- && !ossl_param_bld_push_BN(tmpl, OSSL_PKEY_PARAM_FFC_G, dh_g))
+ && !OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_FFC_G, dh_g))
return 0;
return 1;
}
-static int params_to_key(DH *dh, const OSSL_PARAM params[])
+static int key_to_params(DH *dh, OSSL_PARAM_BLD *tmpl)
{
- const OSSL_PARAM *param_priv_key, *param_pub_key;
- BIGNUM *priv_key = NULL, *pub_key = NULL;
+ const BIGNUM *priv_key = NULL, *pub_key = NULL;
if (dh == NULL)
return 0;
-
- if (!params_to_domparams(dh, params))
+ if (!domparams_to_params(dh, tmpl))
return 0;
- param_priv_key =
- OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DH_PRIV_KEY);
- param_pub_key =
- OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DH_PUB_KEY);
-
- /*
- * DH documentation says that a public key must be present if a
- * private key is present.
- * We want to have at least a public key either way, so we end up
- * requiring it unconditionally.
- */
- if (param_pub_key == NULL)
+ DH_get0_key(dh, &pub_key, &priv_key);
+ if (priv_key != NULL
+ && !OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_PRIV_KEY, priv_key))
+ return 0;
+ if (pub_key != NULL
+ && !OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_PUB_KEY, pub_key))
return 0;
- if ((param_priv_key != NULL
- && !OSSL_PARAM_get_BN(param_priv_key, &priv_key))
- || !OSSL_PARAM_get_BN(param_pub_key, &pub_key))
- goto err;
+ return 1;
+}
- if (!DH_set0_key(dh, pub_key, priv_key))
- goto err;
+static void *dh_newdata(void *provctx)
+{
+ return dh_new_with_ctx(PROV_LIBRARY_CONTEXT_OF(provctx));
+}
- return 1;
+static void dh_freedata(void *keydata)
+{
+ DH_free(keydata);
+}
- err:
- BN_free(priv_key);
- BN_free(pub_key);
- return 0;
+static int dh_has(void *keydata, int selection)
+{
+ DH *dh = keydata;
+ int ok = 0;
+
+ if (dh != NULL) {
+ if ((selection & DH_POSSIBLE_SELECTIONS) != 0)
+ ok = 1;
+
+ if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
+ ok = ok && (DH_get0_pub_key(dh) != NULL);
+ if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
+ ok = ok && (DH_get0_priv_key(dh) != NULL);
+ if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
+ ok = ok && (DH_get0_p(dh) != NULL && DH_get0_g(dh) != NULL);
+ }
+ return ok;
}
-static int key_to_params(DH *dh, OSSL_PARAM_BLD *tmpl)
+static int dh_match(const void *keydata1, const void *keydata2, int selection)
{
- const BIGNUM *priv_key = NULL, *pub_key = NULL;
+ const DH *dh1 = keydata1;
+ const DH *dh2 = keydata2;
+ int ok = 1;
+
+ if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
+ ok = ok && BN_cmp(DH_get0_pub_key(dh1), DH_get0_pub_key(dh2)) == 0;
+ if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
+ ok = ok && BN_cmp(DH_get0_priv_key(dh1), DH_get0_priv_key(dh2)) == 0;
+ if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
+ FFC_PARAMS *dhparams1 = dh_get0_params((DH *)dh1);
+ FFC_PARAMS *dhparams2 = dh_get0_params((DH *)dh2);
+
+ ok = ok && ffc_params_cmp(dhparams1, dhparams2, 1);
+ }
+ return ok;
+}
+
+static int dh_import(void *keydata, int selection, const OSSL_PARAM params[])
+{
+ DH *dh = keydata;
+ int ok = 0;
if (dh == NULL)
return 0;
- if (!domparams_to_params(dh, tmpl))
+
+ if ((selection & DH_POSSIBLE_SELECTIONS) != 0)
+ ok = 1;
+
+ if ((selection & OSSL_KEYMGMT_SELECT_ALL_PARAMETERS) != 0)
+ ok = ok && ffc_fromdata(dh_get0_params(dh), params);
+ if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
+ ok = ok && dh_key_fromdata(dh, params);
+
+ return ok;
+}
+
+static int dh_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,
+ void *cbarg)
+{
+ DH *dh = keydata;
+ OSSL_PARAM_BLD *tmpl;
+ OSSL_PARAM *params = NULL;
+ int ok = 1;
+
+ if (dh == NULL)
return 0;
- DH_get0_key(dh, &pub_key, &priv_key);
- if (priv_key != NULL
- && !ossl_param_bld_push_BN(tmpl, OSSL_PKEY_PARAM_DH_PRIV_KEY, priv_key))
+ tmpl = OSSL_PARAM_BLD_new();
+ if (tmpl == NULL)
return 0;
- if (pub_key != NULL
- && !ossl_param_bld_push_BN(tmpl, OSSL_PKEY_PARAM_DH_PUB_KEY, pub_key))
+
+ if ((selection & OSSL_KEYMGMT_SELECT_ALL_PARAMETERS) != 0)
+ ok = ok && domparams_to_params(dh, tmpl);
+ if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
+ ok = ok && key_to_params(dh, tmpl);
+
+ if (!ok
+ || (params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL) {
+ OSSL_PARAM_BLD_free(tmpl);
return 0;
+ }
+ OSSL_PARAM_BLD_free(tmpl);
- return 1;
+ ok = param_cb(params, cbarg);
+ OSSL_PARAM_BLD_free_params(params);
+ return ok;
}
-static void *dh_importdomparams(void *provctx, const OSSL_PARAM params[])
+/* IMEXPORT = IMPORT + EXPORT */
+
+# define DH_IMEXPORTABLE_PARAMETERS \
+ OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_P, NULL, 0), \
+ OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_G, NULL, 0)
+# define DH_IMEXPORTABLE_PUBLIC_KEY \
+ OSSL_PARAM_BN(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0)
+# define DH_IMEXPORTABLE_PRIVATE_KEY \
+ OSSL_PARAM_BN(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0)
+static const OSSL_PARAM dh_all_types[] = {
+ DH_IMEXPORTABLE_PARAMETERS,
+ DH_IMEXPORTABLE_PUBLIC_KEY,
+ DH_IMEXPORTABLE_PRIVATE_KEY,
+ OSSL_PARAM_END
+};
+static const OSSL_PARAM dh_parameter_types[] = {
+ DH_IMEXPORTABLE_PARAMETERS,
+ OSSL_PARAM_END
+};
+static const OSSL_PARAM dh_key_types[] = {
+ DH_IMEXPORTABLE_PUBLIC_KEY,
+ DH_IMEXPORTABLE_PRIVATE_KEY,
+ OSSL_PARAM_END
+};
+static const OSSL_PARAM *dh_types[] = {
+ NULL, /* Index 0 = none of them */
+ dh_parameter_types, /* Index 1 = parameter types */
+ dh_key_types, /* Index 2 = key types */
+ dh_all_types /* Index 3 = 1 + 2 */
+};
+
+static const OSSL_PARAM *dh_imexport_types(int selection)
{
- DH *dh;
+ int type_select = 0;
- if ((dh = DH_new()) == NULL
- || !params_to_domparams(dh, params)) {
- DH_free(dh);
- dh = NULL;
- }
- return dh;
+ if ((selection & OSSL_KEYMGMT_SELECT_ALL_PARAMETERS) != 0)
+ type_select += 1;
+ if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
+ type_select += 2;
+ return dh_types[type_select];
}
-static int dh_exportdomparams(void *domparams, OSSL_CALLBACK *param_cb,
- void *cbarg)
+static const OSSL_PARAM *dh_import_types(int selection)
{
- DH *dh = domparams;
- OSSL_PARAM_BLD tmpl;
- OSSL_PARAM *params = NULL;
- int ret;
+ return dh_imexport_types(selection);
+}
- ossl_param_bld_init(&tmpl);
- if (dh == NULL
- || !domparams_to_params(dh, &tmpl)
- || (params = ossl_param_bld_to_param(&tmpl)) == NULL)
+static const OSSL_PARAM *dh_export_types(int selection)
+{
+ return dh_imexport_types(selection);
+}
+
+static ossl_inline int dh_get_params(void *key, OSSL_PARAM params[])
+{
+ DH *dh = key;
+ OSSL_PARAM *p;
+
+ if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
+ && !OSSL_PARAM_set_int(p, DH_bits(dh)))
+ return 0;
+ if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
+ && !OSSL_PARAM_set_int(p, DH_security_bits(dh)))
return 0;
- ret = param_cb(params, cbarg);
- ossl_param_bld_free(params);
- return ret;
+ if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
+ && !OSSL_PARAM_set_int(p, DH_size(dh)))
+ return 0;
+ return 1;
}
-static void *dh_importkey(void *provctx, const OSSL_PARAM params[])
+static const OSSL_PARAM dh_params[] = {
+ OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
+ OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
+ OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
+ OSSL_PARAM_END
+};
+
+static const OSSL_PARAM *dh_gettable_params(void)
{
- DH *dh;
+ return dh_params;
+}
- if ((dh = DH_new()) == NULL
- || !params_to_key(dh, params)) {
- DH_free(dh);
- dh = NULL;
- }
- return dh;
+static int dh_validate_public(DH *dh)
+{
+ const BIGNUM *pub_key = NULL;
+
+ DH_get0_key(dh, &pub_key, NULL);
+ return DH_check_pub_key_ex(dh, pub_key);
}
-static int dh_exportkey(void *key, OSSL_CALLBACK *param_cb, void *cbarg)
+static int dh_validate_private(DH *dh)
{
- DH *dh = key;
- OSSL_PARAM_BLD tmpl;
- OSSL_PARAM *params = NULL;
- int ret;
+ int status = 0;
+ const BIGNUM *priv_key = NULL;
- ossl_param_bld_init(&tmpl);
- if (dh == NULL
- || !key_to_params(dh, &tmpl)
- || (params = ossl_param_bld_to_param(&tmpl)) == NULL)
- return 0;
- ret = param_cb(params, cbarg);
- ossl_param_bld_free(params);
- return ret;
+ DH_get0_key(dh, NULL, &priv_key);
+ return dh_check_priv_key(dh, priv_key, &status);;
+}
+
+static int dh_validate(void *keydata, int selection)
+{
+ DH *dh = keydata;
+ int ok = 0;
+
+ if ((selection & DH_POSSIBLE_SELECTIONS) != 0)
+ ok = 1;
+
+ if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
+ ok = ok && DH_check_params_ex(dh);
+
+ if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
+ ok = ok && dh_validate_public(dh);
+
+ if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
+ ok = ok && dh_validate_private(dh);
+
+ if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR)
+ == OSSL_KEYMGMT_SELECT_KEYPAIR)
+ ok = ok && dh_check_pairwise(dh);
+ return ok;
}
const OSSL_DISPATCH dh_keymgmt_functions[] = {
- /*
- * TODO(3.0) When implementing OSSL_FUNC_KEYMGMT_GENKEY, remember to also
- * implement OSSL_FUNC_KEYMGMT_EXPORTKEY.
- */
- { OSSL_FUNC_KEYMGMT_IMPORTDOMPARAMS, (void (*)(void))dh_importdomparams },
- { OSSL_FUNC_KEYMGMT_EXPORTDOMPARAMS, (void (*)(void))dh_exportdomparams },
- { OSSL_FUNC_KEYMGMT_FREEDOMPARAMS, (void (*)(void))DH_free },
- { OSSL_FUNC_KEYMGMT_IMPORTKEY, (void (*)(void))dh_importkey },
- { OSSL_FUNC_KEYMGMT_EXPORTKEY, (void (*)(void))dh_exportkey },
- { OSSL_FUNC_KEYMGMT_FREEKEY, (void (*)(void))DH_free },
+ { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))dh_newdata },
+ { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))dh_freedata },
+ { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))dh_get_params },
+ { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))dh_gettable_params },
+ { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))dh_has },
+ { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))dh_match },
+ { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))dh_validate },
+ { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))dh_import },
+ { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))dh_import_types },
+ { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))dh_export },
+ { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))dh_export_types },
{ 0, NULL }
};