evp.h

Last change on this file was 109052, checked in by vboxsync, 3 weeks ago
openssl-3.4.1: Applied our changes, regenerated files, added missing files and functions. This time with a three way merge. bugref:10890
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 37.1 KB

Line
1	/*
2	* Copyright 2015-2024 The OpenSSL Project Authors. All Rights Reserved.
3	*
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
8	*/
9
10	#ifndef OSSL_CRYPTO_EVP_H
11	# define OSSL_CRYPTO_EVP_H
12	# ifndef RT_WITHOUT_PRAGMA_ONCE /* VBOX */
13	# pragma once
14	# endif /* VBOX */
15
16	# include <openssl/evp.h>
17	# include <openssl/core_dispatch.h>
18	# include "internal/refcount.h"
19	# include "crypto/ecx.h"
20
21	/*
22	* Default PKCS5 PBE KDF salt lengths
23	* In RFC 8018, PBE1 uses 8 bytes (64 bits) for its salt length.
24	* It also specifies to use at least 8 bytes for PBES2.
25	* The NIST requirement for PBKDF2 is 128 bits so we use this as the
26	* default for PBE2 (scrypt and HKDF2)
27	*/
28	# define PKCS5_DEFAULT_PBE1_SALT_LEN PKCS5_SALT_LEN
29	# define PKCS5_DEFAULT_PBE2_SALT_LEN 16
30	/*
31	* Don't free up md_ctx->pctx in EVP_MD_CTX_reset, use the reserved flag
32	* values in evp.h
33	*/
34	#define EVP_MD_CTX_FLAG_KEEP_PKEY_CTX 0x0400
35	#define EVP_MD_CTX_FLAG_FINALISED 0x0800
36
37	#define evp_pkey_ctx_is_legacy(ctx) \
38	((ctx)->keymgmt == NULL)
39	#define evp_pkey_ctx_is_provided(ctx) \
40	(!evp_pkey_ctx_is_legacy(ctx))
41
42	struct evp_pkey_ctx_st {
43	/* Actual operation */
44	int operation;
45
46	/*
47	* Library context, property query, keytype and keymgmt associated with
48	* this context
49	*/
50	OSSL_LIB_CTX *libctx;
51	char *propquery;
52	const char *keytype;
53	/* If \|pkey\| below is set, this field is always a reference to its keymgmt */
54	EVP_KEYMGMT *keymgmt;
55
56	union {
57	struct {
58	void *genctx;
59	} keymgmt;
60
61	struct {
62	EVP_KEYEXCH *exchange;
63	/*
64	* Opaque ctx returned from a providers exchange algorithm
65	* implementation OSSL_FUNC_keyexch_newctx()
66	*/
67	void *algctx;
68	} kex;
69
70	struct {
71	EVP_SIGNATURE *signature;
72	/*
73	* Opaque ctx returned from a providers signature algorithm
74	* implementation OSSL_FUNC_signature_newctx()
75	*/
76	void *algctx;
77	} sig;
78
79	struct {
80	EVP_ASYM_CIPHER *cipher;
81	/*
82	* Opaque ctx returned from a providers asymmetric cipher algorithm
83	* implementation OSSL_FUNC_asym_cipher_newctx()
84	*/
85	void *algctx;
86	} ciph;
87	struct {
88	EVP_KEM *kem;
89	/*
90	* Opaque ctx returned from a providers KEM algorithm
91	* implementation OSSL_FUNC_kem_newctx()
92	*/
93	void *algctx;
94	} encap;
95	} op;
96
97	/*
98	* Cached parameters. Inits of operations that depend on these should
99	* call evp_pkey_ctx_use_delayed_data() when the operation has been set
100	* up properly.
101	*/
102	struct {
103	/* Distinguishing Identifier, ISO/IEC 15946-3, FIPS 196 */
104	char dist_id_name; / The name used with EVP_PKEY_CTX_ctrl_str() */
105	void dist_id; / The distinguishing ID itself */
106	size_t dist_id_len; /* The length of the distinguishing ID */
107
108	/* Indicators of what has been set. Keep them together! */
109	unsigned int dist_id_set : 1;
110	} cached_parameters;
111
112	/* Application specific data, usually used by the callback */
113	void *app_data;
114	/* Keygen callback */
115	EVP_PKEY_gen_cb *pkey_gencb;
116	/* implementation specific keygen data */
117	int *keygen_info;
118	int keygen_info_count;
119
120	/* Legacy fields below */
121
122	/* EVP_PKEY identity */
123	int legacy_keytype;
124	/* Method associated with this operation */
125	const EVP_PKEY_METHOD *pmeth;
126	/* Engine that implements this method or NULL if builtin */
127	ENGINE *engine;
128	/* Key: may be NULL */
129	EVP_PKEY *pkey;
130	/* Peer key for key agreement, may be NULL */
131	EVP_PKEY *peerkey;
132	/* Algorithm specific data */
133	void *data;
134	/* Indicator if digest_custom needs to be called */
135	unsigned int flag_call_digest_custom:1;
136	/*
137	* Used to support taking custody of memory in the case of a provider being
138	* used with the deprecated EVP_PKEY_CTX_set_rsa_keygen_pubexp() API. This
139	* member should NOT be used for any other purpose and should be removed
140	* when said deprecated API is excised completely.
141	*/
142	BIGNUM *rsa_pubexp;
143	} /* EVP_PKEY_CTX */ ;
144
145	#define EVP_PKEY_FLAG_DYNAMIC 1
146
147	struct evp_pkey_method_st {
148	int pkey_id;
149	int flags;
150	int (init) (EVP_PKEY_CTX ctx);
151	int (copy) (EVP_PKEY_CTX dst, const EVP_PKEY_CTX *src);
152	void (cleanup) (EVP_PKEY_CTX ctx);
153	int (paramgen_init) (EVP_PKEY_CTX ctx);
154	int (paramgen) (EVP_PKEY_CTX ctx, EVP_PKEY *pkey);
155	int (keygen_init) (EVP_PKEY_CTX ctx);
156	int (keygen) (EVP_PKEY_CTX ctx, EVP_PKEY *pkey);
157	int (sign_init) (EVP_PKEY_CTX ctx);
158	int (sign) (EVP_PKEY_CTX ctx, unsigned char sig, size_t siglen,
159	const unsigned char *tbs, size_t tbslen);
160	int (verify_init) (EVP_PKEY_CTX ctx);
161	int (verify) (EVP_PKEY_CTX ctx,
162	const unsigned char *sig, size_t siglen,
163	const unsigned char *tbs, size_t tbslen);
164	int (verify_recover_init) (EVP_PKEY_CTX ctx);
165	int (verify_recover) (EVP_PKEY_CTX ctx,
166	unsigned char rout, size_t routlen,
167	const unsigned char *sig, size_t siglen);
168	int (signctx_init) (EVP_PKEY_CTX ctx, EVP_MD_CTX *mctx);
169	int (signctx) (EVP_PKEY_CTX ctx, unsigned char sig, size_t siglen,
170	EVP_MD_CTX *mctx);
171	int (verifyctx_init) (EVP_PKEY_CTX ctx, EVP_MD_CTX *mctx);
172	int (verifyctx) (EVP_PKEY_CTX ctx, const unsigned char *sig, int siglen,
173	EVP_MD_CTX *mctx);
174	int (encrypt_init) (EVP_PKEY_CTX ctx);
175	int (encrypt) (EVP_PKEY_CTX ctx, unsigned char out, size_t outlen,
176	const unsigned char *in, size_t inlen);
177	int (decrypt_init) (EVP_PKEY_CTX ctx);
178	int (decrypt) (EVP_PKEY_CTX ctx, unsigned char out, size_t outlen,
179	const unsigned char *in, size_t inlen);
180	int (derive_init) (EVP_PKEY_CTX ctx);
181	int (derive) (EVP_PKEY_CTX ctx, unsigned char key, size_t keylen);
182	int (ctrl) (EVP_PKEY_CTX ctx, int type, int p1, void *p2);
183	int (ctrl_str) (EVP_PKEY_CTX ctx, const char type, const char value);
184	int (digestsign) (EVP_MD_CTX ctx, unsigned char sig, size_t siglen,
185	const unsigned char *tbs, size_t tbslen);
186	int (digestverify) (EVP_MD_CTX ctx, const unsigned char *sig,
187	size_t siglen, const unsigned char *tbs,
188	size_t tbslen);
189	int (check) (EVP_PKEY pkey);
190	int (public_check) (EVP_PKEY pkey);
191	int (param_check) (EVP_PKEY pkey);
192
193	int (digest_custom) (EVP_PKEY_CTX ctx, EVP_MD_CTX *mctx);
194	} /* EVP_PKEY_METHOD */ ;
195
196	DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
197
198	void evp_pkey_set_cb_translate(BN_GENCB cb, EVP_PKEY_CTX ctx);
199
200	const EVP_PKEY_METHOD *ossl_dh_pkey_method(void);
201	const EVP_PKEY_METHOD *ossl_dhx_pkey_method(void);
202	const EVP_PKEY_METHOD *ossl_dsa_pkey_method(void);
203	const EVP_PKEY_METHOD *ossl_ec_pkey_method(void);
204	const EVP_PKEY_METHOD *ossl_ecx25519_pkey_method(void);
205	const EVP_PKEY_METHOD *ossl_ecx448_pkey_method(void);
206	const EVP_PKEY_METHOD *ossl_ed25519_pkey_method(void);
207	const EVP_PKEY_METHOD *ossl_ed448_pkey_method(void);
208	const EVP_PKEY_METHOD *ossl_rsa_pkey_method(void);
209	const EVP_PKEY_METHOD *ossl_rsa_pss_pkey_method(void);
210
211	struct evp_mac_st {
212	OSSL_PROVIDER *prov;
213	int name_id;
214	char *type_name;
215	const char *description;
216
217	CRYPTO_REF_COUNT refcnt;
218
219	OSSL_FUNC_mac_newctx_fn *newctx;
220	OSSL_FUNC_mac_dupctx_fn *dupctx;
221	OSSL_FUNC_mac_freectx_fn *freectx;
222	OSSL_FUNC_mac_init_fn *init;
223	OSSL_FUNC_mac_update_fn *update;
224	OSSL_FUNC_mac_final_fn *final;
225	OSSL_FUNC_mac_gettable_params_fn *gettable_params;
226	OSSL_FUNC_mac_gettable_ctx_params_fn *gettable_ctx_params;
227	OSSL_FUNC_mac_settable_ctx_params_fn *settable_ctx_params;
228	OSSL_FUNC_mac_get_params_fn *get_params;
229	OSSL_FUNC_mac_get_ctx_params_fn *get_ctx_params;
230	OSSL_FUNC_mac_set_ctx_params_fn *set_ctx_params;
231	};
232
233	struct evp_kdf_st {
234	OSSL_PROVIDER *prov;
235	int name_id;
236	char *type_name;
237	const char *description;
238	CRYPTO_REF_COUNT refcnt;
239
240	OSSL_FUNC_kdf_newctx_fn *newctx;
241	OSSL_FUNC_kdf_dupctx_fn *dupctx;
242	OSSL_FUNC_kdf_freectx_fn *freectx;
243	OSSL_FUNC_kdf_reset_fn *reset;
244	OSSL_FUNC_kdf_derive_fn *derive;
245	OSSL_FUNC_kdf_gettable_params_fn *gettable_params;
246	OSSL_FUNC_kdf_gettable_ctx_params_fn *gettable_ctx_params;
247	OSSL_FUNC_kdf_settable_ctx_params_fn *settable_ctx_params;
248	OSSL_FUNC_kdf_get_params_fn *get_params;
249	OSSL_FUNC_kdf_get_ctx_params_fn *get_ctx_params;
250	OSSL_FUNC_kdf_set_ctx_params_fn *set_ctx_params;
251	};
252
253	#define EVP_ORIG_DYNAMIC 0
254	#define EVP_ORIG_GLOBAL 1
255	#define EVP_ORIG_METH 2
256
257	struct evp_md_st {
258	/* nid */
259	int type;
260
261	/* Legacy structure members */
262	int pkey_type;
263	int md_size;
264	unsigned long flags;
265	int origin;
266	int (init) (EVP_MD_CTX ctx);
267	int (update) (EVP_MD_CTX ctx, const void *data, size_t count);
268	int (final) (EVP_MD_CTX ctx, unsigned char *md);
269	int (copy) (EVP_MD_CTX to, const EVP_MD_CTX *from);
270	int (cleanup) (EVP_MD_CTX ctx);
271	int block_size;
272	int ctx_size; /* how big does the ctx->md_data need to be */
273	/* control function */
274	int (md_ctrl) (EVP_MD_CTX ctx, int cmd, int p1, void *p2);
275
276	/* New structure members */
277	/* Above comment to be removed when legacy has gone */
278	int name_id;
279	char *type_name;
280	const char *description;
281	OSSL_PROVIDER *prov;
282	CRYPTO_REF_COUNT refcnt;
283	OSSL_FUNC_digest_newctx_fn *newctx;
284	OSSL_FUNC_digest_init_fn *dinit;
285	OSSL_FUNC_digest_update_fn *dupdate;
286	OSSL_FUNC_digest_final_fn *dfinal;
287	OSSL_FUNC_digest_squeeze_fn *dsqueeze;
288	OSSL_FUNC_digest_digest_fn *digest;
289	OSSL_FUNC_digest_freectx_fn *freectx;
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;
297
298	} /* EVP_MD */ ;
299
300	struct evp_cipher_st {
301	int nid;
302
303	int block_size;
304	/* Default value for variable length ciphers */
305	int key_len;
306	int iv_len;
307
308	/* Legacy structure members */
309	/* Various flags */
310	unsigned long flags;
311	/* How the EVP_CIPHER was created. */
312	int origin;
313	/* init key */
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);
319	/* cleanup ctx */
320	int (cleanup) (EVP_CIPHER_CTX );
321	/* how big ctx->cipher_data needs to be */
322	int ctx_size;
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 */
330	void *app_data;
331
332	/* New structure members */
333	/* Above comment to be removed when legacy has gone */
334	int name_id;
335	char *type_name;
336	const char *description;
337	OSSL_PROVIDER *prov;
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_freectx_fn *freectx;
346	OSSL_FUNC_cipher_dupctx_fn *dupctx;
347	OSSL_FUNC_cipher_get_params_fn *get_params;
348	OSSL_FUNC_cipher_get_ctx_params_fn *get_ctx_params;
349	OSSL_FUNC_cipher_set_ctx_params_fn *set_ctx_params;
350	OSSL_FUNC_cipher_gettable_params_fn *gettable_params;
351	OSSL_FUNC_cipher_gettable_ctx_params_fn *gettable_ctx_params;
352	OSSL_FUNC_cipher_settable_ctx_params_fn *settable_ctx_params;
353	} /* EVP_CIPHER */ ;
354
355	/* Macros to code block cipher wrappers */
356
357	/* Wrapper functions for each cipher mode */
358
359	#define EVP_C_DATA(kstruct, ctx) \
360	((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
361
362	#define BLOCK_CIPHER_ecb_loop() \
363	size_t i, bl; \
364	bl = EVP_CIPHER_CTX_get0_cipher(ctx)->block_size; \
365	if (inl < bl) return 1;\
366	inl -= bl; \
367	for (i=0; i <= inl; i+=bl)
368
369	#define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
370	static int cname##_ecb_cipher(EVP_CIPHER_CTX ctx, unsigned char out, const unsigned char *in, size_t inl) \
371	{\
372	BLOCK_CIPHER_ecb_loop() \
373	cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_is_encrypting(ctx)); \
374	return 1;\
375	}
376
377	#define EVP_MAXCHUNK ((size_t)1 << 30)
378
379	#define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
380	static int cname##_ofb_cipher(EVP_CIPHER_CTX ctx, unsigned char out, const unsigned char *in, size_t inl) \
381	{\
382	while(inl>=EVP_MAXCHUNK) {\
383	int num = EVP_CIPHER_CTX_get_num(ctx);\
384	cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
385	EVP_CIPHER_CTX_set_num(ctx, num);\
386	inl-=EVP_MAXCHUNK;\
387	in +=EVP_MAXCHUNK;\
388	out+=EVP_MAXCHUNK;\
389	}\
390	if (inl) {\
391	int num = EVP_CIPHER_CTX_get_num(ctx);\
392	cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, &num); \
393	EVP_CIPHER_CTX_set_num(ctx, num);\
394	}\
395	return 1;\
396	}
397
398	#define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
399	static int cname##_cbc_cipher(EVP_CIPHER_CTX ctx, unsigned char out, const unsigned char *in, size_t inl) \
400	{\
401	while(inl>=EVP_MAXCHUNK) {\
402	cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
403	inl-=EVP_MAXCHUNK;\
404	in +=EVP_MAXCHUNK;\
405	out+=EVP_MAXCHUNK;\
406	}\
407	if (inl)\
408	cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, ctx->iv, EVP_CIPHER_CTX_is_encrypting(ctx));\
409	return 1;\
410	}
411
412	#define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
413	static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX ctx, unsigned char out, const unsigned char *in, size_t inl) \
414	{\
415	size_t chunk = EVP_MAXCHUNK;\
416	if (cbits == 1) chunk >>= 3;\
417	if (inl < chunk) chunk = inl;\
418	while (inl && inl >= chunk) {\
419	int num = EVP_CIPHER_CTX_get_num(ctx);\
420	cprefix##_cfb##cbits##_encrypt(in, out, (long) \
421	((cbits == 1) \
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);\
427	inl -= chunk;\
428	in += chunk;\
429	out += chunk;\
430	if (inl < chunk) chunk = inl;\
431	}\
432	return 1;\
433	}
434
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)
440
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, \
447	EVP_ORIG_GLOBAL, \
448	init_key, \
449	cname##_##mode##_cipher, \
450	cleanup, \
451	sizeof(kstruct), \
452	set_asn1, get_asn1,\
453	ctrl, \
454	NULL \
455	}; \
456	const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
457
458	#define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
459	iv_len, flags, init_key, cleanup, set_asn1, \
460	get_asn1, ctrl) \
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)
463
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, \
469	get_asn1, ctrl)
470
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, \
476	get_asn1, ctrl)
477
478	#define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
479	flags, init_key, cleanup, set_asn1, \
480	get_asn1, ctrl) \
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)
483
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)
495
496	/*-
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,\
503	EVP_ORIG_GLOBAL,\
504	init_key,\
505	cname##_cbc_cipher,\
506	cleanup,\
507	sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
508	sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
509	set_asn1, get_asn1,\
510	ctrl, \
511	NULL \
512	};\
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,\
517	EVP_ORIG_GLOBAL,\
518	init_key,\
519	cname##_cfb_cipher,\
520	cleanup,\
521	sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
522	sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
523	set_asn1, get_asn1,\
524	ctrl,\
525	NULL \
526	};\
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,\
531	EVP_ORIG_GLOBAL,\
532	init_key,\
533	cname##_ofb_cipher,\
534	cleanup,\
535	sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
536	sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
537	set_asn1, get_asn1,\
538	ctrl,\
539	NULL \
540	};\
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,\
545	EVP_ORIG_GLOBAL,\
546	init_key,\
547	cname##_ecb_cipher,\
548	cleanup,\
549	sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
550	sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
551	set_asn1, get_asn1,\
552	ctrl,\
553	NULL \
554	};\
555	const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
556	*/
557
558	#define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
559	block_size, key_len, iv_len, cbits, \
560	flags, init_key, \
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, \
565	get_asn1, ctrl)
566
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)
573
574	typedef struct {
575	unsigned char iv[EVP_MAX_IV_LENGTH];
576	unsigned int iv_len;
577	unsigned int tag_len;
578	} evp_cipher_aead_asn1_params;
579
580	int evp_cipher_param_to_asn1_ex(EVP_CIPHER_CTX c, ASN1_TYPE type,
581	evp_cipher_aead_asn1_params *params);
582
583	int evp_cipher_asn1_to_param_ex(EVP_CIPHER_CTX c, ASN1_TYPE type,
584	evp_cipher_aead_asn1_params *params);
585
586	/*
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.
595	*/
596	typedef struct {
597	EVP_KEYMGMT *keymgmt;
598	void *keydata;
599	int selection;
600	} OP_CACHE_ELEM;
601
602	DEFINE_STACK_OF(OP_CACHE_ELEM)
603
604	/*
605	* An EVP_PKEY can have the following states:
606	*
607	* untyped & empty:
608	*
609	* type == EVP_PKEY_NONE && keymgmt == NULL
610	*
611	* typed & empty:
612	*
613	* (type != EVP_PKEY_NONE && pkey.ptr == NULL) ## legacy (libcrypto only)
614	* \|\| (keymgmt != NULL && keydata == NULL) ## provider side
615	*
616	* fully assigned:
617	*
618	* (type != EVP_PKEY_NONE && pkey.ptr != NULL) ## legacy (libcrypto only)
619	* \|\| (keymgmt != NULL && keydata != NULL) ## provider side
620	*
621	* The easiest way to detect a legacy key is:
622	*
623	* keymgmt == NULL && type != EVP_PKEY_NONE
624	*
625	* The easiest way to detect a provider side key is:
626	*
627	* keymgmt != NULL
628	*/
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)
633	#ifndef FIPS_MODULE
634	# define evp_pkey_is_assigned(pk) \
635	((pk)->pkey.ptr != NULL \|\| (pk)->keydata != NULL)
636	#else
637	# define evp_pkey_is_assigned(pk) \
638	((pk)->keydata != NULL)
639	#endif
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)
644
645	union legacy_pkey_st {
646	void *ptr;
647	struct rsa_st rsa; / RSA */
648	# ifndef OPENSSL_NO_DSA
649	struct dsa_st dsa; / DSA */
650	# endif
651	# ifndef OPENSSL_NO_DH
652	struct dh_st dh; / DH */
653	# endif
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 */
658	# endif
659	# endif
660	};
661
662	struct evp_pkey_st {
663	/* == Legacy attributes == */
664	int type;
665	int save_type;
666
667	# ifndef FIPS_MODULE
668	/*
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.
671	*/
672	const EVP_PKEY_ASN1_METHOD *ameth;
673	ENGINE *engine;
674	ENGINE pmeth_engine; / If not NULL public key ENGINE to use */
675
676	/* Union to store the reference to an origin legacy key */
677	union legacy_pkey_st pkey;
678
679	/* Union to store the reference to a non-origin legacy key */
680	union legacy_pkey_st legacy_cache_pkey;
681	# endif
682
683	/* == Common attributes == */
684	CRYPTO_REF_COUNT references;
685	CRYPTO_RWLOCK *lock;
686	#ifndef FIPS_MODULE
687	STACK_OF(X509_ATTRIBUTE) attributes; / [ 0 ] */
688	int save_parameters;
689	unsigned int foreign:1; /* the low-level key is using an engine or an app-method */
690	CRYPTO_EX_DATA ex_data;
691	#endif
692
693	/* == Provider attributes == */
694
695	/*
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.
699	*/
700	EVP_KEYMGMT *keymgmt;
701	void *keydata;
702	/*
703	* If any libcrypto code does anything that may modify the keydata
704	* contents, this dirty counter must be incremented.
705	*/
706	size_t dirty_cnt;
707
708	/*
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.
714	*/
715	STACK_OF(OP_CACHE_ELEM) *operation_cache;
716
717	/*
718	* We keep a copy of that "origin"'s dirty count, so we know if the
719	* operation cache needs flushing.
720	*/
721	size_t dirty_cnt_copy;
722
723	/* Cache of key object information */
724	struct {
725	int bits;
726	int security_bits;
727	int size;
728	} cache;
729	}; /* EVP_PKEY */
730
731	/* The EVP_PKEY_OP_TYPE_ macros are found in include/openssl/evp.h */
732
733	# define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
734	(((ctx)->operation & EVP_PKEY_OP_TYPE_SIG) != 0)
735
736	# define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
737	(((ctx)->operation & EVP_PKEY_OP_TYPE_DERIVE) != 0)
738
739	# define EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx) \
740	(((ctx)->operation & EVP_PKEY_OP_TYPE_CRYPT) != 0)
741
742	# define EVP_PKEY_CTX_IS_GEN_OP(ctx) \
743	(((ctx)->operation & EVP_PKEY_OP_TYPE_GEN) != 0)
744
745	# define EVP_PKEY_CTX_IS_FROMDATA_OP(ctx) \
746	(((ctx)->operation & EVP_PKEY_OP_TYPE_DATA) != 0)
747
748	# define EVP_PKEY_CTX_IS_KEM_OP(ctx) \
749	(((ctx)->operation & EVP_PKEY_OP_TYPE_KEM) != 0)
750
751	void openssl_add_all_ciphers_int(void);
752	void openssl_add_all_digests_int(void);
753	void evp_cleanup_int(void);
754	void evp_app_cleanup_int(void);
755	void evp_pkey_export_to_provider(EVP_PKEY pk, OSSL_LIB_CTX *libctx,
756	EVP_KEYMGMT **keymgmt,
757	const char *propquery);
758	#ifndef FIPS_MODULE
759	int evp_pkey_copy_downgraded(EVP_PKEY *dest, const EVP_PKEY src);
760	void evp_pkey_get_legacy(EVP_PKEY pk);
761	void evp_pkey_free_legacy(EVP_PKEY *x);
762	EVP_PKEY evp_pkcs82pkey_legacy(const PKCS8_PRIV_KEY_INFO p8inf,
763	OSSL_LIB_CTX libctx, const char propq);
764	#endif
765
766	/*
767	* KEYMGMT utility functions
768	*/
769
770	/*
771	* Key import structure and helper function, to be used as an export callback
772	*/
773	struct evp_keymgmt_util_try_import_data_st {
774	EVP_KEYMGMT *keymgmt;
775	void *keydata;
776
777	int selection;
778	};
779	int evp_keymgmt_util_try_import(const OSSL_PARAM params[], void *arg);
780	int evp_keymgmt_util_assign_pkey(EVP_PKEY pkey, EVP_KEYMGMT keymgmt,
781	void *keydata);
782	EVP_PKEY evp_keymgmt_util_make_pkey(EVP_KEYMGMT keymgmt, void *keydata);
783
784	int evp_keymgmt_util_export(const EVP_PKEY *pk, int selection,
785	OSSL_CALLBACK export_cb, void export_cbarg);
786	void evp_keymgmt_util_export_to_provider(EVP_PKEY pk, EVP_KEYMGMT *keymgmt,
787	int selection);
788	OP_CACHE_ELEM evp_keymgmt_util_find_operation_cache(EVP_PKEY pk,
789	EVP_KEYMGMT *keymgmt,
790	int selection);
791	int evp_keymgmt_util_clear_operation_cache(EVP_PKEY *pk);
792	int evp_keymgmt_util_cache_keydata(EVP_PKEY pk, EVP_KEYMGMT keymgmt,
793	void *keydata, int selection);
794	void evp_keymgmt_util_cache_keyinfo(EVP_PKEY *pk);
795	void evp_keymgmt_util_fromdata(EVP_PKEY target, EVP_KEYMGMT *keymgmt,
796	int selection, const OSSL_PARAM params[]);
797	int evp_keymgmt_util_has(EVP_PKEY *pk, int selection);
798	int evp_keymgmt_util_match(EVP_PKEY pk1, EVP_PKEY pk2, int selection);
799	int evp_keymgmt_util_copy(EVP_PKEY to, EVP_PKEY from, int selection);
800	void evp_keymgmt_util_gen(EVP_PKEY target, EVP_KEYMGMT *keymgmt,
801	void genctx, OSSL_CALLBACK cb, void *cbarg);
802	int evp_keymgmt_util_get_deflt_digest_name(EVP_KEYMGMT *keymgmt,
803	void *keydata,
804	char *mdname, size_t mdname_sz);
805	const char evp_keymgmt_util_query_operation_name(EVP_KEYMGMT keymgmt,
806	int op_id);
807
808	/*
809	* KEYMGMT provider interface functions
810	*/
811	void evp_keymgmt_newdata(const EVP_KEYMGMT keymgmt);
812	void evp_keymgmt_freedata(const EVP_KEYMGMT keymgmt, void keyddata);
813	int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt,
814	void *keydata, OSSL_PARAM params[]);
815	int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt,
816	void *keydata, const OSSL_PARAM params[]);
817	void evp_keymgmt_gen_init(const EVP_KEYMGMT keymgmt, int selection,
818	const OSSL_PARAM params[]);
819	int evp_keymgmt_gen_set_template(const EVP_KEYMGMT keymgmt, void genctx,
820	void *templ);
821	int evp_keymgmt_gen_set_params(const EVP_KEYMGMT keymgmt, void genctx,
822	const OSSL_PARAM params[]);
823	int evp_keymgmt_gen_get_params(const EVP_KEYMGMT *keymgmt,
824	void *genctx, OSSL_PARAM params[]);
825	void evp_keymgmt_gen(const EVP_KEYMGMT keymgmt, void *genctx,
826	OSSL_CALLBACK cb, void cbarg);
827	void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT keymgmt, void genctx);
828
829	int evp_keymgmt_has_load(const EVP_KEYMGMT *keymgmt);
830	void evp_keymgmt_load(const EVP_KEYMGMT keymgmt,
831	const void *objref, size_t objref_sz);
832
833	int evp_keymgmt_has(const EVP_KEYMGMT keymgmt, void keyddata, int selection);
834	int evp_keymgmt_validate(const EVP_KEYMGMT keymgmt, void keydata,
835	int selection, int checktype);
836	int evp_keymgmt_match(const EVP_KEYMGMT *keymgmt,
837	const void keydata1, const void keydata2,
838	int selection);
839
840	int evp_keymgmt_import(const EVP_KEYMGMT keymgmt, void keydata,
841	int selection, const OSSL_PARAM params[]);
842	const OSSL_PARAM evp_keymgmt_import_types(const EVP_KEYMGMT keymgmt,
843	int selection);
844	int evp_keymgmt_export(const EVP_KEYMGMT keymgmt, void keydata,
845	int selection, OSSL_CALLBACK param_cb, void cbarg);
846	const OSSL_PARAM evp_keymgmt_export_types(const EVP_KEYMGMT keymgmt,
847	int selection);
848	void evp_keymgmt_dup(const EVP_KEYMGMT keymgmt,
849	const void *keydata_from, int selection);
850	EVP_KEYMGMT evp_keymgmt_fetch_from_prov(OSSL_PROVIDER prov,
851	const char *name,
852	const char *properties);
853
854	/* Pulling defines out of C source files */
855
856	# define EVP_RC4_KEY_SIZE 16
857	# ifndef TLS1_1_VERSION
858	# define TLS1_1_VERSION 0x0302
859	# endif
860
861	void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
862
863	/* EVP_ENCODE_CTX flags */
864	/* Don't generate new lines when encoding */
865	#define EVP_ENCODE_CTX_NO_NEWLINES 1
866	/* Use the SRP base64 alphabet instead of the standard one */
867	#define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2
868
869	const EVP_CIPHER evp_get_cipherbyname_ex(OSSL_LIB_CTX libctx,
870	const char *name);
871	const EVP_MD evp_get_digestbyname_ex(OSSL_LIB_CTX libctx,
872	const char *name);
873
874	int ossl_pkcs5_pbkdf2_hmac_ex(const char *pass, int passlen,
875	const unsigned char *salt, int saltlen, int iter,
876	const EVP_MD *digest, int keylen,
877	unsigned char *out,
878	OSSL_LIB_CTX libctx, const char propq);
879
880	# ifndef FIPS_MODULE
881	/*
882	* Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
883	*
884	* Return 1 on success, 0 or negative for errors.
885	*
886	* In particular they return -2 if any of the params is not supported.
887	*
888	* They are not available in FIPS_MODULE as they depend on
889	* - EVP_PKEY_CTX_{get,set}_params()
890	* - EVP_PKEY_CTX_{gettable,settable}_params()
891	*
892	*/
893	int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX ctx, OSSL_PARAM params);
894	int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX ctx, OSSL_PARAM params);
895
896	EVP_MD_CTX evp_md_ctx_new_ex(EVP_PKEY pkey, const ASN1_OCTET_STRING *id,
897	OSSL_LIB_CTX libctx, const char propq);
898	int evp_pkey_name2type(const char *name);
899	const char *evp_pkey_type2name(int type);
900
901	int evp_pkey_ctx_use_cached_data(EVP_PKEY_CTX *ctx);
902	# endif /* !defined(FIPS_MODULE) */
903
904	int evp_method_store_cache_flush(OSSL_LIB_CTX *libctx);
905	int evp_method_store_remove_all_provided(const OSSL_PROVIDER *prov);
906
907	int evp_default_properties_enable_fips_int(OSSL_LIB_CTX *libctx, int enable,
908	int loadconfig);
909	int evp_set_default_properties_int(OSSL_LIB_CTX libctx, const char propq,
910	int loadconfig, int mirrored);
911	char evp_get_global_properties_str(OSSL_LIB_CTX libctx, int loadconfig);
912
913	void evp_md_ctx_clear_digest(EVP_MD_CTX *ctx, int force, int keep_digest);
914	/* just free the algctx if set, returns 0 on inconsistent state of ctx */
915	int evp_md_ctx_free_algctx(EVP_MD_CTX *ctx);
916
917	/* Three possible states: */
918	# define EVP_PKEY_STATE_UNKNOWN 0
919	# define EVP_PKEY_STATE_LEGACY 1
920	# define EVP_PKEY_STATE_PROVIDER 2
921	int evp_pkey_ctx_state(const EVP_PKEY_CTX *ctx);
922
923	/* These two must ONLY be called for provider side operations */
924	int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX *ctx,
925	int keytype, int optype,
926	int cmd, int p1, void *p2);
927	int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX *ctx,
928	const char name, const char value);
929
930	/* These two must ONLY be called for legacy operations */
931	int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX ctx, const OSSL_PARAM params);
932	int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX ctx, OSSL_PARAM params);
933
934	/* This must ONLY be called for legacy EVP_PKEYs */
935	int evp_pkey_get_params_to_ctrl(const EVP_PKEY pkey, OSSL_PARAM params);
936
937	/* Same as the public get0 functions but are not const */
938	# ifndef OPENSSL_NO_DEPRECATED_3_0
939	DH evp_pkey_get0_DH_int(const EVP_PKEY pkey);
940	EC_KEY evp_pkey_get0_EC_KEY_int(const EVP_PKEY pkey);
941	RSA evp_pkey_get0_RSA_int(const EVP_PKEY pkey);
942	# endif
943
944	/* Get internal identification number routines */
945	int evp_asym_cipher_get_number(const EVP_ASYM_CIPHER *cipher);
946	int evp_cipher_get_number(const EVP_CIPHER *cipher);
947	int evp_kdf_get_number(const EVP_KDF *kdf);
948	int evp_kem_get_number(const EVP_KEM *wrap);
949	int evp_keyexch_get_number(const EVP_KEYEXCH *keyexch);
950	int evp_keymgmt_get_number(const EVP_KEYMGMT *keymgmt);
951	int evp_keymgmt_get_legacy_alg(const EVP_KEYMGMT *keymgmt);
952	int evp_mac_get_number(const EVP_MAC *mac);
953	int evp_md_get_number(const EVP_MD *md);
954	int evp_rand_get_number(const EVP_RAND *rand);
955	int evp_rand_can_seed(EVP_RAND_CTX *ctx);
956	size_t evp_rand_get_seed(EVP_RAND_CTX *ctx,
957	unsigned char **buffer,
958	int entropy, size_t min_len, size_t max_len,
959	int prediction_resistance,
960	const unsigned char *adin, size_t adin_len);
961	void evp_rand_clear_seed(EVP_RAND_CTX *ctx,
962	unsigned char *buffer, size_t b_len);
963	int evp_signature_get_number(const EVP_SIGNATURE *signature);
964
965	int evp_pkey_decrypt_alloc(EVP_PKEY_CTX ctx, unsigned char *outp,
966	size_t *outlenp, size_t expected_outlen,
967	const unsigned char *in, size_t inlen);
968
969	int ossl_md2hmacnid(int mdnid);
970	int ossl_hmac2mdnid(int hmac_nid);
971
972	#endif /* OSSL_CRYPTO_EVP_H */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/libs/openssl-3.4.1/include/crypto/evp.h

Download in other formats: