include/openssl/core_numbers.h

   1 /*
   2  * Copyright 2019 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 # include <openssl/self_test.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_'foo'_fn
  36  * - a function pointer extractor function with the name OSSL_'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_##name##_fn)args;                                \
  47     static ossl_inline \
  48     OSSL_##name##_fn *OSSL_get_##name(const OSSL_DISPATCH *opf)         \
  49     {                                                                   \
  50         return (OSSL_##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_PROVIDER *prov))
  64 # define OSSL_FUNC_CORE_GET_PARAMS             2
  65 OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_PROVIDER *prov,
  66                                          OSSL_PARAM params[]))
  67 # define OSSL_FUNC_CORE_THREAD_START           3
  68 OSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_PROVIDER *prov,
  69                                            OSSL_thread_stop_handler_fn handfn))
  70 # define OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT    4
  71 OSSL_CORE_MAKE_FUNC(OPENSSL_CTX *,core_get_library_context,
  72                     (const OSSL_PROVIDER *prov))
  73 # define OSSL_FUNC_CORE_NEW_ERROR              5
  74 OSSL_CORE_MAKE_FUNC(void,core_new_error,(const OSSL_PROVIDER *prov))
  75 # define OSSL_FUNC_CORE_SET_ERROR_DEBUG        6
  76 OSSL_CORE_MAKE_FUNC(void,core_set_error_debug,
  77                     (const OSSL_PROVIDER *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_PROVIDER *prov,
  82                      uint32_t reason, const char *fmt, va_list args))
  83
  84 /* Memory allocation, freeing, clearing. */
  85 #define OSSL_FUNC_CRYPTO_MALLOC               10
  86 OSSL_CORE_MAKE_FUNC(void *,
  87         CRYPTO_malloc, (size_t num, const char *file, int line))
  88 #define OSSL_FUNC_CRYPTO_ZALLOC               11
  89 OSSL_CORE_MAKE_FUNC(void *,
  90         CRYPTO_zalloc, (size_t num, const char *file, int line))
  91 #define OSSL_FUNC_CRYPTO_FREE                 12
  92 OSSL_CORE_MAKE_FUNC(void,
  93         CRYPTO_free, (void *ptr, const char *file, int line))
  94 #define OSSL_FUNC_CRYPTO_CLEAR_FREE           13
  95 OSSL_CORE_MAKE_FUNC(void,
  96         CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line))
  97 #define OSSL_FUNC_CRYPTO_REALLOC              14
  98 OSSL_CORE_MAKE_FUNC(void *,
  99         CRYPTO_realloc, (void *addr, size_t num, const char *file, int line))
 100 #define OSSL_FUNC_CRYPTO_CLEAR_REALLOC        15
 101 OSSL_CORE_MAKE_FUNC(void *,
 102         CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num,
 103                                const char *file, int line))
 104 #define OSSL_FUNC_CRYPTO_SECURE_MALLOC        16
 105 OSSL_CORE_MAKE_FUNC(void *,
 106         CRYPTO_secure_malloc, (size_t num, const char *file, int line))
 107 #define OSSL_FUNC_CRYPTO_SECURE_ZALLOC        17
 108 OSSL_CORE_MAKE_FUNC(void *,
 109         CRYPTO_secure_zalloc, (size_t num, const char *file, int line))
 110 #define OSSL_FUNC_CRYPTO_SECURE_FREE          18
 111 OSSL_CORE_MAKE_FUNC(void,
 112         CRYPTO_secure_free, (void *ptr, const char *file, int line))
 113 #define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE    19
 114 OSSL_CORE_MAKE_FUNC(void,
 115         CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file,
 116                                    int line))
 117 #define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED     20
 118 OSSL_CORE_MAKE_FUNC(int,
 119         CRYPTO_secure_allocated, (const void *ptr))
 120 #define OSSL_FUNC_OPENSSL_CLEANSE             21
 121 OSSL_CORE_MAKE_FUNC(void,
 122         OPENSSL_cleanse, (void *ptr, size_t len))
 123
 124 /* Bio functions provided by the core */
 125 #define OSSL_FUNC_BIO_NEW_FILE                23
 126 #define OSSL_FUNC_BIO_NEW_MEMBUF              24
 127 #define OSSL_FUNC_BIO_READ_EX                 25
 128 #define OSSL_FUNC_BIO_FREE                    26
 129 #define OSSL_FUNC_BIO_VPRINTF                 27
 130
 131 OSSL_CORE_MAKE_FUNC(BIO *, BIO_new_file, (const char *filename, const char *mode))
 132 OSSL_CORE_MAKE_FUNC(BIO *, BIO_new_membuf, (const void *buf, int len))
 133 OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (BIO *bio, void *data, size_t data_len,
 134                                        size_t *bytes_read))
 135 OSSL_CORE_MAKE_FUNC(int, BIO_free, (BIO *bio))
 136 OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (BIO *bio, const char *format,
 137                                        va_list args))
 138
 139 #define OSSL_FUNC_SELF_TEST_CB                28
 140 OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CTX *ctx, OSSL_CALLBACK **cb,
 141                                          void **cbarg))
 142
 143 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
 144 # define OSSL_FUNC_PROVIDER_TEARDOWN         1024
 145 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
 146 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS  1025
 147 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
 148                     provider_gettable_params,(void *provctx))
 149 # define OSSL_FUNC_PROVIDER_GET_PARAMS       1026
 150 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
 151                                              OSSL_PARAM params[]))
 152 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION  1027
 153 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
 154                     (void *provctx, int operation_id, const int *no_store))
 155 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
 156 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
 157                     (void *provctx))
 158
 159 /* Operations */
 160
 161 # define OSSL_OP_DIGEST                              1
 162 # define OSSL_OP_CIPHER                              2   /* Symmetric Ciphers */
 163 # define OSSL_OP_MAC                                 3
 164 # define OSSL_OP_KDF                                 4
 165 # define OSSL_OP_KEYMGMT                            10
 166 # define OSSL_OP_KEYEXCH                            11
 167 # define OSSL_OP_SIGNATURE                          12
 168 # define OSSL_OP_ASYM_CIPHER                        13
 169 /* New section for non-EVP operations */
 170 # define OSSL_OP_SERIALIZER                         20
 171 /* Highest known operation number */
 172 # define OSSL_OP__HIGHEST                           20
 173
 174 /* Digests */
 175
 176 # define OSSL_FUNC_DIGEST_NEWCTX                     1
 177 # define OSSL_FUNC_DIGEST_INIT                       2
 178 # define OSSL_FUNC_DIGEST_UPDATE                     3
 179 # define OSSL_FUNC_DIGEST_FINAL                      4
 180 # define OSSL_FUNC_DIGEST_DIGEST                     5
 181 # define OSSL_FUNC_DIGEST_FREECTX                    6
 182 # define OSSL_FUNC_DIGEST_DUPCTX                     7
 183 # define OSSL_FUNC_DIGEST_GET_PARAMS                 8
 184 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS             9
 185 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS            10
 186 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS           11
 187 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS       12
 188 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS       13
 189
 190 OSSL_CORE_MAKE_FUNC(void *, OP_digest_newctx, (void *provctx))
 191 OSSL_CORE_MAKE_FUNC(int, OP_digest_init, (void *dctx))
 192 OSSL_CORE_MAKE_FUNC(int, OP_digest_update,
 193                     (void *dctx, const unsigned char *in, size_t inl))
 194 OSSL_CORE_MAKE_FUNC(int, OP_digest_final,
 195                     (void *dctx,
 196                      unsigned char *out, size_t *outl, size_t outsz))
 197 OSSL_CORE_MAKE_FUNC(int, OP_digest_digest,
 198                     (void *provctx, const unsigned char *in, size_t inl,
 199                      unsigned char *out, size_t *outl, size_t outsz))
 200
 201 OSSL_CORE_MAKE_FUNC(void, OP_digest_freectx, (void *dctx))
 202 OSSL_CORE_MAKE_FUNC(void *, OP_digest_dupctx, (void *dctx))
 203
 204 OSSL_CORE_MAKE_FUNC(int, OP_digest_get_params, (OSSL_PARAM params[]))
 205 OSSL_CORE_MAKE_FUNC(int, OP_digest_set_ctx_params,
 206                     (void *vctx, const OSSL_PARAM params[]))
 207 OSSL_CORE_MAKE_FUNC(int, OP_digest_get_ctx_params,
 208                     (void *vctx, OSSL_PARAM params[]))
 209 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_params, (void))
 210 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_settable_ctx_params, (void))
 211 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_ctx_params, (void))
 212
 213 /* Symmetric Ciphers */
 214
 215 # define OSSL_FUNC_CIPHER_NEWCTX                     1
 216 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT               2
 217 # define OSSL_FUNC_CIPHER_DECRYPT_INIT               3
 218 # define OSSL_FUNC_CIPHER_UPDATE                     4
 219 # define OSSL_FUNC_CIPHER_FINAL                      5
 220 # define OSSL_FUNC_CIPHER_CIPHER                     6
 221 # define OSSL_FUNC_CIPHER_FREECTX                    7
 222 # define OSSL_FUNC_CIPHER_DUPCTX                     8
 223 # define OSSL_FUNC_CIPHER_GET_PARAMS                 9
 224 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS            10
 225 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS            11
 226 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS           12
 227 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS       13
 228 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS       14
 229
 230 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_newctx, (void *provctx))
 231 OSSL_CORE_MAKE_FUNC(int, OP_cipher_encrypt_init, (void *cctx,
 232                                                   const unsigned char *key,
 233                                                   size_t keylen,
 234                                                   const unsigned char *iv,
 235                                                   size_t ivlen))
 236 OSSL_CORE_MAKE_FUNC(int, OP_cipher_decrypt_init, (void *cctx,
 237                                                   const unsigned char *key,
 238                                                   size_t keylen,
 239                                                   const unsigned char *iv,
 240                                                   size_t ivlen))
 241 OSSL_CORE_MAKE_FUNC(int, OP_cipher_update,
 242                     (void *cctx,
 243                      unsigned char *out, size_t *outl, size_t outsize,
 244                      const unsigned char *in, size_t inl))
 245 OSSL_CORE_MAKE_FUNC(int, OP_cipher_final,
 246                     (void *cctx,
 247                      unsigned char *out, size_t *outl, size_t outsize))
 248 OSSL_CORE_MAKE_FUNC(int, OP_cipher_cipher,
 249                     (void *cctx,
 250                      unsigned char *out, size_t *outl, size_t outsize,
 251                      const unsigned char *in, size_t inl))
 252 OSSL_CORE_MAKE_FUNC(void, OP_cipher_freectx, (void *cctx))
 253 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_dupctx, (void *cctx))
 254 OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_params, (OSSL_PARAM params[]))
 255 OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_ctx_params, (void *cctx,
 256                                                     OSSL_PARAM params[]))
 257 OSSL_CORE_MAKE_FUNC(int, OP_cipher_set_ctx_params, (void *cctx,
 258                                                     const OSSL_PARAM params[]))
 259 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_params,     (void))
 260 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_settable_ctx_params, (void))
 261 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_ctx_params, (void))
 262
 263 /* MACs */
 264
 265 # define OSSL_FUNC_MAC_NEWCTX                        1
 266 # define OSSL_FUNC_MAC_DUPCTX                        2
 267 # define OSSL_FUNC_MAC_FREECTX                       3
 268 # define OSSL_FUNC_MAC_INIT                          4
 269 # define OSSL_FUNC_MAC_UPDATE                        5
 270 # define OSSL_FUNC_MAC_FINAL                         6
 271 # define OSSL_FUNC_MAC_GET_PARAMS                    7
 272 # define OSSL_FUNC_MAC_GET_CTX_PARAMS                8
 273 # define OSSL_FUNC_MAC_SET_CTX_PARAMS                9
 274 # define OSSL_FUNC_MAC_GETTABLE_PARAMS              10
 275 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS          11
 276 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS          12
 277
 278 OSSL_CORE_MAKE_FUNC(void *, OP_mac_newctx, (void *provctx))
 279 OSSL_CORE_MAKE_FUNC(void *, OP_mac_dupctx, (void *src))
 280 OSSL_CORE_MAKE_FUNC(void, OP_mac_freectx, (void *mctx))
 281 OSSL_CORE_MAKE_FUNC(size_t, OP_mac_size, (void *mctx))
 282 OSSL_CORE_MAKE_FUNC(int, OP_mac_init, (void *mctx))
 283 OSSL_CORE_MAKE_FUNC(int, OP_mac_update,
 284                     (void *mctx, const unsigned char *in, size_t inl))
 285 OSSL_CORE_MAKE_FUNC(int, OP_mac_final,
 286                     (void *mctx,
 287                      unsigned char *out, size_t *outl, size_t outsize))
 288 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_params, (void))
 289 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_ctx_params, (void))
 290 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_settable_ctx_params, (void))
 291 OSSL_CORE_MAKE_FUNC(int, OP_mac_get_params, (OSSL_PARAM params[]))
 292 OSSL_CORE_MAKE_FUNC(int, OP_mac_get_ctx_params,
 293                     (void *mctx, OSSL_PARAM params[]))
 294 OSSL_CORE_MAKE_FUNC(int, OP_mac_set_ctx_params,
 295                     (void *mctx, const OSSL_PARAM params[]))
 296
 297 /* KDFs and PRFs */
 298
 299 # define OSSL_FUNC_KDF_NEWCTX                        1
 300 # define OSSL_FUNC_KDF_DUPCTX                        2
 301 # define OSSL_FUNC_KDF_FREECTX                       3
 302 # define OSSL_FUNC_KDF_RESET                         4
 303 # define OSSL_FUNC_KDF_DERIVE                        5
 304 # define OSSL_FUNC_KDF_GETTABLE_PARAMS               6
 305 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS           7
 306 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS           8
 307 # define OSSL_FUNC_KDF_GET_PARAMS                    9
 308 # define OSSL_FUNC_KDF_GET_CTX_PARAMS               10
 309 # define OSSL_FUNC_KDF_SET_CTX_PARAMS               11
 310
 311 OSSL_CORE_MAKE_FUNC(void *, OP_kdf_newctx, (void *provctx))
 312 OSSL_CORE_MAKE_FUNC(void *, OP_kdf_dupctx, (void *src))
 313 OSSL_CORE_MAKE_FUNC(void, OP_kdf_freectx, (void *kctx))
 314 OSSL_CORE_MAKE_FUNC(void, OP_kdf_reset, (void *kctx))
 315 OSSL_CORE_MAKE_FUNC(int, OP_kdf_derive, (void *kctx, unsigned char *key,
 316                                           size_t keylen))
 317 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_gettable_params, (void))
 318 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_gettable_ctx_params, (void))
 319 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_settable_ctx_params, (void))
 320 OSSL_CORE_MAKE_FUNC(int, OP_kdf_get_params, (OSSL_PARAM params[]))
 321 OSSL_CORE_MAKE_FUNC(int, OP_kdf_get_ctx_params,
 322                     (void *kctx, OSSL_PARAM params[]))
 323 OSSL_CORE_MAKE_FUNC(int, OP_kdf_set_ctx_params,
 324                     (void *kctx, const OSSL_PARAM params[]))
 325
 326 /*-
 327  * Key management
 328  *
 329  * Key domain parameter references can be created in several manners:
 330  * - by importing the domain parameter material via an OSSL_PARAM array.
 331  * - by generating key domain parameters, given input via an OSSL_PARAM
 332  *   array.
 333  *
 334  * Key references can be created in several manners:
 335  * - by importing the key material via an OSSL_PARAM array.
 336  * - by generating a key, given optional domain parameters and
 337  *   additional keygen parameters.
 338  *   If domain parameters are given, they must have been generated using
 339  *   the domain parameter generator functions.
 340  *   If the domain parameters comes from a different provider, results
 341  *   are undefined.
 342  *   THE CALLER MUST ENSURE THAT CORRECT DOMAIN PARAMETERS ARE USED.
 343  * - by loading an internal key, given a binary blob that forms an identity.
 344  *   THE CALLER MUST ENSURE THAT A CORRECT IDENTITY IS USED.
 345  */
 346
 347 /* Key domain parameter creation and destruction */
 348 # define OSSL_FUNC_KEYMGMT_IMPORTDOMPARAMS          1
 349 # define OSSL_FUNC_KEYMGMT_GENDOMPARAMS             2
 350 # define OSSL_FUNC_KEYMGMT_FREEDOMPARAMS            3
 351 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_importdomparams,
 352                     (void *provctx, const OSSL_PARAM params[]))
 353 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_gendomparams,
 354                     (void *provctx, const OSSL_PARAM params[]))
 355 OSSL_CORE_MAKE_FUNC(void, OP_keymgmt_freedomparams, (void *domparams))
 356
 357 /* Key domain parameter export */
 358 # define OSSL_FUNC_KEYMGMT_EXPORTDOMPARAMS          4
 359 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_exportdomparams,
 360                     (void *domparams, OSSL_CALLBACK *param_cb, void *cbarg))
 361
 362 /* Key domain parameter discovery */
 363 /*
 364  * TODO(v3.0) investigate if we need OP_keymgmt_exportdomparam_types.
 365  * 'openssl provider' may be a caller...
 366  */
 367 # define OSSL_FUNC_KEYMGMT_IMPORTDOMPARAM_TYPES     5
 368 # define OSSL_FUNC_KEYMGMT_EXPORTDOMPARAM_TYPES     6
 369 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_importdomparam_types,
 370                     (void))
 371 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_exportdomparam_types,
 372                     (void))
 373
 374 /* Key creation and destruction */
 375 # define OSSL_FUNC_KEYMGMT_IMPORTKEY               10
 376 # define OSSL_FUNC_KEYMGMT_GENKEY                  11
 377 # define OSSL_FUNC_KEYMGMT_LOADKEY                 12
 378 # define OSSL_FUNC_KEYMGMT_FREEKEY                 13
 379 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_importkey,
 380                     (void *provctx, const OSSL_PARAM params[]))
 381 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_genkey,
 382                     (void *provctx,
 383                      void *domparams, const OSSL_PARAM genkeyparams[]))
 384 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_loadkey,
 385                     (void *provctx, void *id, size_t idlen))
 386 OSSL_CORE_MAKE_FUNC(void, OP_keymgmt_freekey, (void *key))
 387
 388 /* Key export */
 389 # define OSSL_FUNC_KEYMGMT_EXPORTKEY               14
 390 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_exportkey,
 391                     (void *key, OSSL_CALLBACK *param_cb, void *cbarg))
 392
 393 /* Key discovery */
 394 /*
 395  * TODO(v3.0) investigate if we need OP_keymgmt_exportkey_types.
 396  * 'openssl provider' may be a caller...
 397  */
 398 # define OSSL_FUNC_KEYMGMT_IMPORTKEY_TYPES         15
 399 # define OSSL_FUNC_KEYMGMT_EXPORTKEY_TYPES         16
 400 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_importkey_types, (void))
 401 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_exportkey_types, (void))
 402
 403 /* Discovery of supported operations */
 404 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME    17
 405 OSSL_CORE_MAKE_FUNC(const char *,OP_keymgmt_query_operation_name,
 406                     (int operation_id))
 407
 408 /* Key Exchange */
 409
 410 # define OSSL_FUNC_KEYEXCH_NEWCTX                      1
 411 # define OSSL_FUNC_KEYEXCH_INIT                        2
 412 # define OSSL_FUNC_KEYEXCH_DERIVE                      3
 413 # define OSSL_FUNC_KEYEXCH_SET_PEER                    4
 414 # define OSSL_FUNC_KEYEXCH_FREECTX                     5
 415 # define OSSL_FUNC_KEYEXCH_DUPCTX                      6
 416 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS              7
 417 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS         8
 418
 419 OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_newctx, (void *provctx))
 420 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_init, (void *ctx, void *provkey))
 421 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_derive, (void *ctx,  unsigned char *secret,
 422                                              size_t *secretlen, size_t outlen))
 423 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_peer, (void *ctx, void *provkey))
 424 OSSL_CORE_MAKE_FUNC(void, OP_keyexch_freectx, (void *ctx))
 425 OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_dupctx, (void *ctx))
 426 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_ctx_params, (void *ctx,
 427                                                      const OSSL_PARAM params[]))
 428 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keyexch_settable_ctx_params,
 429                     (void))
 430
 431 /* Signature */
 432
 433 # define OSSL_FUNC_SIGNATURE_NEWCTX                  1
 434 # define OSSL_FUNC_SIGNATURE_SIGN_INIT               2
 435 # define OSSL_FUNC_SIGNATURE_SIGN                    3
 436 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT             4
 437 # define OSSL_FUNC_SIGNATURE_VERIFY                  5
 438 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT     6
 439 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER          7
 440 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT        8
 441 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE      9
 442 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL      10
 443 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT     11
 444 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE   12
 445 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL    13
 446 # define OSSL_FUNC_SIGNATURE_FREECTX                14
 447 # define OSSL_FUNC_SIGNATURE_DUPCTX                 15
 448 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS         16
 449 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS    17
 450 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS         18
 451 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS    19
 452 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS      20
 453 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 21
 454 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS      22
 455 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 23
 456
 457 OSSL_CORE_MAKE_FUNC(void *, OP_signature_newctx, (void *provctx))
 458 OSSL_CORE_MAKE_FUNC(int, OP_signature_sign_init, (void *ctx, void *provkey))
 459 OSSL_CORE_MAKE_FUNC(int, OP_signature_sign, (void *ctx,  unsigned char *sig,
 460                                              size_t *siglen, size_t sigsize,
 461                                              const unsigned char *tbs,
 462                                              size_t tbslen))
 463 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_init, (void *ctx, void *provkey))
 464 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify, (void *ctx,
 465                                                const unsigned char *sig,
 466                                                size_t siglen,
 467                                                const unsigned char *tbs,
 468                                                size_t tbslen))
 469 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_recover_init, (void *ctx,
 470                                                             void *provkey))
 471 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_recover, (void *ctx,
 472                                                        unsigned char *rout,
 473                                                        size_t *routlen,
 474                                                        size_t routsize,
 475                                                        const unsigned char *sig,
 476                                                        size_t siglen))
 477 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_init,
 478                     (void *ctx, const char *mdname, const char *props,
 479                      void *provkey))
 480 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_update,
 481                     (void *ctx, const unsigned char *data, size_t datalen))
 482 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_final,
 483                     (void *ctx, unsigned char *sig, size_t *siglen,
 484                      size_t sigsize))
 485 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_init,
 486                     (void *ctx, const char *mdname, const char *props,
 487                      void *provkey))
 488 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_update,
 489                     (void *ctx, const unsigned char *data, size_t datalen))
 490 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_final,
 491                     (void *ctx, const unsigned char *sig, size_t siglen))
 492 OSSL_CORE_MAKE_FUNC(void, OP_signature_freectx, (void *ctx))
 493 OSSL_CORE_MAKE_FUNC(void *, OP_signature_dupctx, (void *ctx))
 494 OSSL_CORE_MAKE_FUNC(int, OP_signature_get_ctx_params,
 495                     (void *ctx, OSSL_PARAM params[]))
 496 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_gettable_ctx_params,
 497                     (void))
 498 OSSL_CORE_MAKE_FUNC(int, OP_signature_set_ctx_params,
 499                     (void *ctx, const OSSL_PARAM params[]))
 500 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_settable_ctx_params,
 501                     (void))
 502 OSSL_CORE_MAKE_FUNC(int, OP_signature_get_ctx_md_params,
 503                     (void *ctx, OSSL_PARAM params[]))
 504 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_gettable_ctx_md_params,
 505                     (void *ctx))
 506 OSSL_CORE_MAKE_FUNC(int, OP_signature_set_ctx_md_params,
 507                     (void *ctx, const OSSL_PARAM params[]))
 508 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_settable_ctx_md_params,
 509                     (void *ctx))
 510
 511
 512 /* Asymmetric Ciphers */
 513
 514 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX                  1
 515 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT            2
 516 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT                 3
 517 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT            4
 518 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT                 5
 519 # define OSSL_FUNC_ASYM_CIPHER_FREECTX                 6
 520 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX                  7
 521 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS          8
 522 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS     9
 523 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS         10
 524 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS    11
 525
 526 OSSL_CORE_MAKE_FUNC(void *, OP_asym_cipher_newctx, (void *provctx))
 527 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_encrypt_init, (void *ctx, void *provkey))
 528 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_encrypt, (void *ctx, unsigned char *out,
 529                                                   size_t *outlen,
 530                                                   size_t outsize,
 531                                                   const unsigned char *in,
 532                                                   size_t inlen))
 533 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_decrypt_init, (void *ctx, void *provkey))
 534 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_decrypt, (void *ctx, unsigned char *out,
 535                                                   size_t *outlen,
 536                                                   size_t outsize,
 537                                                   const unsigned char *in,
 538                                                   size_t inlen))
 539 OSSL_CORE_MAKE_FUNC(void, OP_asym_cipher_freectx, (void *ctx))
 540 OSSL_CORE_MAKE_FUNC(void *, OP_asym_cipher_dupctx, (void *ctx))
 541 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_get_ctx_params,
 542                     (void *ctx, OSSL_PARAM params[]))
 543 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_asym_cipher_gettable_ctx_params,
 544                     (void))
 545 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_set_ctx_params,
 546                     (void *ctx, const OSSL_PARAM params[]))
 547 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_asym_cipher_settable_ctx_params,
 548                     (void))
 549
 550 /* Serializers */
 551 # define OSSL_FUNC_SERIALIZER_NEWCTX                1
 552 # define OSSL_FUNC_SERIALIZER_FREECTX               2
 553 # define OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS        3
 554 # define OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS   4
 555 # define OSSL_FUNC_SERIALIZER_SERIALIZE_DATA       10
 556 # define OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT     11
 557 OSSL_CORE_MAKE_FUNC(void *, OP_serializer_newctx, (void *provctx))
 558 OSSL_CORE_MAKE_FUNC(void, OP_serializer_freectx, (void *ctx))
 559 OSSL_CORE_MAKE_FUNC(int, OP_serializer_set_ctx_params,
 560                     (void *ctx, const OSSL_PARAM params[]))
 561 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_serializer_settable_ctx_params,
 562                     (void))
 563
 564 OSSL_CORE_MAKE_FUNC(int, OP_serializer_serialize_data,
 565                     (void *ctx, const OSSL_PARAM[], BIO *out,
 566                      OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
 567 OSSL_CORE_MAKE_FUNC(int, OP_serializer_serialize_object,
 568                     (void *ctx, void *obj, BIO *out,
 569                      OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
 570
 571 # ifdef __cplusplus
 572 }
 573 # endif
 574
 575 #endif