1 /* 2 * Copyright 2019-2025 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 OPENSSL_CORE_NUMBERS_H 11 # define OPENSSL_CORE_NUMBERS_H 12 # pragma once 13 14 # include <stdarg.h> 15 # include <openssl/core.h> 16 # include <openssl/indicator.h> 17 18 # ifdef __cplusplus 19 extern "C" { 20 # endif 21 22 /* 23 * Generic function pointer for provider method arrays, or other contexts where 24 * functions of various signatures must occupy a common slot in an array of 25 * structures. 26 */ 27 typedef void (*OSSL_FUNC)(void); 28 29 /*- 30 * Identities 31 * ---------- 32 * 33 * All series start with 1, to allow 0 to be an array terminator. 34 * For any FUNC identity, we also provide a function signature typedef 35 * and a static inline function to extract a function pointer from a 36 * OSSL_DISPATCH element in a type safe manner. 37 * 38 * Names: 39 * for any function base name 'foo' (uppercase form 'FOO'), we will have 40 * the following: 41 * - a macro for the identity with the name OSSL_FUNC_'FOO' or derivatives 42 * thereof (to be specified further down) 43 * - a function signature typedef with the name OSSL_FUNC_'foo'_fn 44 * - a function pointer extractor function with the name OSSL_FUNC_'foo' 45 */ 46 47 /* 48 * Helper macro to create the function signature typedef and the extractor 49 * |type| is the return-type of the function, |name| is the name of the 50 * function to fetch, and |args| is a parenthesized list of parameters 51 * for the function (that is, it is |name|'s function signature). 52 * Note: This is considered a "reserved" internal macro. Applications should 53 * not use this or assume its existence. 54 */ 55 #define OSSL_CORE_MAKE_FUNC(type,name,args) \ 56 typedef type (OSSL_FUNC_##name##_fn)args; \ 57 static ossl_unused ossl_inline \ 58 OSSL_FUNC_##name##_fn *OSSL_FUNC_##name(const OSSL_DISPATCH *opf) \ 59 { \ 60 return (OSSL_FUNC_##name##_fn *)opf->function; \ 61 } 62 63 /* 64 * Core function identities, for the two OSSL_DISPATCH tables being passed 65 * in the OSSL_provider_init call. 66 * 67 * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must 68 * therefore NEVER be used as a function identity. 69 */ 70 /* Functions provided by the Core to the provider, reserved numbers 1-1023 */ 71 # define OSSL_FUNC_CORE_GETTABLE_PARAMS 1 72 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 73 core_gettable_params,(const OSSL_CORE_HANDLE *prov)) 74 # define OSSL_FUNC_CORE_GET_PARAMS 2 75 OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_CORE_HANDLE *prov, 76 OSSL_PARAM params[])) 77 # define OSSL_FUNC_CORE_THREAD_START 3 78 OSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_CORE_HANDLE *prov, 79 OSSL_thread_stop_handler_fn handfn, 80 void *arg)) 81 # define OSSL_FUNC_CORE_GET_LIBCTX 4 82 OSSL_CORE_MAKE_FUNC(OPENSSL_CORE_CTX *,core_get_libctx, 83 (const OSSL_CORE_HANDLE *prov)) 84 # define OSSL_FUNC_CORE_NEW_ERROR 5 85 OSSL_CORE_MAKE_FUNC(void,core_new_error,(const OSSL_CORE_HANDLE *prov)) 86 # define OSSL_FUNC_CORE_SET_ERROR_DEBUG 6 87 OSSL_CORE_MAKE_FUNC(void,core_set_error_debug, 88 (const OSSL_CORE_HANDLE *prov, 89 const char *file, int line, const char *func)) 90 # define OSSL_FUNC_CORE_VSET_ERROR 7 91 OSSL_CORE_MAKE_FUNC(void,core_vset_error, 92 (const OSSL_CORE_HANDLE *prov, 93 uint32_t reason, const char *fmt, va_list args)) 94 # define OSSL_FUNC_CORE_SET_ERROR_MARK 8 95 OSSL_CORE_MAKE_FUNC(int, core_set_error_mark, (const OSSL_CORE_HANDLE *prov)) 96 # define OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK 9 97 OSSL_CORE_MAKE_FUNC(int, core_clear_last_error_mark, 98 (const OSSL_CORE_HANDLE *prov)) 99 # define OSSL_FUNC_CORE_POP_ERROR_TO_MARK 10 100 OSSL_CORE_MAKE_FUNC(int, core_pop_error_to_mark, (const OSSL_CORE_HANDLE *prov)) 101 102 103 /* Functions to access the OBJ database */ 104 105 #define OSSL_FUNC_CORE_OBJ_ADD_SIGID 11 106 #define OSSL_FUNC_CORE_OBJ_CREATE 12 107 108 OSSL_CORE_MAKE_FUNC(int, core_obj_add_sigid, 109 (const OSSL_CORE_HANDLE *prov, const char *sign_name, 110 const char *digest_name, const char *pkey_name)) 111 OSSL_CORE_MAKE_FUNC(int, core_obj_create, 112 (const OSSL_CORE_HANDLE *prov, const char *oid, 113 const char *sn, const char *ln)) 114 115 /* Memory allocation, freeing, clearing. */ 116 #define OSSL_FUNC_CRYPTO_MALLOC 20 117 OSSL_CORE_MAKE_FUNC(void *, 118 CRYPTO_malloc, (size_t num, const char *file, int line)) 119 #define OSSL_FUNC_CRYPTO_ZALLOC 21 120 OSSL_CORE_MAKE_FUNC(void *, 121 CRYPTO_zalloc, (size_t num, const char *file, int line)) 122 #define OSSL_FUNC_CRYPTO_FREE 22 123 OSSL_CORE_MAKE_FUNC(void, 124 CRYPTO_free, (void *ptr, const char *file, int line)) 125 #define OSSL_FUNC_CRYPTO_CLEAR_FREE 23 126 OSSL_CORE_MAKE_FUNC(void, 127 CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line)) 128 #define OSSL_FUNC_CRYPTO_REALLOC 24 129 OSSL_CORE_MAKE_FUNC(void *, 130 CRYPTO_realloc, (void *addr, size_t num, const char *file, int line)) 131 #define OSSL_FUNC_CRYPTO_CLEAR_REALLOC 25 132 OSSL_CORE_MAKE_FUNC(void *, 133 CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num, 134 const char *file, int line)) 135 #define OSSL_FUNC_CRYPTO_SECURE_MALLOC 26 136 OSSL_CORE_MAKE_FUNC(void *, 137 CRYPTO_secure_malloc, (size_t num, const char *file, int line)) 138 #define OSSL_FUNC_CRYPTO_SECURE_ZALLOC 27 139 OSSL_CORE_MAKE_FUNC(void *, 140 CRYPTO_secure_zalloc, (size_t num, const char *file, int line)) 141 #define OSSL_FUNC_CRYPTO_SECURE_FREE 28 142 OSSL_CORE_MAKE_FUNC(void, 143 CRYPTO_secure_free, (void *ptr, const char *file, int line)) 144 #define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE 29 145 OSSL_CORE_MAKE_FUNC(void, 146 CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file, 147 int line)) 148 #define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED 30 149 OSSL_CORE_MAKE_FUNC(int, 150 CRYPTO_secure_allocated, (const void *ptr)) 151 #define OSSL_FUNC_OPENSSL_CLEANSE 31 152 OSSL_CORE_MAKE_FUNC(void, 153 OPENSSL_cleanse, (void *ptr, size_t len)) 154 155 /* Bio functions provided by the core */ 156 #define OSSL_FUNC_BIO_NEW_FILE 40 157 #define OSSL_FUNC_BIO_NEW_MEMBUF 41 158 #define OSSL_FUNC_BIO_READ_EX 42 159 #define OSSL_FUNC_BIO_WRITE_EX 43 160 #define OSSL_FUNC_BIO_UP_REF 44 161 #define OSSL_FUNC_BIO_FREE 45 162 #define OSSL_FUNC_BIO_VPRINTF 46 163 #define OSSL_FUNC_BIO_VSNPRINTF 47 164 #define OSSL_FUNC_BIO_PUTS 48 165 #define OSSL_FUNC_BIO_GETS 49 166 #define OSSL_FUNC_BIO_CTRL 50 167 168 169 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename, 170 const char *mode)) 171 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len)) 172 OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data, 173 size_t data_len, size_t *bytes_read)) 174 OSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data, 175 size_t data_len, size_t *written)) 176 OSSL_CORE_MAKE_FUNC(int, BIO_gets, (OSSL_CORE_BIO *bio, char *buf, int size)) 177 OSSL_CORE_MAKE_FUNC(int, BIO_puts, (OSSL_CORE_BIO *bio, const char *str)) 178 OSSL_CORE_MAKE_FUNC(int, BIO_up_ref, (OSSL_CORE_BIO *bio)) 179 OSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio)) 180 OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format, 181 va_list args)) 182 OSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf, 183 (char *buf, size_t n, const char *fmt, va_list args)) 184 OSSL_CORE_MAKE_FUNC(int, BIO_ctrl, (OSSL_CORE_BIO *bio, 185 int cmd, long num, void *ptr)) 186 187 /* New seeding functions prototypes with the 101-104 series */ 188 #define OSSL_FUNC_CLEANUP_USER_ENTROPY 96 189 #define OSSL_FUNC_CLEANUP_USER_NONCE 97 190 #define OSSL_FUNC_GET_USER_ENTROPY 98 191 #define OSSL_FUNC_GET_USER_NONCE 99 192 193 #define OSSL_FUNC_INDICATOR_CB 95 194 OSSL_CORE_MAKE_FUNC(void, indicator_cb, (OPENSSL_CORE_CTX *ctx, 195 OSSL_INDICATOR_CALLBACK **cb)) 196 #define OSSL_FUNC_SELF_TEST_CB 100 197 OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb, 198 void **cbarg)) 199 200 /* Functions to get seed material from the operating system */ 201 #define OSSL_FUNC_GET_ENTROPY 101 202 #define OSSL_FUNC_CLEANUP_ENTROPY 102 203 #define OSSL_FUNC_GET_NONCE 103 204 #define OSSL_FUNC_CLEANUP_NONCE 104 205 OSSL_CORE_MAKE_FUNC(size_t, get_entropy, (const OSSL_CORE_HANDLE *handle, 206 unsigned char **pout, int entropy, 207 size_t min_len, size_t max_len)) 208 OSSL_CORE_MAKE_FUNC(size_t, get_user_entropy, (const OSSL_CORE_HANDLE *handle, 209 unsigned char **pout, int entropy, 210 size_t min_len, size_t max_len)) 211 OSSL_CORE_MAKE_FUNC(void, cleanup_entropy, (const OSSL_CORE_HANDLE *handle, 212 unsigned char *buf, size_t len)) 213 OSSL_CORE_MAKE_FUNC(void, cleanup_user_entropy, (const OSSL_CORE_HANDLE *handle, 214 unsigned char *buf, size_t len)) 215 OSSL_CORE_MAKE_FUNC(size_t, get_nonce, (const OSSL_CORE_HANDLE *handle, 216 unsigned char **pout, size_t min_len, 217 size_t max_len, const void *salt, 218 size_t salt_len)) 219 OSSL_CORE_MAKE_FUNC(size_t, get_user_nonce, (const OSSL_CORE_HANDLE *handle, 220 unsigned char **pout, size_t min_len, 221 size_t max_len, const void *salt, 222 size_t salt_len)) 223 OSSL_CORE_MAKE_FUNC(void, cleanup_nonce, (const OSSL_CORE_HANDLE *handle, 224 unsigned char *buf, size_t len)) 225 OSSL_CORE_MAKE_FUNC(void, cleanup_user_nonce, (const OSSL_CORE_HANDLE *handle, 226 unsigned char *buf, size_t len)) 227 228 /* Functions to access the core's providers */ 229 #define OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB 105 230 #define OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB 106 231 #define OSSL_FUNC_PROVIDER_NAME 107 232 #define OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX 108 233 #define OSSL_FUNC_PROVIDER_GET0_DISPATCH 109 234 #define OSSL_FUNC_PROVIDER_UP_REF 110 235 #define OSSL_FUNC_PROVIDER_FREE 111 236 237 OSSL_CORE_MAKE_FUNC(int, provider_register_child_cb, 238 (const OSSL_CORE_HANDLE *handle, 239 int (*create_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata), 240 int (*remove_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata), 241 int (*global_props_cb)(const char *props, void *cbdata), 242 void *cbdata)) 243 OSSL_CORE_MAKE_FUNC(void, provider_deregister_child_cb, 244 (const OSSL_CORE_HANDLE *handle)) 245 OSSL_CORE_MAKE_FUNC(const char *, provider_name, 246 (const OSSL_CORE_HANDLE *prov)) 247 OSSL_CORE_MAKE_FUNC(void *, provider_get0_provider_ctx, 248 (const OSSL_CORE_HANDLE *prov)) 249 OSSL_CORE_MAKE_FUNC(const OSSL_DISPATCH *, provider_get0_dispatch, 250 (const OSSL_CORE_HANDLE *prov)) 251 OSSL_CORE_MAKE_FUNC(int, provider_up_ref, 252 (const OSSL_CORE_HANDLE *prov, int activate)) 253 OSSL_CORE_MAKE_FUNC(int, provider_free, 254 (const OSSL_CORE_HANDLE *prov, int deactivate)) 255 256 /* Additional error functions provided by the core */ 257 # define OSSL_FUNC_CORE_COUNT_TO_MARK 120 258 OSSL_CORE_MAKE_FUNC(int, core_count_to_mark, (const OSSL_CORE_HANDLE *prov)) 259 260 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */ 261 # define OSSL_FUNC_PROVIDER_TEARDOWN 1024 262 OSSL_CORE_MAKE_FUNC(void, provider_teardown, (void *provctx)) 263 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025 264 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 265 provider_gettable_params,(void *provctx)) 266 # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026 267 OSSL_CORE_MAKE_FUNC(int, provider_get_params, (void *provctx, 268 OSSL_PARAM params[])) 269 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027 270 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation, 271 (void *provctx, int operation_id, int *no_store)) 272 # define OSSL_FUNC_PROVIDER_UNQUERY_OPERATION 1028 273 OSSL_CORE_MAKE_FUNC(void, provider_unquery_operation, 274 (void *provctx, int operation_id, const OSSL_ALGORITHM *)) 275 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1029 276 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings, 277 (void *provctx)) 278 # define OSSL_FUNC_PROVIDER_GET_CAPABILITIES 1030 279 OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx, 280 const char *capability, OSSL_CALLBACK *cb, void *arg)) 281 # define OSSL_FUNC_PROVIDER_SELF_TEST 1031 282 OSSL_CORE_MAKE_FUNC(int, provider_self_test, (void *provctx)) 283 # define OSSL_FUNC_PROVIDER_RANDOM_BYTES 1032 284 OSSL_CORE_MAKE_FUNC(int, provider_random_bytes, (void *provctx, int which, 285 void *buf, size_t n, 286 unsigned int strength)) 287 288 /* Libssl related functions */ 289 #define OSSL_FUNC_SSL_QUIC_TLS_CRYPTO_SEND 2001 290 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_crypto_send, 291 (SSL *s, const unsigned char *buf, size_t buf_len, 292 size_t *consumed, void *arg)) 293 #define OSSL_FUNC_SSL_QUIC_TLS_CRYPTO_RECV_RCD 2002 294 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_crypto_recv_rcd, 295 (SSL *s, const unsigned char **buf, size_t *bytes_read, 296 void *arg)) 297 #define OSSL_FUNC_SSL_QUIC_TLS_CRYPTO_RELEASE_RCD 2003 298 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_crypto_release_rcd, 299 (SSL *s, size_t bytes_read, void *arg)) 300 #define OSSL_FUNC_SSL_QUIC_TLS_YIELD_SECRET 2004 301 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_yield_secret, 302 (SSL *s, uint32_t prot_level, int direction, 303 const unsigned char *secret, size_t secret_len, void *arg)) 304 #define OSSL_FUNC_SSL_QUIC_TLS_GOT_TRANSPORT_PARAMS 2005 305 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_got_transport_params, 306 (SSL *s, const unsigned char *params, size_t params_len, 307 void *arg)) 308 #define OSSL_FUNC_SSL_QUIC_TLS_ALERT 2006 309 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_alert, 310 (SSL *s, unsigned char alert_code, void *arg)) 311 312 /* Operations */ 313 314 # define OSSL_OP_DIGEST 1 315 # define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */ 316 # define OSSL_OP_MAC 3 317 # define OSSL_OP_KDF 4 318 # define OSSL_OP_RAND 5 319 # define OSSL_OP_KEYMGMT 10 320 # define OSSL_OP_KEYEXCH 11 321 # define OSSL_OP_SIGNATURE 12 322 # define OSSL_OP_ASYM_CIPHER 13 323 # define OSSL_OP_KEM 14 324 # define OSSL_OP_SKEYMGMT 15 325 /* New section for non-EVP operations */ 326 # define OSSL_OP_ENCODER 20 327 # define OSSL_OP_DECODER 21 328 # define OSSL_OP_STORE 22 329 /* Highest known operation number */ 330 # define OSSL_OP__HIGHEST 22 331 332 /* Digests */ 333 334 # define OSSL_FUNC_DIGEST_NEWCTX 1 335 # define OSSL_FUNC_DIGEST_INIT 2 336 # define OSSL_FUNC_DIGEST_UPDATE 3 337 # define OSSL_FUNC_DIGEST_FINAL 4 338 # define OSSL_FUNC_DIGEST_DIGEST 5 339 # define OSSL_FUNC_DIGEST_FREECTX 6 340 # define OSSL_FUNC_DIGEST_DUPCTX 7 341 # define OSSL_FUNC_DIGEST_GET_PARAMS 8 342 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9 343 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10 344 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11 345 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12 346 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13 347 # define OSSL_FUNC_DIGEST_SQUEEZE 14 348 # define OSSL_FUNC_DIGEST_COPYCTX 15 349 350 OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx)) 351 OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx, const OSSL_PARAM params[])) 352 OSSL_CORE_MAKE_FUNC(int, digest_update, 353 (void *dctx, const unsigned char *in, size_t inl)) 354 OSSL_CORE_MAKE_FUNC(int, digest_final, 355 (void *dctx, 356 unsigned char *out, size_t *outl, size_t outsz)) 357 OSSL_CORE_MAKE_FUNC(int, digest_squeeze, 358 (void *dctx, 359 unsigned char *out, size_t *outl, size_t outsz)) 360 OSSL_CORE_MAKE_FUNC(int, digest_digest, 361 (void *provctx, const unsigned char *in, size_t inl, 362 unsigned char *out, size_t *outl, size_t outsz)) 363 364 OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx)) 365 OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx)) 366 OSSL_CORE_MAKE_FUNC(void, digest_copyctx, (void *outctx, void *inctx)) 367 368 OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[])) 369 OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params, 370 (void *vctx, const OSSL_PARAM params[])) 371 OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params, 372 (void *vctx, OSSL_PARAM params[])) 373 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params, 374 (void *provctx)) 375 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params, 376 (void *dctx, void *provctx)) 377 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params, 378 (void *dctx, void *provctx)) 379 380 /* Symmetric Ciphers */ 381 382 # define OSSL_FUNC_CIPHER_NEWCTX 1 383 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2 384 # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3 385 # define OSSL_FUNC_CIPHER_UPDATE 4 386 # define OSSL_FUNC_CIPHER_FINAL 5 387 # define OSSL_FUNC_CIPHER_CIPHER 6 388 # define OSSL_FUNC_CIPHER_FREECTX 7 389 # define OSSL_FUNC_CIPHER_DUPCTX 8 390 # define OSSL_FUNC_CIPHER_GET_PARAMS 9 391 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10 392 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11 393 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12 394 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13 395 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14 396 # define OSSL_FUNC_CIPHER_PIPELINE_ENCRYPT_INIT 15 397 # define OSSL_FUNC_CIPHER_PIPELINE_DECRYPT_INIT 16 398 # define OSSL_FUNC_CIPHER_PIPELINE_UPDATE 17 399 # define OSSL_FUNC_CIPHER_PIPELINE_FINAL 18 400 # define OSSL_FUNC_CIPHER_ENCRYPT_SKEY_INIT 19 401 # define OSSL_FUNC_CIPHER_DECRYPT_SKEY_INIT 20 402 403 OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx)) 404 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx, 405 const unsigned char *key, 406 size_t keylen, 407 const unsigned char *iv, 408 size_t ivlen, 409 const OSSL_PARAM params[])) 410 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx, 411 const unsigned char *key, 412 size_t keylen, 413 const unsigned char *iv, 414 size_t ivlen, 415 const OSSL_PARAM params[])) 416 OSSL_CORE_MAKE_FUNC(int, cipher_update, 417 (void *cctx, 418 unsigned char *out, size_t *outl, size_t outsize, 419 const unsigned char *in, size_t inl)) 420 OSSL_CORE_MAKE_FUNC(int, cipher_final, 421 (void *cctx, 422 unsigned char *out, size_t *outl, size_t outsize)) 423 OSSL_CORE_MAKE_FUNC(int, cipher_cipher, 424 (void *cctx, 425 unsigned char *out, size_t *outl, size_t outsize, 426 const unsigned char *in, size_t inl)) 427 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_encrypt_init, 428 (void *cctx, 429 const unsigned char *key, size_t keylen, 430 size_t numpipes, const unsigned char **iv, size_t ivlen, 431 const OSSL_PARAM params[])) 432 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_decrypt_init, 433 (void *cctx, 434 const unsigned char *key, size_t keylen, 435 size_t numpipes, const unsigned char **iv, size_t ivlen, 436 const OSSL_PARAM params[])) 437 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_update, 438 (void *cctx, size_t numpipes, 439 unsigned char **out, size_t *outl, const size_t *outsize, 440 const unsigned char **in, const size_t *inl)) 441 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_final, 442 (void *cctx, size_t numpipes, 443 unsigned char **out, size_t *outl, const size_t *outsize)) 444 OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx)) 445 OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx)) 446 OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[])) 447 OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx, 448 OSSL_PARAM params[])) 449 OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx, 450 const OSSL_PARAM params[])) 451 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params, 452 (void *provctx)) 453 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params, 454 (void *cctx, void *provctx)) 455 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params, 456 (void *cctx, void *provctx)) 457 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_skey_init, (void *cctx, 458 void *skeydata, 459 const unsigned char *iv, 460 size_t ivlen, 461 const OSSL_PARAM params[])) 462 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_skey_init, (void *cctx, 463 void *skeydata, 464 const unsigned char *iv, 465 size_t ivlen, 466 const OSSL_PARAM params[])) 467 468 /* MACs */ 469 470 # define OSSL_FUNC_MAC_NEWCTX 1 471 # define OSSL_FUNC_MAC_DUPCTX 2 472 # define OSSL_FUNC_MAC_FREECTX 3 473 # define OSSL_FUNC_MAC_INIT 4 474 # define OSSL_FUNC_MAC_UPDATE 5 475 # define OSSL_FUNC_MAC_FINAL 6 476 # define OSSL_FUNC_MAC_GET_PARAMS 7 477 # define OSSL_FUNC_MAC_GET_CTX_PARAMS 8 478 # define OSSL_FUNC_MAC_SET_CTX_PARAMS 9 479 # define OSSL_FUNC_MAC_GETTABLE_PARAMS 10 480 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11 481 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12 482 # define OSSL_FUNC_MAC_INIT_SKEY 13 483 484 OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx)) 485 OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src)) 486 OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx)) 487 OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx, const unsigned char *key, 488 size_t keylen, const OSSL_PARAM params[])) 489 OSSL_CORE_MAKE_FUNC(int, mac_update, 490 (void *mctx, const unsigned char *in, size_t inl)) 491 OSSL_CORE_MAKE_FUNC(int, mac_final, 492 (void *mctx, 493 unsigned char *out, size_t *outl, size_t outsize)) 494 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx)) 495 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params, 496 (void *mctx, void *provctx)) 497 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params, 498 (void *mctx, void *provctx)) 499 OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[])) 500 OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params, 501 (void *mctx, OSSL_PARAM params[])) 502 OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params, 503 (void *mctx, const OSSL_PARAM params[])) 504 OSSL_CORE_MAKE_FUNC(int, mac_init_skey, (void *mctx, void *key, const OSSL_PARAM params[])) 505 506 /* KDFs and PRFs */ 507 508 # define OSSL_FUNC_KDF_NEWCTX 1 509 # define OSSL_FUNC_KDF_DUPCTX 2 510 # define OSSL_FUNC_KDF_FREECTX 3 511 # define OSSL_FUNC_KDF_RESET 4 512 # define OSSL_FUNC_KDF_DERIVE 5 513 # define OSSL_FUNC_KDF_GETTABLE_PARAMS 6 514 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7 515 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8 516 # define OSSL_FUNC_KDF_GET_PARAMS 9 517 # define OSSL_FUNC_KDF_GET_CTX_PARAMS 10 518 # define OSSL_FUNC_KDF_SET_CTX_PARAMS 11 519 520 OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx)) 521 OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src)) 522 OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx)) 523 OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx)) 524 OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key, 525 size_t keylen, const OSSL_PARAM params[])) 526 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx)) 527 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params, 528 (void *kctx, void *provctx)) 529 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params, 530 (void *kctx, void *provctx)) 531 OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[])) 532 OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params, 533 (void *kctx, OSSL_PARAM params[])) 534 OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params, 535 (void *kctx, const OSSL_PARAM params[])) 536 537 /* RAND */ 538 539 # define OSSL_FUNC_RAND_NEWCTX 1 540 # define OSSL_FUNC_RAND_FREECTX 2 541 # define OSSL_FUNC_RAND_INSTANTIATE 3 542 # define OSSL_FUNC_RAND_UNINSTANTIATE 4 543 # define OSSL_FUNC_RAND_GENERATE 5 544 # define OSSL_FUNC_RAND_RESEED 6 545 # define OSSL_FUNC_RAND_NONCE 7 546 # define OSSL_FUNC_RAND_ENABLE_LOCKING 8 547 # define OSSL_FUNC_RAND_LOCK 9 548 # define OSSL_FUNC_RAND_UNLOCK 10 549 # define OSSL_FUNC_RAND_GETTABLE_PARAMS 11 550 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS 12 551 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS 13 552 # define OSSL_FUNC_RAND_GET_PARAMS 14 553 # define OSSL_FUNC_RAND_GET_CTX_PARAMS 15 554 # define OSSL_FUNC_RAND_SET_CTX_PARAMS 16 555 # define OSSL_FUNC_RAND_VERIFY_ZEROIZATION 17 556 # define OSSL_FUNC_RAND_GET_SEED 18 557 # define OSSL_FUNC_RAND_CLEAR_SEED 19 558 559 OSSL_CORE_MAKE_FUNC(void *,rand_newctx, 560 (void *provctx, void *parent, 561 const OSSL_DISPATCH *parent_calls)) 562 OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx)) 563 OSSL_CORE_MAKE_FUNC(int,rand_instantiate, 564 (void *vdrbg, unsigned int strength, 565 int prediction_resistance, 566 const unsigned char *pstr, size_t pstr_len, 567 const OSSL_PARAM params[])) 568 OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg)) 569 OSSL_CORE_MAKE_FUNC(int,rand_generate, 570 (void *vctx, unsigned char *out, size_t outlen, 571 unsigned int strength, int prediction_resistance, 572 const unsigned char *addin, size_t addin_len)) 573 OSSL_CORE_MAKE_FUNC(int,rand_reseed, 574 (void *vctx, int prediction_resistance, 575 const unsigned char *ent, size_t ent_len, 576 const unsigned char *addin, size_t addin_len)) 577 OSSL_CORE_MAKE_FUNC(size_t,rand_nonce, 578 (void *vctx, unsigned char *out, unsigned int strength, 579 size_t min_noncelen, size_t max_noncelen)) 580 OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx)) 581 OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx)) 582 OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx)) 583 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx)) 584 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params, 585 (void *vctx, void *provctx)) 586 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params, 587 (void *vctx, void *provctx)) 588 OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[])) 589 OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params, 590 (void *vctx, OSSL_PARAM params[])) 591 OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params, 592 (void *vctx, const OSSL_PARAM params[])) 593 OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks, 594 (void *vctx, OSSL_INOUT_CALLBACK *get_entropy, 595 OSSL_CALLBACK *cleanup_entropy, 596 OSSL_INOUT_CALLBACK *get_nonce, 597 OSSL_CALLBACK *cleanup_nonce, void *arg)) 598 OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization, 599 (void *vctx)) 600 OSSL_CORE_MAKE_FUNC(size_t,rand_get_seed, 601 (void *vctx, unsigned char **buffer, 602 int entropy, size_t min_len, size_t max_len, 603 int prediction_resistance, 604 const unsigned char *adin, size_t adin_len)) 605 OSSL_CORE_MAKE_FUNC(void,rand_clear_seed, 606 (void *vctx, unsigned char *buffer, size_t b_len)) 607 608 /*- 609 * Key management 610 * 611 * The Key Management takes care of provider side key objects, and includes 612 * all current functionality to create them, destroy them, set parameters 613 * and key material, etc, essentially everything that manipulates the keys 614 * themselves and their parameters. 615 * 616 * The key objects are commonly referred to as |keydata|, and it MUST be able 617 * to contain parameters if the key has any, the public key and the private 618 * key. All parts are optional, but their presence determines what can be 619 * done with the key object in terms of encryption, signature, and so on. 620 * The assumption from libcrypto is that the key object contains any of the 621 * following data combinations: 622 * 623 * - parameters only 624 * - public key only 625 * - public key + private key 626 * - parameters + public key 627 * - parameters + public key + private key 628 * 629 * What "parameters", "public key" and "private key" means in detail is left 630 * to the implementation. In the case of DH and DSA, they would typically 631 * include domain parameters, while for certain variants of RSA, they would 632 * typically include PSS or OAEP parameters. 633 * 634 * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with 635 * OSSL_FUNC_keymgmt_free(). Key objects can have data filled in with 636 * OSSL_FUNC_keymgmt_import(). 637 * 638 * Three functions are made available to check what selection of data is 639 * present in a key object: OSSL_FUNC_keymgmt_has_parameters(), 640 * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(), 641 */ 642 643 /* Key data subset selection - individual bits */ 644 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01 645 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02 646 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04 647 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80 648 649 /* Key data subset selection - combinations */ 650 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \ 651 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \ 652 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) 653 # define OSSL_KEYMGMT_SELECT_KEYPAIR \ 654 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY ) 655 # define OSSL_KEYMGMT_SELECT_ALL \ 656 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS ) 657 658 # define OSSL_KEYMGMT_VALIDATE_FULL_CHECK 0 659 # define OSSL_KEYMGMT_VALIDATE_QUICK_CHECK 1 660 661 /* Basic key object creation */ 662 # define OSSL_FUNC_KEYMGMT_NEW 1 663 OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx)) 664 665 /* Generation, a more complex constructor */ 666 # define OSSL_FUNC_KEYMGMT_GEN_INIT 2 667 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE 3 668 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS 4 669 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS 5 670 # define OSSL_FUNC_KEYMGMT_GEN 6 671 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP 7 672 # define OSSL_FUNC_KEYMGMT_GEN_GET_PARAMS 15 673 # define OSSL_FUNC_KEYMGMT_GEN_GETTABLE_PARAMS 16 674 675 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init, 676 (void *provctx, int selection, const OSSL_PARAM params[])) 677 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template, 678 (void *genctx, void *templ)) 679 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params, 680 (void *genctx, const OSSL_PARAM params[])) 681 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 682 keymgmt_gen_settable_params, 683 (void *genctx, void *provctx)) 684 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_get_params, 685 (void *genctx, OSSL_PARAM params[])) 686 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gen_gettable_params, 687 (void *genctx, void *provctx)) 688 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen, 689 (void *genctx, OSSL_CALLBACK *cb, void *cbarg)) 690 OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx)) 691 692 /* Key loading by object reference */ 693 # define OSSL_FUNC_KEYMGMT_LOAD 8 694 OSSL_CORE_MAKE_FUNC(void *, keymgmt_load, 695 (const void *reference, size_t reference_sz)) 696 697 /* Basic key object destruction */ 698 # define OSSL_FUNC_KEYMGMT_FREE 10 699 OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata)) 700 701 /* Key object information, with discovery */ 702 #define OSSL_FUNC_KEYMGMT_GET_PARAMS 11 703 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 12 704 OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params, 705 (void *keydata, OSSL_PARAM params[])) 706 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params, 707 (void *provctx)) 708 709 #define OSSL_FUNC_KEYMGMT_SET_PARAMS 13 710 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 14 711 OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params, 712 (void *keydata, const OSSL_PARAM params[])) 713 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params, 714 (void *provctx)) 715 716 /* Key checks - discovery of supported operations */ 717 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20 718 OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name, 719 (int operation_id)) 720 721 /* Key checks - key data content checks */ 722 # define OSSL_FUNC_KEYMGMT_HAS 21 723 OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (const void *keydata, int selection)) 724 725 /* Key checks - validation */ 726 # define OSSL_FUNC_KEYMGMT_VALIDATE 22 727 OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (const void *keydata, int selection, 728 int checktype)) 729 730 /* Key checks - matching */ 731 # define OSSL_FUNC_KEYMGMT_MATCH 23 732 OSSL_CORE_MAKE_FUNC(int, keymgmt_match, 733 (const void *keydata1, const void *keydata2, 734 int selection)) 735 736 /* Import and export functions, with discovery */ 737 # define OSSL_FUNC_KEYMGMT_IMPORT 40 738 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41 739 # define OSSL_FUNC_KEYMGMT_EXPORT 42 740 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43 741 OSSL_CORE_MAKE_FUNC(int, keymgmt_import, 742 (void *keydata, int selection, const OSSL_PARAM params[])) 743 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types, 744 (int selection)) 745 OSSL_CORE_MAKE_FUNC(int, keymgmt_export, 746 (void *keydata, int selection, 747 OSSL_CALLBACK *param_cb, void *cbarg)) 748 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types, 749 (int selection)) 750 751 /* Dup function, constructor */ 752 # define OSSL_FUNC_KEYMGMT_DUP 44 753 OSSL_CORE_MAKE_FUNC(void *, keymgmt_dup, 754 (const void *keydata_from, int selection)) 755 756 /* Extended import and export functions */ 757 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES_EX 45 758 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES_EX 46 759 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types_ex, 760 (void *provctx, int selection)) 761 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types_ex, 762 (void *provctx, int selection)) 763 764 /* Key Exchange */ 765 766 # define OSSL_FUNC_KEYEXCH_NEWCTX 1 767 # define OSSL_FUNC_KEYEXCH_INIT 2 768 # define OSSL_FUNC_KEYEXCH_DERIVE 3 769 # define OSSL_FUNC_KEYEXCH_SET_PEER 4 770 # define OSSL_FUNC_KEYEXCH_FREECTX 5 771 # define OSSL_FUNC_KEYEXCH_DUPCTX 6 772 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7 773 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8 774 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9 775 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10 776 777 OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx)) 778 OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey, 779 const OSSL_PARAM params[])) 780 OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx, unsigned char *secret, 781 size_t *secretlen, size_t outlen)) 782 OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey)) 783 OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx)) 784 OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx)) 785 OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx, 786 const OSSL_PARAM params[])) 787 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params, 788 (void *ctx, void *provctx)) 789 OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx, 790 OSSL_PARAM params[])) 791 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params, 792 (void *ctx, void *provctx)) 793 794 /* Signature */ 795 796 # define OSSL_FUNC_SIGNATURE_NEWCTX 1 797 # define OSSL_FUNC_SIGNATURE_SIGN_INIT 2 798 # define OSSL_FUNC_SIGNATURE_SIGN 3 799 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4 800 # define OSSL_FUNC_SIGNATURE_VERIFY 5 801 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6 802 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7 803 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8 804 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9 805 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10 806 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11 807 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12 808 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13 809 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14 810 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15 811 # define OSSL_FUNC_SIGNATURE_FREECTX 16 812 # define OSSL_FUNC_SIGNATURE_DUPCTX 17 813 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18 814 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19 815 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20 816 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21 817 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22 818 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23 819 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24 820 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25 821 # define OSSL_FUNC_SIGNATURE_QUERY_KEY_TYPES 26 822 # define OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_INIT 27 823 # define OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_UPDATE 28 824 # define OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_FINAL 29 825 # define OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_INIT 30 826 # define OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_UPDATE 31 827 # define OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_FINAL 32 828 829 OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx, 830 const char *propq)) 831 OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey, 832 const OSSL_PARAM params[])) 833 OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx, unsigned char *sig, 834 size_t *siglen, size_t sigsize, 835 const unsigned char *tbs, 836 size_t tbslen)) 837 OSSL_CORE_MAKE_FUNC(int, signature_sign_message_init, 838 (void *ctx, void *provkey, const OSSL_PARAM params[])) 839 OSSL_CORE_MAKE_FUNC(int, signature_sign_message_update, 840 (void *ctx, const unsigned char *in, size_t inlen)) 841 OSSL_CORE_MAKE_FUNC(int, signature_sign_message_final, 842 (void *ctx, unsigned char *sig, 843 size_t *siglen, size_t sigsize)) 844 OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey, 845 const OSSL_PARAM params[])) 846 OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx, 847 const unsigned char *sig, 848 size_t siglen, 849 const unsigned char *tbs, 850 size_t tbslen)) 851 OSSL_CORE_MAKE_FUNC(int, signature_verify_message_init, 852 (void *ctx, void *provkey, const OSSL_PARAM params[])) 853 OSSL_CORE_MAKE_FUNC(int, signature_verify_message_update, 854 (void *ctx, const unsigned char *in, size_t inlen)) 855 /* 856 * signature_verify_final requires that the signature to be verified against 857 * is specified via an OSSL_PARAM. 858 */ 859 OSSL_CORE_MAKE_FUNC(int, signature_verify_message_final, (void *ctx)) 860 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init, 861 (void *ctx, void *provkey, const OSSL_PARAM params[])) 862 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover, 863 (void *ctx, unsigned char *rout, size_t *routlen, 864 size_t routsize, const unsigned char *sig, size_t siglen)) 865 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init, 866 (void *ctx, const char *mdname, void *provkey, 867 const OSSL_PARAM params[])) 868 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update, 869 (void *ctx, const unsigned char *data, size_t datalen)) 870 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final, 871 (void *ctx, unsigned char *sig, size_t *siglen, 872 size_t sigsize)) 873 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign, 874 (void *ctx, unsigned char *sigret, size_t *siglen, 875 size_t sigsize, const unsigned char *tbs, size_t tbslen)) 876 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init, 877 (void *ctx, const char *mdname, void *provkey, 878 const OSSL_PARAM params[])) 879 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update, 880 (void *ctx, const unsigned char *data, size_t datalen)) 881 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final, 882 (void *ctx, const unsigned char *sig, size_t siglen)) 883 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify, 884 (void *ctx, const unsigned char *sig, size_t siglen, 885 const unsigned char *tbs, size_t tbslen)) 886 OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx)) 887 OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx)) 888 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params, 889 (void *ctx, OSSL_PARAM params[])) 890 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params, 891 (void *ctx, void *provctx)) 892 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params, 893 (void *ctx, const OSSL_PARAM params[])) 894 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params, 895 (void *ctx, void *provctx)) 896 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params, 897 (void *ctx, OSSL_PARAM params[])) 898 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params, 899 (void *ctx)) 900 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params, 901 (void *ctx, const OSSL_PARAM params[])) 902 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params, 903 (void *ctx)) 904 OSSL_CORE_MAKE_FUNC(const char **, signature_query_key_types, (void)) 905 906 /*- 907 * Symmetric key management 908 * 909 * The Key Management takes care of provider side of symmetric key objects, and 910 * includes essentially everything that manipulates the keys themselves and 911 * their parameters. 912 * 913 * The key objects are commonly referred to as |keydata|, and it MUST be able 914 * to contain parameters if the key has any, and the secret key. 915 * 916 * Key objects are created with OSSL_FUNC_skeymgmt_import() (there is no 917 * dedicated memory allocation function), exported with 918 * OSSL_FUNC_skeymgmt_export() and destroyed with OSSL_FUNC_keymgmt_free(). 919 * 920 */ 921 922 /* Key data subset selection - individual bits */ 923 # define OSSL_SKEYMGMT_SELECT_PARAMETERS 0x01 924 # define OSSL_SKEYMGMT_SELECT_SECRET_KEY 0x02 925 926 /* Key data subset selection - combinations */ 927 # define OSSL_SKEYMGMT_SELECT_ALL \ 928 (OSSL_SKEYMGMT_SELECT_PARAMETERS | OSSL_SKEYMGMT_SELECT_SECRET_KEY) 929 930 # define OSSL_FUNC_SKEYMGMT_FREE 1 931 # define OSSL_FUNC_SKEYMGMT_IMPORT 2 932 # define OSSL_FUNC_SKEYMGMT_EXPORT 3 933 # define OSSL_FUNC_SKEYMGMT_GENERATE 4 934 # define OSSL_FUNC_SKEYMGMT_GET_KEY_ID 5 935 # define OSSL_FUNC_SKEYMGMT_IMP_SETTABLE_PARAMS 6 936 # define OSSL_FUNC_SKEYMGMT_GEN_SETTABLE_PARAMS 7 937 938 OSSL_CORE_MAKE_FUNC(void, skeymgmt_free, (void *keydata)) 939 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 940 skeymgmt_imp_settable_params, (void *provctx)) 941 OSSL_CORE_MAKE_FUNC(void *, skeymgmt_import, (void *provctx, int selection, 942 const OSSL_PARAM params[])) 943 OSSL_CORE_MAKE_FUNC(int, skeymgmt_export, 944 (void *keydata, int selection, 945 OSSL_CALLBACK *param_cb, void *cbarg)) 946 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 947 skeymgmt_gen_settable_params, (void *provctx)) 948 OSSL_CORE_MAKE_FUNC(void *, skeymgmt_generate, (void *provctx, 949 const OSSL_PARAM params[])) 950 OSSL_CORE_MAKE_FUNC(const char *, skeymgmt_get_key_id, (void *keydata)) 951 952 /* Asymmetric Ciphers */ 953 954 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1 955 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2 956 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3 957 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4 958 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5 959 # define OSSL_FUNC_ASYM_CIPHER_FREECTX 6 960 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7 961 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8 962 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9 963 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10 964 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11 965 966 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx)) 967 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey, 968 const OSSL_PARAM params[])) 969 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out, 970 size_t *outlen, 971 size_t outsize, 972 const unsigned char *in, 973 size_t inlen)) 974 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey, 975 const OSSL_PARAM params[])) 976 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out, 977 size_t *outlen, 978 size_t outsize, 979 const unsigned char *in, 980 size_t inlen)) 981 OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx)) 982 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx)) 983 OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params, 984 (void *ctx, OSSL_PARAM params[])) 985 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params, 986 (void *ctx, void *provctx)) 987 OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params, 988 (void *ctx, const OSSL_PARAM params[])) 989 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params, 990 (void *ctx, void *provctx)) 991 992 /* Asymmetric Key encapsulation */ 993 # define OSSL_FUNC_KEM_NEWCTX 1 994 # define OSSL_FUNC_KEM_ENCAPSULATE_INIT 2 995 # define OSSL_FUNC_KEM_ENCAPSULATE 3 996 # define OSSL_FUNC_KEM_DECAPSULATE_INIT 4 997 # define OSSL_FUNC_KEM_DECAPSULATE 5 998 # define OSSL_FUNC_KEM_FREECTX 6 999 # define OSSL_FUNC_KEM_DUPCTX 7 1000 # define OSSL_FUNC_KEM_GET_CTX_PARAMS 8 1001 # define OSSL_FUNC_KEM_GETTABLE_CTX_PARAMS 9 1002 # define OSSL_FUNC_KEM_SET_CTX_PARAMS 10 1003 # define OSSL_FUNC_KEM_SETTABLE_CTX_PARAMS 11 1004 # define OSSL_FUNC_KEM_AUTH_ENCAPSULATE_INIT 12 1005 # define OSSL_FUNC_KEM_AUTH_DECAPSULATE_INIT 13 1006 1007 OSSL_CORE_MAKE_FUNC(void *, kem_newctx, (void *provctx)) 1008 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate_init, (void *ctx, void *provkey, 1009 const OSSL_PARAM params[])) 1010 OSSL_CORE_MAKE_FUNC(int, kem_auth_encapsulate_init, (void *ctx, void *provkey, 1011 void *authprivkey, 1012 const OSSL_PARAM params[])) 1013 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate, (void *ctx, 1014 unsigned char *out, size_t *outlen, 1015 unsigned char *secret, 1016 size_t *secretlen)) 1017 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate_init, (void *ctx, void *provkey, 1018 const OSSL_PARAM params[])) 1019 OSSL_CORE_MAKE_FUNC(int, kem_auth_decapsulate_init, (void *ctx, void *provkey, 1020 void *authpubkey, 1021 const OSSL_PARAM params[])) 1022 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate, (void *ctx, 1023 unsigned char *out, size_t *outlen, 1024 const unsigned char *in, size_t inlen)) 1025 OSSL_CORE_MAKE_FUNC(void, kem_freectx, (void *ctx)) 1026 OSSL_CORE_MAKE_FUNC(void *, kem_dupctx, (void *ctx)) 1027 OSSL_CORE_MAKE_FUNC(int, kem_get_ctx_params, (void *ctx, OSSL_PARAM params[])) 1028 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_gettable_ctx_params, 1029 (void *ctx, void *provctx)) 1030 OSSL_CORE_MAKE_FUNC(int, kem_set_ctx_params, 1031 (void *ctx, const OSSL_PARAM params[])) 1032 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_settable_ctx_params, 1033 (void *ctx, void *provctx)) 1034 1035 /* Encoders and decoders */ 1036 # define OSSL_FUNC_ENCODER_NEWCTX 1 1037 # define OSSL_FUNC_ENCODER_FREECTX 2 1038 # define OSSL_FUNC_ENCODER_GET_PARAMS 3 1039 # define OSSL_FUNC_ENCODER_GETTABLE_PARAMS 4 1040 # define OSSL_FUNC_ENCODER_SET_CTX_PARAMS 5 1041 # define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS 6 1042 # define OSSL_FUNC_ENCODER_DOES_SELECTION 10 1043 # define OSSL_FUNC_ENCODER_ENCODE 11 1044 # define OSSL_FUNC_ENCODER_IMPORT_OBJECT 20 1045 # define OSSL_FUNC_ENCODER_FREE_OBJECT 21 1046 OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx)) 1047 OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx)) 1048 OSSL_CORE_MAKE_FUNC(int, encoder_get_params, (OSSL_PARAM params[])) 1049 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_gettable_params, 1050 (void *provctx)) 1051 OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params, 1052 (void *ctx, const OSSL_PARAM params[])) 1053 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params, 1054 (void *provctx)) 1055 1056 OSSL_CORE_MAKE_FUNC(int, encoder_does_selection, 1057 (void *provctx, int selection)) 1058 OSSL_CORE_MAKE_FUNC(int, encoder_encode, 1059 (void *ctx, OSSL_CORE_BIO *out, 1060 const void *obj_raw, const OSSL_PARAM obj_abstract[], 1061 int selection, 1062 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)) 1063 1064 OSSL_CORE_MAKE_FUNC(void *, encoder_import_object, 1065 (void *ctx, int selection, const OSSL_PARAM params[])) 1066 OSSL_CORE_MAKE_FUNC(void, encoder_free_object, (void *obj)) 1067 1068 # define OSSL_FUNC_DECODER_NEWCTX 1 1069 # define OSSL_FUNC_DECODER_FREECTX 2 1070 # define OSSL_FUNC_DECODER_GET_PARAMS 3 1071 # define OSSL_FUNC_DECODER_GETTABLE_PARAMS 4 1072 # define OSSL_FUNC_DECODER_SET_CTX_PARAMS 5 1073 # define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS 6 1074 # define OSSL_FUNC_DECODER_DOES_SELECTION 10 1075 # define OSSL_FUNC_DECODER_DECODE 11 1076 # define OSSL_FUNC_DECODER_EXPORT_OBJECT 20 1077 OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx)) 1078 OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx)) 1079 OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[])) 1080 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params, 1081 (void *provctx)) 1082 OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params, 1083 (void *ctx, const OSSL_PARAM params[])) 1084 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params, 1085 (void *provctx)) 1086 1087 OSSL_CORE_MAKE_FUNC(int, decoder_does_selection, 1088 (void *provctx, int selection)) 1089 OSSL_CORE_MAKE_FUNC(int, decoder_decode, 1090 (void *ctx, OSSL_CORE_BIO *in, int selection, 1091 OSSL_CALLBACK *data_cb, void *data_cbarg, 1092 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1093 OSSL_CORE_MAKE_FUNC(int, decoder_export_object, 1094 (void *ctx, const void *objref, size_t objref_sz, 1095 OSSL_CALLBACK *export_cb, void *export_cbarg)) 1096 1097 /*- 1098 * Store 1099 * 1100 * Objects are scanned by using the 'open', 'load', 'eof' and 'close' 1101 * functions, which implement an OSSL_STORE loader. 1102 * 1103 * store_load() works in a way that's very similar to the decoders, in 1104 * that they pass an abstract object through a callback, either as a DER 1105 * octet string or as an object reference, which libcrypto will have to 1106 * deal with. 1107 */ 1108 1109 #define OSSL_FUNC_STORE_OPEN 1 1110 #define OSSL_FUNC_STORE_ATTACH 2 1111 #define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS 3 1112 #define OSSL_FUNC_STORE_SET_CTX_PARAMS 4 1113 #define OSSL_FUNC_STORE_LOAD 5 1114 #define OSSL_FUNC_STORE_EOF 6 1115 #define OSSL_FUNC_STORE_CLOSE 7 1116 #define OSSL_FUNC_STORE_EXPORT_OBJECT 8 1117 #define OSSL_FUNC_STORE_DELETE 9 1118 #define OSSL_FUNC_STORE_OPEN_EX 10 1119 OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri)) 1120 OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in)) 1121 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params, 1122 (void *provctx)) 1123 OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params, 1124 (void *loaderctx, const OSSL_PARAM params[])) 1125 OSSL_CORE_MAKE_FUNC(int, store_load, 1126 (void *loaderctx, 1127 OSSL_CALLBACK *object_cb, void *object_cbarg, 1128 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1129 OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx)) 1130 OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx)) 1131 OSSL_CORE_MAKE_FUNC(int, store_export_object, 1132 (void *loaderctx, const void *objref, size_t objref_sz, 1133 OSSL_CALLBACK *export_cb, void *export_cbarg)) 1134 OSSL_CORE_MAKE_FUNC(int, store_delete, 1135 (void *provctx, const char *uri, const OSSL_PARAM params[], 1136 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1137 OSSL_CORE_MAKE_FUNC(void *, store_open_ex, 1138 (void *provctx, const char *uri, const OSSL_PARAM params[], 1139 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1140 1141 # ifdef __cplusplus 1142 } 1143 # endif 1144 1145 #endif 1146