Correct documentation errors in regards to UTF8 params
authorTomas Mraz <tomas@openssl.org>
Wed, 11 Aug 2021 16:46:07 +0000 (18:46 +0200)
committerTomas Mraz <tomas@openssl.org>
Fri, 13 Aug 2021 10:28:10 +0000 (12:28 +0200)
commit4ccad35756dfa9df657f3853810101fa9d6ca525
tree6a83ff243dd6a351761f1e883a821be7d709375d
parentbd32bdb8b2a0f98d99b21e1b4d68dfaf1bd5584d
Correct documentation errors in regards to UTF8 params

This fixes numerous bugs in documentation in regards to UTF8
params and their sizes. The returned size should always be without the
terminating NUL byte. On the other hand on the requestor side
the size of the buffer should include the NUL byte if it expects it
being included in the returned string.

Also make this clear in the EVP_PKEY_get_group_name() documentation
which uses utf8 string params under the hood.

Fixes #16287

Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16296)
doc/man3/EVP_PKEY_fromdata.pod
doc/man3/EVP_PKEY_get_group_name.pod
doc/man3/EVP_PKEY_gettable_params.pod
doc/man3/OSSL_PARAM.pod
doc/man3/OSSL_PARAM_BLD.pod
doc/man3/OSSL_PARAM_int.pod