2 * Copyright 2015-2025 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
10 #ifndef OSSL_CRYPTO_EVP_H
11 # define OSSL_CRYPTO_EVP_H
14 # include <openssl/evp.h>
15 # include <openssl/core_dispatch.h>
16 # include "internal/refcount.h"
17 # include "crypto/ecx.h"
20 * Default PKCS5 PBE KDF salt lengths
21 * In RFC 8018, PBE1 uses 8 bytes (64 bits) for its salt length.
22 * It also specifies to use at least 8 bytes for PBES2.
23 * The NIST requirement for PBKDF2 is 128 bits so we use this as the
24 * default for PBE2 (scrypt and HKDF2)
26 # define PKCS5_DEFAULT_PBE1_SALT_LEN PKCS5_SALT_LEN
27 # define PKCS5_DEFAULT_PBE2_SALT_LEN 16
29 * Don't free up md_ctx->pctx in EVP_MD_CTX_reset, use the reserved flag
32 #define EVP_MD_CTX_FLAG_KEEP_PKEY_CTX 0x0400
33 #define EVP_MD_CTX_FLAG_FINALISED 0x0800
35 #define evp_pkey_ctx_is_legacy(ctx) \
36 ((ctx)->keymgmt == NULL)
37 #define evp_pkey_ctx_is_provided(ctx) \
38 (!evp_pkey_ctx_is_legacy(ctx))
40 struct evp_pkey_ctx_st
{
41 /* Actual operation */
45 * Library context, property query, keytype and keymgmt associated with
51 /* If |pkey| below is set, this field is always a reference to its keymgmt */
60 EVP_KEYEXCH
*exchange
;
62 * Opaque ctx returned from a providers exchange algorithm
63 * implementation OSSL_FUNC_keyexch_newctx()
69 EVP_SIGNATURE
*signature
;
71 * Opaque ctx returned from a providers signature algorithm
72 * implementation OSSL_FUNC_signature_newctx()
78 EVP_ASYM_CIPHER
*cipher
;
80 * Opaque ctx returned from a providers asymmetric cipher algorithm
81 * implementation OSSL_FUNC_asym_cipher_newctx()
88 * Opaque ctx returned from a providers KEM algorithm
89 * implementation OSSL_FUNC_kem_newctx()
96 * Cached parameters. Inits of operations that depend on these should
97 * call evp_pkey_ctx_use_delayed_data() when the operation has been set
101 /* Distinguishing Identifier, ISO/IEC 15946-3, FIPS 196 */
102 char *dist_id_name
; /* The name used with EVP_PKEY_CTX_ctrl_str() */
103 void *dist_id
; /* The distinguishing ID itself */
104 size_t dist_id_len
; /* The length of the distinguishing ID */
106 /* Indicators of what has been set. Keep them together! */
107 unsigned int dist_id_set
: 1;
110 /* Application specific data, usually used by the callback */
112 /* Keygen callback */
113 EVP_PKEY_gen_cb
*pkey_gencb
;
114 /* implementation specific keygen data */
116 int keygen_info_count
;
118 /* Legacy fields below */
120 /* EVP_PKEY identity */
122 /* Method associated with this operation */
123 const EVP_PKEY_METHOD
*pmeth
;
124 /* Engine that implements this method or NULL if builtin */
126 /* Key: may be NULL */
128 /* Peer key for key agreement, may be NULL */
130 /* Algorithm specific data */
132 /* Indicator if digest_custom needs to be called */
133 unsigned int flag_call_digest_custom
:1;
135 * Used to support taking custody of memory in the case of a provider being
136 * used with the deprecated EVP_PKEY_CTX_set_rsa_keygen_pubexp() API. This
137 * member should NOT be used for any other purpose and should be removed
138 * when said deprecated API is excised completely.
141 } /* EVP_PKEY_CTX */ ;
143 #define EVP_PKEY_FLAG_DYNAMIC 1
145 struct evp_pkey_method_st
{
148 int (*init
) (EVP_PKEY_CTX
*ctx
);
149 int (*copy
) (EVP_PKEY_CTX
*dst
, const EVP_PKEY_CTX
*src
);
150 void (*cleanup
) (EVP_PKEY_CTX
*ctx
);
151 int (*paramgen_init
) (EVP_PKEY_CTX
*ctx
);
152 int (*paramgen
) (EVP_PKEY_CTX
*ctx
, EVP_PKEY
*pkey
);
153 int (*keygen_init
) (EVP_PKEY_CTX
*ctx
);
154 int (*keygen
) (EVP_PKEY_CTX
*ctx
, EVP_PKEY
*pkey
);
155 int (*sign_init
) (EVP_PKEY_CTX
*ctx
);
156 int (*sign
) (EVP_PKEY_CTX
*ctx
, unsigned char *sig
, size_t *siglen
,
157 const unsigned char *tbs
, size_t tbslen
);
158 int (*verify_init
) (EVP_PKEY_CTX
*ctx
);
159 int (*verify
) (EVP_PKEY_CTX
*ctx
,
160 const unsigned char *sig
, size_t siglen
,
161 const unsigned char *tbs
, size_t tbslen
);
162 int (*verify_recover_init
) (EVP_PKEY_CTX
*ctx
);
163 int (*verify_recover
) (EVP_PKEY_CTX
*ctx
,
164 unsigned char *rout
, size_t *routlen
,
165 const unsigned char *sig
, size_t siglen
);
166 int (*signctx_init
) (EVP_PKEY_CTX
*ctx
, EVP_MD_CTX
*mctx
);
167 int (*signctx
) (EVP_PKEY_CTX
*ctx
, unsigned char *sig
, size_t *siglen
,
169 int (*verifyctx_init
) (EVP_PKEY_CTX
*ctx
, EVP_MD_CTX
*mctx
);
170 int (*verifyctx
) (EVP_PKEY_CTX
*ctx
, const unsigned char *sig
, int siglen
,
172 int (*encrypt_init
) (EVP_PKEY_CTX
*ctx
);
173 int (*encrypt
) (EVP_PKEY_CTX
*ctx
, unsigned char *out
, size_t *outlen
,
174 const unsigned char *in
, size_t inlen
);
175 int (*decrypt_init
) (EVP_PKEY_CTX
*ctx
);
176 int (*decrypt
) (EVP_PKEY_CTX
*ctx
, unsigned char *out
, size_t *outlen
,
177 const unsigned char *in
, size_t inlen
);
178 int (*derive_init
) (EVP_PKEY_CTX
*ctx
);
179 int (*derive
) (EVP_PKEY_CTX
*ctx
, unsigned char *key
, size_t *keylen
);
180 int (*ctrl
) (EVP_PKEY_CTX
*ctx
, int type
, int p1
, void *p2
);
181 int (*ctrl_str
) (EVP_PKEY_CTX
*ctx
, const char *type
, const char *value
);
182 int (*digestsign
) (EVP_MD_CTX
*ctx
, unsigned char *sig
, size_t *siglen
,
183 const unsigned char *tbs
, size_t tbslen
);
184 int (*digestverify
) (EVP_MD_CTX
*ctx
, const unsigned char *sig
,
185 size_t siglen
, const unsigned char *tbs
,
187 int (*check
) (EVP_PKEY
*pkey
);
188 int (*public_check
) (EVP_PKEY
*pkey
);
189 int (*param_check
) (EVP_PKEY
*pkey
);
191 int (*digest_custom
) (EVP_PKEY_CTX
*ctx
, EVP_MD_CTX
*mctx
);
192 } /* EVP_PKEY_METHOD */ ;
194 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD
)
196 void evp_pkey_set_cb_translate(BN_GENCB
*cb
, EVP_PKEY_CTX
*ctx
);
198 const EVP_PKEY_METHOD
*ossl_dh_pkey_method(void);
199 const EVP_PKEY_METHOD
*ossl_dhx_pkey_method(void);
200 const EVP_PKEY_METHOD
*ossl_dsa_pkey_method(void);
201 const EVP_PKEY_METHOD
*ossl_ec_pkey_method(void);
202 const EVP_PKEY_METHOD
*ossl_ecx25519_pkey_method(void);
203 const EVP_PKEY_METHOD
*ossl_ecx448_pkey_method(void);
204 const EVP_PKEY_METHOD
*ossl_ed25519_pkey_method(void);
205 const EVP_PKEY_METHOD
*ossl_ed448_pkey_method(void);
206 const EVP_PKEY_METHOD
*ossl_rsa_pkey_method(void);
207 const EVP_PKEY_METHOD
*ossl_rsa_pss_pkey_method(void);
213 const char *description
;
215 CRYPTO_REF_COUNT refcnt
;
217 OSSL_FUNC_mac_newctx_fn
*newctx
;
218 OSSL_FUNC_mac_dupctx_fn
*dupctx
;
219 OSSL_FUNC_mac_freectx_fn
*freectx
;
220 OSSL_FUNC_mac_init_fn
*init
;
221 OSSL_FUNC_mac_update_fn
*update
;
222 OSSL_FUNC_mac_final_fn
*final
;
223 OSSL_FUNC_mac_gettable_params_fn
*gettable_params
;
224 OSSL_FUNC_mac_gettable_ctx_params_fn
*gettable_ctx_params
;
225 OSSL_FUNC_mac_settable_ctx_params_fn
*settable_ctx_params
;
226 OSSL_FUNC_mac_get_params_fn
*get_params
;
227 OSSL_FUNC_mac_get_ctx_params_fn
*get_ctx_params
;
228 OSSL_FUNC_mac_set_ctx_params_fn
*set_ctx_params
;
229 OSSL_FUNC_mac_init_skey_fn
*init_skey
;
236 const char *description
;
237 CRYPTO_REF_COUNT refcnt
;
239 OSSL_FUNC_kdf_newctx_fn
*newctx
;
240 OSSL_FUNC_kdf_dupctx_fn
*dupctx
;
241 OSSL_FUNC_kdf_freectx_fn
*freectx
;
242 OSSL_FUNC_kdf_reset_fn
*reset
;
243 OSSL_FUNC_kdf_derive_fn
*derive
;
244 OSSL_FUNC_kdf_gettable_params_fn
*gettable_params
;
245 OSSL_FUNC_kdf_gettable_ctx_params_fn
*gettable_ctx_params
;
246 OSSL_FUNC_kdf_settable_ctx_params_fn
*settable_ctx_params
;
247 OSSL_FUNC_kdf_get_params_fn
*get_params
;
248 OSSL_FUNC_kdf_get_ctx_params_fn
*get_ctx_params
;
249 OSSL_FUNC_kdf_set_ctx_params_fn
*set_ctx_params
;
250 OSSL_FUNC_kdf_set_skey_fn
*set_skey
;
251 OSSL_FUNC_kdf_derive_skey_fn
*derive_skey
;
254 #define EVP_ORIG_DYNAMIC 0
255 #define EVP_ORIG_GLOBAL 1
256 #define EVP_ORIG_METH 2
262 /* Legacy structure members */
267 int (*init
) (EVP_MD_CTX
*ctx
);
268 int (*update
) (EVP_MD_CTX
*ctx
, const void *data
, size_t count
);
269 int (*final
) (EVP_MD_CTX
*ctx
, unsigned char *md
);
270 int (*copy
) (EVP_MD_CTX
*to
, const EVP_MD_CTX
*from
);
271 int (*cleanup
) (EVP_MD_CTX
*ctx
);
273 int ctx_size
; /* how big does the ctx->md_data need to be */
274 /* control function */
275 int (*md_ctrl
) (EVP_MD_CTX
*ctx
, int cmd
, int p1
, void *p2
);
277 /* New structure members */
278 /* Above comment to be removed when legacy has gone */
281 const char *description
;
283 CRYPTO_REF_COUNT refcnt
;
284 OSSL_FUNC_digest_newctx_fn
*newctx
;
285 OSSL_FUNC_digest_init_fn
*dinit
;
286 OSSL_FUNC_digest_update_fn
*dupdate
;
287 OSSL_FUNC_digest_final_fn
*dfinal
;
288 OSSL_FUNC_digest_squeeze_fn
*dsqueeze
;
289 OSSL_FUNC_digest_digest_fn
*digest
;
290 OSSL_FUNC_digest_freectx_fn
*freectx
;
291 OSSL_FUNC_digest_copyctx_fn
*copyctx
;
292 OSSL_FUNC_digest_dupctx_fn
*dupctx
;
293 OSSL_FUNC_digest_get_params_fn
*get_params
;
294 OSSL_FUNC_digest_set_ctx_params_fn
*set_ctx_params
;
295 OSSL_FUNC_digest_get_ctx_params_fn
*get_ctx_params
;
296 OSSL_FUNC_digest_gettable_params_fn
*gettable_params
;
297 OSSL_FUNC_digest_settable_ctx_params_fn
*settable_ctx_params
;
298 OSSL_FUNC_digest_gettable_ctx_params_fn
*gettable_ctx_params
;
302 struct evp_cipher_st
{
306 /* Default value for variable length ciphers */
310 /* Legacy structure members */
313 /* How the EVP_CIPHER was created. */
316 int (*init
) (EVP_CIPHER_CTX
*ctx
, const unsigned char *key
,
317 const unsigned char *iv
, int enc
);
318 /* encrypt/decrypt data */
319 int (*do_cipher
) (EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
320 const unsigned char *in
, size_t inl
);
322 int (*cleanup
) (EVP_CIPHER_CTX
*);
323 /* how big ctx->cipher_data needs to be */
325 /* Populate a ASN1_TYPE with parameters */
326 int (*set_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
327 /* Get parameters from a ASN1_TYPE */
328 int (*get_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
329 /* Miscellaneous operations */
330 int (*ctrl
) (EVP_CIPHER_CTX
*, int type
, int arg
, void *ptr
);
331 /* Application data */
334 /* New structure members */
335 /* Above comment to be removed when legacy has gone */
338 const char *description
;
340 CRYPTO_REF_COUNT refcnt
;
341 OSSL_FUNC_cipher_newctx_fn
*newctx
;
342 OSSL_FUNC_cipher_encrypt_init_fn
*einit
;
343 OSSL_FUNC_cipher_decrypt_init_fn
*dinit
;
344 OSSL_FUNC_cipher_update_fn
*cupdate
;
345 OSSL_FUNC_cipher_final_fn
*cfinal
;
346 OSSL_FUNC_cipher_cipher_fn
*ccipher
;
347 OSSL_FUNC_cipher_pipeline_encrypt_init_fn
*p_einit
;
348 OSSL_FUNC_cipher_pipeline_decrypt_init_fn
*p_dinit
;
349 OSSL_FUNC_cipher_pipeline_update_fn
*p_cupdate
;
350 OSSL_FUNC_cipher_pipeline_final_fn
*p_cfinal
;
351 OSSL_FUNC_cipher_freectx_fn
*freectx
;
352 OSSL_FUNC_cipher_dupctx_fn
*dupctx
;
353 OSSL_FUNC_cipher_get_params_fn
*get_params
;
354 OSSL_FUNC_cipher_get_ctx_params_fn
*get_ctx_params
;
355 OSSL_FUNC_cipher_set_ctx_params_fn
*set_ctx_params
;
356 OSSL_FUNC_cipher_gettable_params_fn
*gettable_params
;
357 OSSL_FUNC_cipher_gettable_ctx_params_fn
*gettable_ctx_params
;
358 OSSL_FUNC_cipher_settable_ctx_params_fn
*settable_ctx_params
;
359 OSSL_FUNC_cipher_encrypt_skey_init_fn
*einit_skey
;
360 OSSL_FUNC_cipher_decrypt_skey_init_fn
*dinit_skey
;
363 /* Macros to code block cipher wrappers */
365 /* Wrapper functions for each cipher mode */
367 #define EVP_C_DATA(kstruct, ctx) \
368 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
370 #define BLOCK_CIPHER_ecb_loop() \
372 bl = EVP_CIPHER_CTX_get0_cipher(ctx)->block_size; \
373 if (inl < bl) return 1;\
375 for (i=0; i <= inl; i+=bl)
377 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
378 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
380 BLOCK_CIPHER_ecb_loop() \
381 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_is_encrypting(ctx)); \
385 #define EVP_MAXCHUNK ((size_t)1 << 30)
387 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
388 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
390 while(inl>=EVP_MAXCHUNK) {\
391 int num = EVP_CIPHER_CTX_get_num(ctx);\
392 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
393 EVP_CIPHER_CTX_set_num(ctx, num);\
399 int num = EVP_CIPHER_CTX_get_num(ctx);\
400 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
401 EVP_CIPHER_CTX_set_num(ctx, num);\
406 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
407 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
409 while(inl>=EVP_MAXCHUNK) {\
410 cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
416 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
420 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
421 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
423 size_t chunk = EVP_MAXCHUNK;\
424 if (cbits == 1) chunk >>= 3;\
425 if (inl < chunk) chunk = inl;\
426 while (inl && inl >= chunk) {\
427 int num = EVP_CIPHER_CTX_get_num(ctx);\
428 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
430 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
431 ? chunk*8 : chunk), \
432 &EVP_C_DATA(kstruct, ctx)->ksched, ctx->iv,\
433 &num, EVP_CIPHER_CTX_is_encrypting(ctx));\
434 EVP_CIPHER_CTX_set_num(ctx, num);\
438 if (inl < chunk) chunk = inl;\
443 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
444 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
445 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
446 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
447 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
449 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
450 key_len, iv_len, flags, init_key, cleanup, \
451 set_asn1, get_asn1, ctrl) \
452 static const EVP_CIPHER cname##_##mode = { \
453 nid##_##nmode, block_size, key_len, iv_len, \
454 flags | EVP_CIPH_##MODE##_MODE, \
457 cname##_##mode##_cipher, \
464 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
466 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
467 iv_len, flags, init_key, cleanup, set_asn1, \
469 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
470 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
472 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
473 iv_len, cbits, flags, init_key, cleanup, \
474 set_asn1, get_asn1, ctrl) \
475 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
476 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
479 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
480 iv_len, cbits, flags, init_key, cleanup, \
481 set_asn1, get_asn1, ctrl) \
482 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
483 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
486 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
487 flags, init_key, cleanup, set_asn1, \
489 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
490 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
492 #define BLOCK_CIPHER_defs(cname, kstruct, \
493 nid, block_size, key_len, iv_len, cbits, flags, \
494 init_key, cleanup, set_asn1, get_asn1, ctrl) \
495 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
496 init_key, cleanup, set_asn1, get_asn1, ctrl) \
497 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
498 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
499 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
500 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
501 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
502 init_key, cleanup, set_asn1, get_asn1, ctrl)
505 #define BLOCK_CIPHER_defs(cname, kstruct, \
506 nid, block_size, key_len, iv_len, flags,\
507 init_key, cleanup, set_asn1, get_asn1, ctrl)\
508 static const EVP_CIPHER cname##_cbc = {\
509 nid##_cbc, block_size, key_len, iv_len, \
510 flags | EVP_CIPH_CBC_MODE,\
515 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
516 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
521 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
522 static const EVP_CIPHER cname##_cfb = {\
523 nid##_cfb64, 1, key_len, iv_len, \
524 flags | EVP_CIPH_CFB_MODE,\
529 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
530 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
535 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
536 static const EVP_CIPHER cname##_ofb = {\
537 nid##_ofb64, 1, key_len, iv_len, \
538 flags | EVP_CIPH_OFB_MODE,\
543 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
544 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
549 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
550 static const EVP_CIPHER cname##_ecb = {\
551 nid##_ecb, block_size, key_len, iv_len, \
552 flags | EVP_CIPH_ECB_MODE,\
557 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
558 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
563 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
566 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
567 block_size, key_len, iv_len, cbits, \
569 cleanup, set_asn1, get_asn1, ctrl) \
570 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
571 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
572 cbits, flags, init_key, cleanup, set_asn1, \
575 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
576 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
577 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
578 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
579 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
580 cipher##_init_key, NULL, NULL, NULL, NULL)
583 unsigned char iv
[EVP_MAX_IV_LENGTH
];
585 unsigned int tag_len
;
586 } evp_cipher_aead_asn1_params
;
588 int evp_cipher_param_to_asn1_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
589 evp_cipher_aead_asn1_params
*params
);
591 int evp_cipher_asn1_to_param_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
592 evp_cipher_aead_asn1_params
*params
);
595 * To support transparent execution of operation in backends other
596 * than the "origin" key, we support transparent export/import to
597 * those providers, and maintain a cache of the imported keydata,
598 * so we don't need to redo the export/import every time we perform
599 * the same operation in that same provider.
600 * This requires that the "origin" backend (whether it's a legacy or a
601 * provider "origin") implements exports, and that the target provider
602 * has an EVP_KEYMGMT that implements import.
605 EVP_KEYMGMT
*keymgmt
;
610 DEFINE_STACK_OF(OP_CACHE_ELEM
)
613 * An EVP_PKEY can have the following states:
617 * type == EVP_PKEY_NONE && keymgmt == NULL
621 * (type != EVP_PKEY_NONE && pkey.ptr == NULL) ## legacy (libcrypto only)
622 * || (keymgmt != NULL && keydata == NULL) ## provider side
626 * (type != EVP_PKEY_NONE && pkey.ptr != NULL) ## legacy (libcrypto only)
627 * || (keymgmt != NULL && keydata != NULL) ## provider side
629 * The easiest way to detect a legacy key is:
631 * keymgmt == NULL && type != EVP_PKEY_NONE
633 * The easiest way to detect a provider side key is:
637 #define evp_pkey_is_blank(pk) \
638 ((pk)->type == EVP_PKEY_NONE && (pk)->keymgmt == NULL)
639 #define evp_pkey_is_typed(pk) \
640 ((pk)->type != EVP_PKEY_NONE || (pk)->keymgmt != NULL)
642 # define evp_pkey_is_assigned(pk) \
643 ((pk)->pkey.ptr != NULL || (pk)->keydata != NULL)
645 # define evp_pkey_is_assigned(pk) \
646 ((pk)->keydata != NULL)
648 #define evp_pkey_is_legacy(pk) \
649 ((pk)->type != EVP_PKEY_NONE && (pk)->keymgmt == NULL)
650 #define evp_pkey_is_provided(pk) \
651 ((pk)->keymgmt != NULL)
653 union legacy_pkey_st
{
655 struct rsa_st
*rsa
; /* RSA */
656 # ifndef OPENSSL_NO_DSA
657 struct dsa_st
*dsa
; /* DSA */
659 # ifndef OPENSSL_NO_DH
660 struct dh_st
*dh
; /* DH */
662 # ifndef OPENSSL_NO_EC
663 struct ec_key_st
*ec
; /* ECC */
664 # ifndef OPENSSL_NO_ECX
665 ECX_KEY
*ecx
; /* X25519, X448, Ed25519, Ed448 */
671 /* == Legacy attributes == */
677 * Legacy key "origin" is composed of a pointer to an EVP_PKEY_ASN1_METHOD,
678 * a pointer to a low level key and possibly a pointer to an engine.
680 const EVP_PKEY_ASN1_METHOD
*ameth
;
682 ENGINE
*pmeth_engine
; /* If not NULL public key ENGINE to use */
684 /* Union to store the reference to an origin legacy key */
685 union legacy_pkey_st pkey
;
687 /* Union to store the reference to a non-origin legacy key */
688 union legacy_pkey_st legacy_cache_pkey
;
691 /* == Common attributes == */
692 CRYPTO_REF_COUNT references
;
695 STACK_OF(X509_ATTRIBUTE
) *attributes
; /* [ 0 ] */
697 unsigned int foreign
:1; /* the low-level key is using an engine or an app-method */
698 CRYPTO_EX_DATA ex_data
;
701 /* == Provider attributes == */
704 * Provider keydata "origin" is composed of a pointer to an EVP_KEYMGMT
705 * and a pointer to the provider side key data. This is never used at
706 * the same time as the legacy key data above.
708 EVP_KEYMGMT
*keymgmt
;
711 * If any libcrypto code does anything that may modify the keydata
712 * contents, this dirty counter must be incremented.
717 * To support transparent execution of operation in backends other
718 * than the "origin" key, we support transparent export/import to
719 * those providers, and maintain a cache of the imported keydata,
720 * so we don't need to redo the export/import every time we perform
721 * the same operation in that same provider.
723 STACK_OF(OP_CACHE_ELEM
) *operation_cache
;
726 * We keep a copy of that "origin"'s dirty count, so we know if the
727 * operation cache needs flushing.
729 size_t dirty_cnt_copy
;
731 /* Cache of key object information */
735 int security_category
;
740 /* The EVP_PKEY_OP_TYPE_ macros are found in include/openssl/evp.h */
742 # define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
743 (((ctx)->operation & EVP_PKEY_OP_TYPE_SIG) != 0)
745 # define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
746 (((ctx)->operation & EVP_PKEY_OP_TYPE_DERIVE) != 0)
748 # define EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx) \
749 (((ctx)->operation & EVP_PKEY_OP_TYPE_CRYPT) != 0)
751 # define EVP_PKEY_CTX_IS_GEN_OP(ctx) \
752 (((ctx)->operation & EVP_PKEY_OP_TYPE_GEN) != 0)
754 # define EVP_PKEY_CTX_IS_FROMDATA_OP(ctx) \
755 (((ctx)->operation & EVP_PKEY_OP_TYPE_DATA) != 0)
757 # define EVP_PKEY_CTX_IS_KEM_OP(ctx) \
758 (((ctx)->operation & EVP_PKEY_OP_TYPE_KEM) != 0)
761 /* == Common attributes == */
762 CRYPTO_REF_COUNT references
;
765 void *keydata
; /* Alg-specific key data */
766 EVP_SKEYMGMT
*skeymgmt
; /* Import, export, manage */
769 void openssl_add_all_ciphers_int(void);
770 void openssl_add_all_digests_int(void);
771 void evp_cleanup_int(void);
772 void evp_app_cleanup_int(void);
773 void *evp_pkey_export_to_provider(EVP_PKEY
*pk
, OSSL_LIB_CTX
*libctx
,
774 EVP_KEYMGMT
**keymgmt
,
775 const char *propquery
);
777 int evp_pkey_copy_downgraded(EVP_PKEY
**dest
, const EVP_PKEY
*src
);
778 void *evp_pkey_get_legacy(EVP_PKEY
*pk
);
779 void evp_pkey_free_legacy(EVP_PKEY
*x
);
780 EVP_PKEY
*evp_pkcs82pkey_legacy(const PKCS8_PRIV_KEY_INFO
*p8inf
,
781 OSSL_LIB_CTX
*libctx
, const char *propq
);
785 * KEYMGMT utility functions
789 * Key import structure and helper function, to be used as an export callback
791 struct evp_keymgmt_util_try_import_data_st
{
792 EVP_KEYMGMT
*keymgmt
;
797 int evp_keymgmt_util_try_import(const OSSL_PARAM params
[], void *arg
);
798 int evp_keymgmt_util_assign_pkey(EVP_PKEY
*pkey
, EVP_KEYMGMT
*keymgmt
,
800 EVP_PKEY
*evp_keymgmt_util_make_pkey(EVP_KEYMGMT
*keymgmt
, void *keydata
);
802 int evp_keymgmt_util_export(const EVP_PKEY
*pk
, int selection
,
803 OSSL_CALLBACK
*export_cb
, void *export_cbarg
);
804 void *evp_keymgmt_util_export_to_provider(EVP_PKEY
*pk
, EVP_KEYMGMT
*keymgmt
,
806 OP_CACHE_ELEM
*evp_keymgmt_util_find_operation_cache(EVP_PKEY
*pk
,
807 EVP_KEYMGMT
*keymgmt
,
809 int evp_keymgmt_util_clear_operation_cache(EVP_PKEY
*pk
);
810 int evp_keymgmt_util_cache_keydata(EVP_PKEY
*pk
, EVP_KEYMGMT
*keymgmt
,
811 void *keydata
, int selection
);
812 void evp_keymgmt_util_cache_keyinfo(EVP_PKEY
*pk
);
813 void *evp_keymgmt_util_fromdata(EVP_PKEY
*target
, EVP_KEYMGMT
*keymgmt
,
814 int selection
, const OSSL_PARAM params
[]);
815 int evp_keymgmt_util_has(EVP_PKEY
*pk
, int selection
);
816 int evp_keymgmt_util_match(EVP_PKEY
*pk1
, EVP_PKEY
*pk2
, int selection
);
817 int evp_keymgmt_util_copy(EVP_PKEY
*to
, EVP_PKEY
*from
, int selection
);
818 void *evp_keymgmt_util_gen(EVP_PKEY
*target
, EVP_KEYMGMT
*keymgmt
,
819 void *genctx
, OSSL_CALLBACK
*cb
, void *cbarg
);
820 int evp_keymgmt_util_get_deflt_digest_name(EVP_KEYMGMT
*keymgmt
,
822 char *mdname
, size_t mdname_sz
);
823 const char *evp_keymgmt_util_query_operation_name(EVP_KEYMGMT
*keymgmt
,
827 * KEYMGMT provider interface functions
829 void *evp_keymgmt_newdata(const EVP_KEYMGMT
*keymgmt
);
830 void evp_keymgmt_freedata(const EVP_KEYMGMT
*keymgmt
, void *keyddata
);
831 int evp_keymgmt_get_params(const EVP_KEYMGMT
*keymgmt
,
832 void *keydata
, OSSL_PARAM params
[]);
833 int evp_keymgmt_set_params(const EVP_KEYMGMT
*keymgmt
,
834 void *keydata
, const OSSL_PARAM params
[]);
835 void *evp_keymgmt_gen_init(const EVP_KEYMGMT
*keymgmt
, int selection
,
836 const OSSL_PARAM params
[]);
837 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
839 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
840 const OSSL_PARAM params
[]);
841 int evp_keymgmt_gen_get_params(const EVP_KEYMGMT
*keymgmt
,
842 void *genctx
, OSSL_PARAM params
[]);
843 void *evp_keymgmt_gen(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
844 OSSL_CALLBACK
*cb
, void *cbarg
);
845 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT
*keymgmt
, void *genctx
);
847 int evp_keymgmt_has_load(const EVP_KEYMGMT
*keymgmt
);
848 void *evp_keymgmt_load(const EVP_KEYMGMT
*keymgmt
,
849 const void *objref
, size_t objref_sz
);
851 int evp_keymgmt_has(const EVP_KEYMGMT
*keymgmt
, void *keyddata
, int selection
);
852 int evp_keymgmt_validate(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
853 int selection
, int checktype
);
854 int evp_keymgmt_match(const EVP_KEYMGMT
*keymgmt
,
855 const void *keydata1
, const void *keydata2
,
858 int evp_keymgmt_import(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
859 int selection
, const OSSL_PARAM params
[]);
860 const OSSL_PARAM
*evp_keymgmt_import_types(const EVP_KEYMGMT
*keymgmt
,
862 int evp_keymgmt_export(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
863 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
);
864 const OSSL_PARAM
*evp_keymgmt_export_types(const EVP_KEYMGMT
*keymgmt
,
866 void *evp_keymgmt_dup(const EVP_KEYMGMT
*keymgmt
,
867 const void *keydata_from
, int selection
);
868 EVP_KEYMGMT
*evp_keymgmt_fetch_from_prov(OSSL_PROVIDER
*prov
,
870 const char *properties
);
873 * SKEYMGMT provider interface functions
875 EVP_SKEY
*evp_skey_alloc(EVP_SKEYMGMT
*skeymgmt
);
876 void evp_skeymgmt_freedata(const EVP_SKEYMGMT
*keymgmt
, void *keyddata
);
877 void *evp_skeymgmt_import(const EVP_SKEYMGMT
*skeymgmt
, int selection
, const OSSL_PARAM params
[]);
878 int evp_skeymgmt_export(const EVP_SKEYMGMT
*skeymgmt
, void *keydata
,
879 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
);
880 void *evp_skeymgmt_generate(const EVP_SKEYMGMT
*skeymgmt
, const OSSL_PARAM params
[]);
881 EVP_SKEYMGMT
*evp_skeymgmt_fetch_from_prov(OSSL_PROVIDER
*prov
,
883 const char *properties
);
885 /* Pulling defines out of C source files */
887 # define EVP_RC4_KEY_SIZE 16
888 # ifndef TLS1_1_VERSION
889 # define TLS1_1_VERSION 0x0302
892 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX
*ctx
, unsigned int flags
);
894 /* EVP_ENCODE_CTX flags */
895 /* Don't generate new lines when encoding */
896 #define EVP_ENCODE_CTX_NO_NEWLINES 1
897 /* Use the SRP base64 alphabet instead of the standard one */
898 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2
900 const EVP_CIPHER
*evp_get_cipherbyname_ex(OSSL_LIB_CTX
*libctx
,
902 const EVP_MD
*evp_get_digestbyname_ex(OSSL_LIB_CTX
*libctx
,
905 int ossl_pkcs5_pbkdf2_hmac_ex(const char *pass
, int passlen
,
906 const unsigned char *salt
, int saltlen
, int iter
,
907 const EVP_MD
*digest
, int keylen
,
909 OSSL_LIB_CTX
*libctx
, const char *propq
);
913 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
915 * Return 1 on success, 0 or negative for errors.
917 * In particular they return -2 if any of the params is not supported.
919 * They are not available in FIPS_MODULE as they depend on
920 * - EVP_PKEY_CTX_{get,set}_params()
921 * - EVP_PKEY_CTX_{gettable,settable}_params()
924 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
925 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
927 EVP_MD_CTX
*evp_md_ctx_new_ex(EVP_PKEY
*pkey
, const ASN1_OCTET_STRING
*id
,
928 OSSL_LIB_CTX
*libctx
, const char *propq
);
929 int evp_pkey_name2type(const char *name
);
930 const char *evp_pkey_type2name(int type
);
932 int evp_pkey_ctx_use_cached_data(EVP_PKEY_CTX
*ctx
);
933 # endif /* !defined(FIPS_MODULE) */
935 int evp_method_store_cache_flush(OSSL_LIB_CTX
*libctx
);
936 int evp_method_store_remove_all_provided(const OSSL_PROVIDER
*prov
);
938 int evp_default_properties_enable_fips_int(OSSL_LIB_CTX
*libctx
, int enable
,
940 int evp_set_default_properties_int(OSSL_LIB_CTX
*libctx
, const char *propq
,
941 int loadconfig
, int mirrored
);
942 char *evp_get_global_properties_str(OSSL_LIB_CTX
*libctx
, int loadconfig
);
944 void evp_md_ctx_clear_digest(EVP_MD_CTX
*ctx
, int force
, int keep_digest
);
945 /* just free the algctx if set, returns 0 on inconsistent state of ctx */
946 int evp_md_ctx_free_algctx(EVP_MD_CTX
*ctx
);
948 /* Three possible states: */
949 # define EVP_PKEY_STATE_UNKNOWN 0
950 # define EVP_PKEY_STATE_LEGACY 1
951 # define EVP_PKEY_STATE_PROVIDER 2
952 int evp_pkey_ctx_state(const EVP_PKEY_CTX
*ctx
);
954 /* These two must ONLY be called for provider side operations */
955 int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX
*ctx
,
956 int keytype
, int optype
,
957 int cmd
, int p1
, void *p2
);
958 int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX
*ctx
,
959 const char *name
, const char *value
);
961 /* These two must ONLY be called for legacy operations */
962 int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX
*ctx
, const OSSL_PARAM
*params
);
963 int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
965 /* This must ONLY be called for legacy EVP_PKEYs */
966 int evp_pkey_get_params_to_ctrl(const EVP_PKEY
*pkey
, OSSL_PARAM
*params
);
968 /* Same as the public get0 functions but are not const */
969 # ifndef OPENSSL_NO_DEPRECATED_3_0
970 DH
*evp_pkey_get0_DH_int(const EVP_PKEY
*pkey
);
971 EC_KEY
*evp_pkey_get0_EC_KEY_int(const EVP_PKEY
*pkey
);
972 RSA
*evp_pkey_get0_RSA_int(const EVP_PKEY
*pkey
);
975 /* Get internal identification number routines */
976 int evp_asym_cipher_get_number(const EVP_ASYM_CIPHER
*cipher
);
977 int evp_cipher_get_number(const EVP_CIPHER
*cipher
);
978 int evp_kdf_get_number(const EVP_KDF
*kdf
);
979 int evp_kem_get_number(const EVP_KEM
*wrap
);
980 int evp_keyexch_get_number(const EVP_KEYEXCH
*keyexch
);
981 int evp_keymgmt_get_number(const EVP_KEYMGMT
*keymgmt
);
982 int evp_keymgmt_get_legacy_alg(const EVP_KEYMGMT
*keymgmt
);
983 int evp_mac_get_number(const EVP_MAC
*mac
);
984 int evp_md_get_number(const EVP_MD
*md
);
985 int evp_rand_get_number(const EVP_RAND
*rand
);
986 int evp_rand_can_seed(EVP_RAND_CTX
*ctx
);
987 size_t evp_rand_get_seed(EVP_RAND_CTX
*ctx
,
988 unsigned char **buffer
,
989 int entropy
, size_t min_len
, size_t max_len
,
990 int prediction_resistance
,
991 const unsigned char *adin
, size_t adin_len
);
992 void evp_rand_clear_seed(EVP_RAND_CTX
*ctx
,
993 unsigned char *buffer
, size_t b_len
);
994 int evp_signature_get_number(const EVP_SIGNATURE
*signature
);
996 int evp_pkey_decrypt_alloc(EVP_PKEY_CTX
*ctx
, unsigned char **outp
,
997 size_t *outlenp
, size_t expected_outlen
,
998 const unsigned char *in
, size_t inlen
);
1000 int ossl_md2hmacnid(int mdnid
);
1001 int ossl_hmac2mdnid(int hmac_nid
);
1003 #endif /* OSSL_CRYPTO_EVP_H */