]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: clarify SSL_SESSION_get0_hostname() DESCRIPTION
authorRitesh Kudkelwar <ritesh.kumar0793@gmail.com>
Thu, 11 Sep 2025 04:38:34 +0000 (10:08 +0530)
committerTomas Mraz <tomas@openssl.org>
Thu, 18 Sep 2025 15:21:12 +0000 (17:21 +0200)
Also refine RETURN VALUES.

Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/28393)

(cherry picked from commit 32ec97521397597764f72d4e7c279c4e815352ee)

doc/man3/SSL_SESSION_get0_hostname.pod

index f7add16d7bdda9bafab3afe430819aa622185c82..0140deee9a5e95a3f2b7da7f808410b9e5cc35eb 100644 (file)
@@ -23,9 +23,10 @@ SSL_SESSION_set1_alpn_selected
 
 =head1 DESCRIPTION
 
-SSL_SESSION_get0_hostname() retrieves the SNI value that was sent by the
-client when the session was created if it was accepted by the server. Otherwise
-NULL is returned.
+SSL_SESSION_get0_hostname() retrieves the Server Name Indication (SNI) value
+that was sent by the client when the session was created if the server
+acknowledged the client's SNI extension by including an empty SNI extension
+in response. Otherwise NULL is returned.
 
 The value returned is a pointer to memory maintained within B<s> and
 should not be free'd.
@@ -44,8 +45,7 @@ B<alpn>.
 
 =head1 RETURN VALUES
 
-SSL_SESSION_get0_hostname() returns either a string or NULL based on if there
-is the SNI value sent by client.
+SSL_SESSION_get0_hostname() returns the SNI string if available, or NULL if not.
 
 SSL_SESSION_set1_hostname() returns 1 on success or 0 on error.