openssl-core_names.h.pod 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. =pod
  2. =head1 NAME
  3. openssl/core_names.h - OpenSSL provider parameter names
  4. =head1 SYNOPSIS
  5. #include <openssl/core_names.h>
  6. =head1 DESCRIPTION
  7. The F<< <openssl/core_names.h> >> header defines a multitude of macros
  8. for L<OSSL_PARAM(3)> names, algorithm names and other known names used
  9. with OpenSSL's providers, made available for practical purposes only.
  10. Existing names are further described in the manuals for OpenSSL's
  11. providers (see L</SEE ALSO>) and the manuals for each algorithm they
  12. provide (listed in those provider manuals).
  13. =head1 SEE ALSO
  14. L<OSSL_PROVIDER-default(7)>, L<OSSL_PROVIDER-FIPS(7)>,
  15. L<OSSL_PROVIDER-legacy(7)>
  16. =head1 HISTORY
  17. The macros described here were added in OpenSSL 3.0.
  18. =head1 CAVEATS
  19. I<This header file does not constitute a general registry of names>.
  20. Providers that implement new algorithms are to be responsible for
  21. their own parameter names.
  22. However, authors of provider that implement their own variants of
  23. algorithms that OpenSSL providers support will want to pay attention
  24. to the names provided in this header to work in a compatible manner.
  25. =head1 COPYRIGHT
  26. Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  27. Licensed under the Apache License 2.0 (the "License"). You may not use
  28. this file except in compliance with the License. You can obtain a copy
  29. in the file LICENSE in the source distribution or at
  30. L<https://www.openssl.org/source/license.html>.
  31. =cut