diff options
author | Alex Bozarth <ajbozart@us.ibm.com> | 2023-05-19 14:08:41 -0500 |
---|---|---|
committer | Tomas Mraz <tomas@openssl.org> | 2023-06-06 17:03:41 +0200 |
commit | 68668243b176cd2bc53a83c6768d4f39930ba8ed (patch) | |
tree | 61cddf3545b28d1f276a92eb8e8736fcc5cb932b /doc | |
parent | 8229874476cc2955e6947cf6d3fee09e13b8c160 (diff) |
Add SSL_get0_group_name() to get name of the group used for KEX
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20866)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build.info | 6 | ||||
-rw-r--r-- | doc/man3/SSL_get0_group_name.pod | 43 |
2 files changed, 49 insertions, 0 deletions
diff --git a/doc/build.info b/doc/build.info index 6846b552d8..e4a78e0d14 100644 --- a/doc/build.info +++ b/doc/build.info @@ -2495,6 +2495,10 @@ DEPEND[html/man3/SSL_get0_connection.html]=man3/SSL_get0_connection.pod GENERATE[html/man3/SSL_get0_connection.html]=man3/SSL_get0_connection.pod DEPEND[man/man3/SSL_get0_connection.3]=man3/SSL_get0_connection.pod GENERATE[man/man3/SSL_get0_connection.3]=man3/SSL_get0_connection.pod +DEPEND[html/man3/SSL_get0_group_name.html]=man3/SSL_get0_group_name.pod +GENERATE[html/man3/SSL_get0_group_name.html]=man3/SSL_get0_group_name.pod +DEPEND[man/man3/SSL_get0_group_name.3]=man3/SSL_get0_group_name.pod +GENERATE[man/man3/SSL_get0_group_name.3]=man3/SSL_get0_group_name.pod DEPEND[html/man3/SSL_get0_peer_rpk.html]=man3/SSL_get0_peer_rpk.pod GENERATE[html/man3/SSL_get0_peer_rpk.html]=man3/SSL_get0_peer_rpk.pod DEPEND[man/man3/SSL_get0_peer_rpk.3]=man3/SSL_get0_peer_rpk.pod @@ -3523,6 +3527,7 @@ html/man3/SSL_export_keying_material.html \ html/man3/SSL_extension_supported.html \ html/man3/SSL_free.html \ html/man3/SSL_get0_connection.html \ +html/man3/SSL_get0_group_name.html \ html/man3/SSL_get0_peer_rpk.html \ html/man3/SSL_get0_peer_scts.html \ html/man3/SSL_get_SSL_CTX.html \ @@ -4160,6 +4165,7 @@ man/man3/SSL_export_keying_material.3 \ man/man3/SSL_extension_supported.3 \ man/man3/SSL_free.3 \ man/man3/SSL_get0_connection.3 \ +man/man3/SSL_get0_group_name.3 \ man/man3/SSL_get0_peer_rpk.3 \ man/man3/SSL_get0_peer_scts.3 \ man/man3/SSL_get_SSL_CTX.3 \ diff --git a/doc/man3/SSL_get0_group_name.pod b/doc/man3/SSL_get0_group_name.pod new file mode 100644 index 0000000000..a96340ae86 --- /dev/null +++ b/doc/man3/SSL_get0_group_name.pod @@ -0,0 +1,43 @@ +=pod + +=head1 NAME + +SSL_get0_group_name - get name of the group that was used for the key +agreement of the current TLS session establishment + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + const char *SSL_get0_group_name(SSL *s); + +=head1 DESCRIPTION + +SSL_get0_group_name() returns the name of the group that was used for +the key agreement of the current TLS session establishment. + + +=head1 RETURN VALUES + +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. + +Note that the return value is valid only during the lifetime of the +SSL object I<ssl>. + +=head1 SEE ALSO + +L<ssl(7)> + +=head1 COPYRIGHT + +Copyright 2023 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |