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_'foo'_fn
35 * - a function pointer extractor function with the name OSSL_'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_##name##_fn)args; \
47 OSSL_##name##_fn *OSSL_get_##name(const OSSL_DISPATCH *opf) \
49 return (OSSL_##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
139 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename,
141 OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len))
142 OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data,
143 size_t data_len, size_t *bytes_read))
144 OSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data,
145 size_t data_len, size_t *written))
146 OSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio))
147 OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format,
149 OSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf,
150 (char *buf, size_t n, const char *fmt, va_list args))
152 #define OSSL_FUNC_SELF_TEST_CB 100
153 OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb,
156 /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
157 # define OSSL_FUNC_PROVIDER_TEARDOWN 1024
158 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
159 # define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025
160 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
161 provider_gettable_params,(void *provctx))
162 # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026
163 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
164 OSSL_PARAM params[]))
165 # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027
166 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
167 (void *provctx, int operation_id, int *no_store))
168 # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
169 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
171 # define OSSL_FUNC_PROVIDER_GET_CAPABILITIES 1029
172 OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx,
173 const char *capability, OSSL_CALLBACK *cb, void *arg))
177 # define OSSL_OP_DIGEST 1
178 # define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */
179 # define OSSL_OP_MAC 3
180 # define OSSL_OP_KDF 4
181 # define OSSL_OP_RAND 5
182 # define OSSL_OP_KEYMGMT 10
183 # define OSSL_OP_KEYEXCH 11
184 # define OSSL_OP_SIGNATURE 12
185 # define OSSL_OP_ASYM_CIPHER 13
186 /* New section for non-EVP operations */
187 # define OSSL_OP_SERIALIZER 20
188 /* Highest known operation number */
189 # define OSSL_OP__HIGHEST 20
193 # define OSSL_FUNC_DIGEST_NEWCTX 1
194 # define OSSL_FUNC_DIGEST_INIT 2
195 # define OSSL_FUNC_DIGEST_UPDATE 3
196 # define OSSL_FUNC_DIGEST_FINAL 4
197 # define OSSL_FUNC_DIGEST_DIGEST 5
198 # define OSSL_FUNC_DIGEST_FREECTX 6
199 # define OSSL_FUNC_DIGEST_DUPCTX 7
200 # define OSSL_FUNC_DIGEST_GET_PARAMS 8
201 # define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9
202 # define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10
203 # define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11
204 # define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12
205 # define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13
207 OSSL_CORE_MAKE_FUNC(void *, OP_digest_newctx, (void *provctx))
208 OSSL_CORE_MAKE_FUNC(int, OP_digest_init, (void *dctx))
209 OSSL_CORE_MAKE_FUNC(int, OP_digest_update,
210 (void *dctx, const unsigned char *in, size_t inl))
211 OSSL_CORE_MAKE_FUNC(int, OP_digest_final,
213 unsigned char *out, size_t *outl, size_t outsz))
214 OSSL_CORE_MAKE_FUNC(int, OP_digest_digest,
215 (void *provctx, const unsigned char *in, size_t inl,
216 unsigned char *out, size_t *outl, size_t outsz))
218 OSSL_CORE_MAKE_FUNC(void, OP_digest_freectx, (void *dctx))
219 OSSL_CORE_MAKE_FUNC(void *, OP_digest_dupctx, (void *dctx))
221 OSSL_CORE_MAKE_FUNC(int, OP_digest_get_params, (OSSL_PARAM params[]))
222 OSSL_CORE_MAKE_FUNC(int, OP_digest_set_ctx_params,
223 (void *vctx, const OSSL_PARAM params[]))
224 OSSL_CORE_MAKE_FUNC(int, OP_digest_get_ctx_params,
225 (void *vctx, OSSL_PARAM params[]))
226 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_params, (void))
227 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_settable_ctx_params, (void))
228 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_ctx_params, (void))
230 /* Symmetric Ciphers */
232 # define OSSL_FUNC_CIPHER_NEWCTX 1
233 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2
234 # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3
235 # define OSSL_FUNC_CIPHER_UPDATE 4
236 # define OSSL_FUNC_CIPHER_FINAL 5
237 # define OSSL_FUNC_CIPHER_CIPHER 6
238 # define OSSL_FUNC_CIPHER_FREECTX 7
239 # define OSSL_FUNC_CIPHER_DUPCTX 8
240 # define OSSL_FUNC_CIPHER_GET_PARAMS 9
241 # define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10
242 # define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11
243 # define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12
244 # define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13
245 # define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14
247 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_newctx, (void *provctx))
248 OSSL_CORE_MAKE_FUNC(int, OP_cipher_encrypt_init, (void *cctx,
249 const unsigned char *key,
251 const unsigned char *iv,
253 OSSL_CORE_MAKE_FUNC(int, OP_cipher_decrypt_init, (void *cctx,
254 const unsigned char *key,
256 const unsigned char *iv,
258 OSSL_CORE_MAKE_FUNC(int, OP_cipher_update,
260 unsigned char *out, size_t *outl, size_t outsize,
261 const unsigned char *in, size_t inl))
262 OSSL_CORE_MAKE_FUNC(int, OP_cipher_final,
264 unsigned char *out, size_t *outl, size_t outsize))
265 OSSL_CORE_MAKE_FUNC(int, OP_cipher_cipher,
267 unsigned char *out, size_t *outl, size_t outsize,
268 const unsigned char *in, size_t inl))
269 OSSL_CORE_MAKE_FUNC(void, OP_cipher_freectx, (void *cctx))
270 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_dupctx, (void *cctx))
271 OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_params, (OSSL_PARAM params[]))
272 OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_ctx_params, (void *cctx,
273 OSSL_PARAM params[]))
274 OSSL_CORE_MAKE_FUNC(int, OP_cipher_set_ctx_params, (void *cctx,
275 const OSSL_PARAM params[]))
276 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_params, (void))
277 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_settable_ctx_params, (void))
278 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_ctx_params, (void))
282 # define OSSL_FUNC_MAC_NEWCTX 1
283 # define OSSL_FUNC_MAC_DUPCTX 2
284 # define OSSL_FUNC_MAC_FREECTX 3
285 # define OSSL_FUNC_MAC_INIT 4
286 # define OSSL_FUNC_MAC_UPDATE 5
287 # define OSSL_FUNC_MAC_FINAL 6
288 # define OSSL_FUNC_MAC_GET_PARAMS 7
289 # define OSSL_FUNC_MAC_GET_CTX_PARAMS 8
290 # define OSSL_FUNC_MAC_SET_CTX_PARAMS 9
291 # define OSSL_FUNC_MAC_GETTABLE_PARAMS 10
292 # define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11
293 # define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12
295 OSSL_CORE_MAKE_FUNC(void *, OP_mac_newctx, (void *provctx))
296 OSSL_CORE_MAKE_FUNC(void *, OP_mac_dupctx, (void *src))
297 OSSL_CORE_MAKE_FUNC(void, OP_mac_freectx, (void *mctx))
298 OSSL_CORE_MAKE_FUNC(size_t, OP_mac_size, (void *mctx))
299 OSSL_CORE_MAKE_FUNC(int, OP_mac_init, (void *mctx))
300 OSSL_CORE_MAKE_FUNC(int, OP_mac_update,
301 (void *mctx, const unsigned char *in, size_t inl))
302 OSSL_CORE_MAKE_FUNC(int, OP_mac_final,
304 unsigned char *out, size_t *outl, size_t outsize))
305 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_params, (void))
306 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_ctx_params, (void))
307 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_settable_ctx_params, (void))
308 OSSL_CORE_MAKE_FUNC(int, OP_mac_get_params, (OSSL_PARAM params[]))
309 OSSL_CORE_MAKE_FUNC(int, OP_mac_get_ctx_params,
310 (void *mctx, OSSL_PARAM params[]))
311 OSSL_CORE_MAKE_FUNC(int, OP_mac_set_ctx_params,
312 (void *mctx, const OSSL_PARAM params[]))
316 # define OSSL_FUNC_KDF_NEWCTX 1
317 # define OSSL_FUNC_KDF_DUPCTX 2
318 # define OSSL_FUNC_KDF_FREECTX 3
319 # define OSSL_FUNC_KDF_RESET 4
320 # define OSSL_FUNC_KDF_DERIVE 5
321 # define OSSL_FUNC_KDF_GETTABLE_PARAMS 6
322 # define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7
323 # define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8
324 # define OSSL_FUNC_KDF_GET_PARAMS 9
325 # define OSSL_FUNC_KDF_GET_CTX_PARAMS 10
326 # define OSSL_FUNC_KDF_SET_CTX_PARAMS 11
328 OSSL_CORE_MAKE_FUNC(void *, OP_kdf_newctx, (void *provctx))
329 OSSL_CORE_MAKE_FUNC(void *, OP_kdf_dupctx, (void *src))
330 OSSL_CORE_MAKE_FUNC(void, OP_kdf_freectx, (void *kctx))
331 OSSL_CORE_MAKE_FUNC(void, OP_kdf_reset, (void *kctx))
332 OSSL_CORE_MAKE_FUNC(int, OP_kdf_derive, (void *kctx, unsigned char *key,
334 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_gettable_params, (void))
335 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_gettable_ctx_params, (void))
336 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_settable_ctx_params, (void))
337 OSSL_CORE_MAKE_FUNC(int, OP_kdf_get_params, (OSSL_PARAM params[]))
338 OSSL_CORE_MAKE_FUNC(int, OP_kdf_get_ctx_params,
339 (void *kctx, OSSL_PARAM params[]))
340 OSSL_CORE_MAKE_FUNC(int, OP_kdf_set_ctx_params,
341 (void *kctx, const OSSL_PARAM params[]))
345 # define OSSL_FUNC_RAND_NEWCTX 1
346 # define OSSL_FUNC_RAND_FREECTX 2
347 # define OSSL_FUNC_RAND_INSTANTIATE 3
348 # define OSSL_FUNC_RAND_UNINSTANTIATE 4
349 # define OSSL_FUNC_RAND_GENERATE 5
350 # define OSSL_FUNC_RAND_RESEED 6
351 # define OSSL_FUNC_RAND_NONCE 7
352 # define OSSL_FUNC_RAND_ENABLE_LOCKING 8
353 # define OSSL_FUNC_RAND_LOCK 9
354 # define OSSL_FUNC_RAND_UNLOCK 10
355 # define OSSL_FUNC_RAND_GETTABLE_PARAMS 11
356 # define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS 12
357 # define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS 13
358 # define OSSL_FUNC_RAND_GET_PARAMS 14
359 # define OSSL_FUNC_RAND_GET_CTX_PARAMS 15
360 # define OSSL_FUNC_RAND_SET_CTX_PARAMS 16
361 # define OSSL_FUNC_RAND_SET_CALLBACKS 17
363 OSSL_CORE_MAKE_FUNC(void *, OP_rand_newctx,
364 (void *provctx, int secure, unsigned int df, void *parent,
365 const OSSL_DISPATCH *parent_calls))
366 OSSL_CORE_MAKE_FUNC(void, OP_rand_freectx, (void *vctx))
367 OSSL_CORE_MAKE_FUNC(int, OP_rand_instantiate,
368 (void *vdrbg, int strength, int prediction_resistance,
369 const unsigned char *pstr, size_t pstr_len))
370 OSSL_CORE_MAKE_FUNC(int, OP_rand_uninstantiate, (void *vdrbg))
371 OSSL_CORE_MAKE_FUNC(int, OP_rand_generate,
372 (void *vctx, unsigned char *out, size_t outlen,
373 int strength, int prediction_resistance,
374 const unsigned char *addin, size_t addin_len))
375 OSSL_CORE_MAKE_FUNC(int, OP_rand_reseed,
376 (void *vctx, int prediction_resistance,
377 const unsigned char *addin, size_t addin_len))
378 OSSL_CORE_MAKE_FUNC(int, OP_rand_nonce,
379 (void *vctx, unsigned char *out, size_t outlen))
380 OSSL_CORE_MAKE_FUNC(int, OP_rand_set_callbacks,
382 OSSL_CALLBACK *get_entropy, OSSL_CALLBACK *cleanup_entropy,
383 OSSL_CALLBACK *get_nonce, OSSL_CALLBACK *cleanup_nonce))
384 OSSL_CORE_MAKE_FUNC(int, OP_rand_enable_locking, (void *vctx))
385 OSSL_CORE_MAKE_FUNC(int, OP_rand_lock, (void *vctx))
386 OSSL_CORE_MAKE_FUNC(void, OP_rand_unlock, (void *vctx))
387 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_rand_gettable_params, (void))
388 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_rand_gettable_ctx_params, (void))
389 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_rand_settable_ctx_params, (void))
390 OSSL_CORE_MAKE_FUNC(int, OP_rand_get_params, (OSSL_PARAM params[]))
391 OSSL_CORE_MAKE_FUNC(int, OP_rand_get_ctx_params,
392 (void *vctx, OSSL_PARAM params[]))
393 OSSL_CORE_MAKE_FUNC(int, OP_rand_set_ctx_params,
394 (void *vctx, const OSSL_PARAM params[]))
399 * The Key Management takes care of provider side key objects, and includes
400 * all current functionality to create them, destroy them, set parameters
401 * and key material, etc, essentially everything that manipulates the keys
402 * themselves and their parameters.
404 * The key objects are commonly refered to as |keydata|, and it MUST be able
405 * to contain parameters if the key has any, the public key and the private
406 * key. All parts are optional, but their presence determines what can be
407 * done with the key object in terms of encryption, signature, and so on.
408 * The assumption from libcrypto is that the key object contains any of the
409 * following data combinations:
413 * - public key + private key
414 * - parameters + public key
415 * - parameters + public key + private key
417 * What "parameters", "public key" and "private key" means in detail is left
418 * to the implementation. In the case of DH and DSA, they would typically
419 * include domain parameters, while for certain variants of RSA, they would
420 * typically include PSS or OAEP parameters.
422 * Key objects are created with OP_keymgmt_new() and destroyed with
423 * Op_keymgmt_free(). Key objects can have data filled in with
424 * OP_keymgmt_import().
426 * Three functions are made available to check what selection of data is
427 * present in a key object: OP_keymgmt_has_parameters(),
428 * OP_keymgmt_has_public_key(), and OP_keymgmt_has_private_key(),
431 /* Key data subset selection - individual bits */
432 # define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01
433 # define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02
434 # define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04
435 # define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80
437 /* Key data subset selection - combinations */
438 # define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \
439 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \
440 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
441 # define OSSL_KEYMGMT_SELECT_KEYPAIR \
442 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
443 # define OSSL_KEYMGMT_SELECT_ALL \
444 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
446 /* Basic key object creation */
447 # define OSSL_FUNC_KEYMGMT_NEW 1
448 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_new, (void *provctx))
450 /* Generation, a more complex constructor */
451 # define OSSL_FUNC_KEYMGMT_GEN_INIT 2
452 # define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE 3
453 # define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS 4
454 # define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS 5
455 # define OSSL_FUNC_KEYMGMT_GEN 6
456 # define OSSL_FUNC_KEYMGMT_GEN_CLEANUP 7
457 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_gen_init,
458 (void *provctx, int selection))
459 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_gen_set_template,
460 (void *genctx, void *templ))
461 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_gen_set_params,
462 (void *genctx, const OSSL_PARAM params[]))
463 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
464 OP_keymgmt_gen_settable_params, (void *provctx))
465 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_gen_get_params,
466 (void *genctx, OSSL_PARAM params[]))
467 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
468 OP_keymgmt_gen_gettable_params, (void *provctx))
469 OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_gen,
470 (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
471 OSSL_CORE_MAKE_FUNC(void, OP_keymgmt_gen_cleanup, (void *genctx))
473 /* Basic key object destruction */
474 # define OSSL_FUNC_KEYMGMT_FREE 10
475 OSSL_CORE_MAKE_FUNC(void, OP_keymgmt_free, (void *keydata))
477 /* Key object information, with discovery */
478 #define OSSL_FUNC_KEYMGMT_GET_PARAMS 11
479 #define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 12
480 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_get_params,
481 (void *keydata, OSSL_PARAM params[]))
482 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_gettable_params, (void))
484 #define OSSL_FUNC_KEYMGMT_SET_PARAMS 13
485 #define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 14
486 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_set_params,
487 (void *keydata, const OSSL_PARAM params[]))
488 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_settable_params, (void))
490 /* Key checks - discovery of supported operations */
491 # define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20
492 OSSL_CORE_MAKE_FUNC(const char *, OP_keymgmt_query_operation_name,
495 /* Key checks - key data content checks */
496 # define OSSL_FUNC_KEYMGMT_HAS 21
497 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_has, (void *keydata, int selection))
499 /* Key checks - validation */
500 # define OSSL_FUNC_KEYMGMT_VALIDATE 22
501 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_validate, (void *keydata, int selection))
503 /* Key checks - matching */
504 # define OSSL_FUNC_KEYMGMT_MATCH 23
505 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_match,
506 (const void *keydata1, const void *keydata2,
509 /* Import and export functions, with discovery */
510 # define OSSL_FUNC_KEYMGMT_IMPORT 40
511 # define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41
512 # define OSSL_FUNC_KEYMGMT_EXPORT 42
513 # define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43
514 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_import,
515 (void *keydata, int selection, const OSSL_PARAM params[]))
516 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_import_types,
518 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_export,
519 (void *keydata, int selection,
520 OSSL_CALLBACK *param_cb, void *cbarg))
521 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_export_types,
524 /* Copy function, only works for matching keymgmt */
525 # define OSSL_FUNC_KEYMGMT_COPY 44
526 OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_copy,
527 ( void *keydata_to, const void *keydata_from,
532 # define OSSL_FUNC_KEYEXCH_NEWCTX 1
533 # define OSSL_FUNC_KEYEXCH_INIT 2
534 # define OSSL_FUNC_KEYEXCH_DERIVE 3
535 # define OSSL_FUNC_KEYEXCH_SET_PEER 4
536 # define OSSL_FUNC_KEYEXCH_FREECTX 5
537 # define OSSL_FUNC_KEYEXCH_DUPCTX 6
538 # define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7
539 # define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8
540 # define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9
541 # define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10
543 OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_newctx, (void *provctx))
544 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_init, (void *ctx, void *provkey))
545 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_derive, (void *ctx, unsigned char *secret,
546 size_t *secretlen, size_t outlen))
547 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_peer, (void *ctx, void *provkey))
548 OSSL_CORE_MAKE_FUNC(void, OP_keyexch_freectx, (void *ctx))
549 OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_dupctx, (void *ctx))
550 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_ctx_params, (void *ctx,
551 const OSSL_PARAM params[]))
552 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keyexch_settable_ctx_params,
554 OSSL_CORE_MAKE_FUNC(int, OP_keyexch_get_ctx_params, (void *ctx,
555 OSSL_PARAM params[]))
556 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keyexch_gettable_ctx_params,
561 # define OSSL_FUNC_SIGNATURE_NEWCTX 1
562 # define OSSL_FUNC_SIGNATURE_SIGN_INIT 2
563 # define OSSL_FUNC_SIGNATURE_SIGN 3
564 # define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4
565 # define OSSL_FUNC_SIGNATURE_VERIFY 5
566 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6
567 # define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7
568 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8
569 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9
570 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10
571 # define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11
572 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12
573 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13
574 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14
575 # define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15
576 # define OSSL_FUNC_SIGNATURE_FREECTX 16
577 # define OSSL_FUNC_SIGNATURE_DUPCTX 17
578 # define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18
579 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19
580 # define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20
581 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21
582 # define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22
583 # define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
584 # define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24
585 # define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
587 OSSL_CORE_MAKE_FUNC(void *, OP_signature_newctx, (void *provctx,
589 OSSL_CORE_MAKE_FUNC(int, OP_signature_sign_init, (void *ctx, void *provkey))
590 OSSL_CORE_MAKE_FUNC(int, OP_signature_sign, (void *ctx, unsigned char *sig,
591 size_t *siglen, size_t sigsize,
592 const unsigned char *tbs,
594 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_init, (void *ctx, void *provkey))
595 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify, (void *ctx,
596 const unsigned char *sig,
598 const unsigned char *tbs,
600 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_recover_init, (void *ctx,
602 OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_recover, (void *ctx,
606 const unsigned char *sig,
608 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_init,
609 (void *ctx, const char *mdname, void *provkey))
610 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_update,
611 (void *ctx, const unsigned char *data, size_t datalen))
612 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_final,
613 (void *ctx, unsigned char *sig, size_t *siglen,
615 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign,
616 (void *ctx, unsigned char *sigret, size_t *siglen,
617 size_t sigsize, const unsigned char *tbs, size_t tbslen))
618 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_init,
619 (void *ctx, const char *mdname, void *provkey))
620 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_update,
621 (void *ctx, const unsigned char *data, size_t datalen))
622 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_final,
623 (void *ctx, const unsigned char *sig, size_t siglen))
624 OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify,
625 (void *ctx, const unsigned char *sig, size_t siglen,
626 const unsigned char *tbs, size_t tbslen))
627 OSSL_CORE_MAKE_FUNC(void, OP_signature_freectx, (void *ctx))
628 OSSL_CORE_MAKE_FUNC(void *, OP_signature_dupctx, (void *ctx))
629 OSSL_CORE_MAKE_FUNC(int, OP_signature_get_ctx_params,
630 (void *ctx, OSSL_PARAM params[]))
631 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_gettable_ctx_params,
633 OSSL_CORE_MAKE_FUNC(int, OP_signature_set_ctx_params,
634 (void *ctx, const OSSL_PARAM params[]))
635 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_settable_ctx_params,
637 OSSL_CORE_MAKE_FUNC(int, OP_signature_get_ctx_md_params,
638 (void *ctx, OSSL_PARAM params[]))
639 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_gettable_ctx_md_params,
641 OSSL_CORE_MAKE_FUNC(int, OP_signature_set_ctx_md_params,
642 (void *ctx, const OSSL_PARAM params[]))
643 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_settable_ctx_md_params,
647 /* Asymmetric Ciphers */
649 # define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1
650 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2
651 # define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3
652 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4
653 # define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5
654 # define OSSL_FUNC_ASYM_CIPHER_FREECTX 6
655 # define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7
656 # define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8
657 # define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9
658 # define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10
659 # define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11
661 OSSL_CORE_MAKE_FUNC(void *, OP_asym_cipher_newctx, (void *provctx))
662 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_encrypt_init, (void *ctx, void *provkey))
663 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_encrypt, (void *ctx, unsigned char *out,
666 const unsigned char *in,
668 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_decrypt_init, (void *ctx, void *provkey))
669 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_decrypt, (void *ctx, unsigned char *out,
672 const unsigned char *in,
674 OSSL_CORE_MAKE_FUNC(void, OP_asym_cipher_freectx, (void *ctx))
675 OSSL_CORE_MAKE_FUNC(void *, OP_asym_cipher_dupctx, (void *ctx))
676 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_get_ctx_params,
677 (void *ctx, OSSL_PARAM params[]))
678 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_asym_cipher_gettable_ctx_params,
680 OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_set_ctx_params,
681 (void *ctx, const OSSL_PARAM params[]))
682 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_asym_cipher_settable_ctx_params,
686 # define OSSL_FUNC_SERIALIZER_NEWCTX 1
687 # define OSSL_FUNC_SERIALIZER_FREECTX 2
688 # define OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS 3
689 # define OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS 4
690 # define OSSL_FUNC_SERIALIZER_SERIALIZE_DATA 10
691 # define OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT 11
692 OSSL_CORE_MAKE_FUNC(void *, OP_serializer_newctx, (void *provctx))
693 OSSL_CORE_MAKE_FUNC(void, OP_serializer_freectx, (void *ctx))
694 OSSL_CORE_MAKE_FUNC(int, OP_serializer_set_ctx_params,
695 (void *ctx, const OSSL_PARAM params[]))
696 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_serializer_settable_ctx_params,
699 OSSL_CORE_MAKE_FUNC(int, OP_serializer_serialize_data,
700 (void *ctx, const OSSL_PARAM[], OSSL_CORE_BIO *out,
701 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
702 OSSL_CORE_MAKE_FUNC(int, OP_serializer_serialize_object,
703 (void *ctx, void *obj, OSSL_CORE_BIO *out,
704 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))