1254721Semaste/*
2254721Semaste * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
3254721Semaste *
4254721Semaste * Licensed under the Apache License 2.0 (the "License").  You may not use
5254721Semaste * this file except in compliance with the License.  You can obtain a copy
6254721Semaste * in the file LICENSE in the source distribution or at
7254721Semaste * https://www.openssl.org/source/license.html
8254721Semaste */
9254721Semaste
10254721Semaste#ifndef OPENSSL_CORE_NUMBERS_H
11254721Semaste# define OPENSSL_CORE_NUMBERS_H
12254721Semaste# pragma once
13254721Semaste
14254721Semaste# include <stdarg.h>
15254721Semaste# include <openssl/core.h>
16254721Semaste
17254721Semaste# ifdef __cplusplus
18254721Semasteextern "C" {
19254721Semaste# endif
20254721Semaste
21254721Semaste/*-
22254721Semaste * Identities
23254721Semaste * ----------
24254721Semaste *
25254721Semaste * All series start with 1, to allow 0 to be an array terminator.
26254721Semaste * For any FUNC identity, we also provide a function signature typedef
27254721Semaste * and a static inline function to extract a function pointer from a
28254721Semaste * OSSL_DISPATCH element in a type safe manner.
29254721Semaste *
30254721Semaste * Names:
31254721Semaste * for any function base name 'foo' (uppercase form 'FOO'), we will have
32254721Semaste * the following:
33254721Semaste * - a macro for the identity with the name OSSL_FUNC_'FOO' or derivatives
34254721Semaste *   thereof (to be specified further down)
35254721Semaste * - a function signature typedef with the name OSSL_FUNC_'foo'_fn
36254721Semaste * - a function pointer extractor function with the name OSSL_FUNC_'foo'
37254721Semaste */
38254721Semaste
39254721Semaste/*
40254721Semaste * Helper macro to create the function signature typedef and the extractor
41254721Semaste * |type| is the return-type of the function, |name| is the name of the
42254721Semaste * function to fetch, and |args| is a parenthesized list of parameters
43254721Semaste * for the function (that is, it is |name|'s function signature).
44254721Semaste * Note: This is considered a "reserved" internal macro. Applications should
45254721Semaste * not use this or assume its existence.
46254721Semaste */
47254721Semaste#define OSSL_CORE_MAKE_FUNC(type,name,args)                             \
48254721Semaste    typedef type (OSSL_FUNC_##name##_fn)args;                           \
49254721Semaste    static ossl_unused ossl_inline \
50254721Semaste    OSSL_FUNC_##name##_fn *OSSL_FUNC_##name(const OSSL_DISPATCH *opf)   \
51254721Semaste    {                                                                   \
52254721Semaste        return (OSSL_FUNC_##name##_fn *)opf->function;                  \
53254721Semaste    }
54254721Semaste
55254721Semaste/*
56254721Semaste * Core function identities, for the two OSSL_DISPATCH tables being passed
57254721Semaste * in the OSSL_provider_init call.
58254721Semaste *
59254721Semaste * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must
60254721Semaste * therefore NEVER be used as a function identity.
61254721Semaste */
62254721Semaste/* Functions provided by the Core to the provider, reserved numbers 1-1023 */
63254721Semaste# define OSSL_FUNC_CORE_GETTABLE_PARAMS        1
64254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
65254721Semaste                    core_gettable_params,(const OSSL_CORE_HANDLE *prov))
66254721Semaste# define OSSL_FUNC_CORE_GET_PARAMS             2
67254721SemasteOSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_CORE_HANDLE *prov,
68254721Semaste                                         OSSL_PARAM params[]))
69254721Semaste# define OSSL_FUNC_CORE_THREAD_START           3
70254721SemasteOSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_CORE_HANDLE *prov,
71254721Semaste                                           OSSL_thread_stop_handler_fn handfn,
72254721Semaste                                           void *arg))
73254721Semaste# define OSSL_FUNC_CORE_GET_LIBCTX             4
74254721SemasteOSSL_CORE_MAKE_FUNC(OPENSSL_CORE_CTX *,core_get_libctx,
75254721Semaste                    (const OSSL_CORE_HANDLE *prov))
76254721Semaste# define OSSL_FUNC_CORE_NEW_ERROR              5
77254721SemasteOSSL_CORE_MAKE_FUNC(void,core_new_error,(const OSSL_CORE_HANDLE *prov))
78254721Semaste# define OSSL_FUNC_CORE_SET_ERROR_DEBUG        6
79254721SemasteOSSL_CORE_MAKE_FUNC(void,core_set_error_debug,
80254721Semaste                    (const OSSL_CORE_HANDLE *prov,
81254721Semaste                     const char *file, int line, const char *func))
82254721Semaste# define OSSL_FUNC_CORE_VSET_ERROR             7
83254721SemasteOSSL_CORE_MAKE_FUNC(void,core_vset_error,
84254721Semaste                    (const OSSL_CORE_HANDLE *prov,
85254721Semaste                     uint32_t reason, const char *fmt, va_list args))
86254721Semaste# define OSSL_FUNC_CORE_SET_ERROR_MARK         8
87254721SemasteOSSL_CORE_MAKE_FUNC(int, core_set_error_mark, (const OSSL_CORE_HANDLE *prov))
88254721Semaste# define OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK  9
89254721SemasteOSSL_CORE_MAKE_FUNC(int, core_clear_last_error_mark,
90254721Semaste                    (const OSSL_CORE_HANDLE *prov))
91254721Semaste# define OSSL_FUNC_CORE_POP_ERROR_TO_MARK     10
92254721SemasteOSSL_CORE_MAKE_FUNC(int, core_pop_error_to_mark, (const OSSL_CORE_HANDLE *prov))
93254721Semaste
94254721Semaste
95254721Semaste/* Functions to access the OBJ database */
96254721Semaste
97254721Semaste#define OSSL_FUNC_CORE_OBJ_ADD_SIGID          11
98254721Semaste#define OSSL_FUNC_CORE_OBJ_CREATE             12
99254721Semaste
100254721SemasteOSSL_CORE_MAKE_FUNC(int, core_obj_add_sigid,
101254721Semaste                    (const OSSL_CORE_HANDLE *prov, const char  *sign_name,
102254721Semaste                     const char *digest_name, const char *pkey_name))
103254721SemasteOSSL_CORE_MAKE_FUNC(int, core_obj_create,
104254721Semaste                    (const OSSL_CORE_HANDLE *prov, const char *oid,
105254721Semaste                     const char *sn, const char *ln))
106254721Semaste
107254721Semaste/* Memory allocation, freeing, clearing. */
108254721Semaste#define OSSL_FUNC_CRYPTO_MALLOC               20
109254721SemasteOSSL_CORE_MAKE_FUNC(void *,
110254721Semaste        CRYPTO_malloc, (size_t num, const char *file, int line))
111254721Semaste#define OSSL_FUNC_CRYPTO_ZALLOC               21
112254721SemasteOSSL_CORE_MAKE_FUNC(void *,
113254721Semaste        CRYPTO_zalloc, (size_t num, const char *file, int line))
114254721Semaste#define OSSL_FUNC_CRYPTO_FREE                 22
115254721SemasteOSSL_CORE_MAKE_FUNC(void,
116254721Semaste        CRYPTO_free, (void *ptr, const char *file, int line))
117254721Semaste#define OSSL_FUNC_CRYPTO_CLEAR_FREE           23
118254721SemasteOSSL_CORE_MAKE_FUNC(void,
119254721Semaste        CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line))
120254721Semaste#define OSSL_FUNC_CRYPTO_REALLOC              24
121254721SemasteOSSL_CORE_MAKE_FUNC(void *,
122254721Semaste        CRYPTO_realloc, (void *addr, size_t num, const char *file, int line))
123254721Semaste#define OSSL_FUNC_CRYPTO_CLEAR_REALLOC        25
124254721SemasteOSSL_CORE_MAKE_FUNC(void *,
125254721Semaste        CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num,
126254721Semaste                               const char *file, int line))
127254721Semaste#define OSSL_FUNC_CRYPTO_SECURE_MALLOC        26
128254721SemasteOSSL_CORE_MAKE_FUNC(void *,
129254721Semaste        CRYPTO_secure_malloc, (size_t num, const char *file, int line))
130254721Semaste#define OSSL_FUNC_CRYPTO_SECURE_ZALLOC        27
131254721SemasteOSSL_CORE_MAKE_FUNC(void *,
132254721Semaste        CRYPTO_secure_zalloc, (size_t num, const char *file, int line))
133254721Semaste#define OSSL_FUNC_CRYPTO_SECURE_FREE          28
134254721SemasteOSSL_CORE_MAKE_FUNC(void,
135254721Semaste        CRYPTO_secure_free, (void *ptr, const char *file, int line))
136254721Semaste#define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE    29
137254721SemasteOSSL_CORE_MAKE_FUNC(void,
138254721Semaste        CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file,
139254721Semaste                                   int line))
140254721Semaste#define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED     30
141254721SemasteOSSL_CORE_MAKE_FUNC(int,
142254721Semaste        CRYPTO_secure_allocated, (const void *ptr))
143254721Semaste#define OSSL_FUNC_OPENSSL_CLEANSE             31
144254721SemasteOSSL_CORE_MAKE_FUNC(void,
145254721Semaste        OPENSSL_cleanse, (void *ptr, size_t len))
146254721Semaste
147254721Semaste/* Bio functions provided by the core */
148254721Semaste#define OSSL_FUNC_BIO_NEW_FILE                40
149254721Semaste#define OSSL_FUNC_BIO_NEW_MEMBUF              41
150254721Semaste#define OSSL_FUNC_BIO_READ_EX                 42
151254721Semaste#define OSSL_FUNC_BIO_WRITE_EX                43
152254721Semaste#define OSSL_FUNC_BIO_UP_REF                  44
153254721Semaste#define OSSL_FUNC_BIO_FREE                    45
154254721Semaste#define OSSL_FUNC_BIO_VPRINTF                 46
155254721Semaste#define OSSL_FUNC_BIO_VSNPRINTF               47
156254721Semaste#define OSSL_FUNC_BIO_PUTS                    48
157254721Semaste#define OSSL_FUNC_BIO_GETS                    49
158254721Semaste#define OSSL_FUNC_BIO_CTRL                    50
159254721Semaste
160254721Semaste
161254721SemasteOSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_file, (const char *filename,
162254721Semaste                                                    const char *mode))
163254721SemasteOSSL_CORE_MAKE_FUNC(OSSL_CORE_BIO *, BIO_new_membuf, (const void *buf, int len))
164254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (OSSL_CORE_BIO *bio, void *data,
165254721Semaste                                       size_t data_len, size_t *bytes_read))
166254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_write_ex, (OSSL_CORE_BIO *bio, const void *data,
167254721Semaste                                        size_t data_len, size_t *written))
168254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_gets, (OSSL_CORE_BIO *bio, char *buf, int size))
169254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_puts, (OSSL_CORE_BIO *bio, const char *str))
170254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_up_ref, (OSSL_CORE_BIO *bio))
171254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_free, (OSSL_CORE_BIO *bio))
172254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (OSSL_CORE_BIO *bio, const char *format,
173254721Semaste                                       va_list args))
174254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_vsnprintf,
175254721Semaste                   (char *buf, size_t n, const char *fmt, va_list args))
176254721SemasteOSSL_CORE_MAKE_FUNC(int, BIO_ctrl, (OSSL_CORE_BIO *bio,
177254721Semaste                                    int cmd, long num, void *ptr))
178254721Semaste
179254721Semaste#define OSSL_FUNC_SELF_TEST_CB               100
180254721SemasteOSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb,
181254721Semaste                                         void **cbarg))
182254721Semaste
183254721Semaste/* Functions to get seed material from the operating system */
184254721Semaste#define OSSL_FUNC_GET_ENTROPY                101
185254721Semaste#define OSSL_FUNC_CLEANUP_ENTROPY            102
186254721Semaste#define OSSL_FUNC_GET_NONCE                  103
187254721Semaste#define OSSL_FUNC_CLEANUP_NONCE              104
188254721SemasteOSSL_CORE_MAKE_FUNC(size_t, get_entropy, (const OSSL_CORE_HANDLE *handle,
189254721Semaste                                          unsigned char **pout, int entropy,
190254721Semaste                                          size_t min_len, size_t max_len))
191254721SemasteOSSL_CORE_MAKE_FUNC(void, cleanup_entropy, (const OSSL_CORE_HANDLE *handle,
192254721Semaste                                            unsigned char *buf, size_t len))
193254721SemasteOSSL_CORE_MAKE_FUNC(size_t, get_nonce, (const OSSL_CORE_HANDLE *handle,
194254721Semaste                                        unsigned char **pout, size_t min_len,
195254721Semaste                                        size_t max_len, const void *salt,
196254721Semaste                                        size_t salt_len))
197254721SemasteOSSL_CORE_MAKE_FUNC(void, cleanup_nonce, (const OSSL_CORE_HANDLE *handle,
198254721Semaste                                          unsigned char *buf, size_t len))
199254721Semaste
200254721Semaste/* Functions to access the core's providers */
201254721Semaste#define OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB   105
202254721Semaste#define OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB 106
203254721Semaste#define OSSL_FUNC_PROVIDER_NAME                107
204254721Semaste#define OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX   108
205254721Semaste#define OSSL_FUNC_PROVIDER_GET0_DISPATCH       109
206254721Semaste#define OSSL_FUNC_PROVIDER_UP_REF              110
207254721Semaste#define OSSL_FUNC_PROVIDER_FREE                111
208254721Semaste
209254721SemasteOSSL_CORE_MAKE_FUNC(int, provider_register_child_cb,
210254721Semaste                    (const OSSL_CORE_HANDLE *handle,
211254721Semaste                     int (*create_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata),
212254721Semaste                     int (*remove_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata),
213254721Semaste                     int (*global_props_cb)(const char *props, void *cbdata),
214254721Semaste                     void *cbdata))
215254721SemasteOSSL_CORE_MAKE_FUNC(void, provider_deregister_child_cb,
216254721Semaste                    (const OSSL_CORE_HANDLE *handle))
217254721SemasteOSSL_CORE_MAKE_FUNC(const char *, provider_name,
218254721Semaste                    (const OSSL_CORE_HANDLE *prov))
219254721SemasteOSSL_CORE_MAKE_FUNC(void *, provider_get0_provider_ctx,
220254721Semaste                    (const OSSL_CORE_HANDLE *prov))
221254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_DISPATCH *, provider_get0_dispatch,
222254721Semaste                    (const OSSL_CORE_HANDLE *prov))
223254721SemasteOSSL_CORE_MAKE_FUNC(int, provider_up_ref,
224254721Semaste                    (const OSSL_CORE_HANDLE *prov, int activate))
225254721SemasteOSSL_CORE_MAKE_FUNC(int, provider_free,
226254721Semaste                    (const OSSL_CORE_HANDLE *prov, int deactivate))
227254721Semaste
228254721Semaste/* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
229254721Semaste# define OSSL_FUNC_PROVIDER_TEARDOWN           1024
230254721SemasteOSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
231254721Semaste# define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS    1025
232254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
233254721Semaste                    provider_gettable_params,(void *provctx))
234254721Semaste# define OSSL_FUNC_PROVIDER_GET_PARAMS         1026
235254721SemasteOSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
236254721Semaste                                             OSSL_PARAM params[]))
237254721Semaste# define OSSL_FUNC_PROVIDER_QUERY_OPERATION    1027
238254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
239254721Semaste                    (void *provctx, int operation_id, int *no_store))
240254721Semaste# define OSSL_FUNC_PROVIDER_UNQUERY_OPERATION  1028
241254721SemasteOSSL_CORE_MAKE_FUNC(void, provider_unquery_operation,
242254721Semaste                    (void *provctx, int operation_id, const OSSL_ALGORITHM *))
243254721Semaste# define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1029
244254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
245254721Semaste                    (void *provctx))
246254721Semaste# define OSSL_FUNC_PROVIDER_GET_CAPABILITIES   1030
247254721SemasteOSSL_CORE_MAKE_FUNC(int, provider_get_capabilities, (void *provctx,
248254721Semaste                    const char *capability, OSSL_CALLBACK *cb, void *arg))
249254721Semaste# define OSSL_FUNC_PROVIDER_SELF_TEST          1031
250254721SemasteOSSL_CORE_MAKE_FUNC(int, provider_self_test, (void *provctx))
251254721Semaste
252254721Semaste/* Operations */
253254721Semaste
254254721Semaste# define OSSL_OP_DIGEST                              1
255254721Semaste# define OSSL_OP_CIPHER                              2   /* Symmetric Ciphers */
256254721Semaste# define OSSL_OP_MAC                                 3
257254721Semaste# define OSSL_OP_KDF                                 4
258254721Semaste# define OSSL_OP_RAND                                5
259254721Semaste# define OSSL_OP_KEYMGMT                            10
260254721Semaste# define OSSL_OP_KEYEXCH                            11
261254721Semaste# define OSSL_OP_SIGNATURE                          12
262254721Semaste# define OSSL_OP_ASYM_CIPHER                        13
263254721Semaste# define OSSL_OP_KEM                                14
264254721Semaste/* New section for non-EVP operations */
265254721Semaste# define OSSL_OP_ENCODER                            20
266254721Semaste# define OSSL_OP_DECODER                            21
267254721Semaste# define OSSL_OP_STORE                              22
268254721Semaste/* Highest known operation number */
269254721Semaste# define OSSL_OP__HIGHEST                           22
270254721Semaste
271254721Semaste/* Digests */
272254721Semaste
273254721Semaste# define OSSL_FUNC_DIGEST_NEWCTX                     1
274254721Semaste# define OSSL_FUNC_DIGEST_INIT                       2
275254721Semaste# define OSSL_FUNC_DIGEST_UPDATE                     3
276254721Semaste# define OSSL_FUNC_DIGEST_FINAL                      4
277254721Semaste# define OSSL_FUNC_DIGEST_DIGEST                     5
278254721Semaste# define OSSL_FUNC_DIGEST_FREECTX                    6
279254721Semaste# define OSSL_FUNC_DIGEST_DUPCTX                     7
280254721Semaste# define OSSL_FUNC_DIGEST_GET_PARAMS                 8
281254721Semaste# define OSSL_FUNC_DIGEST_SET_CTX_PARAMS             9
282254721Semaste# define OSSL_FUNC_DIGEST_GET_CTX_PARAMS            10
283254721Semaste# define OSSL_FUNC_DIGEST_GETTABLE_PARAMS           11
284254721Semaste# define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS       12
285254721Semaste# define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS       13
286254721Semaste
287254721SemasteOSSL_CORE_MAKE_FUNC(void *, digest_newctx, (void *provctx))
288254721SemasteOSSL_CORE_MAKE_FUNC(int, digest_init, (void *dctx, const OSSL_PARAM params[]))
289254721SemasteOSSL_CORE_MAKE_FUNC(int, digest_update,
290254721Semaste                    (void *dctx, const unsigned char *in, size_t inl))
291254721SemasteOSSL_CORE_MAKE_FUNC(int, digest_final,
292254721Semaste                    (void *dctx,
293254721Semaste                     unsigned char *out, size_t *outl, size_t outsz))
294254721SemasteOSSL_CORE_MAKE_FUNC(int, digest_digest,
295254721Semaste                    (void *provctx, const unsigned char *in, size_t inl,
296254721Semaste                     unsigned char *out, size_t *outl, size_t outsz))
297254721Semaste
298254721SemasteOSSL_CORE_MAKE_FUNC(void, digest_freectx, (void *dctx))
299254721SemasteOSSL_CORE_MAKE_FUNC(void *, digest_dupctx, (void *dctx))
300254721Semaste
301254721SemasteOSSL_CORE_MAKE_FUNC(int, digest_get_params, (OSSL_PARAM params[]))
302254721SemasteOSSL_CORE_MAKE_FUNC(int, digest_set_ctx_params,
303254721Semaste                    (void *vctx, const OSSL_PARAM params[]))
304254721SemasteOSSL_CORE_MAKE_FUNC(int, digest_get_ctx_params,
305254721Semaste                    (void *vctx, OSSL_PARAM params[]))
306254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_params,
307254721Semaste                    (void *provctx))
308254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_settable_ctx_params,
309254721Semaste                    (void *dctx, void *provctx))
310254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, digest_gettable_ctx_params,
311254721Semaste                    (void *dctx, void *provctx))
312254721Semaste
313254721Semaste/* Symmetric Ciphers */
314254721Semaste
315254721Semaste# define OSSL_FUNC_CIPHER_NEWCTX                     1
316254721Semaste# define OSSL_FUNC_CIPHER_ENCRYPT_INIT               2
317254721Semaste# define OSSL_FUNC_CIPHER_DECRYPT_INIT               3
318254721Semaste# define OSSL_FUNC_CIPHER_UPDATE                     4
319254721Semaste# define OSSL_FUNC_CIPHER_FINAL                      5
320254721Semaste# define OSSL_FUNC_CIPHER_CIPHER                     6
321254721Semaste# define OSSL_FUNC_CIPHER_FREECTX                    7
322254721Semaste# define OSSL_FUNC_CIPHER_DUPCTX                     8
323254721Semaste# define OSSL_FUNC_CIPHER_GET_PARAMS                 9
324254721Semaste# define OSSL_FUNC_CIPHER_GET_CTX_PARAMS            10
325254721Semaste# define OSSL_FUNC_CIPHER_SET_CTX_PARAMS            11
326254721Semaste# define OSSL_FUNC_CIPHER_GETTABLE_PARAMS           12
327254721Semaste# define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS       13
328254721Semaste# define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS       14
329254721Semaste
330254721SemasteOSSL_CORE_MAKE_FUNC(void *, cipher_newctx, (void *provctx))
331254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_encrypt_init, (void *cctx,
332254721Semaste                                                  const unsigned char *key,
333254721Semaste                                                  size_t keylen,
334254721Semaste                                                  const unsigned char *iv,
335254721Semaste                                                  size_t ivlen,
336254721Semaste                                                  const OSSL_PARAM params[]))
337254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_decrypt_init, (void *cctx,
338254721Semaste                                                  const unsigned char *key,
339254721Semaste                                                  size_t keylen,
340254721Semaste                                                  const unsigned char *iv,
341254721Semaste                                                  size_t ivlen,
342254721Semaste                                                  const OSSL_PARAM params[]))
343254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_update,
344254721Semaste                    (void *cctx,
345254721Semaste                     unsigned char *out, size_t *outl, size_t outsize,
346254721Semaste                     const unsigned char *in, size_t inl))
347254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_final,
348254721Semaste                    (void *cctx,
349254721Semaste                     unsigned char *out, size_t *outl, size_t outsize))
350254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_cipher,
351254721Semaste                    (void *cctx,
352254721Semaste                     unsigned char *out, size_t *outl, size_t outsize,
353254721Semaste                     const unsigned char *in, size_t inl))
354254721SemasteOSSL_CORE_MAKE_FUNC(void, cipher_freectx, (void *cctx))
355254721SemasteOSSL_CORE_MAKE_FUNC(void *, cipher_dupctx, (void *cctx))
356254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_get_params, (OSSL_PARAM params[]))
357254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_get_ctx_params, (void *cctx,
358254721Semaste                                                    OSSL_PARAM params[]))
359254721SemasteOSSL_CORE_MAKE_FUNC(int, cipher_set_ctx_params, (void *cctx,
360254721Semaste                                                    const OSSL_PARAM params[]))
361254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_params,
362254721Semaste                    (void *provctx))
363254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_settable_ctx_params,
364263363Semaste                    (void *cctx, void *provctx))
365254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, cipher_gettable_ctx_params,
366254721Semaste                    (void *cctx, void *provctx))
367254721Semaste
368254721Semaste/* MACs */
369254721Semaste
370254721Semaste# define OSSL_FUNC_MAC_NEWCTX                        1
371254721Semaste# define OSSL_FUNC_MAC_DUPCTX                        2
372254721Semaste# define OSSL_FUNC_MAC_FREECTX                       3
373254721Semaste# define OSSL_FUNC_MAC_INIT                          4
374254721Semaste# define OSSL_FUNC_MAC_UPDATE                        5
375254721Semaste# define OSSL_FUNC_MAC_FINAL                         6
376254721Semaste# define OSSL_FUNC_MAC_GET_PARAMS                    7
377254721Semaste# define OSSL_FUNC_MAC_GET_CTX_PARAMS                8
378254721Semaste# define OSSL_FUNC_MAC_SET_CTX_PARAMS                9
379254721Semaste# define OSSL_FUNC_MAC_GETTABLE_PARAMS              10
380254721Semaste# define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS          11
381254721Semaste# define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS          12
382254721Semaste
383254721SemasteOSSL_CORE_MAKE_FUNC(void *, mac_newctx, (void *provctx))
384254721SemasteOSSL_CORE_MAKE_FUNC(void *, mac_dupctx, (void *src))
385254721SemasteOSSL_CORE_MAKE_FUNC(void, mac_freectx, (void *mctx))
386254721SemasteOSSL_CORE_MAKE_FUNC(int, mac_init, (void *mctx, const unsigned char *key,
387254721Semaste                                    size_t keylen, const OSSL_PARAM params[]))
388254721SemasteOSSL_CORE_MAKE_FUNC(int, mac_update,
389254721Semaste                    (void *mctx, const unsigned char *in, size_t inl))
390254721SemasteOSSL_CORE_MAKE_FUNC(int, mac_final,
391254721Semaste                    (void *mctx,
392254721Semaste                     unsigned char *out, size_t *outl, size_t outsize))
393254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_params, (void *provctx))
394254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_gettable_ctx_params,
395254721Semaste                    (void *mctx, void *provctx))
396254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, mac_settable_ctx_params,
397254721Semaste                    (void *mctx, void *provctx))
398254721SemasteOSSL_CORE_MAKE_FUNC(int, mac_get_params, (OSSL_PARAM params[]))
399254721SemasteOSSL_CORE_MAKE_FUNC(int, mac_get_ctx_params,
400254721Semaste                    (void *mctx, OSSL_PARAM params[]))
401254721SemasteOSSL_CORE_MAKE_FUNC(int, mac_set_ctx_params,
402254721Semaste                    (void *mctx, const OSSL_PARAM params[]))
403254721Semaste
404254721Semaste/* KDFs and PRFs */
405254721Semaste
406254721Semaste# define OSSL_FUNC_KDF_NEWCTX                        1
407254721Semaste# define OSSL_FUNC_KDF_DUPCTX                        2
408254721Semaste# define OSSL_FUNC_KDF_FREECTX                       3
409254721Semaste# define OSSL_FUNC_KDF_RESET                         4
410254721Semaste# define OSSL_FUNC_KDF_DERIVE                        5
411254721Semaste# define OSSL_FUNC_KDF_GETTABLE_PARAMS               6
412263363Semaste# define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS           7
413254721Semaste# define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS           8
414254721Semaste# define OSSL_FUNC_KDF_GET_PARAMS                    9
415254721Semaste# define OSSL_FUNC_KDF_GET_CTX_PARAMS               10
416254721Semaste# define OSSL_FUNC_KDF_SET_CTX_PARAMS               11
417254721Semaste
418254721SemasteOSSL_CORE_MAKE_FUNC(void *, kdf_newctx, (void *provctx))
419254721SemasteOSSL_CORE_MAKE_FUNC(void *, kdf_dupctx, (void *src))
420254721SemasteOSSL_CORE_MAKE_FUNC(void, kdf_freectx, (void *kctx))
421254721SemasteOSSL_CORE_MAKE_FUNC(void, kdf_reset, (void *kctx))
422254721SemasteOSSL_CORE_MAKE_FUNC(int, kdf_derive, (void *kctx, unsigned char *key,
423254721Semaste                                      size_t keylen, const OSSL_PARAM params[]))
424254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_params, (void *provctx))
425254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_gettable_ctx_params,
426254721Semaste                    (void *kctx, void *provctx))
427254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kdf_settable_ctx_params,
428254721Semaste                    (void *kctx, void *provctx))
429254721SemasteOSSL_CORE_MAKE_FUNC(int, kdf_get_params, (OSSL_PARAM params[]))
430254721SemasteOSSL_CORE_MAKE_FUNC(int, kdf_get_ctx_params,
431254721Semaste                    (void *kctx, OSSL_PARAM params[]))
432254721SemasteOSSL_CORE_MAKE_FUNC(int, kdf_set_ctx_params,
433254721Semaste                    (void *kctx, const OSSL_PARAM params[]))
434254721Semaste
435254721Semaste/* RAND */
436254721Semaste
437254721Semaste# define OSSL_FUNC_RAND_NEWCTX                        1
438254721Semaste# define OSSL_FUNC_RAND_FREECTX                       2
439254721Semaste# define OSSL_FUNC_RAND_INSTANTIATE                   3
440254721Semaste# define OSSL_FUNC_RAND_UNINSTANTIATE                 4
441254721Semaste# define OSSL_FUNC_RAND_GENERATE                      5
442254721Semaste# define OSSL_FUNC_RAND_RESEED                        6
443254721Semaste# define OSSL_FUNC_RAND_NONCE                         7
444254721Semaste# define OSSL_FUNC_RAND_ENABLE_LOCKING                8
445254721Semaste# define OSSL_FUNC_RAND_LOCK                          9
446254721Semaste# define OSSL_FUNC_RAND_UNLOCK                       10
447254721Semaste# define OSSL_FUNC_RAND_GETTABLE_PARAMS              11
448254721Semaste# define OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS          12
449254721Semaste# define OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS          13
450254721Semaste# define OSSL_FUNC_RAND_GET_PARAMS                   14
451254721Semaste# define OSSL_FUNC_RAND_GET_CTX_PARAMS               15
452254721Semaste# define OSSL_FUNC_RAND_SET_CTX_PARAMS               16
453254721Semaste# define OSSL_FUNC_RAND_VERIFY_ZEROIZATION           17
454254721Semaste# define OSSL_FUNC_RAND_GET_SEED                     18
455254721Semaste# define OSSL_FUNC_RAND_CLEAR_SEED                   19
456254721Semaste
457254721SemasteOSSL_CORE_MAKE_FUNC(void *,rand_newctx,
458254721Semaste                    (void *provctx, void *parent,
459254721Semaste                    const OSSL_DISPATCH *parent_calls))
460254721SemasteOSSL_CORE_MAKE_FUNC(void,rand_freectx, (void *vctx))
461254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_instantiate,
462254721Semaste                    (void *vdrbg, unsigned int strength,
463254721Semaste                     int prediction_resistance,
464254721Semaste                     const unsigned char *pstr, size_t pstr_len,
465254721Semaste                     const OSSL_PARAM params[]))
466254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_uninstantiate, (void *vdrbg))
467254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_generate,
468254721Semaste                    (void *vctx, unsigned char *out, size_t outlen,
469254721Semaste                     unsigned int strength, int prediction_resistance,
470254721Semaste                     const unsigned char *addin, size_t addin_len))
471254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_reseed,
472254721Semaste                    (void *vctx, int prediction_resistance,
473254721Semaste                     const unsigned char *ent, size_t ent_len,
474254721Semaste                     const unsigned char *addin, size_t addin_len))
475254721SemasteOSSL_CORE_MAKE_FUNC(size_t,rand_nonce,
476254721Semaste                    (void *vctx, unsigned char *out, unsigned int strength,
477254721Semaste                     size_t min_noncelen, size_t max_noncelen))
478254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_enable_locking, (void *vctx))
479254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_lock, (void *vctx))
480254721SemasteOSSL_CORE_MAKE_FUNC(void,rand_unlock, (void *vctx))
481254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_params, (void *provctx))
482254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_gettable_ctx_params,
483254721Semaste                    (void *vctx, void *provctx))
484254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,rand_settable_ctx_params,
485254721Semaste                    (void *vctx, void *provctx))
486254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_get_params, (OSSL_PARAM params[]))
487254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_get_ctx_params,
488254721Semaste                    (void *vctx, OSSL_PARAM params[]))
489254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_set_ctx_params,
490254721Semaste                    (void *vctx, const OSSL_PARAM params[]))
491254721SemasteOSSL_CORE_MAKE_FUNC(void,rand_set_callbacks,
492254721Semaste                    (void *vctx, OSSL_INOUT_CALLBACK *get_entropy,
493254721Semaste                     OSSL_CALLBACK *cleanup_entropy,
494254721Semaste                     OSSL_INOUT_CALLBACK *get_nonce,
495254721Semaste                     OSSL_CALLBACK *cleanup_nonce, void *arg))
496254721SemasteOSSL_CORE_MAKE_FUNC(int,rand_verify_zeroization,
497254721Semaste                    (void *vctx))
498254721SemasteOSSL_CORE_MAKE_FUNC(size_t,rand_get_seed,
499254721Semaste                    (void *vctx, unsigned char **buffer,
500254721Semaste                     int entropy, size_t min_len, size_t max_len,
501254721Semaste                     int prediction_resistance,
502254721Semaste                     const unsigned char *adin, size_t adin_len))
503254721SemasteOSSL_CORE_MAKE_FUNC(void,rand_clear_seed,
504254721Semaste                    (void *vctx, unsigned char *buffer, size_t b_len))
505254721Semaste
506254721Semaste/*-
507254721Semaste * Key management
508254721Semaste *
509254721Semaste * The Key Management takes care of provider side key objects, and includes
510254721Semaste * all current functionality to create them, destroy them, set parameters
511254721Semaste * and key material, etc, essentially everything that manipulates the keys
512254721Semaste * themselves and their parameters.
513254721Semaste *
514254721Semaste * The key objects are commonly refered to as |keydata|, and it MUST be able
515254721Semaste * to contain parameters if the key has any, the public key and the private
516254721Semaste * key.  All parts are optional, but their presence determines what can be
517254721Semaste * done with the key object in terms of encryption, signature, and so on.
518254721Semaste * The assumption from libcrypto is that the key object contains any of the
519254721Semaste * following data combinations:
520254721Semaste *
521254721Semaste * - parameters only
522254721Semaste * - public key only
523254721Semaste * - public key + private key
524254721Semaste * - parameters + public key
525254721Semaste * - parameters + public key + private key
526254721Semaste *
527254721Semaste * What "parameters", "public key" and "private key" means in detail is left
528254721Semaste * to the implementation.  In the case of DH and DSA, they would typically
529254721Semaste * include domain parameters, while for certain variants of RSA, they would
530254721Semaste * typically include PSS or OAEP parameters.
531254721Semaste *
532254721Semaste * Key objects are created with OSSL_FUNC_keymgmt_new() and destroyed with
533254721Semaste * OSSL_FUNC_keymgmt_free().  Key objects can have data filled in with
534254721Semaste * OSSL_FUNC_keymgmt_import().
535254721Semaste *
536254721Semaste * Three functions are made available to check what selection of data is
537254721Semaste * present in a key object: OSSL_FUNC_keymgmt_has_parameters(),
538254721Semaste * OSSL_FUNC_keymgmt_has_public_key(), and OSSL_FUNC_keymgmt_has_private_key(),
539254721Semaste */
540254721Semaste
541254721Semaste/* Key data subset selection - individual bits */
542254721Semaste# define OSSL_KEYMGMT_SELECT_PRIVATE_KEY            0x01
543254721Semaste# define OSSL_KEYMGMT_SELECT_PUBLIC_KEY             0x02
544254721Semaste# define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS      0x04
545254721Semaste# define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS       0x80
546254721Semaste
547254721Semaste/* Key data subset selection - combinations */
548254721Semaste# define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS     \
549254721Semaste    ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS     \
550254721Semaste      | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
551254721Semaste# define OSSL_KEYMGMT_SELECT_KEYPAIR            \
552254721Semaste    ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
553254721Semaste# define OSSL_KEYMGMT_SELECT_ALL                \
554254721Semaste    ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
555254721Semaste
556254721Semaste# define OSSL_KEYMGMT_VALIDATE_FULL_CHECK              0
557254721Semaste# define OSSL_KEYMGMT_VALIDATE_QUICK_CHECK             1
558254721Semaste
559254721Semaste/* Basic key object creation */
560254721Semaste# define OSSL_FUNC_KEYMGMT_NEW                         1
561254721SemasteOSSL_CORE_MAKE_FUNC(void *, keymgmt_new, (void *provctx))
562254721Semaste
563254721Semaste/* Generation, a more complex constructor */
564254721Semaste# define OSSL_FUNC_KEYMGMT_GEN_INIT                    2
565254721Semaste# define OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE            3
566254721Semaste# define OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS              4
567254721Semaste# define OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS         5
568254721Semaste# define OSSL_FUNC_KEYMGMT_GEN                         6
569254721Semaste# define OSSL_FUNC_KEYMGMT_GEN_CLEANUP                 7
570254721SemasteOSSL_CORE_MAKE_FUNC(void *, keymgmt_gen_init,
571254721Semaste                    (void *provctx, int selection, const OSSL_PARAM params[]))
572254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_template,
573254721Semaste                    (void *genctx, void *templ))
574254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_gen_set_params,
575254721Semaste                    (void *genctx, const OSSL_PARAM params[]))
576254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
577254721Semaste                    keymgmt_gen_settable_params,
578254721Semaste                    (void *genctx, void *provctx))
579254721SemasteOSSL_CORE_MAKE_FUNC(void *, keymgmt_gen,
580254721Semaste                    (void *genctx, OSSL_CALLBACK *cb, void *cbarg))
581254721SemasteOSSL_CORE_MAKE_FUNC(void, keymgmt_gen_cleanup, (void *genctx))
582254721Semaste
583254721Semaste/* Key loading by object reference */
584254721Semaste# define OSSL_FUNC_KEYMGMT_LOAD                        8
585254721SemasteOSSL_CORE_MAKE_FUNC(void *, keymgmt_load,
586254721Semaste                    (const void *reference, size_t reference_sz))
587254721Semaste
588254721Semaste/* Basic key object destruction */
589254721Semaste# define OSSL_FUNC_KEYMGMT_FREE                       10
590254721SemasteOSSL_CORE_MAKE_FUNC(void, keymgmt_free, (void *keydata))
591254721Semaste
592254721Semaste/* Key object information, with discovery */
593254721Semaste#define OSSL_FUNC_KEYMGMT_GET_PARAMS                  11
594254721Semaste#define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS             12
595254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_get_params,
596254721Semaste                    (void *keydata, OSSL_PARAM params[]))
597254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_gettable_params,
598254721Semaste                    (void *provctx))
599254721Semaste
600254721Semaste#define OSSL_FUNC_KEYMGMT_SET_PARAMS                  13
601254721Semaste#define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS             14
602254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_set_params,
603254721Semaste                    (void *keydata, const OSSL_PARAM params[]))
604254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_settable_params,
605254721Semaste                    (void *provctx))
606254721Semaste
607254721Semaste/* Key checks - discovery of supported operations */
608254721Semaste# define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME       20
609254721SemasteOSSL_CORE_MAKE_FUNC(const char *, keymgmt_query_operation_name,
610254721Semaste                    (int operation_id))
611254721Semaste
612254721Semaste/* Key checks - key data content checks */
613254721Semaste# define OSSL_FUNC_KEYMGMT_HAS                        21
614254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_has, (const void *keydata, int selection))
615254721Semaste
616254721Semaste/* Key checks - validation */
617254721Semaste# define OSSL_FUNC_KEYMGMT_VALIDATE                   22
618254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_validate, (const void *keydata, int selection,
619254721Semaste                                            int checktype))
620254721Semaste
621254721Semaste/* Key checks - matching */
622254721Semaste# define OSSL_FUNC_KEYMGMT_MATCH                      23
623254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_match,
624254721Semaste                    (const void *keydata1, const void *keydata2,
625254721Semaste                     int selection))
626254721Semaste
627254721Semaste/* Import and export functions, with discovery */
628254721Semaste# define OSSL_FUNC_KEYMGMT_IMPORT                     40
629254721Semaste# define OSSL_FUNC_KEYMGMT_IMPORT_TYPES               41
630254721Semaste# define OSSL_FUNC_KEYMGMT_EXPORT                     42
631254721Semaste# define OSSL_FUNC_KEYMGMT_EXPORT_TYPES               43
632254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_import,
633254721Semaste                    (void *keydata, int selection, const OSSL_PARAM params[]))
634254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_import_types,
635254721Semaste                    (int selection))
636254721SemasteOSSL_CORE_MAKE_FUNC(int, keymgmt_export,
637254721Semaste                    (void *keydata, int selection,
638254721Semaste                     OSSL_CALLBACK *param_cb, void *cbarg))
639254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keymgmt_export_types,
640254721Semaste                    (int selection))
641254721Semaste
642254721Semaste/* Dup function, constructor */
643254721Semaste# define OSSL_FUNC_KEYMGMT_DUP                        44
644254721SemasteOSSL_CORE_MAKE_FUNC(void *, keymgmt_dup,
645254721Semaste                    (const void *keydata_from, int selection))
646254721Semaste
647254721Semaste/* Key Exchange */
648254721Semaste
649254721Semaste# define OSSL_FUNC_KEYEXCH_NEWCTX                      1
650254721Semaste# define OSSL_FUNC_KEYEXCH_INIT                        2
651254721Semaste# define OSSL_FUNC_KEYEXCH_DERIVE                      3
652254721Semaste# define OSSL_FUNC_KEYEXCH_SET_PEER                    4
653254721Semaste# define OSSL_FUNC_KEYEXCH_FREECTX                     5
654254721Semaste# define OSSL_FUNC_KEYEXCH_DUPCTX                      6
655254721Semaste# define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS              7
656254721Semaste# define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS         8
657254721Semaste# define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS              9
658254721Semaste# define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS        10
659254721Semaste
660254721SemasteOSSL_CORE_MAKE_FUNC(void *, keyexch_newctx, (void *provctx))
661254721SemasteOSSL_CORE_MAKE_FUNC(int, keyexch_init, (void *ctx, void *provkey,
662254721Semaste                                        const OSSL_PARAM params[]))
663254721SemasteOSSL_CORE_MAKE_FUNC(int, keyexch_derive, (void *ctx,  unsigned char *secret,
664254721Semaste                                             size_t *secretlen, size_t outlen))
665254721SemasteOSSL_CORE_MAKE_FUNC(int, keyexch_set_peer, (void *ctx, void *provkey))
666254721SemasteOSSL_CORE_MAKE_FUNC(void, keyexch_freectx, (void *ctx))
667254721SemasteOSSL_CORE_MAKE_FUNC(void *, keyexch_dupctx, (void *ctx))
668254721SemasteOSSL_CORE_MAKE_FUNC(int, keyexch_set_ctx_params, (void *ctx,
669254721Semaste                                                     const OSSL_PARAM params[]))
670254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_settable_ctx_params,
671254721Semaste                    (void *ctx, void *provctx))
672254721SemasteOSSL_CORE_MAKE_FUNC(int, keyexch_get_ctx_params, (void *ctx,
673254721Semaste                                                     OSSL_PARAM params[]))
674254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, keyexch_gettable_ctx_params,
675254721Semaste                    (void *ctx, void *provctx))
676254721Semaste
677254721Semaste/* Signature */
678254721Semaste
679254721Semaste# define OSSL_FUNC_SIGNATURE_NEWCTX                  1
680254721Semaste# define OSSL_FUNC_SIGNATURE_SIGN_INIT               2
681254721Semaste# define OSSL_FUNC_SIGNATURE_SIGN                    3
682254721Semaste# define OSSL_FUNC_SIGNATURE_VERIFY_INIT             4
683254721Semaste# define OSSL_FUNC_SIGNATURE_VERIFY                  5
684254721Semaste# define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT     6
685254721Semaste# define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER          7
686254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT        8
687254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE      9
688254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL      10
689254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN            11
690254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT     12
691254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE   13
692254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL    14
693254721Semaste# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY          15
694254721Semaste# define OSSL_FUNC_SIGNATURE_FREECTX                16
695254721Semaste# define OSSL_FUNC_SIGNATURE_DUPCTX                 17
696254721Semaste# define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS         18
697254721Semaste# define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS    19
698254721Semaste# define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS         20
699254721Semaste# define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS    21
700254721Semaste# define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS      22
701254721Semaste# define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
702254721Semaste# define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS      24
703254721Semaste# define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
704254721Semaste
705254721SemasteOSSL_CORE_MAKE_FUNC(void *, signature_newctx, (void *provctx,
706254721Semaste                                                  const char *propq))
707254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_sign_init, (void *ctx, void *provkey,
708254721Semaste                                               const OSSL_PARAM params[]))
709254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_sign, (void *ctx,  unsigned char *sig,
710254721Semaste                                             size_t *siglen, size_t sigsize,
711254721Semaste                                             const unsigned char *tbs,
712254721Semaste                                             size_t tbslen))
713254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_verify_init, (void *ctx, void *provkey,
714254721Semaste                                                 const OSSL_PARAM params[]))
715254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_verify, (void *ctx,
716254721Semaste                                               const unsigned char *sig,
717254721Semaste                                               size_t siglen,
718254721Semaste                                               const unsigned char *tbs,
719254721Semaste                                               size_t tbslen))
720254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_verify_recover_init,
721254721Semaste                    (void *ctx, void *provkey, const OSSL_PARAM params[]))
722254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_verify_recover,
723254721Semaste                    (void *ctx, unsigned char *rout, size_t *routlen,
724254721Semaste                     size_t routsize, const unsigned char *sig, size_t siglen))
725254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_sign_init,
726254721Semaste                    (void *ctx, const char *mdname, void *provkey,
727254721Semaste                     const OSSL_PARAM params[]))
728254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_sign_update,
729254721Semaste                    (void *ctx, const unsigned char *data, size_t datalen))
730254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_sign_final,
731254721Semaste                    (void *ctx, unsigned char *sig, size_t *siglen,
732254721Semaste                     size_t sigsize))
733254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_sign,
734254721Semaste                    (void *ctx, unsigned char *sigret, size_t *siglen,
735254721Semaste                     size_t sigsize, const unsigned char *tbs, size_t tbslen))
736254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_verify_init,
737254721Semaste                    (void *ctx, const char *mdname, void *provkey,
738254721Semaste                     const OSSL_PARAM params[]))
739254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_verify_update,
740254721Semaste                    (void *ctx, const unsigned char *data, size_t datalen))
741254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_verify_final,
742254721Semaste                    (void *ctx, const unsigned char *sig, size_t siglen))
743254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_digest_verify,
744254721Semaste                    (void *ctx, const unsigned char *sig, size_t siglen,
745254721Semaste                     const unsigned char *tbs, size_t tbslen))
746254721SemasteOSSL_CORE_MAKE_FUNC(void, signature_freectx, (void *ctx))
747254721SemasteOSSL_CORE_MAKE_FUNC(void *, signature_dupctx, (void *ctx))
748254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_get_ctx_params,
749254721Semaste                    (void *ctx, OSSL_PARAM params[]))
750254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_params,
751254721Semaste                    (void *ctx, void *provctx))
752254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_set_ctx_params,
753254721Semaste                    (void *ctx, const OSSL_PARAM params[]))
754254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_params,
755254721Semaste                    (void *ctx, void *provctx))
756254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_get_ctx_md_params,
757254721Semaste                    (void *ctx, OSSL_PARAM params[]))
758254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_gettable_ctx_md_params,
759254721Semaste                    (void *ctx))
760254721SemasteOSSL_CORE_MAKE_FUNC(int, signature_set_ctx_md_params,
761254721Semaste                    (void *ctx, const OSSL_PARAM params[]))
762254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, signature_settable_ctx_md_params,
763254721Semaste                    (void *ctx))
764254721Semaste
765254721Semaste
766254721Semaste/* Asymmetric Ciphers */
767254721Semaste
768254721Semaste# define OSSL_FUNC_ASYM_CIPHER_NEWCTX                  1
769254721Semaste# define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT            2
770254721Semaste# define OSSL_FUNC_ASYM_CIPHER_ENCRYPT                 3
771254721Semaste# define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT            4
772254721Semaste# define OSSL_FUNC_ASYM_CIPHER_DECRYPT                 5
773254721Semaste# define OSSL_FUNC_ASYM_CIPHER_FREECTX                 6
774254721Semaste# define OSSL_FUNC_ASYM_CIPHER_DUPCTX                  7
775254721Semaste# define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS          8
776254721Semaste# define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS     9
777254721Semaste# define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS         10
778254721Semaste# define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS    11
779254721Semaste
780254721SemasteOSSL_CORE_MAKE_FUNC(void *, asym_cipher_newctx, (void *provctx))
781254721SemasteOSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt_init, (void *ctx, void *provkey,
782254721Semaste                                                    const OSSL_PARAM params[]))
783254721SemasteOSSL_CORE_MAKE_FUNC(int, asym_cipher_encrypt, (void *ctx, unsigned char *out,
784254721Semaste                                                  size_t *outlen,
785254721Semaste                                                  size_t outsize,
786254721Semaste                                                  const unsigned char *in,
787254721Semaste                                                  size_t inlen))
788254721SemasteOSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt_init, (void *ctx, void *provkey,
789254721Semaste                                                    const OSSL_PARAM params[]))
790254721SemasteOSSL_CORE_MAKE_FUNC(int, asym_cipher_decrypt, (void *ctx, unsigned char *out,
791254721Semaste                                                  size_t *outlen,
792254721Semaste                                                  size_t outsize,
793254721Semaste                                                  const unsigned char *in,
794254721Semaste                                                  size_t inlen))
795254721SemasteOSSL_CORE_MAKE_FUNC(void, asym_cipher_freectx, (void *ctx))
796254721SemasteOSSL_CORE_MAKE_FUNC(void *, asym_cipher_dupctx, (void *ctx))
797254721SemasteOSSL_CORE_MAKE_FUNC(int, asym_cipher_get_ctx_params,
798254721Semaste                    (void *ctx, OSSL_PARAM params[]))
799254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_gettable_ctx_params,
800254721Semaste                    (void *ctx, void *provctx))
801254721SemasteOSSL_CORE_MAKE_FUNC(int, asym_cipher_set_ctx_params,
802254721Semaste                    (void *ctx, const OSSL_PARAM params[]))
803254721SemasteOSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, asym_cipher_settable_ctx_params,
804254721Semaste                    (void *ctx, void *provctx))
805254721Semaste
806254721Semaste/* Asymmetric Key encapsulation */
807254721Semaste# define OSSL_FUNC_KEM_NEWCTX                  1
808254721Semaste# define OSSL_FUNC_KEM_ENCAPSULATE_INIT        2
809254721Semaste# define OSSL_FUNC_KEM_ENCAPSULATE             3
810254721Semaste# define OSSL_FUNC_KEM_DECAPSULATE_INIT        4
811254721Semaste# define OSSL_FUNC_KEM_DECAPSULATE             5
812254721Semaste# define OSSL_FUNC_KEM_FREECTX                 6
813254721Semaste# define OSSL_FUNC_KEM_DUPCTX                  7
814254721Semaste# define OSSL_FUNC_KEM_GET_CTX_PARAMS          8
815254721Semaste# define OSSL_FUNC_KEM_GETTABLE_CTX_PARAMS     9
816254721Semaste# define OSSL_FUNC_KEM_SET_CTX_PARAMS         10
817# define OSSL_FUNC_KEM_SETTABLE_CTX_PARAMS    11
818
819OSSL_CORE_MAKE_FUNC(void *, kem_newctx, (void *provctx))
820OSSL_CORE_MAKE_FUNC(int, kem_encapsulate_init, (void *ctx, void *provkey,
821                                                const OSSL_PARAM params[]))
822OSSL_CORE_MAKE_FUNC(int, kem_encapsulate, (void *ctx,
823                                           unsigned char *out, size_t *outlen,
824                                           unsigned char *secret,
825                                           size_t *secretlen))
826OSSL_CORE_MAKE_FUNC(int, kem_decapsulate_init, (void *ctx, void *provkey,
827                                                const OSSL_PARAM params[]))
828OSSL_CORE_MAKE_FUNC(int, kem_decapsulate, (void *ctx,
829                                           unsigned char *out, size_t *outlen,
830                                           const unsigned char *in, size_t inlen))
831OSSL_CORE_MAKE_FUNC(void, kem_freectx, (void *ctx))
832OSSL_CORE_MAKE_FUNC(void *, kem_dupctx, (void *ctx))
833OSSL_CORE_MAKE_FUNC(int, kem_get_ctx_params, (void *ctx, OSSL_PARAM params[]))
834OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_gettable_ctx_params,
835                    (void *ctx, void *provctx))
836OSSL_CORE_MAKE_FUNC(int, kem_set_ctx_params,
837                    (void *ctx, const OSSL_PARAM params[]))
838OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, kem_settable_ctx_params,
839                    (void *ctx, void *provctx))
840
841/* Encoders and decoders */
842# define OSSL_FUNC_ENCODER_NEWCTX                      1
843# define OSSL_FUNC_ENCODER_FREECTX                     2
844# define OSSL_FUNC_ENCODER_GET_PARAMS                  3
845# define OSSL_FUNC_ENCODER_GETTABLE_PARAMS             4
846# define OSSL_FUNC_ENCODER_SET_CTX_PARAMS              5
847# define OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS         6
848# define OSSL_FUNC_ENCODER_DOES_SELECTION             10
849# define OSSL_FUNC_ENCODER_ENCODE                     11
850# define OSSL_FUNC_ENCODER_IMPORT_OBJECT              20
851# define OSSL_FUNC_ENCODER_FREE_OBJECT                21
852OSSL_CORE_MAKE_FUNC(void *, encoder_newctx, (void *provctx))
853OSSL_CORE_MAKE_FUNC(void, encoder_freectx, (void *ctx))
854OSSL_CORE_MAKE_FUNC(int, encoder_get_params, (OSSL_PARAM params[]))
855OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_gettable_params,
856                    (void *provctx))
857OSSL_CORE_MAKE_FUNC(int, encoder_set_ctx_params,
858                    (void *ctx, const OSSL_PARAM params[]))
859OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, encoder_settable_ctx_params,
860                    (void *provctx))
861
862OSSL_CORE_MAKE_FUNC(int, encoder_does_selection,
863                    (void *provctx, int selection))
864OSSL_CORE_MAKE_FUNC(int, encoder_encode,
865                    (void *ctx, OSSL_CORE_BIO *out,
866                     const void *obj_raw, const OSSL_PARAM obj_abstract[],
867                     int selection,
868                     OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
869
870OSSL_CORE_MAKE_FUNC(void *, encoder_import_object,
871                    (void *ctx, int selection, const OSSL_PARAM params[]))
872OSSL_CORE_MAKE_FUNC(void, encoder_free_object, (void *obj))
873
874# define OSSL_FUNC_DECODER_NEWCTX                      1
875# define OSSL_FUNC_DECODER_FREECTX                     2
876# define OSSL_FUNC_DECODER_GET_PARAMS                  3
877# define OSSL_FUNC_DECODER_GETTABLE_PARAMS             4
878# define OSSL_FUNC_DECODER_SET_CTX_PARAMS              5
879# define OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS         6
880# define OSSL_FUNC_DECODER_DOES_SELECTION             10
881# define OSSL_FUNC_DECODER_DECODE                     11
882# define OSSL_FUNC_DECODER_EXPORT_OBJECT              20
883OSSL_CORE_MAKE_FUNC(void *, decoder_newctx, (void *provctx))
884OSSL_CORE_MAKE_FUNC(void, decoder_freectx, (void *ctx))
885OSSL_CORE_MAKE_FUNC(int, decoder_get_params, (OSSL_PARAM params[]))
886OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_gettable_params,
887                    (void *provctx))
888OSSL_CORE_MAKE_FUNC(int, decoder_set_ctx_params,
889                    (void *ctx, const OSSL_PARAM params[]))
890OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, decoder_settable_ctx_params,
891                    (void *provctx))
892
893OSSL_CORE_MAKE_FUNC(int, decoder_does_selection,
894                    (void *provctx, int selection))
895OSSL_CORE_MAKE_FUNC(int, decoder_decode,
896                    (void *ctx, OSSL_CORE_BIO *in, int selection,
897                     OSSL_CALLBACK *data_cb, void *data_cbarg,
898                     OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
899OSSL_CORE_MAKE_FUNC(int, decoder_export_object,
900                    (void *ctx, const void *objref, size_t objref_sz,
901                     OSSL_CALLBACK *export_cb, void *export_cbarg))
902
903/*-
904 * Store
905 *
906 * Objects are scanned by using the 'open', 'load', 'eof' and 'close'
907 * functions, which implement an OSSL_STORE loader.
908 *
909 * store_load() works in a way that's very similar to the decoders, in
910 * that they pass an abstract object through a callback, either as a DER
911 * octet string or as an object reference, which libcrypto will have to
912 * deal with.
913 */
914
915#define OSSL_FUNC_STORE_OPEN                        1
916#define OSSL_FUNC_STORE_ATTACH                      2
917#define OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS         3
918#define OSSL_FUNC_STORE_SET_CTX_PARAMS              4
919#define OSSL_FUNC_STORE_LOAD                        5
920#define OSSL_FUNC_STORE_EOF                         6
921#define OSSL_FUNC_STORE_CLOSE                       7
922#define OSSL_FUNC_STORE_EXPORT_OBJECT               8
923OSSL_CORE_MAKE_FUNC(void *, store_open, (void *provctx, const char *uri))
924OSSL_CORE_MAKE_FUNC(void *, store_attach, (void *provctx, OSSL_CORE_BIO *in))
925OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, store_settable_ctx_params,
926                    (void *provctx))
927OSSL_CORE_MAKE_FUNC(int, store_set_ctx_params,
928                    (void *loaderctx, const OSSL_PARAM params[]))
929OSSL_CORE_MAKE_FUNC(int, store_load,
930                    (void *loaderctx,
931                     OSSL_CALLBACK *object_cb, void *object_cbarg,
932                     OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg))
933OSSL_CORE_MAKE_FUNC(int, store_eof, (void *loaderctx))
934OSSL_CORE_MAKE_FUNC(int, store_close, (void *loaderctx))
935OSSL_CORE_MAKE_FUNC(int, store_export_object,
936                    (void *loaderctx, const void *objref, size_t objref_sz,
937                     OSSL_CALLBACK *export_cb, void *export_cbarg))
938
939# ifdef __cplusplus
940}
941# endif
942
943#endif
944