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