doc/man3/OSSL_PROVIDER.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_PROVIDER_set_default_search_path,
   6 OSSL_PROVIDER, OSSL_PROVIDER_load, OSSL_PROVIDER_try_load, OSSL_PROVIDER_unload,
   7 OSSL_PROVIDER_available, OSSL_PROVIDER_do_all,
   8 OSSL_PROVIDER_gettable_params, OSSL_PROVIDER_get_params,
   9 OSSL_PROVIDER_query_operation, OSSL_PROVIDER_unquery_operation,
  10 OSSL_PROVIDER_get0_provider_ctx, OSSL_PROVIDER_get0_dispatch,
  11 OSSL_PROVIDER_add_builtin, OSSL_PROVIDER_get0_name, OSSL_PROVIDER_get_capabilities,
  12 OSSL_PROVIDER_self_test
  13 - provider routines
  14
  15 =head1 SYNOPSIS
  16
  17  #include <openssl/provider.h>
  18
  19  typedef struct ossl_provider_st OSSL_PROVIDER;
  20
  21  void OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *libctx,
  22                                             const char *path);
  23
  24  OSSL_PROVIDER *OSSL_PROVIDER_load(OSSL_LIB_CTX *libctx, const char *name);
  25  OSSL_PROVIDER *OSSL_PROVIDER_try_load(OSSL_LIB_CTX *libctx, const char *name,
  26                                        int retain_fallbacks);
  27  int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
  28  int OSSL_PROVIDER_available(OSSL_LIB_CTX *libctx, const char *name);
  29  int OSSL_PROVIDER_do_all(OSSL_LIB_CTX *ctx,
  30                           int (*cb)(OSSL_PROVIDER *provider, void *cbdata),
  31                           void *cbdata);
  32
  33  const OSSL_PARAM *OSSL_PROVIDER_gettable_params(OSSL_PROVIDER *prov);
  34  int OSSL_PROVIDER_get_params(OSSL_PROVIDER *prov, OSSL_PARAM params[]);
  35
  36  const OSSL_ALGORITHM *OSSL_PROVIDER_query_operation(const OSSL_PROVIDER *prov,
  37                                                      int operation_id,
  38                                                      int *no_cache);
  39  void OSSL_PROVIDER_unquery_operation(const OSSL_PROVIDER *prov,
  40                                       int operation_id,
  41                                       const OSSL_ALGORITHM *algs);
  42  void *OSSL_PROVIDER_get0_provider_ctx(const OSSL_PROVIDER *prov);
  43  const OSSL_DISPATCH *OSSL_PROVIDER_get0_dispatch(const OSSL_PROVIDER *prov);
  44
  45  int OSSL_PROVIDER_add_builtin(OSSL_LIB_CTX *libctx, const char *name,
  46                                ossl_provider_init_fn *init_fn);
  47
  48  const char *OSSL_PROVIDER_get0_name(const OSSL_PROVIDER *prov);
  49
  50  int OSSL_PROVIDER_get_capabilities(const OSSL_PROVIDER *prov,
  51                                     const char *capability,
  52                                     OSSL_CALLBACK *cb,
  53                                     void *arg);
  54  int OSSL_PROVIDER_self_test(const OSSL_PROVIDER *prov);
  55
  56 =head1 DESCRIPTION
  57
  58 B<OSSL_PROVIDER> is a type that holds internal information about
  59 implementation providers (see L<provider(7)> for information on what a
  60 provider is).
  61 A provider can be built in to the application or the OpenSSL
  62 libraries, or can be a loadable module.
  63 The functions described here handle both forms.
  64
  65 Some of these functions operate within a library context, please see
  66 L<OSSL_LIB_CTX(3)> for further details.
  67
  68 =head2 Functions
  69
  70 OSSL_PROVIDER_set_default_search_path() specifies the default search I<path>
  71 that is to be used for looking for providers in the specified I<libctx>.
  72 If left unspecified, an environment variable and a fall back default value will
  73 be used instead.
  74
  75 OSSL_PROVIDER_add_builtin() is used to add a built in provider to
  76 B<OSSL_PROVIDER> store in the given library context, by associating a
  77 provider name with a provider initialization function.
  78 This name can then be used with OSSL_PROVIDER_load().
  79
  80 OSSL_PROVIDER_load() loads and initializes a provider.
  81 This may simply initialize a provider that was previously added with
  82 OSSL_PROVIDER_add_builtin() and run its given initialization function,
  83 or load a provider module with the given name and run its provider
  84 entry point, C<OSSL_provider_init>. The I<name> can be a path
  85 to a provider module, in that case the provider name as returned
  86 by OSSL_PROVIDER_get0_name() will be the path. Interpretation
  87 of relative paths is platform dependent and they are relative
  88 to the configured "MODULESDIR" directory or the path set in
  89 the environment variable OPENSSL_MODULES if set.
  90
  91 OSSL_PROVIDER_try_load() functions like OSSL_PROVIDER_load(), except that
  92 it does not disable the fallback providers if the provider cannot be
  93 loaded and initialized or if I<retain_fallbacks> is zero.
  94 If the provider loads successfully and I<retain_fallbacks> is nonzero, the
  95 fallback providers are disabled.
  96
  97 OSSL_PROVIDER_unload() unloads the given provider.
  98 For a provider added with OSSL_PROVIDER_add_builtin(), this simply
  99 runs its teardown function.
 100
 101 OSSL_PROVIDER_available() checks if a named provider is available
 102 for use.
 103
 104 OSSL_PROVIDER_do_all() iterates over all loaded providers, calling
 105 I<cb> for each one, with the current provider in I<provider> and the
 106 I<cbdata> that comes from the caller. If no other provider has been loaded
 107 before calling this function, the default provider is still available as
 108 fallback.
 109 See L<OSSL_PROVIDER-default(7)> for more information on this fallback
 110 behaviour.
 111
 112 OSSL_PROVIDER_gettable_params() is used to get a provider parameter
 113 descriptor set as a constant B<OSSL_PARAM> array.
 114 See L<OSSL_PARAM(3)> for more information.
 115
 116 OSSL_PROVIDER_get_params() is used to get provider parameter values.
 117 The caller must prepare the B<OSSL_PARAM> array before calling this
 118 function, and the variables acting as buffers for this parameter array
 119 should be filled with data when it returns successfully.
 120
 121 OSSL_PROVIDER_self_test() is used to run a provider's self tests on demand.
 122 If the self tests fail then the provider will fail to provide any further
 123 services and algorithms. L<OSSL_SELF_TEST_set_callback(3)> may be called
 124 beforehand in order to display diagnostics for the running self tests.
 125
 126 OSSL_PROVIDER_query_operation() calls the provider's I<query_operation>
 127 function (see L<provider(7)>), if the provider has one. It returns an
 128 array of I<OSSL_ALGORITHM> for the given I<operation_id> terminated by an all
 129 NULL OSSL_ALGORITHM entry. This is considered a low-level function that most
 130 applications should not need to call.
 131
 132 OSSL_PROVIDER_unquery_operation() calls the provider's I<unquery_operation>
 133 function (see L<provider(7)>), if the provider has one.  This is considered a
 134 low-level function that most applications should not need to call.
 135
 136 OSSL_PROVIDER_get0_provider_ctx() returns the provider context for the given
 137 provider. The provider context is an opaque handle set by the provider itself
 138 and is passed back to the provider by libcrypto in various function calls.
 139
 140 OSSL_PROVIDER_get0_dispatch() returns the provider's dispatch table as it was
 141 returned in the I<out> parameter from the provider's init function. See
 142 L<provider-base(7)>.
 143
 144 If it is permissible to cache references to this array then I<*no_store> is set
 145 to 0 or 1 otherwise. If the array is not cacheable then it is assumed to
 146 have a short lifetime.
 147
 148 OSSL_PROVIDER_get0_name() returns the name of the given provider.
 149
 150 OSSL_PROVIDER_get_capabilities() provides information about the capabilities
 151 supported by the provider specified in I<prov> with the capability name
 152 I<capability>. For each capability of that name supported by the provider it
 153 will call the callback I<cb> and supply a set of B<OSSL_PARAM>s describing the
 154 capability. It will also pass back the argument I<arg>. For more details about
 155 capabilities and what they can be used for please see
 156 L<provider-base(7)/CAPABILTIIES>.
 157
 158 =head1 RETURN VALUES
 159
 160 OSSL_PROVIDER_add(), OSSL_PROVIDER_unload(), OSSL_PROVIDER_get_params() and
 161 OSSL_PROVIDER_get_capabilities() return 1 on success, or 0 on error.
 162
 163 OSSL_PROVIDER_load() and OSSL_PROVIDER_try_load() return a pointer to a
 164 provider object on success, or NULL on error.
 165
 166 OSSL_PROVIDER_do_all() returns 1 if the callback I<cb> returns 1 for every
 167 provider it is called with, or 0 if any provider callback invocation returns 0;
 168 callback processing stops at the first callback invocation on a provider
 169 that returns 0.
 170
 171 OSSL_PROVIDER_available() returns 1 if the named provider is available,
 172 otherwise 0.
 173
 174 OSSL_PROVIDER_gettable_params() returns a pointer to an array
 175 of constant B<OSSL_PARAM>, or NULL if none is provided.
 176
 177 OSSL_PROVIDER_get_params() and returns 1 on success, or 0 on error.
 178
 179 OSSL_PROVIDER_query_operation() returns an array of OSSL_ALGORITHM or NULL on
 180 error.
 181
 182 OSSL_PROVIDER_self_test() returns 1 if the self tests pass, or 0 on error.
 183
 184 =head1 EXAMPLES
 185
 186 This demonstrates how to load the provider module "foo" and ask for
 187 its build number.
 188
 189  OSSL_PROVIDER *prov = NULL;
 190  const char *build = NULL;
 191  size_t built_l = 0;
 192  OSSL_PARAM request[] = {
 193      { "build", OSSL_PARAM_UTF8_STRING_PTR, &build, 0, &build_l },
 194      { NULL, 0, NULL, 0, NULL }
 195  };
 196
 197  if ((prov = OSSL_PROVIDER_load(NULL, "foo")) != NULL
 198      && OSSL_PROVIDER_get_params(prov, request))
 199      printf("Provider 'foo' build %s\n", build);
 200  else
 201      ERR_print_errors_fp(stderr);
 202
 203 =head1 SEE ALSO
 204
 205 L<openssl-core.h(7)>, L<OSSL_LIB_CTX(3)>, L<provider(7)>
 206
 207 =head1 HISTORY
 208
 209 The type and functions described here were added in OpenSSL 3.0.
 210
 211 =head1 COPYRIGHT
 212
 213 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
 214
 215 Licensed under the Apache License 2.0 (the "License").  You may not use
 216 this file except in compliance with the License.  You can obtain a copy
 217 in the file LICENSE in the source distribution or at
 218 L<https://www.openssl.org/source/license.html>.
 219
 220 =cut