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 /* New section for non-EVP operations */
 197 # define OSSL_OP_ENCODER                            20
 198 # define OSSL_OP_DECODER                            21
 199 # define OSSL_OP_STORE                              22
 200 /* Highest known operation number */
 201 # define OSSL_OP__HIGHEST                           22
 202
 203 /* Digests */
 204
 205 # define OSSL_FUNC_DIGEST_NEWCTX                     1
 206 # define OSSL_FUNC_DIGEST_INIT                       2
 207 # define OSSL_FUNC_DIGEST_UPDATE                     3
 208 # define OSSL_FUNC_DIGEST_FINAL                      4
 209 # define OSSL_FUNC_DIGEST_DIGEST                     5
 210 # define OSSL_FUNC_DIGEST_FREECTX                    6
 211 # define OSSL_FUNC_DIGEST_DUPCTX                     7
 212 # define OSSL_FUNC_DIGEST_GET_PARAMS                 8
 213 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS             9
 214 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS            10
 215 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS           11
 216 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS       12
 217 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS       13
 218
 219 OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx))
 220 OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx))
 221 OSSL_CORE_MAKE_FUNC(int, digest_update,
 222                     (void *dctx, const unsigned char *in, size_t inl))
 223 OSSL_CORE_MAKE_FUNC(int, digest_final,
 224                     (void *dctx,
 225                      unsigned char *out, size_t *outl, size_t outsz))
 226 OSSL_CORE_MAKE_FUNC(int, digest_digest,
 227                     (void *provctx, const unsigned char *in, size_t inl,
 228                      unsigned char *out, size_t *outl, size_t outsz))
 229
 230 OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx))
 231 OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx))
 232
 233 OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[]))
 234 OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params,
 235                     (void *vctx, const OSSL_PARAM params[]))
 236 OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params,
 237                     (void *vctx, OSSL_PARAM params[]))
 238 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params,
 239                     (void *provctx))
 240 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params,
 241                     (void *provctx))
 242 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params,
 243                     (void *provctx))
 244
 245 /* Symmetric Ciphers */
 246
 247 # define OSSL_FUNC_CIPHER_NEWCTX                     1
 248 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT               2
 249 # define OSSL_FUNC_CIPHER_DECRYPT_INIT               3
 250 # define OSSL_FUNC_CIPHER_UPDATE                     4
 251 # define OSSL_FUNC_CIPHER_FINAL                      5
 252 # define OSSL_FUNC_CIPHER_CIPHER                     6
 253 # define OSSL_FUNC_CIPHER_FREECTX                    7
 254 # define OSSL_FUNC_CIPHER_DUPCTX                     8
 255 # define OSSL_FUNC_CIPHER_GET_PARAMS                 9
 256 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS            10
 257 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS            11
 258 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS           12
 259 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS       13
 260 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS       14
 261
 262 OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx))
 263 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx,
 264                                                   const unsigned char *key,
 265                                                   size_t keylen,
 266                                                   const unsigned char *iv,
 267                                                   size_t ivlen))
 268 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx,
 269                                                   const unsigned char *key,
 270                                                   size_t keylen,
 271                                                   const unsigned char *iv,
 272                                                   size_t ivlen))
 273 OSSL_CORE_MAKE_FUNC(int, cipher_update,
 274                     (void *cctx,
 275                      unsigned char *out, size_t *outl, size_t outsize,
 276                      const unsigned char *in, size_t inl))
 277 OSSL_CORE_MAKE_FUNC(int, cipher_final,
 278                     (void *cctx,
 279                      unsigned char *out, size_t *outl, size_t outsize))
 280 OSSL_CORE_MAKE_FUNC(int, cipher_cipher,
 281                     (void *cctx,
 282                      unsigned char *out, size_t *outl, size_t outsize,
 283                      const unsigned char *in, size_t inl))
 284 OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx))
 285 OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx))
 286 OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[]))
 287 OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx,
 288                                                     OSSL_PARAM params[]))
 289 OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx,
 290                                                     const OSSL_PARAM params[]))
 291 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params,
 292                     (void *provctx))
 293 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params,
 294                     (void *provctx))
 295 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params,
 296                     (void *provctx))
 297
 298 /* MACs */
 299
 300 # define OSSL_FUNC_MAC_NEWCTX                        1
 301 # define OSSL_FUNC_MAC_DUPCTX                        2
 302 # define OSSL_FUNC_MAC_FREECTX                       3
 303 # define OSSL_FUNC_MAC_INIT                          4
 304 # define OSSL_FUNC_MAC_UPDATE                        5
 305 # define OSSL_FUNC_MAC_FINAL                         6
 306 # define OSSL_FUNC_MAC_GET_PARAMS                    7
 307 # define OSSL_FUNC_MAC_GET_CTX_PARAMS                8
 308 # define OSSL_FUNC_MAC_SET_CTX_PARAMS                9
 309 # define OSSL_FUNC_MAC_GETTABLE_PARAMS              10
 310 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS          11
 311 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS          12
 312
 313 OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx))
 314 OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src))
 315 OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx))
 316 OSSL_CORE_MAKE_FUNC(size_t, mac_size, (void *mctx))
 317 OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx))
 318 OSSL_CORE_MAKE_FUNC(int, mac_update,
 319                     (void *mctx, const unsigned char *in, size_t inl))
 320 OSSL_CORE_MAKE_FUNC(int, mac_final,
 321                     (void *mctx,
 322                      unsigned char *out, size_t *outl, size_t outsize))
 323 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx))
 324 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params,
 325                     (void *provctx))
 326 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params,
 327                     (void *provctx))
 328 OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[]))
 329 OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params,
 330                     (void *mctx, OSSL_PARAM params[]))
 331 OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params,
 332                     (void *mctx, const OSSL_PARAM params[]))
 333
 334 /* KDFs and PRFs */
 335
 336 # define OSSL_FUNC_KDF_NEWCTX                        1
 337 # define OSSL_FUNC_KDF_DUPCTX                        2
 338 # define OSSL_FUNC_KDF_FREECTX                       3
 339 # define OSSL_FUNC_KDF_RESET                         4
 340 # define OSSL_FUNC_KDF_DERIVE                        5
 341 # define OSSL_FUNC_KDF_GETTABLE_PARAMS               6
 342 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS           7
 343 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS           8
 344 # define OSSL_FUNC_KDF_GET_PARAMS                    9
 345 # define OSSL_FUNC_KDF_GET_CTX_PARAMS               10
 346 # define OSSL_FUNC_KDF_SET_CTX_PARAMS               11
 347
 348 OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx))
 349 OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src))
 350 OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx))
 351 OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx))
 352 OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key,
 353                                           size_t keylen))
 354 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx))
 355 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params,
 356                     (void *provctx))
 357 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params,
 358                     (void *provctx))
 359 OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[]))
 360 OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params,
 361                     (void *kctx, OSSL_PARAM params[]))
 362 OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params,
 363                     (void *kctx, const OSSL_PARAM params[]))
 364
 365 /* RAND */
 366
 367 # define OSSL_FUNC_RAND_NEWCTX                        1
 368 # define OSSL_FUNC_RAND_FREECTX                       2
 369 # define OSSL_FUNC_RAND_INSTANTIATE                   3
 370 # define OSSL_FUNC_RAND_UNINSTANTIATE                 4
 371 # define OSSL_FUNC_RAND_GENERATE                      5
 372 # define OSSL_FUNC_RAND_RESEED                        6
 373 # define OSSL_FUNC_RAND_NONCE                         7
 374 # define OSSL_FUNC_RAND_ENABLE_LOCKING                8
 375 # define OSSL_FUNC_RAND_LOCK                          9
 376 # define OSSL_FUNC_RAND_UNLOCK                       10
 377 # define OSSL_FUNC_RAND_GETTABLE_PARAMS              11
 378 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS          12
 379 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS          13
 380 # define OSSL_FUNC_RAND_GET_PARAMS                   14
 381 # define OSSL_FUNC_RAND_GET_CTX_PARAMS               15
 382 # define OSSL_FUNC_RAND_SET_CTX_PARAMS               16
 383 # define OSSL_FUNC_RAND_VERIFY_ZEROIZATION           17
 384
 385 OSSL_CORE_MAKE_FUNC(void *,rand_newctx,
 386                     (void *provctx, void *parent,
 387                     const OSSL_DISPATCH *parent_calls))
 388 OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx))
 389 OSSL_CORE_MAKE_FUNC(int,rand_instantiate,
 390                     (void *vdrbg, unsigned int strength,
 391                      int prediction_resistance,
 392                      const unsigned char *pstr, size_t pstr_len))
 393 OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg))
 394 OSSL_CORE_MAKE_FUNC(int,rand_generate,
 395                     (void *vctx, unsigned char *out, size_t outlen,
 396                      unsigned int strength, int prediction_resistance,
 397                      const unsigned char *addin, size_t addin_len))
 398 OSSL_CORE_MAKE_FUNC(int,rand_reseed,
 399                     (void *vctx, int prediction_resistance,
 400                      const unsigned char *ent, size_t ent_len,
 401                      const unsigned char *addin, size_t addin_len))
 402 OSSL_CORE_MAKE_FUNC(size_t,rand_nonce,
 403                     (void *vctx, unsigned char *out, unsigned int strength,
 404                      size_t min_noncelen, size_t max_noncelen))
 405 OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx))
 406 OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx))
 407 OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx))
 408 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx))
 409 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params,
 410                     (void *provctx))
 411 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params,
 412                     (void *provctx))
 413 OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[]))
 414 OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params,
 415                     (void *vctx, OSSL_PARAM params[]))
 416 OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params,
 417                     (void *vctx, const OSSL_PARAM params[]))
 418 OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks,
 419                     (void *vctx, OSSL_INOUT_CALLBACK *get_entropy,
 420                      OSSL_CALLBACK *cleanup_entropy,
 421                      OSSL_INOUT_CALLBACK *get_nonce,
 422                      OSSL_CALLBACK *cleanup_nonce, void *arg))
 423 OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization,
 424                     (void *vctx))
 425
 426 /*-
 427  * Key management
 428  *
 429  * The Key Management takes care of provider side key objects, and includes
 430  * all current functionality to create them, destroy them, set parameters
 431  * and key material, etc, essentially everything that manipulates the keys
 432  * themselves and their parameters.
 433  *
 434  * The key objects are commonly refered to as |keydata|, and it MUST be able
 435  * to contain parameters if the key has any, the public key and the private
 436  * key.  All parts are optional, but their presence determines what can be
 437  * done with the key object in terms of encryption, signature, and so on.
 438  * The assumption from libcrypto is that the key object contains any of the
 439  * following data combinations:
 440  *
 441  * - parameters only
 442  * - public key only
 443  * - public key + private key
 444  * - parameters + public key
 445  * - parameters + public key + private key
 446  *
 447  * What "parameters", "public key" and "private key" means in detail is left
 448  * to the implementation.  In the case of DH and DSA, they would typically
 449  * include domain parameters, while for certain variants of RSA, they would
 450  * typically include PSS or OAEP parameters.
 451  *
 452  * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with
 453  * OSSL_FUNC_keymgmt_free().  Key objects can have data filled in with
 454  * OSSL_FUNC_keymgmt_import().
 455  *
 456  * Three functions are made available to check what selection of data is
 457  * present in a key object: OSSL_FUNC_keymgmt_has_parameters(),
 458  * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(),
 459  */
 460
 461 /* Key data subset selection - individual bits */
 462 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY            0x01
 463 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY             0x02
 464 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS      0x04
 465 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS       0x80
 466
 467 /* Key data subset selection - combinations */
 468 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS     \
 469     ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS     \
 470       | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
 471 # define OSSL_KEYMGMT_SELECT_KEYPAIR            \
 472     ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
 473 # define OSSL_KEYMGMT_SELECT_ALL                \
 474     ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
 475
 476 /* Basic key object creation */
 477 # define OSSL_FUNC_KEYMGMT_NEW                         1
 478 OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx))
 479
 480 /* Generation, a more complex constructor */
 481 # define OSSL_FUNC_KEYMGMT_GEN_INIT                    2
 482 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE            3
 483 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS              4
 484 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS         5
 485 # define OSSL_FUNC_KEYMGMT_GEN                         6
 486 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP                 7
 487 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init,
 488                     (void *provctx, int selection))
 489 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template,
 490                     (void *genctx, void *templ))
 491 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params,
 492                     (void *genctx, const OSSL_PARAM params[]))
 493 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
 494                     keymgmt_gen_settable_params, (void *provctx))
 495 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_get_params,
 496                     (void *genctx, OSSL_PARAM params[]))
 497 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
 498                     keymgmt_gen_gettable_params, (void *provctx))
 499 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen,
 500                     (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
 501 OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx))
 502
 503 /* Key loading by object reference */
 504 # define OSSL_FUNC_KEYMGMT_LOAD                        8
 505 OSSL_CORE_MAKE_FUNC(void *, keymgmt_load,
 506                     (const void *reference, size_t reference_sz))
 507
 508 /* Basic key object destruction */
 509 # define OSSL_FUNC_KEYMGMT_FREE                       10
 510 OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata))
 511
 512 /* Key object information, with discovery */
 513 #define OSSL_FUNC_KEYMGMT_GET_PARAMS                  11
 514 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS             12
 515 OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params,
 516                     (void *keydata, OSSL_PARAM params[]))
 517 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params, (void *))
 518
 519 #define OSSL_FUNC_KEYMGMT_SET_PARAMS                  13
 520 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS             14
 521 OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params,
 522                     (void *keydata, const OSSL_PARAM params[]))
 523 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params, (void *))
 524
 525 /* Key checks - discovery of supported operations */
 526 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME       20
 527 OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name,
 528                     (int operation_id))
 529
 530 /* Key checks - key data content checks */
 531 # define OSSL_FUNC_KEYMGMT_HAS                        21
 532 OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (void *keydata, int selection))
 533
 534 /* Key checks - validation */
 535 # define OSSL_FUNC_KEYMGMT_VALIDATE                   22
 536 OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (void *keydata, int selection))
 537
 538 /* Key checks - matching */
 539 # define OSSL_FUNC_KEYMGMT_MATCH                      23
 540 OSSL_CORE_MAKE_FUNC(int, keymgmt_match,
 541                     (const void *keydata1, const void *keydata2,
 542                      int selection))
 543
 544 /* Import and export functions, with discovery */
 545 # define OSSL_FUNC_KEYMGMT_IMPORT                     40
 546 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES               41
 547 # define OSSL_FUNC_KEYMGMT_EXPORT                     42
 548 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES               43
 549 OSSL_CORE_MAKE_FUNC(int, keymgmt_import,
 550                     (void *keydata, int selection, const OSSL_PARAM params[]))
 551 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types,
 552                     (int selection))
 553 OSSL_CORE_MAKE_FUNC(int, keymgmt_export,
 554                     (void *keydata, int selection,
 555                      OSSL_CALLBACK *param_cb, void *cbarg))
 556 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types,
 557                     (int selection))
 558
 559 /* Copy function, only works for matching keymgmt */
 560 # define OSSL_FUNC_KEYMGMT_COPY                       44
 561 OSSL_CORE_MAKE_FUNC(int, keymgmt_copy,
 562                     ( void *keydata_to, const void *keydata_from,
 563                      int selection))
 564
 565 /* Key Exchange */
 566
 567 # define OSSL_FUNC_KEYEXCH_NEWCTX                      1
 568 # define OSSL_FUNC_KEYEXCH_INIT                        2
 569 # define OSSL_FUNC_KEYEXCH_DERIVE                      3
 570 # define OSSL_FUNC_KEYEXCH_SET_PEER                    4
 571 # define OSSL_FUNC_KEYEXCH_FREECTX                     5
 572 # define OSSL_FUNC_KEYEXCH_DUPCTX                      6
 573 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS              7
 574 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS         8
 575 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS              9
 576 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS        10
 577
 578 OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx))
 579 OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey))
 580 OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx,  unsigned char *secret,
 581                                              size_t *secretlen, size_t outlen))
 582 OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey))
 583 OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx))
 584 OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx))
 585 OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx,
 586                                                      const OSSL_PARAM params[]))
 587 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params,
 588                     (void *provctx))
 589 OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx,
 590                                                      OSSL_PARAM params[]))
 591 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params,
 592                     (void *provctx))
 593
 594 /* Signature */
 595
 596 # define OSSL_FUNC_SIGNATURE_NEWCTX                  1
 597 # define OSSL_FUNC_SIGNATURE_SIGN_INIT               2
 598 # define OSSL_FUNC_SIGNATURE_SIGN                    3
 599 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT             4
 600 # define OSSL_FUNC_SIGNATURE_VERIFY                  5
 601 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT     6
 602 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER          7
 603 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT        8
 604 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE      9
 605 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL      10
 606 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN            11
 607 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT     12
 608 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE   13
 609 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL    14
 610 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY          15
 611 # define OSSL_FUNC_SIGNATURE_FREECTX                16
 612 # define OSSL_FUNC_SIGNATURE_DUPCTX                 17
 613 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS         18
 614 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS    19
 615 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS         20
 616 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS    21
 617 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS      22
 618 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
 619 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS      24
 620 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
 621
 622 OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx,
 623                                                   const char *propq))
 624 OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey))
 625 OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx,  unsigned char *sig,
 626                                              size_t *siglen, size_t sigsize,
 627                                              const unsigned char *tbs,
 628                                              size_t tbslen))
 629 OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey))
 630 OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx,
 631                                                const unsigned char *sig,
 632                                                size_t siglen,
 633                                                const unsigned char *tbs,
 634                                                size_t tbslen))
 635 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init, (void *ctx,
 636                                                             void *provkey))
 637 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover, (void *ctx,
 638                                                        unsigned char *rout,
 639                                                        size_t *routlen,
 640                                                        size_t routsize,
 641                                                        const unsigned char *sig,
 642                                                        size_t siglen))
 643 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init,
 644                     (void *ctx, const char *mdname, void *provkey))
 645 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update,
 646                     (void *ctx, const unsigned char *data, size_t datalen))
 647 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final,
 648                     (void *ctx, unsigned char *sig, size_t *siglen,
 649                      size_t sigsize))
 650 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign,
 651                     (void *ctx, unsigned char *sigret, size_t *siglen,
 652                      size_t sigsize, const unsigned char *tbs, size_t tbslen))
 653 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init,
 654                     (void *ctx, const char *mdname, void *provkey))
 655 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update,
 656                     (void *ctx, const unsigned char *data, size_t datalen))
 657 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final,
 658                     (void *ctx, const unsigned char *sig, size_t siglen))
 659 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify,
 660                     (void *ctx, const unsigned char *sig, size_t siglen,
 661                      const unsigned char *tbs, size_t tbslen))
 662 OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx))
 663 OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx))
 664 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params,
 665                     (void *ctx, OSSL_PARAM params[]))
 666 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params,
 667                     (void *provctx))
 668 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params,
 669                     (void *ctx, const OSSL_PARAM params[]))
 670 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params,
 671                     (void *provctx))
 672 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params,
 673                     (void *ctx, OSSL_PARAM params[]))
 674 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params,
 675                     (void *ctx))
 676 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params,
 677                     (void *ctx, const OSSL_PARAM params[]))
 678 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params,
 679                     (void *ctx))
 680
 681
 682 /* Asymmetric Ciphers */
 683
 684 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX                  1
 685 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT            2
 686 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT                 3
 687 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT            4
 688 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT                 5
 689 # define OSSL_FUNC_ASYM_CIPHER_FREECTX                 6
 690 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX                  7
 691 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS          8
 692 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS     9
 693 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS         10
 694 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS    11
 695
 696 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx))
 697 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey))
 698 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out,
 699                                                   size_t *outlen,
 700                                                   size_t outsize,
 701                                                   const unsigned char *in,
 702                                                   size_t inlen))
 703 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey))
 704 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out,
 705                                                   size_t *outlen,
 706                                                   size_t outsize,
 707                                                   const unsigned char *in,
 708                                                   size_t inlen))
 709 OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx))
 710 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx))
 711 OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params,
 712                     (void *ctx, OSSL_PARAM params[]))
 713 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params,
 714                     (void *provctx))
 715 OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params,
 716                     (void *ctx, const OSSL_PARAM params[]))
 717 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params,
 718                     (void *provctx))
 719
 720 /* Encoders and decoders */
 721 # define OSSL_FUNC_ENCODER_NEWCTX                      1
 722 # define OSSL_FUNC_ENCODER_FREECTX                     2
 723 # define OSSL_FUNC_ENCODER_SET_CTX_PARAMS              3
 724 # define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS         4
 725 # define OSSL_FUNC_ENCODER_ENCODE_DATA                10
 726 # define OSSL_FUNC_ENCODER_ENCODE_OBJECT              11
 727 OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx))
 728 OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx))
 729 OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params,
 730                     (void *ctx, const OSSL_PARAM params[]))
 731 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params,
 732                     (void *provctx))
 733
 734 OSSL_CORE_MAKE_FUNC(int, encoder_encode_data,
 735                     (void *ctx, const OSSL_PARAM[], OSSL_CORE_BIO *out,
 736                      OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
 737 OSSL_CORE_MAKE_FUNC(int, encoder_encode_object,
 738                     (void *ctx, const void *obj, OSSL_CORE_BIO *out,
 739                      OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
 740
 741 # define OSSL_FUNC_DECODER_NEWCTX                      1
 742 # define OSSL_FUNC_DECODER_FREECTX                     2
 743 # define OSSL_FUNC_DECODER_GET_PARAMS                  3
 744 # define OSSL_FUNC_DECODER_GETTABLE_PARAMS             4
 745 # define OSSL_FUNC_DECODER_SET_CTX_PARAMS              5
 746 # define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS         6
 747 # define OSSL_FUNC_DECODER_DECODE                     10
 748 # define OSSL_FUNC_DECODER_EXPORT_OBJECT              11
 749 OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx))
 750 OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx))
 751 OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[]))
 752 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params,
 753                     (void *provctx))
 754 OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params,
 755                     (void *ctx, const OSSL_PARAM params[]))
 756 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params,
 757                     (void *provctx))
 758
 759 OSSL_CORE_MAKE_FUNC(int, decoder_decode,
 760                     (void *ctx, OSSL_CORE_BIO *in,
 761                      OSSL_CALLBACK *metadata_cb, void *metadata_cbarg,
 762                      OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
 763 OSSL_CORE_MAKE_FUNC(int, decoder_export_object,
 764                     (void *ctx, const void *objref, size_t objref_sz,
 765                      OSSL_CALLBACK *export_cb, void *export_cbarg))
 766
 767 /*-
 768  * Store
 769  *
 770  * Objects are scanned by using the 'open', 'load', 'eof' and 'close'
 771  * functions, which implement an OSSL_STORE loader.
 772  *
 773  * store_load() works in a way that's very similar to the decoders, in
 774  * that they pass an abstract object through a callback, either as a DER
 775  * octet string or as an object reference, which libcrypto will have to
 776  * deal with.
 777  */
 778
 779 #define OSSL_FUNC_STORE_OPEN                        1
 780 #define OSSL_FUNC_STORE_ATTACH                      2
 781 #define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS         3
 782 #define OSSL_FUNC_STORE_SET_CTX_PARAMS              4
 783 #define OSSL_FUNC_STORE_LOAD                        5
 784 #define OSSL_FUNC_STORE_EOF                         6
 785 #define OSSL_FUNC_STORE_CLOSE                       7
 786 #define OSSL_FUNC_STORE_EXPORT_OBJECT               8
 787 OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri))
 788 OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in))
 789 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params,
 790                     (void *provctx))
 791 OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params,
 792                     (void *loaderctx, const OSSL_PARAM params[]))
 793 OSSL_CORE_MAKE_FUNC(int, store_load,
 794                     (void *loaderctx,
 795                      OSSL_CALLBACK *object_cb, void *object_cbarg,
 796                      OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
 797 OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx))
 798 OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx))
 799 OSSL_CORE_MAKE_FUNC(int, store_export_object,
 800                     (void *loaderctx, const void *objref, size_t objref_sz,
 801                      OSSL_CALLBACK *export_cb, void *export_cbarg))
 802
 803 # ifdef __cplusplus
 804 }
 805 # endif
 806
 807 #endif