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_LIBRARY_CONTEXT 4
70 OSSL_CORE_MAKE_FUNC(OPENSSL_CORE_CTX *,core_get_library_context,
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
142 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename,
144 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len))
145 OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data,
146 size_t data_len, size_t *bytes_read))
147 OSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data,
148 size_t data_len, size_t *written))
149 OSSL_CORE_MAKE_FUNC(int, BIO_gets, (OSSL_CORE_BIO *bio, char *buf, int size))
150 OSSL_CORE_MAKE_FUNC(int, BIO_puts, (OSSL_CORE_BIO *bio, const char *str))
151 OSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio))
152 OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format,
154 OSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf,
155 (char *buf, size_t n, const char *fmt, va_list args))
157 #define OSSL_FUNC_SELF_TEST_CB 100
158 OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb,
161 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
162 # define OSSL_FUNC_PROVIDER_TEARDOWN 1024
163 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
164 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025
165 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
166 provider_gettable_params,(void *provctx))
167 # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026
168 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
169 OSSL_PARAM params[]))
170 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027
171 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
172 (void *provctx, int operation_id, int *no_store))
173 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
174 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
176 # define OSSL_FUNC_PROVIDER_GET_CAPABILITIES 1029
177 OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx,
178 const char *capability, OSSL_CALLBACK *cb, void *arg))
182 # define OSSL_OP_DIGEST 1
183 # define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */
184 # define OSSL_OP_MAC 3
185 # define OSSL_OP_KDF 4
186 # define OSSL_OP_RAND 5
187 # define OSSL_OP_KEYMGMT 10
188 # define OSSL_OP_KEYEXCH 11
189 # define OSSL_OP_SIGNATURE 12
190 # define OSSL_OP_ASYM_CIPHER 13
191 /* New section for non-EVP operations */
192 # define OSSL_OP_SERIALIZER 20
193 # define OSSL_OP_DESERIALIZER 21
194 /* Highest known operation number */
195 # define OSSL_OP__HIGHEST 21
199 # define OSSL_FUNC_DIGEST_NEWCTX 1
200 # define OSSL_FUNC_DIGEST_INIT 2
201 # define OSSL_FUNC_DIGEST_UPDATE 3
202 # define OSSL_FUNC_DIGEST_FINAL 4
203 # define OSSL_FUNC_DIGEST_DIGEST 5
204 # define OSSL_FUNC_DIGEST_FREECTX 6
205 # define OSSL_FUNC_DIGEST_DUPCTX 7
206 # define OSSL_FUNC_DIGEST_GET_PARAMS 8
207 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9
208 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10
209 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11
210 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12
211 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13
213 OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx))
214 OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx))
215 OSSL_CORE_MAKE_FUNC(int, digest_update,
216 (void *dctx, const unsigned char *in, size_t inl))
217 OSSL_CORE_MAKE_FUNC(int, digest_final,
219 unsigned char *out, size_t *outl, size_t outsz))
220 OSSL_CORE_MAKE_FUNC(int, digest_digest,
221 (void *provctx, const unsigned char *in, size_t inl,
222 unsigned char *out, size_t *outl, size_t outsz))
224 OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx))
225 OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx))
227 OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[]))
228 OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params,
229 (void *vctx, const OSSL_PARAM params[]))
230 OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params,
231 (void *vctx, OSSL_PARAM params[]))
232 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params,
234 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params,
236 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params,
239 /* Symmetric Ciphers */
241 # define OSSL_FUNC_CIPHER_NEWCTX 1
242 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2
243 # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3
244 # define OSSL_FUNC_CIPHER_UPDATE 4
245 # define OSSL_FUNC_CIPHER_FINAL 5
246 # define OSSL_FUNC_CIPHER_CIPHER 6
247 # define OSSL_FUNC_CIPHER_FREECTX 7
248 # define OSSL_FUNC_CIPHER_DUPCTX 8
249 # define OSSL_FUNC_CIPHER_GET_PARAMS 9
250 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10
251 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11
252 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12
253 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13
254 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14
256 OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx))
257 OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx,
258 const unsigned char *key,
260 const unsigned char *iv,
262 OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx,
263 const unsigned char *key,
265 const unsigned char *iv,
267 OSSL_CORE_MAKE_FUNC(int, cipher_update,
269 unsigned char *out, size_t *outl, size_t outsize,
270 const unsigned char *in, size_t inl))
271 OSSL_CORE_MAKE_FUNC(int, cipher_final,
273 unsigned char *out, size_t *outl, size_t outsize))
274 OSSL_CORE_MAKE_FUNC(int, cipher_cipher,
276 unsigned char *out, size_t *outl, size_t outsize,
277 const unsigned char *in, size_t inl))
278 OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx))
279 OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx))
280 OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[]))
281 OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx,
282 OSSL_PARAM params[]))
283 OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx,
284 const OSSL_PARAM params[]))
285 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params,
287 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params,
289 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params,
294 # define OSSL_FUNC_MAC_NEWCTX 1
295 # define OSSL_FUNC_MAC_DUPCTX 2
296 # define OSSL_FUNC_MAC_FREECTX 3
297 # define OSSL_FUNC_MAC_INIT 4
298 # define OSSL_FUNC_MAC_UPDATE 5
299 # define OSSL_FUNC_MAC_FINAL 6
300 # define OSSL_FUNC_MAC_GET_PARAMS 7
301 # define OSSL_FUNC_MAC_GET_CTX_PARAMS 8
302 # define OSSL_FUNC_MAC_SET_CTX_PARAMS 9
303 # define OSSL_FUNC_MAC_GETTABLE_PARAMS 10
304 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11
305 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12
307 OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx))
308 OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src))
309 OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx))
310 OSSL_CORE_MAKE_FUNC(size_t, mac_size, (void *mctx))
311 OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx))
312 OSSL_CORE_MAKE_FUNC(int, mac_update,
313 (void *mctx, const unsigned char *in, size_t inl))
314 OSSL_CORE_MAKE_FUNC(int, mac_final,
316 unsigned char *out, size_t *outl, size_t outsize))
317 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx))
318 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params,
320 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params,
322 OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[]))
323 OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params,
324 (void *mctx, OSSL_PARAM params[]))
325 OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params,
326 (void *mctx, const OSSL_PARAM params[]))
330 # define OSSL_FUNC_KDF_NEWCTX 1
331 # define OSSL_FUNC_KDF_DUPCTX 2
332 # define OSSL_FUNC_KDF_FREECTX 3
333 # define OSSL_FUNC_KDF_RESET 4
334 # define OSSL_FUNC_KDF_DERIVE 5
335 # define OSSL_FUNC_KDF_GETTABLE_PARAMS 6
336 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7
337 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8
338 # define OSSL_FUNC_KDF_GET_PARAMS 9
339 # define OSSL_FUNC_KDF_GET_CTX_PARAMS 10
340 # define OSSL_FUNC_KDF_SET_CTX_PARAMS 11
342 OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx))
343 OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src))
344 OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx))
345 OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx))
346 OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key,
348 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx))
349 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params,
351 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params,
353 OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[]))
354 OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params,
355 (void *kctx, OSSL_PARAM params[]))
356 OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params,
357 (void *kctx, const OSSL_PARAM params[]))
361 # define OSSL_FUNC_RAND_NEWCTX 1
362 # define OSSL_FUNC_RAND_FREECTX 2
363 # define OSSL_FUNC_RAND_INSTANTIATE 3
364 # define OSSL_FUNC_RAND_UNINSTANTIATE 4
365 # define OSSL_FUNC_RAND_GENERATE 5
366 # define OSSL_FUNC_RAND_RESEED 6
367 # define OSSL_FUNC_RAND_NONCE 7
368 # define OSSL_FUNC_RAND_ENABLE_LOCKING 8
369 # define OSSL_FUNC_RAND_LOCK 9
370 # define OSSL_FUNC_RAND_UNLOCK 10
371 # define OSSL_FUNC_RAND_GETTABLE_PARAMS 11
372 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS 12
373 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS 13
374 # define OSSL_FUNC_RAND_GET_PARAMS 14
375 # define OSSL_FUNC_RAND_GET_CTX_PARAMS 15
376 # define OSSL_FUNC_RAND_SET_CTX_PARAMS 16
377 # define OSSL_FUNC_RAND_VERIFY_ZEROIZATION 17
379 OSSL_CORE_MAKE_FUNC(void *,rand_newctx,
380 (void *provctx, void *parent,
381 const OSSL_DISPATCH *parent_calls))
382 OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx))
383 OSSL_CORE_MAKE_FUNC(int,rand_instantiate,
384 (void *vdrbg, unsigned int strength,
385 int prediction_resistance,
386 const unsigned char *pstr, size_t pstr_len))
387 OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg))
388 OSSL_CORE_MAKE_FUNC(int,rand_generate,
389 (void *vctx, unsigned char *out, size_t outlen,
390 unsigned int strength, int prediction_resistance,
391 const unsigned char *addin, size_t addin_len))
392 OSSL_CORE_MAKE_FUNC(int,rand_reseed,
393 (void *vctx, int prediction_resistance,
394 const unsigned char *ent, size_t ent_len,
395 const unsigned char *addin, size_t addin_len))
396 OSSL_CORE_MAKE_FUNC(size_t,rand_nonce,
397 (void *vctx, unsigned char *out, unsigned int strength,
398 size_t min_noncelen, size_t max_noncelen))
399 OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx))
400 OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx))
401 OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx))
402 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx))
403 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params,
405 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params,
407 OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[]))
408 OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params,
409 (void *vctx, OSSL_PARAM params[]))
410 OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params,
411 (void *vctx, const OSSL_PARAM params[]))
412 OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks,
413 (void *vctx, OSSL_INOUT_CALLBACK *get_entropy,
414 OSSL_CALLBACK *cleanup_entropy,
415 OSSL_INOUT_CALLBACK *get_nonce,
416 OSSL_CALLBACK *cleanup_nonce, void *arg))
417 OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization,
423 * The Key Management takes care of provider side key objects, and includes
424 * all current functionality to create them, destroy them, set parameters
425 * and key material, etc, essentially everything that manipulates the keys
426 * themselves and their parameters.
428 * The key objects are commonly refered to as |keydata|, and it MUST be able
429 * to contain parameters if the key has any, the public key and the private
430 * key. All parts are optional, but their presence determines what can be
431 * done with the key object in terms of encryption, signature, and so on.
432 * The assumption from libcrypto is that the key object contains any of the
433 * following data combinations:
437 * - public key + private key
438 * - parameters + public key
439 * - parameters + public key + private key
441 * What "parameters", "public key" and "private key" means in detail is left
442 * to the implementation. In the case of DH and DSA, they would typically
443 * include domain parameters, while for certain variants of RSA, they would
444 * typically include PSS or OAEP parameters.
446 * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with
447 * OSSL_FUNC_keymgmt_free(). Key objects can have data filled in with
448 * OSSL_FUNC_keymgmt_import().
450 * Three functions are made available to check what selection of data is
451 * present in a key object: OSSL_FUNC_keymgmt_has_parameters(),
452 * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(),
455 /* Key data subset selection - individual bits */
456 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01
457 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02
458 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04
459 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80
461 /* Key data subset selection - combinations */
462 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \
463 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \
464 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
465 # define OSSL_KEYMGMT_SELECT_KEYPAIR \
466 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
467 # define OSSL_KEYMGMT_SELECT_ALL \
468 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
470 /* Basic key object creation */
471 # define OSSL_FUNC_KEYMGMT_NEW 1
472 OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx))
474 /* Generation, a more complex constructor */
475 # define OSSL_FUNC_KEYMGMT_GEN_INIT 2
476 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE 3
477 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS 4
478 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS 5
479 # define OSSL_FUNC_KEYMGMT_GEN 6
480 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP 7
481 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init,
482 (void *provctx, int selection))
483 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template,
484 (void *genctx, void *templ))
485 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params,
486 (void *genctx, const OSSL_PARAM params[]))
487 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
488 keymgmt_gen_settable_params, (void *provctx))
489 OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_get_params,
490 (void *genctx, OSSL_PARAM params[]))
491 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
492 keymgmt_gen_gettable_params, (void *provctx))
493 OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen,
494 (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
495 OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx))
497 /* Key loading by object reference */
498 # define OSSL_FUNC_KEYMGMT_LOAD 8
499 OSSL_CORE_MAKE_FUNC(void *, keymgmt_load,
500 (const void *reference, size_t reference_sz))
502 /* Basic key object destruction */
503 # define OSSL_FUNC_KEYMGMT_FREE 10
504 OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata))
506 /* Key object information, with discovery */
507 #define OSSL_FUNC_KEYMGMT_GET_PARAMS 11
508 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 12
509 OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params,
510 (void *keydata, OSSL_PARAM params[]))
511 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params, (void *))
513 #define OSSL_FUNC_KEYMGMT_SET_PARAMS 13
514 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 14
515 OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params,
516 (void *keydata, const OSSL_PARAM params[]))
517 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params, (void *))
519 /* Key checks - discovery of supported operations */
520 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20
521 OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name,
524 /* Key checks - key data content checks */
525 # define OSSL_FUNC_KEYMGMT_HAS 21
526 OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (void *keydata, int selection))
528 /* Key checks - validation */
529 # define OSSL_FUNC_KEYMGMT_VALIDATE 22
530 OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (void *keydata, int selection))
532 /* Key checks - matching */
533 # define OSSL_FUNC_KEYMGMT_MATCH 23
534 OSSL_CORE_MAKE_FUNC(int, keymgmt_match,
535 (const void *keydata1, const void *keydata2,
538 /* Import and export functions, with discovery */
539 # define OSSL_FUNC_KEYMGMT_IMPORT 40
540 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41
541 # define OSSL_FUNC_KEYMGMT_EXPORT 42
542 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43
543 OSSL_CORE_MAKE_FUNC(int, keymgmt_import,
544 (void *keydata, int selection, const OSSL_PARAM params[]))
545 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types,
547 OSSL_CORE_MAKE_FUNC(int, keymgmt_export,
548 (void *keydata, int selection,
549 OSSL_CALLBACK *param_cb, void *cbarg))
550 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types,
553 /* Copy function, only works for matching keymgmt */
554 # define OSSL_FUNC_KEYMGMT_COPY 44
555 OSSL_CORE_MAKE_FUNC(int, keymgmt_copy,
556 ( void *keydata_to, const void *keydata_from,
561 # define OSSL_FUNC_KEYEXCH_NEWCTX 1
562 # define OSSL_FUNC_KEYEXCH_INIT 2
563 # define OSSL_FUNC_KEYEXCH_DERIVE 3
564 # define OSSL_FUNC_KEYEXCH_SET_PEER 4
565 # define OSSL_FUNC_KEYEXCH_FREECTX 5
566 # define OSSL_FUNC_KEYEXCH_DUPCTX 6
567 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7
568 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8
569 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9
570 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10
572 OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx))
573 OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey))
574 OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx, unsigned char *secret,
575 size_t *secretlen, size_t outlen))
576 OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey))
577 OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx))
578 OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx))
579 OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx,
580 const OSSL_PARAM params[]))
581 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params,
583 OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx,
584 OSSL_PARAM params[]))
585 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params,
590 # define OSSL_FUNC_SIGNATURE_NEWCTX 1
591 # define OSSL_FUNC_SIGNATURE_SIGN_INIT 2
592 # define OSSL_FUNC_SIGNATURE_SIGN 3
593 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4
594 # define OSSL_FUNC_SIGNATURE_VERIFY 5
595 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6
596 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7
597 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8
598 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9
599 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10
600 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11
601 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12
602 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13
603 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14
604 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15
605 # define OSSL_FUNC_SIGNATURE_FREECTX 16
606 # define OSSL_FUNC_SIGNATURE_DUPCTX 17
607 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18
608 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19
609 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20
610 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21
611 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22
612 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
613 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24
614 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
616 OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx,
618 OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey))
619 OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx, unsigned char *sig,
620 size_t *siglen, size_t sigsize,
621 const unsigned char *tbs,
623 OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey))
624 OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx,
625 const unsigned char *sig,
627 const unsigned char *tbs,
629 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init, (void *ctx,
631 OSSL_CORE_MAKE_FUNC(int, signature_verify_recover, (void *ctx,
635 const unsigned char *sig,
637 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init,
638 (void *ctx, const char *mdname, void *provkey))
639 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update,
640 (void *ctx, const unsigned char *data, size_t datalen))
641 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final,
642 (void *ctx, unsigned char *sig, size_t *siglen,
644 OSSL_CORE_MAKE_FUNC(int, signature_digest_sign,
645 (void *ctx, unsigned char *sigret, size_t *siglen,
646 size_t sigsize, const unsigned char *tbs, size_t tbslen))
647 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init,
648 (void *ctx, const char *mdname, void *provkey))
649 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update,
650 (void *ctx, const unsigned char *data, size_t datalen))
651 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final,
652 (void *ctx, const unsigned char *sig, size_t siglen))
653 OSSL_CORE_MAKE_FUNC(int, signature_digest_verify,
654 (void *ctx, const unsigned char *sig, size_t siglen,
655 const unsigned char *tbs, size_t tbslen))
656 OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx))
657 OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx))
658 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params,
659 (void *ctx, OSSL_PARAM params[]))
660 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params,
662 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params,
663 (void *ctx, const OSSL_PARAM params[]))
664 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params,
666 OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params,
667 (void *ctx, OSSL_PARAM params[]))
668 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params,
670 OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params,
671 (void *ctx, const OSSL_PARAM params[]))
672 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params,
676 /* Asymmetric Ciphers */
678 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1
679 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2
680 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3
681 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4
682 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5
683 # define OSSL_FUNC_ASYM_CIPHER_FREECTX 6
684 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7
685 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8
686 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9
687 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10
688 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11
690 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx))
691 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey))
692 OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out,
695 const unsigned char *in,
697 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey))
698 OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out,
701 const unsigned char *in,
703 OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx))
704 OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx))
705 OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params,
706 (void *ctx, OSSL_PARAM params[]))
707 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params,
709 OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params,
710 (void *ctx, const OSSL_PARAM params[]))
711 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params,
714 /* Serializers and deserializers */
715 # define OSSL_FUNC_SERIALIZER_NEWCTX 1
716 # define OSSL_FUNC_SERIALIZER_FREECTX 2
717 # define OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS 3
718 # define OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS 4
719 # define OSSL_FUNC_SERIALIZER_SERIALIZE_DATA 10
720 # define OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT 11
721 OSSL_CORE_MAKE_FUNC(void *, serializer_newctx, (void *provctx))
722 OSSL_CORE_MAKE_FUNC(void, serializer_freectx, (void *ctx))
723 OSSL_CORE_MAKE_FUNC(int, serializer_set_ctx_params,
724 (void *ctx, const OSSL_PARAM params[]))
725 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, serializer_settable_ctx_params,
728 OSSL_CORE_MAKE_FUNC(int, serializer_serialize_data,
729 (void *ctx, const OSSL_PARAM[], OSSL_CORE_BIO *out,
730 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
731 OSSL_CORE_MAKE_FUNC(int, serializer_serialize_object,
732 (void *ctx, void *obj, OSSL_CORE_BIO *out,
733 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
735 # define OSSL_FUNC_DESERIALIZER_NEWCTX 1
736 # define OSSL_FUNC_DESERIALIZER_FREECTX 2
737 # define OSSL_FUNC_DESERIALIZER_GET_PARAMS 3
738 # define OSSL_FUNC_DESERIALIZER_GETTABLE_PARAMS 4
739 # define OSSL_FUNC_DESERIALIZER_SET_CTX_PARAMS 5
740 # define OSSL_FUNC_DESERIALIZER_SETTABLE_CTX_PARAMS 6
741 # define OSSL_FUNC_DESERIALIZER_DESERIALIZE 10
742 # define OSSL_FUNC_DESERIALIZER_EXPORT_OBJECT 11
743 OSSL_CORE_MAKE_FUNC(void *, deserializer_newctx, (void *provctx))
744 OSSL_CORE_MAKE_FUNC(void, deserializer_freectx, (void *ctx))
745 OSSL_CORE_MAKE_FUNC(int, deserializer_get_params, (OSSL_PARAM params[]))
746 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, deserializer_gettable_params,
748 OSSL_CORE_MAKE_FUNC(int, deserializer_set_ctx_params,
749 (void *ctx, const OSSL_PARAM params[]))
750 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, deserializer_settable_ctx_params,
753 OSSL_CORE_MAKE_FUNC(int, deserializer_deserialize,
754 (void *ctx, OSSL_CORE_BIO *in,
755 OSSL_CALLBACK *metadata_cb, void *metadata_cbarg,
756 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
757 OSSL_CORE_MAKE_FUNC(int, deserializer_export_object,
758 (void *ctx, const void *objref, size_t objref_sz,
759 OSSL_CALLBACK *export_cb, void *export_cbarg))