xref: /freebsd/crypto/openssl/doc/man3/SSL_get0_group_name.pod (revision e7be843b4a162e68651d3911f0357ed464915629)
1*e7be843bSPierre Pronchery=pod
2*e7be843bSPierre Pronchery
3*e7be843bSPierre Pronchery=head1 NAME
4*e7be843bSPierre Pronchery
5*e7be843bSPierre ProncherySSL_get0_group_name - get name of the group that was used for the key
6*e7be843bSPierre Proncheryagreement of the current TLS session establishment
7*e7be843bSPierre Pronchery
8*e7be843bSPierre Pronchery=head1 SYNOPSIS
9*e7be843bSPierre Pronchery
10*e7be843bSPierre Pronchery #include <openssl/ssl.h>
11*e7be843bSPierre Pronchery
12*e7be843bSPierre Pronchery const char *SSL_get0_group_name(SSL *s);
13*e7be843bSPierre Pronchery
14*e7be843bSPierre Pronchery=head1 DESCRIPTION
15*e7be843bSPierre Pronchery
16*e7be843bSPierre ProncherySSL_get0_group_name() returns the name of the group that was used for
17*e7be843bSPierre Proncherythe key agreement of the current TLS session establishment.
18*e7be843bSPierre Pronchery
19*e7be843bSPierre Pronchery=head1 RETURN VALUES
20*e7be843bSPierre Pronchery
21*e7be843bSPierre ProncheryIf non-NULL, SSL_get0_group_name() returns the name of the group that was used for
22*e7be843bSPierre Proncherythe key agreement of the current TLS session establishment.
23*e7be843bSPierre ProncheryIf SSL_get0_group_name() returns NULL, an error occurred; possibly no TLS session
24*e7be843bSPierre Proncheryhas been established. See also L<SSL_get_negotiated_group(3)>.
25*e7be843bSPierre Pronchery
26*e7be843bSPierre ProncheryNote that the return value is valid only during the lifetime of the
27*e7be843bSPierre ProncherySSL object I<ssl>.
28*e7be843bSPierre Pronchery
29*e7be843bSPierre Pronchery=head1 SEE ALSO
30*e7be843bSPierre Pronchery
31*e7be843bSPierre ProncheryL<ssl(7)>,
32*e7be843bSPierre ProncheryL<SSL_get_negotiated_group(3)>
33*e7be843bSPierre Pronchery
34*e7be843bSPierre Pronchery=head1 HISTORY
35*e7be843bSPierre Pronchery
36*e7be843bSPierre ProncheryThis function was added in OpenSSL 3.2.
37*e7be843bSPierre Pronchery
38*e7be843bSPierre Pronchery=head1 COPYRIGHT
39*e7be843bSPierre Pronchery
40*e7be843bSPierre ProncheryCopyright 2023-2025 The OpenSSL Project Authors. All Rights Reserved.
41*e7be843bSPierre Pronchery
42*e7be843bSPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
43*e7be843bSPierre Proncherythis file except in compliance with the License.  You can obtain a copy
44*e7be843bSPierre Proncheryin the file LICENSE in the source distribution or at
45*e7be843bSPierre ProncheryL<https://www.openssl.org/source/license.html>.
46*e7be843bSPierre Pronchery
47*e7be843bSPierre Pronchery=cut
48