xref: /freebsd/crypto/openssl/doc/man3/SSL_SESSION_get0_hostname.pod (revision e7be843b4a162e68651d3911f0357ed464915629)
1=pod
2
3=head1 NAME
4
5SSL_SESSION_get0_hostname,
6SSL_SESSION_set1_hostname,
7SSL_SESSION_get0_alpn_selected,
8SSL_SESSION_set1_alpn_selected
9- get and set SNI and ALPN data associated with a session
10
11=head1 SYNOPSIS
12
13 #include <openssl/ssl.h>
14
15 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s);
16 int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname);
17
18 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
19                                     const unsigned char **alpn,
20                                     size_t *len);
21 int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s, const unsigned char *alpn,
22                                    size_t len);
23
24=head1 DESCRIPTION
25
26SSL_SESSION_get0_hostname() retrieves the SNI value that was sent by the
27client when the session was created if it was accepted by the server. Otherwise
28NULL is returned.
29
30The value returned is a pointer to memory maintained within B<s> and
31should not be free'd.
32
33SSL_SESSION_set1_hostname() sets the SNI value for the hostname to a copy of
34the string provided in hostname.
35
36SSL_SESSION_get0_alpn_selected() retrieves the selected ALPN protocol for this
37session and its associated length in bytes. The returned value of B<*alpn> is a
38pointer to memory maintained within B<s> and should not be free'd.
39
40SSL_SESSION_set1_alpn_selected() sets the ALPN protocol for this session to the
41value in B<alpn> which should be of length B<len> bytes. A copy of the input
42value is made, and the caller retains ownership of the memory pointed to by
43B<alpn>.
44
45=head1 RETURN VALUES
46
47SSL_SESSION_get0_hostname() returns either a string or NULL based on if there
48is the SNI value sent by client.
49
50SSL_SESSION_set1_hostname() returns 1 on success or 0 on error.
51
52SSL_SESSION_set1_alpn_selected() returns 1 on success or 0 on error.
53
54=head1 SEE ALSO
55
56L<ssl(7)>,
57L<d2i_SSL_SESSION(3)>,
58L<SSL_SESSION_get_time(3)>,
59L<SSL_SESSION_free(3)>
60
61=head1 HISTORY
62
63The SSL_SESSION_set1_hostname(), SSL_SESSION_get0_alpn_selected() and
64SSL_SESSION_set1_alpn_selected() functions were added in OpenSSL 1.1.1.
65
66=head1 COPYRIGHT
67
68Copyright 2016-2025 The OpenSSL Project Authors. All Rights Reserved.
69
70Licensed under the Apache License 2.0 (the "License").  You may not use
71this file except in compliance with the License.  You can obtain a copy
72in the file LICENSE in the source distribution or at
73L<https://www.openssl.org/source/license.html>.
74
75=cut
76