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