2 * Copyright 2015-2024 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
;
235 const char *description
;
236 CRYPTO_REF_COUNT refcnt
;
238 OSSL_FUNC_kdf_newctx_fn
*newctx
;
239 OSSL_FUNC_kdf_dupctx_fn
*dupctx
;
240 OSSL_FUNC_kdf_freectx_fn
*freectx
;
241 OSSL_FUNC_kdf_reset_fn
*reset
;
242 OSSL_FUNC_kdf_derive_fn
*derive
;
243 OSSL_FUNC_kdf_gettable_params_fn
*gettable_params
;
244 OSSL_FUNC_kdf_gettable_ctx_params_fn
*gettable_ctx_params
;
245 OSSL_FUNC_kdf_settable_ctx_params_fn
*settable_ctx_params
;
246 OSSL_FUNC_kdf_get_params_fn
*get_params
;
247 OSSL_FUNC_kdf_get_ctx_params_fn
*get_ctx_params
;
248 OSSL_FUNC_kdf_set_ctx_params_fn
*set_ctx_params
;
251 #define EVP_ORIG_DYNAMIC 0
252 #define EVP_ORIG_GLOBAL 1
253 #define EVP_ORIG_METH 2
259 /* Legacy structure members */
264 int (*init
) (EVP_MD_CTX
*ctx
);
265 int (*update
) (EVP_MD_CTX
*ctx
, const void *data
, size_t count
);
266 int (*final
) (EVP_MD_CTX
*ctx
, unsigned char *md
);
267 int (*copy
) (EVP_MD_CTX
*to
, const EVP_MD_CTX
*from
);
268 int (*cleanup
) (EVP_MD_CTX
*ctx
);
270 int ctx_size
; /* how big does the ctx->md_data need to be */
271 /* control function */
272 int (*md_ctrl
) (EVP_MD_CTX
*ctx
, int cmd
, int p1
, void *p2
);
274 /* New structure members */
275 /* Above comment to be removed when legacy has gone */
278 const char *description
;
280 CRYPTO_REF_COUNT refcnt
;
281 OSSL_FUNC_digest_newctx_fn
*newctx
;
282 OSSL_FUNC_digest_init_fn
*dinit
;
283 OSSL_FUNC_digest_update_fn
*dupdate
;
284 OSSL_FUNC_digest_final_fn
*dfinal
;
285 OSSL_FUNC_digest_squeeze_fn
*dsqueeze
;
286 OSSL_FUNC_digest_digest_fn
*digest
;
287 OSSL_FUNC_digest_freectx_fn
*freectx
;
288 OSSL_FUNC_digest_dupctx_fn
*dupctx
;
289 OSSL_FUNC_digest_get_params_fn
*get_params
;
290 OSSL_FUNC_digest_set_ctx_params_fn
*set_ctx_params
;
291 OSSL_FUNC_digest_get_ctx_params_fn
*get_ctx_params
;
292 OSSL_FUNC_digest_gettable_params_fn
*gettable_params
;
293 OSSL_FUNC_digest_settable_ctx_params_fn
*settable_ctx_params
;
294 OSSL_FUNC_digest_gettable_ctx_params_fn
*gettable_ctx_params
;
298 struct evp_cipher_st
{
302 /* Default value for variable length ciphers */
306 /* Legacy structure members */
309 /* How the EVP_CIPHER was created. */
312 int (*init
) (EVP_CIPHER_CTX
*ctx
, const unsigned char *key
,
313 const unsigned char *iv
, int enc
);
314 /* encrypt/decrypt data */
315 int (*do_cipher
) (EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
316 const unsigned char *in
, size_t inl
);
318 int (*cleanup
) (EVP_CIPHER_CTX
*);
319 /* how big ctx->cipher_data needs to be */
321 /* Populate a ASN1_TYPE with parameters */
322 int (*set_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
323 /* Get parameters from a ASN1_TYPE */
324 int (*get_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
325 /* Miscellaneous operations */
326 int (*ctrl
) (EVP_CIPHER_CTX
*, int type
, int arg
, void *ptr
);
327 /* Application data */
330 /* New structure members */
331 /* Above comment to be removed when legacy has gone */
334 const char *description
;
336 CRYPTO_REF_COUNT refcnt
;
337 OSSL_FUNC_cipher_newctx_fn
*newctx
;
338 OSSL_FUNC_cipher_encrypt_init_fn
*einit
;
339 OSSL_FUNC_cipher_decrypt_init_fn
*dinit
;
340 OSSL_FUNC_cipher_update_fn
*cupdate
;
341 OSSL_FUNC_cipher_final_fn
*cfinal
;
342 OSSL_FUNC_cipher_cipher_fn
*ccipher
;
343 OSSL_FUNC_cipher_freectx_fn
*freectx
;
344 OSSL_FUNC_cipher_dupctx_fn
*dupctx
;
345 OSSL_FUNC_cipher_get_params_fn
*get_params
;
346 OSSL_FUNC_cipher_get_ctx_params_fn
*get_ctx_params
;
347 OSSL_FUNC_cipher_set_ctx_params_fn
*set_ctx_params
;
348 OSSL_FUNC_cipher_gettable_params_fn
*gettable_params
;
349 OSSL_FUNC_cipher_gettable_ctx_params_fn
*gettable_ctx_params
;
350 OSSL_FUNC_cipher_settable_ctx_params_fn
*settable_ctx_params
;
353 /* Macros to code block cipher wrappers */
355 /* Wrapper functions for each cipher mode */
357 #define EVP_C_DATA(kstruct, ctx) \
358 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
360 #define BLOCK_CIPHER_ecb_loop() \
362 bl = EVP_CIPHER_CTX_get0_cipher(ctx)->block_size; \
363 if (inl < bl) return 1;\
365 for (i=0; i <= inl; i+=bl)
367 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
368 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
370 BLOCK_CIPHER_ecb_loop() \
371 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_is_encrypting(ctx)); \
375 #define EVP_MAXCHUNK ((size_t)1 << 30)
377 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
378 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
380 while(inl>=EVP_MAXCHUNK) {\
381 int num = EVP_CIPHER_CTX_get_num(ctx);\
382 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
383 EVP_CIPHER_CTX_set_num(ctx, num);\
389 int num = EVP_CIPHER_CTX_get_num(ctx);\
390 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
391 EVP_CIPHER_CTX_set_num(ctx, num);\
396 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
397 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
399 while(inl>=EVP_MAXCHUNK) \
401 cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
407 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
411 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
412 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
414 size_t chunk = EVP_MAXCHUNK;\
415 if (cbits == 1) chunk >>= 3;\
416 if (inl < chunk) chunk = inl;\
417 while (inl && inl >= chunk)\
419 int num = EVP_CIPHER_CTX_get_num(ctx);\
420 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
422 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
423 ? chunk*8 : chunk), \
424 &EVP_C_DATA(kstruct, ctx)->ksched, ctx->iv,\
425 &num, EVP_CIPHER_CTX_is_encrypting(ctx));\
426 EVP_CIPHER_CTX_set_num(ctx, num);\
430 if (inl < chunk) chunk = inl;\
435 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
436 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
437 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
438 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
439 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
441 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
442 key_len, iv_len, flags, init_key, cleanup, \
443 set_asn1, get_asn1, ctrl) \
444 static const EVP_CIPHER cname##_##mode = { \
445 nid##_##nmode, block_size, key_len, iv_len, \
446 flags | EVP_CIPH_##MODE##_MODE, \
449 cname##_##mode##_cipher, \
456 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
458 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
459 iv_len, flags, init_key, cleanup, set_asn1, \
461 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
462 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
464 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
465 iv_len, cbits, flags, init_key, cleanup, \
466 set_asn1, get_asn1, ctrl) \
467 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
468 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
471 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
472 iv_len, cbits, flags, init_key, cleanup, \
473 set_asn1, get_asn1, ctrl) \
474 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
475 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
478 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
479 flags, init_key, cleanup, set_asn1, \
481 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
482 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
484 #define BLOCK_CIPHER_defs(cname, kstruct, \
485 nid, block_size, key_len, iv_len, cbits, flags, \
486 init_key, cleanup, set_asn1, get_asn1, ctrl) \
487 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
488 init_key, cleanup, set_asn1, get_asn1, ctrl) \
489 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
490 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
491 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
492 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
493 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
494 init_key, cleanup, set_asn1, get_asn1, ctrl)
497 #define BLOCK_CIPHER_defs(cname, kstruct, \
498 nid, block_size, key_len, iv_len, flags,\
499 init_key, cleanup, set_asn1, get_asn1, ctrl)\
500 static const EVP_CIPHER cname##_cbc = {\
501 nid##_cbc, block_size, key_len, iv_len, \
502 flags | EVP_CIPH_CBC_MODE,\
507 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
508 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
513 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
514 static const EVP_CIPHER cname##_cfb = {\
515 nid##_cfb64, 1, key_len, iv_len, \
516 flags | EVP_CIPH_CFB_MODE,\
521 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
522 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
527 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
528 static const EVP_CIPHER cname##_ofb = {\
529 nid##_ofb64, 1, key_len, iv_len, \
530 flags | EVP_CIPH_OFB_MODE,\
535 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
536 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
541 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
542 static const EVP_CIPHER cname##_ecb = {\
543 nid##_ecb, block_size, key_len, iv_len, \
544 flags | EVP_CIPH_ECB_MODE,\
549 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
550 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
555 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
558 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
559 block_size, key_len, iv_len, cbits, \
561 cleanup, set_asn1, get_asn1, ctrl) \
562 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
563 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
564 cbits, flags, init_key, cleanup, set_asn1, \
567 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
568 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
569 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
570 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
571 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
572 cipher##_init_key, NULL, NULL, NULL, NULL)
575 unsigned char iv
[EVP_MAX_IV_LENGTH
];
577 unsigned int tag_len
;
578 } evp_cipher_aead_asn1_params
;
580 int evp_cipher_param_to_asn1_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
581 evp_cipher_aead_asn1_params
*params
);
583 int evp_cipher_asn1_to_param_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
584 evp_cipher_aead_asn1_params
*params
);
587 * To support transparent execution of operation in backends other
588 * than the "origin" key, we support transparent export/import to
589 * those providers, and maintain a cache of the imported keydata,
590 * so we don't need to redo the export/import every time we perform
591 * the same operation in that same provider.
592 * This requires that the "origin" backend (whether it's a legacy or a
593 * provider "origin") implements exports, and that the target provider
594 * has an EVP_KEYMGMT that implements import.
597 EVP_KEYMGMT
*keymgmt
;
602 DEFINE_STACK_OF(OP_CACHE_ELEM
)
605 * An EVP_PKEY can have the following states:
609 * type == EVP_PKEY_NONE && keymgmt == NULL
613 * (type != EVP_PKEY_NONE && pkey.ptr == NULL) ## legacy (libcrypto only)
614 * || (keymgmt != NULL && keydata == NULL) ## provider side
618 * (type != EVP_PKEY_NONE && pkey.ptr != NULL) ## legacy (libcrypto only)
619 * || (keymgmt != NULL && keydata != NULL) ## provider side
621 * The easiest way to detect a legacy key is:
623 * keymgmt == NULL && type != EVP_PKEY_NONE
625 * The easiest way to detect a provider side key is:
629 #define evp_pkey_is_blank(pk) \
630 ((pk)->type == EVP_PKEY_NONE && (pk)->keymgmt == NULL)
631 #define evp_pkey_is_typed(pk) \
632 ((pk)->type != EVP_PKEY_NONE || (pk)->keymgmt != NULL)
634 # define evp_pkey_is_assigned(pk) \
635 ((pk)->pkey.ptr != NULL || (pk)->keydata != NULL)
637 # define evp_pkey_is_assigned(pk) \
638 ((pk)->keydata != NULL)
640 #define evp_pkey_is_legacy(pk) \
641 ((pk)->type != EVP_PKEY_NONE && (pk)->keymgmt == NULL)
642 #define evp_pkey_is_provided(pk) \
643 ((pk)->keymgmt != NULL)
645 union legacy_pkey_st
{
647 struct rsa_st
*rsa
; /* RSA */
648 # ifndef OPENSSL_NO_DSA
649 struct dsa_st
*dsa
; /* DSA */
651 # ifndef OPENSSL_NO_DH
652 struct dh_st
*dh
; /* DH */
654 # ifndef OPENSSL_NO_EC
655 struct ec_key_st
*ec
; /* ECC */
656 # ifndef OPENSSL_NO_ECX
657 ECX_KEY
*ecx
; /* X25519, X448, Ed25519, Ed448 */
663 /* == Legacy attributes == */
669 * Legacy key "origin" is composed of a pointer to an EVP_PKEY_ASN1_METHOD,
670 * a pointer to a low level key and possibly a pointer to an engine.
672 const EVP_PKEY_ASN1_METHOD
*ameth
;
674 ENGINE
*pmeth_engine
; /* If not NULL public key ENGINE to use */
676 /* Union to store the reference to an origin legacy key */
677 union legacy_pkey_st pkey
;
679 /* Union to store the reference to a non-origin legacy key */
680 union legacy_pkey_st legacy_cache_pkey
;
683 /* == Common attributes == */
684 CRYPTO_REF_COUNT references
;
687 STACK_OF(X509_ATTRIBUTE
) *attributes
; /* [ 0 ] */
689 unsigned int foreign
:1; /* the low-level key is using an engine or an app-method */
690 CRYPTO_EX_DATA ex_data
;
693 /* == Provider attributes == */
696 * Provider keydata "origin" is composed of a pointer to an EVP_KEYMGMT
697 * and a pointer to the provider side key data. This is never used at
698 * the same time as the legacy key data above.
700 EVP_KEYMGMT
*keymgmt
;
703 * If any libcrypto code does anything that may modify the keydata
704 * contents, this dirty counter must be incremented.
709 * To support transparent execution of operation in backends other
710 * than the "origin" key, we support transparent export/import to
711 * those providers, and maintain a cache of the imported keydata,
712 * so we don't need to redo the export/import every time we perform
713 * the same operation in that same provider.
715 STACK_OF(OP_CACHE_ELEM
) *operation_cache
;
718 * We keep a copy of that "origin"'s dirty count, so we know if the
719 * operation cache needs flushing.
721 size_t dirty_cnt_copy
;
723 /* Cache of key object information */
731 #define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
732 ((ctx)->operation == EVP_PKEY_OP_SIGN \
733 || (ctx)->operation == EVP_PKEY_OP_SIGNCTX \
734 || (ctx)->operation == EVP_PKEY_OP_VERIFY \
735 || (ctx)->operation == EVP_PKEY_OP_VERIFYCTX \
736 || (ctx)->operation == EVP_PKEY_OP_VERIFYRECOVER)
738 #define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
739 ((ctx)->operation == EVP_PKEY_OP_DERIVE)
741 #define EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx) \
742 ((ctx)->operation == EVP_PKEY_OP_ENCRYPT \
743 || (ctx)->operation == EVP_PKEY_OP_DECRYPT)
745 #define EVP_PKEY_CTX_IS_GEN_OP(ctx) \
746 ((ctx)->operation == EVP_PKEY_OP_PARAMGEN \
747 || (ctx)->operation == EVP_PKEY_OP_KEYGEN)
749 #define EVP_PKEY_CTX_IS_FROMDATA_OP(ctx) \
750 ((ctx)->operation == EVP_PKEY_OP_FROMDATA)
752 #define EVP_PKEY_CTX_IS_KEM_OP(ctx) \
753 ((ctx)->operation == EVP_PKEY_OP_ENCAPSULATE \
754 || (ctx)->operation == EVP_PKEY_OP_DECAPSULATE)
756 void openssl_add_all_ciphers_int(void);
757 void openssl_add_all_digests_int(void);
758 void evp_cleanup_int(void);
759 void evp_app_cleanup_int(void);
760 void *evp_pkey_export_to_provider(EVP_PKEY
*pk
, OSSL_LIB_CTX
*libctx
,
761 EVP_KEYMGMT
**keymgmt
,
762 const char *propquery
);
764 int evp_pkey_copy_downgraded(EVP_PKEY
**dest
, const EVP_PKEY
*src
);
765 void *evp_pkey_get_legacy(EVP_PKEY
*pk
);
766 void evp_pkey_free_legacy(EVP_PKEY
*x
);
767 EVP_PKEY
*evp_pkcs82pkey_legacy(const PKCS8_PRIV_KEY_INFO
*p8inf
,
768 OSSL_LIB_CTX
*libctx
, const char *propq
);
772 * KEYMGMT utility functions
776 * Key import structure and helper function, to be used as an export callback
778 struct evp_keymgmt_util_try_import_data_st
{
779 EVP_KEYMGMT
*keymgmt
;
784 int evp_keymgmt_util_try_import(const OSSL_PARAM params
[], void *arg
);
785 int evp_keymgmt_util_assign_pkey(EVP_PKEY
*pkey
, EVP_KEYMGMT
*keymgmt
,
787 EVP_PKEY
*evp_keymgmt_util_make_pkey(EVP_KEYMGMT
*keymgmt
, void *keydata
);
789 int evp_keymgmt_util_export(const EVP_PKEY
*pk
, int selection
,
790 OSSL_CALLBACK
*export_cb
, void *export_cbarg
);
791 void *evp_keymgmt_util_export_to_provider(EVP_PKEY
*pk
, EVP_KEYMGMT
*keymgmt
,
793 OP_CACHE_ELEM
*evp_keymgmt_util_find_operation_cache(EVP_PKEY
*pk
,
794 EVP_KEYMGMT
*keymgmt
,
796 int evp_keymgmt_util_clear_operation_cache(EVP_PKEY
*pk
);
797 int evp_keymgmt_util_cache_keydata(EVP_PKEY
*pk
, EVP_KEYMGMT
*keymgmt
,
798 void *keydata
, int selection
);
799 void evp_keymgmt_util_cache_keyinfo(EVP_PKEY
*pk
);
800 void *evp_keymgmt_util_fromdata(EVP_PKEY
*target
, EVP_KEYMGMT
*keymgmt
,
801 int selection
, const OSSL_PARAM params
[]);
802 int evp_keymgmt_util_has(EVP_PKEY
*pk
, int selection
);
803 int evp_keymgmt_util_match(EVP_PKEY
*pk1
, EVP_PKEY
*pk2
, int selection
);
804 int evp_keymgmt_util_copy(EVP_PKEY
*to
, EVP_PKEY
*from
, int selection
);
805 void *evp_keymgmt_util_gen(EVP_PKEY
*target
, EVP_KEYMGMT
*keymgmt
,
806 void *genctx
, OSSL_CALLBACK
*cb
, void *cbarg
);
807 int evp_keymgmt_util_get_deflt_digest_name(EVP_KEYMGMT
*keymgmt
,
809 char *mdname
, size_t mdname_sz
);
810 const char *evp_keymgmt_util_query_operation_name(EVP_KEYMGMT
*keymgmt
,
814 * KEYMGMT provider interface functions
816 void *evp_keymgmt_newdata(const EVP_KEYMGMT
*keymgmt
);
817 void evp_keymgmt_freedata(const EVP_KEYMGMT
*keymgmt
, void *keyddata
);
818 int evp_keymgmt_get_params(const EVP_KEYMGMT
*keymgmt
,
819 void *keydata
, OSSL_PARAM params
[]);
820 int evp_keymgmt_set_params(const EVP_KEYMGMT
*keymgmt
,
821 void *keydata
, const OSSL_PARAM params
[]);
822 void *evp_keymgmt_gen_init(const EVP_KEYMGMT
*keymgmt
, int selection
,
823 const OSSL_PARAM params
[]);
824 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
826 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
827 const OSSL_PARAM params
[]);
828 void *evp_keymgmt_gen(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
829 OSSL_CALLBACK
*cb
, void *cbarg
);
830 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT
*keymgmt
, void *genctx
);
832 int evp_keymgmt_has_load(const EVP_KEYMGMT
*keymgmt
);
833 void *evp_keymgmt_load(const EVP_KEYMGMT
*keymgmt
,
834 const void *objref
, size_t objref_sz
);
836 int evp_keymgmt_has(const EVP_KEYMGMT
*keymgmt
, void *keyddata
, int selection
);
837 int evp_keymgmt_validate(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
838 int selection
, int checktype
);
839 int evp_keymgmt_match(const EVP_KEYMGMT
*keymgmt
,
840 const void *keydata1
, const void *keydata2
,
843 int evp_keymgmt_import(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
844 int selection
, const OSSL_PARAM params
[]);
845 const OSSL_PARAM
*evp_keymgmt_import_types(const EVP_KEYMGMT
*keymgmt
,
847 int evp_keymgmt_export(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
848 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
);
849 const OSSL_PARAM
*evp_keymgmt_export_types(const EVP_KEYMGMT
*keymgmt
,
851 void *evp_keymgmt_dup(const EVP_KEYMGMT
*keymgmt
,
852 const void *keydata_from
, int selection
);
853 EVP_KEYMGMT
*evp_keymgmt_fetch_from_prov(OSSL_PROVIDER
*prov
,
855 const char *properties
);
857 /* Pulling defines out of C source files */
859 # define EVP_RC4_KEY_SIZE 16
860 # ifndef TLS1_1_VERSION
861 # define TLS1_1_VERSION 0x0302
864 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX
*ctx
, unsigned int flags
);
866 /* EVP_ENCODE_CTX flags */
867 /* Don't generate new lines when encoding */
868 #define EVP_ENCODE_CTX_NO_NEWLINES 1
869 /* Use the SRP base64 alphabet instead of the standard one */
870 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2
872 const EVP_CIPHER
*evp_get_cipherbyname_ex(OSSL_LIB_CTX
*libctx
,
874 const EVP_MD
*evp_get_digestbyname_ex(OSSL_LIB_CTX
*libctx
,
877 int ossl_pkcs5_pbkdf2_hmac_ex(const char *pass
, int passlen
,
878 const unsigned char *salt
, int saltlen
, int iter
,
879 const EVP_MD
*digest
, int keylen
,
881 OSSL_LIB_CTX
*libctx
, const char *propq
);
885 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
887 * Return 1 on success, 0 or negative for errors.
889 * In particular they return -2 if any of the params is not supported.
891 * They are not available in FIPS_MODULE as they depend on
892 * - EVP_PKEY_CTX_{get,set}_params()
893 * - EVP_PKEY_CTX_{gettable,settable}_params()
896 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
897 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
899 EVP_MD_CTX
*evp_md_ctx_new_ex(EVP_PKEY
*pkey
, const ASN1_OCTET_STRING
*id
,
900 OSSL_LIB_CTX
*libctx
, const char *propq
);
901 int evp_pkey_name2type(const char *name
);
902 const char *evp_pkey_type2name(int type
);
904 int evp_pkey_ctx_use_cached_data(EVP_PKEY_CTX
*ctx
);
905 # endif /* !defined(FIPS_MODULE) */
907 int evp_method_store_cache_flush(OSSL_LIB_CTX
*libctx
);
908 int evp_method_store_remove_all_provided(const OSSL_PROVIDER
*prov
);
910 int evp_default_properties_enable_fips_int(OSSL_LIB_CTX
*libctx
, int enable
,
912 int evp_set_default_properties_int(OSSL_LIB_CTX
*libctx
, const char *propq
,
913 int loadconfig
, int mirrored
);
914 char *evp_get_global_properties_str(OSSL_LIB_CTX
*libctx
, int loadconfig
);
916 void evp_md_ctx_clear_digest(EVP_MD_CTX
*ctx
, int force
, int keep_digest
);
917 /* just free the algctx if set, returns 0 on inconsistent state of ctx */
918 int evp_md_ctx_free_algctx(EVP_MD_CTX
*ctx
);
920 /* Three possible states: */
921 # define EVP_PKEY_STATE_UNKNOWN 0
922 # define EVP_PKEY_STATE_LEGACY 1
923 # define EVP_PKEY_STATE_PROVIDER 2
924 int evp_pkey_ctx_state(const EVP_PKEY_CTX
*ctx
);
926 /* These two must ONLY be called for provider side operations */
927 int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX
*ctx
,
928 int keytype
, int optype
,
929 int cmd
, int p1
, void *p2
);
930 int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX
*ctx
,
931 const char *name
, const char *value
);
933 /* These two must ONLY be called for legacy operations */
934 int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX
*ctx
, const OSSL_PARAM
*params
);
935 int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
937 /* This must ONLY be called for legacy EVP_PKEYs */
938 int evp_pkey_get_params_to_ctrl(const EVP_PKEY
*pkey
, OSSL_PARAM
*params
);
940 /* Same as the public get0 functions but are not const */
941 # ifndef OPENSSL_NO_DEPRECATED_3_0
942 DH
*evp_pkey_get0_DH_int(const EVP_PKEY
*pkey
);
943 EC_KEY
*evp_pkey_get0_EC_KEY_int(const EVP_PKEY
*pkey
);
944 RSA
*evp_pkey_get0_RSA_int(const EVP_PKEY
*pkey
);
947 /* Get internal identification number routines */
948 int evp_asym_cipher_get_number(const EVP_ASYM_CIPHER
*cipher
);
949 int evp_cipher_get_number(const EVP_CIPHER
*cipher
);
950 int evp_kdf_get_number(const EVP_KDF
*kdf
);
951 int evp_kem_get_number(const EVP_KEM
*wrap
);
952 int evp_keyexch_get_number(const EVP_KEYEXCH
*keyexch
);
953 int evp_keymgmt_get_number(const EVP_KEYMGMT
*keymgmt
);
954 int evp_keymgmt_get_legacy_alg(const EVP_KEYMGMT
*keymgmt
);
955 int evp_mac_get_number(const EVP_MAC
*mac
);
956 int evp_md_get_number(const EVP_MD
*md
);
957 int evp_rand_get_number(const EVP_RAND
*rand
);
958 int evp_rand_can_seed(EVP_RAND_CTX
*ctx
);
959 size_t evp_rand_get_seed(EVP_RAND_CTX
*ctx
,
960 unsigned char **buffer
,
961 int entropy
, size_t min_len
, size_t max_len
,
962 int prediction_resistance
,
963 const unsigned char *adin
, size_t adin_len
);
964 void evp_rand_clear_seed(EVP_RAND_CTX
*ctx
,
965 unsigned char *buffer
, size_t b_len
);
966 int evp_signature_get_number(const EVP_SIGNATURE
*signature
);
968 int evp_pkey_decrypt_alloc(EVP_PKEY_CTX
*ctx
, unsigned char **outp
,
969 size_t *outlenp
, size_t expected_outlen
,
970 const unsigned char *in
, size_t inlen
);
972 #endif /* OSSL_CRYPTO_EVP_H */