1 /* 2 * Copyright 2000-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 #include <openssl/core_dispatch.h> 11 #include "internal/refcount.h" 12 13 #define EVP_CTRL_RET_UNSUPPORTED -1 14 15 16 struct evp_md_ctx_st { 17 const EVP_MD *reqdigest; /* The original requested digest */ 18 const EVP_MD *digest; 19 ENGINE *engine; /* functional reference if 'digest' is 20 * ENGINE-provided */ 21 unsigned long flags; 22 void *md_data; 23 /* Public key context for sign/verify */ 24 EVP_PKEY_CTX *pctx; 25 /* Update function: usually copied from EVP_MD */ 26 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count); 27 28 /* 29 * Opaque ctx returned from a providers digest algorithm implementation 30 * OSSL_FUNC_digest_newctx() 31 */ 32 void *algctx; 33 EVP_MD *fetched_digest; 34 } /* EVP_MD_CTX */ ; 35 36 struct evp_cipher_ctx_st { 37 const EVP_CIPHER *cipher; 38 ENGINE *engine; /* functional reference if 'cipher' is 39 * ENGINE-provided */ 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 */ 52 int final_used; 53 int block_mask; 54 unsigned char final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */ 55 56 /* 57 * Opaque ctx returned from a providers cipher algorithm implementation 58 * OSSL_FUNC_cipher_newctx() 59 */ 60 void *algctx; 61 EVP_CIPHER *fetched_cipher; 62 } /* EVP_CIPHER_CTX */ ; 63 64 struct evp_mac_ctx_st { 65 EVP_MAC *meth; /* Method structure */ 66 /* 67 * Opaque ctx returned from a providers MAC algorithm implementation 68 * OSSL_FUNC_mac_newctx() 69 */ 70 void *algctx; 71 } /* EVP_MAC_CTX */; 72 73 struct evp_kdf_ctx_st { 74 EVP_KDF *meth; /* Method structure */ 75 /* 76 * Opaque ctx returned from a providers KDF algorithm implementation 77 * OSSL_FUNC_kdf_newctx() 78 */ 79 void *algctx; 80 } /* EVP_KDF_CTX */ ; 81 82 struct evp_rand_ctx_st { 83 EVP_RAND *meth; /* Method structure */ 84 /* 85 * Opaque ctx returned from a providers rand algorithm implementation 86 * OSSL_FUNC_rand_newctx() 87 */ 88 void *algctx; 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 */ ; 93 94 struct evp_keymgmt_st { 95 int id; /* libcrypto internal */ 96 97 int name_id; 98 /* NID for the legacy alg if there is one */ 99 int legacy_alg; 100 char *type_name; 101 const char *description; 102 OSSL_PROVIDER *prov; 103 CRYPTO_REF_COUNT refcnt; 104 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; 112 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_get_params_fn *gen_get_params; 117 OSSL_FUNC_keymgmt_gen_gettable_params_fn *gen_gettable_params; 118 OSSL_FUNC_keymgmt_gen_set_params_fn *gen_set_params; 119 OSSL_FUNC_keymgmt_gen_settable_params_fn *gen_settable_params; 120 OSSL_FUNC_keymgmt_gen_fn *gen; 121 OSSL_FUNC_keymgmt_gen_cleanup_fn *gen_cleanup; 122 123 OSSL_FUNC_keymgmt_load_fn *load; 124 125 /* Key object checking */ 126 OSSL_FUNC_keymgmt_query_operation_name_fn *query_operation_name; 127 OSSL_FUNC_keymgmt_has_fn *has; 128 OSSL_FUNC_keymgmt_validate_fn *validate; 129 OSSL_FUNC_keymgmt_match_fn *match; 130 131 /* Import and export routines */ 132 OSSL_FUNC_keymgmt_import_fn *import; 133 OSSL_FUNC_keymgmt_import_types_fn *import_types; 134 OSSL_FUNC_keymgmt_import_types_ex_fn *import_types_ex; 135 OSSL_FUNC_keymgmt_export_fn *export; 136 OSSL_FUNC_keymgmt_export_types_fn *export_types; 137 OSSL_FUNC_keymgmt_export_types_ex_fn *export_types_ex; 138 OSSL_FUNC_keymgmt_dup_fn *dup; 139 } /* EVP_KEYMGMT */ ; 140 141 struct evp_keyexch_st { 142 int name_id; 143 char *type_name; 144 const char *description; 145 OSSL_PROVIDER *prov; 146 CRYPTO_REF_COUNT refcnt; 147 148 OSSL_FUNC_keyexch_newctx_fn *newctx; 149 OSSL_FUNC_keyexch_init_fn *init; 150 OSSL_FUNC_keyexch_set_peer_fn *set_peer; 151 OSSL_FUNC_keyexch_derive_fn *derive; 152 OSSL_FUNC_keyexch_freectx_fn *freectx; 153 OSSL_FUNC_keyexch_dupctx_fn *dupctx; 154 OSSL_FUNC_keyexch_set_ctx_params_fn *set_ctx_params; 155 OSSL_FUNC_keyexch_settable_ctx_params_fn *settable_ctx_params; 156 OSSL_FUNC_keyexch_get_ctx_params_fn *get_ctx_params; 157 OSSL_FUNC_keyexch_gettable_ctx_params_fn *gettable_ctx_params; 158 } /* EVP_KEYEXCH */; 159 160 struct evp_signature_st { 161 int name_id; 162 char *type_name; 163 const char *description; 164 OSSL_PROVIDER *prov; 165 CRYPTO_REF_COUNT refcnt; 166 167 OSSL_FUNC_signature_newctx_fn *newctx; 168 OSSL_FUNC_signature_sign_init_fn *sign_init; 169 OSSL_FUNC_signature_sign_fn *sign; 170 OSSL_FUNC_signature_sign_message_init_fn *sign_message_init; 171 OSSL_FUNC_signature_sign_message_update_fn *sign_message_update; 172 OSSL_FUNC_signature_sign_message_final_fn *sign_message_final; 173 OSSL_FUNC_signature_verify_init_fn *verify_init; 174 OSSL_FUNC_signature_verify_fn *verify; 175 OSSL_FUNC_signature_verify_message_init_fn *verify_message_init; 176 OSSL_FUNC_signature_verify_message_update_fn *verify_message_update; 177 OSSL_FUNC_signature_verify_message_final_fn *verify_message_final; 178 OSSL_FUNC_signature_verify_recover_init_fn *verify_recover_init; 179 OSSL_FUNC_signature_verify_recover_fn *verify_recover; 180 OSSL_FUNC_signature_digest_sign_init_fn *digest_sign_init; 181 OSSL_FUNC_signature_digest_sign_update_fn *digest_sign_update; 182 OSSL_FUNC_signature_digest_sign_final_fn *digest_sign_final; 183 OSSL_FUNC_signature_digest_sign_fn *digest_sign; 184 OSSL_FUNC_signature_digest_verify_init_fn *digest_verify_init; 185 OSSL_FUNC_signature_digest_verify_update_fn *digest_verify_update; 186 OSSL_FUNC_signature_digest_verify_final_fn *digest_verify_final; 187 OSSL_FUNC_signature_digest_verify_fn *digest_verify; 188 OSSL_FUNC_signature_freectx_fn *freectx; 189 OSSL_FUNC_signature_dupctx_fn *dupctx; 190 OSSL_FUNC_signature_get_ctx_params_fn *get_ctx_params; 191 OSSL_FUNC_signature_gettable_ctx_params_fn *gettable_ctx_params; 192 OSSL_FUNC_signature_set_ctx_params_fn *set_ctx_params; 193 OSSL_FUNC_signature_settable_ctx_params_fn *settable_ctx_params; 194 OSSL_FUNC_signature_get_ctx_md_params_fn *get_ctx_md_params; 195 OSSL_FUNC_signature_gettable_ctx_md_params_fn *gettable_ctx_md_params; 196 OSSL_FUNC_signature_set_ctx_md_params_fn *set_ctx_md_params; 197 OSSL_FUNC_signature_settable_ctx_md_params_fn *settable_ctx_md_params; 198 199 /* Signature object checking */ 200 OSSL_FUNC_signature_query_key_types_fn *query_key_types; 201 } /* EVP_SIGNATURE */; 202 203 struct evp_asym_cipher_st { 204 int name_id; 205 char *type_name; 206 const char *description; 207 OSSL_PROVIDER *prov; 208 CRYPTO_REF_COUNT refcnt; 209 210 OSSL_FUNC_asym_cipher_newctx_fn *newctx; 211 OSSL_FUNC_asym_cipher_encrypt_init_fn *encrypt_init; 212 OSSL_FUNC_asym_cipher_encrypt_fn *encrypt; 213 OSSL_FUNC_asym_cipher_decrypt_init_fn *decrypt_init; 214 OSSL_FUNC_asym_cipher_decrypt_fn *decrypt; 215 OSSL_FUNC_asym_cipher_freectx_fn *freectx; 216 OSSL_FUNC_asym_cipher_dupctx_fn *dupctx; 217 OSSL_FUNC_asym_cipher_get_ctx_params_fn *get_ctx_params; 218 OSSL_FUNC_asym_cipher_gettable_ctx_params_fn *gettable_ctx_params; 219 OSSL_FUNC_asym_cipher_set_ctx_params_fn *set_ctx_params; 220 OSSL_FUNC_asym_cipher_settable_ctx_params_fn *settable_ctx_params; 221 } /* EVP_ASYM_CIPHER */; 222 223 struct evp_kem_st { 224 int name_id; 225 char *type_name; 226 const char *description; 227 OSSL_PROVIDER *prov; 228 CRYPTO_REF_COUNT refcnt; 229 230 OSSL_FUNC_kem_newctx_fn *newctx; 231 OSSL_FUNC_kem_encapsulate_init_fn *encapsulate_init; 232 OSSL_FUNC_kem_encapsulate_fn *encapsulate; 233 OSSL_FUNC_kem_decapsulate_init_fn *decapsulate_init; 234 OSSL_FUNC_kem_decapsulate_fn *decapsulate; 235 OSSL_FUNC_kem_freectx_fn *freectx; 236 OSSL_FUNC_kem_dupctx_fn *dupctx; 237 OSSL_FUNC_kem_get_ctx_params_fn *get_ctx_params; 238 OSSL_FUNC_kem_gettable_ctx_params_fn *gettable_ctx_params; 239 OSSL_FUNC_kem_set_ctx_params_fn *set_ctx_params; 240 OSSL_FUNC_kem_settable_ctx_params_fn *settable_ctx_params; 241 OSSL_FUNC_kem_auth_encapsulate_init_fn *auth_encapsulate_init; 242 OSSL_FUNC_kem_auth_decapsulate_init_fn *auth_decapsulate_init; 243 } /* EVP_KEM */; 244 245 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, 246 int passlen, ASN1_TYPE *param, 247 const EVP_CIPHER *c, const EVP_MD *md, 248 int en_de); 249 int PKCS5_v2_PBKDF2_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass, 250 int passlen, ASN1_TYPE *param, 251 const EVP_CIPHER *c, const EVP_MD *md, 252 int en_de, OSSL_LIB_CTX *libctx, const char *propq); 253 254 struct evp_Encode_Ctx_st { 255 /* number saved in a partial encode/decode */ 256 int num; 257 /* 258 * The length is either the output line length (in input bytes) or the 259 * shortest input line length that is ok. Once decoding begins, the 260 * length is adjusted up each time a longer line is decoded 261 */ 262 int length; 263 /* data to encode */ 264 unsigned char enc_data[80]; 265 /* number read on current line */ 266 int line_num; 267 unsigned int flags; 268 }; 269 270 typedef struct evp_pbe_st EVP_PBE_CTL; 271 DEFINE_STACK_OF(EVP_PBE_CTL) 272 273 int ossl_is_partially_overlapping(const void *ptr1, const void *ptr2, int len); 274 275 #include <openssl/types.h> 276 #include <openssl/core.h> 277 278 void *evp_generic_fetch(OSSL_LIB_CTX *ctx, int operation_id, 279 const char *name, const char *properties, 280 void *(*new_method)(int name_id, 281 const OSSL_ALGORITHM *algodef, 282 OSSL_PROVIDER *prov), 283 int (*up_ref_method)(void *), 284 void (*free_method)(void *)); 285 void *evp_generic_fetch_from_prov(OSSL_PROVIDER *prov, int operation_id, 286 const char *name, const char *properties, 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 *)); 292 void evp_generic_do_all_prefetched(OSSL_LIB_CTX *libctx, int operation_id, 293 void (*user_fn)(void *method, void *arg), 294 void *user_arg); 295 void evp_generic_do_all(OSSL_LIB_CTX *libctx, int operation_id, 296 void (*user_fn)(void *method, void *arg), 297 void *user_arg, 298 void *(*new_method)(int name_id, 299 const OSSL_ALGORITHM *algodef, 300 OSSL_PROVIDER *prov), 301 int (*up_ref_method)(void *), 302 void (*free_method)(void *)); 303 304 /* Internal fetchers for method types that are to be combined with others */ 305 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OSSL_LIB_CTX *ctx, int name_id, 306 const char *properties); 307 EVP_SIGNATURE *evp_signature_fetch_from_prov(OSSL_PROVIDER *prov, 308 const char *name, 309 const char *properties); 310 EVP_ASYM_CIPHER *evp_asym_cipher_fetch_from_prov(OSSL_PROVIDER *prov, 311 const char *name, 312 const char *properties); 313 EVP_KEYEXCH *evp_keyexch_fetch_from_prov(OSSL_PROVIDER *prov, 314 const char *name, 315 const char *properties); 316 EVP_KEM *evp_kem_fetch_from_prov(OSSL_PROVIDER *prov, 317 const char *name, 318 const char *properties); 319 320 /* Internal structure constructors for fetched methods */ 321 EVP_MD *evp_md_new(void); 322 EVP_CIPHER *evp_cipher_new(void); 323 324 int evp_cipher_get_asn1_aead_params(EVP_CIPHER_CTX *c, ASN1_TYPE *type, 325 evp_cipher_aead_asn1_params *asn1_params); 326 int evp_cipher_set_asn1_aead_params(EVP_CIPHER_CTX *c, ASN1_TYPE *type, 327 evp_cipher_aead_asn1_params *asn1_params); 328 329 /* Helper functions to avoid duplicating code */ 330 331 /* 332 * These methods implement different ways to pass a params array to the 333 * provider. They will return one of these values: 334 * 335 * -2 if the method doesn't come from a provider 336 * (evp_do_param will return this to the called) 337 * -1 if the provider doesn't offer the desired function 338 * (evp_do_param will raise an error and return 0) 339 * or the return value from the desired function 340 * (evp_do_param will return it to the caller) 341 */ 342 int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]); 343 int evp_do_ciph_ctx_getparams(const EVP_CIPHER *ciph, void *provctx, 344 OSSL_PARAM params[]); 345 int evp_do_ciph_ctx_setparams(const EVP_CIPHER *ciph, void *provctx, 346 OSSL_PARAM params[]); 347 int evp_do_md_getparams(const EVP_MD *md, OSSL_PARAM params[]); 348 int evp_do_md_ctx_getparams(const EVP_MD *md, void *provctx, 349 OSSL_PARAM params[]); 350 int evp_do_md_ctx_setparams(const EVP_MD *md, void *provctx, 351 OSSL_PARAM params[]); 352 353 OSSL_PARAM *evp_pkey_to_param(EVP_PKEY *pkey, size_t *sz); 354 355 #define M_check_autoarg(ctx, arg, arglen, err) \ 356 if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) { \ 357 size_t pksize = (size_t)EVP_PKEY_get_size(ctx->pkey); \ 358 \ 359 if (pksize == 0) { \ 360 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY); /*ckerr_ignore*/ \ 361 return 0; \ 362 } \ 363 if (arg == NULL) { \ 364 *arglen = pksize; \ 365 return 1; \ 366 } \ 367 if (*arglen < pksize) { \ 368 ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \ 369 return 0; \ 370 } \ 371 } 372 373 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx); 374 void evp_cipher_free_int(EVP_CIPHER *md); 375 void evp_md_free_int(EVP_MD *md); 376 377 /* OSSL_PROVIDER * is only used to get the library context */ 378 int evp_is_a(OSSL_PROVIDER *prov, int number, 379 const char *legacy_name, const char *name); 380 int evp_names_do_all(OSSL_PROVIDER *prov, int number, 381 void (*fn)(const char *name, void *data), 382 void *data); 383 int evp_cipher_cache_constants(EVP_CIPHER *cipher); 384
