2 * Copyright 2015-2018 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 #include <openssl/evp.h>
11 #include <openssl/core_numbers.h>
12 #include "internal/refcount.h"
13 #include "crypto/ecx.h"
16 * Don't free up md_ctx->pctx in EVP_MD_CTX_reset, use the reserved flag
19 #define EVP_MD_CTX_FLAG_KEEP_PKEY_CTX 0x0400
21 struct evp_pkey_ctx_st {
22 /* Actual operation */
26 * Library context, Key type name and properties associated
31 const char *propquery;
33 /* cached key manager */
42 EVP_KEYEXCH *exchange;
47 EVP_SIGNATURE *signature;
52 EVP_ASYM_CIPHER *cipher;
57 /* Application specific data, usually used by the callback */
60 EVP_PKEY_gen_cb *pkey_gencb;
61 /* implementation specific keygen data */
63 int keygen_info_count;
65 /* Legacy fields below */
67 /* Method associated with this operation */
68 const EVP_PKEY_METHOD *pmeth;
69 /* Engine that implements this method or NULL if builtin */
71 /* Key: may be NULL */
73 /* Peer key for key agreement, may be NULL */
75 /* Algorithm specific data */
77 /* Indicator if digest_custom needs to be called */
78 unsigned int flag_call_digest_custom:1;
79 } /* EVP_PKEY_CTX */ ;
81 #define EVP_PKEY_FLAG_DYNAMIC 1
83 struct evp_pkey_method_st {
86 int (*init) (EVP_PKEY_CTX *ctx);
87 int (*copy) (EVP_PKEY_CTX *dst, const EVP_PKEY_CTX *src);
88 void (*cleanup) (EVP_PKEY_CTX *ctx);
89 int (*paramgen_init) (EVP_PKEY_CTX *ctx);
90 int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
91 int (*keygen_init) (EVP_PKEY_CTX *ctx);
92 int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
93 int (*sign_init) (EVP_PKEY_CTX *ctx);
94 int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
95 const unsigned char *tbs, size_t tbslen);
96 int (*verify_init) (EVP_PKEY_CTX *ctx);
97 int (*verify) (EVP_PKEY_CTX *ctx,
98 const unsigned char *sig, size_t siglen,
99 const unsigned char *tbs, size_t tbslen);
100 int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
101 int (*verify_recover) (EVP_PKEY_CTX *ctx,
102 unsigned char *rout, size_t *routlen,
103 const unsigned char *sig, size_t siglen);
104 int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
105 int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
107 int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
108 int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
110 int (*encrypt_init) (EVP_PKEY_CTX *ctx);
111 int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
112 const unsigned char *in, size_t inlen);
113 int (*decrypt_init) (EVP_PKEY_CTX *ctx);
114 int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
115 const unsigned char *in, size_t inlen);
116 int (*derive_init) (EVP_PKEY_CTX *ctx);
117 int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
118 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
119 int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
120 int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
121 const unsigned char *tbs, size_t tbslen);
122 int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
123 size_t siglen, const unsigned char *tbs,
125 int (*check) (EVP_PKEY *pkey);
126 int (*public_check) (EVP_PKEY *pkey);
127 int (*param_check) (EVP_PKEY *pkey);
129 int (*digest_custom) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
130 } /* EVP_PKEY_METHOD */ ;
132 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
134 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
136 const EVP_PKEY_METHOD *cmac_pkey_method(void);
137 const EVP_PKEY_METHOD *dh_pkey_method(void);
138 const EVP_PKEY_METHOD *dhx_pkey_method(void);
139 const EVP_PKEY_METHOD *dsa_pkey_method(void);
140 const EVP_PKEY_METHOD *ec_pkey_method(void);
141 const EVP_PKEY_METHOD *sm2_pkey_method(void);
142 const EVP_PKEY_METHOD *ecx25519_pkey_method(void);
143 const EVP_PKEY_METHOD *ecx448_pkey_method(void);
144 const EVP_PKEY_METHOD *ed25519_pkey_method(void);
145 const EVP_PKEY_METHOD *ed448_pkey_method(void);
146 const EVP_PKEY_METHOD *hmac_pkey_method(void);
147 const EVP_PKEY_METHOD *rsa_pkey_method(void);
148 const EVP_PKEY_METHOD *rsa_pss_pkey_method(void);
149 const EVP_PKEY_METHOD *scrypt_pkey_method(void);
150 const EVP_PKEY_METHOD *tls1_prf_pkey_method(void);
151 const EVP_PKEY_METHOD *hkdf_pkey_method(void);
152 const EVP_PKEY_METHOD *poly1305_pkey_method(void);
153 const EVP_PKEY_METHOD *siphash_pkey_method(void);
159 CRYPTO_REF_COUNT refcnt;
162 OSSL_OP_mac_newctx_fn *newctx;
163 OSSL_OP_mac_dupctx_fn *dupctx;
164 OSSL_OP_mac_freectx_fn *freectx;
165 OSSL_OP_mac_size_fn *size;
166 OSSL_OP_mac_init_fn *init;
167 OSSL_OP_mac_update_fn *update;
168 OSSL_OP_mac_final_fn *final;
169 OSSL_OP_mac_gettable_params_fn *gettable_params;
170 OSSL_OP_mac_gettable_ctx_params_fn *gettable_ctx_params;
171 OSSL_OP_mac_settable_ctx_params_fn *settable_ctx_params;
172 OSSL_OP_mac_get_params_fn *get_params;
173 OSSL_OP_mac_get_ctx_params_fn *get_ctx_params;
174 OSSL_OP_mac_set_ctx_params_fn *set_ctx_params;
180 CRYPTO_REF_COUNT refcnt;
183 OSSL_OP_kdf_newctx_fn *newctx;
184 OSSL_OP_kdf_dupctx_fn *dupctx;
185 OSSL_OP_kdf_freectx_fn *freectx;
186 OSSL_OP_kdf_reset_fn *reset;
187 OSSL_OP_kdf_derive_fn *derive;
188 OSSL_OP_kdf_gettable_params_fn *gettable_params;
189 OSSL_OP_kdf_gettable_ctx_params_fn *gettable_ctx_params;
190 OSSL_OP_kdf_settable_ctx_params_fn *settable_ctx_params;
191 OSSL_OP_kdf_get_params_fn *get_params;
192 OSSL_OP_kdf_get_ctx_params_fn *get_ctx_params;
193 OSSL_OP_kdf_set_ctx_params_fn *set_ctx_params;
200 /* Legacy structure members */
201 /* TODO(3.0): Remove these */
205 int (*init) (EVP_MD_CTX *ctx);
206 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
207 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
208 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
209 int (*cleanup) (EVP_MD_CTX *ctx);
211 int ctx_size; /* how big does the ctx->md_data need to be */
212 /* control function */
213 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
215 /* New structure members */
216 /* TODO(3.0): Remove above comment when legacy has gone */
219 CRYPTO_REF_COUNT refcnt;
221 OSSL_OP_digest_newctx_fn *newctx;
222 OSSL_OP_digest_init_fn *dinit;
223 OSSL_OP_digest_update_fn *dupdate;
224 OSSL_OP_digest_final_fn *dfinal;
225 OSSL_OP_digest_digest_fn *digest;
226 OSSL_OP_digest_freectx_fn *freectx;
227 OSSL_OP_digest_dupctx_fn *dupctx;
228 OSSL_OP_digest_get_params_fn *get_params;
229 OSSL_OP_digest_set_ctx_params_fn *set_ctx_params;
230 OSSL_OP_digest_get_ctx_params_fn *get_ctx_params;
231 OSSL_OP_digest_gettable_params_fn *gettable_params;
232 OSSL_OP_digest_settable_ctx_params_fn *settable_ctx_params;
233 OSSL_OP_digest_gettable_ctx_params_fn *gettable_ctx_params;
237 struct evp_cipher_st {
241 /* Default value for variable length ciphers */
245 /* Legacy structure members */
246 /* TODO(3.0): Remove these */
250 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
251 const unsigned char *iv, int enc);
252 /* encrypt/decrypt data */
253 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
254 const unsigned char *in, size_t inl);
256 int (*cleanup) (EVP_CIPHER_CTX *);
257 /* how big ctx->cipher_data needs to be */
259 /* Populate a ASN1_TYPE with parameters */
260 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
261 /* Get parameters from a ASN1_TYPE */
262 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
263 /* Miscellaneous operations */
264 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
265 /* Application data */
268 /* New structure members */
269 /* TODO(3.0): Remove above comment when legacy has gone */
272 CRYPTO_REF_COUNT refcnt;
274 OSSL_OP_cipher_newctx_fn *newctx;
275 OSSL_OP_cipher_encrypt_init_fn *einit;
276 OSSL_OP_cipher_decrypt_init_fn *dinit;
277 OSSL_OP_cipher_update_fn *cupdate;
278 OSSL_OP_cipher_final_fn *cfinal;
279 OSSL_OP_cipher_cipher_fn *ccipher;
280 OSSL_OP_cipher_freectx_fn *freectx;
281 OSSL_OP_cipher_dupctx_fn *dupctx;
282 OSSL_OP_cipher_get_params_fn *get_params;
283 OSSL_OP_cipher_get_ctx_params_fn *get_ctx_params;
284 OSSL_OP_cipher_set_ctx_params_fn *set_ctx_params;
285 OSSL_OP_cipher_gettable_params_fn *gettable_params;
286 OSSL_OP_cipher_gettable_ctx_params_fn *gettable_ctx_params;
287 OSSL_OP_cipher_settable_ctx_params_fn *settable_ctx_params;
290 /* Macros to code block cipher wrappers */
292 /* Wrapper functions for each cipher mode */
294 #define EVP_C_DATA(kstruct, ctx) \
295 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
297 #define BLOCK_CIPHER_ecb_loop() \
299 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
300 if (inl < bl) return 1;\
302 for (i=0; i <= inl; i+=bl)
304 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
305 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
307 BLOCK_CIPHER_ecb_loop() \
308 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
312 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
314 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
315 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
317 while(inl>=EVP_MAXCHUNK) {\
318 int num = EVP_CIPHER_CTX_num(ctx);\
319 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
320 EVP_CIPHER_CTX_set_num(ctx, num);\
326 int num = EVP_CIPHER_CTX_num(ctx);\
327 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
328 EVP_CIPHER_CTX_set_num(ctx, num);\
333 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
334 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
336 while(inl>=EVP_MAXCHUNK) \
338 cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
344 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
348 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
349 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
351 size_t chunk = EVP_MAXCHUNK;\
352 if (cbits == 1) chunk >>= 3;\
353 if (inl < chunk) chunk = inl;\
354 while (inl && inl >= chunk)\
356 int num = EVP_CIPHER_CTX_num(ctx);\
357 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
359 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
360 ? chunk*8 : chunk), \
361 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
362 &num, EVP_CIPHER_CTX_encrypting(ctx));\
363 EVP_CIPHER_CTX_set_num(ctx, num);\
367 if (inl < chunk) chunk = inl;\
372 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
373 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
374 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
375 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
376 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
378 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
379 key_len, iv_len, flags, init_key, cleanup, \
380 set_asn1, get_asn1, ctrl) \
381 static const EVP_CIPHER cname##_##mode = { \
382 nid##_##nmode, block_size, key_len, iv_len, \
383 flags | EVP_CIPH_##MODE##_MODE, \
385 cname##_##mode##_cipher, \
392 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
394 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
395 iv_len, flags, init_key, cleanup, set_asn1, \
397 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
398 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
400 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
401 iv_len, cbits, flags, init_key, cleanup, \
402 set_asn1, get_asn1, ctrl) \
403 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
404 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
407 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
408 iv_len, cbits, flags, init_key, cleanup, \
409 set_asn1, get_asn1, ctrl) \
410 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
411 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
414 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
415 flags, init_key, cleanup, set_asn1, \
417 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
418 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
420 #define BLOCK_CIPHER_defs(cname, kstruct, \
421 nid, block_size, key_len, iv_len, cbits, flags, \
422 init_key, cleanup, set_asn1, get_asn1, ctrl) \
423 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
424 init_key, cleanup, set_asn1, get_asn1, ctrl) \
425 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
426 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
427 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
428 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
429 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
430 init_key, cleanup, set_asn1, get_asn1, ctrl)
433 #define BLOCK_CIPHER_defs(cname, kstruct, \
434 nid, block_size, key_len, iv_len, flags,\
435 init_key, cleanup, set_asn1, get_asn1, ctrl)\
436 static const EVP_CIPHER cname##_cbc = {\
437 nid##_cbc, block_size, key_len, iv_len, \
438 flags | EVP_CIPH_CBC_MODE,\
442 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
443 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
448 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
449 static const EVP_CIPHER cname##_cfb = {\
450 nid##_cfb64, 1, key_len, iv_len, \
451 flags | EVP_CIPH_CFB_MODE,\
455 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
456 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
461 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
462 static const EVP_CIPHER cname##_ofb = {\
463 nid##_ofb64, 1, key_len, iv_len, \
464 flags | EVP_CIPH_OFB_MODE,\
468 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
469 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
474 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
475 static const EVP_CIPHER cname##_ecb = {\
476 nid##_ecb, block_size, key_len, iv_len, \
477 flags | EVP_CIPH_ECB_MODE,\
481 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
482 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
487 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
490 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
491 block_size, key_len, iv_len, cbits, \
493 cleanup, set_asn1, get_asn1, ctrl) \
494 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
495 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
496 cbits, flags, init_key, cleanup, set_asn1, \
499 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
500 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
501 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
502 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
503 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
504 cipher##_init_key, NULL, NULL, NULL, NULL)
507 * Type needs to be a bit field Sub-type needs to be for variations on the
508 * method, as in, can it do arbitrary encryption....
511 /* == Legacy attributes == */
516 * Legacy key "origin" is composed of a pointer to an EVP_PKEY_ASN1_METHOD,
517 * a pointer to a low level key and possibly a pointer to an engine.
519 const EVP_PKEY_ASN1_METHOD *ameth;
521 ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
524 # ifndef OPENSSL_NO_RSA
525 struct rsa_st *rsa; /* RSA */
527 # ifndef OPENSSL_NO_DSA
528 struct dsa_st *dsa; /* DSA */
530 # ifndef OPENSSL_NO_DH
531 struct dh_st *dh; /* DH */
533 # ifndef OPENSSL_NO_EC
534 struct ec_key_st *ec; /* ECC */
535 ECX_KEY *ecx; /* X25519, X448, Ed25519, Ed448 */
539 /* == Common attributes == */
540 CRYPTO_REF_COUNT references;
542 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
545 /* == Provider attributes == */
548 * Provider keydata "origin" is composed of a pointer to an EVP_KEYMGMT
549 * and a pointer to the provider side key data. This is never used at
550 * the same time as the legacy key data above.
552 EVP_KEYMGMT *keymgmt;
555 * If any libcrypto code does anything that may modify the keydata
556 * contents, this dirty counter must be incremented.
561 * To support transparent execution of operation in backends other
562 * than the "origin" key, we support transparent export/import to
563 * those providers, and maintain a cache of the imported keydata,
564 * so we don't need to redo the export/import every time we perform
565 * the same operation in that same provider.
566 * This requires that the "origin" backend (whether it's a legacy or a
567 * provider "origin") implements exports, and that the target provider
568 * has an EVP_KEYMGMT that implements import.
570 * The cache limit is set at 10 different providers using the same
571 * "origin". It's probably over the top, but is preferable to too
575 EVP_KEYMGMT *keymgmt;
577 } operation_cache[10];
579 * We keep a copy of that "origin"'s dirty count, so we know if the
580 * operation cache needs flushing.
582 size_t dirty_cnt_copy;
584 /* Cache of key object information */
592 #define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
593 ((ctx)->operation == EVP_PKEY_OP_SIGN \
594 || (ctx)->operation == EVP_PKEY_OP_SIGNCTX \
595 || (ctx)->operation == EVP_PKEY_OP_VERIFY \
596 || (ctx)->operation == EVP_PKEY_OP_VERIFYCTX \
597 || (ctx)->operation == EVP_PKEY_OP_VERIFYRECOVER)
599 #define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
600 ((ctx)->operation == EVP_PKEY_OP_DERIVE)
602 #define EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx) \
603 ((ctx)->operation == EVP_PKEY_OP_ENCRYPT \
604 || (ctx)->operation == EVP_PKEY_OP_DECRYPT)
606 #define EVP_PKEY_CTX_IS_GEN_OP(ctx) \
607 ((ctx)->operation == EVP_PKEY_OP_PARAMGEN \
608 || (ctx)->operation == EVP_PKEY_OP_KEYGEN)
610 void openssl_add_all_ciphers_int(void);
611 void openssl_add_all_digests_int(void);
612 void evp_cleanup_int(void);
613 void evp_app_cleanup_int(void);
614 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
615 EVP_KEYMGMT **keymgmt,
616 const char *propquery);
617 void *evp_pkey_upgrade_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
618 EVP_KEYMGMT **keymgmt,
619 const char *propquery);
621 void evp_pkey_free_legacy(EVP_PKEY *x);
625 * KEYMGMT utility functions
627 void *evp_keymgmt_util_export_to_provider(EVP_PKEY *pk, EVP_KEYMGMT *keymgmt);
628 size_t evp_keymgmt_util_find_operation_cache_index(EVP_PKEY *pk,
629 EVP_KEYMGMT *keymgmt);
630 void evp_keymgmt_util_clear_operation_cache(EVP_PKEY *pk);
631 int evp_keymgmt_util_cache_keydata(EVP_PKEY *pk, size_t index,
632 EVP_KEYMGMT *keymgmt, void *keydata);
633 void evp_keymgmt_util_cache_keyinfo(EVP_PKEY *pk);
634 void *evp_keymgmt_util_fromdata(EVP_PKEY *target, EVP_KEYMGMT *keymgmt,
635 int selection, const OSSL_PARAM params[]);
636 int evp_keymgmt_util_has(EVP_PKEY *pk, int selection);
637 int evp_keymgmt_util_match(EVP_PKEY *pk1, EVP_PKEY *pk2, int selection);
638 int evp_keymgmt_util_copy(EVP_PKEY *to, EVP_PKEY *from, int selection);
639 void *evp_keymgmt_util_gen(EVP_PKEY *target, EVP_KEYMGMT *keymgmt,
640 void *genctx, OSSL_CALLBACK *cb, void *cbarg);
644 * KEYMGMT provider interface functions
646 void *evp_keymgmt_newdata(const EVP_KEYMGMT *keymgmt);
647 void evp_keymgmt_freedata(const EVP_KEYMGMT *keymgmt, void *keyddata);
648 int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt,
649 void *keydata, OSSL_PARAM params[]);
650 const OSSL_PARAM *evp_keymgmt_gettable_params(const EVP_KEYMGMT *keymgmt);
651 int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt,
652 void *keydata, const OSSL_PARAM params[]);
653 const OSSL_PARAM *evp_keymgmt_settable_params(const EVP_KEYMGMT *keymgmt);
655 void *evp_keymgmt_gen_init(const EVP_KEYMGMT *keymgmt, int selection);
656 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT *keymgmt, void *genctx,
658 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT *keymgmt, void *genctx,
659 const OSSL_PARAM params[]);
661 evp_keymgmt_gen_settable_params(const EVP_KEYMGMT *keymgmt);
662 void *evp_keymgmt_gen(const EVP_KEYMGMT *keymgmt, void *genctx,
663 OSSL_CALLBACK *cb, void *cbarg);
664 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT *keymgmt, void *genctx);
666 int evp_keymgmt_has(const EVP_KEYMGMT *keymgmt, void *keyddata, int selection);
667 int evp_keymgmt_validate(const EVP_KEYMGMT *keymgmt, void *keydata,
669 int evp_keymgmt_match(const EVP_KEYMGMT *keymgmt,
670 const void *keydata1, const void *keydata2,
673 int evp_keymgmt_import(const EVP_KEYMGMT *keymgmt, void *keydata,
674 int selection, const OSSL_PARAM params[]);
675 const OSSL_PARAM *evp_keymgmt_import_types(const EVP_KEYMGMT *keymgmt,
677 int evp_keymgmt_export(const EVP_KEYMGMT *keymgmt, void *keydata,
678 int selection, OSSL_CALLBACK *param_cb, void *cbarg);
679 const OSSL_PARAM *evp_keymgmt_export_types(const EVP_KEYMGMT *keymgmt,
681 int evp_keymgmt_copy(const EVP_KEYMGMT *keymgmt,
682 void *keydata_to, const void *keydata_from,
685 /* Pulling defines out of C source files */
687 #define EVP_RC4_KEY_SIZE 16
688 #ifndef TLS1_1_VERSION
689 # define TLS1_1_VERSION 0x0302
692 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
694 /* EVP_ENCODE_CTX flags */
695 /* Don't generate new lines when encoding */
696 #define EVP_ENCODE_CTX_NO_NEWLINES 1
697 /* Use the SRP base64 alphabet instead of the standard one */
698 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2
700 const EVP_CIPHER *evp_get_cipherbyname_ex(OPENSSL_CTX *libctx, const char *name);
701 const EVP_MD *evp_get_digestbyname_ex(OPENSSL_CTX *libctx, const char *name);
705 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
707 * Return 1 on success, 0 or negative for errors.
709 * In particular they return -2 if any of the params is not supported.
711 * They are not available in FIPS_MODE as they depend on
712 * - EVP_PKEY_CTX_{get,set}_params()
713 * - EVP_PKEY_CTX_{gettable,settable}_params()
716 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params);
717 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params);
718 #endif /* !defined(FIPS_MODE) */