]>
Commit | Line | Data |
---|---|---|
4c2883a9 RL |
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 | ||
3593266d | 13 | # include <stdarg.h> |
4c2883a9 RL |
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 | ||
b60cba3c RS |
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 | */ | |
4c2883a9 RL |
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_GET_PARAM_TYPES 1 | |
61 | OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *, | |
62 | core_get_param_types,(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, | |
4e7991b4 | 65 | OSSL_PARAM params[])) |
da747958 MC |
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_PUT_ERROR 4 | |
6ebc2f56 RL |
70 | OSSL_CORE_MAKE_FUNC(void,core_put_error, |
71 | (const OSSL_PROVIDER *prov, | |
72 | uint32_t reason, const char *file, int line)) | |
da747958 | 73 | # define OSSL_FUNC_CORE_ADD_ERROR_VDATA 5 |
6ebc2f56 RL |
74 | OSSL_CORE_MAKE_FUNC(void,core_add_error_vdata,(const OSSL_PROVIDER *prov, |
75 | int num, va_list args)) | |
da747958 | 76 | # define OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT 6 |
e7706e63 RL |
77 | OSSL_CORE_MAKE_FUNC(OPENSSL_CTX *,core_get_library_context, |
78 | (const OSSL_PROVIDER *prov)) | |
3593266d | 79 | |
4c2883a9 | 80 | |
b60cba3c RS |
81 | /* Memory allocation, freeing, clearing. */ |
82 | #define OSSL_FUNC_CRYPTO_MALLOC 10 | |
83 | OSSL_CORE_MAKE_FUNC(void *, | |
84 | CRYPTO_malloc, (size_t num, const char *file, int line)) | |
85 | #define OSSL_FUNC_CRYPTO_ZALLOC 11 | |
86 | OSSL_CORE_MAKE_FUNC(void *, | |
87 | CRYPTO_zalloc, (size_t num, const char *file, int line)) | |
88 | #define OSSL_FUNC_CRYPTO_MEMDUP 12 | |
89 | OSSL_CORE_MAKE_FUNC(void *, | |
90 | CRYPTO_memdup, (const void *str, size_t siz, const char *file, int line)) | |
91 | #define OSSL_FUNC_CRYPTO_STRDUP 13 | |
92 | OSSL_CORE_MAKE_FUNC(char *, | |
93 | CRYPTO_strdup, (const char *str, const char *file, int line)) | |
94 | #define OSSL_FUNC_CRYPTO_STRNDUP 14 | |
95 | OSSL_CORE_MAKE_FUNC(char *, | |
96 | CRYPTO_strndup, (const char *str, size_t s, const char *file, int line)) | |
97 | #define OSSL_FUNC_CRYPTO_FREE 15 | |
98 | OSSL_CORE_MAKE_FUNC(void, | |
99 | CRYPTO_free, (void *ptr, const char *file, int line)) | |
100 | #define OSSL_FUNC_CRYPTO_CLEAR_FREE 16 | |
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 17 | |
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 18 | |
107 | OSSL_CORE_MAKE_FUNC(void *, | |
108 | CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num, const char *file, int line)) | |
109 | #define OSSL_FUNC_CRYPTO_SECURE_MALLOC 19 | |
110 | OSSL_CORE_MAKE_FUNC(void *, | |
111 | CRYPTO_secure_malloc, (size_t num, const char *file, int line)) | |
112 | #define OSSL_FUNC_CRYPTO_SECURE_ZALLOC 20 | |
113 | OSSL_CORE_MAKE_FUNC(void *, | |
114 | CRYPTO_secure_zalloc, (size_t num, const char *file, int line)) | |
115 | #define OSSL_FUNC_CRYPTO_SECURE_FREE 21 | |
116 | OSSL_CORE_MAKE_FUNC(void, | |
117 | CRYPTO_secure_free, (void *ptr, const char *file, int line)) | |
118 | #define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE 22 | |
119 | OSSL_CORE_MAKE_FUNC(void, | |
120 | CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file, int line)) | |
121 | #define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED 23 | |
122 | OSSL_CORE_MAKE_FUNC(int, | |
123 | CRYPTO_secure_allocated, (const void *ptr)) | |
124 | #define OSSL_FUNC_OPENSSL_CLEANSE 24 | |
125 | OSSL_CORE_MAKE_FUNC(void, | |
126 | OPENSSL_cleanse, (void *ptr, size_t len)) | |
127 | # define OSSL_FUNC_OPENSSL_HEXSTR2BUF 25 | |
128 | OSSL_CORE_MAKE_FUNC(unsigned char *, | |
129 | OPENSSL_hexstr2buf, (const char *str, long *len)) | |
130 | ||
4c2883a9 RL |
131 | /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */ |
132 | # define OSSL_FUNC_PROVIDER_TEARDOWN 1024 | |
a39eb840 | 133 | OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx)) |
4c2883a9 RL |
134 | # define OSSL_FUNC_PROVIDER_GET_PARAM_TYPES 1025 |
135 | OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *, | |
a39eb840 | 136 | provider_get_param_types,(void *provctx)) |
4c2883a9 | 137 | # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026 |
a39eb840 | 138 | OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx, |
4e7991b4 | 139 | OSSL_PARAM params[])) |
099bd339 RL |
140 | # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027 |
141 | OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation, | |
a39eb840 | 142 | (void *provctx, int operation_id, const int *no_store)) |
6ebc2f56 RL |
143 | # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028 |
144 | OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings, | |
145 | (void *provctx)) | |
4c2883a9 | 146 | |
3653d0c2 MC |
147 | /* Digests */ |
148 | ||
149 | # define OSSL_OP_DIGEST 1 | |
150 | ||
151 | # define OSSL_FUNC_DIGEST_NEWCTX 1 | |
152 | # define OSSL_FUNC_DIGEST_INIT 2 | |
df05f2ce | 153 | # define OSSL_FUNC_DIGEST_UPDATE 3 |
3653d0c2 MC |
154 | # define OSSL_FUNC_DIGEST_FINAL 4 |
155 | # define OSSL_FUNC_DIGEST_DIGEST 5 | |
156 | # define OSSL_FUNC_DIGEST_FREECTX 6 | |
8c8cf0d9 MC |
157 | # define OSSL_FUNC_DIGEST_DUPCTX 7 |
158 | # define OSSL_FUNC_DIGEST_SIZE 8 | |
7556b9df | 159 | # define OSSL_FUNC_DIGEST_BLOCK_SIZE 9 |
d5e5e2ff SL |
160 | # define OSSL_FUNC_DIGEST_SET_PARAMS 10 |
161 | # define OSSL_FUNC_DIGEST_GET_PARAMS 11 | |
df05f2ce | 162 | |
a39eb840 RL |
163 | OSSL_CORE_MAKE_FUNC(void *, OP_digest_newctx, (void *provctx)) |
164 | OSSL_CORE_MAKE_FUNC(int, OP_digest_init, (void *dctx)) | |
3653d0c2 | 165 | OSSL_CORE_MAKE_FUNC(int, OP_digest_update, |
a39eb840 | 166 | (void *dctx, const unsigned char *in, size_t inl)) |
3653d0c2 | 167 | OSSL_CORE_MAKE_FUNC(int, OP_digest_final, |
a39eb840 RL |
168 | (void *dctx, |
169 | unsigned char *out, size_t *outl, size_t outsz)) | |
3653d0c2 | 170 | OSSL_CORE_MAKE_FUNC(int, OP_digest_digest, |
a39eb840 RL |
171 | (void *provctx, const unsigned char *in, size_t inl, |
172 | unsigned char *out, size_t *out_l, size_t outsz)) | |
df05f2ce | 173 | |
a39eb840 RL |
174 | OSSL_CORE_MAKE_FUNC(void, OP_digest_cleanctx, (void *dctx)) |
175 | OSSL_CORE_MAKE_FUNC(void, OP_digest_freectx, (void *dctx)) | |
176 | OSSL_CORE_MAKE_FUNC(void *, OP_digest_dupctx, (void *dctx)) | |
d5e5e2ff | 177 | |
8c8cf0d9 | 178 | OSSL_CORE_MAKE_FUNC(size_t, OP_digest_size, (void)) |
7556b9df | 179 | OSSL_CORE_MAKE_FUNC(size_t, OP_digest_block_size, (void)) |
d5e5e2ff SL |
180 | OSSL_CORE_MAKE_FUNC(int, OP_digest_set_params, |
181 | (void *vctx, const OSSL_PARAM params[])) | |
182 | OSSL_CORE_MAKE_FUNC(int, OP_digest_get_params, | |
4e7991b4 | 183 | (void *vctx, OSSL_PARAM params[])) |
459b15d4 | 184 | OSSL_CORE_MAKE_FUNC(unsigned long, OP_cipher_get_flags, (void)) |
df05f2ce MC |
185 | |
186 | /* Symmetric Ciphers */ | |
187 | ||
188 | # define OSSL_OP_CIPHER 2 | |
189 | ||
190 | # define OSSL_FUNC_CIPHER_NEWCTX 1 | |
191 | # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2 | |
192 | # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3 | |
193 | # define OSSL_FUNC_CIPHER_UPDATE 4 | |
194 | # define OSSL_FUNC_CIPHER_FINAL 5 | |
718b133a MC |
195 | # define OSSL_FUNC_CIPHER_CIPHER 6 |
196 | # define OSSL_FUNC_CIPHER_FREECTX 7 | |
197 | # define OSSL_FUNC_CIPHER_DUPCTX 8 | |
80942379 RL |
198 | # define OSSL_FUNC_CIPHER_GET_PARAMS 9 |
199 | # define OSSL_FUNC_CIPHER_CTX_GET_PARAMS 10 | |
200 | # define OSSL_FUNC_CIPHER_CTX_SET_PARAMS 11 | |
df05f2ce | 201 | |
a39eb840 RL |
202 | OSSL_CORE_MAKE_FUNC(void *, OP_cipher_newctx, (void *provctx)) |
203 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_encrypt_init, (void *cctx, | |
df05f2ce | 204 | const unsigned char *key, |
344cfa34 MC |
205 | size_t keylen, |
206 | const unsigned char *iv, | |
207 | size_t ivlen)) | |
a39eb840 | 208 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_decrypt_init, (void *cctx, |
df05f2ce | 209 | const unsigned char *key, |
344cfa34 MC |
210 | size_t keylen, |
211 | const unsigned char *iv, | |
212 | size_t ivlen)) | |
df05f2ce | 213 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_update, |
a39eb840 RL |
214 | (void *cctx, |
215 | unsigned char *out, size_t *outl, size_t outsize, | |
df05f2ce MC |
216 | const unsigned char *in, size_t inl)) |
217 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_final, | |
a39eb840 RL |
218 | (void *cctx, |
219 | unsigned char *out, size_t *outl, size_t outsize)) | |
df05f2ce | 220 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_cipher, |
a39eb840 | 221 | (void *cctx, |
f79858ac RL |
222 | unsigned char *out, size_t *outl, size_t outsize, |
223 | const unsigned char *in, size_t inl)) | |
a39eb840 RL |
224 | OSSL_CORE_MAKE_FUNC(void, OP_cipher_freectx, (void *cctx)) |
225 | OSSL_CORE_MAKE_FUNC(void *, OP_cipher_dupctx, (void *cctx)) | |
4e7991b4 | 226 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_params, (OSSL_PARAM params[])) |
a39eb840 | 227 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_ctx_get_params, (void *cctx, |
4e7991b4 | 228 | OSSL_PARAM params[])) |
a39eb840 | 229 | OSSL_CORE_MAKE_FUNC(int, OP_cipher_ctx_set_params, (void *cctx, |
718b133a | 230 | const OSSL_PARAM params[])) |
df05f2ce | 231 | |
ff64702b MC |
232 | /* Key Exchange */ |
233 | ||
234 | # define OSSL_OP_KEYEXCH 3 | |
235 | ||
236 | # define OSSL_FUNC_KEYEXCH_NEWCTX 1 | |
237 | # define OSSL_FUNC_KEYEXCH_INIT 2 | |
238 | # define OSSL_FUNC_KEYEXCH_DERIVE 3 | |
239 | # define OSSL_FUNC_KEYEXCH_SET_PEER 4 | |
240 | # define OSSL_FUNC_KEYEXCH_FREECTX 5 | |
241 | # define OSSL_FUNC_KEYEXCH_DUPCTX 6 | |
242 | ||
243 | OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_newctx, (void *provctx)) | |
244 | OSSL_CORE_MAKE_FUNC(int, OP_keyexch_init, (void *ctx, | |
245 | OSSL_PARAM params[])) | |
246 | OSSL_CORE_MAKE_FUNC(int, OP_keyexch_derive, (void *ctx, unsigned char *key, | |
247 | size_t *keylen, size_t outlen)) | |
248 | OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_peer, (void *ctx, | |
249 | OSSL_PARAM params[])) | |
250 | OSSL_CORE_MAKE_FUNC(void, OP_keyexch_freectx, (void *ctx)) | |
251 | OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_dupctx, (void *ctx)) | |
252 | ||
4c2883a9 RL |
253 | # ifdef __cplusplus |
254 | } | |
255 | # endif | |
256 | ||
257 | #endif |