include/openssl/core_dispatch.h

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