2 * Copyright 2019-2020 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
14 # include <openssl/core.h>
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.
30 * for any function base name 'foo' (uppercase form 'FOO'), we will have
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'
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).
44 #define OSSL_CORE_MAKE_FUNC(type,name,args) \
45 typedef type (OSSL_FUNC_##name##_fn)args; \
47 OSSL_FUNC_##name##_fn *OSSL_FUNC_##name(const OSSL_DISPATCH *opf) \
49 return (OSSL_FUNC_##name##_fn *)opf->function; \
53 * Core function identities, for the two OSSL_DISPATCH tables being passed
54 * in the OSSL_provider_init call.
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.
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,
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_LIBCTX 4
70 OSSL_CORE_MAKE_FUNC(OPENSSL_CORE_CTX *,core_get_libctx,
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))
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,
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))
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 #define OSSL_FUNC_BIO_PUTS 47
139 #define OSSL_FUNC_BIO_GETS 48
140 #define OSSL_FUNC_BIO_CTRL 49
143 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename,
145 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len))
146 OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data,
147 size_t data_len, size_t *bytes_read))
148 OSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data,
149 size_t data_len, size_t *written))
150 OSSL_CORE_MAKE_FUNC(int, BIO_gets, (OSSL_CORE_BIO *bio, char *buf, int size))
151 OSSL_CORE_MAKE_FUNC(int, BIO_puts, (OSSL_CORE_BIO *bio, const char *str))
152 OSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio))
153 OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format,
155 OSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf,
156 (char *buf, size_t n, const char *fmt, va_list args))
157 OSSL_CORE_MAKE_FUNC(int, BIO_ctrl, (OSSL_CORE_BIO *bio,
158 int cmd, long num, void *ptr))
160 #define OSSL_FUNC_SELF_TEST_CB 100
161 OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb,
164 /* Functions to get seed material from the operating system */
165 #define OSSL_FUNC_GET_ENTROPY 101
166 #define OSSL_FUNC_CLEANUP_ENTROPY 102
167 #define OSSL_FUNC_GET_NONCE 103
168 #define OSSL_FUNC_CLEANUP_NONCE 104
169 OSSL_CORE_MAKE_FUNC(size_t, get_entropy, (const OSSL_CORE_HANDLE *handle,
170 unsigned char **pout, int entropy,
171 size_t min_len, size_t max_len))
172 OSSL_CORE_MAKE_FUNC(void, cleanup_entropy, (const OSSL_CORE_HANDLE *handle,
173 unsigned char *buf, size_t len))
174 OSSL_CORE_MAKE_FUNC(size_t, get_nonce, (const OSSL_CORE_HANDLE *handle,
175 unsigned char **pout, size_t min_len,
176 size_t max_len, const void *salt,
178 OSSL_CORE_MAKE_FUNC(void, cleanup_nonce, (const OSSL_CORE_HANDLE *handle,
179 unsigned char *buf, size_t len))
181 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
182 # define OSSL_FUNC_PROVIDER_TEARDOWN 1024
183 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
184 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025
185 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
186 provider_gettable_params,(void *provctx))
187 # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026
188 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
189 OSSL_PARAM params[]))
190 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027
191 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
192 (void *provctx, int operation_id, int *no_store))
193 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
194 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
196 # define OSSL_FUNC_PROVIDER_GET_CAPABILITIES 1029
197 OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx,
198 const char *capability, OSSL_CALLBACK *cb, void *arg))
199 # define OSSL_FUNC_PROVIDER_SELF_TEST 1030
200 OSSL_CORE_MAKE_FUNC(int, provider_self_test, (void *provctx))
204 # define OSSL_OP_DIGEST 1
205 # define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */
206 # define OSSL_OP_MAC 3
207 # define OSSL_OP_KDF 4
208 # define OSSL_OP_RAND 5
209 # define OSSL_OP_KEYMGMT 10
210 # define OSSL_OP_KEYEXCH 11
211 # define OSSL_OP_SIGNATURE 12
212 # define OSSL_OP_ASYM_CIPHER 13
213 # define OSSL_OP_KEM 14
214 /* New section for non-EVP operations */
215 # define OSSL_OP_ENCODER 20
216 # define OSSL_OP_DECODER 21
217 # define OSSL_OP_STORE 22
218 /* Highest known operation number */
219 # define OSSL_OP__HIGHEST 22
223 # define OSSL_FUNC_DIGEST_NEWCTX 1
224 # define OSSL_FUNC_DIGEST_INIT 2
225 # define OSSL_FUNC_DIGEST_UPDATE 3
226 # define OSSL_FUNC_DIGEST_FINAL 4
227 # define OSSL_FUNC_DIGEST_DIGEST 5
228 # define OSSL_FUNC_DIGEST_FREECTX 6
229 # define OSSL_FUNC_DIGEST_DUPCTX 7
230 # define OSSL_FUNC_DIGEST_GET_PARAMS 8
231 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9
232 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10
233 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11
234 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12
235 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13
237 OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx))
238 OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx))
239 OSSL_CORE_MAKE_FUNC(int, digest_update,
240 (void *dctx, const unsigned char *in, size_t inl))
241 OSSL_CORE_MAKE_FUNC(int, digest_final,
243 unsigned char *out, size_t *outl, size_t outsz))
244 OSSL_CORE_MAKE_FUNC(int, digest_digest,
245 (void *provctx, const unsigned char *in, size_t inl,
246 unsigned char *out, size_t *outl, size_t outsz))
248 OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx))
249 OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx))
251 OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[]))
252 OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params,
253 (void *vctx, const OSSL_PARAM params[]))
254 OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params,
255 (void *vctx, OSSL_PARAM params[]))
256 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params,
258 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params,
260 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params,
263 /* Symmetric Ciphers */
265 # define OSSL_FUNC_CIPHER_NEWCTX 1
266 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2
267 # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3
268 # define OSSL_FUNC_CIPHER_UPDATE 4
269 # define OSSL_FUNC_CIPHER_FINAL 5
270 # define OSSL_FUNC_CIPHER_CIPHER 6
271 # define OSSL_FUNC_CIPHER_FREECTX 7
272 # define OSSL_FUNC_CIPHER_DUPCTX 8
273 # define OSSL_FUNC_CIPHER_GET_PARAMS 9
274 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10
275 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11
276 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12
277 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13
278 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14
280 OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx))
281 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx,
282 const unsigned char *key,
284 const unsigned char *iv,
286 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx,
287 const unsigned char *key,
289 const unsigned char *iv,
291 OSSL_CORE_MAKE_FUNC(int, cipher_update,
293 unsigned char *out, size_t *outl, size_t outsize,
294 const unsigned char *in, size_t inl))
295 OSSL_CORE_MAKE_FUNC(int, cipher_final,
297 unsigned char *out, size_t *outl, size_t outsize))
298 OSSL_CORE_MAKE_FUNC(int, cipher_cipher,
300 unsigned char *out, size_t *outl, size_t outsize,
301 const unsigned char *in, size_t inl))
302 OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx))
303 OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx))
304 OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[]))
305 OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx,
306 OSSL_PARAM params[]))
307 OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx,
308 const OSSL_PARAM params[]))
309 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params,
311 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params,
313 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params,
318 # define OSSL_FUNC_MAC_NEWCTX 1
319 # define OSSL_FUNC_MAC_DUPCTX 2
320 # define OSSL_FUNC_MAC_FREECTX 3
321 # define OSSL_FUNC_MAC_INIT 4
322 # define OSSL_FUNC_MAC_UPDATE 5
323 # define OSSL_FUNC_MAC_FINAL 6
324 # define OSSL_FUNC_MAC_GET_PARAMS 7
325 # define OSSL_FUNC_MAC_GET_CTX_PARAMS 8
326 # define OSSL_FUNC_MAC_SET_CTX_PARAMS 9
327 # define OSSL_FUNC_MAC_GETTABLE_PARAMS 10
328 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11
329 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12
331 OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx))
332 OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src))
333 OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx))
334 OSSL_CORE_MAKE_FUNC(size_t, mac_size, (void *mctx))
335 OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx))
336 OSSL_CORE_MAKE_FUNC(int, mac_update,
337 (void *mctx, const unsigned char *in, size_t inl))
338 OSSL_CORE_MAKE_FUNC(int, mac_final,
340 unsigned char *out, size_t *outl, size_t outsize))
341 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx))
342 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params,
344 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params,
346 OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[]))
347 OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params,
348 (void *mctx, OSSL_PARAM params[]))
349 OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params,
350 (void *mctx, const OSSL_PARAM params[]))
354 # define OSSL_FUNC_KDF_NEWCTX 1
355 # define OSSL_FUNC_KDF_DUPCTX 2
356 # define OSSL_FUNC_KDF_FREECTX 3
357 # define OSSL_FUNC_KDF_RESET 4
358 # define OSSL_FUNC_KDF_DERIVE 5
359 # define OSSL_FUNC_KDF_GETTABLE_PARAMS 6
360 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7
361 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8
362 # define OSSL_FUNC_KDF_GET_PARAMS 9
363 # define OSSL_FUNC_KDF_GET_CTX_PARAMS 10
364 # define OSSL_FUNC_KDF_SET_CTX_PARAMS 11
366 OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx))
367 OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src))
368 OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx))
369 OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx))
370 OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key,
372 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx))
373 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params,
375 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params,
377 OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[]))
378 OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params,
379 (void *kctx, OSSL_PARAM params[]))
380 OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params,
381 (void *kctx, const OSSL_PARAM params[]))
385 # define OSSL_FUNC_RAND_NEWCTX 1
386 # define OSSL_FUNC_RAND_FREECTX 2
387 # define OSSL_FUNC_RAND_INSTANTIATE 3
388 # define OSSL_FUNC_RAND_UNINSTANTIATE 4
389 # define OSSL_FUNC_RAND_GENERATE 5
390 # define OSSL_FUNC_RAND_RESEED 6
391 # define OSSL_FUNC_RAND_NONCE 7
392 # define OSSL_FUNC_RAND_ENABLE_LOCKING 8
393 # define OSSL_FUNC_RAND_LOCK 9
394 # define OSSL_FUNC_RAND_UNLOCK 10
395 # define OSSL_FUNC_RAND_GETTABLE_PARAMS 11
396 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS 12
397 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS 13
398 # define OSSL_FUNC_RAND_GET_PARAMS 14
399 # define OSSL_FUNC_RAND_GET_CTX_PARAMS 15
400 # define OSSL_FUNC_RAND_SET_CTX_PARAMS 16
401 # define OSSL_FUNC_RAND_VERIFY_ZEROIZATION 17
403 OSSL_CORE_MAKE_FUNC(void *,rand_newctx,
404 (void *provctx, void *parent,
405 const OSSL_DISPATCH *parent_calls))
406 OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx))
407 OSSL_CORE_MAKE_FUNC(int,rand_instantiate,
408 (void *vdrbg, unsigned int strength,
409 int prediction_resistance,
410 const unsigned char *pstr, size_t pstr_len))
411 OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg))
412 OSSL_CORE_MAKE_FUNC(int,rand_generate,
413 (void *vctx, unsigned char *out, size_t outlen,
414 unsigned int strength, int prediction_resistance,
415 const unsigned char *addin, size_t addin_len))
416 OSSL_CORE_MAKE_FUNC(int,rand_reseed,
417 (void *vctx, int prediction_resistance,
418 const unsigned char *ent, size_t ent_len,
419 const unsigned char *addin, size_t addin_len))
420 OSSL_CORE_MAKE_FUNC(size_t,rand_nonce,
421 (void *vctx, unsigned char *out, unsigned int strength,
422 size_t min_noncelen, size_t max_noncelen))
423 OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx))
424 OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx))
425 OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx))
426 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx))
427 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params,
429 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params,
431 OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[]))
432 OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params,
433 (void *vctx, OSSL_PARAM params[]))
434 OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params,
435 (void *vctx, const OSSL_PARAM params[]))
436 OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks,
437 (void *vctx, OSSL_INOUT_CALLBACK *get_entropy,
438 OSSL_CALLBACK *cleanup_entropy,
439 OSSL_INOUT_CALLBACK *get_nonce,
440 OSSL_CALLBACK *cleanup_nonce, void *arg))
441 OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization,
447 * The Key Management takes care of provider side key objects, and includes
448 * all current functionality to create them, destroy them, set parameters
449 * and key material, etc, essentially everything that manipulates the keys
450 * themselves and their parameters.
452 * The key objects are commonly refered to as |keydata|, and it MUST be able
453 * to contain parameters if the key has any, the public key and the private
454 * key. All parts are optional, but their presence determines what can be
455 * done with the key object in terms of encryption, signature, and so on.
456 * The assumption from libcrypto is that the key object contains any of the
457 * following data combinations:
461 * - public key + private key
462 * - parameters + public key
463 * - parameters + public key + private key
465 * What "parameters", "public key" and "private key" means in detail is left
466 * to the implementation. In the case of DH and DSA, they would typically
467 * include domain parameters, while for certain variants of RSA, they would
468 * typically include PSS or OAEP parameters.
470 * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with
471 * OSSL_FUNC_keymgmt_free(). Key objects can have data filled in with
472 * OSSL_FUNC_keymgmt_import().
474 * Three functions are made available to check what selection of data is
475 * present in a key object: OSSL_FUNC_keymgmt_has_parameters(),
476 * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(),
479 /* Key data subset selection - individual bits */
480 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01
481 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02
482 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04
483 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80
485 /* Key data subset selection - combinations */
486 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \
487 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \
488 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
489 # define OSSL_KEYMGMT_SELECT_KEYPAIR \
490 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
491 # define OSSL_KEYMGMT_SELECT_ALL \
492 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
494 /* Basic key object creation */
495 # define OSSL_FUNC_KEYMGMT_NEW 1
496 OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx))
498 /* Generation, a more complex constructor */
499 # define OSSL_FUNC_KEYMGMT_GEN_INIT 2
500 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE 3
501 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS 4
502 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS 5
503 # define OSSL_FUNC_KEYMGMT_GEN 6
504 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP 7
505 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init,
506 (void *provctx, int selection))
507 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template,
508 (void *genctx, void *templ))
509 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params,
510 (void *genctx, const OSSL_PARAM params[]))
511 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
512 keymgmt_gen_settable_params, (void *provctx))
513 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_get_params,
514 (void *genctx, OSSL_PARAM params[]))
515 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
516 keymgmt_gen_gettable_params, (void *provctx))
517 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen,
518 (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
519 OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx))
521 /* Key loading by object reference */
522 # define OSSL_FUNC_KEYMGMT_LOAD 8
523 OSSL_CORE_MAKE_FUNC(void *, keymgmt_load,
524 (const void *reference, size_t reference_sz))
526 /* Basic key object destruction */
527 # define OSSL_FUNC_KEYMGMT_FREE 10
528 OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata))
530 /* Key object information, with discovery */
531 #define OSSL_FUNC_KEYMGMT_GET_PARAMS 11
532 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 12
533 OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params,
534 (void *keydata, OSSL_PARAM params[]))
535 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params, (void *))
537 #define OSSL_FUNC_KEYMGMT_SET_PARAMS 13
538 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 14
539 OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params,
540 (void *keydata, const OSSL_PARAM params[]))
541 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params, (void *))
543 /* Key checks - discovery of supported operations */
544 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20
545 OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name,
548 /* Key checks - key data content checks */
549 # define OSSL_FUNC_KEYMGMT_HAS 21
550 OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (const void *keydata, int selection))
552 /* Key checks - validation */
553 # define OSSL_FUNC_KEYMGMT_VALIDATE 22
554 OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (const void *keydata, int selection))
556 /* Key checks - matching */
557 # define OSSL_FUNC_KEYMGMT_MATCH 23
558 OSSL_CORE_MAKE_FUNC(int, keymgmt_match,
559 (const void *keydata1, const void *keydata2,
562 /* Import and export functions, with discovery */
563 # define OSSL_FUNC_KEYMGMT_IMPORT 40
564 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41
565 # define OSSL_FUNC_KEYMGMT_EXPORT 42
566 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43
567 OSSL_CORE_MAKE_FUNC(int, keymgmt_import,
568 (void *keydata, int selection, const OSSL_PARAM params[]))
569 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types,
571 OSSL_CORE_MAKE_FUNC(int, keymgmt_export,
572 (void *keydata, int selection,
573 OSSL_CALLBACK *param_cb, void *cbarg))
574 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types,
577 /* Copy function, only works for matching keymgmt */
578 # define OSSL_FUNC_KEYMGMT_COPY 44
579 OSSL_CORE_MAKE_FUNC(int, keymgmt_copy,
580 ( void *keydata_to, const void *keydata_from,
585 # define OSSL_FUNC_KEYEXCH_NEWCTX 1
586 # define OSSL_FUNC_KEYEXCH_INIT 2
587 # define OSSL_FUNC_KEYEXCH_DERIVE 3
588 # define OSSL_FUNC_KEYEXCH_SET_PEER 4
589 # define OSSL_FUNC_KEYEXCH_FREECTX 5
590 # define OSSL_FUNC_KEYEXCH_DUPCTX 6
591 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7
592 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8
593 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9
594 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10
596 OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx))
597 OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey))
598 OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx, unsigned char *secret,
599 size_t *secretlen, size_t outlen))
600 OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey))
601 OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx))
602 OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx))
603 OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx,
604 const OSSL_PARAM params[]))
605 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params,
607 OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx,
608 OSSL_PARAM params[]))
609 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params,
614 # define OSSL_FUNC_SIGNATURE_NEWCTX 1
615 # define OSSL_FUNC_SIGNATURE_SIGN_INIT 2
616 # define OSSL_FUNC_SIGNATURE_SIGN 3
617 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4
618 # define OSSL_FUNC_SIGNATURE_VERIFY 5
619 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6
620 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7
621 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8
622 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9
623 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10
624 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11
625 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12
626 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13
627 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14
628 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15
629 # define OSSL_FUNC_SIGNATURE_FREECTX 16
630 # define OSSL_FUNC_SIGNATURE_DUPCTX 17
631 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18
632 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19
633 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20
634 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21
635 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22
636 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
637 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24
638 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
640 OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx,
642 OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey))
643 OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx, unsigned char *sig,
644 size_t *siglen, size_t sigsize,
645 const unsigned char *tbs,
647 OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey))
648 OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx,
649 const unsigned char *sig,
651 const unsigned char *tbs,
653 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init, (void *ctx,
655 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover, (void *ctx,
659 const unsigned char *sig,
661 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init,
662 (void *ctx, const char *mdname, void *provkey))
663 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update,
664 (void *ctx, const unsigned char *data, size_t datalen))
665 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final,
666 (void *ctx, unsigned char *sig, size_t *siglen,
668 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign,
669 (void *ctx, unsigned char *sigret, size_t *siglen,
670 size_t sigsize, const unsigned char *tbs, size_t tbslen))
671 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init,
672 (void *ctx, const char *mdname, void *provkey))
673 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update,
674 (void *ctx, const unsigned char *data, size_t datalen))
675 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final,
676 (void *ctx, const unsigned char *sig, size_t siglen))
677 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify,
678 (void *ctx, const unsigned char *sig, size_t siglen,
679 const unsigned char *tbs, size_t tbslen))
680 OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx))
681 OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx))
682 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params,
683 (void *ctx, OSSL_PARAM params[]))
684 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params,
686 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params,
687 (void *ctx, const OSSL_PARAM params[]))
688 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params,
690 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params,
691 (void *ctx, OSSL_PARAM params[]))
692 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params,
694 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params,
695 (void *ctx, const OSSL_PARAM params[]))
696 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params,
700 /* Asymmetric Ciphers */
702 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1
703 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2
704 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3
705 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4
706 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5
707 # define OSSL_FUNC_ASYM_CIPHER_FREECTX 6
708 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7
709 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8
710 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9
711 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10
712 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11
714 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx))
715 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey))
716 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out,
719 const unsigned char *in,
721 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey))
722 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out,
725 const unsigned char *in,
727 OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx))
728 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx))
729 OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params,
730 (void *ctx, OSSL_PARAM params[]))
731 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params,
733 OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params,
734 (void *ctx, const OSSL_PARAM params[]))
735 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params,
738 /* Asymmetric Key encapsulation */
739 # define OSSL_FUNC_KEM_NEWCTX 1
740 # define OSSL_FUNC_KEM_ENCAPSULATE_INIT 2
741 # define OSSL_FUNC_KEM_ENCAPSULATE 3
742 # define OSSL_FUNC_KEM_DECAPSULATE_INIT 4
743 # define OSSL_FUNC_KEM_DECAPSULATE 5
744 # define OSSL_FUNC_KEM_FREECTX 6
745 # define OSSL_FUNC_KEM_DUPCTX 7
746 # define OSSL_FUNC_KEM_GET_CTX_PARAMS 8
747 # define OSSL_FUNC_KEM_GETTABLE_CTX_PARAMS 9
748 # define OSSL_FUNC_KEM_SET_CTX_PARAMS 10
749 # define OSSL_FUNC_KEM_SETTABLE_CTX_PARAMS 11
751 OSSL_CORE_MAKE_FUNC(void *, kem_newctx, (void *provctx))
752 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate_init, (void *ctx, void *provkey))
753 OSSL_CORE_MAKE_FUNC(int, kem_encapsulate, (void *ctx,
754 unsigned char *out, size_t *outlen,
755 unsigned char *secret,
757 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate_init, (void *ctx, void *provkey))
758 OSSL_CORE_MAKE_FUNC(int, kem_decapsulate, (void *ctx,
759 unsigned char *out, size_t *outlen,
760 const unsigned char *in, size_t inlen))
761 OSSL_CORE_MAKE_FUNC(void, kem_freectx, (void *ctx))
762 OSSL_CORE_MAKE_FUNC(void *, kem_dupctx, (void *ctx))
763 OSSL_CORE_MAKE_FUNC(int, kem_get_ctx_params, (void *ctx, OSSL_PARAM params[]))
764 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_gettable_ctx_params, (void *provctx))
765 OSSL_CORE_MAKE_FUNC(int, kem_set_ctx_params,
766 (void *ctx, const OSSL_PARAM params[]))
767 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_settable_ctx_params, (void *provctx))
769 /* Encoders and decoders */
770 # define OSSL_FUNC_ENCODER_NEWCTX 1
771 # define OSSL_FUNC_ENCODER_FREECTX 2
772 # define OSSL_FUNC_ENCODER_GET_PARAMS 3
773 # define OSSL_FUNC_ENCODER_GETTABLE_PARAMS 4
774 # define OSSL_FUNC_ENCODER_SET_CTX_PARAMS 5
775 # define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS 6
776 # define OSSL_FUNC_ENCODER_DOES_SELECTION 10
777 # define OSSL_FUNC_ENCODER_ENCODE 11
778 # define OSSL_FUNC_ENCODER_IMPORT_OBJECT 20
779 # define OSSL_FUNC_ENCODER_FREE_OBJECT 21
780 OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx))
781 OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx))
782 OSSL_CORE_MAKE_FUNC(int, encoder_get_params, (OSSL_PARAM params[]))
783 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_gettable_params,
785 OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params,
786 (void *ctx, const OSSL_PARAM params[]))
787 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params,
790 OSSL_CORE_MAKE_FUNC(int, encoder_does_selection,
791 (void *provctx, int selection))
792 OSSL_CORE_MAKE_FUNC(int, encoder_encode,
793 (void *ctx, OSSL_CORE_BIO *out,
794 const void *obj_raw, const OSSL_PARAM obj_abstract[],
796 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
798 OSSL_CORE_MAKE_FUNC(void *, encoder_import_object,
799 (void *ctx, int selection, const OSSL_PARAM params[]))
800 OSSL_CORE_MAKE_FUNC(void, encoder_free_object, (void *obj))
802 # define OSSL_FUNC_DECODER_NEWCTX 1
803 # define OSSL_FUNC_DECODER_FREECTX 2
804 # define OSSL_FUNC_DECODER_GET_PARAMS 3
805 # define OSSL_FUNC_DECODER_GETTABLE_PARAMS 4
806 # define OSSL_FUNC_DECODER_SET_CTX_PARAMS 5
807 # define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS 6
808 # define OSSL_FUNC_DECODER_DOES_SELECTION 10
809 # define OSSL_FUNC_DECODER_DECODE 11
810 # define OSSL_FUNC_DECODER_EXPORT_OBJECT 20
811 OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx))
812 OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx))
813 OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[]))
814 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params,
816 OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params,
817 (void *ctx, const OSSL_PARAM params[]))
818 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params,
821 OSSL_CORE_MAKE_FUNC(int, decoder_does_selection,
822 (void *provctx, int selection))
823 OSSL_CORE_MAKE_FUNC(int, decoder_decode,
824 (void *ctx, OSSL_CORE_BIO *in, int selection,
825 OSSL_CALLBACK *metadata_cb, void *metadata_cbarg,
826 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
827 OSSL_CORE_MAKE_FUNC(int, decoder_export_object,
828 (void *ctx, const void *objref, size_t objref_sz,
829 OSSL_CALLBACK *export_cb, void *export_cbarg))
834 * Objects are scanned by using the 'open', 'load', 'eof' and 'close'
835 * functions, which implement an OSSL_STORE loader.
837 * store_load() works in a way that's very similar to the decoders, in
838 * that they pass an abstract object through a callback, either as a DER
839 * octet string or as an object reference, which libcrypto will have to
843 #define OSSL_FUNC_STORE_OPEN 1
844 #define OSSL_FUNC_STORE_ATTACH 2
845 #define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS 3
846 #define OSSL_FUNC_STORE_SET_CTX_PARAMS 4
847 #define OSSL_FUNC_STORE_LOAD 5
848 #define OSSL_FUNC_STORE_EOF 6
849 #define OSSL_FUNC_STORE_CLOSE 7
850 #define OSSL_FUNC_STORE_EXPORT_OBJECT 8
851 OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri))
852 OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in))
853 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params,
855 OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params,
856 (void *loaderctx, const OSSL_PARAM params[]))
857 OSSL_CORE_MAKE_FUNC(int, store_load,
859 OSSL_CALLBACK *object_cb, void *object_cbarg,
860 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
861 OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx))
862 OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx))
863 OSSL_CORE_MAKE_FUNC(int, store_export_object,
864 (void *loaderctx, const void *objref, size_t objref_sz,
865 OSSL_CALLBACK *export_cb, void *export_cbarg))