]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/core_numbers.h
projects / thirdparty / openssl.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add provider awareness of EVP_DigestSign() and EVP_DigestVerify()
[thirdparty/openssl.git] / include / openssl / core_numbers.h
CommitLineData
4c2883a9
RL		 1/*
2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
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 14# include <openssl/core.h>
36fc5fc6 15# include <openssl/self_test.h>
4c2883a9
RL		 16
17# ifdef __cplusplus
18extern "C" {
19# endif
20
21/*-
22 * Identities
23 * ----------
24 *
25 * All series start with 1, to allow 0 to be an array terminator.
26 * For any FUNC identity, we also provide a function signature typedef
27 * and a static inline function to extract a function pointer from a
28 * OSSL_DISPATCH element in a type safe manner.
29 *
30 * Names:
31 * for any function base name 'foo' (uppercase form 'FOO'), we will have
32 * the following:
79c44b4e 33 * - a macro for the identity with the name OSSL_FUNC_'FOO' or derivatives
4c2883a9
RL		 34 * thereof (to be specified further down)
35 * - a function signature typedef with the name OSSL_'foo'_fn
36 * - a function pointer extractor function with the name OSSL_'foo'
37 */
38
b60cba3c
RS		 39/*
40 * Helper macro to create the function signature typedef and the extractor
41 * |type| is the return-type of the function, |name| is the name of the
42 * function to fetch, and |args| is a parenthesized list of parameters
43 * for the function (that is, it is |name|'s function signature).
44 */
4c2883a9
RL		 45#define OSSL_CORE_MAKE_FUNC(type,name,args) \
46 typedef type (OSSL_##name##_fn)args; \
47 static ossl_inline \
48 OSSL_##name##_fn *OSSL_get_##name(const OSSL_DISPATCH *opf) \
49 { \
50 return (OSSL_##name##_fn *)opf->function; \
51 }
52
53/*
54 * Core function identities, for the two OSSL_DISPATCH tables being passed
55 * in the OSSL_provider_init call.
56 *
57 * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must
58 * therefore NEVER be used as a function identity.
59 */
60/* Functions provided by the Core to the provider, reserved numbers 1-1023 */
dca97d00 61# define OSSL_FUNC_CORE_GETTABLE_PARAMS 1
26175013 62OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
dca97d00 63 core_gettable_params,(const OSSL_PROVIDER *prov))
4c2883a9
RL		 64# define OSSL_FUNC_CORE_GET_PARAMS 2
65OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_PROVIDER *prov,
4e7991b4 66 OSSL_PARAM params[]))
da747958
MC		 67# define OSSL_FUNC_CORE_THREAD_START 3
68OSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_PROVIDER *prov,
69 OSSL_thread_stop_handler_fn handfn))
49c64346 70# define OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT 4
e7706e63
RL		 71OSSL_CORE_MAKE_FUNC(OPENSSL_CTX *,core_get_library_context,
72 (const OSSL_PROVIDER *prov))
49c64346
RL		 73# define OSSL_FUNC_CORE_NEW_ERROR 5
74OSSL_CORE_MAKE_FUNC(void,core_new_error,(const OSSL_PROVIDER *prov))
75# define OSSL_FUNC_CORE_SET_ERROR_DEBUG 6
76OSSL_CORE_MAKE_FUNC(void,core_set_error_debug,
77 (const OSSL_PROVIDER *prov,
78 const char *file, int line, const char *func))
79# define OSSL_FUNC_CORE_VSET_ERROR 7
80OSSL_CORE_MAKE_FUNC(void,core_vset_error,
81 (const OSSL_PROVIDER *prov,
82 uint32_t reason, const char *fmt, va_list args))
7b131de2
RL		 83# define OSSL_FUNC_CORE_SET_ERROR_MARK 8
84OSSL_CORE_MAKE_FUNC(int, core_set_error_mark, (const OSSL_PROVIDER *prov))
85# define OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK 9
86OSSL_CORE_MAKE_FUNC(int, core_clear_last_error_mark,
87 (const OSSL_PROVIDER *prov))
88# define OSSL_FUNC_CORE_POP_ERROR_TO_MARK 10
89OSSL_CORE_MAKE_FUNC(int, core_pop_error_to_mark, (const OSSL_PROVIDER *prov))
4c2883a9 90
b60cba3c 91/* Memory allocation, freeing, clearing. */
7b131de2 92#define OSSL_FUNC_CRYPTO_MALLOC 20
b60cba3c
RS		 93OSSL_CORE_MAKE_FUNC(void *,
94 CRYPTO_malloc, (size_t num, const char *file, int line))
7b131de2 95#define OSSL_FUNC_CRYPTO_ZALLOC 21
b60cba3c
RS		 96OSSL_CORE_MAKE_FUNC(void *,
97 CRYPTO_zalloc, (size_t num, const char *file, int line))
7b131de2 98#define OSSL_FUNC_CRYPTO_FREE 22
b60cba3c
RS		 99OSSL_CORE_MAKE_FUNC(void,
100 CRYPTO_free, (void *ptr, const char *file, int line))
7b131de2 101#define OSSL_FUNC_CRYPTO_CLEAR_FREE 23
b60cba3c
RS		 102OSSL_CORE_MAKE_FUNC(void,
103 CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line))
7b131de2 104#define OSSL_FUNC_CRYPTO_REALLOC 24
b60cba3c
RS		 105OSSL_CORE_MAKE_FUNC(void *,
106 CRYPTO_realloc, (void *addr, size_t num, const char *file, int line))
7b131de2 107#define OSSL_FUNC_CRYPTO_CLEAR_REALLOC 25
b60cba3c 108OSSL_CORE_MAKE_FUNC(void *,
784883fc
SL		 109 CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num,
110 const char *file, int line))
7b131de2 111#define OSSL_FUNC_CRYPTO_SECURE_MALLOC 26
b60cba3c
RS		 112OSSL_CORE_MAKE_FUNC(void *,
113 CRYPTO_secure_malloc, (size_t num, const char *file, int line))
7b131de2 114#define OSSL_FUNC_CRYPTO_SECURE_ZALLOC 27
b60cba3c
RS		 115OSSL_CORE_MAKE_FUNC(void *,
116 CRYPTO_secure_zalloc, (size_t num, const char *file, int line))
7b131de2 117#define OSSL_FUNC_CRYPTO_SECURE_FREE 28
b60cba3c
RS		 118OSSL_CORE_MAKE_FUNC(void,
119 CRYPTO_secure_free, (void *ptr, const char *file, int line))
7b131de2 120#define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE 29
b60cba3c 121OSSL_CORE_MAKE_FUNC(void,
784883fc
SL		 122 CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file,
123 int line))
7b131de2 124#define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED 30
b60cba3c
RS		 125OSSL_CORE_MAKE_FUNC(int,
126 CRYPTO_secure_allocated, (const void *ptr))
7b131de2 127#define OSSL_FUNC_OPENSSL_CLEANSE 31
b60cba3c
RS		 128OSSL_CORE_MAKE_FUNC(void,
129 OPENSSL_cleanse, (void *ptr, size_t len))
b60cba3c 130
25e60144 131/* Bio functions provided by the core */
7b131de2
RL		 132#define OSSL_FUNC_BIO_NEW_FILE 40
133#define OSSL_FUNC_BIO_NEW_MEMBUF 41
134#define OSSL_FUNC_BIO_READ_EX 42
135#define OSSL_FUNC_BIO_FREE 43
136#define OSSL_FUNC_BIO_VPRINTF 44
25e60144
SL		 137
138OSSL_CORE_MAKE_FUNC(BIO *, BIO_new_file, (const char *filename, const char *mode))
139OSSL_CORE_MAKE_FUNC(BIO *, BIO_new_membuf, (const void *buf, int len))
7bb82f92
SL		 140OSSL_CORE_MAKE_FUNC(int, BIO_read_ex, (BIO *bio, void *data, size_t data_len,
141 size_t *bytes_read))
25e60144 142OSSL_CORE_MAKE_FUNC(int, BIO_free, (BIO *bio))
63665fff
RL		 143OSSL_CORE_MAKE_FUNC(int, BIO_vprintf, (BIO *bio, const char *format,
144 va_list args))
25e60144 145
7b131de2 146#define OSSL_FUNC_SELF_TEST_CB 100
36fc5fc6
SL		 147OSSL_CORE_MAKE_FUNC(void, self_test_cb, (OPENSSL_CTX *ctx, OSSL_CALLBACK **cb,
148 void **cbarg))
149
4c2883a9
RL		 150/* Functions provided by the provider to the Core, reserved numbers 1024-1535 */
151# define OSSL_FUNC_PROVIDER_TEARDOWN 1024
a39eb840 152OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx))
dca97d00 153# define OSSL_FUNC_PROVIDER_GETTABLE_PARAMS 1025
26175013 154OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *,
dca97d00 155 provider_gettable_params,(void *provctx))
4c2883a9 156# define OSSL_FUNC_PROVIDER_GET_PARAMS 1026
a39eb840 157OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx,
4e7991b4 158 OSSL_PARAM params[]))
099bd339
RL		 159# define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027
160OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation,
a39eb840 161 (void *provctx, int operation_id, const int *no_store))
6ebc2f56
RL		 162# define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028
163OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings,
164 (void *provctx))
4c2883a9 165
784883fc 166/* Operations */
3653d0c2 167
2893111f 168# define OSSL_OP_DIGEST 1
784883fc
SL		 169# define OSSL_OP_CIPHER 2 /* Symmetric Ciphers */
170# define OSSL_OP_MAC 3
ad1700c7 171# define OSSL_OP_KDF 4
784883fc
SL		 172# define OSSL_OP_KEYMGMT 10
173# define OSSL_OP_KEYEXCH 11
dfcb5d29 174# define OSSL_OP_SIGNATURE 12
2c938e2e 175# define OSSL_OP_ASYM_CIPHER 13
0d003c52
RL		 176/* New section for non-EVP operations */
177# define OSSL_OP_SERIALIZER 20
784883fc 178/* Highest known operation number */
0d003c52 179# define OSSL_OP__HIGHEST 20
784883fc
SL		 180
181/* Digests */
2893111f
RL		 182
183# define OSSL_FUNC_DIGEST_NEWCTX 1
184# define OSSL_FUNC_DIGEST_INIT 2
185# define OSSL_FUNC_DIGEST_UPDATE 3
186# define OSSL_FUNC_DIGEST_FINAL 4
187# define OSSL_FUNC_DIGEST_DIGEST 5
188# define OSSL_FUNC_DIGEST_FREECTX 6
189# define OSSL_FUNC_DIGEST_DUPCTX 7
190# define OSSL_FUNC_DIGEST_GET_PARAMS 8
92d9d0ae
RL		 191# define OSSL_FUNC_DIGEST_SET_CTX_PARAMS 9
192# define OSSL_FUNC_DIGEST_GET_CTX_PARAMS 10
ae3ff60e
RL		 193# define OSSL_FUNC_DIGEST_GETTABLE_PARAMS 11
194# define OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS 12
195# define OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS 13
df05f2ce 196
a39eb840
RL		 197OSSL_CORE_MAKE_FUNC(void *, OP_digest_newctx, (void *provctx))
198OSSL_CORE_MAKE_FUNC(int, OP_digest_init, (void *dctx))
3653d0c2 199OSSL_CORE_MAKE_FUNC(int, OP_digest_update,
a39eb840 200 (void *dctx, const unsigned char *in, size_t inl))
3653d0c2 201OSSL_CORE_MAKE_FUNC(int, OP_digest_final,
a39eb840
RL		 202 (void *dctx,
203 unsigned char *out, size_t *outl, size_t outsz))
3653d0c2 204OSSL_CORE_MAKE_FUNC(int, OP_digest_digest,
a39eb840 205 (void *provctx, const unsigned char *in, size_t inl,
8ccf2ffb 206 unsigned char *out, size_t *outl, size_t outsz))
df05f2ce 207
a39eb840
RL		 208OSSL_CORE_MAKE_FUNC(void, OP_digest_freectx, (void *dctx))
209OSSL_CORE_MAKE_FUNC(void *, OP_digest_dupctx, (void *dctx))
d5e5e2ff 210
2893111f 211OSSL_CORE_MAKE_FUNC(int, OP_digest_get_params, (OSSL_PARAM params[]))
92d9d0ae 212OSSL_CORE_MAKE_FUNC(int, OP_digest_set_ctx_params,
2893111f 213 (void *vctx, const OSSL_PARAM params[]))
92d9d0ae 214OSSL_CORE_MAKE_FUNC(int, OP_digest_get_ctx_params,
2893111f 215 (void *vctx, OSSL_PARAM params[]))
ae3ff60e
RL		 216OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_params, (void))
217OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_settable_ctx_params, (void))
218OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_digest_gettable_ctx_params, (void))
df05f2ce
MC		 219
220/* Symmetric Ciphers */
221
df05f2ce
MC		 222# define OSSL_FUNC_CIPHER_NEWCTX 1
223# define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2
224# define OSSL_FUNC_CIPHER_DECRYPT_INIT 3
225# define OSSL_FUNC_CIPHER_UPDATE 4
226# define OSSL_FUNC_CIPHER_FINAL 5
718b133a
MC		 227# define OSSL_FUNC_CIPHER_CIPHER 6
228# define OSSL_FUNC_CIPHER_FREECTX 7
229# define OSSL_FUNC_CIPHER_DUPCTX 8
80942379 230# define OSSL_FUNC_CIPHER_GET_PARAMS 9
92d9d0ae
RL		 231# define OSSL_FUNC_CIPHER_GET_CTX_PARAMS 10
232# define OSSL_FUNC_CIPHER_SET_CTX_PARAMS 11
ae3ff60e
RL		 233# define OSSL_FUNC_CIPHER_GETTABLE_PARAMS 12
234# define OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS 13
235# define OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS 14
df05f2ce 236
a39eb840
RL		 237OSSL_CORE_MAKE_FUNC(void *, OP_cipher_newctx, (void *provctx))
238OSSL_CORE_MAKE_FUNC(int, OP_cipher_encrypt_init, (void *cctx,
df05f2ce 239 const unsigned char *key,
344cfa34
MC		 240 size_t keylen,
241 const unsigned char *iv,
242 size_t ivlen))
a39eb840 243OSSL_CORE_MAKE_FUNC(int, OP_cipher_decrypt_init, (void *cctx,
df05f2ce 244 const unsigned char *key,
344cfa34
MC		 245 size_t keylen,
246 const unsigned char *iv,
247 size_t ivlen))
df05f2ce 248OSSL_CORE_MAKE_FUNC(int, OP_cipher_update,
a39eb840
RL		 249 (void *cctx,
250 unsigned char *out, size_t *outl, size_t outsize,
df05f2ce
MC		 251 const unsigned char *in, size_t inl))
252OSSL_CORE_MAKE_FUNC(int, OP_cipher_final,
a39eb840
RL		 253 (void *cctx,
254 unsigned char *out, size_t *outl, size_t outsize))
df05f2ce 255OSSL_CORE_MAKE_FUNC(int, OP_cipher_cipher,
a39eb840 256 (void *cctx,
f79858ac
RL		 257 unsigned char *out, size_t *outl, size_t outsize,
258 const unsigned char *in, size_t inl))
a39eb840
RL		 259OSSL_CORE_MAKE_FUNC(void, OP_cipher_freectx, (void *cctx))
260OSSL_CORE_MAKE_FUNC(void *, OP_cipher_dupctx, (void *cctx))
4e7991b4 261OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_params, (OSSL_PARAM params[]))
92d9d0ae 262OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_ctx_params, (void *cctx,
4e7991b4 263 OSSL_PARAM params[]))
92d9d0ae 264OSSL_CORE_MAKE_FUNC(int, OP_cipher_set_ctx_params, (void *cctx,
718b133a 265 const OSSL_PARAM params[]))
784883fc
SL		 266OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_params, (void))
267OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_settable_ctx_params, (void))
268OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_cipher_gettable_ctx_params, (void))
df05f2ce 269
e74bd290
RL		 270/* MACs */
271
e74bd290
RL		 272# define OSSL_FUNC_MAC_NEWCTX 1
273# define OSSL_FUNC_MAC_DUPCTX 2
274# define OSSL_FUNC_MAC_FREECTX 3
275# define OSSL_FUNC_MAC_INIT 4
276# define OSSL_FUNC_MAC_UPDATE 5
277# define OSSL_FUNC_MAC_FINAL 6
784883fc
SL		 278# define OSSL_FUNC_MAC_GET_PARAMS 7
279# define OSSL_FUNC_MAC_GET_CTX_PARAMS 8
280# define OSSL_FUNC_MAC_SET_CTX_PARAMS 9
281# define OSSL_FUNC_MAC_GETTABLE_PARAMS 10
282# define OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS 11
283# define OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS 12
e74bd290
RL		 284
285OSSL_CORE_MAKE_FUNC(void *, OP_mac_newctx, (void *provctx))
286OSSL_CORE_MAKE_FUNC(void *, OP_mac_dupctx, (void *src))
287OSSL_CORE_MAKE_FUNC(void, OP_mac_freectx, (void *mctx))
288OSSL_CORE_MAKE_FUNC(size_t, OP_mac_size, (void *mctx))
289OSSL_CORE_MAKE_FUNC(int, OP_mac_init, (void *mctx))
290OSSL_CORE_MAKE_FUNC(int, OP_mac_update,
291 (void *mctx, const unsigned char *in, size_t inl))
292OSSL_CORE_MAKE_FUNC(int, OP_mac_final,
293 (void *mctx,
294 unsigned char *out, size_t *outl, size_t outsize))
295OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_params, (void))
296OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_gettable_ctx_params, (void))
297OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_mac_settable_ctx_params, (void))
298OSSL_CORE_MAKE_FUNC(int, OP_mac_get_params, (OSSL_PARAM params[]))
92d9d0ae 299OSSL_CORE_MAKE_FUNC(int, OP_mac_get_ctx_params,
e74bd290 300 (void *mctx, OSSL_PARAM params[]))
92d9d0ae 301OSSL_CORE_MAKE_FUNC(int, OP_mac_set_ctx_params,
e74bd290
RL		 302 (void *mctx, const OSSL_PARAM params[]))
303
2f755701 304/* KDFs and PRFs */
2f755701
P		 305
306# define OSSL_FUNC_KDF_NEWCTX 1
307# define OSSL_FUNC_KDF_DUPCTX 2
308# define OSSL_FUNC_KDF_FREECTX 3
309# define OSSL_FUNC_KDF_RESET 4
310# define OSSL_FUNC_KDF_DERIVE 5
311# define OSSL_FUNC_KDF_GETTABLE_PARAMS 6
312# define OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS 7
313# define OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS 8
314# define OSSL_FUNC_KDF_GET_PARAMS 9
315# define OSSL_FUNC_KDF_GET_CTX_PARAMS 10
316# define OSSL_FUNC_KDF_SET_CTX_PARAMS 11
317
318OSSL_CORE_MAKE_FUNC(void *, OP_kdf_newctx, (void *provctx))
319OSSL_CORE_MAKE_FUNC(void *, OP_kdf_dupctx, (void *src))
320OSSL_CORE_MAKE_FUNC(void, OP_kdf_freectx, (void *kctx))
321OSSL_CORE_MAKE_FUNC(void, OP_kdf_reset, (void *kctx))
322OSSL_CORE_MAKE_FUNC(int, OP_kdf_derive, (void *kctx, unsigned char *key,
323 size_t keylen))
324OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_gettable_params, (void))
325OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_gettable_ctx_params, (void))
326OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_kdf_settable_ctx_params, (void))
327OSSL_CORE_MAKE_FUNC(int, OP_kdf_get_params, (OSSL_PARAM params[]))
328OSSL_CORE_MAKE_FUNC(int, OP_kdf_get_ctx_params,
329 (void *kctx, OSSL_PARAM params[]))
330OSSL_CORE_MAKE_FUNC(int, OP_kdf_set_ctx_params,
331 (void *kctx, const OSSL_PARAM params[]))
332
a94a3e0d
RL		 333/*-
334 * Key management
335 *
b305452f
RL		 336 * The Key Management takes care of provider side key objects, and includes
337 * all current functionality to create them, destroy them, set parameters
338 * and key material, etc, essentially everything that manipulates the keys
339 * themselves and their parameters.
a94a3e0d 340 *
b305452f
RL		 341 * The key objects are commonly refered to as |keydata|, and it MUST be able
342 * to contain parameters if the key has any, the public key and the private
343 * key. All parts are optional, but their presence determines what can be
344 * done with the key object in terms of encryption, signature, and so on.
345 * The assumption from libcrypto is that the key object contains any of the
346 * following data combinations:
347 *
348 * - parameters only
349 * - public key only
350 * - public key + private key
351 * - parameters + public key
352 * - parameters + public key + private key
353 *
354 * What "parameters", "public key" and "private key" means in detail is left
355 * to the implementation. In the case of DH and DSA, they would typically
356 * include domain parameters, while for certain variants of RSA, they would
357 * typically include PSS or OAEP parameters.
358 *
359 * Key objects are created with OP_keymgmt_new() and destroyed with
360 * Op_keymgmt_free(). Key objects can have data filled in with
361 * OP_keymgmt_import().
362 *
363 * Three functions are made available to check what selection of data is
364 * present in a key object: OP_keymgmt_has_parameters(),
365 * OP_keymgmt_has_public_key(), and OP_keymgmt_has_private_key(),
a94a3e0d
RL		 366 */
367
b305452f
RL		 368/* Key data subset selection - individual bits */
369# define OSSL_KEYMGMT_SELECT_PRIVATE_KEY 0x01
370# define OSSL_KEYMGMT_SELECT_PUBLIC_KEY 0x02
371# define OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS 0x04
372# define OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS 0x80
373
374/* Key data subset selection - combinations */
375# define OSSL_KEYMGMT_SELECT_ALL_PARAMETERS \
376 ( OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS \
377 | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
378# define OSSL_KEYMGMT_SELECT_KEYPAIR \
379 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY | OSSL_KEYMGMT_SELECT_PUBLIC_KEY )
380# define OSSL_KEYMGMT_SELECT_ALL \
381 ( OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS )
382
383/* Basic key object creation, destruction */
384# define OSSL_FUNC_KEYMGMT_NEW 1
385# define OSSL_FUNC_KEYMGMT_FREE 9
386OSSL_CORE_MAKE_FUNC(void *, OP_keymgmt_new, (void *provctx))
387OSSL_CORE_MAKE_FUNC(void, OP_keymgmt_free, (void *keydata))
388
389/* Key object information, with discovery */
390#define OSSL_FUNC_KEYMGMT_GET_PARAMS 10
391#define OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS 11
392OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_get_params,
393 (void *keydata, OSSL_PARAM params[]))
394OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_gettable_params, (void))
395
4fe54d67
NT		 396#define OSSL_FUNC_KEYMGMT_SET_PARAMS 12
397#define OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS 13
398OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_set_params,
399 (void *keydata, const OSSL_PARAM params[]))
400OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_settable_params, (void))
401
b305452f
RL		 402/* Key checks - discovery of supported operations */
403# define OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME 20
404OSSL_CORE_MAKE_FUNC(const char *, OP_keymgmt_query_operation_name,
e62a45b6
RL		 405 (int operation_id))
406
b305452f
RL		 407/* Key checks - key data content checks */
408# define OSSL_FUNC_KEYMGMT_HAS 21
409OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_has, (void *keydata, int selection))
410
411/* Key checks - validation */
412# define OSSL_FUNC_KEYMGMT_VALIDATE 22
413OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_validate, (void *keydata, int selection))
414
bee5d6cd
RL		 415/* Key checks - matching */
416# define OSSL_FUNC_KEYMGMT_MATCH 23
417OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_match,
418 (const void *keydata1, const void *keydata2,
419 int selection))
420
13697f1c 421/* Import and export functions, with discovery */
b305452f
RL		 422# define OSSL_FUNC_KEYMGMT_IMPORT 40
423# define OSSL_FUNC_KEYMGMT_IMPORT_TYPES 41
424# define OSSL_FUNC_KEYMGMT_EXPORT 42
425# define OSSL_FUNC_KEYMGMT_EXPORT_TYPES 43
426OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_import,
427 (void *keydata, int selection, const OSSL_PARAM params[]))
428OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_import_types,
429 (int selection))
430OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_export,
431 (void *keydata, int selection,
432 OSSL_CALLBACK *param_cb, void *cbarg))
433OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keymgmt_export_types,
434 (int selection))
12603de6 435
13697f1c
RL		 436/* Copy function, only works for matching keymgmt */
437# define OSSL_FUNC_KEYMGMT_COPY 44
438OSSL_CORE_MAKE_FUNC(int, OP_keymgmt_copy,
439 ( void *keydata_to, const void *keydata_from,
440 int selection))
441
ff64702b
MC		 442/* Key Exchange */
443
ff64702b
MC		 444# define OSSL_FUNC_KEYEXCH_NEWCTX 1
445# define OSSL_FUNC_KEYEXCH_INIT 2
446# define OSSL_FUNC_KEYEXCH_DERIVE 3
447# define OSSL_FUNC_KEYEXCH_SET_PEER 4
448# define OSSL_FUNC_KEYEXCH_FREECTX 5
449# define OSSL_FUNC_KEYEXCH_DUPCTX 6
9c45222d
MC		 450# define OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS 7
451# define OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS 8
4fe54d67
NT		 452# define OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS 9
453# define OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS 10
ff64702b
MC		 454
455OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_newctx, (void *provctx))
8b84b075 456OSSL_CORE_MAKE_FUNC(int, OP_keyexch_init, (void *ctx, void *provkey))
59972370
MC		 457OSSL_CORE_MAKE_FUNC(int, OP_keyexch_derive, (void *ctx, unsigned char *secret,
458 size_t *secretlen, size_t outlen))
8b84b075 459OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_peer, (void *ctx, void *provkey))
ff64702b
MC		 460OSSL_CORE_MAKE_FUNC(void, OP_keyexch_freectx, (void *ctx))
461OSSL_CORE_MAKE_FUNC(void *, OP_keyexch_dupctx, (void *ctx))
9c45222d
MC		 462OSSL_CORE_MAKE_FUNC(int, OP_keyexch_set_ctx_params, (void *ctx,
463 const OSSL_PARAM params[]))
464OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keyexch_settable_ctx_params,
465 (void))
4fe54d67
NT		 466OSSL_CORE_MAKE_FUNC(int, OP_keyexch_get_ctx_params, (void *ctx,
467 OSSL_PARAM params[]))
468OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_keyexch_gettable_ctx_params,
469 (void))
ff64702b 470
dfcb5d29
MC		 471/* Signature */
472
473# define OSSL_FUNC_SIGNATURE_NEWCTX 1
474# define OSSL_FUNC_SIGNATURE_SIGN_INIT 2
475# define OSSL_FUNC_SIGNATURE_SIGN 3
390acbeb
MC		 476# define OSSL_FUNC_SIGNATURE_VERIFY_INIT 4
477# define OSSL_FUNC_SIGNATURE_VERIFY 5
478# define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT 6
479# define OSSL_FUNC_SIGNATURE_VERIFY_RECOVER 7
d8c98d79
MC		 480# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT 8
481# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE 9
482# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL 10
eea1e780
MC		 483# define OSSL_FUNC_SIGNATURE_DIGEST_SIGN 11
484# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT 12
485# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE 13
486# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL 14
487# define OSSL_FUNC_SIGNATURE_DIGEST_VERIFY 15
488# define OSSL_FUNC_SIGNATURE_FREECTX 16
489# define OSSL_FUNC_SIGNATURE_DUPCTX 17
490# define OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS 18
491# define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS 19
492# define OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS 20
493# define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS 21
494# define OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS 22
495# define OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS 23
496# define OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS 24
497# define OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS 25
dfcb5d29
MC		 498
499OSSL_CORE_MAKE_FUNC(void *, OP_signature_newctx, (void *provctx))
500OSSL_CORE_MAKE_FUNC(int, OP_signature_sign_init, (void *ctx, void *provkey))
501OSSL_CORE_MAKE_FUNC(int, OP_signature_sign, (void *ctx, unsigned char *sig,
502 size_t *siglen, size_t sigsize,
503 const unsigned char *tbs,
504 size_t tbslen))
390acbeb
MC		 505OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_init, (void *ctx, void *provkey))
506OSSL_CORE_MAKE_FUNC(int, OP_signature_verify, (void *ctx,
507 const unsigned char *sig,
508 size_t siglen,
509 const unsigned char *tbs,
510 size_t tbslen))
511OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_recover_init, (void *ctx,
512 void *provkey))
513OSSL_CORE_MAKE_FUNC(int, OP_signature_verify_recover, (void *ctx,
514 unsigned char *rout,
515 size_t *routlen,
516 size_t routsize,
517 const unsigned char *sig,
518 size_t siglen))
d8c98d79
MC		 519OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_init,
520 (void *ctx, const char *mdname, const char *props,
521 void *provkey))
522OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_update,
523 (void *ctx, const unsigned char *data, size_t datalen))
524OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign_final,
525 (void *ctx, unsigned char *sig, size_t *siglen,
526 size_t sigsize))
eea1e780
MC		 527OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_sign,
528 (void *ctx, unsigned char *sigret, size_t *siglen,
529 size_t sigsize, const unsigned char *tbs, size_t tbslen))
d8c98d79
MC		 530OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_init,
531 (void *ctx, const char *mdname, const char *props,
532 void *provkey))
533OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_update,
534 (void *ctx, const unsigned char *data, size_t datalen))
535OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify_final,
536 (void *ctx, const unsigned char *sig, size_t siglen))
eea1e780
MC		 537OSSL_CORE_MAKE_FUNC(int, OP_signature_digest_verify,
538 (void *ctx, const unsigned char *sig, size_t siglen,
539 const unsigned char *tbs, size_t tbslen))
dfcb5d29
MC		 540OSSL_CORE_MAKE_FUNC(void, OP_signature_freectx, (void *ctx))
541OSSL_CORE_MAKE_FUNC(void *, OP_signature_dupctx, (void *ctx))
9c45222d
MC		 542OSSL_CORE_MAKE_FUNC(int, OP_signature_get_ctx_params,
543 (void *ctx, OSSL_PARAM params[]))
544OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_gettable_ctx_params,
545 (void))
546OSSL_CORE_MAKE_FUNC(int, OP_signature_set_ctx_params,
547 (void *ctx, const OSSL_PARAM params[]))
548OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_settable_ctx_params,
549 (void))
d8c98d79
MC		 550OSSL_CORE_MAKE_FUNC(int, OP_signature_get_ctx_md_params,
551 (void *ctx, OSSL_PARAM params[]))
552OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_gettable_ctx_md_params,
553 (void *ctx))
554OSSL_CORE_MAKE_FUNC(int, OP_signature_set_ctx_md_params,
555 (void *ctx, const OSSL_PARAM params[]))
556OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_signature_settable_ctx_md_params,
557 (void *ctx))
dfcb5d29 558
2c938e2e
MC		 559
560/* Asymmetric Ciphers */
561
562# define OSSL_FUNC_ASYM_CIPHER_NEWCTX 1
563# define OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT 2
564# define OSSL_FUNC_ASYM_CIPHER_ENCRYPT 3
565# define OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT 4
566# define OSSL_FUNC_ASYM_CIPHER_DECRYPT 5
567# define OSSL_FUNC_ASYM_CIPHER_FREECTX 6
568# define OSSL_FUNC_ASYM_CIPHER_DUPCTX 7
569# define OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS 8
570# define OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS 9
571# define OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS 10
572# define OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS 11
573
574OSSL_CORE_MAKE_FUNC(void *, OP_asym_cipher_newctx, (void *provctx))
575OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_encrypt_init, (void *ctx, void *provkey))
576OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_encrypt, (void *ctx, unsigned char *out,
577 size_t *outlen,
578 size_t outsize,
579 const unsigned char *in,
580 size_t inlen))
581OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_decrypt_init, (void *ctx, void *provkey))
582OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_decrypt, (void *ctx, unsigned char *out,
583 size_t *outlen,
584 size_t outsize,
585 const unsigned char *in,
586 size_t inlen))
587OSSL_CORE_MAKE_FUNC(void, OP_asym_cipher_freectx, (void *ctx))
588OSSL_CORE_MAKE_FUNC(void *, OP_asym_cipher_dupctx, (void *ctx))
589OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_get_ctx_params,
590 (void *ctx, OSSL_PARAM params[]))
591OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_asym_cipher_gettable_ctx_params,
592 (void))
593OSSL_CORE_MAKE_FUNC(int, OP_asym_cipher_set_ctx_params,
594 (void *ctx, const OSSL_PARAM params[]))
595OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_asym_cipher_settable_ctx_params,
596 (void))
597
0d003c52
RL		 598/* Serializers */
599# define OSSL_FUNC_SERIALIZER_NEWCTX 1
600# define OSSL_FUNC_SERIALIZER_FREECTX 2
601# define OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS 3
602# define OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS 4
603# define OSSL_FUNC_SERIALIZER_SERIALIZE_DATA 10
604# define OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT 11
605OSSL_CORE_MAKE_FUNC(void *, OP_serializer_newctx, (void *provctx))
606OSSL_CORE_MAKE_FUNC(void, OP_serializer_freectx, (void *ctx))
607OSSL_CORE_MAKE_FUNC(int, OP_serializer_set_ctx_params,
608 (void *ctx, const OSSL_PARAM params[]))
609OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, OP_serializer_settable_ctx_params,
610 (void))
611
612OSSL_CORE_MAKE_FUNC(int, OP_serializer_serialize_data,
613 (void *ctx, const OSSL_PARAM[], BIO *out,
614 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
615OSSL_CORE_MAKE_FUNC(int, OP_serializer_serialize_object,
616 (void *ctx, void *obj, BIO *out,
617 OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg))
618
4c2883a9
RL		 619# ifdef __cplusplus
620}
621# endif
622
623#endif
A mirror of the official openssl repository