diff options
| author | Tomas Mraz <tomas@openssl.org> | 2021-08-11 18:46:07 +0200 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2021-08-13 12:28:10 +0200 |
| commit | 4ccad35756dfa9df657f3853810101fa9d6ca525 (patch) | |
| tree | 6a83ff243dd6a351761f1e883a821be7d709375d /doc/man3/EVP_PKEY_get_group_name.pod | |
| parent | bd32bdb8b2a0f98d99b21e1b4d68dfaf1bd5584d (diff) | |
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)
Diffstat (limited to 'doc/man3/EVP_PKEY_get_group_name.pod')
| -rw-r--r-- | doc/man3/EVP_PKEY_get_group_name.pod | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/man3/EVP_PKEY_get_group_name.pod b/doc/man3/EVP_PKEY_get_group_name.pod index 3ef19b8575..5844bf1abc 100644 --- a/doc/man3/EVP_PKEY_get_group_name.pod +++ b/doc/man3/EVP_PKEY_get_group_name.pod @@ -15,8 +15,8 @@ EVP_PKEY_get_group_name - get group name of a key EVP_PKEY_get_group_name() fills in the group name of the I<pkey> into I<gname>, up to at most I<gname_sz> bytes including the ending NUL byte -and assigns I<*gname_len> the actual size of the name, if I<pkey>'s key type -supports it. +and assigns I<*gname_len> the actual length of the name not including +the NUL byte, if I<pkey>'s key type supports it. I<gname> as well as I<gname_len> may individually be NULL, and won't be filled in or assigned in that case. |