xref: /freebsd/crypto/openssl/doc/man7/openssl-core_names.h.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre Proncheryopenssl/core_names.h - OpenSSL provider parameter names
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 SYNOPSIS
8*b077aed3SPierre Pronchery
9*b077aed3SPierre Pronchery #include <openssl/core_names.h>
10*b077aed3SPierre Pronchery
11*b077aed3SPierre Pronchery=head1 DESCRIPTION
12*b077aed3SPierre Pronchery
13*b077aed3SPierre ProncheryThe F<< <openssl/core_names.h> >> header defines a multitude of macros
14*b077aed3SPierre Proncheryfor L<OSSL_PARAM(3)> names, algorithm names and other known names used
15*b077aed3SPierre Proncherywith OpenSSL's providers, made available for practical purposes only.
16*b077aed3SPierre Pronchery
17*b077aed3SPierre ProncheryExisting names are further described in the manuals for OpenSSL's
18*b077aed3SPierre Proncheryproviders (see L</SEE ALSO>) and the manuals for each algorithm they
19*b077aed3SPierre Proncheryprovide (listed in those provider manuals).
20*b077aed3SPierre Pronchery
21*b077aed3SPierre Pronchery=head1 SEE ALSO
22*b077aed3SPierre Pronchery
23*b077aed3SPierre ProncheryL<OSSL_PROVIDER-default(7)>, L<OSSL_PROVIDER-FIPS(7)>,
24*b077aed3SPierre ProncheryL<OSSL_PROVIDER-legacy(7)>
25*b077aed3SPierre Pronchery
26*b077aed3SPierre Pronchery=head1 HISTORY
27*b077aed3SPierre Pronchery
28*b077aed3SPierre ProncheryThe macros described here were added in OpenSSL 3.0.
29*b077aed3SPierre Pronchery
30*b077aed3SPierre Pronchery=head1 CAVEATS
31*b077aed3SPierre Pronchery
32*b077aed3SPierre ProncheryI<This header file does not constitute a general registry of names>.
33*b077aed3SPierre ProncheryProviders that implement new algorithms are to be responsible for
34*b077aed3SPierre Proncherytheir own parameter names.
35*b077aed3SPierre Pronchery
36*b077aed3SPierre ProncheryHowever, authors of provider that implement their own variants of
37*b077aed3SPierre Proncheryalgorithms that OpenSSL providers support will want to pay attention
38*b077aed3SPierre Proncheryto the names provided in this header to work in a compatible manner.
39*b077aed3SPierre Pronchery
40*b077aed3SPierre Pronchery=head1 COPYRIGHT
41*b077aed3SPierre Pronchery
42*b077aed3SPierre ProncheryCopyright 2020 The OpenSSL Project Authors. All Rights Reserved.
43*b077aed3SPierre Pronchery
44*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
45*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
46*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
47*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
48*b077aed3SPierre Pronchery
49*b077aed3SPierre Pronchery=cut
50