mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-01-12 13:36:28 +08:00
Code Issues Packages Projects Releases Wiki Activity
04af51c276
openssl/doc/man7
History
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
..
img
bio.pod Change all references to OpenSSL 3.1 to OpenSSL 3.2 in the master branch 2022-10-07 10:05:50 +02:00
crypto.pod Add provider pre-fetching documentation 2023-02-28 14:29:42 +11:00
ct.pod
des_modes.pod
EVP_ASYM_CIPHER-RSA.pod Add doc for EVP_ASYM_CIPHER-RSA and clean up OSSL_PROVIDER-FIPS.pod. 2022-11-18 14:29:01 +01:00
EVP_ASYM_CIPHER-SM2.pod
EVP_CIPHER-AES.pod Update AES documentation excluding AES SIV from the FIPS provider 2023-03-01 18:35:01 +11:00
EVP_CIPHER-ARIA.pod
EVP_CIPHER-BLOWFISH.pod
EVP_CIPHER-CAMELLIA.pod
EVP_CIPHER-CAST.pod
EVP_CIPHER-CHACHA.pod
EVP_CIPHER-DES.pod
EVP_CIPHER-IDEA.pod
EVP_CIPHER-NULL.pod Add documentation for "NULL" cipher and digest algorithms. 2023-02-28 14:26:33 +11:00
EVP_CIPHER-RC2.pod
EVP_CIPHER-RC4.pod
EVP_CIPHER-RC5.pod
EVP_CIPHER-SEED.pod
EVP_CIPHER-SM4.pod doc: add note for sm4 xts 2022-11-29 16:18:07 +01:00
EVP_KDF-HKDF.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-HMAC-DRBG.pod Typos fixing 2023-01-24 11:03:20 +00:00
EVP_KDF-KB.pod Add KMAC support to KBKDF. 2022-12-16 16:36:49 +01:00
EVP_KDF-KRB5KDF.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-PBKDF1.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-PBKDF2.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-PKCS12KDF.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-PVKKDF.pod Fix version mistake in some HISTORY sections 2022-11-23 08:23:17 +01:00
EVP_KDF-SCRYPT.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-SS.pod SSKDF with KMAC should return SIZE_MAX when EVP_KDF_CTX_get_kdf_size() 2023-01-12 12:13:47 +01:00
EVP_KDF-SSHKDF.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-TLS1_PRF.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-TLS13_KDF.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-X942-ASN1.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-X942-CONCAT.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KDF-X963.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KEM-EC.pod Add HISTORY section to EVP_KEM-EC document. 2022-11-24 06:39:22 +00:00
EVP_KEM-RSA.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
EVP_KEM-X25519.pod Fix version mistake in some HISTORY sections 2022-11-23 08:23:17 +01:00
EVP_KEYEXCH-DH.pod Update copyright year 2022-05-03 13:34:51 +01:00
EVP_KEYEXCH-ECDH.pod Update copyright year 2022-05-03 13:34:51 +01:00
EVP_KEYEXCH-X25519.pod
EVP_MAC-BLAKE2.pod
EVP_MAC-CMAC.pod cmac_set_ctx_params(): Fail if cipher mode is not CBC 2022-11-11 16:54:50 +01:00
EVP_MAC-GMAC.pod
EVP_MAC-HMAC.pod
EVP_MAC-KMAC.pod Add KMAC support to KBKDF. 2022-12-16 16:36:49 +01:00
EVP_MAC-Poly1305.pod
EVP_MAC-Siphash.pod
EVP_MD-BLAKE2.pod Update copyright year 2022-05-03 13:34:51 +01:00
EVP_MD-common.pod
EVP_MD-KECCAK.pod
EVP_MD-MD2.pod
EVP_MD-MD4.pod
EVP_MD-MD5-SHA1.pod
EVP_MD-MD5.pod
EVP_MD-MDC2.pod
EVP_MD-NULL.pod Add documentation for "NULL" cipher and digest algorithms. 2023-02-28 14:26:33 +11:00
EVP_MD-RIPEMD160.pod ripemd: document as being present in the default provider 2022-10-19 13:21:01 +02:00
EVP_MD-SHA1.pod
EVP_MD-SHA2.pod
EVP_MD-SHA3.pod
EVP_MD-SHAKE.pod SHAKE documentation updates for default output length. 2022-08-17 16:17:42 +02:00
EVP_MD-SM3.pod
EVP_MD-WHIRLPOOL.pod
EVP_PKEY-DH.pod Add documentation for key validation that indicates the difference between the 2022-05-09 10:07:42 +10:00
EVP_PKEY-DSA.pod Add documentation for key validation that indicates the difference between the 2022-05-09 10:07:42 +10:00
EVP_PKEY-EC.pod DOCS: provider-keymgmt(7) - params for EVP_PKEY_get_default_digest_{name,nid}() 2023-03-07 07:54:04 +01:00
EVP_PKEY-FFC.pod Add documentation for key validation that indicates the difference between the 2022-05-09 10:07:42 +10:00
EVP_PKEY-HMAC.pod
EVP_PKEY-RSA.pod Document that the RSA e value is mandatory when importing. 2023-01-26 11:04:30 +01:00
EVP_PKEY-SM2.pod
EVP_PKEY-X25519.pod Add HPKE DHKEM provider support for EC, X25519 and X448. 2022-09-23 09:24:47 +01:00
EVP_RAND-CTR-DRBG.pod Fix docs related to EVP_RAND_CTX_new() that were not passing the parent 2022-11-30 07:31:53 +00:00
EVP_RAND-HASH-DRBG.pod Fix docs related to EVP_RAND_CTX_new() that were not passing the parent 2022-11-30 07:31:53 +00:00
EVP_RAND-HMAC-DRBG.pod Implement deterministic ECDSA sign (RFC6979) 2022-11-30 07:31:53 +00:00
EVP_RAND-SEED-SRC.pod Fix docs related to EVP_RAND_CTX_new() that were not passing the parent 2022-11-30 07:31:53 +00:00
EVP_RAND-TEST-RAND.pod Fix docs related to EVP_RAND_CTX_new() that were not passing the parent 2022-11-30 07:31:53 +00:00
EVP_RAND.pod
EVP_SIGNATURE-DSA.pod Allow OSSL_SIGNATURE_PARAM_NONCE_TYPE to be retrieved 2023-01-23 10:34:36 +01:00
EVP_SIGNATURE-ECDSA.pod Allow OSSL_SIGNATURE_PARAM_NONCE_TYPE to be retrieved 2023-01-23 10:34:36 +01:00
EVP_SIGNATURE-ED25519.pod Support all five EdDSA instances from RFC 8032 2023-01-13 07:09:09 +00:00
EVP_SIGNATURE-HMAC.pod
EVP_SIGNATURE-RSA.pod signature: Clamp PSS salt len to MD len 2022-12-08 11:02:52 +01:00
evp.pod
fips_module.pod update documentation to note that EdDSA is not FIPS approved 2023-02-22 11:29:02 +11:00
life_cycle-cipher.pod
life_cycle-digest.pod
life_cycle-kdf.pod
life_cycle-mac.pod
life_cycle-pkey.pod Update copyright year 2022-05-03 13:34:51 +01:00
life_cycle-rand.pod
migration_guide.pod Add provider pre-fetching documentation 2023-02-28 14:29:42 +11:00
openssl_user_macros.pod.in
openssl-core_dispatch.h.pod
openssl-core_names.h.pod
openssl-core.h.pod Move the description of the core types into their own pages 2022-12-08 07:32:34 +01:00
openssl-env.pod Add basic RISC-V cpuid and OPENSSL_riscvcap 2022-05-19 16:32:49 +10:00
openssl-glossary.pod Update copyright year 2022-05-03 13:34:51 +01:00
openssl-threads.pod
OSSL_PROVIDER-base.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
OSSL_PROVIDER-default.pod Document the list of RAND algorithms in the default and fips providers. 2023-02-28 14:31:05 +11:00
OSSL_PROVIDER-FIPS.pod Add option to FIPS module to enforce EMS check during KDF TLS1_PRF. 2023-03-07 18:24:45 +01:00
OSSL_PROVIDER-legacy.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
OSSL_PROVIDER-null.pod Add missing HISTORY sections for OpenSSL 3.0 related documents. 2022-11-21 12:03:10 +01:00
ossl_store-file.pod
ossl_store.pod
passphrase-encoding.pod
property.pod Add link to EBNF definition 2023-01-20 10:15:53 +11:00
provider-asym_cipher.pod Fixed typos in documentation and comments 2023-01-04 12:53:05 +01:00
provider-base.pod Fix typo in base provider example code 2023-03-03 10:34:01 +11:00
provider-cipher.pod Add documentation for "NULL" cipher and digest algorithms. 2023-02-28 14:26:33 +11:00
provider-decoder.pod Fix documented function return types 2023-03-16 11:56:15 +11:00
provider-digest.pod Add documentation for "NULL" cipher and digest algorithms. 2023-02-28 14:26:33 +11:00
provider-encoder.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
provider-kdf.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
provider-kem.pod Typos fixing 2023-01-24 11:03:20 +00:00
provider-keyexch.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
provider-keymgmt.pod DOCS: provider-keymgmt(7) - params for EVP_PKEY_get_default_digest_{name,nid}() 2023-03-07 07:54:04 +01:00
provider-mac.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
provider-object.pod Update copyright year 2022-05-03 13:34:51 +01:00
provider-rand.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
provider-signature.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
provider-storemgmt.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
provider.pod Replace some boldened types with a corresponding man page link 2022-12-08 07:32:34 +01:00
proxy-certificates.pod
RAND.pod
RSA-PSS.pod
ssl.pod
x509.pod
X25519.pod