xref: /freebsd/crypto/openssl/doc/man3/SSL_get0_group_name.pod (revision e7be843b4a162e68651d3911f0357ed464915629)
1=pod
2
3=head1 NAME
4
5SSL_get0_group_name - get name of the group that was used for the key
6agreement 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
16SSL_get0_group_name() returns the name of the group that was used for
17the key agreement of the current TLS session establishment.
18
19=head1 RETURN VALUES
20
21If non-NULL, SSL_get0_group_name() returns the name of the group that was used for
22the key agreement of the current TLS session establishment.
23If SSL_get0_group_name() returns NULL, an error occurred; possibly no TLS session
24has been established. See also L<SSL_get_negotiated_group(3)>.
25
26Note that the return value is valid only during the lifetime of the
27SSL object I<ssl>.
28
29=head1 SEE ALSO
30
31L<ssl(7)>,
32L<SSL_get_negotiated_group(3)>
33
34=head1 HISTORY
35
36This function was added in OpenSSL 3.2.
37
38=head1 COPYRIGHT
39
40Copyright 2023-2025 The OpenSSL Project Authors. All Rights Reserved.
41
42Licensed under the Apache License 2.0 (the "License").  You may not use
43this file except in compliance with the License.  You can obtain a copy
44in the file LICENSE in the source distribution or at
45L<https://www.openssl.org/source/license.html>.
46
47=cut
48