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