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
;
252 #define EVP_ORIG_DYNAMIC 0
253 #define EVP_ORIG_GLOBAL 1
254 #define EVP_ORIG_METH 2
260 /* Legacy structure members */
265 int (*init
) (EVP_MD_CTX
*ctx
);
266 int (*update
) (EVP_MD_CTX
*ctx
, const void *data
, size_t count
);
267 int (*final
) (EVP_MD_CTX
*ctx
, unsigned char *md
);
268 int (*copy
) (EVP_MD_CTX
*to
, const EVP_MD_CTX
*from
);
269 int (*cleanup
) (EVP_MD_CTX
*ctx
);
271 int ctx_size
; /* how big does the ctx->md_data need to be */
272 /* control function */
273 int (*md_ctrl
) (EVP_MD_CTX
*ctx
, int cmd
, int p1
, void *p2
);
275 /* New structure members */
276 /* Above comment to be removed when legacy has gone */
279 const char *description
;
281 CRYPTO_REF_COUNT refcnt
;
282 OSSL_FUNC_digest_newctx_fn
*newctx
;
283 OSSL_FUNC_digest_init_fn
*dinit
;
284 OSSL_FUNC_digest_update_fn
*dupdate
;
285 OSSL_FUNC_digest_final_fn
*dfinal
;
286 OSSL_FUNC_digest_squeeze_fn
*dsqueeze
;
287 OSSL_FUNC_digest_digest_fn
*digest
;
288 OSSL_FUNC_digest_freectx_fn
*freectx
;
289 OSSL_FUNC_digest_copyctx_fn
*copyctx
;
290 OSSL_FUNC_digest_dupctx_fn
*dupctx
;
291 OSSL_FUNC_digest_get_params_fn
*get_params
;
292 OSSL_FUNC_digest_set_ctx_params_fn
*set_ctx_params
;
293 OSSL_FUNC_digest_get_ctx_params_fn
*get_ctx_params
;
294 OSSL_FUNC_digest_gettable_params_fn
*gettable_params
;
295 OSSL_FUNC_digest_settable_ctx_params_fn
*settable_ctx_params
;
296 OSSL_FUNC_digest_gettable_ctx_params_fn
*gettable_ctx_params
;
300 struct evp_cipher_st
{
304 /* Default value for variable length ciphers */
308 /* Legacy structure members */
311 /* How the EVP_CIPHER was created. */
314 int (*init
) (EVP_CIPHER_CTX
*ctx
, const unsigned char *key
,
315 const unsigned char *iv
, int enc
);
316 /* encrypt/decrypt data */
317 int (*do_cipher
) (EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
318 const unsigned char *in
, size_t inl
);
320 int (*cleanup
) (EVP_CIPHER_CTX
*);
321 /* how big ctx->cipher_data needs to be */
323 /* Populate a ASN1_TYPE with parameters */
324 int (*set_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
325 /* Get parameters from a ASN1_TYPE */
326 int (*get_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
327 /* Miscellaneous operations */
328 int (*ctrl
) (EVP_CIPHER_CTX
*, int type
, int arg
, void *ptr
);
329 /* Application data */
332 /* New structure members */
333 /* Above comment to be removed when legacy has gone */
336 const char *description
;
338 CRYPTO_REF_COUNT refcnt
;
339 OSSL_FUNC_cipher_newctx_fn
*newctx
;
340 OSSL_FUNC_cipher_encrypt_init_fn
*einit
;
341 OSSL_FUNC_cipher_decrypt_init_fn
*dinit
;
342 OSSL_FUNC_cipher_update_fn
*cupdate
;
343 OSSL_FUNC_cipher_final_fn
*cfinal
;
344 OSSL_FUNC_cipher_cipher_fn
*ccipher
;
345 OSSL_FUNC_cipher_pipeline_encrypt_init_fn
*p_einit
;
346 OSSL_FUNC_cipher_pipeline_decrypt_init_fn
*p_dinit
;
347 OSSL_FUNC_cipher_pipeline_update_fn
*p_cupdate
;
348 OSSL_FUNC_cipher_pipeline_final_fn
*p_cfinal
;
349 OSSL_FUNC_cipher_freectx_fn
*freectx
;
350 OSSL_FUNC_cipher_dupctx_fn
*dupctx
;
351 OSSL_FUNC_cipher_get_params_fn
*get_params
;
352 OSSL_FUNC_cipher_get_ctx_params_fn
*get_ctx_params
;
353 OSSL_FUNC_cipher_set_ctx_params_fn
*set_ctx_params
;
354 OSSL_FUNC_cipher_gettable_params_fn
*gettable_params
;
355 OSSL_FUNC_cipher_gettable_ctx_params_fn
*gettable_ctx_params
;
356 OSSL_FUNC_cipher_settable_ctx_params_fn
*settable_ctx_params
;
357 OSSL_FUNC_cipher_encrypt_skey_init_fn
*einit_skey
;
358 OSSL_FUNC_cipher_decrypt_skey_init_fn
*dinit_skey
;
361 /* Macros to code block cipher wrappers */
363 /* Wrapper functions for each cipher mode */
365 #define EVP_C_DATA(kstruct, ctx) \
366 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
368 #define BLOCK_CIPHER_ecb_loop() \
370 bl = EVP_CIPHER_CTX_get0_cipher(ctx)->block_size; \
371 if (inl < bl) return 1;\
373 for (i=0; i <= inl; i+=bl)
375 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
376 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
378 BLOCK_CIPHER_ecb_loop() \
379 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_is_encrypting(ctx)); \
383 #define EVP_MAXCHUNK ((size_t)1 << 30)
385 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
386 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
388 while(inl>=EVP_MAXCHUNK) {\
389 int num = EVP_CIPHER_CTX_get_num(ctx);\
390 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
391 EVP_CIPHER_CTX_set_num(ctx, num);\
397 int num = EVP_CIPHER_CTX_get_num(ctx);\
398 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
399 EVP_CIPHER_CTX_set_num(ctx, num);\
404 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
405 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
407 while(inl>=EVP_MAXCHUNK) {\
408 cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
414 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
418 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
419 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
421 size_t chunk = EVP_MAXCHUNK;\
422 if (cbits == 1) chunk >>= 3;\
423 if (inl < chunk) chunk = inl;\
424 while (inl && inl >= chunk) {\
425 int num = EVP_CIPHER_CTX_get_num(ctx);\
426 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
428 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
429 ? chunk*8 : chunk), \
430 &EVP_C_DATA(kstruct, ctx)->ksched, ctx->iv,\
431 &num, EVP_CIPHER_CTX_is_encrypting(ctx));\
432 EVP_CIPHER_CTX_set_num(ctx, num);\
436 if (inl < chunk) chunk = inl;\
441 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
442 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
443 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
444 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
445 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
447 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
448 key_len, iv_len, flags, init_key, cleanup, \
449 set_asn1, get_asn1, ctrl) \
450 static const EVP_CIPHER cname##_##mode = { \
451 nid##_##nmode, block_size, key_len, iv_len, \
452 flags | EVP_CIPH_##MODE##_MODE, \
455 cname##_##mode##_cipher, \
462 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
464 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
465 iv_len, flags, init_key, cleanup, set_asn1, \
467 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
468 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
470 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
471 iv_len, cbits, flags, init_key, cleanup, \
472 set_asn1, get_asn1, ctrl) \
473 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
474 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
477 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
478 iv_len, cbits, flags, init_key, cleanup, \
479 set_asn1, get_asn1, ctrl) \
480 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
481 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
484 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
485 flags, init_key, cleanup, set_asn1, \
487 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
488 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
490 #define BLOCK_CIPHER_defs(cname, kstruct, \
491 nid, block_size, key_len, iv_len, cbits, flags, \
492 init_key, cleanup, set_asn1, get_asn1, ctrl) \
493 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
494 init_key, cleanup, set_asn1, get_asn1, ctrl) \
495 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
496 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
497 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
498 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
499 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
500 init_key, cleanup, set_asn1, get_asn1, ctrl)
503 #define BLOCK_CIPHER_defs(cname, kstruct, \
504 nid, block_size, key_len, iv_len, flags,\
505 init_key, cleanup, set_asn1, get_asn1, ctrl)\
506 static const EVP_CIPHER cname##_cbc = {\
507 nid##_cbc, block_size, key_len, iv_len, \
508 flags | EVP_CIPH_CBC_MODE,\
513 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
514 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
519 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
520 static const EVP_CIPHER cname##_cfb = {\
521 nid##_cfb64, 1, key_len, iv_len, \
522 flags | EVP_CIPH_CFB_MODE,\
527 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
528 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
533 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
534 static const EVP_CIPHER cname##_ofb = {\
535 nid##_ofb64, 1, key_len, iv_len, \
536 flags | EVP_CIPH_OFB_MODE,\
541 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
542 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
547 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
548 static const EVP_CIPHER cname##_ecb = {\
549 nid##_ecb, block_size, key_len, iv_len, \
550 flags | EVP_CIPH_ECB_MODE,\
555 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
556 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
561 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
564 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
565 block_size, key_len, iv_len, cbits, \
567 cleanup, set_asn1, get_asn1, ctrl) \
568 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
569 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
570 cbits, flags, init_key, cleanup, set_asn1, \
573 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
574 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
575 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
576 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
577 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
578 cipher##_init_key, NULL, NULL, NULL, NULL)
581 unsigned char iv
[EVP_MAX_IV_LENGTH
];
583 unsigned int tag_len
;
584 } evp_cipher_aead_asn1_params
;
586 int evp_cipher_param_to_asn1_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
587 evp_cipher_aead_asn1_params
*params
);
589 int evp_cipher_asn1_to_param_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
590 evp_cipher_aead_asn1_params
*params
);
593 * To support transparent execution of operation in backends other
594 * than the "origin" key, we support transparent export/import to
595 * those providers, and maintain a cache of the imported keydata,
596 * so we don't need to redo the export/import every time we perform
597 * the same operation in that same provider.
598 * This requires that the "origin" backend (whether it's a legacy or a
599 * provider "origin") implements exports, and that the target provider
600 * has an EVP_KEYMGMT that implements import.
603 EVP_KEYMGMT
*keymgmt
;
608 DEFINE_STACK_OF(OP_CACHE_ELEM
)
611 * An EVP_PKEY can have the following states:
615 * type == EVP_PKEY_NONE && keymgmt == NULL
619 * (type != EVP_PKEY_NONE && pkey.ptr == NULL) ## legacy (libcrypto only)
620 * || (keymgmt != NULL && keydata == NULL) ## provider side
624 * (type != EVP_PKEY_NONE && pkey.ptr != NULL) ## legacy (libcrypto only)
625 * || (keymgmt != NULL && keydata != NULL) ## provider side
627 * The easiest way to detect a legacy key is:
629 * keymgmt == NULL && type != EVP_PKEY_NONE
631 * The easiest way to detect a provider side key is:
635 #define evp_pkey_is_blank(pk) \
636 ((pk)->type == EVP_PKEY_NONE && (pk)->keymgmt == NULL)
637 #define evp_pkey_is_typed(pk) \
638 ((pk)->type != EVP_PKEY_NONE || (pk)->keymgmt != NULL)
640 # define evp_pkey_is_assigned(pk) \
641 ((pk)->pkey.ptr != NULL || (pk)->keydata != NULL)
643 # define evp_pkey_is_assigned(pk) \
644 ((pk)->keydata != NULL)
646 #define evp_pkey_is_legacy(pk) \
647 ((pk)->type != EVP_PKEY_NONE && (pk)->keymgmt == NULL)
648 #define evp_pkey_is_provided(pk) \
649 ((pk)->keymgmt != NULL)
651 union legacy_pkey_st
{
653 struct rsa_st
*rsa
; /* RSA */
654 # ifndef OPENSSL_NO_DSA
655 struct dsa_st
*dsa
; /* DSA */
657 # ifndef OPENSSL_NO_DH
658 struct dh_st
*dh
; /* DH */
660 # ifndef OPENSSL_NO_EC
661 struct ec_key_st
*ec
; /* ECC */
662 # ifndef OPENSSL_NO_ECX
663 ECX_KEY
*ecx
; /* X25519, X448, Ed25519, Ed448 */
669 /* == Legacy attributes == */
675 * Legacy key "origin" is composed of a pointer to an EVP_PKEY_ASN1_METHOD,
676 * a pointer to a low level key and possibly a pointer to an engine.
678 const EVP_PKEY_ASN1_METHOD
*ameth
;
680 ENGINE
*pmeth_engine
; /* If not NULL public key ENGINE to use */
682 /* Union to store the reference to an origin legacy key */
683 union legacy_pkey_st pkey
;
685 /* Union to store the reference to a non-origin legacy key */
686 union legacy_pkey_st legacy_cache_pkey
;
689 /* == Common attributes == */
690 CRYPTO_REF_COUNT references
;
693 STACK_OF(X509_ATTRIBUTE
) *attributes
; /* [ 0 ] */
695 unsigned int foreign
:1; /* the low-level key is using an engine or an app-method */
696 CRYPTO_EX_DATA ex_data
;
699 /* == Provider attributes == */
702 * Provider keydata "origin" is composed of a pointer to an EVP_KEYMGMT
703 * and a pointer to the provider side key data. This is never used at
704 * the same time as the legacy key data above.
706 EVP_KEYMGMT
*keymgmt
;
709 * If any libcrypto code does anything that may modify the keydata
710 * contents, this dirty counter must be incremented.
715 * To support transparent execution of operation in backends other
716 * than the "origin" key, we support transparent export/import to
717 * those providers, and maintain a cache of the imported keydata,
718 * so we don't need to redo the export/import every time we perform
719 * the same operation in that same provider.
721 STACK_OF(OP_CACHE_ELEM
) *operation_cache
;
724 * We keep a copy of that "origin"'s dirty count, so we know if the
725 * operation cache needs flushing.
727 size_t dirty_cnt_copy
;
729 /* Cache of key object information */
733 int security_category
;
738 /* The EVP_PKEY_OP_TYPE_ macros are found in include/openssl/evp.h */
740 # define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
741 (((ctx)->operation & EVP_PKEY_OP_TYPE_SIG) != 0)
743 # define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
744 (((ctx)->operation & EVP_PKEY_OP_TYPE_DERIVE) != 0)
746 # define EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx) \
747 (((ctx)->operation & EVP_PKEY_OP_TYPE_CRYPT) != 0)
749 # define EVP_PKEY_CTX_IS_GEN_OP(ctx) \
750 (((ctx)->operation & EVP_PKEY_OP_TYPE_GEN) != 0)
752 # define EVP_PKEY_CTX_IS_FROMDATA_OP(ctx) \
753 (((ctx)->operation & EVP_PKEY_OP_TYPE_DATA) != 0)
755 # define EVP_PKEY_CTX_IS_KEM_OP(ctx) \
756 (((ctx)->operation & EVP_PKEY_OP_TYPE_KEM) != 0)
759 /* == Common attributes == */
760 CRYPTO_REF_COUNT references
;
763 void *keydata
; /* Alg-specific key data */
764 EVP_SKEYMGMT
*skeymgmt
; /* Import, export, manage */
767 void openssl_add_all_ciphers_int(void);
768 void openssl_add_all_digests_int(void);
769 void evp_cleanup_int(void);
770 void evp_app_cleanup_int(void);
771 void *evp_pkey_export_to_provider(EVP_PKEY
*pk
, OSSL_LIB_CTX
*libctx
,
772 EVP_KEYMGMT
**keymgmt
,
773 const char *propquery
);
775 int evp_pkey_copy_downgraded(EVP_PKEY
**dest
, const EVP_PKEY
*src
);
776 void *evp_pkey_get_legacy(EVP_PKEY
*pk
);
777 void evp_pkey_free_legacy(EVP_PKEY
*x
);
778 EVP_PKEY
*evp_pkcs82pkey_legacy(const PKCS8_PRIV_KEY_INFO
*p8inf
,
779 OSSL_LIB_CTX
*libctx
, const char *propq
);
783 * KEYMGMT utility functions
787 * Key import structure and helper function, to be used as an export callback
789 struct evp_keymgmt_util_try_import_data_st
{
790 EVP_KEYMGMT
*keymgmt
;
795 int evp_keymgmt_util_try_import(const OSSL_PARAM params
[], void *arg
);
796 int evp_keymgmt_util_assign_pkey(EVP_PKEY
*pkey
, EVP_KEYMGMT
*keymgmt
,
798 EVP_PKEY
*evp_keymgmt_util_make_pkey(EVP_KEYMGMT
*keymgmt
, void *keydata
);
800 int evp_keymgmt_util_export(const EVP_PKEY
*pk
, int selection
,
801 OSSL_CALLBACK
*export_cb
, void *export_cbarg
);
802 void *evp_keymgmt_util_export_to_provider(EVP_PKEY
*pk
, EVP_KEYMGMT
*keymgmt
,
804 OP_CACHE_ELEM
*evp_keymgmt_util_find_operation_cache(EVP_PKEY
*pk
,
805 EVP_KEYMGMT
*keymgmt
,
807 int evp_keymgmt_util_clear_operation_cache(EVP_PKEY
*pk
);
808 int evp_keymgmt_util_cache_keydata(EVP_PKEY
*pk
, EVP_KEYMGMT
*keymgmt
,
809 void *keydata
, int selection
);
810 void evp_keymgmt_util_cache_keyinfo(EVP_PKEY
*pk
);
811 void *evp_keymgmt_util_fromdata(EVP_PKEY
*target
, EVP_KEYMGMT
*keymgmt
,
812 int selection
, const OSSL_PARAM params
[]);
813 int evp_keymgmt_util_has(EVP_PKEY
*pk
, int selection
);
814 int evp_keymgmt_util_match(EVP_PKEY
*pk1
, EVP_PKEY
*pk2
, int selection
);
815 int evp_keymgmt_util_copy(EVP_PKEY
*to
, EVP_PKEY
*from
, int selection
);
816 void *evp_keymgmt_util_gen(EVP_PKEY
*target
, EVP_KEYMGMT
*keymgmt
,
817 void *genctx
, OSSL_CALLBACK
*cb
, void *cbarg
);
818 int evp_keymgmt_util_get_deflt_digest_name(EVP_KEYMGMT
*keymgmt
,
820 char *mdname
, size_t mdname_sz
);
821 const char *evp_keymgmt_util_query_operation_name(EVP_KEYMGMT
*keymgmt
,
825 * KEYMGMT provider interface functions
827 void *evp_keymgmt_newdata(const EVP_KEYMGMT
*keymgmt
);
828 void evp_keymgmt_freedata(const EVP_KEYMGMT
*keymgmt
, void *keyddata
);
829 int evp_keymgmt_get_params(const EVP_KEYMGMT
*keymgmt
,
830 void *keydata
, OSSL_PARAM params
[]);
831 int evp_keymgmt_set_params(const EVP_KEYMGMT
*keymgmt
,
832 void *keydata
, const OSSL_PARAM params
[]);
833 void *evp_keymgmt_gen_init(const EVP_KEYMGMT
*keymgmt
, int selection
,
834 const OSSL_PARAM params
[]);
835 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
837 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
838 const OSSL_PARAM params
[]);
839 int evp_keymgmt_gen_get_params(const EVP_KEYMGMT
*keymgmt
,
840 void *genctx
, OSSL_PARAM params
[]);
841 void *evp_keymgmt_gen(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
842 OSSL_CALLBACK
*cb
, void *cbarg
);
843 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT
*keymgmt
, void *genctx
);
845 int evp_keymgmt_has_load(const EVP_KEYMGMT
*keymgmt
);
846 void *evp_keymgmt_load(const EVP_KEYMGMT
*keymgmt
,
847 const void *objref
, size_t objref_sz
);
849 int evp_keymgmt_has(const EVP_KEYMGMT
*keymgmt
, void *keyddata
, int selection
);
850 int evp_keymgmt_validate(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
851 int selection
, int checktype
);
852 int evp_keymgmt_match(const EVP_KEYMGMT
*keymgmt
,
853 const void *keydata1
, const void *keydata2
,
856 int evp_keymgmt_import(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
857 int selection
, const OSSL_PARAM params
[]);
858 const OSSL_PARAM
*evp_keymgmt_import_types(const EVP_KEYMGMT
*keymgmt
,
860 int evp_keymgmt_export(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
861 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
);
862 const OSSL_PARAM
*evp_keymgmt_export_types(const EVP_KEYMGMT
*keymgmt
,
864 void *evp_keymgmt_dup(const EVP_KEYMGMT
*keymgmt
,
865 const void *keydata_from
, int selection
);
866 EVP_KEYMGMT
*evp_keymgmt_fetch_from_prov(OSSL_PROVIDER
*prov
,
868 const char *properties
);
871 * SKEYMGMT provider interface functions
873 void evp_skeymgmt_freedata(const EVP_SKEYMGMT
*keymgmt
, void *keyddata
);
874 void *evp_skeymgmt_import(const EVP_SKEYMGMT
*skeymgmt
, int selection
, const OSSL_PARAM params
[]);
875 int evp_skeymgmt_export(const EVP_SKEYMGMT
*skeymgmt
, void *keydata
,
876 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
);
877 void *evp_skeymgmt_generate(const EVP_SKEYMGMT
*skeymgmt
, const OSSL_PARAM params
[]);
878 EVP_SKEYMGMT
*evp_skeymgmt_fetch_from_prov(OSSL_PROVIDER
*prov
,
880 const char *properties
);
882 /* Pulling defines out of C source files */
884 # define EVP_RC4_KEY_SIZE 16
885 # ifndef TLS1_1_VERSION
886 # define TLS1_1_VERSION 0x0302
889 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX
*ctx
, unsigned int flags
);
891 /* EVP_ENCODE_CTX flags */
892 /* Don't generate new lines when encoding */
893 #define EVP_ENCODE_CTX_NO_NEWLINES 1
894 /* Use the SRP base64 alphabet instead of the standard one */
895 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2
897 const EVP_CIPHER
*evp_get_cipherbyname_ex(OSSL_LIB_CTX
*libctx
,
899 const EVP_MD
*evp_get_digestbyname_ex(OSSL_LIB_CTX
*libctx
,
902 int ossl_pkcs5_pbkdf2_hmac_ex(const char *pass
, int passlen
,
903 const unsigned char *salt
, int saltlen
, int iter
,
904 const EVP_MD
*digest
, int keylen
,
906 OSSL_LIB_CTX
*libctx
, const char *propq
);
910 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
912 * Return 1 on success, 0 or negative for errors.
914 * In particular they return -2 if any of the params is not supported.
916 * They are not available in FIPS_MODULE as they depend on
917 * - EVP_PKEY_CTX_{get,set}_params()
918 * - EVP_PKEY_CTX_{gettable,settable}_params()
921 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
922 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
924 EVP_MD_CTX
*evp_md_ctx_new_ex(EVP_PKEY
*pkey
, const ASN1_OCTET_STRING
*id
,
925 OSSL_LIB_CTX
*libctx
, const char *propq
);
926 int evp_pkey_name2type(const char *name
);
927 const char *evp_pkey_type2name(int type
);
929 int evp_pkey_ctx_use_cached_data(EVP_PKEY_CTX
*ctx
);
930 # endif /* !defined(FIPS_MODULE) */
932 int evp_method_store_cache_flush(OSSL_LIB_CTX
*libctx
);
933 int evp_method_store_remove_all_provided(const OSSL_PROVIDER
*prov
);
935 int evp_default_properties_enable_fips_int(OSSL_LIB_CTX
*libctx
, int enable
,
937 int evp_set_default_properties_int(OSSL_LIB_CTX
*libctx
, const char *propq
,
938 int loadconfig
, int mirrored
);
939 char *evp_get_global_properties_str(OSSL_LIB_CTX
*libctx
, int loadconfig
);
941 void evp_md_ctx_clear_digest(EVP_MD_CTX
*ctx
, int force
, int keep_digest
);
942 /* just free the algctx if set, returns 0 on inconsistent state of ctx */
943 int evp_md_ctx_free_algctx(EVP_MD_CTX
*ctx
);
945 /* Three possible states: */
946 # define EVP_PKEY_STATE_UNKNOWN 0
947 # define EVP_PKEY_STATE_LEGACY 1
948 # define EVP_PKEY_STATE_PROVIDER 2
949 int evp_pkey_ctx_state(const EVP_PKEY_CTX
*ctx
);
951 /* These two must ONLY be called for provider side operations */
952 int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX
*ctx
,
953 int keytype
, int optype
,
954 int cmd
, int p1
, void *p2
);
955 int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX
*ctx
,
956 const char *name
, const char *value
);
958 /* These two must ONLY be called for legacy operations */
959 int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX
*ctx
, const OSSL_PARAM
*params
);
960 int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
962 /* This must ONLY be called for legacy EVP_PKEYs */
963 int evp_pkey_get_params_to_ctrl(const EVP_PKEY
*pkey
, OSSL_PARAM
*params
);
965 /* Same as the public get0 functions but are not const */
966 # ifndef OPENSSL_NO_DEPRECATED_3_0
967 DH
*evp_pkey_get0_DH_int(const EVP_PKEY
*pkey
);
968 EC_KEY
*evp_pkey_get0_EC_KEY_int(const EVP_PKEY
*pkey
);
969 RSA
*evp_pkey_get0_RSA_int(const EVP_PKEY
*pkey
);
972 /* Get internal identification number routines */
973 int evp_asym_cipher_get_number(const EVP_ASYM_CIPHER
*cipher
);
974 int evp_cipher_get_number(const EVP_CIPHER
*cipher
);
975 int evp_kdf_get_number(const EVP_KDF
*kdf
);
976 int evp_kem_get_number(const EVP_KEM
*wrap
);
977 int evp_keyexch_get_number(const EVP_KEYEXCH
*keyexch
);
978 int evp_keymgmt_get_number(const EVP_KEYMGMT
*keymgmt
);
979 int evp_keymgmt_get_legacy_alg(const EVP_KEYMGMT
*keymgmt
);
980 int evp_mac_get_number(const EVP_MAC
*mac
);
981 int evp_md_get_number(const EVP_MD
*md
);
982 int evp_rand_get_number(const EVP_RAND
*rand
);
983 int evp_rand_can_seed(EVP_RAND_CTX
*ctx
);
984 size_t evp_rand_get_seed(EVP_RAND_CTX
*ctx
,
985 unsigned char **buffer
,
986 int entropy
, size_t min_len
, size_t max_len
,
987 int prediction_resistance
,
988 const unsigned char *adin
, size_t adin_len
);
989 void evp_rand_clear_seed(EVP_RAND_CTX
*ctx
,
990 unsigned char *buffer
, size_t b_len
);
991 int evp_signature_get_number(const EVP_SIGNATURE
*signature
);
993 int evp_pkey_decrypt_alloc(EVP_PKEY_CTX
*ctx
, unsigned char **outp
,
994 size_t *outlenp
, size_t expected_outlen
,
995 const unsigned char *in
, size_t inlen
);
997 int ossl_md2hmacnid(int mdnid
);
998 int ossl_hmac2mdnid(int hmac_nid
);
1000 #endif /* OSSL_CRYPTO_EVP_H */