summaryrefslogtreecommitdiffstats
path: root/doc/man3/SSL_get0_group_name.pod
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man3/SSL_get0_group_name.pod')
-rw-r--r--doc/man3/SSL_get0_group_name.pod43
1 files changed, 43 insertions, 0 deletions
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