]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/core_dispatch.h
Fix typo in CONTRIBUTING.md
[thirdparty/openssl.git] / include / openssl / core_dispatch.h
CommitLineData
4c2883a9 1/*
da1c088f 2 * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
4c2883a9
RL
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
ae4186b0
DMSP
10#ifndef OPENSSL_CORE_NUMBERS_H
11# define OPENSSL_CORE_NUMBERS_H
d59068bd 12# pragma once
4c2883a9 13
3593266d 14# include <stdarg.h>
4c2883a9
RL
15# include <openssl/core.h>
16
17# ifdef __cplusplus
18extern "C" {
19# endif
20
21/*-
22 * Identities
23 * ----------
24 *
25 * All series start with 1, to allow 0 to be an array terminator.
26 * For any FUNC identity, we also provide a function signature typedef
27 * and a static inline function to extract a function pointer from a
28 * OSSL_DISPATCH element in a type safe manner.
29 *
30 * Names:
31 * for any function base name 'foo' (uppercase form 'FOO'), we will have
32 * the following:
79c44b4e 33 * - a macro for the identity with the name OSSL_FUNC_'FOO' or derivatives
4c2883a9 34 * thereof (to be specified further down)
363b1e5d
DMSP
35 * - a function signature typedef with the name OSSL_FUNC_'foo'_fn
36 * - a function pointer extractor function with the name OSSL_FUNC_'foo'
4c2883a9
RL
37 */
38
b60cba3c
RS
39/*
40 * Helper macro to create the function signature typedef and the extractor
41 * |type| is the return-type of the function, |name| is the name of the
42 * function to fetch, and |args| is a parenthesized list of parameters
43 * for the function (that is, it is |name|'s function signature).
636a9345
MC
44 * Note: This is considered a "reserved" internal macro. Applications should
45 * not use this or assume its existence.
b60cba3c 46 */
4c2883a9 47#define OSSL_CORE_MAKE_FUNC(type,name,args) \
363b1e5d 48 typedef type (OSSL_FUNC_##name##_fn)args; \
937a6232 49 static ossl_unused ossl_inline \
363b1e5d 50 OSSL_FUNC_##name##_fn *OSSL_FUNC_##name(const OSSL_DISPATCH *opf) \
4c2883a9 51 { \
363b1e5d 52 return (OSSL_FUNC_##name##_fn *)opf->function; \
4c2883a9
RL
53 }
54
55/*
56 * Core function identities, for the two OSSL_DISPATCH tables being passed
57 * in the OSSL_provider_init call.
58 *
59 * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must
60 * therefore NEVER be used as a function identity.
61 */
62/* Functions provided by the Core to the provider, reserved numbers 1-1023 */
dca97d00 63# define OSSL_FUNC_CORE_GETTABLE_PARAMS 1
26175013 64OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
d40b42ab 65 core_gettable_params,(const OSSL_CORE_HANDLE *prov))
4c2883a9 66# define OSSL_FUNC_CORE_GET_PARAMS 2
d40b42ab 67OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_CORE_HANDLE *prov,
4e7991b4 68 OSSL_PARAM params[]))
da747958 69# define OSSL_FUNC_CORE_THREAD_START 3
d40b42ab 70OSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_CORE_HANDLE *prov,
c9732f09
MC
71 OSSL_thread_stop_handler_fn handfn,
72 void *arg))
a829b735
DMSP
73# define OSSL_FUNC_CORE_GET_LIBCTX 4
74OSSL_CORE_MAKE_FUNC(OPENSSL_CORE_CTX *,core_get_libctx,
d40b42ab 75 (const OSSL_CORE_HANDLE *prov))
49c64346 76# define OSSL_FUNC_CORE_NEW_ERROR 5
d40b42ab 77OSSL_CORE_MAKE_FUNC(void,core_new_error,(const OSSL_CORE_HANDLE *prov))
49c64346
RL
78# define OSSL_FUNC_CORE_SET_ERROR_DEBUG 6
79OSSL_CORE_MAKE_FUNC(void,core_set_error_debug,
d40b42ab 80 (const OSSL_CORE_HANDLE *prov,
49c64346
RL
81 const char *file, int line, const char *func))
82# define OSSL_FUNC_CORE_VSET_ERROR 7
83OSSL_CORE_MAKE_FUNC(void,core_vset_error,
d40b42ab 84 (const OSSL_CORE_HANDLE *prov,
49c64346 85 uint32_t reason, const char *fmt, va_list args))
7b131de2 86# define OSSL_FUNC_CORE_SET_ERROR_MARK 8
d40b42ab 87OSSL_CORE_MAKE_FUNC(int, core_set_error_mark, (const OSSL_CORE_HANDLE *prov))
7b131de2
RL
88# define OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK 9
89OSSL_CORE_MAKE_FUNC(int, core_clear_last_error_mark,
d40b42ab 90 (const OSSL_CORE_HANDLE *prov))
d16d0b71 91# define OSSL_FUNC_CORE_POP_ERROR_TO_MARK 10
d40b42ab 92OSSL_CORE_MAKE_FUNC(int, core_pop_error_to_mark, (const OSSL_CORE_HANDLE *prov))
4c2883a9 93
97abae6a
MC
94
95/* Functions to access the OBJ database */
96
97#define OSSL_FUNC_CORE_OBJ_ADD_SIGID 11
98#define OSSL_FUNC_CORE_OBJ_CREATE 12
99
100OSSL_CORE_MAKE_FUNC(int, core_obj_add_sigid,
101 (const OSSL_CORE_HANDLE *prov, const char *sign_name,
102 const char *digest_name, const char *pkey_name))
103OSSL_CORE_MAKE_FUNC(int, core_obj_create,
104 (const OSSL_CORE_HANDLE *prov, const char *oid,
105 const char *sn, const char *ln))
106
b60cba3c 107/* Memory allocation, freeing, clearing. */
7b131de2 108#define OSSL_FUNC_CRYPTO_MALLOC 20
b60cba3c
RS
109OSSL_CORE_MAKE_FUNC(void *,
110 CRYPTO_malloc, (size_t num, const char *file, int line))
7b131de2 111#define OSSL_FUNC_CRYPTO_ZALLOC 21
b60cba3c
RS
112OSSL_CORE_MAKE_FUNC(void *,
113 CRYPTO_zalloc, (size_t num, const char *file, int line))
7b131de2 114#define OSSL_FUNC_CRYPTO_FREE 22
b60cba3c
RS
115OSSL_CORE_MAKE_FUNC(void,
116 CRYPTO_free, (void *ptr, const char *file, int line))
7b131de2 117#define OSSL_FUNC_CRYPTO_CLEAR_FREE 23
b60cba3c
RS
118OSSL_CORE_MAKE_FUNC(void,
119 CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line))
7b131de2 120#define OSSL_FUNC_CRYPTO_REALLOC 24
b60cba3c
RS
121OSSL_CORE_MAKE_FUNC(void *,
122 CRYPTO_realloc, (void *addr, size_t num, const char *file, int line))
7b131de2 123#define OSSL_FUNC_CRYPTO_CLEAR_REALLOC 25
b60cba3c 124OSSL_CORE_MAKE_FUNC(void *,
784883fc
SL
125 CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num,
126 const char *file, int line))
7b131de2 127#define OSSL_FUNC_CRYPTO_SECURE_MALLOC 26
b60cba3c
RS
128OSSL_CORE_MAKE_FUNC(void *,
129 CRYPTO_secure_malloc, (size_t num, const char *file, int line))
7b131de2 130#define OSSL_FUNC_CRYPTO_SECURE_ZALLOC 27
b60cba3c
RS
131OSSL_CORE_MAKE_FUNC(void *,
132 CRYPTO_secure_zalloc, (size_t num, const char *file, int line))
7b131de2 133#define OSSL_FUNC_CRYPTO_SECURE_FREE 28
b60cba3c
RS
134OSSL_CORE_MAKE_FUNC(void,
135 CRYPTO_secure_free, (void *ptr, const char *file, int line))
7b131de2 136#define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE 29
b60cba3c 137OSSL_CORE_MAKE_FUNC(void,
784883fc
SL
138 CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file,
139 int line))
7b131de2 140#define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED 30
b60cba3c
RS
141OSSL_CORE_MAKE_FUNC(int,
142 CRYPTO_secure_allocated, (const void *ptr))
7b131de2 143#define OSSL_FUNC_OPENSSL_CLEANSE 31
b60cba3c
RS
144OSSL_CORE_MAKE_FUNC(void,
145 OPENSSL_cleanse, (void *ptr, size_t len))
b60cba3c 146
25e60144 147/* Bio functions provided by the core */
7b131de2
RL
148#define OSSL_FUNC_BIO_NEW_FILE 40
149#define OSSL_FUNC_BIO_NEW_MEMBUF 41
150#define OSSL_FUNC_BIO_READ_EX 42
d40b42ab 151#define OSSL_FUNC_BIO_WRITE_EX 43
925b5360
P
152#define OSSL_FUNC_BIO_UP_REF 44
153#define OSSL_FUNC_BIO_FREE 45
154#define OSSL_FUNC_BIO_VPRINTF 46
155#define OSSL_FUNC_BIO_VSNPRINTF 47
156#define OSSL_FUNC_BIO_PUTS 48
157#define OSSL_FUNC_BIO_GETS 49
158#define OSSL_FUNC_BIO_CTRL 50
853ca128 159
d40b42ab
MC
160
161OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename,
162 const char *mode))
163OSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len))
164OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data,
165 size_t data_len, size_t *bytes_read))
166OSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data,
167 size_t data_len, size_t *written))
853ca128
RL
168OSSL_CORE_MAKE_FUNC(int, BIO_gets, (OSSL_CORE_BIO *bio, char *buf, int size))
169OSSL_CORE_MAKE_FUNC(int, BIO_puts, (OSSL_CORE_BIO *bio, const char *str))
925b5360 170OSSL_CORE_MAKE_FUNC(int, BIO_up_ref, (OSSL_CORE_BIO *bio))
d40b42ab
MC
171OSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio))
172OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format,
63665fff 173 va_list args))
d16d0b71
SL
174OSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf,
175 (char *buf, size_t n, const char *fmt, va_list args))
63f187cf
RL
176OSSL_CORE_MAKE_FUNC(int, BIO_ctrl, (OSSL_CORE_BIO *bio,
177 int cmd, long num, void *ptr))
25e60144 178
4cde7585 179/* New seeding functions prototypes with the 101-104 series */
5516d202
MSP
180#define OSSL_FUNC_CLEANUP_USER_ENTROPY 96
181#define OSSL_FUNC_CLEANUP_USER_NONCE 97
4cde7585
P
182#define OSSL_FUNC_GET_USER_ENTROPY 98
183#define OSSL_FUNC_GET_USER_NONCE 99
184
7b131de2 185#define OSSL_FUNC_SELF_TEST_CB 100
d40b42ab 186OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb,
36fc5fc6
SL
187 void **cbarg))
188
03bede0c
P
189/* Functions to get seed material from the operating system */
190#define OSSL_FUNC_GET_ENTROPY 101
191#define OSSL_FUNC_CLEANUP_ENTROPY 102
192#define OSSL_FUNC_GET_NONCE 103
193#define OSSL_FUNC_CLEANUP_NONCE 104
194OSSL_CORE_MAKE_FUNC(size_t, get_entropy, (const OSSL_CORE_HANDLE *handle,
195 unsigned char **pout, int entropy,
196 size_t min_len, size_t max_len))
4cde7585
P
197OSSL_CORE_MAKE_FUNC(size_t, get_user_entropy, (const OSSL_CORE_HANDLE *handle,
198 unsigned char **pout, int entropy,
199 size_t min_len, size_t max_len))
03bede0c
P
200OSSL_CORE_MAKE_FUNC(void, cleanup_entropy, (const OSSL_CORE_HANDLE *handle,
201 unsigned char *buf, size_t len))
5516d202
MSP
202OSSL_CORE_MAKE_FUNC(void, cleanup_user_entropy, (const OSSL_CORE_HANDLE *handle,
203 unsigned char *buf, size_t len))
03bede0c
P
204OSSL_CORE_MAKE_FUNC(size_t, get_nonce, (const OSSL_CORE_HANDLE *handle,
205 unsigned char **pout, size_t min_len,
206 size_t max_len, const void *salt,
207 size_t salt_len))
4cde7585
P
208OSSL_CORE_MAKE_FUNC(size_t, get_user_nonce, (const OSSL_CORE_HANDLE *handle,
209 unsigned char **pout, size_t min_len,
210 size_t max_len, const void *salt,
211 size_t salt_len))
03bede0c
P
212OSSL_CORE_MAKE_FUNC(void, cleanup_nonce, (const OSSL_CORE_HANDLE *handle,
213 unsigned char *buf, size_t len))
5516d202
MSP
214OSSL_CORE_MAKE_FUNC(void, cleanup_user_nonce, (const OSSL_CORE_HANDLE *handle,
215 unsigned char *buf, size_t len))
03bede0c 216
f12a5690 217/* Functions to access the core's providers */
7b88c184
MC
218#define OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB 105
219#define OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB 106
220#define OSSL_FUNC_PROVIDER_NAME 107
221#define OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX 108
222#define OSSL_FUNC_PROVIDER_GET0_DISPATCH 109
8c627075
MC
223#define OSSL_FUNC_PROVIDER_UP_REF 110
224#define OSSL_FUNC_PROVIDER_FREE 111
f12a5690 225
7b88c184
MC
226OSSL_CORE_MAKE_FUNC(int, provider_register_child_cb,
227 (const OSSL_CORE_HANDLE *handle,
228 int (*create_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata),
229 int (*remove_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata),
447588b6 230 int (*global_props_cb)(const char *props, void *cbdata),
7b88c184
MC
231 void *cbdata))
232OSSL_CORE_MAKE_FUNC(void, provider_deregister_child_cb,
233 (const OSSL_CORE_HANDLE *handle))
234OSSL_CORE_MAKE_FUNC(const char *, provider_name,
235 (const OSSL_CORE_HANDLE *prov))
236OSSL_CORE_MAKE_FUNC(void *, provider_get0_provider_ctx,
237 (const OSSL_CORE_HANDLE *prov))
238OSSL_CORE_MAKE_FUNC(const OSSL_DISPATCH *, provider_get0_dispatch,
239 (const OSSL_CORE_HANDLE *prov))
8c627075
MC
240OSSL_CORE_MAKE_FUNC(int, provider_up_ref,
241 (const OSSL_CORE_HANDLE *prov, int activate))
242OSSL_CORE_MAKE_FUNC(int, provider_free,
243 (const OSSL_CORE_HANDLE *prov, int deactivate))
f12a5690 244
4c2883a9 245/* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
72bfc958 246# define OSSL_FUNC_PROVIDER_TEARDOWN 1024
a39eb840 247OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
72bfc958 248# define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025
26175013 249OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
dca97d00 250 provider_gettable_params,(void *provctx))
72bfc958 251# define OSSL_FUNC_PROVIDER_GET_PARAMS 1026
a39eb840 252OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
4e7991b4 253 OSSL_PARAM params[]))
72bfc958 254# define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027
099bd339 255OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
b0f3c594 256 (void *provctx, int operation_id, int *no_store))
b0001d0c
P
257# define OSSL_FUNC_PROVIDER_UNQUERY_OPERATION 1028
258OSSL_CORE_MAKE_FUNC(void, provider_unquery_operation,
259 (void *provctx, int operation_id, const OSSL_ALGORITHM *))
260# define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1029
6ebc2f56
RL
261OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
262 (void *provctx))
b0001d0c 263# define OSSL_FUNC_PROVIDER_GET_CAPABILITIES 1030
72bfc958
MC
264OSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx,
265 const char *capability, OSSL_CALLBACK *cb, void *arg))
b0001d0c 266# define OSSL_FUNC_PROVIDER_SELF_TEST 1031
04cb5ec0 267OSSL_CORE_MAKE_FUNC(int, provider_self_test, (void *provctx))
4c2883a9 268
784883fc 269/* Operations */
3653d0c2 270
2893111f 271# define OSSL_OP_DIGEST 1
784883fc
SL
272# define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */
273# define OSSL_OP_MAC 3
ad1700c7 274# define OSSL_OP_KDF 4
15dfa092 275# define OSSL_OP_RAND 5
784883fc
SL
276# define OSSL_OP_KEYMGMT 10
277# define OSSL_OP_KEYEXCH 11
dfcb5d29 278# define OSSL_OP_SIGNATURE 12
2c938e2e 279# define OSSL_OP_ASYM_CIPHER 13
80f4fd18 280# define OSSL_OP_KEM 14
0d003c52 281/* New section for non-EVP operations */
8704b6bf
RL
282# define OSSL_OP_ENCODER 20
283# define OSSL_OP_DECODER 21
284# define OSSL_OP_STORE 22
784883fc 285/* Highest known operation number */
8704b6bf 286# define OSSL_OP__HIGHEST 22
784883fc
SL
287
288/* Digests */
2893111f
RL
289
290# define OSSL_FUNC_DIGEST_NEWCTX 1
291# define OSSL_FUNC_DIGEST_INIT 2
292# define OSSL_FUNC_DIGEST_UPDATE 3
293# define OSSL_FUNC_DIGEST_FINAL 4
294# define OSSL_FUNC_DIGEST_DIGEST 5
295# define OSSL_FUNC_DIGEST_FREECTX 6
296# define OSSL_FUNC_DIGEST_DUPCTX 7
297# define OSSL_FUNC_DIGEST_GET_PARAMS 8
92d9d0ae
RL
298# define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9
299# define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10
ae3ff60e
RL
300# define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11
301# define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12
302# define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13
53664908 303# define OSSL_FUNC_DIGEST_SQUEEZE 14
df05f2ce 304
363b1e5d 305OSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx))
480c8ef8 306OSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx, const OSSL_PARAM params[]))
363b1e5d 307OSSL_CORE_MAKE_FUNC(int, digest_update,
a39eb840 308 (void *dctx, const unsigned char *in, size_t inl))
363b1e5d 309OSSL_CORE_MAKE_FUNC(int, digest_final,
a39eb840
RL
310 (void *dctx,
311 unsigned char *out, size_t *outl, size_t outsz))
53664908 312OSSL_CORE_MAKE_FUNC(int, digest_squeeze,
313 (void *dctx,
314 unsigned char *out, size_t *outl, size_t outsz))
363b1e5d 315OSSL_CORE_MAKE_FUNC(int, digest_digest,
a39eb840 316 (void *provctx, const unsigned char *in, size_t inl,
8ccf2ffb 317 unsigned char *out, size_t *outl, size_t outsz))
df05f2ce 318
363b1e5d
DMSP
319OSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx))
320OSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx))
d5e5e2ff 321
363b1e5d
DMSP
322OSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[]))
323OSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params,
2893111f 324 (void *vctx, const OSSL_PARAM params[]))
363b1e5d 325OSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params,
2893111f 326 (void *vctx, OSSL_PARAM params[]))
18ec26ba
P
327OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params,
328 (void *provctx))
329OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params,
aa95e08b 330 (void *dctx, void *provctx))
18ec26ba 331OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params,
aa95e08b 332 (void *dctx, void *provctx))
df05f2ce
MC
333
334/* Symmetric Ciphers */
335
df05f2ce
MC
336# define OSSL_FUNC_CIPHER_NEWCTX 1
337# define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2
338# define OSSL_FUNC_CIPHER_DECRYPT_INIT 3
339# define OSSL_FUNC_CIPHER_UPDATE 4
340# define OSSL_FUNC_CIPHER_FINAL 5
718b133a
MC
341# define OSSL_FUNC_CIPHER_CIPHER 6
342# define OSSL_FUNC_CIPHER_FREECTX 7
343# define OSSL_FUNC_CIPHER_DUPCTX 8
80942379 344# define OSSL_FUNC_CIPHER_GET_PARAMS 9
92d9d0ae
RL
345# define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10
346# define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11
ae3ff60e
RL
347# define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12
348# define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13
349# define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14
df05f2ce 350
363b1e5d
DMSP
351OSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx))
352OSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx,
df05f2ce 353 const unsigned char *key,
344cfa34
MC
354 size_t keylen,
355 const unsigned char *iv,
480c8ef8
P
356 size_t ivlen,
357 const OSSL_PARAM params[]))
363b1e5d 358OSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx,
df05f2ce 359 const unsigned char *key,
344cfa34
MC
360 size_t keylen,
361 const unsigned char *iv,
480c8ef8
P
362 size_t ivlen,
363 const OSSL_PARAM params[]))
363b1e5d 364OSSL_CORE_MAKE_FUNC(int, cipher_update,
a39eb840
RL
365 (void *cctx,
366 unsigned char *out, size_t *outl, size_t outsize,
df05f2ce 367 const unsigned char *in, size_t inl))
363b1e5d 368OSSL_CORE_MAKE_FUNC(int, cipher_final,
a39eb840
RL
369 (void *cctx,
370 unsigned char *out, size_t *outl, size_t outsize))
363b1e5d 371OSSL_CORE_MAKE_FUNC(int, cipher_cipher,
a39eb840 372 (void *cctx,
f79858ac
RL
373 unsigned char *out, size_t *outl, size_t outsize,
374 const unsigned char *in, size_t inl))
363b1e5d
DMSP
375OSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx))
376OSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx))
377OSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[]))
378OSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx,
4e7991b4 379 OSSL_PARAM params[]))
363b1e5d 380OSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx,
718b133a 381 const OSSL_PARAM params[]))
18ec26ba
P
382OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params,
383 (void *provctx))
384OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params,
e79fb279 385 (void *cctx, void *provctx))
18ec26ba 386OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params,
e79fb279 387 (void *cctx, void *provctx))
df05f2ce 388
e74bd290
RL
389/* MACs */
390
e74bd290
RL
391# define OSSL_FUNC_MAC_NEWCTX 1
392# define OSSL_FUNC_MAC_DUPCTX 2
393# define OSSL_FUNC_MAC_FREECTX 3
394# define OSSL_FUNC_MAC_INIT 4
395# define OSSL_FUNC_MAC_UPDATE 5
396# define OSSL_FUNC_MAC_FINAL 6
784883fc
SL
397# define OSSL_FUNC_MAC_GET_PARAMS 7
398# define OSSL_FUNC_MAC_GET_CTX_PARAMS 8
399# define OSSL_FUNC_MAC_SET_CTX_PARAMS 9
400# define OSSL_FUNC_MAC_GETTABLE_PARAMS 10
401# define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11
402# define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12
e74bd290 403
363b1e5d
DMSP
404OSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx))
405OSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src))
406OSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx))
b58e1f74
P
407OSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx, const unsigned char *key,
408 size_t keylen, const OSSL_PARAM params[]))
363b1e5d 409OSSL_CORE_MAKE_FUNC(int, mac_update,
e74bd290 410 (void *mctx, const unsigned char *in, size_t inl))
363b1e5d 411OSSL_CORE_MAKE_FUNC(int, mac_final,
e74bd290
RL
412 (void *mctx,
413 unsigned char *out, size_t *outl, size_t outsize))
18ec26ba
P
414OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx))
415OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params,
5a7134ee 416 (void *mctx, void *provctx))
18ec26ba 417OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params,
5a7134ee 418 (void *mctx, void *provctx))
363b1e5d
DMSP
419OSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[]))
420OSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params,
e74bd290 421 (void *mctx, OSSL_PARAM params[]))
363b1e5d 422OSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params,
e74bd290
RL
423 (void *mctx, const OSSL_PARAM params[]))
424
2f755701 425/* KDFs and PRFs */
2f755701
P
426
427# define OSSL_FUNC_KDF_NEWCTX 1
428# define OSSL_FUNC_KDF_DUPCTX 2
429# define OSSL_FUNC_KDF_FREECTX 3
430# define OSSL_FUNC_KDF_RESET 4
431# define OSSL_FUNC_KDF_DERIVE 5
432# define OSSL_FUNC_KDF_GETTABLE_PARAMS 6
433# define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7
434# define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8
435# define OSSL_FUNC_KDF_GET_PARAMS 9
436# define OSSL_FUNC_KDF_GET_CTX_PARAMS 10
437# define OSSL_FUNC_KDF_SET_CTX_PARAMS 11
438
363b1e5d
DMSP
439OSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx))
440OSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src))
441OSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx))
442OSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx))
443OSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key,
a9603292 444 size_t keylen, const OSSL_PARAM params[]))
18ec26ba
P
445OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx))
446OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params,
de43d82b 447 (void *kctx, void *provctx))
18ec26ba 448OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params,
de43d82b 449 (void *kctx, void *provctx))
363b1e5d
DMSP
450OSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[]))
451OSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params,
2f755701 452 (void *kctx, OSSL_PARAM params[]))
363b1e5d 453OSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params,
2f755701
P
454 (void *kctx, const OSSL_PARAM params[]))
455
15dfa092
P
456/* RAND */
457
458# define OSSL_FUNC_RAND_NEWCTX 1
459# define OSSL_FUNC_RAND_FREECTX 2
460# define OSSL_FUNC_RAND_INSTANTIATE 3
461# define OSSL_FUNC_RAND_UNINSTANTIATE 4
462# define OSSL_FUNC_RAND_GENERATE 5
463# define OSSL_FUNC_RAND_RESEED 6
464# define OSSL_FUNC_RAND_NONCE 7
465# define OSSL_FUNC_RAND_ENABLE_LOCKING 8
466# define OSSL_FUNC_RAND_LOCK 9
467# define OSSL_FUNC_RAND_UNLOCK 10
468# define OSSL_FUNC_RAND_GETTABLE_PARAMS 11
469# define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS 12
470# define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS 13
471# define OSSL_FUNC_RAND_GET_PARAMS 14
472# define OSSL_FUNC_RAND_GET_CTX_PARAMS 15
473# define OSSL_FUNC_RAND_SET_CTX_PARAMS 16
7d615e21 474# define OSSL_FUNC_RAND_VERIFY_ZEROIZATION 17
78436fd1
P
475# define OSSL_FUNC_RAND_GET_SEED 18
476# define OSSL_FUNC_RAND_CLEAR_SEED 19
15dfa092 477
363b1e5d 478OSSL_CORE_MAKE_FUNC(void *,rand_newctx,
f000e828 479 (void *provctx, void *parent,
15dfa092 480 const OSSL_DISPATCH *parent_calls))
363b1e5d
DMSP
481OSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx))
482OSSL_CORE_MAKE_FUNC(int,rand_instantiate,
714a1bb3
P
483 (void *vdrbg, unsigned int strength,
484 int prediction_resistance,
dbf299f7
P
485 const unsigned char *pstr, size_t pstr_len,
486 const OSSL_PARAM params[]))
363b1e5d
DMSP
487OSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg))
488OSSL_CORE_MAKE_FUNC(int,rand_generate,
15dfa092 489 (void *vctx, unsigned char *out, size_t outlen,
714a1bb3 490 unsigned int strength, int prediction_resistance,
15dfa092 491 const unsigned char *addin, size_t addin_len))
363b1e5d 492OSSL_CORE_MAKE_FUNC(int,rand_reseed,
15dfa092 493 (void *vctx, int prediction_resistance,
714a1bb3 494 const unsigned char *ent, size_t ent_len,
15dfa092 495 const unsigned char *addin, size_t addin_len))
363b1e5d 496OSSL_CORE_MAKE_FUNC(size_t,rand_nonce,
f000e828 497 (void *vctx, unsigned char *out, unsigned int strength,
714a1bb3 498 size_t min_noncelen, size_t max_noncelen))
363b1e5d
DMSP
499OSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx))
500OSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx))
501OSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx))
18ec26ba
P
502OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx))
503OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params,
1c9eaf42 504 (void *vctx, void *provctx))
18ec26ba 505OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params,
1c9eaf42 506 (void *vctx, void *provctx))
363b1e5d
DMSP
507OSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[]))
508OSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params,
15dfa092 509 (void *vctx, OSSL_PARAM params[]))
363b1e5d 510OSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params,
15dfa092 511 (void *vctx, const OSSL_PARAM params[]))
363b1e5d 512OSSL_CORE_MAKE_FUNC(void,rand_set_callbacks,
f000e828
P
513 (void *vctx, OSSL_INOUT_CALLBACK *get_entropy,
514 OSSL_CALLBACK *cleanup_entropy,
515 OSSL_INOUT_CALLBACK *get_nonce,
516 OSSL_CALLBACK *cleanup_nonce, void *arg))
363b1e5d 517OSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization,
714a1bb3 518 (void *vctx))
78436fd1
P
519OSSL_CORE_MAKE_FUNC(size_t,rand_get_seed,
520 (void *vctx, unsigned char **buffer,
521 int entropy, size_t min_len, size_t max_len,
522 int prediction_resistance,
523 const unsigned char *adin, size_t adin_len))
524OSSL_CORE_MAKE_FUNC(void,rand_clear_seed,
525 (void *vctx, unsigned char *buffer, size_t b_len))
15dfa092 526
a94a3e0d
RL
527/*-
528 * Key management
529 *
b305452f
RL
530 * The Key Management takes care of provider side key objects, and includes
531 * all current functionality to create them, destroy them, set parameters
532 * and key material, etc, essentially everything that manipulates the keys
533 * themselves and their parameters.
a94a3e0d 534 *
e304aa87 535 * The key objects are commonly referred to as |keydata|, and it MUST be able
b305452f
RL
536 * to contain parameters if the key has any, the public key and the private
537 * key. All parts are optional, but their presence determines what can be
538 * done with the key object in terms of encryption, signature, and so on.
539 * The assumption from libcrypto is that the key object contains any of the
540 * following data combinations:
541 *
542 * - parameters only
543 * - public key only
544 * - public key + private key
545 * - parameters + public key
546 * - parameters + public key + private key
547 *
548 * What "parameters", "public key" and "private key" means in detail is left
549 * to the implementation. In the case of DH and DSA, they would typically
550 * include domain parameters, while for certain variants of RSA, they would
551 * typically include PSS or OAEP parameters.
552 *
363b1e5d
DMSP
553 * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with
554 * OSSL_FUNC_keymgmt_free(). Key objects can have data filled in with
555 * OSSL_FUNC_keymgmt_import().
b305452f
RL
556 *
557 * Three functions are made available to check what selection of data is
363b1e5d
DMSP
558 * present in a key object: OSSL_FUNC_keymgmt_has_parameters(),
559 * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(),
a94a3e0d
RL
560 */
561
b305452f
RL
562/* Key data subset selection - individual bits */
563# define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01
564# define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02
565# define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04
566# define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80
567
568/* Key data subset selection - combinations */
569# define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \
570 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \
571 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
572# define OSSL_KEYMGMT_SELECT_KEYPAIR \
573 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
574# define OSSL_KEYMGMT_SELECT_ALL \
575 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
576
899e2564
MC
577# define OSSL_KEYMGMT_VALIDATE_FULL_CHECK 0
578# define OSSL_KEYMGMT_VALIDATE_QUICK_CHECK 1
579
1a5632e0 580/* Basic key object creation */
b305452f 581# define OSSL_FUNC_KEYMGMT_NEW 1
363b1e5d 582OSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx))
1a5632e0
RL
583
584/* Generation, a more complex constructor */
2b9add69
RL
585# define OSSL_FUNC_KEYMGMT_GEN_INIT 2
586# define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE 3
587# define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS 4
588# define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS 5
5e77b79a
SL
589# define OSSL_FUNC_KEYMGMT_GEN 6
590# define OSSL_FUNC_KEYMGMT_GEN_CLEANUP 7
363b1e5d 591OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init,
2faea853 592 (void *provctx, int selection, const OSSL_PARAM params[]))
363b1e5d 593OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template,
1a5632e0 594 (void *genctx, void *templ))
363b1e5d 595OSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params,
1a5632e0
RL
596 (void *genctx, const OSSL_PARAM params[]))
597OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
fb67126e
TM
598 keymgmt_gen_settable_params,
599 (void *genctx, void *provctx))
363b1e5d 600OSSL_CORE_MAKE_FUNC(void *, keymgmt_gen,
1a5632e0 601 (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
363b1e5d 602OSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx))
1a5632e0 603
5dacb38c
RL
604/* Key loading by object reference */
605# define OSSL_FUNC_KEYMGMT_LOAD 8
606OSSL_CORE_MAKE_FUNC(void *, keymgmt_load,
607 (const void *reference, size_t reference_sz))
608
1a5632e0 609/* Basic key object destruction */
2b9add69 610# define OSSL_FUNC_KEYMGMT_FREE 10
363b1e5d 611OSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata))
b305452f
RL
612
613/* Key object information, with discovery */
2b9add69
RL
614#define OSSL_FUNC_KEYMGMT_GET_PARAMS 11
615#define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 12
363b1e5d 616OSSL_CORE_MAKE_FUNC(int, keymgmt_get_params,
b305452f 617 (void *keydata, OSSL_PARAM params[]))
16df436d
NT
618OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params,
619 (void *provctx))
b305452f 620
2b9add69
RL
621#define OSSL_FUNC_KEYMGMT_SET_PARAMS 13
622#define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 14
363b1e5d 623OSSL_CORE_MAKE_FUNC(int, keymgmt_set_params,
4fe54d67 624 (void *keydata, const OSSL_PARAM params[]))
16df436d
NT
625OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params,
626 (void *provctx))
4fe54d67 627
b305452f
RL
628/* Key checks - discovery of supported operations */
629# define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20
363b1e5d 630OSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name,
e62a45b6
RL
631 (int operation_id))
632
b305452f
RL
633/* Key checks - key data content checks */
634# define OSSL_FUNC_KEYMGMT_HAS 21
3d914185 635OSSL_CORE_MAKE_FUNC(int, keymgmt_has, (const void *keydata, int selection))
b305452f
RL
636
637/* Key checks - validation */
638# define OSSL_FUNC_KEYMGMT_VALIDATE 22
899e2564
MC
639OSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (const void *keydata, int selection,
640 int checktype))
b305452f 641
bee5d6cd
RL
642/* Key checks - matching */
643# define OSSL_FUNC_KEYMGMT_MATCH 23
363b1e5d 644OSSL_CORE_MAKE_FUNC(int, keymgmt_match,
bee5d6cd
RL
645 (const void *keydata1, const void *keydata2,
646 int selection))
647
13697f1c 648/* Import and export functions, with discovery */
b305452f
RL
649# define OSSL_FUNC_KEYMGMT_IMPORT 40
650# define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41
651# define OSSL_FUNC_KEYMGMT_EXPORT 42
652# define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43
363b1e5d 653OSSL_CORE_MAKE_FUNC(int, keymgmt_import,
b305452f 654 (void *keydata, int selection, const OSSL_PARAM params[]))
363b1e5d 655OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types,
b305452f 656 (int selection))
363b1e5d 657OSSL_CORE_MAKE_FUNC(int, keymgmt_export,
b305452f
RL
658 (void *keydata, int selection,
659 OSSL_CALLBACK *param_cb, void *cbarg))
363b1e5d 660OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types,
b305452f 661 (int selection))
12603de6 662
4a9fe33c 663/* Dup function, constructor */
85fcc3fb 664# define OSSL_FUNC_KEYMGMT_DUP 44
4a9fe33c 665OSSL_CORE_MAKE_FUNC(void *, keymgmt_dup,
b4f447c0 666 (const void *keydata_from, int selection))
13697f1c 667
5e3b8450
IF
668/* Extended import and export functions */
669# define OSSL_FUNC_KEYMGMT_IMPORT_TYPES_EX 45
670# define OSSL_FUNC_KEYMGMT_EXPORT_TYPES_EX 46
671OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types_ex,
672 (void *provctx, int selection))
673OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types_ex,
674 (void *provctx, int selection))
675
ff64702b
MC
676/* Key Exchange */
677
ff64702b
MC
678# define OSSL_FUNC_KEYEXCH_NEWCTX 1
679# define OSSL_FUNC_KEYEXCH_INIT 2
680# define OSSL_FUNC_KEYEXCH_DERIVE 3
681# define OSSL_FUNC_KEYEXCH_SET_PEER 4
682# define OSSL_FUNC_KEYEXCH_FREECTX 5
683# define OSSL_FUNC_KEYEXCH_DUPCTX 6
9c45222d
MC
684# define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7
685# define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8
4fe54d67
NT
686# define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9
687# define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10
ff64702b 688
363b1e5d 689OSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx))
480c8ef8
P
690OSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey,
691 const OSSL_PARAM params[]))
363b1e5d 692OSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx, unsigned char *secret,
59972370 693 size_t *secretlen, size_t outlen))
363b1e5d
DMSP
694OSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey))
695OSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx))
696OSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx))
697OSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx,
9c45222d 698 const OSSL_PARAM params[]))
363b1e5d 699OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params,
fb67126e 700 (void *ctx, void *provctx))
363b1e5d 701OSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx,
4fe54d67 702 OSSL_PARAM params[]))
363b1e5d 703OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params,
fb67126e 704 (void *ctx, void *provctx))
ff64702b 705
dfcb5d29
MC
706/* Signature */
707
708# define OSSL_FUNC_SIGNATURE_NEWCTX 1
709# define OSSL_FUNC_SIGNATURE_SIGN_INIT 2
710# define OSSL_FUNC_SIGNATURE_SIGN 3
390acbeb
MC
711# define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4
712# define OSSL_FUNC_SIGNATURE_VERIFY 5
713# define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6
714# define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7
d8c98d79
MC
715# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8
716# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9
717# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10
eea1e780
MC
718# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11
719# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12
720# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13
721# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14
722# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15
723# define OSSL_FUNC_SIGNATURE_FREECTX 16
724# define OSSL_FUNC_SIGNATURE_DUPCTX 17
725# define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18
726# define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19
727# define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20
728# define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21
729# define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22
730# define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
731# define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24
732# define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
dfcb5d29 733
363b1e5d 734OSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx,
2c6094ba 735 const char *propq))
480c8ef8
P
736OSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey,
737 const OSSL_PARAM params[]))
363b1e5d 738OSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx, unsigned char *sig,
dfcb5d29
MC
739 size_t *siglen, size_t sigsize,
740 const unsigned char *tbs,
741 size_t tbslen))
480c8ef8
P
742OSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey,
743 const OSSL_PARAM params[]))
363b1e5d 744OSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx,
390acbeb
MC
745 const unsigned char *sig,
746 size_t siglen,
747 const unsigned char *tbs,
748 size_t tbslen))
480c8ef8
P
749OSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init,
750 (void *ctx, void *provkey, const OSSL_PARAM params[]))
751OSSL_CORE_MAKE_FUNC(int, signature_verify_recover,
752 (void *ctx, unsigned char *rout, size_t *routlen,
753 size_t routsize, const unsigned char *sig, size_t siglen))
363b1e5d 754OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init,
480c8ef8
P
755 (void *ctx, const char *mdname, void *provkey,
756 const OSSL_PARAM params[]))
363b1e5d 757OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update,
d8c98d79 758 (void *ctx, const unsigned char *data, size_t datalen))
363b1e5d 759OSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final,
d8c98d79
MC
760 (void *ctx, unsigned char *sig, size_t *siglen,
761 size_t sigsize))
363b1e5d 762OSSL_CORE_MAKE_FUNC(int, signature_digest_sign,
eea1e780
MC
763 (void *ctx, unsigned char *sigret, size_t *siglen,
764 size_t sigsize, const unsigned char *tbs, size_t tbslen))
363b1e5d 765OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init,
480c8ef8
P
766 (void *ctx, const char *mdname, void *provkey,
767 const OSSL_PARAM params[]))
363b1e5d 768OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update,
d8c98d79 769 (void *ctx, const unsigned char *data, size_t datalen))
363b1e5d 770OSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final,
d8c98d79 771 (void *ctx, const unsigned char *sig, size_t siglen))
363b1e5d 772OSSL_CORE_MAKE_FUNC(int, signature_digest_verify,
eea1e780
MC
773 (void *ctx, const unsigned char *sig, size_t siglen,
774 const unsigned char *tbs, size_t tbslen))
363b1e5d
DMSP
775OSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx))
776OSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx))
777OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params,
9c45222d 778 (void *ctx, OSSL_PARAM params[]))
363b1e5d 779OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params,
fb67126e 780 (void *ctx, void *provctx))
363b1e5d 781OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params,
9c45222d 782 (void *ctx, const OSSL_PARAM params[]))
363b1e5d 783OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params,
fb67126e 784 (void *ctx, void *provctx))
363b1e5d 785OSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params,
d8c98d79 786 (void *ctx, OSSL_PARAM params[]))
363b1e5d 787OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params,
d8c98d79 788 (void *ctx))
363b1e5d 789OSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params,
d8c98d79 790 (void *ctx, const OSSL_PARAM params[]))
363b1e5d 791OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params,
d8c98d79 792 (void *ctx))
dfcb5d29 793
2c938e2e
MC
794
795/* Asymmetric Ciphers */
796
797# define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1
798# define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2
799# define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3
800# define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4
801# define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5
802# define OSSL_FUNC_ASYM_CIPHER_FREECTX 6
803# define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7
804# define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8
805# define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9
806# define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10
807# define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11
808
363b1e5d 809OSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx))
480c8ef8
P
810OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey,
811 const OSSL_PARAM params[]))
363b1e5d 812OSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out,
2c938e2e
MC
813 size_t *outlen,
814 size_t outsize,
815 const unsigned char *in,
816 size_t inlen))
480c8ef8
P
817OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey,
818 const OSSL_PARAM params[]))
363b1e5d 819OSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out,
2c938e2e
MC
820 size_t *outlen,
821 size_t outsize,
822 const unsigned char *in,
823 size_t inlen))
363b1e5d
DMSP
824OSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx))
825OSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx))
826OSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params,
2c938e2e 827 (void *ctx, OSSL_PARAM params[]))
363b1e5d 828OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params,
fb67126e 829 (void *ctx, void *provctx))
363b1e5d 830OSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params,
2c938e2e 831 (void *ctx, const OSSL_PARAM params[]))
363b1e5d 832OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params,
fb67126e 833 (void *ctx, void *provctx))
2c938e2e 834
80f4fd18
SL
835/* Asymmetric Key encapsulation */
836# define OSSL_FUNC_KEM_NEWCTX 1
837# define OSSL_FUNC_KEM_ENCAPSULATE_INIT 2
838# define OSSL_FUNC_KEM_ENCAPSULATE 3
839# define OSSL_FUNC_KEM_DECAPSULATE_INIT 4
840# define OSSL_FUNC_KEM_DECAPSULATE 5
841# define OSSL_FUNC_KEM_FREECTX 6
842# define OSSL_FUNC_KEM_DUPCTX 7
843# define OSSL_FUNC_KEM_GET_CTX_PARAMS 8
844# define OSSL_FUNC_KEM_GETTABLE_CTX_PARAMS 9
845# define OSSL_FUNC_KEM_SET_CTX_PARAMS 10
846# define OSSL_FUNC_KEM_SETTABLE_CTX_PARAMS 11
78c44b05 847# define OSSL_FUNC_KEM_AUTH_ENCAPSULATE_INIT 12
848# define OSSL_FUNC_KEM_AUTH_DECAPSULATE_INIT 13
80f4fd18
SL
849
850OSSL_CORE_MAKE_FUNC(void *, kem_newctx, (void *provctx))
480c8ef8
P
851OSSL_CORE_MAKE_FUNC(int, kem_encapsulate_init, (void *ctx, void *provkey,
852 const OSSL_PARAM params[]))
78c44b05 853OSSL_CORE_MAKE_FUNC(int, kem_auth_encapsulate_init, (void *ctx, void *provkey,
854 void *authprivkey,
855 const OSSL_PARAM params[]))
80f4fd18
SL
856OSSL_CORE_MAKE_FUNC(int, kem_encapsulate, (void *ctx,
857 unsigned char *out, size_t *outlen,
858 unsigned char *secret,
859 size_t *secretlen))
480c8ef8
P
860OSSL_CORE_MAKE_FUNC(int, kem_decapsulate_init, (void *ctx, void *provkey,
861 const OSSL_PARAM params[]))
78c44b05 862OSSL_CORE_MAKE_FUNC(int, kem_auth_decapsulate_init, (void *ctx, void *provkey,
863 void *authpubkey,
864 const OSSL_PARAM params[]))
80f4fd18
SL
865OSSL_CORE_MAKE_FUNC(int, kem_decapsulate, (void *ctx,
866 unsigned char *out, size_t *outlen,
867 const unsigned char *in, size_t inlen))
868OSSL_CORE_MAKE_FUNC(void, kem_freectx, (void *ctx))
869OSSL_CORE_MAKE_FUNC(void *, kem_dupctx, (void *ctx))
870OSSL_CORE_MAKE_FUNC(int, kem_get_ctx_params, (void *ctx, OSSL_PARAM params[]))
fb67126e
TM
871OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_gettable_ctx_params,
872 (void *ctx, void *provctx))
80f4fd18
SL
873OSSL_CORE_MAKE_FUNC(int, kem_set_ctx_params,
874 (void *ctx, const OSSL_PARAM params[]))
fb67126e
TM
875OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_settable_ctx_params,
876 (void *ctx, void *provctx))
80f4fd18 877
ece9304c
RL
878/* Encoders and decoders */
879# define OSSL_FUNC_ENCODER_NEWCTX 1
880# define OSSL_FUNC_ENCODER_FREECTX 2
5a6d6fe6
RL
881# define OSSL_FUNC_ENCODER_GET_PARAMS 3
882# define OSSL_FUNC_ENCODER_GETTABLE_PARAMS 4
883# define OSSL_FUNC_ENCODER_SET_CTX_PARAMS 5
884# define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS 6
cd861ab7
RL
885# define OSSL_FUNC_ENCODER_DOES_SELECTION 10
886# define OSSL_FUNC_ENCODER_ENCODE 11
5a6d6fe6
RL
887# define OSSL_FUNC_ENCODER_IMPORT_OBJECT 20
888# define OSSL_FUNC_ENCODER_FREE_OBJECT 21
ece9304c
RL
889OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx))
890OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx))
5a6d6fe6
RL
891OSSL_CORE_MAKE_FUNC(int, encoder_get_params, (OSSL_PARAM params[]))
892OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_gettable_params,
893 (void *provctx))
ece9304c 894OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params,
0d003c52 895 (void *ctx, const OSSL_PARAM params[]))
ece9304c 896OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params,
18ec26ba 897 (void *provctx))
0d003c52 898
cd861ab7
RL
899OSSL_CORE_MAKE_FUNC(int, encoder_does_selection,
900 (void *provctx, int selection))
5a6d6fe6
RL
901OSSL_CORE_MAKE_FUNC(int, encoder_encode,
902 (void *ctx, OSSL_CORE_BIO *out,
903 const void *obj_raw, const OSSL_PARAM obj_abstract[],
904 int selection,
0d003c52
RL
905 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
906
5a6d6fe6
RL
907OSSL_CORE_MAKE_FUNC(void *, encoder_import_object,
908 (void *ctx, int selection, const OSSL_PARAM params[]))
909OSSL_CORE_MAKE_FUNC(void, encoder_free_object, (void *obj))
910
ece9304c
RL
911# define OSSL_FUNC_DECODER_NEWCTX 1
912# define OSSL_FUNC_DECODER_FREECTX 2
913# define OSSL_FUNC_DECODER_GET_PARAMS 3
914# define OSSL_FUNC_DECODER_GETTABLE_PARAMS 4
915# define OSSL_FUNC_DECODER_SET_CTX_PARAMS 5
916# define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS 6
67c91ca2
RL
917# define OSSL_FUNC_DECODER_DOES_SELECTION 10
918# define OSSL_FUNC_DECODER_DECODE 11
919# define OSSL_FUNC_DECODER_EXPORT_OBJECT 20
ece9304c
RL
920OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx))
921OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx))
922OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[]))
923OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params,
18ec26ba 924 (void *provctx))
ece9304c 925OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params,
c3e4c1f3 926 (void *ctx, const OSSL_PARAM params[]))
ece9304c 927OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params,
18ec26ba 928 (void *provctx))
c3e4c1f3 929
67c91ca2
RL
930OSSL_CORE_MAKE_FUNC(int, decoder_does_selection,
931 (void *provctx, int selection))
ece9304c 932OSSL_CORE_MAKE_FUNC(int, decoder_decode,
67c91ca2 933 (void *ctx, OSSL_CORE_BIO *in, int selection,
bd6e7fb7 934 OSSL_CALLBACK *data_cb, void *data_cbarg,
c3e4c1f3 935 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
ece9304c 936OSSL_CORE_MAKE_FUNC(int, decoder_export_object,
c3e4c1f3
RL
937 (void *ctx, const void *objref, size_t objref_sz,
938 OSSL_CALLBACK *export_cb, void *export_cbarg))
939
8704b6bf
RL
940/*-
941 * Store
942 *
943 * Objects are scanned by using the 'open', 'load', 'eof' and 'close'
944 * functions, which implement an OSSL_STORE loader.
945 *
946 * store_load() works in a way that's very similar to the decoders, in
947 * that they pass an abstract object through a callback, either as a DER
948 * octet string or as an object reference, which libcrypto will have to
949 * deal with.
950 */
951
952#define OSSL_FUNC_STORE_OPEN 1
953#define OSSL_FUNC_STORE_ATTACH 2
954#define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS 3
955#define OSSL_FUNC_STORE_SET_CTX_PARAMS 4
956#define OSSL_FUNC_STORE_LOAD 5
957#define OSSL_FUNC_STORE_EOF 6
958#define OSSL_FUNC_STORE_CLOSE 7
959#define OSSL_FUNC_STORE_EXPORT_OBJECT 8
0a8807b4 960#define OSSL_FUNC_STORE_DELETE 9
96e67808 961#define OSSL_FUNC_STORE_OPEN_EX 10
8704b6bf
RL
962OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri))
963OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in))
964OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params,
965 (void *provctx))
966OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params,
967 (void *loaderctx, const OSSL_PARAM params[]))
968OSSL_CORE_MAKE_FUNC(int, store_load,
969 (void *loaderctx,
970 OSSL_CALLBACK *object_cb, void *object_cbarg,
971 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
972OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx))
973OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx))
974OSSL_CORE_MAKE_FUNC(int, store_export_object,
975 (void *loaderctx, const void *objref, size_t objref_sz,
976 OSSL_CALLBACK *export_cb, void *export_cbarg))
0a8807b4
DB
977OSSL_CORE_MAKE_FUNC(int, store_delete,
978 (void *provctx, const char *uri, const OSSL_PARAM params[],
979 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
96e67808
SS
980OSSL_CORE_MAKE_FUNC(void *, store_open_ex,
981 (void *provctx, const char *uri, const OSSL_PARAM params[],
982 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
8704b6bf 983
4c2883a9
RL
984# ifdef __cplusplus
985}
986# endif
987
988#endif