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 OSSL_CORE_NUMBERS_H
  11 # define OSSL_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 derivates
  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, const char *file, int line))
 102 #define OSSL_FUNC_CRYPTO_SECURE_MALLOC        16
 103 OSSL_CORE_MAKE_FUNC(void *,
 104         CRYPTO_secure_malloc, (size_t num, const char *file, int line))
 105 #define OSSL_FUNC_CRYPTO_SECURE_ZALLOC        17
 106 OSSL_CORE_MAKE_FUNC(void *,
 107         CRYPTO_secure_zalloc, (size_t num, const char *file, int line))
 108 #define OSSL_FUNC_CRYPTO_SECURE_FREE          18
 109 OSSL_CORE_MAKE_FUNC(void,
 110         CRYPTO_secure_free, (void *ptr, const char *file, int line))
 111 #define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE    19
 112 OSSL_CORE_MAKE_FUNC(void,
 113         CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file, int line))
 114 #define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED     20
 115 OSSL_CORE_MAKE_FUNC(int,
 116         CRYPTO_secure_allocated, (const void *ptr))
 117 #define OSSL_FUNC_OPENSSL_CLEANSE             21
 118 OSSL_CORE_MAKE_FUNC(void,
 119         OPENSSL_cleanse, (void *ptr, size_t len))
 120
 121 /* Bio functions provided by the core */
 122 #define OSSL_FUNC_BIO_NEW_FILE                22
 123 #define OSSL_FUNC_BIO_NEW_MEMBUF              23
 124 #define OSSL_FUNC_BIO_READ                    24
 125 #define OSSL_FUNC_BIO_FREE                    25
 126
 127 OSSL_CORE_MAKE_FUNC(BIO *, BIO_new_file, (const char *filename, const char *mode))
 128 OSSL_CORE_MAKE_FUNC(BIO *, BIO_new_membuf, (const void *buf, int len))
 129 OSSL_CORE_MAKE_FUNC(int, BIO_read, (BIO *bio, void *data, size_t data_len,
 130                                     size_t *bytes_read))
 131 OSSL_CORE_MAKE_FUNC(int, BIO_free, (BIO *bio))
 132
 133 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
 134 # define OSSL_FUNC_PROVIDER_TEARDOWN         1024
 135 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
 136 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS  1025
 137 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
 138                     provider_gettable_params,(void *provctx))
 139 # define OSSL_FUNC_PROVIDER_GET_PARAMS       1026
 140 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
 141                                              OSSL_PARAM params[]))
 142 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION  1027
 143 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
 144                     (void *provctx, int operation_id, const int *no_store))
 145 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
 146 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
 147                     (void *provctx))
 148
 149 /* Digests */
 150
 151 # define OSSL_OP_DIGEST                              1
 152
 153 # define OSSL_FUNC_DIGEST_NEWCTX                     1
 154 # define OSSL_FUNC_DIGEST_INIT                       2
 155 # define OSSL_FUNC_DIGEST_UPDATE                     3
 156 # define OSSL_FUNC_DIGEST_FINAL                      4
 157 # define OSSL_FUNC_DIGEST_DIGEST                     5
 158 # define OSSL_FUNC_DIGEST_FREECTX                    6
 159 # define OSSL_FUNC_DIGEST_DUPCTX                     7
 160 # define OSSL_FUNC_DIGEST_GET_PARAMS                 8
 161 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS             9
 162 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS            10
 163 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS           11
 164 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS       12
 165 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS       13
 166
 167 OSSL_CORE_MAKE_FUNC(void *, OP_digest_newctx, (void *provctx))
 168 OSSL_CORE_MAKE_FUNC(int, OP_digest_init, (void *dctx))
 169 OSSL_CORE_MAKE_FUNC(int, OP_digest_update,
 170                     (void *dctx, const unsigned char *in, size_t inl))
 171 OSSL_CORE_MAKE_FUNC(int, OP_digest_final,
 172                     (void *dctx,
 173                      unsigned char *out, size_t *outl, size_t outsz))
 174 OSSL_CORE_MAKE_FUNC(int, OP_digest_digest,
 175                     (void *provctx, const unsigned char *in, size_t inl,
 176                      unsigned char *out, size_t *outl, size_t outsz))
 177
 178 OSSL_CORE_MAKE_FUNC(void, OP_digest_freectx, (void *dctx))
 179 OSSL_CORE_MAKE_FUNC(void *, OP_digest_dupctx, (void *dctx))
 180
 181 OSSL_CORE_MAKE_FUNC(int, OP_digest_get_params, (OSSL_PARAM params[]))
 182 OSSL_CORE_MAKE_FUNC(int, OP_digest_set_ctx_params,
 183                     (void *vctx, const OSSL_PARAM params[]))
 184 OSSL_CORE_MAKE_FUNC(int, OP_digest_get_ctx_params,
 185                     (void *vctx, OSSL_PARAM params[]))
 186 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_params, (void))
 187 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_settable_ctx_params, (void))
 188 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_ctx_params, (void))
 189
 190 /* Symmetric Ciphers */
 191
 192 # define OSSL_OP_CIPHER                              2
 193
 194 # define OSSL_FUNC_CIPHER_NEWCTX                     1
 195 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT               2
 196 # define OSSL_FUNC_CIPHER_DECRYPT_INIT               3
 197 # define OSSL_FUNC_CIPHER_UPDATE                     4
 198 # define OSSL_FUNC_CIPHER_FINAL                      5
 199 # define OSSL_FUNC_CIPHER_CIPHER                     6
 200 # define OSSL_FUNC_CIPHER_FREECTX                    7
 201 # define OSSL_FUNC_CIPHER_DUPCTX                     8
 202 # define OSSL_FUNC_CIPHER_GET_PARAMS                 9
 203 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS            10
 204 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS            11
 205 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS           12
 206 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS       13
 207 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS       14
 208
 209 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_newctx, (void *provctx))
 210 OSSL_CORE_MAKE_FUNC(int, OP_cipher_encrypt_init, (void *cctx,
 211                                                   const unsigned char *key,
 212                                                   size_t keylen,
 213                                                   const unsigned char *iv,
 214                                                   size_t ivlen))
 215 OSSL_CORE_MAKE_FUNC(int, OP_cipher_decrypt_init, (void *cctx,
 216                                                   const unsigned char *key,
 217                                                   size_t keylen,
 218                                                   const unsigned char *iv,
 219                                                   size_t ivlen))
 220 OSSL_CORE_MAKE_FUNC(int, OP_cipher_update,
 221                     (void *cctx,
 222                      unsigned char *out, size_t *outl, size_t outsize,
 223                      const unsigned char *in, size_t inl))
 224 OSSL_CORE_MAKE_FUNC(int, OP_cipher_final,
 225                     (void *cctx,
 226                      unsigned char *out, size_t *outl, size_t outsize))
 227 OSSL_CORE_MAKE_FUNC(int, OP_cipher_cipher,
 228                     (void *cctx,
 229                      unsigned char *out, size_t *outl, size_t outsize,
 230                      const unsigned char *in, size_t inl))
 231 OSSL_CORE_MAKE_FUNC(void, OP_cipher_freectx, (void *cctx))
 232 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_dupctx, (void *cctx))
 233 OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_params, (OSSL_PARAM params[]))
 234 OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_ctx_params, (void *cctx,
 235                                                     OSSL_PARAM params[]))
 236 OSSL_CORE_MAKE_FUNC(int, OP_cipher_set_ctx_params, (void *cctx,
 237                                                     const OSSL_PARAM params[]))
 238 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_params,
 239                     (void))
 240 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_settable_ctx_params,
 241                     (void))
 242 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_ctx_params,
 243                     (void))
 244
 245 /* MACs */
 246
 247 # define OSSL_OP_MAC                                 3
 248
 249 # define OSSL_FUNC_MAC_NEWCTX                        1
 250 # define OSSL_FUNC_MAC_DUPCTX                        2
 251 # define OSSL_FUNC_MAC_FREECTX                       3
 252 # define OSSL_FUNC_MAC_INIT                          4
 253 # define OSSL_FUNC_MAC_UPDATE                        5
 254 # define OSSL_FUNC_MAC_FINAL                         6
 255 # define OSSL_FUNC_MAC_GETTABLE_PARAMS               7
 256 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS           8
 257 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS           9
 258 # define OSSL_FUNC_MAC_GET_PARAMS                   10
 259 # define OSSL_FUNC_MAC_GET_CTX_PARAMS               11
 260 # define OSSL_FUNC_MAC_SET_CTX_PARAMS               12
 261
 262 OSSL_CORE_MAKE_FUNC(void *, OP_mac_newctx, (void *provctx))
 263 OSSL_CORE_MAKE_FUNC(void *, OP_mac_dupctx, (void *src))
 264 OSSL_CORE_MAKE_FUNC(void, OP_mac_freectx, (void *mctx))
 265 OSSL_CORE_MAKE_FUNC(size_t, OP_mac_size, (void *mctx))
 266 OSSL_CORE_MAKE_FUNC(int, OP_mac_init, (void *mctx))
 267 OSSL_CORE_MAKE_FUNC(int, OP_mac_update,
 268                     (void *mctx, const unsigned char *in, size_t inl))
 269 OSSL_CORE_MAKE_FUNC(int, OP_mac_final,
 270                     (void *mctx,
 271                      unsigned char *out, size_t *outl, size_t outsize))
 272 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_params, (void))
 273 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_ctx_params, (void))
 274 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_settable_ctx_params, (void))
 275 OSSL_CORE_MAKE_FUNC(int, OP_mac_get_params, (OSSL_PARAM params[]))
 276 OSSL_CORE_MAKE_FUNC(int, OP_mac_get_ctx_params,
 277                     (void *mctx, OSSL_PARAM params[]))
 278 OSSL_CORE_MAKE_FUNC(int, OP_mac_set_ctx_params,
 279                     (void *mctx, const OSSL_PARAM params[]))
 280
 281 /*-
 282  * Key management
 283  *
 284  * Key domain parameter references can be created in several manners:
 285  * - by importing the domain parameter material via an OSSL_PARAM array.
 286  * - by generating key domain parameters, given input via an OSSL_PARAM
 287  *   array.
 288  *
 289  * Key references can be created in several manners:
 290  * - by importing the key material via an OSSL_PARAM array.
 291  * - by generating a key, given optional domain parameters and
 292  *   additional keygen parameters.
 293  *   If domain parameters are given, they must have been generated using
 294  *   the domain parameter generator functions.
 295  *   If the domain parameters comes from a different provider, results
 296  *   are undefined.
 297  *   THE CALLER MUST ENSURE THAT CORRECT DOMAIN PARAMETERS ARE USED.
 298  * - by loading an internal key, given a binary blob that forms an identity.
 299  *   THE CALLER MUST ENSURE THAT A CORRECT IDENTITY IS USED.
 300  */
 301
 302 # define OSSL_OP_KEYMGMT                           10
 303
 304 /* Key domain parameter creation and destruction */
 305 # define OSSL_FUNC_KEYMGMT_IMPORTDOMPARAMS          1
 306 # define OSSL_FUNC_KEYMGMT_GENDOMPARAMS             2
 307 # define OSSL_FUNC_KEYMGMT_FREEDOMPARAMS            3
 308 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_importdomparams,
 309                     (void *provctx, const OSSL_PARAM params[]))
 310 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_gendomparams,
 311                     (void *provctx, const OSSL_PARAM params[]))
 312 OSSL_CORE_MAKE_FUNC(void, OP_keymgmt_freedomparams, (void *domparams))
 313
 314 /* Key domain parameter export */
 315 # define OSSL_FUNC_KEYMGMT_EXPORTDOMPARAMS          4
 316 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_exportdomparams,
 317                     (void *domparams, OSSL_PARAM params[]))
 318
 319 /* Key domain parameter discovery */
 320 # define OSSL_FUNC_KEYMGMT_IMPORTDOMPARAM_TYPES     5
 321 # define OSSL_FUNC_KEYMGMT_EXPORTDOMPARAM_TYPES     6
 322 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_importdomparam_types,
 323                     (void))
 324 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_exportdomparam_types,
 325                     (void))
 326
 327 /* Key creation and destruction */
 328 # define OSSL_FUNC_KEYMGMT_IMPORTKEY               10
 329 # define OSSL_FUNC_KEYMGMT_GENKEY                  11
 330 # define OSSL_FUNC_KEYMGMT_LOADKEY                 12
 331 # define OSSL_FUNC_KEYMGMT_FREEKEY                 13
 332 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_importkey,
 333                     (void *provctx, const OSSL_PARAM params[]))
 334 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_genkey,
 335                     (void *provctx,
 336                      void *domparams, const OSSL_PARAM genkeyparams[]))
 337 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_loadkey,
 338                     (void *provctx, void *id, size_t idlen))
 339 OSSL_CORE_MAKE_FUNC(void, OP_keymgmt_freekey, (void *key))
 340
 341 /* Key export */
 342 # define OSSL_FUNC_KEYMGMT_EXPORTKEY               14
 343 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_exportkey,
 344                     (void *key, OSSL_PARAM params[]))
 345
 346 /* Key discovery */
 347 # define OSSL_FUNC_KEYMGMT_IMPORTKEY_TYPES         15
 348 # define OSSL_FUNC_KEYMGMT_EXPORTKEY_TYPES         16
 349 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_importkey_types, (void))
 350 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_exportkey_types, (void))
 351
 352 /* Key Exchange */
 353
 354 # define OSSL_OP_KEYEXCH                              11
 355
 356 # define OSSL_FUNC_KEYEXCH_NEWCTX                      1
 357 # define OSSL_FUNC_KEYEXCH_INIT                        2
 358 # define OSSL_FUNC_KEYEXCH_DERIVE                      3
 359 # define OSSL_FUNC_KEYEXCH_SET_PEER                    4
 360 # define OSSL_FUNC_KEYEXCH_FREECTX                     5
 361 # define OSSL_FUNC_KEYEXCH_DUPCTX                      6
 362 # define OSSL_FUNC_KEYEXCH_SET_PARAMS                  7
 363
 364 OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_newctx, (void *provctx))
 365 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_init, (void *ctx, void *provkey))
 366 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_derive, (void *ctx,  unsigned char *secret,
 367                                              size_t *secretlen, size_t outlen))
 368 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_peer, (void *ctx, void *provkey))
 369 OSSL_CORE_MAKE_FUNC(void, OP_keyexch_freectx, (void *ctx))
 370 OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_dupctx, (void *ctx))
 371 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_params, (void *ctx,
 372                                                  const OSSL_PARAM params[]))
 373
 374 /* Highest known operation number */
 375 # define OSSL_OP__HIGHEST                            3
 376
 377 # ifdef __cplusplus
 378 }
 379 # endif
 380
 381 #endif