ossl_algorithm_do_all.pod 2.0 KB

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