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 /* Helper macro to create the function signature typedef and the extractor */
  39 #define OSSL_CORE_MAKE_FUNC(type,name,args)                             \
  40     typedef type (OSSL_##name##_fn)args;                                \
  41     static ossl_inline \
  42     OSSL_##name##_fn *OSSL_get_##name(const OSSL_DISPATCH *opf)         \
  43     {                                                                   \
  44         return (OSSL_##name##_fn *)opf->function;                       \
  45     }
  46
  47 /*
  48  * Core function identities, for the two OSSL_DISPATCH tables being passed
  49  * in the OSSL_provider_init call.
  50  *
  51  * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must
  52  * therefore NEVER be used as a function identity.
  53  */
  54 /* Functions provided by the Core to the provider, reserved numbers 1-1023 */
  55 # define OSSL_FUNC_CORE_GET_PARAM_TYPES        1
  56 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,
  57                     core_get_param_types,(const OSSL_PROVIDER *prov))
  58 # define OSSL_FUNC_CORE_GET_PARAMS             2
  59 OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_PROVIDER *prov,
  60                                          const OSSL_PARAM params[]))
  61 # define OSSL_FUNC_CORE_PUT_ERROR              3
  62 OSSL_CORE_MAKE_FUNC(void,core_put_error,(int lib, int func, int reason,
  63                                          const char *file, int line))
  64 # define OSSL_FUNC_CORE_ADD_ERROR_VDATA        4
  65 OSSL_CORE_MAKE_FUNC(void,core_add_error_vdata,(int num, va_list args))
  66
  67
  68 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
  69 # define OSSL_FUNC_PROVIDER_TEARDOWN         1024
  70 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
  71 # define OSSL_FUNC_PROVIDER_GET_PARAM_TYPES  1025
  72 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,
  73                     provider_get_param_types,(void *provctx))
  74 # define OSSL_FUNC_PROVIDER_GET_PARAMS       1026
  75 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
  76                                              const OSSL_PARAM params[]))
  77 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION  1027
  78 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
  79                     (void *provctx, int operation_id, const int *no_store))
  80
  81 /* Digests */
  82
  83 # define OSSL_OP_DIGEST                     1
  84
  85 # define OSSL_FUNC_DIGEST_NEWCTX            1
  86 # define OSSL_FUNC_DIGEST_INIT              2
  87 # define OSSL_FUNC_DIGEST_UPDATE            3
  88 # define OSSL_FUNC_DIGEST_FINAL             4
  89 # define OSSL_FUNC_DIGEST_DIGEST            5
  90 # define OSSL_FUNC_DIGEST_FREECTX           6
  91 # define OSSL_FUNC_DIGEST_DUPCTX            7
  92 # define OSSL_FUNC_DIGEST_SIZE              8
  93 # define OSSL_FUNC_DIGEST_BLOCK_SIZE        9
  94 # define OSSL_FUNC_DIGEST_SET_PARAMS        10
  95 # define OSSL_FUNC_DIGEST_GET_PARAMS        11
  96
  97 OSSL_CORE_MAKE_FUNC(void *, OP_digest_newctx, (void *provctx))
  98 OSSL_CORE_MAKE_FUNC(int, OP_digest_init, (void *dctx))
  99 OSSL_CORE_MAKE_FUNC(int, OP_digest_update,
 100                     (void *dctx, const unsigned char *in, size_t inl))
 101 OSSL_CORE_MAKE_FUNC(int, OP_digest_final,
 102                     (void *dctx,
 103                      unsigned char *out, size_t *outl, size_t outsz))
 104 OSSL_CORE_MAKE_FUNC(int, OP_digest_digest,
 105                     (void *provctx, const unsigned char *in, size_t inl,
 106                      unsigned char *out, size_t *out_l, size_t outsz))
 107
 108 OSSL_CORE_MAKE_FUNC(void, OP_digest_cleanctx, (void *dctx))
 109 OSSL_CORE_MAKE_FUNC(void, OP_digest_freectx, (void *dctx))
 110 OSSL_CORE_MAKE_FUNC(void *, OP_digest_dupctx, (void *dctx))
 111
 112 OSSL_CORE_MAKE_FUNC(size_t, OP_digest_size, (void))
 113 OSSL_CORE_MAKE_FUNC(size_t, OP_digest_block_size, (void))
 114 OSSL_CORE_MAKE_FUNC(int, OP_digest_set_params,
 115                     (void *vctx, const OSSL_PARAM params[]))
 116 OSSL_CORE_MAKE_FUNC(int, OP_digest_get_params,
 117                     (void *vctx, const OSSL_PARAM params[]))
 118
 119 /* Symmetric Ciphers */
 120
 121 # define OSSL_OP_CIPHER                              2
 122
 123 # define OSSL_FUNC_CIPHER_NEWCTX                     1
 124 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT               2
 125 # define OSSL_FUNC_CIPHER_DECRYPT_INIT               3
 126 # define OSSL_FUNC_CIPHER_UPDATE                     4
 127 # define OSSL_FUNC_CIPHER_FINAL                      5
 128 # define OSSL_FUNC_CIPHER_CIPHER                     6
 129 # define OSSL_FUNC_CIPHER_FREECTX                    7
 130 # define OSSL_FUNC_CIPHER_DUPCTX                     8
 131 # define OSSL_FUNC_CIPHER_KEY_LENGTH                 9
 132 # define OSSL_FUNC_CIPHER_IV_LENGTH                 10
 133 # define OSSL_FUNC_CIPHER_BLOCK_SIZE                11
 134 # define OSSL_FUNC_CIPHER_GET_PARAMS                12
 135 # define OSSL_FUNC_CIPHER_CTX_GET_PARAMS            13
 136 # define OSSL_FUNC_CIPHER_CTX_SET_PARAMS            14
 137
 138 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_newctx, (void *provctx))
 139 OSSL_CORE_MAKE_FUNC(int, OP_cipher_encrypt_init, (void *cctx,
 140                                                   const unsigned char *key,
 141                                                   size_t keylen,
 142                                                   const unsigned char *iv,
 143                                                   size_t ivlen))
 144 OSSL_CORE_MAKE_FUNC(int, OP_cipher_decrypt_init, (void *cctx,
 145                                                   const unsigned char *key,
 146                                                   size_t keylen,
 147                                                   const unsigned char *iv,
 148                                                   size_t ivlen))
 149 OSSL_CORE_MAKE_FUNC(int, OP_cipher_update,
 150                     (void *cctx,
 151                      unsigned char *out, size_t *outl, size_t outsize,
 152                      const unsigned char *in, size_t inl))
 153 OSSL_CORE_MAKE_FUNC(int, OP_cipher_final,
 154                     (void *cctx,
 155                      unsigned char *out, size_t *outl, size_t outsize))
 156 OSSL_CORE_MAKE_FUNC(int, OP_cipher_cipher,
 157                     (void *cctx,
 158                      unsigned char *out, size_t *outl, size_t outsize,
 159                      const unsigned char *in, size_t inl))
 160 OSSL_CORE_MAKE_FUNC(void, OP_cipher_freectx, (void *cctx))
 161 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_dupctx, (void *cctx))
 162 OSSL_CORE_MAKE_FUNC(size_t, OP_cipher_key_length, (void))
 163 OSSL_CORE_MAKE_FUNC(size_t, OP_cipher_iv_length, (void))
 164 OSSL_CORE_MAKE_FUNC(size_t, OP_cipher_block_size, (void))
 165 OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_params, (const OSSL_PARAM params[]))
 166 OSSL_CORE_MAKE_FUNC(int, OP_cipher_ctx_get_params, (void *cctx,
 167                                                     const OSSL_PARAM params[]))
 168 OSSL_CORE_MAKE_FUNC(int, OP_cipher_ctx_set_params, (void *cctx,
 169                                                     const OSSL_PARAM params[]))
 170
 171 # ifdef __cplusplus
 172 }
 173 # endif
 174
 175 #endif