2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
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
10 #ifndef OPENSSL_CORE_NUMBERS_H
11 # define OPENSSL_CORE_NUMBERS_H
15 # include <openssl/core.h>
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.
31 * for any function base name 'foo' (uppercase form 'FOO'), we will have
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_FUNC_'foo'_fn
36 * - a function pointer extractor function with the name OSSL_FUNC_'foo'
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 * Note: This is considered a "reserved" internal macro. Applications should
45 * not use this or assume its existence.
47 #define OSSL_CORE_MAKE_FUNC(type,name,args) \
48 typedef type (OSSL_FUNC_##name##_fn)args; \
49 static ossl_unused ossl_inline \
50 OSSL_FUNC_##name##_fn *OSSL_FUNC_##name(const OSSL_DISPATCH *opf) \
52 return (OSSL_FUNC_##name##_fn *)opf->function; \
56 * Core function identities, for the two OSSL_DISPATCH tables being passed
57 * in the OSSL_provider_init call.
59 * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must
60 * therefore NEVER be used as a function identity.
62 /* Functions provided by the Core to the provider, reserved numbers 1-1023 */
63 # define OSSL_FUNC_CORE_GETTABLE_PARAMS 1
64 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
65 core_gettable_params,(const OSSL_CORE_HANDLE *prov))
66 # define OSSL_FUNC_CORE_GET_PARAMS 2
67 OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_CORE_HANDLE *prov,
69 # define OSSL_FUNC_CORE_THREAD_START 3
70 OSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_CORE_HANDLE *prov,
71 OSSL_thread_stop_handler_fn handfn))
72 # define OSSL_FUNC_CORE_GET_LIBCTX 4
73 OSSL_CORE_MAKE_FUNC(OPENSSL_CORE_CTX *,core_get_libctx,
74 (const OSSL_CORE_HANDLE *prov))
75 # define OSSL_FUNC_CORE_NEW_ERROR 5
76 OSSL_CORE_MAKE_FUNC(void,core_new_error,(const OSSL_CORE_HANDLE *prov))
77 # define OSSL_FUNC_CORE_SET_ERROR_DEBUG 6
78 OSSL_CORE_MAKE_FUNC(void,core_set_error_debug,
79 (const OSSL_CORE_HANDLE *prov,
80 const char *file, int line, const char *func))
81 # define OSSL_FUNC_CORE_VSET_ERROR 7
82 OSSL_CORE_MAKE_FUNC(void,core_vset_error,
83 (const OSSL_CORE_HANDLE *prov,
84 uint32_t reason, const char *fmt, va_list args))
85 # define OSSL_FUNC_CORE_SET_ERROR_MARK 8
86 OSSL_CORE_MAKE_FUNC(int, core_set_error_mark, (const OSSL_CORE_HANDLE *prov))
87 # define OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK 9
88 OSSL_CORE_MAKE_FUNC(int, core_clear_last_error_mark,
89 (const OSSL_CORE_HANDLE *prov))
90 # define OSSL_FUNC_CORE_POP_ERROR_TO_MARK 10
91 OSSL_CORE_MAKE_FUNC(int, core_pop_error_to_mark, (const OSSL_CORE_HANDLE *prov))
93 /* Memory allocation, freeing, clearing. */
94 #define OSSL_FUNC_CRYPTO_MALLOC 20
95 OSSL_CORE_MAKE_FUNC(void *,
96 CRYPTO_malloc, (size_t num, const char *file, int line))
97 #define OSSL_FUNC_CRYPTO_ZALLOC 21
98 OSSL_CORE_MAKE_FUNC(void *,
99 CRYPTO_zalloc, (size_t num, const char *file, int line))
100 #define OSSL_FUNC_CRYPTO_FREE 22
101 OSSL_CORE_MAKE_FUNC(void,
102 CRYPTO_free, (void *ptr, const char *file, int line))
103 #define OSSL_FUNC_CRYPTO_CLEAR_FREE 23
104 OSSL_CORE_MAKE_FUNC(void,
105 CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line))
106 #define OSSL_FUNC_CRYPTO_REALLOC 24
107 OSSL_CORE_MAKE_FUNC(void *,
108 CRYPTO_realloc, (void *addr, size_t num, const char *file, int line))
109 #define OSSL_FUNC_CRYPTO_CLEAR_REALLOC 25
110 OSSL_CORE_MAKE_FUNC(void *,
111 CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num,
112 const char *file, int line))
113 #define OSSL_FUNC_CRYPTO_SECURE_MALLOC 26
114 OSSL_CORE_MAKE_FUNC(void *,
115 CRYPTO_secure_malloc, (size_t num, const char *file, int line))
116 #define OSSL_FUNC_CRYPTO_SECURE_ZALLOC 27
117 OSSL_CORE_MAKE_FUNC(void *,
118 CRYPTO_secure_zalloc, (size_t num, const char *file, int line))
119 #define OSSL_FUNC_CRYPTO_SECURE_FREE 28
120 OSSL_CORE_MAKE_FUNC(void,
121 CRYPTO_secure_free, (void *ptr, const char *file, int line))
122 #define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE 29
123 OSSL_CORE_MAKE_FUNC(void,
124 CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file,
126 #define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED 30
127 OSSL_CORE_MAKE_FUNC(int,
128 CRYPTO_secure_allocated, (const void *ptr))
129 #define OSSL_FUNC_OPENSSL_CLEANSE 31
130 OSSL_CORE_MAKE_FUNC(void,
131 OPENSSL_cleanse, (void *ptr, size_t len))
133 /* Bio functions provided by the core */
134 #define OSSL_FUNC_BIO_NEW_FILE 40
135 #define OSSL_FUNC_BIO_NEW_MEMBUF 41
136 #define OSSL_FUNC_BIO_READ_EX 42
137 #define OSSL_FUNC_BIO_WRITE_EX 43
138 #define OSSL_FUNC_BIO_FREE 44
139 #define OSSL_FUNC_BIO_VPRINTF 45
140 #define OSSL_FUNC_BIO_VSNPRINTF 46
141 #define OSSL_FUNC_BIO_PUTS 47
142 #define OSSL_FUNC_BIO_GETS 48
143 #define OSSL_FUNC_BIO_CTRL 49
146 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename,
148 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len))
149 OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data,
150 size_t data_len, size_t *bytes_read))
151 OSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data,
152 size_t data_len, size_t *written))
153 OSSL_CORE_MAKE_FUNC(int, BIO_gets, (OSSL_CORE_BIO *bio, char *buf, int size))
154 OSSL_CORE_MAKE_FUNC(int, BIO_puts, (OSSL_CORE_BIO *bio, const char *str))
155 OSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio))
156 OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format,
158 OSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf,
159 (char *buf, size_t n, const char *fmt, va_list args))
160 OSSL_CORE_MAKE_FUNC(int, BIO_ctrl, (OSSL_CORE_BIO *bio,
161 int cmd, long num, void *ptr))
163 #define OSSL_FUNC_SELF_TEST_CB 100
164 OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb,
167 /* Functions to get seed material from the operating system */
168 #define OSSL_FUNC_GET_ENTROPY 101
169 #define OSSL_FUNC_CLEANUP_ENTROPY 102
170 #define OSSL_FUNC_GET_NONCE 103
171 #define OSSL_FUNC_CLEANUP_NONCE 104
172 OSSL_CORE_MAKE_FUNC(size_t, get_entropy, (const OSSL_CORE_HANDLE *handle,
173 unsigned char **pout, int entropy,
174 size_t min_len, size_t max_len))
175 OSSL_CORE_MAKE_FUNC(void, cleanup_entropy, (const OSSL_CORE_HANDLE *handle,
176 unsigned char *buf, size_t len))
177 OSSL_CORE_MAKE_FUNC(size_t, get_nonce, (const OSSL_CORE_HANDLE *handle,
178 unsigned char **pout, size_t min_len,
179 size_t max_len, const void *salt,
181 OSSL_CORE_MAKE_FUNC(void, cleanup_nonce, (const OSSL_CORE_HANDLE *handle,
182 unsigned char *buf, size_t len))
184 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
185 # define OSSL_FUNC_PROVIDER_TEARDOWN 1024
186 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
187 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025
188 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
189 provider_gettable_params,(void *provctx))
190 # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026
191 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
192 OSSL_PARAM params[]))
193 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027
194 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
195 (void *provctx, int operation_id, int *no_store))
196 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
197 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
199 # define OSSL_FUNC_PROVIDER_GET_CAPABILITIES 1029
200 OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx,
201 const char *capability, OSSL_CALLBACK *cb, void *arg))
202 # define OSSL_FUNC_PROVIDER_SELF_TEST 1030
203 OSSL_CORE_MAKE_FUNC(int, provider_self_test, (void *provctx))
207 # define OSSL_OP_DIGEST 1
208 # define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */
209 # define OSSL_OP_MAC 3
210 # define OSSL_OP_KDF 4
211 # define OSSL_OP_RAND 5
212 # define OSSL_OP_KEYMGMT 10
213 # define OSSL_OP_KEYEXCH 11
214 # define OSSL_OP_SIGNATURE 12
215 # define OSSL_OP_ASYM_CIPHER 13
216 # define OSSL_OP_KEM 14
217 /* New section for non-EVP operations */
218 # define OSSL_OP_ENCODER 20
219 # define OSSL_OP_DECODER 21
220 # define OSSL_OP_STORE 22
221 /* Highest known operation number */
222 # define OSSL_OP__HIGHEST 22
226 # define OSSL_FUNC_DIGEST_NEWCTX 1
227 # define OSSL_FUNC_DIGEST_INIT 2
228 # define OSSL_FUNC_DIGEST_UPDATE 3
229 # define OSSL_FUNC_DIGEST_FINAL 4
230 # define OSSL_FUNC_DIGEST_DIGEST 5
231 # define OSSL_FUNC_DIGEST_FREECTX 6
232 # define OSSL_FUNC_DIGEST_DUPCTX 7
233 # define OSSL_FUNC_DIGEST_GET_PARAMS 8
234 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9
235 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10
236 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11
237 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12
238 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13
240 OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx))
241 OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx))
242 OSSL_CORE_MAKE_FUNC(int, digest_update,
243 (void *dctx, const unsigned char *in, size_t inl))
244 OSSL_CORE_MAKE_FUNC(int, digest_final,
246 unsigned char *out, size_t *outl, size_t outsz))
247 OSSL_CORE_MAKE_FUNC(int, digest_digest,
248 (void *provctx, const unsigned char *in, size_t inl,
249 unsigned char *out, size_t *outl, size_t outsz))
251 OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx))
252 OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx))
254 OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[]))
255 OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params,
256 (void *vctx, const OSSL_PARAM params[]))
257 OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params,
258 (void *vctx, OSSL_PARAM params[]))
259 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params,
261 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params,
263 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params,
266 /* Symmetric Ciphers */
268 # define OSSL_FUNC_CIPHER_NEWCTX 1
269 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2
270 # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3
271 # define OSSL_FUNC_CIPHER_UPDATE 4
272 # define OSSL_FUNC_CIPHER_FINAL 5
273 # define OSSL_FUNC_CIPHER_CIPHER 6
274 # define OSSL_FUNC_CIPHER_FREECTX 7
275 # define OSSL_FUNC_CIPHER_DUPCTX 8
276 # define OSSL_FUNC_CIPHER_GET_PARAMS 9
277 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10
278 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11
279 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12
280 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13
281 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14
283 OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx))
284 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx,
285 const unsigned char *key,
287 const unsigned char *iv,
289 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx,
290 const unsigned char *key,
292 const unsigned char *iv,
294 OSSL_CORE_MAKE_FUNC(int, cipher_update,
296 unsigned char *out, size_t *outl, size_t outsize,
297 const unsigned char *in, size_t inl))
298 OSSL_CORE_MAKE_FUNC(int, cipher_final,
300 unsigned char *out, size_t *outl, size_t outsize))
301 OSSL_CORE_MAKE_FUNC(int, cipher_cipher,
303 unsigned char *out, size_t *outl, size_t outsize,
304 const unsigned char *in, size_t inl))
305 OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx))
306 OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx))
307 OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[]))
308 OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx,
309 OSSL_PARAM params[]))
310 OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx,
311 const OSSL_PARAM params[]))
312 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params,
314 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params,
316 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params,
321 # define OSSL_FUNC_MAC_NEWCTX 1
322 # define OSSL_FUNC_MAC_DUPCTX 2
323 # define OSSL_FUNC_MAC_FREECTX 3
324 # define OSSL_FUNC_MAC_INIT 4
325 # define OSSL_FUNC_MAC_UPDATE 5
326 # define OSSL_FUNC_MAC_FINAL 6
327 # define OSSL_FUNC_MAC_GET_PARAMS 7
328 # define OSSL_FUNC_MAC_GET_CTX_PARAMS 8
329 # define OSSL_FUNC_MAC_SET_CTX_PARAMS 9
330 # define OSSL_FUNC_MAC_GETTABLE_PARAMS 10
331 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11
332 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12
334 OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx))
335 OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src))
336 OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx))
337 OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx))
338 OSSL_CORE_MAKE_FUNC(int, mac_update,
339 (void *mctx, const unsigned char *in, size_t inl))
340 OSSL_CORE_MAKE_FUNC(int, mac_final,
342 unsigned char *out, size_t *outl, size_t outsize))
343 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx))
344 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params,
346 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params,
348 OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[]))
349 OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params,
350 (void *mctx, OSSL_PARAM params[]))
351 OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params,
352 (void *mctx, const OSSL_PARAM params[]))
356 # define OSSL_FUNC_KDF_NEWCTX 1
357 # define OSSL_FUNC_KDF_DUPCTX 2
358 # define OSSL_FUNC_KDF_FREECTX 3
359 # define OSSL_FUNC_KDF_RESET 4
360 # define OSSL_FUNC_KDF_DERIVE 5
361 # define OSSL_FUNC_KDF_GETTABLE_PARAMS 6
362 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7
363 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8
364 # define OSSL_FUNC_KDF_GET_PARAMS 9
365 # define OSSL_FUNC_KDF_GET_CTX_PARAMS 10
366 # define OSSL_FUNC_KDF_SET_CTX_PARAMS 11
368 OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx))
369 OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src))
370 OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx))
371 OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx))
372 OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key,
374 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx))
375 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params,
377 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params,
379 OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[]))
380 OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params,
381 (void *kctx, OSSL_PARAM params[]))
382 OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params,
383 (void *kctx, const OSSL_PARAM params[]))
387 # define OSSL_FUNC_RAND_NEWCTX 1
388 # define OSSL_FUNC_RAND_FREECTX 2
389 # define OSSL_FUNC_RAND_INSTANTIATE 3
390 # define OSSL_FUNC_RAND_UNINSTANTIATE 4
391 # define OSSL_FUNC_RAND_GENERATE 5
392 # define OSSL_FUNC_RAND_RESEED 6
393 # define OSSL_FUNC_RAND_NONCE 7
394 # define OSSL_FUNC_RAND_ENABLE_LOCKING 8
395 # define OSSL_FUNC_RAND_LOCK 9
396 # define OSSL_FUNC_RAND_UNLOCK 10
397 # define OSSL_FUNC_RAND_GETTABLE_PARAMS 11
398 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS 12
399 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS 13
400 # define OSSL_FUNC_RAND_GET_PARAMS 14
401 # define OSSL_FUNC_RAND_GET_CTX_PARAMS 15
402 # define OSSL_FUNC_RAND_SET_CTX_PARAMS 16
403 # define OSSL_FUNC_RAND_VERIFY_ZEROIZATION 17
404 # define OSSL_FUNC_RAND_GET_SEED 18
405 # define OSSL_FUNC_RAND_CLEAR_SEED 19
407 OSSL_CORE_MAKE_FUNC(void *,rand_newctx,
408 (void *provctx, void *parent,
409 const OSSL_DISPATCH *parent_calls))
410 OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx))
411 OSSL_CORE_MAKE_FUNC(int,rand_instantiate,
412 (void *vdrbg, unsigned int strength,
413 int prediction_resistance,
414 const unsigned char *pstr, size_t pstr_len))
415 OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg))
416 OSSL_CORE_MAKE_FUNC(int,rand_generate,
417 (void *vctx, unsigned char *out, size_t outlen,
418 unsigned int strength, int prediction_resistance,
419 const unsigned char *addin, size_t addin_len))
420 OSSL_CORE_MAKE_FUNC(int,rand_reseed,
421 (void *vctx, int prediction_resistance,
422 const unsigned char *ent, size_t ent_len,
423 const unsigned char *addin, size_t addin_len))
424 OSSL_CORE_MAKE_FUNC(size_t,rand_nonce,
425 (void *vctx, unsigned char *out, unsigned int strength,
426 size_t min_noncelen, size_t max_noncelen))
427 OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx))
428 OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx))
429 OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx))
430 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx))
431 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params,
433 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params,
435 OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[]))
436 OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params,
437 (void *vctx, OSSL_PARAM params[]))
438 OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params,
439 (void *vctx, const OSSL_PARAM params[]))
440 OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks,
441 (void *vctx, OSSL_INOUT_CALLBACK *get_entropy,
442 OSSL_CALLBACK *cleanup_entropy,
443 OSSL_INOUT_CALLBACK *get_nonce,
444 OSSL_CALLBACK *cleanup_nonce, void *arg))
445 OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization,
447 OSSL_CORE_MAKE_FUNC(size_t,rand_get_seed,
448 (void *vctx, unsigned char **buffer,
449 int entropy, size_t min_len, size_t max_len,
450 int prediction_resistance,
451 const unsigned char *adin, size_t adin_len))
452 OSSL_CORE_MAKE_FUNC(void,rand_clear_seed,
453 (void *vctx, unsigned char *buffer, size_t b_len))
458 * The Key Management takes care of provider side key objects, and includes
459 * all current functionality to create them, destroy them, set parameters
460 * and key material, etc, essentially everything that manipulates the keys
461 * themselves and their parameters.
463 * The key objects are commonly refered to as |keydata|, and it MUST be able
464 * to contain parameters if the key has any, the public key and the private
465 * key. All parts are optional, but their presence determines what can be
466 * done with the key object in terms of encryption, signature, and so on.
467 * The assumption from libcrypto is that the key object contains any of the
468 * following data combinations:
472 * - public key + private key
473 * - parameters + public key
474 * - parameters + public key + private key
476 * What "parameters", "public key" and "private key" means in detail is left
477 * to the implementation. In the case of DH and DSA, they would typically
478 * include domain parameters, while for certain variants of RSA, they would
479 * typically include PSS or OAEP parameters.
481 * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with
482 * OSSL_FUNC_keymgmt_free(). Key objects can have data filled in with
483 * OSSL_FUNC_keymgmt_import().
485 * Three functions are made available to check what selection of data is
486 * present in a key object: OSSL_FUNC_keymgmt_has_parameters(),
487 * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(),
490 /* Key data subset selection - individual bits */
491 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01
492 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02
493 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04
494 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80
496 /* Key data subset selection - combinations */
497 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \
498 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \
499 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
500 # define OSSL_KEYMGMT_SELECT_KEYPAIR \
501 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
502 # define OSSL_KEYMGMT_SELECT_ALL \
503 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
505 # define OSSL_KEYMGMT_VALIDATE_FULL_CHECK 0
506 # define OSSL_KEYMGMT_VALIDATE_QUICK_CHECK 1
508 /* Basic key object creation */
509 # define OSSL_FUNC_KEYMGMT_NEW 1
510 OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx))
512 /* Generation, a more complex constructor */
513 # define OSSL_FUNC_KEYMGMT_GEN_INIT 2
514 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE 3
515 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS 4
516 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS 5
517 # define OSSL_FUNC_KEYMGMT_GEN 6
518 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP 7
519 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init,
520 (void *provctx, int selection))
521 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template,
522 (void *genctx, void *templ))
523 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params,
524 (void *genctx, const OSSL_PARAM params[]))
525 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
526 keymgmt_gen_settable_params, (void *provctx))
527 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_get_params,
528 (void *genctx, OSSL_PARAM params[]))
529 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
530 keymgmt_gen_gettable_params, (void *provctx))
531 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen,
532 (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
533 OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx))
535 /* Key loading by object reference */
536 # define OSSL_FUNC_KEYMGMT_LOAD 8
537 OSSL_CORE_MAKE_FUNC(void *, keymgmt_load,
538 (const void *reference, size_t reference_sz))
540 /* Basic key object destruction */
541 # define OSSL_FUNC_KEYMGMT_FREE 10
542 OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata))
544 /* Key object information, with discovery */
545 #define OSSL_FUNC_KEYMGMT_GET_PARAMS 11
546 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 12
547 OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params,
548 (void *keydata, OSSL_PARAM params[]))
549 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params, (void *))
551 #define OSSL_FUNC_KEYMGMT_SET_PARAMS 13
552 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 14
553 OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params,
554 (void *keydata, const OSSL_PARAM params[]))
555 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params, (void *))
557 /* Key checks - discovery of supported operations */
558 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20
559 OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name,
562 /* Key checks - key data content checks */
563 # define OSSL_FUNC_KEYMGMT_HAS 21
564 OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (const void *keydata, int selection))
566 /* Key checks - validation */
567 # define OSSL_FUNC_KEYMGMT_VALIDATE 22
568 OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (const void *keydata, int selection,
571 /* Key checks - matching */
572 # define OSSL_FUNC_KEYMGMT_MATCH 23
573 OSSL_CORE_MAKE_FUNC(int, keymgmt_match,
574 (const void *keydata1, const void *keydata2,
577 /* Import and export functions, with discovery */
578 # define OSSL_FUNC_KEYMGMT_IMPORT 40
579 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41
580 # define OSSL_FUNC_KEYMGMT_EXPORT 42
581 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43
582 OSSL_CORE_MAKE_FUNC(int, keymgmt_import,
583 (void *keydata, int selection, const OSSL_PARAM params[]))
584 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types,
586 OSSL_CORE_MAKE_FUNC(int, keymgmt_export,
587 (void *keydata, int selection,
588 OSSL_CALLBACK *param_cb, void *cbarg))
589 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types,
592 /* Copy function, only works for matching keymgmt */
593 # define OSSL_FUNC_KEYMGMT_COPY 44
594 OSSL_CORE_MAKE_FUNC(int, keymgmt_copy,
595 ( void *keydata_to, const void *keydata_from,
600 # define OSSL_FUNC_KEYEXCH_NEWCTX 1
601 # define OSSL_FUNC_KEYEXCH_INIT 2
602 # define OSSL_FUNC_KEYEXCH_DERIVE 3
603 # define OSSL_FUNC_KEYEXCH_SET_PEER 4
604 # define OSSL_FUNC_KEYEXCH_FREECTX 5
605 # define OSSL_FUNC_KEYEXCH_DUPCTX 6
606 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7
607 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8
608 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9
609 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10
611 OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx))
612 OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey))
613 OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx, unsigned char *secret,
614 size_t *secretlen, size_t outlen))
615 OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey))
616 OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx))
617 OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx))
618 OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx,
619 const OSSL_PARAM params[]))
620 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params,
622 OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx,
623 OSSL_PARAM params[]))
624 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params,
629 # define OSSL_FUNC_SIGNATURE_NEWCTX 1
630 # define OSSL_FUNC_SIGNATURE_SIGN_INIT 2
631 # define OSSL_FUNC_SIGNATURE_SIGN 3
632 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4
633 # define OSSL_FUNC_SIGNATURE_VERIFY 5
634 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6
635 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7
636 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8
637 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9
638 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10
639 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11
640 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12
641 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13
642 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14
643 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15
644 # define OSSL_FUNC_SIGNATURE_FREECTX 16
645 # define OSSL_FUNC_SIGNATURE_DUPCTX 17
646 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18
647 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19
648 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20
649 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21
650 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22
651 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
652 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24
653 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
655 OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx,
657 OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey))
658 OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx, unsigned char *sig,
659 size_t *siglen, size_t sigsize,
660 const unsigned char *tbs,
662 OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey))
663 OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx,
664 const unsigned char *sig,
666 const unsigned char *tbs,
668 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init, (void *ctx,
670 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover, (void *ctx,
674 const unsigned char *sig,
676 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init,
677 (void *ctx, const char *mdname, void *provkey))
678 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update,
679 (void *ctx, const unsigned char *data, size_t datalen))
680 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final,
681 (void *ctx, unsigned char *sig, size_t *siglen,
683 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign,
684 (void *ctx, unsigned char *sigret, size_t *siglen,
685 size_t sigsize, const unsigned char *tbs, size_t tbslen))
686 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init,
687 (void *ctx, const char *mdname, void *provkey))
688 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update,
689 (void *ctx, const unsigned char *data, size_t datalen))
690 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final,
691 (void *ctx, const unsigned char *sig, size_t siglen))
692 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify,
693 (void *ctx, const unsigned char *sig, size_t siglen,
694 const unsigned char *tbs, size_t tbslen))
695 OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx))
696 OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx))
697 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params,
698 (void *ctx, OSSL_PARAM params[]))
699 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params,
701 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params,
702 (void *ctx, const OSSL_PARAM params[]))
703 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params,
705 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params,
706 (void *ctx, OSSL_PARAM params[]))
707 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params,
709 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params,
710 (void *ctx, const OSSL_PARAM params[]))
711 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params,
715 /* Asymmetric Ciphers */
717 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1
718 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2
719 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3
720 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4
721 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5
722 # define OSSL_FUNC_ASYM_CIPHER_FREECTX 6
723 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7
724 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8
725 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9
726 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10
727 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11
729 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx))
730 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey))
731 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out,
734 const unsigned char *in,
736 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey))
737 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out,
740 const unsigned char *in,
742 OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx))
743 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx))
744 OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params,
745 (void *ctx, OSSL_PARAM params[]))
746 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params,
748 OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params,
749 (void *ctx, const OSSL_PARAM params[]))
750 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params,
753 /* Asymmetric Key encapsulation */
754 # define OSSL_FUNC_KEM_NEWCTX 1
755 # define OSSL_FUNC_KEM_ENCAPSULATE_INIT 2
756 # define OSSL_FUNC_KEM_ENCAPSULATE 3
757 # define OSSL_FUNC_KEM_DECAPSULATE_INIT 4
758 # define OSSL_FUNC_KEM_DECAPSULATE 5
759 # define OSSL_FUNC_KEM_FREECTX 6
760 # define OSSL_FUNC_KEM_DUPCTX 7
761 # define OSSL_FUNC_KEM_GET_CTX_PARAMS 8
762 # define OSSL_FUNC_KEM_GETTABLE_CTX_PARAMS 9
763 # define OSSL_FUNC_KEM_SET_CTX_PARAMS 10
764 # define OSSL_FUNC_KEM_SETTABLE_CTX_PARAMS 11
766 OSSL_CORE_MAKE_FUNC(void *, kem_newctx, (void *provctx))
767 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate_init, (void *ctx, void *provkey))
768 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate, (void *ctx,
769 unsigned char *out, size_t *outlen,
770 unsigned char *secret,
772 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate_init, (void *ctx, void *provkey))
773 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate, (void *ctx,
774 unsigned char *out, size_t *outlen,
775 const unsigned char *in, size_t inlen))
776 OSSL_CORE_MAKE_FUNC(void, kem_freectx, (void *ctx))
777 OSSL_CORE_MAKE_FUNC(void *, kem_dupctx, (void *ctx))
778 OSSL_CORE_MAKE_FUNC(int, kem_get_ctx_params, (void *ctx, OSSL_PARAM params[]))
779 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_gettable_ctx_params, (void *provctx))
780 OSSL_CORE_MAKE_FUNC(int, kem_set_ctx_params,
781 (void *ctx, const OSSL_PARAM params[]))
782 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_settable_ctx_params, (void *provctx))
784 /* Encoders and decoders */
785 # define OSSL_FUNC_ENCODER_NEWCTX 1
786 # define OSSL_FUNC_ENCODER_FREECTX 2
787 # define OSSL_FUNC_ENCODER_GET_PARAMS 3
788 # define OSSL_FUNC_ENCODER_GETTABLE_PARAMS 4
789 # define OSSL_FUNC_ENCODER_SET_CTX_PARAMS 5
790 # define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS 6
791 # define OSSL_FUNC_ENCODER_DOES_SELECTION 10
792 # define OSSL_FUNC_ENCODER_ENCODE 11
793 # define OSSL_FUNC_ENCODER_IMPORT_OBJECT 20
794 # define OSSL_FUNC_ENCODER_FREE_OBJECT 21
795 OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx))
796 OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx))
797 OSSL_CORE_MAKE_FUNC(int, encoder_get_params, (OSSL_PARAM params[]))
798 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_gettable_params,
800 OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params,
801 (void *ctx, const OSSL_PARAM params[]))
802 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params,
805 OSSL_CORE_MAKE_FUNC(int, encoder_does_selection,
806 (void *provctx, int selection))
807 OSSL_CORE_MAKE_FUNC(int, encoder_encode,
808 (void *ctx, OSSL_CORE_BIO *out,
809 const void *obj_raw, const OSSL_PARAM obj_abstract[],
811 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
813 OSSL_CORE_MAKE_FUNC(void *, encoder_import_object,
814 (void *ctx, int selection, const OSSL_PARAM params[]))
815 OSSL_CORE_MAKE_FUNC(void, encoder_free_object, (void *obj))
817 # define OSSL_FUNC_DECODER_NEWCTX 1
818 # define OSSL_FUNC_DECODER_FREECTX 2
819 # define OSSL_FUNC_DECODER_GET_PARAMS 3
820 # define OSSL_FUNC_DECODER_GETTABLE_PARAMS 4
821 # define OSSL_FUNC_DECODER_SET_CTX_PARAMS 5
822 # define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS 6
823 # define OSSL_FUNC_DECODER_DOES_SELECTION 10
824 # define OSSL_FUNC_DECODER_DECODE 11
825 # define OSSL_FUNC_DECODER_EXPORT_OBJECT 20
826 OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx))
827 OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx))
828 OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[]))
829 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params,
831 OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params,
832 (void *ctx, const OSSL_PARAM params[]))
833 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params,
836 OSSL_CORE_MAKE_FUNC(int, decoder_does_selection,
837 (void *provctx, int selection))
838 OSSL_CORE_MAKE_FUNC(int, decoder_decode,
839 (void *ctx, OSSL_CORE_BIO *in, int selection,
840 OSSL_CALLBACK *metadata_cb, void *metadata_cbarg,
841 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
842 OSSL_CORE_MAKE_FUNC(int, decoder_export_object,
843 (void *ctx, const void *objref, size_t objref_sz,
844 OSSL_CALLBACK *export_cb, void *export_cbarg))
849 * Objects are scanned by using the 'open', 'load', 'eof' and 'close'
850 * functions, which implement an OSSL_STORE loader.
852 * store_load() works in a way that's very similar to the decoders, in
853 * that they pass an abstract object through a callback, either as a DER
854 * octet string or as an object reference, which libcrypto will have to
858 #define OSSL_FUNC_STORE_OPEN 1
859 #define OSSL_FUNC_STORE_ATTACH 2
860 #define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS 3
861 #define OSSL_FUNC_STORE_SET_CTX_PARAMS 4
862 #define OSSL_FUNC_STORE_LOAD 5
863 #define OSSL_FUNC_STORE_EOF 6
864 #define OSSL_FUNC_STORE_CLOSE 7
865 #define OSSL_FUNC_STORE_EXPORT_OBJECT 8
866 OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri))
867 OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in))
868 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params,
870 OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params,
871 (void *loaderctx, const OSSL_PARAM params[]))
872 OSSL_CORE_MAKE_FUNC(int, store_load,
874 OSSL_CALLBACK *object_cb, void *object_cbarg,
875 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
876 OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx))
877 OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx))
878 OSSL_CORE_MAKE_FUNC(int, store_export_object,
879 (void *loaderctx, const void *objref, size_t objref_sz,
880 OSSL_CALLBACK *export_cb, void *export_cbarg))