include/openssl/core_dispatch.h

   1 /*
   2  * Copyright 2019-2021 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
  17 # ifdef __cplusplus
  18 extern "C" {
  19 # endif
  20
  21 /*-
  22  * Identities
  23  * ----------
  24  *
  25  * All series start with 1, to allow 0 to be an array terminator.
  26  * For any FUNC identity, we also provide a function signature typedef
  27  * and a static inline function to extract a function pointer from a
  28  * OSSL_DISPATCH element in a type safe manner.
  29  *
  30  * Names:
  31  * for any function base name 'foo' (uppercase form 'FOO'), we will have
  32  * the following:
  33  * - a macro for the identity with the name OSSL_FUNC_'FOO' or derivatives
  34  *   thereof (to be specified further down)
  35  * - a function signature typedef with the name OSSL_FUNC_'foo'_fn
  36  * - a function pointer extractor function with the name OSSL_FUNC_'foo'
  37  */
  38
  39 /*
  40  * Helper macro to create the function signature typedef and the extractor
  41  * |type| is the return-type of the function, |name| is the name of the
  42  * function to fetch, and |args| is a parenthesized list of parameters
  43  * for the function (that is, it is |name|'s function signature).
  44  */
  45 #define OSSL_CORE_MAKE_FUNC(type,name,args)                             \
  46     typedef type (OSSL_FUNC_##name##_fn)args;                           \
  47     static ossl_unused ossl_inline \
  48     OSSL_FUNC_##name##_fn *OSSL_FUNC_##name(const OSSL_DISPATCH *opf)   \
  49     {                                                                   \
  50         return (OSSL_FUNC_##name##_fn *)opf->function;                  \
  51     }
  52
  53 /*
  54  * Core function identities, for the two OSSL_DISPATCH tables being passed
  55  * in the OSSL_provider_init call.
  56  *
  57  * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must
  58  * therefore NEVER be used as a function identity.
  59  */
  60 /* Functions provided by the Core to the provider, reserved numbers 1-1023 */
  61 # define OSSL_FUNC_CORE_GETTABLE_PARAMS        1
  62 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
  63                     core_gettable_params,(const OSSL_CORE_HANDLE *prov))
  64 # define OSSL_FUNC_CORE_GET_PARAMS             2
  65 OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_CORE_HANDLE *prov,
  66                                          OSSL_PARAM params[]))
  67 # define OSSL_FUNC_CORE_THREAD_START           3
  68 OSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_CORE_HANDLE *prov,
  69                                            OSSL_thread_stop_handler_fn handfn))
  70 # define OSSL_FUNC_CORE_GET_LIBCTX             4
  71 OSSL_CORE_MAKE_FUNC(OPENSSL_CORE_CTX *,core_get_libctx,
  72                     (const OSSL_CORE_HANDLE *prov))
  73 # define OSSL_FUNC_CORE_NEW_ERROR              5
  74 OSSL_CORE_MAKE_FUNC(void,core_new_error,(const OSSL_CORE_HANDLE *prov))
  75 # define OSSL_FUNC_CORE_SET_ERROR_DEBUG        6
  76 OSSL_CORE_MAKE_FUNC(void,core_set_error_debug,
  77                     (const OSSL_CORE_HANDLE *prov,
  78                      const char *file, int line, const char *func))
  79 # define OSSL_FUNC_CORE_VSET_ERROR             7
  80 OSSL_CORE_MAKE_FUNC(void,core_vset_error,
  81                     (const OSSL_CORE_HANDLE *prov,
  82                      uint32_t reason, const char *fmt, va_list args))
  83 # define OSSL_FUNC_CORE_SET_ERROR_MARK         8
  84 OSSL_CORE_MAKE_FUNC(int, core_set_error_mark, (const OSSL_CORE_HANDLE *prov))
  85 # define OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK  9
  86 OSSL_CORE_MAKE_FUNC(int, core_clear_last_error_mark,
  87                     (const OSSL_CORE_HANDLE *prov))
  88 # define OSSL_FUNC_CORE_POP_ERROR_TO_MARK     10
  89 OSSL_CORE_MAKE_FUNC(int, core_pop_error_to_mark, (const OSSL_CORE_HANDLE *prov))
  90
  91 /* Memory allocation, freeing, clearing. */
  92 #define OSSL_FUNC_CRYPTO_MALLOC               20
  93 OSSL_CORE_MAKE_FUNC(void *,
  94         CRYPTO_malloc, (size_t num, const char *file, int line))
  95 #define OSSL_FUNC_CRYPTO_ZALLOC               21
  96 OSSL_CORE_MAKE_FUNC(void *,
  97         CRYPTO_zalloc, (size_t num, const char *file, int line))
  98 #define OSSL_FUNC_CRYPTO_FREE                 22
  99 OSSL_CORE_MAKE_FUNC(void,
 100         CRYPTO_free, (void *ptr, const char *file, int line))
 101 #define OSSL_FUNC_CRYPTO_CLEAR_FREE           23
 102 OSSL_CORE_MAKE_FUNC(void,
 103         CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line))
 104 #define OSSL_FUNC_CRYPTO_REALLOC              24
 105 OSSL_CORE_MAKE_FUNC(void *,
 106         CRYPTO_realloc, (void *addr, size_t num, const char *file, int line))
 107 #define OSSL_FUNC_CRYPTO_CLEAR_REALLOC        25
 108 OSSL_CORE_MAKE_FUNC(void *,
 109         CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num,
 110                                const char *file, int line))
 111 #define OSSL_FUNC_CRYPTO_SECURE_MALLOC        26
 112 OSSL_CORE_MAKE_FUNC(void *,
 113         CRYPTO_secure_malloc, (size_t num, const char *file, int line))
 114 #define OSSL_FUNC_CRYPTO_SECURE_ZALLOC        27
 115 OSSL_CORE_MAKE_FUNC(void *,
 116         CRYPTO_secure_zalloc, (size_t num, const char *file, int line))
 117 #define OSSL_FUNC_CRYPTO_SECURE_FREE          28
 118 OSSL_CORE_MAKE_FUNC(void,
 119         CRYPTO_secure_free, (void *ptr, const char *file, int line))
 120 #define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE    29
 121 OSSL_CORE_MAKE_FUNC(void,
 122         CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file,
 123                                    int line))
 124 #define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED     30
 125 OSSL_CORE_MAKE_FUNC(int,
 126         CRYPTO_secure_allocated, (const void *ptr))
 127 #define OSSL_FUNC_OPENSSL_CLEANSE             31
 128 OSSL_CORE_MAKE_FUNC(void,
 129         OPENSSL_cleanse, (void *ptr, size_t len))
 130
 131 /* Bio functions provided by the core */
 132 #define OSSL_FUNC_BIO_NEW_FILE                40
 133 #define OSSL_FUNC_BIO_NEW_MEMBUF              41
 134 #define OSSL_FUNC_BIO_READ_EX                 42
 135 #define OSSL_FUNC_BIO_WRITE_EX                43
 136 #define OSSL_FUNC_BIO_FREE                    44
 137 #define OSSL_FUNC_BIO_VPRINTF                 45
 138 #define OSSL_FUNC_BIO_VSNPRINTF               46
 139 #define OSSL_FUNC_BIO_PUTS                    47
 140 #define OSSL_FUNC_BIO_GETS                    48
 141 #define OSSL_FUNC_BIO_CTRL                    49
 142
 143
 144 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename,
 145                                                     const char *mode))
 146 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len))
 147 OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data,
 148                                        size_t data_len, size_t *bytes_read))
 149 OSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data,
 150                                         size_t data_len, size_t *written))
 151 OSSL_CORE_MAKE_FUNC(int, BIO_gets, (OSSL_CORE_BIO *bio, char *buf, int size))
 152 OSSL_CORE_MAKE_FUNC(int, BIO_puts, (OSSL_CORE_BIO *bio, const char *str))
 153 OSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio))
 154 OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format,
 155                                        va_list args))
 156 OSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf,
 157                    (char *buf, size_t n, const char *fmt, va_list args))
 158 OSSL_CORE_MAKE_FUNC(int, BIO_ctrl, (OSSL_CORE_BIO *bio,
 159                                     int cmd, long num, void *ptr))
 160
 161 #define OSSL_FUNC_SELF_TEST_CB               100
 162 OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb,
 163                                          void **cbarg))
 164
 165 /* Functions to get seed material from the operating system */
 166 #define OSSL_FUNC_GET_ENTROPY                101
 167 #define OSSL_FUNC_CLEANUP_ENTROPY            102
 168 #define OSSL_FUNC_GET_NONCE                  103
 169 #define OSSL_FUNC_CLEANUP_NONCE              104
 170 OSSL_CORE_MAKE_FUNC(size_t, get_entropy, (const OSSL_CORE_HANDLE *handle,
 171                                           unsigned char **pout, int entropy,
 172                                           size_t min_len, size_t max_len))
 173 OSSL_CORE_MAKE_FUNC(void, cleanup_entropy, (const OSSL_CORE_HANDLE *handle,
 174                                             unsigned char *buf, size_t len))
 175 OSSL_CORE_MAKE_FUNC(size_t, get_nonce, (const OSSL_CORE_HANDLE *handle,
 176                                         unsigned char **pout, size_t min_len,
 177                                         size_t max_len, const void *salt,
 178                                         size_t salt_len))
 179 OSSL_CORE_MAKE_FUNC(void, cleanup_nonce, (const OSSL_CORE_HANDLE *handle,
 180                                           unsigned char *buf, size_t len))
 181
 182 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
 183 # define OSSL_FUNC_PROVIDER_TEARDOWN           1024
 184 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
 185 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS    1025
 186 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
 187                     provider_gettable_params,(void *provctx))
 188 # define OSSL_FUNC_PROVIDER_GET_PARAMS         1026
 189 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
 190                                              OSSL_PARAM params[]))
 191 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION    1027
 192 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
 193                     (void *provctx, int operation_id, int *no_store))
 194 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
 195 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
 196                     (void *provctx))
 197 # define OSSL_FUNC_PROVIDER_GET_CAPABILITIES   1029
 198 OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx,
 199                     const char *capability, OSSL_CALLBACK *cb, void *arg))
 200 # define OSSL_FUNC_PROVIDER_SELF_TEST          1030
 201 OSSL_CORE_MAKE_FUNC(int, provider_self_test, (void *provctx))
 202
 203 /* Operations */
 204
 205 # define OSSL_OP_DIGEST                              1
 206 # define OSSL_OP_CIPHER                              2   /* Symmetric Ciphers */
 207 # define OSSL_OP_MAC                                 3
 208 # define OSSL_OP_KDF                                 4
 209 # define OSSL_OP_RAND                                5
 210 # define OSSL_OP_KEYMGMT                            10
 211 # define OSSL_OP_KEYEXCH                            11
 212 # define OSSL_OP_SIGNATURE                          12
 213 # define OSSL_OP_ASYM_CIPHER                        13
 214 # define OSSL_OP_KEM                                14
 215 /* New section for non-EVP operations */
 216 # define OSSL_OP_ENCODER                            20
 217 # define OSSL_OP_DECODER                            21
 218 # define OSSL_OP_STORE                              22
 219 /* Highest known operation number */
 220 # define OSSL_OP__HIGHEST                           22
 221
 222 /* Digests */
 223
 224 # define OSSL_FUNC_DIGEST_NEWCTX                     1
 225 # define OSSL_FUNC_DIGEST_INIT                       2
 226 # define OSSL_FUNC_DIGEST_UPDATE                     3
 227 # define OSSL_FUNC_DIGEST_FINAL                      4
 228 # define OSSL_FUNC_DIGEST_DIGEST                     5
 229 # define OSSL_FUNC_DIGEST_FREECTX                    6
 230 # define OSSL_FUNC_DIGEST_DUPCTX                     7
 231 # define OSSL_FUNC_DIGEST_GET_PARAMS                 8
 232 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS             9
 233 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS            10
 234 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS           11
 235 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS       12
 236 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS       13
 237
 238 OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx))
 239 OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx))
 240 OSSL_CORE_MAKE_FUNC(int, digest_update,
 241                     (void *dctx, const unsigned char *in, size_t inl))
 242 OSSL_CORE_MAKE_FUNC(int, digest_final,
 243                     (void *dctx,
 244                      unsigned char *out, size_t *outl, size_t outsz))
 245 OSSL_CORE_MAKE_FUNC(int, digest_digest,
 246                     (void *provctx, const unsigned char *in, size_t inl,
 247                      unsigned char *out, size_t *outl, size_t outsz))
 248
 249 OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx))
 250 OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx))
 251
 252 OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[]))
 253 OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params,
 254                     (void *vctx, const OSSL_PARAM params[]))
 255 OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params,
 256                     (void *vctx, OSSL_PARAM params[]))
 257 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params,
 258                     (void *provctx))
 259 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params,
 260                     (void *provctx))
 261 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params,
 262                     (void *provctx))
 263
 264 /* Symmetric Ciphers */
 265
 266 # define OSSL_FUNC_CIPHER_NEWCTX                     1
 267 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT               2
 268 # define OSSL_FUNC_CIPHER_DECRYPT_INIT               3
 269 # define OSSL_FUNC_CIPHER_UPDATE                     4
 270 # define OSSL_FUNC_CIPHER_FINAL                      5
 271 # define OSSL_FUNC_CIPHER_CIPHER                     6
 272 # define OSSL_FUNC_CIPHER_FREECTX                    7
 273 # define OSSL_FUNC_CIPHER_DUPCTX                     8
 274 # define OSSL_FUNC_CIPHER_GET_PARAMS                 9
 275 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS            10
 276 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS            11
 277 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS           12
 278 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS       13
 279 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS       14
 280
 281 OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx))
 282 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx,
 283                                                   const unsigned char *key,
 284                                                   size_t keylen,
 285                                                   const unsigned char *iv,
 286                                                   size_t ivlen))
 287 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx,
 288                                                   const unsigned char *key,
 289                                                   size_t keylen,
 290                                                   const unsigned char *iv,
 291                                                   size_t ivlen))
 292 OSSL_CORE_MAKE_FUNC(int, cipher_update,
 293                     (void *cctx,
 294                      unsigned char *out, size_t *outl, size_t outsize,
 295                      const unsigned char *in, size_t inl))
 296 OSSL_CORE_MAKE_FUNC(int, cipher_final,
 297                     (void *cctx,
 298                      unsigned char *out, size_t *outl, size_t outsize))
 299 OSSL_CORE_MAKE_FUNC(int, cipher_cipher,
 300                     (void *cctx,
 301                      unsigned char *out, size_t *outl, size_t outsize,
 302                      const unsigned char *in, size_t inl))
 303 OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx))
 304 OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx))
 305 OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[]))
 306 OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx,
 307                                                     OSSL_PARAM params[]))
 308 OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx,
 309                                                     const OSSL_PARAM params[]))
 310 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params,
 311                     (void *provctx))
 312 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params,
 313                     (void *provctx))
 314 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params,
 315                     (void *provctx))
 316
 317 /* MACs */
 318
 319 # define OSSL_FUNC_MAC_NEWCTX                        1
 320 # define OSSL_FUNC_MAC_DUPCTX                        2
 321 # define OSSL_FUNC_MAC_FREECTX                       3
 322 # define OSSL_FUNC_MAC_INIT                          4
 323 # define OSSL_FUNC_MAC_UPDATE                        5
 324 # define OSSL_FUNC_MAC_FINAL                         6
 325 # define OSSL_FUNC_MAC_GET_PARAMS                    7
 326 # define OSSL_FUNC_MAC_GET_CTX_PARAMS                8
 327 # define OSSL_FUNC_MAC_SET_CTX_PARAMS                9
 328 # define OSSL_FUNC_MAC_GETTABLE_PARAMS              10
 329 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS          11
 330 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS          12
 331
 332 OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx))
 333 OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src))
 334 OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx))
 335 OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx))
 336 OSSL_CORE_MAKE_FUNC(int, mac_update,
 337                     (void *mctx, const unsigned char *in, size_t inl))
 338 OSSL_CORE_MAKE_FUNC(int, mac_final,
 339                     (void *mctx,
 340                      unsigned char *out, size_t *outl, size_t outsize))
 341 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx))
 342 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params,
 343                     (void *provctx))
 344 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params,
 345                     (void *provctx))
 346 OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[]))
 347 OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params,
 348                     (void *mctx, OSSL_PARAM params[]))
 349 OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params,
 350                     (void *mctx, const OSSL_PARAM params[]))
 351
 352 /* KDFs and PRFs */
 353
 354 # define OSSL_FUNC_KDF_NEWCTX                        1
 355 # define OSSL_FUNC_KDF_DUPCTX                        2
 356 # define OSSL_FUNC_KDF_FREECTX                       3
 357 # define OSSL_FUNC_KDF_RESET                         4
 358 # define OSSL_FUNC_KDF_DERIVE                        5
 359 # define OSSL_FUNC_KDF_GETTABLE_PARAMS               6
 360 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS           7
 361 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS           8
 362 # define OSSL_FUNC_KDF_GET_PARAMS                    9
 363 # define OSSL_FUNC_KDF_GET_CTX_PARAMS               10
 364 # define OSSL_FUNC_KDF_SET_CTX_PARAMS               11
 365
 366 OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx))
 367 OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src))
 368 OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx))
 369 OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx))
 370 OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key,
 371                                           size_t keylen))
 372 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx))
 373 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params,
 374                     (void *provctx))
 375 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params,
 376                     (void *provctx))
 377 OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[]))
 378 OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params,
 379                     (void *kctx, OSSL_PARAM params[]))
 380 OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params,
 381                     (void *kctx, const OSSL_PARAM params[]))
 382
 383 /* RAND */
 384
 385 # define OSSL_FUNC_RAND_NEWCTX                        1
 386 # define OSSL_FUNC_RAND_FREECTX                       2
 387 # define OSSL_FUNC_RAND_INSTANTIATE                   3
 388 # define OSSL_FUNC_RAND_UNINSTANTIATE                 4
 389 # define OSSL_FUNC_RAND_GENERATE                      5
 390 # define OSSL_FUNC_RAND_RESEED                        6
 391 # define OSSL_FUNC_RAND_NONCE                         7
 392 # define OSSL_FUNC_RAND_ENABLE_LOCKING                8
 393 # define OSSL_FUNC_RAND_LOCK                          9
 394 # define OSSL_FUNC_RAND_UNLOCK                       10
 395 # define OSSL_FUNC_RAND_GETTABLE_PARAMS              11
 396 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS          12
 397 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS          13
 398 # define OSSL_FUNC_RAND_GET_PARAMS                   14
 399 # define OSSL_FUNC_RAND_GET_CTX_PARAMS               15
 400 # define OSSL_FUNC_RAND_SET_CTX_PARAMS               16
 401 # define OSSL_FUNC_RAND_VERIFY_ZEROIZATION           17
 402 # define OSSL_FUNC_RAND_GET_SEED                     18
 403 # define OSSL_FUNC_RAND_CLEAR_SEED                   19
 404
 405 OSSL_CORE_MAKE_FUNC(void *,rand_newctx,
 406                     (void *provctx, void *parent,
 407                     const OSSL_DISPATCH *parent_calls))
 408 OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx))
 409 OSSL_CORE_MAKE_FUNC(int,rand_instantiate,
 410                     (void *vdrbg, unsigned int strength,
 411                      int prediction_resistance,
 412                      const unsigned char *pstr, size_t pstr_len))
 413 OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg))
 414 OSSL_CORE_MAKE_FUNC(int,rand_generate,
 415                     (void *vctx, unsigned char *out, size_t outlen,
 416                      unsigned int strength, int prediction_resistance,
 417                      const unsigned char *addin, size_t addin_len))
 418 OSSL_CORE_MAKE_FUNC(int,rand_reseed,
 419                     (void *vctx, int prediction_resistance,
 420                      const unsigned char *ent, size_t ent_len,
 421                      const unsigned char *addin, size_t addin_len))
 422 OSSL_CORE_MAKE_FUNC(size_t,rand_nonce,
 423                     (void *vctx, unsigned char *out, unsigned int strength,
 424                      size_t min_noncelen, size_t max_noncelen))
 425 OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx))
 426 OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx))
 427 OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx))
 428 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx))
 429 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params,
 430                     (void *provctx))
 431 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params,
 432                     (void *provctx))
 433 OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[]))
 434 OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params,
 435                     (void *vctx, OSSL_PARAM params[]))
 436 OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params,
 437                     (void *vctx, const OSSL_PARAM params[]))
 438 OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks,
 439                     (void *vctx, OSSL_INOUT_CALLBACK *get_entropy,
 440                      OSSL_CALLBACK *cleanup_entropy,
 441                      OSSL_INOUT_CALLBACK *get_nonce,
 442                      OSSL_CALLBACK *cleanup_nonce, void *arg))
 443 OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization,
 444                     (void *vctx))
 445 OSSL_CORE_MAKE_FUNC(size_t,rand_get_seed,
 446                     (void *vctx, unsigned char **buffer,
 447                      int entropy, size_t min_len, size_t max_len,
 448                      int prediction_resistance,
 449                      const unsigned char *adin, size_t adin_len))
 450 OSSL_CORE_MAKE_FUNC(void,rand_clear_seed,
 451                     (void *vctx, unsigned char *buffer, size_t b_len))
 452
 453 /*-
 454  * Key management
 455  *
 456  * The Key Management takes care of provider side key objects, and includes
 457  * all current functionality to create them, destroy them, set parameters
 458  * and key material, etc, essentially everything that manipulates the keys
 459  * themselves and their parameters.
 460  *
 461  * The key objects are commonly refered to as |keydata|, and it MUST be able
 462  * to contain parameters if the key has any, the public key and the private
 463  * key.  All parts are optional, but their presence determines what can be
 464  * done with the key object in terms of encryption, signature, and so on.
 465  * The assumption from libcrypto is that the key object contains any of the
 466  * following data combinations:
 467  *
 468  * - parameters only
 469  * - public key only
 470  * - public key + private key
 471  * - parameters + public key
 472  * - parameters + public key + private key
 473  *
 474  * What "parameters", "public key" and "private key" means in detail is left
 475  * to the implementation.  In the case of DH and DSA, they would typically
 476  * include domain parameters, while for certain variants of RSA, they would
 477  * typically include PSS or OAEP parameters.
 478  *
 479  * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with
 480  * OSSL_FUNC_keymgmt_free().  Key objects can have data filled in with
 481  * OSSL_FUNC_keymgmt_import().
 482  *
 483  * Three functions are made available to check what selection of data is
 484  * present in a key object: OSSL_FUNC_keymgmt_has_parameters(),
 485  * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(),
 486  */
 487
 488 /* Key data subset selection - individual bits */
 489 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY            0x01
 490 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY             0x02
 491 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS      0x04
 492 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS       0x80
 493
 494 /* Key data subset selection - combinations */
 495 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS     \
 496     ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS     \
 497       | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
 498 # define OSSL_KEYMGMT_SELECT_KEYPAIR            \
 499     ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
 500 # define OSSL_KEYMGMT_SELECT_ALL                \
 501     ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
 502
 503 # define OSSL_KEYMGMT_VALIDATE_FULL_CHECK              0
 504 # define OSSL_KEYMGMT_VALIDATE_QUICK_CHECK             1
 505
 506 /* Basic key object creation */
 507 # define OSSL_FUNC_KEYMGMT_NEW                         1
 508 OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx))
 509
 510 /* Generation, a more complex constructor */
 511 # define OSSL_FUNC_KEYMGMT_GEN_INIT                    2
 512 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE            3
 513 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS              4
 514 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS         5
 515 # define OSSL_FUNC_KEYMGMT_GEN                         6
 516 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP                 7
 517 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init,
 518                     (void *provctx, int selection))
 519 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template,
 520                     (void *genctx, void *templ))
 521 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params,
 522                     (void *genctx, const OSSL_PARAM params[]))
 523 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
 524                     keymgmt_gen_settable_params, (void *provctx))
 525 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_get_params,
 526                     (void *genctx, OSSL_PARAM params[]))
 527 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
 528                     keymgmt_gen_gettable_params, (void *provctx))
 529 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen,
 530                     (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
 531 OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx))
 532
 533 /* Key loading by object reference */
 534 # define OSSL_FUNC_KEYMGMT_LOAD                        8
 535 OSSL_CORE_MAKE_FUNC(void *, keymgmt_load,
 536                     (const void *reference, size_t reference_sz))
 537
 538 /* Basic key object destruction */
 539 # define OSSL_FUNC_KEYMGMT_FREE                       10
 540 OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata))
 541
 542 /* Key object information, with discovery */
 543 #define OSSL_FUNC_KEYMGMT_GET_PARAMS                  11
 544 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS             12
 545 OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params,
 546                     (void *keydata, OSSL_PARAM params[]))
 547 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params, (void *))
 548
 549 #define OSSL_FUNC_KEYMGMT_SET_PARAMS                  13
 550 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS             14
 551 OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params,
 552                     (void *keydata, const OSSL_PARAM params[]))
 553 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params, (void *))
 554
 555 /* Key checks - discovery of supported operations */
 556 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME       20
 557 OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name,
 558                     (int operation_id))
 559
 560 /* Key checks - key data content checks */
 561 # define OSSL_FUNC_KEYMGMT_HAS                        21
 562 OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (const void *keydata, int selection))
 563
 564 /* Key checks - validation */
 565 # define OSSL_FUNC_KEYMGMT_VALIDATE                   22
 566 OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (const void *keydata, int selection,
 567                                             int checktype))
 568
 569 /* Key checks - matching */
 570 # define OSSL_FUNC_KEYMGMT_MATCH                      23
 571 OSSL_CORE_MAKE_FUNC(int, keymgmt_match,
 572                     (const void *keydata1, const void *keydata2,
 573                      int selection))
 574
 575 /* Import and export functions, with discovery */
 576 # define OSSL_FUNC_KEYMGMT_IMPORT                     40
 577 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES               41
 578 # define OSSL_FUNC_KEYMGMT_EXPORT                     42
 579 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES               43
 580 OSSL_CORE_MAKE_FUNC(int, keymgmt_import,
 581                     (void *keydata, int selection, const OSSL_PARAM params[]))
 582 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types,
 583                     (int selection))
 584 OSSL_CORE_MAKE_FUNC(int, keymgmt_export,
 585                     (void *keydata, int selection,
 586                      OSSL_CALLBACK *param_cb, void *cbarg))
 587 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types,
 588                     (int selection))
 589
 590 /* Copy function, only works for matching keymgmt */
 591 # define OSSL_FUNC_KEYMGMT_COPY                       44
 592 OSSL_CORE_MAKE_FUNC(int, keymgmt_copy,
 593                     ( void *keydata_to, const void *keydata_from,
 594                      int selection))
 595
 596 /* Key Exchange */
 597
 598 # define OSSL_FUNC_KEYEXCH_NEWCTX                      1
 599 # define OSSL_FUNC_KEYEXCH_INIT                        2
 600 # define OSSL_FUNC_KEYEXCH_DERIVE                      3
 601 # define OSSL_FUNC_KEYEXCH_SET_PEER                    4
 602 # define OSSL_FUNC_KEYEXCH_FREECTX                     5
 603 # define OSSL_FUNC_KEYEXCH_DUPCTX                      6
 604 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS              7
 605 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS         8
 606 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS              9
 607 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS        10
 608
 609 OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx))
 610 OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey))
 611 OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx,  unsigned char *secret,
 612                                              size_t *secretlen, size_t outlen))
 613 OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey))
 614 OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx))
 615 OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx))
 616 OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx,
 617                                                      const OSSL_PARAM params[]))
 618 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params,
 619                     (void *provctx))
 620 OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx,
 621                                                      OSSL_PARAM params[]))
 622 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params,
 623                     (void *provctx))
 624
 625 /* Signature */
 626
 627 # define OSSL_FUNC_SIGNATURE_NEWCTX                  1
 628 # define OSSL_FUNC_SIGNATURE_SIGN_INIT               2
 629 # define OSSL_FUNC_SIGNATURE_SIGN                    3
 630 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT             4
 631 # define OSSL_FUNC_SIGNATURE_VERIFY                  5
 632 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT     6
 633 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER          7
 634 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT        8
 635 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE      9
 636 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL      10
 637 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN            11
 638 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT     12
 639 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE   13
 640 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL    14
 641 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY          15
 642 # define OSSL_FUNC_SIGNATURE_FREECTX                16
 643 # define OSSL_FUNC_SIGNATURE_DUPCTX                 17
 644 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS         18
 645 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS    19
 646 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS         20
 647 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS    21
 648 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS      22
 649 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
 650 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS      24
 651 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
 652
 653 OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx,
 654                                                   const char *propq))
 655 OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey))
 656 OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx,  unsigned char *sig,
 657                                              size_t *siglen, size_t sigsize,
 658                                              const unsigned char *tbs,
 659                                              size_t tbslen))
 660 OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey))
 661 OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx,
 662                                                const unsigned char *sig,
 663                                                size_t siglen,
 664                                                const unsigned char *tbs,
 665                                                size_t tbslen))
 666 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init, (void *ctx,
 667                                                             void *provkey))
 668 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover, (void *ctx,
 669                                                        unsigned char *rout,
 670                                                        size_t *routlen,
 671                                                        size_t routsize,
 672                                                        const unsigned char *sig,
 673                                                        size_t siglen))
 674 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init,
 675                     (void *ctx, const char *mdname, void *provkey))
 676 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update,
 677                     (void *ctx, const unsigned char *data, size_t datalen))
 678 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final,
 679                     (void *ctx, unsigned char *sig, size_t *siglen,
 680                      size_t sigsize))
 681 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign,
 682                     (void *ctx, unsigned char *sigret, size_t *siglen,
 683                      size_t sigsize, const unsigned char *tbs, size_t tbslen))
 684 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init,
 685                     (void *ctx, const char *mdname, void *provkey))
 686 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update,
 687                     (void *ctx, const unsigned char *data, size_t datalen))
 688 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final,
 689                     (void *ctx, const unsigned char *sig, size_t siglen))
 690 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify,
 691                     (void *ctx, const unsigned char *sig, size_t siglen,
 692                      const unsigned char *tbs, size_t tbslen))
 693 OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx))
 694 OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx))
 695 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params,
 696                     (void *ctx, OSSL_PARAM params[]))
 697 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params,
 698                     (void *provctx))
 699 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params,
 700                     (void *ctx, const OSSL_PARAM params[]))
 701 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params,
 702                     (void *provctx))
 703 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params,
 704                     (void *ctx, OSSL_PARAM params[]))
 705 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params,
 706                     (void *ctx))
 707 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params,
 708                     (void *ctx, const OSSL_PARAM params[]))
 709 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params,
 710                     (void *ctx))
 711
 712
 713 /* Asymmetric Ciphers */
 714
 715 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX                  1
 716 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT            2
 717 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT                 3
 718 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT            4
 719 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT                 5
 720 # define OSSL_FUNC_ASYM_CIPHER_FREECTX                 6
 721 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX                  7
 722 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS          8
 723 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS     9
 724 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS         10
 725 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS    11
 726
 727 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx))
 728 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey))
 729 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out,
 730                                                   size_t *outlen,
 731                                                   size_t outsize,
 732                                                   const unsigned char *in,
 733                                                   size_t inlen))
 734 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey))
 735 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out,
 736                                                   size_t *outlen,
 737                                                   size_t outsize,
 738                                                   const unsigned char *in,
 739                                                   size_t inlen))
 740 OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx))
 741 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx))
 742 OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params,
 743                     (void *ctx, OSSL_PARAM params[]))
 744 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params,
 745                     (void *provctx))
 746 OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params,
 747                     (void *ctx, const OSSL_PARAM params[]))
 748 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params,
 749                     (void *provctx))
 750
 751 /* Asymmetric Key encapsulation */
 752 # define OSSL_FUNC_KEM_NEWCTX                  1
 753 # define OSSL_FUNC_KEM_ENCAPSULATE_INIT        2
 754 # define OSSL_FUNC_KEM_ENCAPSULATE             3
 755 # define OSSL_FUNC_KEM_DECAPSULATE_INIT        4
 756 # define OSSL_FUNC_KEM_DECAPSULATE             5
 757 # define OSSL_FUNC_KEM_FREECTX                 6
 758 # define OSSL_FUNC_KEM_DUPCTX                  7
 759 # define OSSL_FUNC_KEM_GET_CTX_PARAMS          8
 760 # define OSSL_FUNC_KEM_GETTABLE_CTX_PARAMS     9
 761 # define OSSL_FUNC_KEM_SET_CTX_PARAMS         10
 762 # define OSSL_FUNC_KEM_SETTABLE_CTX_PARAMS    11
 763
 764 OSSL_CORE_MAKE_FUNC(void *, kem_newctx, (void *provctx))
 765 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate_init, (void *ctx, void *provkey))
 766 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate, (void *ctx,
 767                                            unsigned char *out, size_t *outlen,
 768                                            unsigned char *secret,
 769                                            size_t *secretlen))
 770 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate_init, (void *ctx, void *provkey))
 771 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate, (void *ctx,
 772                                            unsigned char *out, size_t *outlen,
 773                                            const unsigned char *in, size_t inlen))
 774 OSSL_CORE_MAKE_FUNC(void, kem_freectx, (void *ctx))
 775 OSSL_CORE_MAKE_FUNC(void *, kem_dupctx, (void *ctx))
 776 OSSL_CORE_MAKE_FUNC(int, kem_get_ctx_params, (void *ctx, OSSL_PARAM params[]))
 777 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_gettable_ctx_params, (void *provctx))
 778 OSSL_CORE_MAKE_FUNC(int, kem_set_ctx_params,
 779                     (void *ctx, const OSSL_PARAM params[]))
 780 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_settable_ctx_params, (void *provctx))
 781
 782 /* Encoders and decoders */
 783 # define OSSL_FUNC_ENCODER_NEWCTX                      1
 784 # define OSSL_FUNC_ENCODER_FREECTX                     2
 785 # define OSSL_FUNC_ENCODER_GET_PARAMS                  3
 786 # define OSSL_FUNC_ENCODER_GETTABLE_PARAMS             4
 787 # define OSSL_FUNC_ENCODER_SET_CTX_PARAMS              5
 788 # define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS         6
 789 # define OSSL_FUNC_ENCODER_DOES_SELECTION             10
 790 # define OSSL_FUNC_ENCODER_ENCODE                     11
 791 # define OSSL_FUNC_ENCODER_IMPORT_OBJECT              20
 792 # define OSSL_FUNC_ENCODER_FREE_OBJECT                21
 793 OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx))
 794 OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx))
 795 OSSL_CORE_MAKE_FUNC(int, encoder_get_params, (OSSL_PARAM params[]))
 796 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_gettable_params,
 797                     (void *provctx))
 798 OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params,
 799                     (void *ctx, const OSSL_PARAM params[]))
 800 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params,
 801                     (void *provctx))
 802
 803 OSSL_CORE_MAKE_FUNC(int, encoder_does_selection,
 804                     (void *provctx, int selection))
 805 OSSL_CORE_MAKE_FUNC(int, encoder_encode,
 806                     (void *ctx, OSSL_CORE_BIO *out,
 807                      const void *obj_raw, const OSSL_PARAM obj_abstract[],
 808                      int selection,
 809                      OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
 810
 811 OSSL_CORE_MAKE_FUNC(void *, encoder_import_object,
 812                     (void *ctx, int selection, const OSSL_PARAM params[]))
 813 OSSL_CORE_MAKE_FUNC(void, encoder_free_object, (void *obj))
 814
 815 # define OSSL_FUNC_DECODER_NEWCTX                      1
 816 # define OSSL_FUNC_DECODER_FREECTX                     2
 817 # define OSSL_FUNC_DECODER_GET_PARAMS                  3
 818 # define OSSL_FUNC_DECODER_GETTABLE_PARAMS             4
 819 # define OSSL_FUNC_DECODER_SET_CTX_PARAMS              5
 820 # define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS         6
 821 # define OSSL_FUNC_DECODER_DOES_SELECTION             10
 822 # define OSSL_FUNC_DECODER_DECODE                     11
 823 # define OSSL_FUNC_DECODER_EXPORT_OBJECT              20
 824 OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx))
 825 OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx))
 826 OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[]))
 827 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params,
 828                     (void *provctx))
 829 OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params,
 830                     (void *ctx, const OSSL_PARAM params[]))
 831 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params,
 832                     (void *provctx))
 833
 834 OSSL_CORE_MAKE_FUNC(int, decoder_does_selection,
 835                     (void *provctx, int selection))
 836 OSSL_CORE_MAKE_FUNC(int, decoder_decode,
 837                     (void *ctx, OSSL_CORE_BIO *in, int selection,
 838                      OSSL_CALLBACK *metadata_cb, void *metadata_cbarg,
 839                      OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
 840 OSSL_CORE_MAKE_FUNC(int, decoder_export_object,
 841                     (void *ctx, const void *objref, size_t objref_sz,
 842                      OSSL_CALLBACK *export_cb, void *export_cbarg))
 843
 844 /*-
 845  * Store
 846  *
 847  * Objects are scanned by using the 'open', 'load', 'eof' and 'close'
 848  * functions, which implement an OSSL_STORE loader.
 849  *
 850  * store_load() works in a way that's very similar to the decoders, in
 851  * that they pass an abstract object through a callback, either as a DER
 852  * octet string or as an object reference, which libcrypto will have to
 853  * deal with.
 854  */
 855
 856 #define OSSL_FUNC_STORE_OPEN                        1
 857 #define OSSL_FUNC_STORE_ATTACH                      2
 858 #define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS         3
 859 #define OSSL_FUNC_STORE_SET_CTX_PARAMS              4
 860 #define OSSL_FUNC_STORE_LOAD                        5
 861 #define OSSL_FUNC_STORE_EOF                         6
 862 #define OSSL_FUNC_STORE_CLOSE                       7
 863 #define OSSL_FUNC_STORE_EXPORT_OBJECT               8
 864 OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri))
 865 OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in))
 866 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params,
 867                     (void *provctx))
 868 OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params,
 869                     (void *loaderctx, const OSSL_PARAM params[]))
 870 OSSL_CORE_MAKE_FUNC(int, store_load,
 871                     (void *loaderctx,
 872                      OSSL_CALLBACK *object_cb, void *object_cbarg,
 873                      OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
 874 OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx))
 875 OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx))
 876 OSSL_CORE_MAKE_FUNC(int, store_export_object,
 877                     (void *loaderctx, const void *objref, size_t objref_sz,
 878                      OSSL_CALLBACK *export_cb, void *export_cbarg))
 879
 880 # ifdef __cplusplus
 881 }
 882 # endif
 883
 884 #endif