evp_local.h 15 KB

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