From: Kinshuk Dua <kinshukdua@gmail.com>
Date: Thu, 21 Oct 2021 13:17:53 +0000 (+0530)
Subject: Doc: be explicit about NUL in max_identity_len
X-Git-Tag: openssl-3.2.0-alpha1~3439
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=25ead551aa31feae91cab91b648a2ca16bc7a8dc;p=thirdparty%2Fopenssl.git

Doc: be explicit about NUL in max_identity_len

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16877)
---

diff --git a/doc/man3/SSL_CTX_set_psk_client_callback.pod b/doc/man3/SSL_CTX_set_psk_client_callback.pod
index 23bab173177..dd302983fdd 100644
--- a/doc/man3/SSL_CTX_set_psk_client_callback.pod
+++ b/doc/man3/SSL_CTX_set_psk_client_callback.pod
@@ -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