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