2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #ifndef OPENSSL_CORE_H
11 # define OPENSSL_CORE_H
14 # include <openssl/types.h>
24 * These are the types that the OpenSSL core and providers have in common
25 * to communicate data between them.
29 * Dispatch table element. function_id numbers are defined further down,
30 * see macros with '_FUNC' in their names.
32 * An array of these is always terminated by function_id == 0
34 struct ossl_dispatch_st {
36 void (*function)(void);
40 * Other items, essentially an int<->pointer map element.
42 * We make this type distinct from OSSL_DISPATCH to ensure that dispatch
43 * tables remain tables with function pointers only.
45 * This is used whenever we need to pass things like a table of error reason
46 * codes <-> reason string maps, ...
48 * Usage determines which field works as key if any, rather than field order.
50 * An array of these is always terminated by id == 0 && ptr == NULL
58 * Type to tie together algorithm names, property definition string and
59 * the algorithm implementation in the form of a dispatch table.
61 * An array of these is always terminated by algorithm_names == NULL
63 struct ossl_algorithm_st {
64 const char *algorithm_names; /* key */
65 const char *property_definition; /* key */
66 const OSSL_DISPATCH *implementation;
70 * Type to pass object data in a uniform way, without exposing the object
73 * An array of these is always terminated by key == NULL
75 struct ossl_param_st {
76 const char *key; /* the name of the parameter */
77 unsigned int data_type; /* declare what kind of content is in buffer */
78 void *data; /* value being passed in or out */
79 size_t data_size; /* data size */
80 size_t return_size; /* returned content size */
83 /* Currently supported OSSL_PARAM data types */
85 * OSSL_PARAM_INTEGER and OSSL_PARAM_UNSIGNED_INTEGER
86 * are arbitrary length and therefore require an arbitrarily sized buffer,
87 * since they may be used to pass numbers larger than what is natively
90 * The number must be buffered in native form, i.e. MSB first on B_ENDIAN
91 * systems and LSB first on L_ENDIAN systems. This means that arbitrary
92 * native integers can be stored in the buffer, just make sure that the
93 * buffer size is correct and the buffer itself is properly aligned (for
94 * example by having the buffer field point at a C integer).
96 # define OSSL_PARAM_INTEGER 1
97 # define OSSL_PARAM_UNSIGNED_INTEGER 2
100 * is a C binary floating point values in native form and alignment.
102 # define OSSL_PARAM_REAL 3
104 * OSSL_PARAM_UTF8_STRING
105 * is a printable string. Is expteced to be printed as it is.
107 # define OSSL_PARAM_UTF8_STRING 4
109 * OSSL_PARAM_OCTET_STRING
110 * is a string of bytes with no further specification. Is expected to be
111 * printed as a hexdump.
113 # define OSSL_PARAM_OCTET_STRING 5
115 * OSSL_PARAM_UTF8_PTR
116 * is a pointer to a printable string. Is expteced to be printed as it is.
118 * The difference between this and OSSL_PARAM_UTF8_STRING is that only pointers
119 * are manipulated for this type.
121 * This is more relevant for parameter requests, where the responding
122 * function doesn't need to copy the data to the provided buffer, but
123 * sets the provided buffer to point at the actual data instead.
125 * WARNING! Using these is FRAGILE, as it assumes that the actual
126 * data and its location are constant.
128 * EXTRA WARNING! If you are not completely sure you most likely want
129 * to use the OSSL_PARAM_UTF8_STRING type.
131 # define OSSL_PARAM_UTF8_PTR 6
133 * OSSL_PARAM_OCTET_PTR
134 * is a pointer to a string of bytes with no further specification. It is
135 * expected to be printed as a hexdump.
137 * The difference between this and OSSL_PARAM_OCTET_STRING is that only pointers
138 * are manipulated for this type.
140 * This is more relevant for parameter requests, where the responding
141 * function doesn't need to copy the data to the provided buffer, but
142 * sets the provided buffer to point at the actual data instead.
144 * WARNING! Using these is FRAGILE, as it assumes that the actual
145 * data and its location are constant.
147 * EXTRA WARNING! If you are not completely sure you most likely want
148 * to use the OSSL_PARAM_OCTET_STRING type.
150 # define OSSL_PARAM_OCTET_PTR 7
153 * Typedef for the thread stop handling callback. Used both internally and by
156 * Providers may register for notifications about threads stopping by
157 * registering a callback to hear about such events. Providers register the
158 * callback using the OSSL_FUNC_CORE_THREAD_START function in the |in| dispatch
159 * table passed to OSSL_provider_init(). The arg passed back to a provider will
160 * be the provider side context object.
162 typedef void (*OSSL_thread_stop_handler_fn)(void *arg);
166 * Provider entry point
167 * --------------------
169 * This function is expected to be present in any dynamically loadable
170 * provider module. By definition, if this function doesn't exist in a
171 * module, that module is not an OpenSSL provider module.
174 * |provider| pointer to opaque type OSSL_PROVIDER. This can be used
175 * together with some functions passed via |in| to query data.
176 * |in| is the array of functions that the Core passes to the provider.
177 * |out| will be the array of base functions that the provider passes
179 * |provctx| a provider side context object, optionally created if the
180 * provider needs it. This value is passed to other provider
181 * functions, notably other context constructors.
183 typedef int (OSSL_provider_init_fn)(const OSSL_PROVIDER *provider,
184 const OSSL_DISPATCH *in,
185 const OSSL_DISPATCH **out,
189 # pragma names uppercase,truncated
191 extern OSSL_provider_init_fn OSSL_provider_init;
193 # pragma names restore
197 * Generic callback function signature.
199 * The expectation is that any provider function that wants to offer
200 * a callback / hook can do so by taking an argument with this type,
201 * as well as a pointer to caller-specific data. When calling the
202 * callback, the provider function can populate an OSSL_PARAM array
203 * with data of its choice and pass that in the callback call, along
204 * with the caller data argument.
206 * libcrypto may use the OSSL_PARAM array to create arguments for an
207 * application callback it knows about.
209 typedef int (OSSL_CALLBACK)(const OSSL_PARAM params[], void *arg);
212 * Passphrase callback function signature
214 * This is similar to the generic callback function above, but adds a
217 typedef int (OSSL_PASSPHRASE_CALLBACK)(char *pass, size_t pass_size,
219 const OSSL_PARAM params[], void *arg);