openssl/doc
Andy Bernard 04af51c276 Fix documented function return types
The documented return type of the (incorrectly named; see below) OSSL_FUNC_decoder_export_object function signature is wrong; the correct type is int, due to the following line in core_dispatch.h:
OSSL_CORE_MAKE_FUNC(int, decoder_export_object,

Fixes #19543

Per the Github conversation with levitte and t8m for pull request #19964, the following issues are not addressed by this patch:

The macro OSSL_CORE_MAKE_FUNC in core_dispatch.h generates a function, and a corresponding function signature typedef with name ending in "_fn". The typedefed signature is unrelated to the signature of the function.
However, provider-decoder.pod describes typedefed signatures generated by the macro, but uses the names of the functions (lacking "_fn") instead of the typedefed signatures, which is a mismatch.

Also, the documented claim about OSSL_FUNC_decoder_export_object, etc that "None of these are actual functions" is contradicted by the fact that the code actually calls those functions, and calls them specifically by those names. E.g. in decoder_meth.c:
decoder->export_object = OSSL_FUNC_decoder_export_object(fns);

The functions are generated by OSSL_CORE_MAKE_FUNC.

The paragraph "None of these are actual functions"... should be replaced by something more like "These function signatures, generated by the OSSL_CORE_MAKE_FUNC macro, are for functions that are offered via function pointers in OSSL_DISPATCH arrays."

CLA: trivial

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19964)
2023-03-16 11:56:15 +11:00
..
designs Design for the Fault Injector 2023-01-31 11:34:15 +11:00
HOWTO Replace "a RSA" with "an RSA" 2022-12-07 09:37:25 +11:00
images
internal cmp_client_test.c: add tests for errors reported by server on subsequent requests in a transaction 2023-02-08 17:05:47 +01:00
life-cycles doc: remove end of line whitespace 2021-09-22 16:22:50 +10:00
man1 apps/x509 etc.: allow private key input when public key is expected 2023-03-14 17:26:49 +01:00
man3 Do not fail if ctx dup does not succeed 2023-03-15 08:42:52 +11:00
man5 openssl-3.0#20290: Fixed typo in "config" man page 2023-02-20 08:01:56 +11:00
man7 Fix documented function return types 2023-03-16 11:56:15 +11:00
build.info Add documentation for "NULL" cipher and digest algorithms. 2023-02-28 14:26:33 +11:00
build.info.in doc: remove end of line whitespace 2021-09-22 16:22:50 +10:00
dir-locals.example.el
fingerprints.txt Update Paul's pgp key signature 2022-05-03 12:34:46 +01:00
openssl-c-indent.el
perlvars.pm Disabling Encrypt-then-MAC extension in s_client/s_server 2021-06-15 22:14:34 +02:00
README.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00

OpenSSL Documentation

README.md This file

fingerprints.txt PGP fingerprints of authorised release signers

standards.txt standards.txt Moved to the web, https://www.openssl.org/docs/standards.html

HOWTO/ A few how-to documents; not necessarily up-to-date

man1/ The openssl command-line tools; start with openssl.pod

man3/ The SSL library and the crypto library

man5/ File formats

man7/ Overviews; start with crypto.pod and ssl.pod, for example Algorithm specific EVP_PKEY documentation.

Formatted versions of the manpages (apps,ssl,crypto) can be found at https://www.openssl.org/docs/manpages.html