Add OSSL_PROVIDER_do_all()

[openssl.git] / doc / man3 / OSSL_PROVIDER.pod

diff --git a/doc/man3/OSSL_PROVIDER.pod b/doc/man3/OSSL_PROVIDER.pod
index e3653663b21a41d212c750d63bdd1f142e7e990d..93d6e1421cc505d0e9dc05b1965932bb088d80a6 100644 (file)
--- a/doc/man3/OSSL_PROVIDER.pod
+++ b/doc/man3/OSSL_PROVIDER.pod
@@ -2,9 +2,11 @@
 
 =head1 NAME
 
 
 =head1 NAME
 

+OSSL_PROVIDER_set_default_search_path,

 OSSL_PROVIDER, OSSL_PROVIDER_load, OSSL_PROVIDER_unload,
 OSSL_PROVIDER, OSSL_PROVIDER_load, OSSL_PROVIDER_unload,

-OSSL_PROVIDER_get_param_types, OSSL_PROVIDER_get_params,
-OSSL_PROVIDER_add_builtin - provider routines
+OSSL_PROVIDER_available, OSSL_PROVIDER_do_all,
+OSSL_PROVIDER_gettable_params, OSSL_PROVIDER_get_params,
+OSSL_PROVIDER_add_builtin, OSSL_PROVIDER_name - provider routines

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -12,15 +14,24 @@ OSSL_PROVIDER_add_builtin - provider routines
 
  typedef struct ossl_provider_st OSSL_PROVIDER;
 
 
  typedef struct ossl_provider_st OSSL_PROVIDER;
 

- OSSL_PROVIDER *OSSL_PROVIDER_load(OPENSSL_CTX *, const char *name);
+ void OSSL_PROVIDER_set_default_search_path(OPENSSL_CTX *libctx,
+                                            const char *path);
+
+ OSSL_PROVIDER *OSSL_PROVIDER_load(OPENSSL_CTX *libctx, const char *name);

  int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
  int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);

+ int OSSL_PROVIDER_available(OPENSSL_CTX *libctx, const char *name);
+ int OSSL_PROVIDER_do_all(OPENSSL_CTX *ctx,
+                          int (*cb)(OSSL_PROVIDER *provider, void *cbdata),
+                          void *cbdata);

 
 

- const OSSL_ITEM *OSSL_PROVIDER_get_param_types(OSSL_PROVIDER *prov);
- int OSSL_PROVIDER_get_params(OSSL_PROVIDER *prov, const OSSL_PARAM params[]);
+ const OSSL_PARAM *OSSL_PROVIDER_gettable_params(OSSL_PROVIDER *prov);
+ int OSSL_PROVIDER_get_params(OSSL_PROVIDER *prov, OSSL_PARAM params[]);

 
 

- int OSSL_PROVIDER_add_builtin(OPENSSL_CTX *, const char *name,
+ int OSSL_PROVIDER_add_builtin(OPENSSL_CTX *libctx, const char *name,

                                ossl_provider_init_fn *init_fn);
 
                                ossl_provider_init_fn *init_fn);
 

+ const char *OSSL_PROVIDER_name(const OSSL_PROVIDER *prov);
+

 =head1 DESCRIPTION
 
 B<OSSL_PROVIDER> is a type that holds internal information about
 =head1 DESCRIPTION
 
 B<OSSL_PROVIDER> is a type that holds internal information about


@@ -30,8 +41,16 @@ A provider can be built in to the application or the OpenSSL
 libraries, or can be a loadable module.
 The functions described here handle both forms.
 
 libraries, or can be a loadable module.
 The functions described here handle both forms.
 

+Some of these functions operate within a library context, please see
+L<OPENSSL_CTX(3)> for further details.
+

 =head2 Functions
 
 =head2 Functions
 

+OSSL_PROVIDER_set_default_search_path() specifies the default search B<path>
+that is to be used for looking for providers in the specified B<libctx>.
+If left unspecified, an environment variable and a fall back default value will
+be used instead.
+

 OSSL_PROVIDER_add_builtin() is used to add a built in provider to
 B<OSSL_PROVIDER> store in the given library context, by associating a
 provider name with a provider initialization function.
 OSSL_PROVIDER_add_builtin() is used to add a built in provider to
 B<OSSL_PROVIDER> store in the given library context, by associating a
 provider name with a provider initialization function.


