The branch master has been updated via f438f53a4e57462216be271c1c965550b6ff9941 (commit) via 329b2a2cde480fbfe1cf43bf8ecf1c75a16cf6bf (commit) from d561b84143f5e7956454090e15de0c5e1425ceac (commit)
- Log ----------------------------------------------------------------- commit f438f53a4e57462216be271c1c965550b6ff9941 Author: Richard Levitte <levi...@openssl.org> Date: Tue May 26 14:26:30 2020 +0200 DOCS: add openssl-core_names.h(7) A CAVEATS section is present in this manual. That section name is borrowed from OpenBSD, where mdoc(7) explains it like this: CAVEATS Common misuses and misunderstandings should be explained in this section. Reviewed-by: Shane Lontis <shane.lon...@oracle.com> (Merged from https://github.com/openssl/openssl/pull/11963) commit 329b2a2cde480fbfe1cf43bf8ecf1c75a16cf6bf Author: Richard Levitte <levi...@openssl.org> Date: Tue May 26 14:25:44 2020 +0200 DOCS: add openssl-core_numbers.h(7) Reviewed-by: Shane Lontis <shane.lon...@oracle.com> (Merged from https://github.com/openssl/openssl/pull/11963) ----------------------------------------------------------------------- Summary of changes: doc/man7/openssl-core_names.h.pod | 49 ++++++++++++++++++++++++++++++++ doc/man7/openssl-core_numbers.h.pod | 56 +++++++++++++++++++++++++++++++++++++ util/missingcrypto.txt | 1 - 3 files changed, 105 insertions(+), 1 deletion(-) create mode 100644 doc/man7/openssl-core_names.h.pod create mode 100644 doc/man7/openssl-core_numbers.h.pod diff --git a/doc/man7/openssl-core_names.h.pod b/doc/man7/openssl-core_names.h.pod new file mode 100644 index 0000000000..a11bf3feee --- /dev/null +++ b/doc/man7/openssl-core_names.h.pod @@ -0,0 +1,49 @@ +=pod + +=head1 NAME + +openssl/core_names.h - OpenSSL provider parameter names + +=head1 SYNOPSIS + + #include <openssl/core_names.h> + +=head1 DESCRIPTION + +The F<< <openssl/core_names.h> >> header defines a multitude of macros +for L<OSSL_PARAM(3)> names, algorithm names and other known names used +with OpenSSL's providers, made available for practical purposes only. + +Existing names are further described in the manuals for OpenSSL's +providers (see L</SEE ALSO>) and the manuals for each algorithm they +provide (listed in those provider manuals). + +=head1 SEE ALSO + +L<OSSL_PROVIDER-default(7)>, L<OSSL_PROVIDER-FIPS(7)>, +L<OSSL_PROVIDER-legacy(7)> + +=head1 HISTORY + +The macros described here were added in OpenSSL 3.0. + +=head1 CAVEATS + +I<This header file does not constitute a general registry of names>. +Providers that implement new algorithms are to be responsible for +their own parameter names. + +However, authors of provider that implement their own variants of +algorithms that OpenSSL providers support will want to pay attention +to the names provided in this header to work in a compatible manner. + +=head1 COPYRIGHT + +Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut diff --git a/doc/man7/openssl-core_numbers.h.pod b/doc/man7/openssl-core_numbers.h.pod new file mode 100644 index 0000000000..d9bdcbc810 --- /dev/null +++ b/doc/man7/openssl-core_numbers.h.pod @@ -0,0 +1,56 @@ +=pod + +=head1 NAME + +openssl/core_numbers.h +- OpenSSL provider dispatch numbers and function types + +=head1 SYNOPSIS + + #include <openssl/core_numbers.h> + +=head1 DESCRIPTION + +The F<< <openssl/core_numbers.h> >> header defines all the operation +numbers, dispatch numbers and provider interface function types +currently available. + +The operation and dispatch numbers are represented with macros, which +are named as follows: + +=over 4 + +=item operation numbers + +These macros have the form C<OSSL_OP_I<opname>>. + +=item dipatch numbers + +These macros have the form C<OSSL_FUNC_I<opname>_I<funcname>>, where +C<I<opname>> is the same as in the macro for the operation this +function belongs to. + +=back + +With every dispatch number, there is an associated function type. + +For further information, please see the L<provider(7)> + +=head1 SEE ALSO + +L<provider(7)> + +=head1 HISTORY + +The types and macros described here were added in OpenSSL 3.0. + +=head1 COPYRIGHT + +Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut diff --git a/util/missingcrypto.txt b/util/missingcrypto.txt index 6fba94701a..bc276a8c4a 100644 --- a/util/missingcrypto.txt +++ b/util/missingcrypto.txt @@ -1570,7 +1570,6 @@ i2v_ASN1_BIT_STRING(3) i2v_GENERAL_NAME(3) i2v_GENERAL_NAMES(3) o2i_ECPublicKey(3) -openssl-core_numbers.h(7) provider-kdf(7) v2i_ASN1_BIT_STRING(3) v2i_GENERAL_NAME(3)