]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Doc: be explicit about NUL in max_identity_len
authorKinshuk Dua <kinshukdua@gmail.com>
Thu, 21 Oct 2021 13:17:53 +0000 (18:47 +0530)
committerTomas Mraz <tomas@openssl.org>
Fri, 22 Oct 2021 14:24:08 +0000 (16:24 +0200)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16877)

doc/man3/SSL_CTX_set_psk_client_callback.pod

index 23bab173177212e533b4a9047a95df9adeffbc1b..dd302983fddebfc54874f24db0be765f116f86ad 100644 (file)
@@ -107,11 +107,11 @@ the pre-shared key to use during the connection setup phase.
 
 The callback is set using functions SSL_CTX_set_psk_client_callback()
 or SSL_set_psk_client_callback(). The callback function is given the
-connection in parameter B<ssl>, a B<NULL>-terminated PSK identity hint
+connection in parameter B<ssl>, a B<NUL>-terminated PSK identity hint
 sent by the server in parameter B<hint>, a buffer B<identity> of
-length B<max_identity_len> bytes where the resulting
-B<NUL>-terminated identity is to be stored, and a buffer B<psk> of
-length B<max_psk_len> bytes where the resulting pre-shared key is to
+length B<max_identity_len> bytes (including the B<NUL>-terminator) where the
+resulting B<NUL>-terminated identity is to be stored, and a buffer B<psk>
+of length B<max_psk_len> bytes where the resulting pre-shared key is to
 be stored.
 
 The callback for use in TLSv1.2 will also work in TLSv1.3 although it is