2 * Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include <openssl/core.h>
13 #include <openssl/core_names.h>
14 #include "internal/cryptlib.h"
15 #include "internal/core.h"
16 #include <openssl/objects.h>
17 #include <openssl/evp.h>
18 #include "crypto/bn.h"
19 #include "crypto/asn1.h"
20 #include "crypto/evp.h"
21 #include "evp_local.h"
23 #if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_EC)
27 /* TODO(3.0) remove when provider SM2 key generation is implemented */
29 # include <openssl/ec.h>
30 # include <openssl/serializer.h>
31 # include "internal/sizes.h"
34 static int gen_init(EVP_PKEY_CTX
*ctx
, int operation
)
41 evp_pkey_ctx_free_old_ops(ctx
);
42 ctx
->operation
= operation
;
44 if (ctx
->keymgmt
== NULL
|| ctx
->keymgmt
->gen_init
== NULL
)
47 /* TODO remove when provider SM2 key generation is implemented */
49 if (ctx
->pmeth
!= NULL
&& ctx
->pmeth
->pkey_id
== EVP_PKEY_SM2
)
54 case EVP_PKEY_OP_PARAMGEN
:
55 ctx
->op
.keymgmt
.genctx
=
56 evp_keymgmt_gen_init(ctx
->keymgmt
,
57 OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
);
59 case EVP_PKEY_OP_KEYGEN
:
60 ctx
->op
.keymgmt
.genctx
=
61 evp_keymgmt_gen_init(ctx
->keymgmt
, OSSL_KEYMGMT_SELECT_KEYPAIR
);
65 if (ctx
->op
.keymgmt
.genctx
== NULL
)
66 ERR_raise(ERR_LIB_EVP
, EVP_R_INITIALIZATION_ERROR
);
75 if (ctx
->pmeth
== NULL
76 || (operation
== EVP_PKEY_OP_PARAMGEN
77 && ctx
->pmeth
->paramgen
== NULL
)
78 || (operation
== EVP_PKEY_OP_KEYGEN
79 && ctx
->pmeth
->keygen
== NULL
))
84 case EVP_PKEY_OP_PARAMGEN
:
85 if (ctx
->pmeth
->paramgen_init
!= NULL
)
86 ret
= ctx
->pmeth
->paramgen_init(ctx
);
88 case EVP_PKEY_OP_KEYGEN
:
89 if (ctx
->pmeth
->keygen_init
!= NULL
)
90 ret
= ctx
->pmeth
->keygen_init(ctx
);
97 ctx
->operation
= EVP_PKEY_OP_UNDEFINED
;
101 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
106 int EVP_PKEY_paramgen_init(EVP_PKEY_CTX
*ctx
)
108 return gen_init(ctx
, EVP_PKEY_OP_PARAMGEN
);
111 int EVP_PKEY_keygen_init(EVP_PKEY_CTX
*ctx
)
113 return gen_init(ctx
, EVP_PKEY_OP_KEYGEN
);
116 static int ossl_callback_to_pkey_gencb(const OSSL_PARAM params
[], void *arg
)
118 EVP_PKEY_CTX
*ctx
= arg
;
119 const OSSL_PARAM
*param
= NULL
;
122 if (ctx
->pkey_gencb
== NULL
)
123 return 1; /* No callback? That's fine */
125 if ((param
= OSSL_PARAM_locate_const(params
, OSSL_GEN_PARAM_POTENTIAL
))
127 || !OSSL_PARAM_get_int(param
, &p
))
129 if ((param
= OSSL_PARAM_locate_const(params
, OSSL_GEN_PARAM_ITERATION
))
131 || !OSSL_PARAM_get_int(param
, &n
))
134 ctx
->keygen_info
[0] = p
;
135 ctx
->keygen_info
[1] = n
;
137 return ctx
->pkey_gencb(ctx
);
140 int EVP_PKEY_gen(EVP_PKEY_CTX
*ctx
, EVP_PKEY
**ppkey
)
144 EVP_PKEY
*allocated_pkey
= NULL
;
152 if ((ctx
->operation
& EVP_PKEY_OP_TYPE_GEN
) == 0)
153 goto not_initialized
;
156 *ppkey
= allocated_pkey
= EVP_PKEY_new();
158 if (*ppkey
== NULL
) {
159 ERR_raise(ERR_LIB_EVP
, ERR_R_MALLOC_FAILURE
);
163 if (ctx
->op
.keymgmt
.genctx
== NULL
)
167 if (ctx
->pkey
!= NULL
) {
168 EVP_KEYMGMT
*tmp_keymgmt
= ctx
->keymgmt
;
170 evp_pkey_export_to_provider(ctx
->pkey
, ctx
->libctx
,
171 &tmp_keymgmt
, ctx
->propquery
);
173 if (tmp_keymgmt
== NULL
)
176 * It's ok if keydata is NULL here. The backend is expected to deal
177 * with that as it sees fit.
179 ret
= evp_keymgmt_gen_set_template(ctx
->keymgmt
,
180 ctx
->op
.keymgmt
.genctx
, keydata
);
184 * the returned value from evp_keymgmt_util_gen() is cached in *ppkey,
185 * so we so not need to save it, just check it.
188 && (evp_keymgmt_util_gen(*ppkey
, ctx
->keymgmt
, ctx
->op
.keymgmt
.genctx
,
189 ossl_callback_to_pkey_gencb
, ctx
)
193 /* In case |*ppkey| was originally a legacy key */
195 evp_pkey_free_legacy(*ppkey
);
198 /* TODO remove when SM2 key have been cleanly separated from EC keys */
201 * Legacy SM2 keys are implemented as EC_KEY with a twist. The legacy
202 * key generation detects the SM2 curve and "magically" changes the pkey
204 * Since we don't have SM2 in the provider implementation, we need to
205 * downgrade the generated provider side key to a legacy one under the
208 * THIS IS AN UGLY BUT TEMPORARY HACK
211 char curve_name
[OSSL_MAX_NAME_SIZE
] = "";
213 if (EVP_PKEY_CTX_get_ec_paramgen_curve_name(ctx
, curve_name
,
214 sizeof(curve_name
)) < 1
215 || strcmp(curve_name
, "SM2") != 0)
219 if (!evp_pkey_downgrade(*ppkey
)
220 || !EVP_PKEY_set_alias_type(*ppkey
, EVP_PKEY_SM2
))
229 if (ctx
->pkey
&& !evp_pkey_downgrade(ctx
->pkey
))
231 switch (ctx
->operation
) {
232 case EVP_PKEY_OP_PARAMGEN
:
233 ret
= ctx
->pmeth
->paramgen(ctx
, *ppkey
);
235 case EVP_PKEY_OP_KEYGEN
:
236 ret
= ctx
->pmeth
->keygen(ctx
, *ppkey
);
245 if (allocated_pkey
!= NULL
)
247 EVP_PKEY_free(allocated_pkey
);
252 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
256 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATON_NOT_INITIALIZED
);
261 ERR_raise(ERR_LIB_EVP
, EVP_R_INACCESSIBLE_DOMAIN_PARAMETERS
);
267 int EVP_PKEY_paramgen(EVP_PKEY_CTX
*ctx
, EVP_PKEY
**ppkey
)
269 if (ctx
->operation
!= EVP_PKEY_OP_PARAMGEN
) {
270 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATON_NOT_INITIALIZED
);
273 return EVP_PKEY_gen(ctx
, ppkey
);
276 int EVP_PKEY_keygen(EVP_PKEY_CTX
*ctx
, EVP_PKEY
**ppkey
)
278 if (ctx
->operation
!= EVP_PKEY_OP_KEYGEN
) {
279 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATON_NOT_INITIALIZED
);
282 return EVP_PKEY_gen(ctx
, ppkey
);
285 void EVP_PKEY_CTX_set_cb(EVP_PKEY_CTX
*ctx
, EVP_PKEY_gen_cb
*cb
)
287 ctx
->pkey_gencb
= cb
;
290 EVP_PKEY_gen_cb
*EVP_PKEY_CTX_get_cb(EVP_PKEY_CTX
*ctx
)
292 return ctx
->pkey_gencb
;
296 * "translation callback" to call EVP_PKEY_CTX callbacks using BN_GENCB style
300 static int trans_cb(int a
, int b
, BN_GENCB
*gcb
)
302 EVP_PKEY_CTX
*ctx
= BN_GENCB_get_arg(gcb
);
303 ctx
->keygen_info
[0] = a
;
304 ctx
->keygen_info
[1] = b
;
305 return ctx
->pkey_gencb(ctx
);
308 void evp_pkey_set_cb_translate(BN_GENCB
*cb
, EVP_PKEY_CTX
*ctx
)
310 BN_GENCB_set(cb
, trans_cb
, ctx
);
313 int EVP_PKEY_CTX_get_keygen_info(EVP_PKEY_CTX
*ctx
, int idx
)
316 return ctx
->keygen_info_count
;
317 if (idx
< 0 || idx
> ctx
->keygen_info_count
)
319 return ctx
->keygen_info
[idx
];
324 EVP_PKEY
*EVP_PKEY_new_mac_key(int type
, ENGINE
*e
,
325 const unsigned char *key
, int keylen
)
327 EVP_PKEY_CTX
*mac_ctx
= NULL
;
328 EVP_PKEY
*mac_key
= NULL
;
329 mac_ctx
= EVP_PKEY_CTX_new_id(type
, e
);
332 if (EVP_PKEY_keygen_init(mac_ctx
) <= 0)
334 if (EVP_PKEY_CTX_set_mac_key(mac_ctx
, key
, keylen
) <= 0)
336 if (EVP_PKEY_keygen(mac_ctx
, &mac_key
) <= 0)
339 EVP_PKEY_CTX_free(mac_ctx
);
343 #endif /* FIPS_MODULE */
345 /*- All methods below can also be used in FIPS_MODULE */
347 static int fromdata_init(EVP_PKEY_CTX
*ctx
, int operation
)
349 if (ctx
== NULL
|| ctx
->keytype
== NULL
)
352 evp_pkey_ctx_free_old_ops(ctx
);
353 if (ctx
->keymgmt
== NULL
)
356 ctx
->operation
= operation
;
360 ctx
->operation
= EVP_PKEY_OP_UNDEFINED
;
361 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
365 int EVP_PKEY_param_fromdata_init(EVP_PKEY_CTX
*ctx
)
367 return fromdata_init(ctx
, EVP_PKEY_OP_PARAMFROMDATA
);
370 int EVP_PKEY_key_fromdata_init(EVP_PKEY_CTX
*ctx
)
372 return fromdata_init(ctx
, EVP_PKEY_OP_KEYFROMDATA
);
375 int EVP_PKEY_fromdata(EVP_PKEY_CTX
*ctx
, EVP_PKEY
**ppkey
, OSSL_PARAM params
[])
377 void *keydata
= NULL
;
380 if (ctx
== NULL
|| (ctx
->operation
& EVP_PKEY_OP_TYPE_FROMDATA
) == 0) {
381 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
389 *ppkey
= EVP_PKEY_new();
391 if (*ppkey
== NULL
) {
392 ERR_raise(ERR_LIB_EVP
, ERR_R_MALLOC_FAILURE
);
396 if (ctx
->operation
== EVP_PKEY_OP_PARAMFROMDATA
)
397 selection
= OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
;
399 selection
= OSSL_KEYMGMT_SELECT_ALL
;
400 keydata
= evp_keymgmt_util_fromdata(*ppkey
, ctx
->keymgmt
, selection
,
405 /* keydata is cached in *ppkey, so we need not bother with it further */
410 * TODO(3.0) Re-evaluate the names, it's possible that we find these to be
413 * EVP_PKEY_param_settable()
414 * EVP_PKEY_param_gettable()
416 const OSSL_PARAM
*EVP_PKEY_param_fromdata_settable(EVP_PKEY_CTX
*ctx
)
418 /* We call fromdata_init to get ctx->keymgmt populated */
419 if (fromdata_init(ctx
, EVP_PKEY_OP_UNDEFINED
))
420 return evp_keymgmt_import_types(ctx
->keymgmt
,
421 OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
);
425 const OSSL_PARAM
*EVP_PKEY_key_fromdata_settable(EVP_PKEY_CTX
*ctx
)
427 /* We call fromdata_init to get ctx->keymgmt populated */
428 if (fromdata_init(ctx
, EVP_PKEY_OP_UNDEFINED
))
429 return evp_keymgmt_import_types(ctx
->keymgmt
,
430 OSSL_KEYMGMT_SELECT_ALL
);