]> git.ipfire.org Git - thirdparty/openssl.git/blob - doc/man3/SSL_get0_group_name.pod
Add SSL_get0_group_name() to get name of the group used for KEX
[thirdparty/openssl.git] / doc / man3 / SSL_get0_group_name.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get0_group_name - get name of the group that was used for the key
6 agreement of the current TLS session establishment
7
8 =head1 SYNOPSIS
9
10 #include <openssl/ssl.h>
11
12 const char *SSL_get0_group_name(SSL *s);
13
14 =head1 DESCRIPTION
15
16 SSL_get0_group_name() returns the name of the group that was used for
17 the key agreement of the current TLS session establishment.
18
19
20 =head1 RETURN VALUES
21
22 If non-NULL, SSL_get0_group_name() returns the name of the group that was used for
23 the key agreement of the current TLS session establishment.
24 If SSL_get0_group_name() returns NULL, an error occurred; possibly no TLS session
25 has been established.
26
27 Note that the return value is valid only during the lifetime of the
28 SSL object I<ssl>.
29
30 =head1 SEE ALSO
31
32 L<ssl(7)>
33
34 =head1 COPYRIGHT
35
36 Copyright 2023 The OpenSSL Project Authors. All Rights Reserved.
37
38 Licensed under the Apache License 2.0 (the "License"). You may not use
39 this file except in compliance with the License. You can obtain a copy
40 in the file LICENSE in the source distribution or at
41 L<https://www.openssl.org/source/license.html>.
42
43 =cut