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 */
38 EVP_KEYEXCH
*exchange
;
43 EVP_SIGNATURE
*signature
;
48 EVP_ASYM_CIPHER
*cipher
;
53 /* Legacy fields below */
55 /* Method associated with this operation */
56 const EVP_PKEY_METHOD
*pmeth
;
57 /* Engine that implements this method or NULL if builtin */
59 /* Key: may be NULL */
61 /* Peer key for key agreement, may be NULL */
63 /* Algorithm specific data */
65 /* Application specific data */
68 EVP_PKEY_gen_cb
*pkey_gencb
;
69 /* implementation specific keygen data */
71 int keygen_info_count
;
72 } /* EVP_PKEY_CTX */ ;
74 #define EVP_PKEY_FLAG_DYNAMIC 1
76 struct evp_pkey_method_st
{
79 int (*init
) (EVP_PKEY_CTX
*ctx
);
80 int (*copy
) (EVP_PKEY_CTX
*dst
, const EVP_PKEY_CTX
*src
);
81 void (*cleanup
) (EVP_PKEY_CTX
*ctx
);
82 int (*paramgen_init
) (EVP_PKEY_CTX
*ctx
);
83 int (*paramgen
) (EVP_PKEY_CTX
*ctx
, EVP_PKEY
*pkey
);
84 int (*keygen_init
) (EVP_PKEY_CTX
*ctx
);
85 int (*keygen
) (EVP_PKEY_CTX
*ctx
, EVP_PKEY
*pkey
);
86 int (*sign_init
) (EVP_PKEY_CTX
*ctx
);
87 int (*sign
) (EVP_PKEY_CTX
*ctx
, unsigned char *sig
, size_t *siglen
,
88 const unsigned char *tbs
, size_t tbslen
);
89 int (*verify_init
) (EVP_PKEY_CTX
*ctx
);
90 int (*verify
) (EVP_PKEY_CTX
*ctx
,
91 const unsigned char *sig
, size_t siglen
,
92 const unsigned char *tbs
, size_t tbslen
);
93 int (*verify_recover_init
) (EVP_PKEY_CTX
*ctx
);
94 int (*verify_recover
) (EVP_PKEY_CTX
*ctx
,
95 unsigned char *rout
, size_t *routlen
,
96 const unsigned char *sig
, size_t siglen
);
97 int (*signctx_init
) (EVP_PKEY_CTX
*ctx
, EVP_MD_CTX
*mctx
);
98 int (*signctx
) (EVP_PKEY_CTX
*ctx
, unsigned char *sig
, size_t *siglen
,
100 int (*verifyctx_init
) (EVP_PKEY_CTX
*ctx
, EVP_MD_CTX
*mctx
);
101 int (*verifyctx
) (EVP_PKEY_CTX
*ctx
, const unsigned char *sig
, int siglen
,
103 int (*encrypt_init
) (EVP_PKEY_CTX
*ctx
);
104 int (*encrypt
) (EVP_PKEY_CTX
*ctx
, unsigned char *out
, size_t *outlen
,
105 const unsigned char *in
, size_t inlen
);
106 int (*decrypt_init
) (EVP_PKEY_CTX
*ctx
);
107 int (*decrypt
) (EVP_PKEY_CTX
*ctx
, unsigned char *out
, size_t *outlen
,
108 const unsigned char *in
, size_t inlen
);
109 int (*derive_init
) (EVP_PKEY_CTX
*ctx
);
110 int (*derive
) (EVP_PKEY_CTX
*ctx
, unsigned char *key
, size_t *keylen
);
111 int (*ctrl
) (EVP_PKEY_CTX
*ctx
, int type
, int p1
, void *p2
);
112 int (*ctrl_str
) (EVP_PKEY_CTX
*ctx
, const char *type
, const char *value
);
113 int (*digestsign
) (EVP_MD_CTX
*ctx
, unsigned char *sig
, size_t *siglen
,
114 const unsigned char *tbs
, size_t tbslen
);
115 int (*digestverify
) (EVP_MD_CTX
*ctx
, const unsigned char *sig
,
116 size_t siglen
, const unsigned char *tbs
,
118 int (*check
) (EVP_PKEY
*pkey
);
119 int (*public_check
) (EVP_PKEY
*pkey
);
120 int (*param_check
) (EVP_PKEY
*pkey
);
122 int (*digest_custom
) (EVP_PKEY_CTX
*ctx
, EVP_MD_CTX
*mctx
);
123 } /* EVP_PKEY_METHOD */ ;
125 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD
)
127 void evp_pkey_set_cb_translate(BN_GENCB
*cb
, EVP_PKEY_CTX
*ctx
);
129 const EVP_PKEY_METHOD
*cmac_pkey_method(void);
130 const EVP_PKEY_METHOD
*dh_pkey_method(void);
131 const EVP_PKEY_METHOD
*dhx_pkey_method(void);
132 const EVP_PKEY_METHOD
*dsa_pkey_method(void);
133 const EVP_PKEY_METHOD
*ec_pkey_method(void);
134 const EVP_PKEY_METHOD
*sm2_pkey_method(void);
135 const EVP_PKEY_METHOD
*ecx25519_pkey_method(void);
136 const EVP_PKEY_METHOD
*ecx448_pkey_method(void);
137 const EVP_PKEY_METHOD
*ed25519_pkey_method(void);
138 const EVP_PKEY_METHOD
*ed448_pkey_method(void);
139 const EVP_PKEY_METHOD
*hmac_pkey_method(void);
140 const EVP_PKEY_METHOD
*rsa_pkey_method(void);
141 const EVP_PKEY_METHOD
*rsa_pss_pkey_method(void);
142 const EVP_PKEY_METHOD
*scrypt_pkey_method(void);
143 const EVP_PKEY_METHOD
*tls1_prf_pkey_method(void);
144 const EVP_PKEY_METHOD
*hkdf_pkey_method(void);
145 const EVP_PKEY_METHOD
*poly1305_pkey_method(void);
146 const EVP_PKEY_METHOD
*siphash_pkey_method(void);
152 CRYPTO_REF_COUNT refcnt
;
155 OSSL_OP_mac_newctx_fn
*newctx
;
156 OSSL_OP_mac_dupctx_fn
*dupctx
;
157 OSSL_OP_mac_freectx_fn
*freectx
;
158 OSSL_OP_mac_size_fn
*size
;
159 OSSL_OP_mac_init_fn
*init
;
160 OSSL_OP_mac_update_fn
*update
;
161 OSSL_OP_mac_final_fn
*final
;
162 OSSL_OP_mac_gettable_params_fn
*gettable_params
;
163 OSSL_OP_mac_gettable_ctx_params_fn
*gettable_ctx_params
;
164 OSSL_OP_mac_settable_ctx_params_fn
*settable_ctx_params
;
165 OSSL_OP_mac_get_params_fn
*get_params
;
166 OSSL_OP_mac_get_ctx_params_fn
*get_ctx_params
;
167 OSSL_OP_mac_set_ctx_params_fn
*set_ctx_params
;
173 CRYPTO_REF_COUNT refcnt
;
176 OSSL_OP_kdf_newctx_fn
*newctx
;
177 OSSL_OP_kdf_dupctx_fn
*dupctx
;
178 OSSL_OP_kdf_freectx_fn
*freectx
;
179 OSSL_OP_kdf_reset_fn
*reset
;
180 OSSL_OP_kdf_derive_fn
*derive
;
181 OSSL_OP_kdf_gettable_params_fn
*gettable_params
;
182 OSSL_OP_kdf_gettable_ctx_params_fn
*gettable_ctx_params
;
183 OSSL_OP_kdf_settable_ctx_params_fn
*settable_ctx_params
;
184 OSSL_OP_kdf_get_params_fn
*get_params
;
185 OSSL_OP_kdf_get_ctx_params_fn
*get_ctx_params
;
186 OSSL_OP_kdf_set_ctx_params_fn
*set_ctx_params
;
193 /* Legacy structure members */
194 /* TODO(3.0): Remove these */
198 int (*init
) (EVP_MD_CTX
*ctx
);
199 int (*update
) (EVP_MD_CTX
*ctx
, const void *data
, size_t count
);
200 int (*final
) (EVP_MD_CTX
*ctx
, unsigned char *md
);
201 int (*copy
) (EVP_MD_CTX
*to
, const EVP_MD_CTX
*from
);
202 int (*cleanup
) (EVP_MD_CTX
*ctx
);
204 int ctx_size
; /* how big does the ctx->md_data need to be */
205 /* control function */
206 int (*md_ctrl
) (EVP_MD_CTX
*ctx
, int cmd
, int p1
, void *p2
);
208 /* New structure members */
209 /* TODO(3.0): Remove above comment when legacy has gone */
212 CRYPTO_REF_COUNT refcnt
;
214 OSSL_OP_digest_newctx_fn
*newctx
;
215 OSSL_OP_digest_init_fn
*dinit
;
216 OSSL_OP_digest_update_fn
*dupdate
;
217 OSSL_OP_digest_final_fn
*dfinal
;
218 OSSL_OP_digest_digest_fn
*digest
;
219 OSSL_OP_digest_freectx_fn
*freectx
;
220 OSSL_OP_digest_dupctx_fn
*dupctx
;
221 OSSL_OP_digest_get_params_fn
*get_params
;
222 OSSL_OP_digest_set_ctx_params_fn
*set_ctx_params
;
223 OSSL_OP_digest_get_ctx_params_fn
*get_ctx_params
;
224 OSSL_OP_digest_gettable_params_fn
*gettable_params
;
225 OSSL_OP_digest_settable_ctx_params_fn
*settable_ctx_params
;
226 OSSL_OP_digest_gettable_ctx_params_fn
*gettable_ctx_params
;
230 struct evp_cipher_st
{
234 /* Default value for variable length ciphers */
238 /* Legacy structure members */
239 /* TODO(3.0): Remove these */
243 int (*init
) (EVP_CIPHER_CTX
*ctx
, const unsigned char *key
,
244 const unsigned char *iv
, int enc
);
245 /* encrypt/decrypt data */
246 int (*do_cipher
) (EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
247 const unsigned char *in
, size_t inl
);
249 int (*cleanup
) (EVP_CIPHER_CTX
*);
250 /* how big ctx->cipher_data needs to be */
252 /* Populate a ASN1_TYPE with parameters */
253 int (*set_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
254 /* Get parameters from a ASN1_TYPE */
255 int (*get_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
256 /* Miscellaneous operations */
257 int (*ctrl
) (EVP_CIPHER_CTX
*, int type
, int arg
, void *ptr
);
258 /* Application data */
261 /* New structure members */
262 /* TODO(3.0): Remove above comment when legacy has gone */
265 CRYPTO_REF_COUNT refcnt
;
267 OSSL_OP_cipher_newctx_fn
*newctx
;
268 OSSL_OP_cipher_encrypt_init_fn
*einit
;
269 OSSL_OP_cipher_decrypt_init_fn
*dinit
;
270 OSSL_OP_cipher_update_fn
*cupdate
;
271 OSSL_OP_cipher_final_fn
*cfinal
;
272 OSSL_OP_cipher_cipher_fn
*ccipher
;
273 OSSL_OP_cipher_freectx_fn
*freectx
;
274 OSSL_OP_cipher_dupctx_fn
*dupctx
;
275 OSSL_OP_cipher_get_params_fn
*get_params
;
276 OSSL_OP_cipher_get_ctx_params_fn
*get_ctx_params
;
277 OSSL_OP_cipher_set_ctx_params_fn
*set_ctx_params
;
278 OSSL_OP_cipher_gettable_params_fn
*gettable_params
;
279 OSSL_OP_cipher_gettable_ctx_params_fn
*gettable_ctx_params
;
280 OSSL_OP_cipher_settable_ctx_params_fn
*settable_ctx_params
;
283 /* Macros to code block cipher wrappers */
285 /* Wrapper functions for each cipher mode */
287 #define EVP_C_DATA(kstruct, ctx) \
288 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
290 #define BLOCK_CIPHER_ecb_loop() \
292 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
293 if (inl < bl) return 1;\
295 for (i=0; i <= inl; i+=bl)
297 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
298 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
300 BLOCK_CIPHER_ecb_loop() \
301 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
305 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
307 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
308 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
310 while(inl>=EVP_MAXCHUNK) {\
311 int num = EVP_CIPHER_CTX_num(ctx);\
312 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
313 EVP_CIPHER_CTX_set_num(ctx, num);\
319 int num = EVP_CIPHER_CTX_num(ctx);\
320 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
321 EVP_CIPHER_CTX_set_num(ctx, num);\
326 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
327 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
329 while(inl>=EVP_MAXCHUNK) \
331 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));\
337 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
341 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
342 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
344 size_t chunk = EVP_MAXCHUNK;\
345 if (cbits == 1) chunk >>= 3;\
346 if (inl < chunk) chunk = inl;\
347 while (inl && inl >= chunk)\
349 int num = EVP_CIPHER_CTX_num(ctx);\
350 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
352 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
353 ? chunk*8 : chunk), \
354 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
355 &num, EVP_CIPHER_CTX_encrypting(ctx));\
356 EVP_CIPHER_CTX_set_num(ctx, num);\
360 if (inl < chunk) chunk = inl;\
365 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
366 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
367 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
368 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
369 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
371 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
372 key_len, iv_len, flags, init_key, cleanup, \
373 set_asn1, get_asn1, ctrl) \
374 static const EVP_CIPHER cname##_##mode = { \
375 nid##_##nmode, block_size, key_len, iv_len, \
376 flags | EVP_CIPH_##MODE##_MODE, \
378 cname##_##mode##_cipher, \
385 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
387 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
388 iv_len, flags, init_key, cleanup, set_asn1, \
390 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
391 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
393 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
394 iv_len, cbits, flags, init_key, cleanup, \
395 set_asn1, get_asn1, ctrl) \
396 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
397 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
400 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
401 iv_len, cbits, flags, init_key, cleanup, \
402 set_asn1, get_asn1, ctrl) \
403 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
404 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
407 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
408 flags, init_key, cleanup, set_asn1, \
410 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
411 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
413 #define BLOCK_CIPHER_defs(cname, kstruct, \
414 nid, block_size, key_len, iv_len, cbits, flags, \
415 init_key, cleanup, set_asn1, get_asn1, ctrl) \
416 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
417 init_key, cleanup, set_asn1, get_asn1, ctrl) \
418 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
419 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
420 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
421 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
422 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
423 init_key, cleanup, set_asn1, get_asn1, ctrl)
426 #define BLOCK_CIPHER_defs(cname, kstruct, \
427 nid, block_size, key_len, iv_len, flags,\
428 init_key, cleanup, set_asn1, get_asn1, ctrl)\
429 static const EVP_CIPHER cname##_cbc = {\
430 nid##_cbc, block_size, key_len, iv_len, \
431 flags | EVP_CIPH_CBC_MODE,\
435 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
436 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
441 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
442 static const EVP_CIPHER cname##_cfb = {\
443 nid##_cfb64, 1, key_len, iv_len, \
444 flags | EVP_CIPH_CFB_MODE,\
448 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
449 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
454 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
455 static const EVP_CIPHER cname##_ofb = {\
456 nid##_ofb64, 1, key_len, iv_len, \
457 flags | EVP_CIPH_OFB_MODE,\
461 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
462 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
467 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
468 static const EVP_CIPHER cname##_ecb = {\
469 nid##_ecb, block_size, key_len, iv_len, \
470 flags | EVP_CIPH_ECB_MODE,\
474 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
475 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
480 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
483 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
484 block_size, key_len, iv_len, cbits, \
486 cleanup, set_asn1, get_asn1, ctrl) \
487 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
488 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
489 cbits, flags, init_key, cleanup, set_asn1, \
492 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
493 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
494 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
495 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
496 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
497 cipher##_init_key, NULL, NULL, NULL, NULL)
500 * Type needs to be a bit field Sub-type needs to be for variations on the
501 * method, as in, can it do arbitrary encryption....
504 /* == Legacy attributes == */
509 * Legacy key "origin" is composed of a pointer to an EVP_PKEY_ASN1_METHOD,
510 * a pointer to a low level key and possibly a pointer to an engine.
512 const EVP_PKEY_ASN1_METHOD
*ameth
;
514 ENGINE
*pmeth_engine
; /* If not NULL public key ENGINE to use */
517 # ifndef OPENSSL_NO_RSA
518 struct rsa_st
*rsa
; /* RSA */
520 # ifndef OPENSSL_NO_DSA
521 struct dsa_st
*dsa
; /* DSA */
523 # ifndef OPENSSL_NO_DH
524 struct dh_st
*dh
; /* DH */
526 # ifndef OPENSSL_NO_EC
527 struct ec_key_st
*ec
; /* ECC */
528 ECX_KEY
*ecx
; /* X25519, X448, Ed25519, Ed448 */
532 /* == Common attributes == */
533 CRYPTO_REF_COUNT references
;
535 STACK_OF(X509_ATTRIBUTE
) *attributes
; /* [ 0 ] */
538 /* == Provider attributes == */
541 * Provider keydata "origin" is composed of a pointer to an EVP_KEYMGMT
542 * and a pointer to the provider side key data. This is never used at
543 * the same time as the legacy key data above.
545 EVP_KEYMGMT
*keymgmt
;
548 * If any libcrypto code does anything that may modify the keydata
549 * contents, this dirty counter must be incremented.
554 * To support transparent execution of operation in backends other
555 * than the "origin" key, we support transparent export/import to
556 * those providers, and maintain a cache of the imported keydata,
557 * so we don't need to redo the export/import every time we perform
558 * the same operation in that same provider.
559 * This requires that the "origin" backend (whether it's a legacy or a
560 * provider "origin") implements exports, and that the target provider
561 * has an EVP_KEYMGMT that implements import.
563 * The cache limit is set at 10 different providers using the same
564 * "origin". It's probably over the top, but is preferable to too
568 EVP_KEYMGMT
*keymgmt
;
570 } operation_cache
[10];
572 * We keep a copy of that "origin"'s dirty count, so we know if the
573 * operation cache needs flushing.
575 size_t dirty_cnt_copy
;
577 /* Cache of key object information */
585 #define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
586 ((ctx)->operation == EVP_PKEY_OP_SIGN \
587 || (ctx)->operation == EVP_PKEY_OP_SIGNCTX \
588 || (ctx)->operation == EVP_PKEY_OP_VERIFY \
589 || (ctx)->operation == EVP_PKEY_OP_VERIFYCTX \
590 || (ctx)->operation == EVP_PKEY_OP_VERIFYRECOVER)
592 #define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
593 ((ctx)->operation == EVP_PKEY_OP_DERIVE)
595 #define EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx) \
596 ((ctx)->operation == EVP_PKEY_OP_ENCRYPT \
597 || (ctx)->operation == EVP_PKEY_OP_DECRYPT)
599 void openssl_add_all_ciphers_int(void);
600 void openssl_add_all_digests_int(void);
601 void evp_cleanup_int(void);
602 void evp_app_cleanup_int(void);
603 void *evp_pkey_export_to_provider(EVP_PKEY
*pk
, OPENSSL_CTX
*libctx
,
604 EVP_KEYMGMT
**keymgmt
,
605 const char *propquery
);
606 void *evp_pkey_upgrade_to_provider(EVP_PKEY
*pk
, OPENSSL_CTX
*libctx
,
607 EVP_KEYMGMT
**keymgmt
,
608 const char *propquery
);
611 * KEYMGMT utility functions
613 void *evp_keymgmt_util_export_to_provider(EVP_PKEY
*pk
, EVP_KEYMGMT
*keymgmt
);
614 size_t evp_keymgmt_util_find_operation_cache_index(EVP_PKEY
*pk
,
615 EVP_KEYMGMT
*keymgmt
);
616 void evp_keymgmt_util_clear_operation_cache(EVP_PKEY
*pk
);
617 int evp_keymgmt_util_cache_keydata(EVP_PKEY
*pk
, size_t index
,
618 EVP_KEYMGMT
*keymgmt
, void *keydata
);
619 void evp_keymgmt_util_cache_keyinfo(EVP_PKEY
*pk
);
620 void *evp_keymgmt_util_fromdata(EVP_PKEY
*target
, EVP_KEYMGMT
*keymgmt
,
621 int selection
, const OSSL_PARAM params
[]);
622 int evp_keymgmt_util_has(EVP_PKEY
*pk
, int selection
);
626 * KEYMGMT provider interface functions
628 void *evp_keymgmt_newdata(const EVP_KEYMGMT
*keymgmt
);
629 void evp_keymgmt_freedata(const EVP_KEYMGMT
*keymgmt
, void *keyddata
);
630 int evp_keymgmt_get_params(const EVP_KEYMGMT
*keymgmt
,
631 void *keydata
, OSSL_PARAM params
[]);
632 const OSSL_PARAM
*evp_keymgmt_gettable_params(const EVP_KEYMGMT
*keymgmt
);
633 int evp_keymgmt_set_params(const EVP_KEYMGMT
*keymgmt
,
634 void *keydata
, const OSSL_PARAM params
[]);
635 const OSSL_PARAM
*evp_keymgmt_settable_params(const EVP_KEYMGMT
*keymgmt
);
638 int evp_keymgmt_has(const EVP_KEYMGMT
*keymgmt
, void *keyddata
, int selection
);
639 int evp_keymgmt_validate(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
641 int evp_keymgmt_match(const EVP_KEYMGMT
*keymgmt
,
642 const void *keydata1
, const void *keydata2
,
645 int evp_keymgmt_import(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
646 int selection
, const OSSL_PARAM params
[]);
647 const OSSL_PARAM
*evp_keymgmt_import_types(const EVP_KEYMGMT
*keymgmt
,
649 int evp_keymgmt_export(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
650 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
);
651 const OSSL_PARAM
*evp_keymgmt_export_types(const EVP_KEYMGMT
*keymgmt
,
654 /* Pulling defines out of C source files */
656 #define EVP_RC4_KEY_SIZE 16
657 #ifndef TLS1_1_VERSION
658 # define TLS1_1_VERSION 0x0302
661 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX
*ctx
, unsigned int flags
);
663 /* EVP_ENCODE_CTX flags */
664 /* Don't generate new lines when encoding */
665 #define EVP_ENCODE_CTX_NO_NEWLINES 1
666 /* Use the SRP base64 alphabet instead of the standard one */
667 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2
669 const EVP_CIPHER
*evp_get_cipherbyname_ex(OPENSSL_CTX
*libctx
, const char *name
);
670 const EVP_MD
*evp_get_digestbyname_ex(OPENSSL_CTX
*libctx
, const char *name
);
674 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
676 * Return 1 on success, 0 or negative for errors.
678 * In particular they return -2 if any of the params is not supported.
680 * They are not available in FIPS_MODE as they depend on
681 * - EVP_PKEY_CTX_{get,set}_params()
682 * - EVP_PKEY_CTX_{gettable,settable}_params()
685 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
686 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
);
687 #endif /* !defined(FIPS_MODE) */