xref: /freebsd/crypto/openssl/doc/man3/SSL_group_to_name.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncherySSL_group_to_name - get name of group
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 SYNOPSIS
8*b077aed3SPierre Pronchery
9*b077aed3SPierre Pronchery #include <openssl/ssl.h>
10*b077aed3SPierre Pronchery
11*b077aed3SPierre Pronchery const char *SSL_group_to_name(const SSL *ssl, int id);
12*b077aed3SPierre Pronchery
13*b077aed3SPierre Pronchery=head1 DESCRIPTION
14*b077aed3SPierre Pronchery
15*b077aed3SPierre ProncherySSL_group_to_name() is used to retrieve the TLS group name
16*b077aed3SPierre Proncheryassociated with a given TLS group ID, as registered via built-in
17*b077aed3SPierre Proncheryor external providers and as returned by a call to SSL_get1_groups()
18*b077aed3SPierre Proncheryor SSL_get_shared_group().
19*b077aed3SPierre Pronchery
20*b077aed3SPierre Pronchery=head1 RETURN VALUES
21*b077aed3SPierre Pronchery
22*b077aed3SPierre ProncheryIf non-NULL, SSL_group_to_name() returns the TLS group name
23*b077aed3SPierre Proncherycorresponding to the given I<id> as a NUL-terminated string.
24*b077aed3SPierre ProncheryIf SSL_group_to_name() returns NULL, an error occurred; possibly no
25*b077aed3SPierre Proncherycorresponding tlsname was registered during provider initialisation.
26*b077aed3SPierre Pronchery
27*b077aed3SPierre ProncheryNote that the return value is valid only during the lifetime of the
28*b077aed3SPierre ProncherySSL object I<ssl>.
29*b077aed3SPierre Pronchery
30*b077aed3SPierre Pronchery=head1 SEE ALSO
31*b077aed3SPierre Pronchery
32*b077aed3SPierre ProncheryL<ssl(7)>
33*b077aed3SPierre Pronchery
34*b077aed3SPierre Pronchery=head1 COPYRIGHT
35*b077aed3SPierre Pronchery
36*b077aed3SPierre ProncheryCopyright 2021 The OpenSSL Project Authors. All Rights Reserved.
37*b077aed3SPierre Pronchery
38*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
39*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
40*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
41*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
42*b077aed3SPierre Pronchery
43*b077aed3SPierre Pronchery=cut
44