]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Link SSL_get_negotiated_group() and SSL_get0_group_name() in the docs
authorMatt Caswell <matt@openssl.org>
Mon, 31 Mar 2025 14:51:14 +0000 (15:51 +0100)
committerTomas Mraz <tomas@openssl.org>
Wed, 2 Apr 2025 06:48:57 +0000 (08:48 +0200)
If you are intereseted in one you might be interested in the other.

Fixes #27137

Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/27210)

(cherry picked from commit 9eb21877f5704595a89cd550b1a639df86229b09)

doc/man3/SSL_CTX_set1_curves.pod
doc/man3/SSL_get0_group_name.pod

index 1ebabfb4815f2907673af43471167c8f9a6455b8..44b1f207588c0beedcf77561e0343cf697171341 100644 (file)
@@ -121,7 +121,9 @@ TLS versions, when a session has been resumed, it always reflects the group
 used for key exchange during the initial handshake (otherwise it is from the
 current, non-resumption, connection).  This can be called by either client or
 server. If the NID for the shared group is unknown then the value is set to the
-bitwise OR of TLSEXT_nid_unknown (0x1000000) and the id of the group.
+bitwise OR of TLSEXT_nid_unknown (0x1000000) and the id of the group. See also
+L<SSL_get0_group_name(3)> which returns the name of the negotiated group
+directly and is generally preferred over SSL_get_negotiated_group().
 
 All these functions are implemented as macros.
 
@@ -159,7 +161,8 @@ key exchange, or NID_undef if there was no negotiated group.
 =head1 SEE ALSO
 
 L<ssl(7)>,
-L<SSL_CTX_add_extra_chain_cert(3)>
+L<SSL_CTX_add_extra_chain_cert(3)>,
+L<SSL_get0_group_name(3)>
 
 =head1 HISTORY
 
index 9f43a7f2503dd3bb6b93c07669059acc2f6701ca..13d26f414f7697f1946b1216ba258c478191d0da 100644 (file)
@@ -21,14 +21,15 @@ the key agreement of the current TLS session establishment.
 If non-NULL, SSL_get0_group_name() returns the name of the group that was used for
 the key agreement of the current TLS session establishment.
 If SSL_get0_group_name() returns NULL, an error occurred; possibly no TLS session
-has been established.
+has been established. See also L<SSL_get_negotiated_group(3)>.
 
 Note that the return value is valid only during the lifetime of the
 SSL object I<ssl>.
 
 =head1 SEE ALSO
 
-L<ssl(7)>
+L<ssl(7)>,
+L<SSL_get_negotiated_group(3)>
 
 =head1 HISTORY