Rename some occurrences of 'library_context' and 'lib_ctx' to 'libctx'
[openssl.git] / doc / man7 / provider-base.pod
1 =pod
2
3 =head1 NAME
4
5 provider-base
6 - The basic OpenSSL library E<lt>-E<gt> provider functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/core_dispatch.h>
11
12  /*
13   * None of these are actual functions, but are displayed like this for
14   * the function signatures for functions that are offered as function
15   * pointers in OSSL_DISPATCH arrays.
16   */
17
18  /* Functions offered by libcrypto to the providers */
19  const OSSL_ITEM *core_gettable_params(const OSSL_CORE_HANDLE *handle);
20  int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[]);
21  int core_thread_start(const OSSL_CORE_HANDLE *handle,
22                        OSSL_thread_stop_handler_fn handfn);
23  OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle);
24  void core_new_error(const OSSL_CORE_HANDLE *handle);
25  void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
26                            const char *file, int line, const char *func);
27  void core_vset_error(const OSSL_CORE_HANDLE *handle,
28                       uint32_t reason, const char *fmt, va_list args);
29
30  /*
31   * Some OpenSSL functionality is directly offered to providers via
32   * dispatch
33   */
34  void *CRYPTO_malloc(size_t num, const char *file, int line);
35  void *CRYPTO_zalloc(size_t num, const char *file, int line);
36  void *CRYPTO_memdup(const void *str, size_t siz,
37                      const char *file, int line);
38  char *CRYPTO_strdup(const char *str, const char *file, int line);
39  char *CRYPTO_strndup(const char *str, size_t s,
40                       const char *file, int line);
41  void CRYPTO_free(void *ptr, const char *file, int line);
42  void CRYPTO_clear_free(void *ptr, size_t num,
43                         const char *file, int line);
44  void *CRYPTO_realloc(void *addr, size_t num,
45                       const char *file, int line);
46  void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
47                             const char *file, int line);
48  void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
49  void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
50  void CRYPTO_secure_free(void *ptr, const char *file, int line);
51  void CRYPTO_secure_clear_free(void *ptr, size_t num,
52                                const char *file, int line);
53  int CRYPTO_secure_allocated(const void *ptr);
54  void OPENSSL_cleanse(void *ptr, size_t len);
55
56  OSSL_CORE_BIO * BIO_new_file(const char *filename, const char *mode)
57  OSSL_CORE_BIO * BIO_new_membuf(const void *buf, int len)
58  int BIO_read_ex(OSSL_CORE_BIO *bio, void *data, size_t data_len,
59                  size_t *bytes_read))
60  int BIO_write_ex(OSSL_CORE_BIO *bio, const void *data, size_t data_len,
61                   size_t *written)
62  int BIO_free(OSSL_CORE_BIO *bio))
63  int BIO_vprintf(OSSL_CORE_BIO *bio, const char *format, va_list args)
64  int BIO_vsnprintf(char *buf, size_t n, const char *fmt, va_list args)
65
66  void self_test_cb(OPENSSL_CORE_CTX *ctx, OSSL_CALLBACK **cb, void **cbarg)
67
68
69  /* Functions offered by the provider to libcrypto */
70  void provider_teardown(void *provctx);
71  const OSSL_ITEM *provider_gettable_params(void *provctx);
72  int provider_get_params(void *provctx, OSSL_PARAM params[]);
73  const OSSL_ALGORITHM *provider_query_operation(void *provctx,
74                                                 int operation_id,
75                                                 const int *no_store);
76  const OSSL_ITEM *provider_get_reason_strings(void *provctx);
77  int provider_get_capabilities(void *provctx, const char *capability,
78                                OSSL_CALLBACK *cb, void *arg);
79
80 =head1 DESCRIPTION
81
82 All "functions" mentioned here are passed as function pointers between
83 F<libcrypto> and the provider in B<OSSL_DISPATCH> arrays, in the call
84 of the provider initialization function.  See L<provider(7)/Provider>
85 for a description of the initialization function.
86
87 All these "functions" have a corresponding function type definition
88 named B<OSSL_{name}_fn>, and a helper function to retrieve the
89 function pointer from a B<OSSL_DISPATCH> element named
90 B<OSSL_FUNC_{name}>.
91 For example, the "function" core_gettable_params() has these:
92
93  typedef OSSL_PARAM *
94      (OSSL_FUNC_core_gettable_params_fn)(const OSSL_CORE_HANDLE *handle);
95  static ossl_inline OSSL_NAME_core_gettable_params_fn
96      OSSL_FUNC_core_gettable_params(const OSSL_DISPATCH *opf);
97
98 B<OSSL_DISPATCH> arrays are indexed by numbers that are provided as
99 macros in L<openssl-core_dispatch.h(7)>, as follows:
100
101 For I<in> (the B<OSSL_DISPATCH> array passed from F<libcrypto> to the
102 provider):
103
104  core_gettable_params           OSSL_FUNC_CORE_GETTABLE_PARAMS
105  core_get_params                OSSL_FUNC_CORE_GET_PARAMS
106  core_thread_start              OSSL_FUNC_CORE_THREAD_START
107  core_get_libctx                OSSL_FUNC_CORE_GET_LIBCTX
108  core_new_error                 OSSL_FUNC_CORE_NEW_ERROR
109  core_set_error_debug           OSSL_FUNC_CORE_SET_ERROR_DEBUG
110  core_set_error                 OSSL_FUNC_CORE_SET_ERROR
111  CRYPTO_malloc                  OSSL_FUNC_CRYPTO_MALLOC
112  CRYPTO_zalloc                  OSSL_FUNC_CRYPTO_ZALLOC
113  CRYPTO_memdup                  OSSL_FUNC_CRYPTO_MEMDUP
114  CRYPTO_strdup                  OSSL_FUNC_CRYPTO_STRDUP
115  CRYPTO_strndup                 OSSL_FUNC_CRYPTO_STRNDUP
116  CRYPTO_free                    OSSL_FUNC_CRYPTO_FREE
117  CRYPTO_clear_free              OSSL_FUNC_CRYPTO_CLEAR_FREE
118  CRYPTO_realloc                 OSSL_FUNC_CRYPTO_REALLOC
119  CRYPTO_clear_realloc           OSSL_FUNC_CRYPTO_CLEAR_REALLOC
120  CRYPTO_secure_malloc           OSSL_FUNC_CRYPTO_SECURE_MALLOC
121  CRYPTO_secure_zalloc           OSSL_FUNC_CRYPTO_SECURE_ZALLOC
122  CRYPTO_secure_free             OSSL_FUNC_CRYPTO_SECURE_FREE
123  CRYPTO_secure_clear_free       OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE
124  CRYPTO_secure_allocated        OSSL_FUNC_CRYPTO_SECURE_ALLOCATED
125  BIO_new_file                   OSSL_FUNC_BIO_NEW_FILE
126  BIO_new_mem_buf                OSSL_FUNC_BIO_NEW_MEMBUF
127  BIO_read_ex                    OSSL_FUNC_BIO_READ_EX
128  BIO_free                       OSSL_FUNC_BIO_FREE
129  BIO_vprintf                    OSSL_FUNC_BIO_VPRINTF
130  OPENSSL_cleanse                OSSL_FUNC_OPENSSL_CLEANSE
131  OSSL_SELF_TEST_set_callback    OSSL_FUNC_SELF_TEST_CB
132
133 For I<*out> (the B<OSSL_DISPATCH> array passed from the provider to
134 F<libcrypto>):
135
136  provider_teardown              OSSL_FUNC_PROVIDER_TEARDOWN
137  provider_gettable_params       OSSL_FUNC_PROVIDER_GETTABLE_PARAMS
138  provider_get_params            OSSL_FUNC_PROVIDER_GET_PARAMS
139  provider_query_operation       OSSL_FUNC_PROVIDER_QUERY_OPERATION
140  provider_get_reason_strings    OSSL_FUNC_PROVIDER_GET_REASON_STRINGS
141  provider_get_capabilities      OSSL_FUNC_PROVIDER_GET_CAPABILITIES
142  provider_self_test             OSSL_FUNC_PROVIDER_SELF_TEST
143
144 =head2 Core functions
145
146 core_gettable_params() returns a constant array of descriptor
147 B<OSSL_PARAM>, for parameters that core_get_params() can handle.
148
149 core_get_params() retrieves parameters from the core for the given I<handle>.
150 See L</Core parameters> below for a description of currently known
151 parameters.
152
153 =for comment core_thread_start() TBA
154
155 core_get_libctx() retrieves the library context in which the library
156 object for the current provider is stored, accessible through the I<handle>.
157 This may sometimes be useful if the provider wishes to store a
158 reference to its context in the same library context.
159
160 core_new_error(), core_set_error_debug() and core_set_error() are
161 building blocks for reporting an error back to the core, with
162 reference to the I<handle>.
163
164 =over 4
165
166 =item core_new_error()
167
168 allocates a new thread specific error record.
169
170 This corresponds to the OpenSSL function L<ERR_new(3)>.
171
172 =item core_set_error_debug()
173
174 sets debugging information in the current thread specific error
175 record.
176 The debugging information includes the name of the file I<file>, the
177 line I<line> and the function name I<func> where the error occurred.
178
179 This corresponds to the OpenSSL function L<ERR_set_debug(3)>.
180
181 =item core_set_error()
182
183 sets the I<reason> for the error, along with any addition data.
184 The I<reason> is a number defined by the provider and used to index
185 the reason strings table that's returned by
186 provider_get_reason_strings().
187 The additional data is given as a format string I<fmt> and a set of
188 arguments I<args>, which are treated in the same manner as with
189 BIO_vsnprintf().
190 I<file> and I<line> may also be passed to indicate exactly where the
191 error occurred or was reported.
192
193 This corresponds to the OpenSSL function L<ERR_vset_error(3)>.
194
195 =back
196
197 CRYPTO_malloc(), CRYPTO_zalloc(), CRYPTO_memdup(), CRYPTO_strdup(),
198 CRYPTO_strndup(), CRYPTO_free(), CRYPTO_clear_free(),
199 CRYPTO_realloc(), CRYPTO_clear_realloc(), CRYPTO_secure_malloc(),
200 CRYPTO_secure_zalloc(), CRYPTO_secure_free(),
201 CRYPTO_secure_clear_free(), CRYPTO_secure_allocated(),
202 BIO_new_file(), BIO_new_mem_buf(), BIO_read_ex(), BIO_free(),
203 BIO_vprintf(), OPENSSL_cleanse(), and OPENSSL_hexstr2buf()
204 correspond exactly to the public functions with the same name.
205 As a matter of fact, the pointers in the B<OSSL_DISPATCH> array are
206 direct pointers to those public functions. Note that the BIO functions take an
207 B<OSSL_CORE_BIO> type rather than the standard B<BIO> type. This is to ensure
208 that a provider does not mix BIOs from the core with BIOs used on the provider
209 side (the two are not compatible).
210 OSSL_SELF_TEST_set_callback() is used to set an optional callback that can be
211 passed into a provider. This may be ignored by a provider.
212
213 =head2 Provider functions
214
215 provider_teardown() is called when a provider is shut down and removed
216 from the core's provider store.
217 It must free the passed I<provctx>.
218
219 provider_gettable_params() should return a constant array of
220 descriptor B<OSSL_PARAM>, for parameters that provider_get_params()
221 can handle.
222
223 provider_get_params() should process the B<OSSL_PARAM> array
224 I<params>, setting the values of the parameters it understands.
225
226 provider_query_operation() should return a constant B<OSSL_ALGORITHM>
227 that corresponds to the given I<operation_id>.
228 It should indicate if the core may store a reference to this array by
229 setting I<*no_store> to 0 (core may store a reference) or 1 (core may
230 not store a reference).
231
232 provider_get_reason_strings() should return a constant B<OSSL_ITEM>
233 array that provides reason strings for reason codes the provider may
234 use when reporting errors using core_put_error().
235
236 The provider_get_capabilities() function should call the callback I<cb> passing
237 it a set of B<OSSL_PARAM>s and the caller supplied argument I<arg>. The
238 B<OSSL_PARAM>s should provide details about the capability with the name given
239 in the I<capability> argument relevant for the provider context I<provctx>. If a
240 provider supports multiple capabilities with the given name then it may call the
241 callback multiple times (one for each capability). Capabilities can be useful for
242 describing the services that a provider can offer. For further details see the
243 L</CAPABILITIES> section below. It should return 1 on success or 0 on error.
244
245 The provider_self_test() function should perform known answer tests on a subset
246 of the algorithms that it uses, and may also verify the integrity of the
247 provider module. It should return 1 on success or 0 on error. It will return 1
248 if this function is not used.
249
250 None of these functions are mandatory, but a provider is fairly
251 useless without at least provider_query_operation(), and
252 provider_gettable_params() is fairly useless if not accompanied by
253 provider_get_params().
254
255 =head2 Provider parameters
256
257 provider_get_params() can return the following provider parameters to the core:
258
259 =over 4
260
261 =item "name" (B<OSSL_PROV_PARAM_NAME>) <UTF8_ptr>
262
263 This points to a string that should give a unique name for the provider.
264
265 =item "version" (B<OSSL_PROV_PARAM_VERSION>) <UTF8_ptr>
266
267 This points to a string that is a version number associated with this provider.
268 OpenSSL in-built providers use OPENSSL_VERSION_STR, but this may be different
269 for any third party provider. This string is for informational purposes only.
270
271 =item "buildinfo" (B<OSSL_PROV_PARAM_BUILDINFO>) <UTF8_ptr>
272
273 This points to a string that is a build information associated with this provider.
274 OpenSSL in-built providers use OPENSSL_FULL_VERSION_STR, but this may be
275 different for any third party provider.
276
277 =item "status" (B<OSSL_PROV_PARAM_STATUS>) <unsigned integer>
278
279 This returns 0 if the provider has entered an error state, otherwise it returns
280 1.
281
282 =back 
283
284 provider_gettable_params() should return the above parameters.
285
286
287 =head2 Core parameters
288
289 core_get_params() can retrieve the following core parameters for each provider:
290
291 =over 4
292
293 =item "openssl-version" (B<OSSL_PROV_PARAM_CORE_VERSION>) <UTF8_ptr>
294
295 This points to the OpenSSL libraries' full version string, i.e. the string
296 expanded from the macro B<OPENSSL_VERSION_STR>.
297
298 =item "provider-name" (B<OSSL_PROV_PARAM_CORE_PROV_NAME>) <UTF8_ptr>
299
300 This points to the OpenSSL libraries' idea of what the calling provider is named.
301
302 =item "module-filename" (B<OSSL_PROV_PARAM_CORE_MODULE_FILENAME>) <UTF8_ptr>
303
304 This points to a string containing the full filename of the providers
305 module file.
306
307 =back
308
309 Additionally, provider specific configuration parameters from the
310 config file are available, in dotted name form.
311 The dotted name form is a concatenation of section names and final
312 config command name separated by periods.
313
314 For example, let's say we have the following config example:
315
316  openssl_conf = openssl_init
317
318  [openssl_init]
319  providers = providers_sect
320
321  [providers_sect]
322  foo = foo_sect
323
324  [foo_sect]
325  activate = 1
326  data1 = 2
327  data2 = str
328  more = foo_more
329
330  [foo_more]
331  data3 = foo,bar
332
333 The provider will have these additional parameters available:
334
335 =over 4
336
337 =item "activate"
338
339 pointing at the string "1"
340
341 =item "data1"
342
343 pointing at the string "2"
344
345 =item "data2"
346
347 pointing at the string "str"
348
349 =item "more.data3"
350
351 pointing at the string "foo,bar"
352
353 =back
354
355 For more information on handling parameters, see L<OSSL_PARAM(3)> as
356 L<OSSL_PARAM_int(3)>.
357
358 =head1 CAPABILITIES
359
360 Capabilities describe some of the services that a provider can offer.
361 Applications can query the capabilities to discover those services.
362
363 =head3 "TLS-GROUP" Capability
364
365 The "TLS-GROUP" capability can be queried by libssl to discover the list of
366 TLS groups that a provider can support. Each group supported can be used for
367 I<key exchange> (KEX) or I<key encapsulation method> (KEM) during a TLS
368 handshake.
369 TLS clients can advertise the list of TLS groups they support in the
370 supported_groups extension, and TLS servers can select a group from the offered
371 list that they also support. In this way a provider can add to the list of
372 groups that libssl already supports with additional ones.
373
374 Each TLS group that a provider supports should be described via the callback
375 passed in through the provider_get_capabilities function. Each group should have
376 the following details supplied (all are mandatory, except
377 B<OSSL_CAPABILITY_TLS_GROUP_IS_KEM>):
378
379 =over 4
380
381 =item "tls-group-name" (B<OSSL_CAPABILITY_TLS_GROUP_NAME>) <utf8 string>
382
383 The name of the group as given in the IANA TLS Supported Groups registry
384 L<https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-8>.
385
386 =item "tls-group-name-internal" (B<OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL>) <utf8 string>
387
388 The name of the group as known by the provider. This could be the same as the
389 "tls-group-name", but does not have to be.
390
391 =item "tls-group-id" (B<OSSL_CAPABILITY_TLS_GROUP_ID>) <unsigned integer>
392
393 The TLS group id value as given in the IANA TLS Supported Groups registry.
394
395 =item "tls-group-alg" (B<OSSL_CAPABILITY_TLS_GROUP_ALG>) <utf8 string>
396
397 The name of a Key Management algorithm that the provider offers and that should
398 be used with this group. Keys created should be able to support I<key exchange>
399 or I<key encapsulation method> (KEM), as implied by the optional
400 B<OSSL_CAPABILITY_TLS_GROUP_IS_KEM> flag.
401 The algorithm must support key and parameter generation as well as the
402 key/parameter generation parameter, B<OSSL_PKEY_PARAM_GROUP_NAME>. The group
403 name given via "tls-group-name-internal" above will be passed via
404 B<OSSL_PKEY_PARAM_GROUP_NAME> when libssl wishes to generate keys/parameters.
405
406 =item "tls-group-sec-bits" (B<OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS>) <unsigned integer>
407
408 The number of bits of security offered by keys in this group. The number of bits
409 should be comparable with the ones given in table 2 and 3 of the NIST SP800-57
410 document.
411
412 =item "tls-group-is-kem" (B<OSSL_CAPABILITY_TLS_GROUP_IS_KEM>) <unsigned integer>
413
414 Boolean flag to describe if the group should be used in I<key exchange> (KEX)
415 mode (0, default) or in I<key encapsulation method> (KEM) mode (1).
416
417 This parameter is optional: if not specified, KEX mode is assumed as the default
418 mode for the group.
419
420 In KEX mode, in a typical Diffie-Hellman fashion, both sides execute I<keygen>
421 then I<derive> against the peer public key. To operate in KEX mode, the group
422 implementation must support the provider functions as described in
423 L<provider-keyexch(7)>.
424
425 In KEM mode, the client executes I<keygen> and sends its public key, the server
426 executes I<encapsulate> using the client's public key and sends back the
427 resulting I<ciphertext>, finally the client executes I<decapsulate> to retrieve
428 the same I<shared secret> generated by the server's I<encapsulate>. To operate
429 in KEM mode, the group implementation must support the provider functions as
430 described in L<provider-kem(7)>.
431
432 Both in KEX and KEM mode, the resulting I<shared secret> is then used according
433 to the protocol specification.
434
435 =item "tls-min-tls" (B<OSSL_CAPABILITY_TLS_GROUP_MIN_TLS>) <integer>
436
437 =item "tls-max-tls" (B<OSSL_CAPABILITY_TLS_GROUP_MAX_TLS>) <integer>
438
439 =item "tls-min-dtls" (B<OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS>) <integer>
440
441 =item "tls-max-dtls" (B<OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS>) <integer>
442
443 These parameters can be used to describe the minimum and maximum TLS and DTLS
444 versions supported by the group. The values equate to the on-the-wire encoding
445 of the various TLS versions. For example TLSv1.3 is 0x0304 (772 decimal), and
446 TLSv1.2 is 0x0303 (771 decimal). A 0 indicates that there is no defined minimum
447 or maximum. A -1 indicates that the group should not be used in that protocol.
448
449 =back
450
451 =head1 EXAMPLES
452
453 This is an example of a simple provider made available as a
454 dynamically loadable module.
455 It implements the fictitious algorithm C<FOO> for the fictitious
456 operation C<BAR>.
457
458  #include <malloc.h>
459  #include <openssl/core.h>
460  #include <openssl/core_dispatch.h>
461
462  /* Errors used in this provider */
463  #define E_MALLOC       1
464
465  static const OSSL_ITEM reasons[] = {
466      { E_MALLOC, "memory allocation failure" }.
467      { 0, NULL } /* Termination */
468  };
469
470  /*
471   * To ensure we get the function signature right, forward declare
472   * them using function types provided by openssl/core_dispatch.h
473   */
474  OSSL_FUNC_bar_newctx_fn foo_newctx;
475  OSSL_FUNC_bar_freectx_fn foo_freectx;
476  OSSL_FUNC_bar_init_fn foo_init;
477  OSSL_FUNC_bar_update_fn foo_update;
478  OSSL_FUNC_bar_final_fn foo_final;
479
480  OSSL_FUNC_provider_query_operation_fn p_query;
481  OSSL_FUNC_provider_get_reason_strings_fn p_reasons;
482  OSSL_FUNC_provider_teardown_fn p_teardown;
483
484  OSSL_provider_init_fn OSSL_provider_init;
485
486  OSSL_FUNC_core_put_error *c_put_error = NULL;
487
488  /* Provider context */
489  struct prov_ctx_st {
490      OSSL_CORE_HANDLE *handle;
491  }
492
493  /* operation context for the algorithm FOO */
494  struct foo_ctx_st {
495      struct prov_ctx_st *provctx;
496      int b;
497  };
498
499  static void *foo_newctx(void *provctx)
500  {
501      struct foo_ctx_st *fooctx = malloc(sizeof(*fooctx));
502
503      if (fooctx != NULL)
504          fooctx->provctx = provctx;
505      else
506          c_put_error(provctx->handle, E_MALLOC, __FILE__, __LINE__);
507      return fooctx;
508  }
509
510  static void foo_freectx(void *fooctx)
511  {
512      free(fooctx);
513  }
514
515  static int foo_init(void *vfooctx)
516  {
517      struct foo_ctx_st *fooctx = vfooctx;
518
519      fooctx->b = 0x33;
520  }
521
522  static int foo_update(void *vfooctx, unsigned char *in, size_t inl)
523  {
524      struct foo_ctx_st *fooctx = vfooctx;
525
526      /* did you expect something serious? */
527      if (inl == 0)
528          return 1;
529      for (; inl-- > 0; in++)
530          *in ^= fooctx->b;
531      return 1;
532  }
533
534  static int foo_final(void *vfooctx)
535  {
536      struct foo_ctx_st *fooctx = vfooctx;
537
538      fooctx->b = 0x66;
539  }
540
541  static const OSSL_DISPATCH foo_fns[] = {
542      { OSSL_FUNC_BAR_NEWCTX, (void (*)(void))foo_newctx },
543      { OSSL_FUNC_BAR_FREECTX, (void (*)(void))foo_freectx },
544      { OSSL_FUNC_BAR_INIT, (void (*)(void))foo_init },
545      { OSSL_FUNC_BAR_UPDATE, (void (*)(void))foo_update },
546      { OSSL_FUNC_BAR_FINAL, (void (*)(void))foo_final },
547      { 0, NULL }
548  };
549
550  static const OSSL_ALGORITHM bars[] = {
551      { "FOO", "provider=chumbawamba", foo_fns },
552      { NULL, NULL, NULL }
553  };
554
555  static const OSSL_ALGORITHM *p_query(void *provctx, int operation_id,
556                                       int *no_store)
557  {
558      switch (operation_id) {
559      case OSSL_OP_BAR:
560          return bars;
561      }
562      return NULL;
563  }
564
565  static const OSSL_ITEM *p_reasons(void *provctx)
566  {
567      return reasons;
568  }
569
570  static void p_teardown(void *provctx)
571  {
572      free(provctx);
573  }
574
575  static const OSSL_DISPATCH prov_fns[] = {
576      { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))p_teardown },
577      { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))p_query },
578      { OSSL_FUNC_PROVIDER_GET_REASON_STRINGS, (void (*)(void))p_reasons },
579      { 0, NULL }
580  };
581
582  int OSSL_provider_init(const OSSL_CORE_HANDLE *handle,
583                         const OSSL_DISPATCH *in,
584                         const OSSL_DISPATCH **out,
585                         void **provctx)
586  {
587      struct prov_ctx_st *pctx = NULL;
588
589      for (; in->function_id != 0; in++)
590          switch (in->function_id) {
591          case OSSL_FUNC_CORE_PUT_ERROR:
592              c_put_error = OSSL_FUNC_core_put_error(in);
593              break;
594          }
595
596      *out = prov_fns;
597
598      if ((pctx = malloc(sizeof(*pctx))) == NULL) {
599          /*
600           * ALEA IACTA EST, if the core retrieves the reason table
601           * regardless, that string will be displayed, otherwise not.
602           */
603          c_put_error(handle, E_MALLOC, __FILE__, __LINE__);
604          return 0;
605      }
606      pctx->handle = handle;
607      return 1;
608  }
609
610 This relies on a few things existing in F<openssl/core_dispatch.h>:
611
612  #define OSSL_OP_BAR            4711
613
614  #define OSSL_FUNC_BAR_NEWCTX      1
615  typedef void *(OSSL_FUNC_bar_newctx_fn)(void *provctx);
616  static ossl_inline OSSL_FUNC_bar_newctx(const OSSL_DISPATCH *opf)
617  { return (OSSL_FUNC_bar_newctx_fn *)opf->function; }
618
619  #define OSSL_FUNC_BAR_FREECTX     2
620  typedef void (OSSL_FUNC_bar_freectx_fn)(void *ctx);
621  static ossl_inline OSSL_FUNC_bar_newctx(const OSSL_DISPATCH *opf)
622  { return (OSSL_FUNC_bar_freectx_fn *)opf->function; }
623
624  #define OSSL_FUNC_BAR_INIT        3
625  typedef void *(OSSL_FUNC_bar_init_fn)(void *ctx);
626  static ossl_inline OSSL_FUNC_bar_init(const OSSL_DISPATCH *opf)
627  { return (OSSL_FUNC_bar_init_fn *)opf->function; }
628
629  #define OSSL_FUNC_BAR_UPDATE      4
630  typedef void *(OSSL_FUNC_bar_update_fn)(void *ctx,
631                                        unsigned char *in, size_t inl);
632  static ossl_inline OSSL_FUNC_bar_update(const OSSL_DISPATCH *opf)
633  { return (OSSL_FUNC_bar_update_fn *)opf->function; }
634
635  #define OSSL_FUNC_BAR_FINAL       5
636  typedef void *(OSSL_FUNC_bar_final_fn)(void *ctx);
637  static ossl_inline OSSL_FUNC_bar_final(const OSSL_DISPATCH *opf)
638  { return (OSSL_FUNC_bar_final_fn *)opf->function; }
639
640 =head1 SEE ALSO
641
642 L<provider(7)>
643
644 =head1 HISTORY
645
646 The concept of providers and everything surrounding them was
647 introduced in OpenSSL 3.0.
648
649 =head1 COPYRIGHT
650
651 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
652
653 Licensed under the Apache License 2.0 (the "License").  You may not use
654 this file except in compliance with the License.  You can obtain a copy
655 in the file LICENSE in the source distribution or at
656 L<https://www.openssl.org/source/license.html>.
657
658 =cut