1=pod
2
3=head1 NAME
4
5ossl_algorithm_do_all - generic algorithm implementation iterator
6
7=head1 SYNOPSIS
8
9 void ossl_algorithm_do_all(OSSL_LIB_CTX *libctx, int operation_id,
10                            OSSL_PROVIDER *provider,
11                            void (*fn)(OSSL_PROVIDER *provider,
12                                       const OSSL_ALGORITHM *algo,
13                                       int no_store, void *data),
14                            void *data);
15
16=head1 DESCRIPTION
17
18ossl_algorithm_do_all() looks up every algorithm it can find, given a
19library context I<libctx>, an operation identity I<operation_id> and a
20provider I<provider>.
21I<libctx> may be NULL to signify that the default library context should
22be used.
23I<operation_id> may be zero to signify that all kinds of operations
24will be looked up.
25I<provider> may be NULL to signify that all loaded providers will be
26queried.
27
28For each implementation found, the function I<fn> is called with the
29I<provider> for the implementation, the algorithm descriptor I<algo>,
30the flag I<no_store> indicating whether the algorithm descriptor may
31be remembered or not, and the caller I<data> that was passed to
32ossl_algorithm_do_all().
33
34=head1 RETURN VALUES
35
36ossl_algorithm_do_all() doesn't return any value.
37
38=head1 NOTES
39
40The function described here are mainly useful for discovery, and
41possibly display of what has been discovered, for example an
42application that wants to display the loaded providers and what they
43may offer, but also for constructors, such as
44L<ossl_method_construct(3)>.
45
46=head1 SEE ALSO
47
48L<ossl_method_construct(3)>, L<EVP_MAC_do_all_provided(3)>
49
50=head1 HISTORY
51
52This functionality was added to OpenSSL 3.0.
53
54=head1 COPYRIGHT
55
56Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
57
58Licensed under the Apache License 2.0 (the "License").  You may not use this
59file except in compliance with the License.  You can obtain a copy in the file
60LICENSE in the source distribution or at
61L<https://www.openssl.org/source/license.html>.
62
63=cut
64