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 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */ 257 # define OSSL_FUNC_PROVIDER_TEARDOWN 1024 258 OSSL_CORE_MAKE_FUNC(void, provider_teardown, (void *provctx)) 259 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025 260 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 261 provider_gettable_params,(void *provctx)) 262 # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026 263 OSSL_CORE_MAKE_FUNC(int, provider_get_params, (void *provctx, 264 OSSL_PARAM params[])) 265 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027 266 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation, 267 (void *provctx, int operation_id, int *no_store)) 268 # define OSSL_FUNC_PROVIDER_UNQUERY_OPERATION 1028 269 OSSL_CORE_MAKE_FUNC(void, provider_unquery_operation, 270 (void *provctx, int operation_id, const OSSL_ALGORITHM *)) 271 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1029 272 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings, 273 (void *provctx)) 274 # define OSSL_FUNC_PROVIDER_GET_CAPABILITIES 1030 275 OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx, 276 const char *capability, OSSL_CALLBACK *cb, void *arg)) 277 # define OSSL_FUNC_PROVIDER_SELF_TEST 1031 278 OSSL_CORE_MAKE_FUNC(int, provider_self_test, (void *provctx)) 279 # define OSSL_FUNC_PROVIDER_RANDOM_BYTES 1032 280 OSSL_CORE_MAKE_FUNC(int, provider_random_bytes, (void *provctx, int which, 281 void *buf, size_t n, 282 unsigned int strength)) 283 284 /* Libssl related functions */ 285 #define OSSL_FUNC_SSL_QUIC_TLS_CRYPTO_SEND 2001 286 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_crypto_send, 287 (SSL *s, const unsigned char *buf, size_t buf_len, 288 size_t *consumed, void *arg)) 289 #define OSSL_FUNC_SSL_QUIC_TLS_CRYPTO_RECV_RCD 2002 290 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_crypto_recv_rcd, 291 (SSL *s, const unsigned char **buf, size_t *bytes_read, 292 void *arg)) 293 #define OSSL_FUNC_SSL_QUIC_TLS_CRYPTO_RELEASE_RCD 2003 294 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_crypto_release_rcd, 295 (SSL *s, size_t bytes_read, void *arg)) 296 #define OSSL_FUNC_SSL_QUIC_TLS_YIELD_SECRET 2004 297 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_yield_secret, 298 (SSL *s, uint32_t prot_level, int direction, 299 const unsigned char *secret, size_t secret_len, void *arg)) 300 #define OSSL_FUNC_SSL_QUIC_TLS_GOT_TRANSPORT_PARAMS 2005 301 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_got_transport_params, 302 (SSL *s, const unsigned char *params, size_t params_len, 303 void *arg)) 304 #define OSSL_FUNC_SSL_QUIC_TLS_ALERT 2006 305 OSSL_CORE_MAKE_FUNC(int, SSL_QUIC_TLS_alert, 306 (SSL *s, unsigned char alert_code, void *arg)) 307 308 /* Operations */ 309 310 # define OSSL_OP_DIGEST 1 311 # define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */ 312 # define OSSL_OP_MAC 3 313 # define OSSL_OP_KDF 4 314 # define OSSL_OP_RAND 5 315 # define OSSL_OP_KEYMGMT 10 316 # define OSSL_OP_KEYEXCH 11 317 # define OSSL_OP_SIGNATURE 12 318 # define OSSL_OP_ASYM_CIPHER 13 319 # define OSSL_OP_KEM 14 320 # define OSSL_OP_SKEYMGMT 15 321 /* New section for non-EVP operations */ 322 # define OSSL_OP_ENCODER 20 323 # define OSSL_OP_DECODER 21 324 # define OSSL_OP_STORE 22 325 /* Highest known operation number */ 326 # define OSSL_OP__HIGHEST 22 327 328 /* Digests */ 329 330 # define OSSL_FUNC_DIGEST_NEWCTX 1 331 # define OSSL_FUNC_DIGEST_INIT 2 332 # define OSSL_FUNC_DIGEST_UPDATE 3 333 # define OSSL_FUNC_DIGEST_FINAL 4 334 # define OSSL_FUNC_DIGEST_DIGEST 5 335 # define OSSL_FUNC_DIGEST_FREECTX 6 336 # define OSSL_FUNC_DIGEST_DUPCTX 7 337 # define OSSL_FUNC_DIGEST_GET_PARAMS 8 338 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9 339 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10 340 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11 341 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12 342 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13 343 # define OSSL_FUNC_DIGEST_SQUEEZE 14 344 # define OSSL_FUNC_DIGEST_COPYCTX 15 345 346 OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx)) 347 OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx, const OSSL_PARAM params[])) 348 OSSL_CORE_MAKE_FUNC(int, digest_update, 349 (void *dctx, const unsigned char *in, size_t inl)) 350 OSSL_CORE_MAKE_FUNC(int, digest_final, 351 (void *dctx, 352 unsigned char *out, size_t *outl, size_t outsz)) 353 OSSL_CORE_MAKE_FUNC(int, digest_squeeze, 354 (void *dctx, 355 unsigned char *out, size_t *outl, size_t outsz)) 356 OSSL_CORE_MAKE_FUNC(int, digest_digest, 357 (void *provctx, const unsigned char *in, size_t inl, 358 unsigned char *out, size_t *outl, size_t outsz)) 359 360 OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx)) 361 OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx)) 362 OSSL_CORE_MAKE_FUNC(void, digest_copyctx, (void *outctx, void *inctx)) 363 364 OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[])) 365 OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params, 366 (void *vctx, const OSSL_PARAM params[])) 367 OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params, 368 (void *vctx, OSSL_PARAM params[])) 369 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params, 370 (void *provctx)) 371 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params, 372 (void *dctx, void *provctx)) 373 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params, 374 (void *dctx, void *provctx)) 375 376 /* Symmetric Ciphers */ 377 378 # define OSSL_FUNC_CIPHER_NEWCTX 1 379 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2 380 # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3 381 # define OSSL_FUNC_CIPHER_UPDATE 4 382 # define OSSL_FUNC_CIPHER_FINAL 5 383 # define OSSL_FUNC_CIPHER_CIPHER 6 384 # define OSSL_FUNC_CIPHER_FREECTX 7 385 # define OSSL_FUNC_CIPHER_DUPCTX 8 386 # define OSSL_FUNC_CIPHER_GET_PARAMS 9 387 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10 388 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11 389 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12 390 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13 391 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14 392 # define OSSL_FUNC_CIPHER_PIPELINE_ENCRYPT_INIT 15 393 # define OSSL_FUNC_CIPHER_PIPELINE_DECRYPT_INIT 16 394 # define OSSL_FUNC_CIPHER_PIPELINE_UPDATE 17 395 # define OSSL_FUNC_CIPHER_PIPELINE_FINAL 18 396 # define OSSL_FUNC_CIPHER_ENCRYPT_SKEY_INIT 19 397 # define OSSL_FUNC_CIPHER_DECRYPT_SKEY_INIT 20 398 399 OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx)) 400 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx, 401 const unsigned char *key, 402 size_t keylen, 403 const unsigned char *iv, 404 size_t ivlen, 405 const OSSL_PARAM params[])) 406 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx, 407 const unsigned char *key, 408 size_t keylen, 409 const unsigned char *iv, 410 size_t ivlen, 411 const OSSL_PARAM params[])) 412 OSSL_CORE_MAKE_FUNC(int, cipher_update, 413 (void *cctx, 414 unsigned char *out, size_t *outl, size_t outsize, 415 const unsigned char *in, size_t inl)) 416 OSSL_CORE_MAKE_FUNC(int, cipher_final, 417 (void *cctx, 418 unsigned char *out, size_t *outl, size_t outsize)) 419 OSSL_CORE_MAKE_FUNC(int, cipher_cipher, 420 (void *cctx, 421 unsigned char *out, size_t *outl, size_t outsize, 422 const unsigned char *in, size_t inl)) 423 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_encrypt_init, 424 (void *cctx, 425 const unsigned char *key, size_t keylen, 426 size_t numpipes, const unsigned char **iv, size_t ivlen, 427 const OSSL_PARAM params[])) 428 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_decrypt_init, 429 (void *cctx, 430 const unsigned char *key, size_t keylen, 431 size_t numpipes, const unsigned char **iv, size_t ivlen, 432 const OSSL_PARAM params[])) 433 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_update, 434 (void *cctx, size_t numpipes, 435 unsigned char **out, size_t *outl, const size_t *outsize, 436 const unsigned char **in, const size_t *inl)) 437 OSSL_CORE_MAKE_FUNC(int, cipher_pipeline_final, 438 (void *cctx, size_t numpipes, 439 unsigned char **out, size_t *outl, const size_t *outsize)) 440 OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx)) 441 OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx)) 442 OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[])) 443 OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx, 444 OSSL_PARAM params[])) 445 OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx, 446 const OSSL_PARAM params[])) 447 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params, 448 (void *provctx)) 449 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params, 450 (void *cctx, void *provctx)) 451 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params, 452 (void *cctx, void *provctx)) 453 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_skey_init, (void *cctx, 454 void *skeydata, 455 const unsigned char *iv, 456 size_t ivlen, 457 const OSSL_PARAM params[])) 458 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_skey_init, (void *cctx, 459 void *skeydata, 460 const unsigned char *iv, 461 size_t ivlen, 462 const OSSL_PARAM params[])) 463 464 /* MACs */ 465 466 # define OSSL_FUNC_MAC_NEWCTX 1 467 # define OSSL_FUNC_MAC_DUPCTX 2 468 # define OSSL_FUNC_MAC_FREECTX 3 469 # define OSSL_FUNC_MAC_INIT 4 470 # define OSSL_FUNC_MAC_UPDATE 5 471 # define OSSL_FUNC_MAC_FINAL 6 472 # define OSSL_FUNC_MAC_GET_PARAMS 7 473 # define OSSL_FUNC_MAC_GET_CTX_PARAMS 8 474 # define OSSL_FUNC_MAC_SET_CTX_PARAMS 9 475 # define OSSL_FUNC_MAC_GETTABLE_PARAMS 10 476 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11 477 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12 478 # define OSSL_FUNC_MAC_INIT_SKEY 13 479 480 OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx)) 481 OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src)) 482 OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx)) 483 OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx, const unsigned char *key, 484 size_t keylen, const OSSL_PARAM params[])) 485 OSSL_CORE_MAKE_FUNC(int, mac_update, 486 (void *mctx, const unsigned char *in, size_t inl)) 487 OSSL_CORE_MAKE_FUNC(int, mac_final, 488 (void *mctx, 489 unsigned char *out, size_t *outl, size_t outsize)) 490 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx)) 491 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params, 492 (void *mctx, void *provctx)) 493 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params, 494 (void *mctx, void *provctx)) 495 OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[])) 496 OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params, 497 (void *mctx, OSSL_PARAM params[])) 498 OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params, 499 (void *mctx, const OSSL_PARAM params[])) 500 OSSL_CORE_MAKE_FUNC(int, mac_init_skey, (void *mctx, void *key, const OSSL_PARAM params[])) 501 502 /* KDFs and PRFs */ 503 504 # define OSSL_FUNC_KDF_NEWCTX 1 505 # define OSSL_FUNC_KDF_DUPCTX 2 506 # define OSSL_FUNC_KDF_FREECTX 3 507 # define OSSL_FUNC_KDF_RESET 4 508 # define OSSL_FUNC_KDF_DERIVE 5 509 # define OSSL_FUNC_KDF_GETTABLE_PARAMS 6 510 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7 511 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8 512 # define OSSL_FUNC_KDF_GET_PARAMS 9 513 # define OSSL_FUNC_KDF_GET_CTX_PARAMS 10 514 # define OSSL_FUNC_KDF_SET_CTX_PARAMS 11 515 516 OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx)) 517 OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src)) 518 OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx)) 519 OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx)) 520 OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key, 521 size_t keylen, const OSSL_PARAM params[])) 522 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx)) 523 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params, 524 (void *kctx, void *provctx)) 525 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params, 526 (void *kctx, void *provctx)) 527 OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[])) 528 OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params, 529 (void *kctx, OSSL_PARAM params[])) 530 OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params, 531 (void *kctx, const OSSL_PARAM params[])) 532 533 /* RAND */ 534 535 # define OSSL_FUNC_RAND_NEWCTX 1 536 # define OSSL_FUNC_RAND_FREECTX 2 537 # define OSSL_FUNC_RAND_INSTANTIATE 3 538 # define OSSL_FUNC_RAND_UNINSTANTIATE 4 539 # define OSSL_FUNC_RAND_GENERATE 5 540 # define OSSL_FUNC_RAND_RESEED 6 541 # define OSSL_FUNC_RAND_NONCE 7 542 # define OSSL_FUNC_RAND_ENABLE_LOCKING 8 543 # define OSSL_FUNC_RAND_LOCK 9 544 # define OSSL_FUNC_RAND_UNLOCK 10 545 # define OSSL_FUNC_RAND_GETTABLE_PARAMS 11 546 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS 12 547 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS 13 548 # define OSSL_FUNC_RAND_GET_PARAMS 14 549 # define OSSL_FUNC_RAND_GET_CTX_PARAMS 15 550 # define OSSL_FUNC_RAND_SET_CTX_PARAMS 16 551 # define OSSL_FUNC_RAND_VERIFY_ZEROIZATION 17 552 # define OSSL_FUNC_RAND_GET_SEED 18 553 # define OSSL_FUNC_RAND_CLEAR_SEED 19 554 555 OSSL_CORE_MAKE_FUNC(void *,rand_newctx, 556 (void *provctx, void *parent, 557 const OSSL_DISPATCH *parent_calls)) 558 OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx)) 559 OSSL_CORE_MAKE_FUNC(int,rand_instantiate, 560 (void *vdrbg, unsigned int strength, 561 int prediction_resistance, 562 const unsigned char *pstr, size_t pstr_len, 563 const OSSL_PARAM params[])) 564 OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg)) 565 OSSL_CORE_MAKE_FUNC(int,rand_generate, 566 (void *vctx, unsigned char *out, size_t outlen, 567 unsigned int strength, int prediction_resistance, 568 const unsigned char *addin, size_t addin_len)) 569 OSSL_CORE_MAKE_FUNC(int,rand_reseed, 570 (void *vctx, int prediction_resistance, 571 const unsigned char *ent, size_t ent_len, 572 const unsigned char *addin, size_t addin_len)) 573 OSSL_CORE_MAKE_FUNC(size_t,rand_nonce, 574 (void *vctx, unsigned char *out, unsigned int strength, 575 size_t min_noncelen, size_t max_noncelen)) 576 OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx)) 577 OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx)) 578 OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx)) 579 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx)) 580 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params, 581 (void *vctx, void *provctx)) 582 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params, 583 (void *vctx, void *provctx)) 584 OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[])) 585 OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params, 586 (void *vctx, OSSL_PARAM params[])) 587 OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params, 588 (void *vctx, const OSSL_PARAM params[])) 589 OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks, 590 (void *vctx, OSSL_INOUT_CALLBACK *get_entropy, 591 OSSL_CALLBACK *cleanup_entropy, 592 OSSL_INOUT_CALLBACK *get_nonce, 593 OSSL_CALLBACK *cleanup_nonce, void *arg)) 594 OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization, 595 (void *vctx)) 596 OSSL_CORE_MAKE_FUNC(size_t,rand_get_seed, 597 (void *vctx, unsigned char **buffer, 598 int entropy, size_t min_len, size_t max_len, 599 int prediction_resistance, 600 const unsigned char *adin, size_t adin_len)) 601 OSSL_CORE_MAKE_FUNC(void,rand_clear_seed, 602 (void *vctx, unsigned char *buffer, size_t b_len)) 603 604 /*- 605 * Key management 606 * 607 * The Key Management takes care of provider side key objects, and includes 608 * all current functionality to create them, destroy them, set parameters 609 * and key material, etc, essentially everything that manipulates the keys 610 * themselves and their parameters. 611 * 612 * The key objects are commonly referred to as |keydata|, and it MUST be able 613 * to contain parameters if the key has any, the public key and the private 614 * key. All parts are optional, but their presence determines what can be 615 * done with the key object in terms of encryption, signature, and so on. 616 * The assumption from libcrypto is that the key object contains any of the 617 * following data combinations: 618 * 619 * - parameters only 620 * - public key only 621 * - public key + private key 622 * - parameters + public key 623 * - parameters + public key + private key 624 * 625 * What "parameters", "public key" and "private key" means in detail is left 626 * to the implementation. In the case of DH and DSA, they would typically 627 * include domain parameters, while for certain variants of RSA, they would 628 * typically include PSS or OAEP parameters. 629 * 630 * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with 631 * OSSL_FUNC_keymgmt_free(). Key objects can have data filled in with 632 * OSSL_FUNC_keymgmt_import(). 633 * 634 * Three functions are made available to check what selection of data is 635 * present in a key object: OSSL_FUNC_keymgmt_has_parameters(), 636 * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(), 637 */ 638 639 /* Key data subset selection - individual bits */ 640 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01 641 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02 642 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04 643 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80 644 645 /* Key data subset selection - combinations */ 646 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \ 647 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \ 648 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) 649 # define OSSL_KEYMGMT_SELECT_KEYPAIR \ 650 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY ) 651 # define OSSL_KEYMGMT_SELECT_ALL \ 652 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS ) 653 654 # define OSSL_KEYMGMT_VALIDATE_FULL_CHECK 0 655 # define OSSL_KEYMGMT_VALIDATE_QUICK_CHECK 1 656 657 /* Basic key object creation */ 658 # define OSSL_FUNC_KEYMGMT_NEW 1 659 OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx)) 660 661 /* Generation, a more complex constructor */ 662 # define OSSL_FUNC_KEYMGMT_GEN_INIT 2 663 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE 3 664 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS 4 665 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS 5 666 # define OSSL_FUNC_KEYMGMT_GEN 6 667 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP 7 668 # define OSSL_FUNC_KEYMGMT_GEN_GET_PARAMS 15 669 # define OSSL_FUNC_KEYMGMT_GEN_GETTABLE_PARAMS 16 670 671 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init, 672 (void *provctx, int selection, const OSSL_PARAM params[])) 673 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template, 674 (void *genctx, void *templ)) 675 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params, 676 (void *genctx, const OSSL_PARAM params[])) 677 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 678 keymgmt_gen_settable_params, 679 (void *genctx, void *provctx)) 680 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_get_params, 681 (void *genctx, OSSL_PARAM params[])) 682 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gen_gettable_params, 683 (void *genctx, void *provctx)) 684 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen, 685 (void *genctx, OSSL_CALLBACK *cb, void *cbarg)) 686 OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx)) 687 688 /* Key loading by object reference */ 689 # define OSSL_FUNC_KEYMGMT_LOAD 8 690 OSSL_CORE_MAKE_FUNC(void *, keymgmt_load, 691 (const void *reference, size_t reference_sz)) 692 693 /* Basic key object destruction */ 694 # define OSSL_FUNC_KEYMGMT_FREE 10 695 OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata)) 696 697 /* Key object information, with discovery */ 698 #define OSSL_FUNC_KEYMGMT_GET_PARAMS 11 699 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 12 700 OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params, 701 (void *keydata, OSSL_PARAM params[])) 702 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params, 703 (void *provctx)) 704 705 #define OSSL_FUNC_KEYMGMT_SET_PARAMS 13 706 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 14 707 OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params, 708 (void *keydata, const OSSL_PARAM params[])) 709 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params, 710 (void *provctx)) 711 712 /* Key checks - discovery of supported operations */ 713 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20 714 OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name, 715 (int operation_id)) 716 717 /* Key checks - key data content checks */ 718 # define OSSL_FUNC_KEYMGMT_HAS 21 719 OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (const void *keydata, int selection)) 720 721 /* Key checks - validation */ 722 # define OSSL_FUNC_KEYMGMT_VALIDATE 22 723 OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (const void *keydata, int selection, 724 int checktype)) 725 726 /* Key checks - matching */ 727 # define OSSL_FUNC_KEYMGMT_MATCH 23 728 OSSL_CORE_MAKE_FUNC(int, keymgmt_match, 729 (const void *keydata1, const void *keydata2, 730 int selection)) 731 732 /* Import and export functions, with discovery */ 733 # define OSSL_FUNC_KEYMGMT_IMPORT 40 734 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41 735 # define OSSL_FUNC_KEYMGMT_EXPORT 42 736 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43 737 OSSL_CORE_MAKE_FUNC(int, keymgmt_import, 738 (void *keydata, int selection, const OSSL_PARAM params[])) 739 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types, 740 (int selection)) 741 OSSL_CORE_MAKE_FUNC(int, keymgmt_export, 742 (void *keydata, int selection, 743 OSSL_CALLBACK *param_cb, void *cbarg)) 744 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types, 745 (int selection)) 746 747 /* Dup function, constructor */ 748 # define OSSL_FUNC_KEYMGMT_DUP 44 749 OSSL_CORE_MAKE_FUNC(void *, keymgmt_dup, 750 (const void *keydata_from, int selection)) 751 752 /* Extended import and export functions */ 753 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES_EX 45 754 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES_EX 46 755 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types_ex, 756 (void *provctx, int selection)) 757 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types_ex, 758 (void *provctx, int selection)) 759 760 /* Key Exchange */ 761 762 # define OSSL_FUNC_KEYEXCH_NEWCTX 1 763 # define OSSL_FUNC_KEYEXCH_INIT 2 764 # define OSSL_FUNC_KEYEXCH_DERIVE 3 765 # define OSSL_FUNC_KEYEXCH_SET_PEER 4 766 # define OSSL_FUNC_KEYEXCH_FREECTX 5 767 # define OSSL_FUNC_KEYEXCH_DUPCTX 6 768 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7 769 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8 770 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9 771 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10 772 773 OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx)) 774 OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey, 775 const OSSL_PARAM params[])) 776 OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx, unsigned char *secret, 777 size_t *secretlen, size_t outlen)) 778 OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey)) 779 OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx)) 780 OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx)) 781 OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx, 782 const OSSL_PARAM params[])) 783 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params, 784 (void *ctx, void *provctx)) 785 OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx, 786 OSSL_PARAM params[])) 787 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params, 788 (void *ctx, void *provctx)) 789 790 /* Signature */ 791 792 # define OSSL_FUNC_SIGNATURE_NEWCTX 1 793 # define OSSL_FUNC_SIGNATURE_SIGN_INIT 2 794 # define OSSL_FUNC_SIGNATURE_SIGN 3 795 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4 796 # define OSSL_FUNC_SIGNATURE_VERIFY 5 797 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6 798 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7 799 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8 800 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9 801 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10 802 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11 803 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12 804 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13 805 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14 806 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15 807 # define OSSL_FUNC_SIGNATURE_FREECTX 16 808 # define OSSL_FUNC_SIGNATURE_DUPCTX 17 809 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18 810 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19 811 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20 812 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21 813 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22 814 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23 815 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24 816 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25 817 # define OSSL_FUNC_SIGNATURE_QUERY_KEY_TYPES 26 818 # define OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_INIT 27 819 # define OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_UPDATE 28 820 # define OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_FINAL 29 821 # define OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_INIT 30 822 # define OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_UPDATE 31 823 # define OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_FINAL 32 824 825 OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx, 826 const char *propq)) 827 OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey, 828 const OSSL_PARAM params[])) 829 OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx, unsigned char *sig, 830 size_t *siglen, size_t sigsize, 831 const unsigned char *tbs, 832 size_t tbslen)) 833 OSSL_CORE_MAKE_FUNC(int, signature_sign_message_init, 834 (void *ctx, void *provkey, const OSSL_PARAM params[])) 835 OSSL_CORE_MAKE_FUNC(int, signature_sign_message_update, 836 (void *ctx, const unsigned char *in, size_t inlen)) 837 OSSL_CORE_MAKE_FUNC(int, signature_sign_message_final, 838 (void *ctx, unsigned char *sig, 839 size_t *siglen, size_t sigsize)) 840 OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey, 841 const OSSL_PARAM params[])) 842 OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx, 843 const unsigned char *sig, 844 size_t siglen, 845 const unsigned char *tbs, 846 size_t tbslen)) 847 OSSL_CORE_MAKE_FUNC(int, signature_verify_message_init, 848 (void *ctx, void *provkey, const OSSL_PARAM params[])) 849 OSSL_CORE_MAKE_FUNC(int, signature_verify_message_update, 850 (void *ctx, const unsigned char *in, size_t inlen)) 851 /* 852 * signature_verify_final requires that the signature to be verified against 853 * is specified via an OSSL_PARAM. 854 */ 855 OSSL_CORE_MAKE_FUNC(int, signature_verify_message_final, (void *ctx)) 856 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init, 857 (void *ctx, void *provkey, const OSSL_PARAM params[])) 858 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover, 859 (void *ctx, unsigned char *rout, size_t *routlen, 860 size_t routsize, const unsigned char *sig, size_t siglen)) 861 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init, 862 (void *ctx, const char *mdname, void *provkey, 863 const OSSL_PARAM params[])) 864 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update, 865 (void *ctx, const unsigned char *data, size_t datalen)) 866 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final, 867 (void *ctx, unsigned char *sig, size_t *siglen, 868 size_t sigsize)) 869 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign, 870 (void *ctx, unsigned char *sigret, size_t *siglen, 871 size_t sigsize, const unsigned char *tbs, size_t tbslen)) 872 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init, 873 (void *ctx, const char *mdname, void *provkey, 874 const OSSL_PARAM params[])) 875 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update, 876 (void *ctx, const unsigned char *data, size_t datalen)) 877 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final, 878 (void *ctx, const unsigned char *sig, size_t siglen)) 879 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify, 880 (void *ctx, const unsigned char *sig, size_t siglen, 881 const unsigned char *tbs, size_t tbslen)) 882 OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx)) 883 OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx)) 884 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params, 885 (void *ctx, OSSL_PARAM params[])) 886 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params, 887 (void *ctx, void *provctx)) 888 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params, 889 (void *ctx, const OSSL_PARAM params[])) 890 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params, 891 (void *ctx, void *provctx)) 892 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params, 893 (void *ctx, OSSL_PARAM params[])) 894 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params, 895 (void *ctx)) 896 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params, 897 (void *ctx, const OSSL_PARAM params[])) 898 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params, 899 (void *ctx)) 900 OSSL_CORE_MAKE_FUNC(const char **, signature_query_key_types, (void)) 901 902 /*- 903 * Symmetric key management 904 * 905 * The Key Management takes care of provider side of symmetric key objects, and 906 * includes essentially everything that manipulates the keys themselves and 907 * their parameters. 908 * 909 * The key objects are commonly referred to as |keydata|, and it MUST be able 910 * to contain parameters if the key has any, and the secret key. 911 * 912 * Key objects are created with OSSL_FUNC_skeymgmt_import() (there is no 913 * dedicated memory allocation function), exported with 914 * OSSL_FUNC_skeymgmt_export() and destroyed with OSSL_FUNC_keymgmt_free(). 915 * 916 */ 917 918 /* Key data subset selection - individual bits */ 919 # define OSSL_SKEYMGMT_SELECT_PARAMETERS 0x01 920 # define OSSL_SKEYMGMT_SELECT_SECRET_KEY 0x02 921 922 /* Key data subset selection - combinations */ 923 # define OSSL_SKEYMGMT_SELECT_ALL \ 924 (OSSL_SKEYMGMT_SELECT_PARAMETERS | OSSL_SKEYMGMT_SELECT_SECRET_KEY) 925 926 # define OSSL_FUNC_SKEYMGMT_FREE 1 927 # define OSSL_FUNC_SKEYMGMT_IMPORT 2 928 # define OSSL_FUNC_SKEYMGMT_EXPORT 3 929 # define OSSL_FUNC_SKEYMGMT_GENERATE 4 930 # define OSSL_FUNC_SKEYMGMT_GET_KEY_ID 5 931 # define OSSL_FUNC_SKEYMGMT_IMP_SETTABLE_PARAMS 6 932 # define OSSL_FUNC_SKEYMGMT_GEN_SETTABLE_PARAMS 7 933 934 OSSL_CORE_MAKE_FUNC(void, skeymgmt_free, (void *keydata)) 935 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 936 skeymgmt_imp_settable_params, (void *provctx)) 937 OSSL_CORE_MAKE_FUNC(void *, skeymgmt_import, (void *provctx, int selection, 938 const OSSL_PARAM params[])) 939 OSSL_CORE_MAKE_FUNC(int, skeymgmt_export, 940 (void *keydata, int selection, 941 OSSL_CALLBACK *param_cb, void *cbarg)) 942 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, 943 skeymgmt_gen_settable_params, (void *provctx)) 944 OSSL_CORE_MAKE_FUNC(void *, skeymgmt_generate, (void *provctx, 945 const OSSL_PARAM params[])) 946 OSSL_CORE_MAKE_FUNC(const char *, skeymgmt_get_key_id, (void *keydata)) 947 948 /* Asymmetric Ciphers */ 949 950 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1 951 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2 952 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3 953 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4 954 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5 955 # define OSSL_FUNC_ASYM_CIPHER_FREECTX 6 956 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7 957 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8 958 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9 959 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10 960 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11 961 962 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx)) 963 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey, 964 const OSSL_PARAM params[])) 965 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out, 966 size_t *outlen, 967 size_t outsize, 968 const unsigned char *in, 969 size_t inlen)) 970 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey, 971 const OSSL_PARAM params[])) 972 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out, 973 size_t *outlen, 974 size_t outsize, 975 const unsigned char *in, 976 size_t inlen)) 977 OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx)) 978 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx)) 979 OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params, 980 (void *ctx, OSSL_PARAM params[])) 981 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params, 982 (void *ctx, void *provctx)) 983 OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params, 984 (void *ctx, const OSSL_PARAM params[])) 985 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params, 986 (void *ctx, void *provctx)) 987 988 /* Asymmetric Key encapsulation */ 989 # define OSSL_FUNC_KEM_NEWCTX 1 990 # define OSSL_FUNC_KEM_ENCAPSULATE_INIT 2 991 # define OSSL_FUNC_KEM_ENCAPSULATE 3 992 # define OSSL_FUNC_KEM_DECAPSULATE_INIT 4 993 # define OSSL_FUNC_KEM_DECAPSULATE 5 994 # define OSSL_FUNC_KEM_FREECTX 6 995 # define OSSL_FUNC_KEM_DUPCTX 7 996 # define OSSL_FUNC_KEM_GET_CTX_PARAMS 8 997 # define OSSL_FUNC_KEM_GETTABLE_CTX_PARAMS 9 998 # define OSSL_FUNC_KEM_SET_CTX_PARAMS 10 999 # define OSSL_FUNC_KEM_SETTABLE_CTX_PARAMS 11 1000 # define OSSL_FUNC_KEM_AUTH_ENCAPSULATE_INIT 12 1001 # define OSSL_FUNC_KEM_AUTH_DECAPSULATE_INIT 13 1002 1003 OSSL_CORE_MAKE_FUNC(void *, kem_newctx, (void *provctx)) 1004 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate_init, (void *ctx, void *provkey, 1005 const OSSL_PARAM params[])) 1006 OSSL_CORE_MAKE_FUNC(int, kem_auth_encapsulate_init, (void *ctx, void *provkey, 1007 void *authprivkey, 1008 const OSSL_PARAM params[])) 1009 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate, (void *ctx, 1010 unsigned char *out, size_t *outlen, 1011 unsigned char *secret, 1012 size_t *secretlen)) 1013 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate_init, (void *ctx, void *provkey, 1014 const OSSL_PARAM params[])) 1015 OSSL_CORE_MAKE_FUNC(int, kem_auth_decapsulate_init, (void *ctx, void *provkey, 1016 void *authpubkey, 1017 const OSSL_PARAM params[])) 1018 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate, (void *ctx, 1019 unsigned char *out, size_t *outlen, 1020 const unsigned char *in, size_t inlen)) 1021 OSSL_CORE_MAKE_FUNC(void, kem_freectx, (void *ctx)) 1022 OSSL_CORE_MAKE_FUNC(void *, kem_dupctx, (void *ctx)) 1023 OSSL_CORE_MAKE_FUNC(int, kem_get_ctx_params, (void *ctx, OSSL_PARAM params[])) 1024 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_gettable_ctx_params, 1025 (void *ctx, void *provctx)) 1026 OSSL_CORE_MAKE_FUNC(int, kem_set_ctx_params, 1027 (void *ctx, const OSSL_PARAM params[])) 1028 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_settable_ctx_params, 1029 (void *ctx, void *provctx)) 1030 1031 /* Encoders and decoders */ 1032 # define OSSL_FUNC_ENCODER_NEWCTX 1 1033 # define OSSL_FUNC_ENCODER_FREECTX 2 1034 # define OSSL_FUNC_ENCODER_GET_PARAMS 3 1035 # define OSSL_FUNC_ENCODER_GETTABLE_PARAMS 4 1036 # define OSSL_FUNC_ENCODER_SET_CTX_PARAMS 5 1037 # define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS 6 1038 # define OSSL_FUNC_ENCODER_DOES_SELECTION 10 1039 # define OSSL_FUNC_ENCODER_ENCODE 11 1040 # define OSSL_FUNC_ENCODER_IMPORT_OBJECT 20 1041 # define OSSL_FUNC_ENCODER_FREE_OBJECT 21 1042 OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx)) 1043 OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx)) 1044 OSSL_CORE_MAKE_FUNC(int, encoder_get_params, (OSSL_PARAM params[])) 1045 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_gettable_params, 1046 (void *provctx)) 1047 OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params, 1048 (void *ctx, const OSSL_PARAM params[])) 1049 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params, 1050 (void *provctx)) 1051 1052 OSSL_CORE_MAKE_FUNC(int, encoder_does_selection, 1053 (void *provctx, int selection)) 1054 OSSL_CORE_MAKE_FUNC(int, encoder_encode, 1055 (void *ctx, OSSL_CORE_BIO *out, 1056 const void *obj_raw, const OSSL_PARAM obj_abstract[], 1057 int selection, 1058 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)) 1059 1060 OSSL_CORE_MAKE_FUNC(void *, encoder_import_object, 1061 (void *ctx, int selection, const OSSL_PARAM params[])) 1062 OSSL_CORE_MAKE_FUNC(void, encoder_free_object, (void *obj)) 1063 1064 # define OSSL_FUNC_DECODER_NEWCTX 1 1065 # define OSSL_FUNC_DECODER_FREECTX 2 1066 # define OSSL_FUNC_DECODER_GET_PARAMS 3 1067 # define OSSL_FUNC_DECODER_GETTABLE_PARAMS 4 1068 # define OSSL_FUNC_DECODER_SET_CTX_PARAMS 5 1069 # define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS 6 1070 # define OSSL_FUNC_DECODER_DOES_SELECTION 10 1071 # define OSSL_FUNC_DECODER_DECODE 11 1072 # define OSSL_FUNC_DECODER_EXPORT_OBJECT 20 1073 OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx)) 1074 OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx)) 1075 OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[])) 1076 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params, 1077 (void *provctx)) 1078 OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params, 1079 (void *ctx, const OSSL_PARAM params[])) 1080 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params, 1081 (void *provctx)) 1082 1083 OSSL_CORE_MAKE_FUNC(int, decoder_does_selection, 1084 (void *provctx, int selection)) 1085 OSSL_CORE_MAKE_FUNC(int, decoder_decode, 1086 (void *ctx, OSSL_CORE_BIO *in, int selection, 1087 OSSL_CALLBACK *data_cb, void *data_cbarg, 1088 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1089 OSSL_CORE_MAKE_FUNC(int, decoder_export_object, 1090 (void *ctx, const void *objref, size_t objref_sz, 1091 OSSL_CALLBACK *export_cb, void *export_cbarg)) 1092 1093 /*- 1094 * Store 1095 * 1096 * Objects are scanned by using the 'open', 'load', 'eof' and 'close' 1097 * functions, which implement an OSSL_STORE loader. 1098 * 1099 * store_load() works in a way that's very similar to the decoders, in 1100 * that they pass an abstract object through a callback, either as a DER 1101 * octet string or as an object reference, which libcrypto will have to 1102 * deal with. 1103 */ 1104 1105 #define OSSL_FUNC_STORE_OPEN 1 1106 #define OSSL_FUNC_STORE_ATTACH 2 1107 #define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS 3 1108 #define OSSL_FUNC_STORE_SET_CTX_PARAMS 4 1109 #define OSSL_FUNC_STORE_LOAD 5 1110 #define OSSL_FUNC_STORE_EOF 6 1111 #define OSSL_FUNC_STORE_CLOSE 7 1112 #define OSSL_FUNC_STORE_EXPORT_OBJECT 8 1113 #define OSSL_FUNC_STORE_DELETE 9 1114 #define OSSL_FUNC_STORE_OPEN_EX 10 1115 OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri)) 1116 OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in)) 1117 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params, 1118 (void *provctx)) 1119 OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params, 1120 (void *loaderctx, const OSSL_PARAM params[])) 1121 OSSL_CORE_MAKE_FUNC(int, store_load, 1122 (void *loaderctx, 1123 OSSL_CALLBACK *object_cb, void *object_cbarg, 1124 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1125 OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx)) 1126 OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx)) 1127 OSSL_CORE_MAKE_FUNC(int, store_export_object, 1128 (void *loaderctx, const void *objref, size_t objref_sz, 1129 OSSL_CALLBACK *export_cb, void *export_cbarg)) 1130 OSSL_CORE_MAKE_FUNC(int, store_delete, 1131 (void *provctx, const char *uri, const OSSL_PARAM params[], 1132 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1133 OSSL_CORE_MAKE_FUNC(void *, store_open_ex, 1134 (void *provctx, const char *uri, const OSSL_PARAM params[], 1135 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)) 1136 1137 # ifdef __cplusplus 1138 } 1139 # endif 1140 1141 #endif 1142