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_unload,
   7 OSSL_PROVIDER_available,
   8 OSSL_PROVIDER_gettable_params, OSSL_PROVIDER_get_params,
   9 OSSL_PROVIDER_add_builtin, OSSL_PROVIDER_name - provider routines
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/provider.h>
  14
  15  typedef struct ossl_provider_st OSSL_PROVIDER;
  16
  17  void OSSL_PROVIDER_set_default_search_path(OPENSSL_CTX *libctx,
  18                                             const char *path);
  19
  20  OSSL_PROVIDER *OSSL_PROVIDER_load(OPENSSL_CTX *libctx, const char *name);
  21  int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
  22  int OSSL_PROVIDER_available(OPENSSL_CTX *libctx, const char *name);
  23
  24  const OSSL_PARAM *OSSL_PROVIDER_gettable_params(OSSL_PROVIDER *prov);
  25  int OSSL_PROVIDER_get_params(OSSL_PROVIDER *prov, OSSL_PARAM params[]);
  26
  27  int OSSL_PROVIDER_add_builtin(OPENSSL_CTX *libctx, const char *name,
  28                                ossl_provider_init_fn *init_fn);
  29
  30  const char *OSSL_PROVIDER_name(const OSSL_PROVIDER *prov);
  31
  32 =head1 DESCRIPTION
  33
  34 B<OSSL_PROVIDER> is a type that holds internal information about
  35 implementation providers (see L<provider(7)> for information on what a
  36 provider is).
  37 A provider can be built in to the application or the OpenSSL
  38 libraries, or can be a loadable module.
  39 The functions described here handle both forms.
  40
  41 Some of these functions operate within a library context, please see
  42 L<OPENSSL_CTX(3)> for further details.
  43
  44 =head2 Functions
  45
  46 OSSL_PROVIDER_set_default_search_path() specifies the default search B<path>
  47 that is to be used for looking for providers in the specified B<libctx>.
  48 If left unspecified, an environment variable and a fall back default value will
  49 be used instead.
  50
  51 OSSL_PROVIDER_add_builtin() is used to add a built in provider to
  52 B<OSSL_PROVIDER> store in the given library context, by associating a
  53 provider name with a provider initialization function.
  54 This name can then be used with OSSL_PROVIDER_load().
  55
  56 OSSL_PROVIDER_load() loads and initializes a provider.
  57 This may simply initialize a provider that was previously added with
  58 OSSL_PROVIDER_add_builtin() and run its given initialization function,
  59 or load a provider module with the given name and run its provider
  60 entry point, C<OSSL_provider_init>.
  61
  62 OSSL_PROVIDER_unload() unloads the given provider.
  63 For a provider added with OSSL_PROVIDER_add_builtin(), this simply
  64 runs its teardown function.
  65
  66 OSSL_PROVIDER_available() checks if a named provider is available
  67 for use.
  68
  69 OSSL_PROVIDER_gettable_params() is used to get a provider parameter
  70 descriptor set as a constant B<OSSL_PARAM> array.
  71 See L<OSSL_PARAM(3)> for more information.
  72
  73 OSSL_PROVIDER_get_params() is used to get provider parameter values.
  74 The caller must prepare the B<OSSL_PARAM> array before calling this
  75 function, and the variables acting as buffers for this parameter array
  76 should be filled with data when it returns successfully.
  77
  78 OSSL_PROVIDER_name() returns the name of the given provider.
  79
  80 =head1 RETURN VALUES
  81
  82 OSSL_PROVIDER_add() returns 1 on success, or 0 on error.
  83
  84 OSSL_PROVIDER_load() returns a pointer to a provider object on
  85 success, or B<NULL> on error.
  86
  87 OSSL_PROVIDER_unload() returns 1 on success, or 0 on error.
  88
  89 OSSL_PROVIDER_available() returns 1 if the named provider is available,
  90 otherwise 0.
  91
  92 OSSL_PROVIDER_gettable_params() returns a pointer to an array
  93 of constant B<OSSL_PARAM>, or NULL if none is provided.
  94
  95 OSSL_PROVIDER_get_params() returns 1 on success, or 0 on error.
  96
  97 =head1 EXAMPLES
  98
  99 This demonstrates how to load the provider module "foo" and ask for
 100 its build number.
 101
 102  OSSL_PROVIDER *prov = NULL;
 103  const char *build = NULL;
 104  size_t built_l = 0;
 105  OSSL_PARAM request[] = {
 106      { "build", OSSL_PARAM_UTF8_STRING_PTR, &build, 0, &build_l },
 107      { NULL, 0, NULL, 0, NULL }
 108  };
 109
 110  if ((prov = OSSL_PROVIDER_load(NULL, "foo")) != NULL
 111      && OSSL_PROVIDER_get_params(prov, request))
 112      printf("Provider 'foo' build %s\n", build);
 113  else
 114      ERR_print_errors_fp(stderr);
 115
 116 =head1 SEE ALSO
 117
 118 L<openssl-core.h(7)>, L<OPENSSL_CTX(3)>, L<provider(7)>
 119
 120 =head1 HISTORY
 121
 122 The type and functions described here were added in OpenSSL 3.0.
 123
 124 =head1 COPYRIGHT
 125
 126 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
 127
 128 Licensed under the Apache License 2.0 (the "License").  You may not use
 129 this file except in compliance with the License.  You can obtain a copy
 130 in the file LICENSE in the source distribution or at
 131 L<https://www.openssl.org/source/license.html>.
 132
 133 =cut