2 * Copyright 2000-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 #include <openssl/core_dispatch.h>
11 #include "internal/refcount.h"
13 #define EVP_CTRL_RET_UNSUPPORTED -1
16 struct evp_md_ctx_st
{
17 const EVP_MD
*reqdigest
; /* The original requested digest */
19 ENGINE
*engine
; /* functional reference if 'digest' is
23 /* Public key context for sign/verify */
25 /* Update function: usually copied from EVP_MD */
26 int (*update
) (EVP_MD_CTX
*ctx
, const void *data
, size_t count
);
29 * Opaque ctx returned from a providers digest algorithm implementation
30 * OSSL_FUNC_digest_newctx()
33 EVP_MD
*fetched_digest
;
36 struct evp_cipher_ctx_st
{
37 const EVP_CIPHER
*cipher
;
38 ENGINE
*engine
; /* functional reference if 'cipher' is
40 int encrypt
; /* encrypt or decrypt */
41 int buf_len
; /* number we have left */
42 unsigned char oiv
[EVP_MAX_IV_LENGTH
]; /* original iv */
43 unsigned char iv
[EVP_MAX_IV_LENGTH
]; /* working iv */
44 unsigned char buf
[EVP_MAX_BLOCK_LENGTH
]; /* saved partial block */
45 int num
; /* used by cfb/ofb/ctr mode */
46 /* FIXME: Should this even exist? It appears unused */
47 void *app_data
; /* application stuff */
48 int key_len
; /* May change for variable length cipher */
49 int iv_len
; /* IV length */
50 unsigned long flags
; /* Various flags */
51 void *cipher_data
; /* per EVP data */
54 unsigned char final
[EVP_MAX_BLOCK_LENGTH
]; /* possible final block */
57 * Opaque ctx returned from a providers cipher algorithm implementation
58 * OSSL_FUNC_cipher_newctx()
61 EVP_CIPHER
*fetched_cipher
;
62 } /* EVP_CIPHER_CTX */ ;
64 struct evp_mac_ctx_st
{
65 EVP_MAC
*meth
; /* Method structure */
67 * Opaque ctx returned from a providers MAC algorithm implementation
68 * OSSL_FUNC_mac_newctx()
73 struct evp_kdf_ctx_st
{
74 EVP_KDF
*meth
; /* Method structure */
76 * Opaque ctx returned from a providers KDF algorithm implementation
77 * OSSL_FUNC_kdf_newctx()
82 struct evp_rand_ctx_st
{
83 EVP_RAND
*meth
; /* Method structure */
85 * Opaque ctx returned from a providers rand algorithm implementation
86 * OSSL_FUNC_rand_newctx()
89 EVP_RAND_CTX
*parent
; /* Parent EVP_RAND or NULL if none */
90 CRYPTO_REF_COUNT refcnt
; /* Context reference count */
91 CRYPTO_RWLOCK
*refcnt_lock
;
92 } /* EVP_RAND_CTX */ ;
94 struct evp_keymgmt_st
{
95 int id
; /* libcrypto internal */
98 /* NID for the legacy alg if there is one */
101 const char *description
;
103 CRYPTO_REF_COUNT refcnt
;
105 /* Constructor(s), destructor, information */
106 OSSL_FUNC_keymgmt_new_fn
*new;
107 OSSL_FUNC_keymgmt_free_fn
*free
;
108 OSSL_FUNC_keymgmt_get_params_fn
*get_params
;
109 OSSL_FUNC_keymgmt_gettable_params_fn
*gettable_params
;
110 OSSL_FUNC_keymgmt_set_params_fn
*set_params
;
111 OSSL_FUNC_keymgmt_settable_params_fn
*settable_params
;
113 /* Generation, a complex constructor */
114 OSSL_FUNC_keymgmt_gen_init_fn
*gen_init
;
115 OSSL_FUNC_keymgmt_gen_set_template_fn
*gen_set_template
;
116 OSSL_FUNC_keymgmt_gen_set_params_fn
*gen_set_params
;
117 OSSL_FUNC_keymgmt_gen_settable_params_fn
*gen_settable_params
;
118 OSSL_FUNC_keymgmt_gen_fn
*gen
;
119 OSSL_FUNC_keymgmt_gen_cleanup_fn
*gen_cleanup
;
121 OSSL_FUNC_keymgmt_load_fn
*load
;
123 /* Key object checking */
124 OSSL_FUNC_keymgmt_query_operation_name_fn
*query_operation_name
;
125 OSSL_FUNC_keymgmt_has_fn
*has
;
126 OSSL_FUNC_keymgmt_validate_fn
*validate
;
127 OSSL_FUNC_keymgmt_match_fn
*match
;
129 /* Import and export routines */
130 OSSL_FUNC_keymgmt_import_fn
*import
;
131 OSSL_FUNC_keymgmt_import_types_fn
*import_types
;
132 OSSL_FUNC_keymgmt_import_types_ex_fn
*import_types_ex
;
133 OSSL_FUNC_keymgmt_export_fn
*export
;
134 OSSL_FUNC_keymgmt_export_types_fn
*export_types
;
135 OSSL_FUNC_keymgmt_export_types_ex_fn
*export_types_ex
;
136 OSSL_FUNC_keymgmt_dup_fn
*dup
;
137 } /* EVP_KEYMGMT */ ;
139 struct evp_keyexch_st
{
142 const char *description
;
144 CRYPTO_REF_COUNT refcnt
;
146 OSSL_FUNC_keyexch_newctx_fn
*newctx
;
147 OSSL_FUNC_keyexch_init_fn
*init
;
148 OSSL_FUNC_keyexch_set_peer_fn
*set_peer
;
149 OSSL_FUNC_keyexch_derive_fn
*derive
;
150 OSSL_FUNC_keyexch_freectx_fn
*freectx
;
151 OSSL_FUNC_keyexch_dupctx_fn
*dupctx
;
152 OSSL_FUNC_keyexch_set_ctx_params_fn
*set_ctx_params
;
153 OSSL_FUNC_keyexch_settable_ctx_params_fn
*settable_ctx_params
;
154 OSSL_FUNC_keyexch_get_ctx_params_fn
*get_ctx_params
;
155 OSSL_FUNC_keyexch_gettable_ctx_params_fn
*gettable_ctx_params
;
158 struct evp_signature_st
{
161 const char *description
;
163 CRYPTO_REF_COUNT refcnt
;
165 OSSL_FUNC_signature_newctx_fn
*newctx
;
166 OSSL_FUNC_signature_sign_init_fn
*sign_init
;
167 OSSL_FUNC_signature_sign_fn
*sign
;
168 OSSL_FUNC_signature_verify_init_fn
*verify_init
;
169 OSSL_FUNC_signature_verify_fn
*verify
;
170 OSSL_FUNC_signature_verify_recover_init_fn
*verify_recover_init
;
171 OSSL_FUNC_signature_verify_recover_fn
*verify_recover
;
172 OSSL_FUNC_signature_digest_sign_init_fn
*digest_sign_init
;
173 OSSL_FUNC_signature_digest_sign_update_fn
*digest_sign_update
;
174 OSSL_FUNC_signature_digest_sign_final_fn
*digest_sign_final
;
175 OSSL_FUNC_signature_digest_sign_fn
*digest_sign
;
176 OSSL_FUNC_signature_digest_verify_init_fn
*digest_verify_init
;
177 OSSL_FUNC_signature_digest_verify_update_fn
*digest_verify_update
;
178 OSSL_FUNC_signature_digest_verify_final_fn
*digest_verify_final
;
179 OSSL_FUNC_signature_digest_verify_fn
*digest_verify
;
180 OSSL_FUNC_signature_freectx_fn
*freectx
;
181 OSSL_FUNC_signature_dupctx_fn
*dupctx
;
182 OSSL_FUNC_signature_get_ctx_params_fn
*get_ctx_params
;
183 OSSL_FUNC_signature_gettable_ctx_params_fn
*gettable_ctx_params
;
184 OSSL_FUNC_signature_set_ctx_params_fn
*set_ctx_params
;
185 OSSL_FUNC_signature_settable_ctx_params_fn
*settable_ctx_params
;
186 OSSL_FUNC_signature_get_ctx_md_params_fn
*get_ctx_md_params
;
187 OSSL_FUNC_signature_gettable_ctx_md_params_fn
*gettable_ctx_md_params
;
188 OSSL_FUNC_signature_set_ctx_md_params_fn
*set_ctx_md_params
;
189 OSSL_FUNC_signature_settable_ctx_md_params_fn
*settable_ctx_md_params
;
190 } /* EVP_SIGNATURE */;
192 struct evp_asym_cipher_st
{
195 const char *description
;
197 CRYPTO_REF_COUNT refcnt
;
199 OSSL_FUNC_asym_cipher_newctx_fn
*newctx
;
200 OSSL_FUNC_asym_cipher_encrypt_init_fn
*encrypt_init
;
201 OSSL_FUNC_asym_cipher_encrypt_fn
*encrypt
;
202 OSSL_FUNC_asym_cipher_decrypt_init_fn
*decrypt_init
;
203 OSSL_FUNC_asym_cipher_decrypt_fn
*decrypt
;
204 OSSL_FUNC_asym_cipher_freectx_fn
*freectx
;
205 OSSL_FUNC_asym_cipher_dupctx_fn
*dupctx
;
206 OSSL_FUNC_asym_cipher_get_ctx_params_fn
*get_ctx_params
;
207 OSSL_FUNC_asym_cipher_gettable_ctx_params_fn
*gettable_ctx_params
;
208 OSSL_FUNC_asym_cipher_set_ctx_params_fn
*set_ctx_params
;
209 OSSL_FUNC_asym_cipher_settable_ctx_params_fn
*settable_ctx_params
;
210 } /* EVP_ASYM_CIPHER */;
215 const char *description
;
217 CRYPTO_REF_COUNT refcnt
;
219 OSSL_FUNC_kem_newctx_fn
*newctx
;
220 OSSL_FUNC_kem_encapsulate_init_fn
*encapsulate_init
;
221 OSSL_FUNC_kem_encapsulate_fn
*encapsulate
;
222 OSSL_FUNC_kem_decapsulate_init_fn
*decapsulate_init
;
223 OSSL_FUNC_kem_decapsulate_fn
*decapsulate
;
224 OSSL_FUNC_kem_freectx_fn
*freectx
;
225 OSSL_FUNC_kem_dupctx_fn
*dupctx
;
226 OSSL_FUNC_kem_get_ctx_params_fn
*get_ctx_params
;
227 OSSL_FUNC_kem_gettable_ctx_params_fn
*gettable_ctx_params
;
228 OSSL_FUNC_kem_set_ctx_params_fn
*set_ctx_params
;
229 OSSL_FUNC_kem_settable_ctx_params_fn
*settable_ctx_params
;
230 OSSL_FUNC_kem_auth_encapsulate_init_fn
*auth_encapsulate_init
;
231 OSSL_FUNC_kem_auth_decapsulate_init_fn
*auth_decapsulate_init
;
234 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX
*ctx
, const char *pass
,
235 int passlen
, ASN1_TYPE
*param
,
236 const EVP_CIPHER
*c
, const EVP_MD
*md
,
238 int PKCS5_v2_PBKDF2_keyivgen_ex(EVP_CIPHER_CTX
*ctx
, const char *pass
,
239 int passlen
, ASN1_TYPE
*param
,
240 const EVP_CIPHER
*c
, const EVP_MD
*md
,
241 int en_de
, OSSL_LIB_CTX
*libctx
, const char *propq
);
243 struct evp_Encode_Ctx_st
{
244 /* number saved in a partial encode/decode */
247 * The length is either the output line length (in input bytes) or the
248 * shortest input line length that is ok. Once decoding begins, the
249 * length is adjusted up each time a longer line is decoded
253 unsigned char enc_data
[80];
254 /* number read on current line */
259 typedef struct evp_pbe_st EVP_PBE_CTL
;
260 DEFINE_STACK_OF(EVP_PBE_CTL
)
262 int ossl_is_partially_overlapping(const void *ptr1
, const void *ptr2
, int len
);
264 #include <openssl/types.h>
265 #include <openssl/core.h>
267 void *evp_generic_fetch(OSSL_LIB_CTX
*ctx
, int operation_id
,
268 const char *name
, const char *properties
,
269 void *(*new_method
)(int name_id
,
270 const OSSL_ALGORITHM
*algodef
,
271 OSSL_PROVIDER
*prov
),
272 int (*up_ref_method
)(void *),
273 void (*free_method
)(void *));
274 void *evp_generic_fetch_from_prov(OSSL_PROVIDER
*prov
, int operation_id
,
275 const char *name
, const char *properties
,
276 void *(*new_method
)(int name_id
,
277 const OSSL_ALGORITHM
*algodef
,
278 OSSL_PROVIDER
*prov
),
279 int (*up_ref_method
)(void *),
280 void (*free_method
)(void *));
281 void evp_generic_do_all_prefetched(OSSL_LIB_CTX
*libctx
, int operation_id
,
282 void (*user_fn
)(void *method
, void *arg
),
284 void evp_generic_do_all(OSSL_LIB_CTX
*libctx
, int operation_id
,
285 void (*user_fn
)(void *method
, void *arg
),
287 void *(*new_method
)(int name_id
,
288 const OSSL_ALGORITHM
*algodef
,
289 OSSL_PROVIDER
*prov
),
290 int (*up_ref_method
)(void *),
291 void (*free_method
)(void *));
293 /* Internal fetchers for method types that are to be combined with others */
294 EVP_KEYMGMT
*evp_keymgmt_fetch_by_number(OSSL_LIB_CTX
*ctx
, int name_id
,
295 const char *properties
);
296 EVP_SIGNATURE
*evp_signature_fetch_from_prov(OSSL_PROVIDER
*prov
,
298 const char *properties
);
299 EVP_ASYM_CIPHER
*evp_asym_cipher_fetch_from_prov(OSSL_PROVIDER
*prov
,
301 const char *properties
);
302 EVP_KEYEXCH
*evp_keyexch_fetch_from_prov(OSSL_PROVIDER
*prov
,
304 const char *properties
);
305 EVP_KEM
*evp_kem_fetch_from_prov(OSSL_PROVIDER
*prov
,
307 const char *properties
);
309 /* Internal structure constructors for fetched methods */
310 EVP_MD
*evp_md_new(void);
311 EVP_CIPHER
*evp_cipher_new(void);
313 int evp_cipher_get_asn1_aead_params(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
314 evp_cipher_aead_asn1_params
*asn1_params
);
315 int evp_cipher_set_asn1_aead_params(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
316 evp_cipher_aead_asn1_params
*asn1_params
);
318 /* Helper functions to avoid duplicating code */
321 * These methods implement different ways to pass a params array to the
322 * provider. They will return one of these values:
324 * -2 if the method doesn't come from a provider
325 * (evp_do_param will return this to the called)
326 * -1 if the provider doesn't offer the desired function
327 * (evp_do_param will raise an error and return 0)
328 * or the return value from the desired function
329 * (evp_do_param will return it to the caller)
331 int evp_do_ciph_getparams(const EVP_CIPHER
*ciph
, OSSL_PARAM params
[]);
332 int evp_do_ciph_ctx_getparams(const EVP_CIPHER
*ciph
, void *provctx
,
333 OSSL_PARAM params
[]);
334 int evp_do_ciph_ctx_setparams(const EVP_CIPHER
*ciph
, void *provctx
,
335 OSSL_PARAM params
[]);
336 int evp_do_md_getparams(const EVP_MD
*md
, OSSL_PARAM params
[]);
337 int evp_do_md_ctx_getparams(const EVP_MD
*md
, void *provctx
,
338 OSSL_PARAM params
[]);
339 int evp_do_md_ctx_setparams(const EVP_MD
*md
, void *provctx
,
340 OSSL_PARAM params
[]);
342 OSSL_PARAM
*evp_pkey_to_param(EVP_PKEY
*pkey
, size_t *sz
);
344 #define M_check_autoarg(ctx, arg, arglen, err) \
345 if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) { \
346 size_t pksize = (size_t)EVP_PKEY_get_size(ctx->pkey); \
349 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY); /*ckerr_ignore*/ \
356 if (*arglen < pksize) { \
357 ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \
362 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX
*ctx
);
363 void evp_cipher_free_int(EVP_CIPHER
*md
);
364 void evp_md_free_int(EVP_MD
*md
);
366 /* OSSL_PROVIDER * is only used to get the library context */
367 int evp_is_a(OSSL_PROVIDER
*prov
, int number
,
368 const char *legacy_name
, const char *name
);
369 int evp_names_do_all(OSSL_PROVIDER
*prov
, int number
,
370 void (*fn
)(const char *name
, void *data
),
372 int evp_cipher_cache_constants(EVP_CIPHER
*cipher
);