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