@@ -47,18 +66,24 @@ OSSL_PROVIDER_unload() unloads the given provider.
 For a provider added with OSSL_PROVIDER_add_builtin(), this simply
 runs its teardown function.
 
 For a provider added with OSSL_PROVIDER_add_builtin(), this simply
 runs its teardown function.
 

-OSSL_PROVIDER_get_param_types() is used to get a provider parameter
-descriptor set as an B<OSSL_ITEM> array.
-Each element is a tuple of an B<OSSL_PARAM> parameter type and a name
-in form of a C string.
-See L<openssl-core.h(7)> for more information on B<OSSL_ITEM> and
-parameter types.
+OSSL_PROVIDER_available() checks if a named provider is available
+for use.
+
+OSSL_PROVIDER_do_all() iterates over all loaded providers, calling
+I<cb> for each one, with the current provider in I<provider> and the
+I<cbdata> that comes from the caller.
+
+OSSL_PROVIDER_gettable_params() is used to get a provider parameter
+descriptor set as a constant B<OSSL_PARAM> array.
+See L<OSSL_PARAM(3)> for more information.

 
 OSSL_PROVIDER_get_params() is used to get provider parameter values.
 The caller must prepare the B<OSSL_PARAM> array before calling this
 function, and the variables acting as buffers for this parameter array
 should be filled with data when it returns successfully.
 
 
 OSSL_PROVIDER_get_params() is used to get provider parameter values.
 The caller must prepare the B<OSSL_PARAM> array before calling this
 function, and the variables acting as buffers for this parameter array
 should be filled with data when it returns successfully.
 

+OSSL_PROVIDER_name() returns the name of the given provider.
+

 =head1 RETURN VALUES
 
 OSSL_PROVIDER_add() returns 1 on success, or 0 on error.
 =head1 RETURN VALUES
 
 OSSL_PROVIDER_add() returns 1 on success, or 0 on error.


@@ -68,8 +93,11 @@ success, or B<NULL> on error.
 
 OSSL_PROVIDER_unload() returns 1 on success, or 0 on error.
 
 
 OSSL_PROVIDER_unload() returns 1 on success, or 0 on error.
 

-OSSL_PROVIDER_get_param_types() returns a pointer to a constant array
-of B<OSSL_ITEM>, or NULL if none is provided.
+OSSL_PROVIDER_available() returns 1 if the named provider is available,
+otherwise 0.
+
+OSSL_PROVIDER_gettable_params() returns a pointer to an array
+of constant B<OSSL_PARAM>, or NULL if none is provided.

 
 OSSL_PROVIDER_get_params() returns 1 on success, or 0 on error.
 
 
 OSSL_PROVIDER_get_params() returns 1 on success, or 0 on error.
 


@@ -81,7 +109,7 @@ its build number.
  OSSL_PROVIDER *prov = NULL;
  const char *build = NULL;
  size_t built_l = 0;
  OSSL_PROVIDER *prov = NULL;
  const char *build = NULL;
  size_t built_l = 0;

- const OSSL_PARAM request[] = {
+ OSSL_PARAM request[] = {

      { "build", OSSL_PARAM_UTF8_STRING_PTR, &build, 0, &build_l },
      { NULL, 0, NULL, 0, NULL }
  };
      { "build", OSSL_PARAM_UTF8_STRING_PTR, &build, 0, &build_l },
      { NULL, 0, NULL, 0, NULL }
  };


@@ -94,7 +122,7 @@ its build number.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

-L<openssl-core.h(7)>, L<provider(7)>
+L<openssl-core.h(7)>, L<OPENSSL_CTX(3)>, L<provider(7)>

 
 =head1 HISTORY
 
 
 =head1 HISTORY
 


@@ -102,7 +130,7 @@ The type and functions described here were added in OpenSSL 3.0.
 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT
 

-Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.

 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy