include/openssl/core_dispatch.h

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