xref: /freebsd/crypto/openssl/doc/man3/SSL_SESSION_get0_hostname.pod (revision 20bd59416dcacbd2b776fe49dfa193900f303287)
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, or NULL if no value was sent.
28
29The value returned is a pointer to memory maintained within B<s> and
30should not be free'd.
31
32SSL_SESSION_set1_hostname() sets the SNI value for the hostname to a copy of
33the string provided in hostname.
34
35SSL_SESSION_get0_alpn_selected() retrieves the selected ALPN protocol for this
36session and its associated length in bytes. The returned value of B<*alpn> is a
37pointer to memory maintained within B<s> and should not be free'd.
38
39SSL_SESSION_set1_alpn_selected() sets the ALPN protocol for this session to the
40value in B<alpn> which should be of length B<len> bytes. A copy of the input
41value is made, and the caller retains ownership of the memory pointed to by
42B<alpn>.
43
44=head1 RETURN VALUES
45
46SSL_SESSION_get0_hostname() returns either a string or NULL based on if there
47is the SNI value sent by client.
48
49SSL_SESSION_set1_hostname() returns 1 on success or 0 on error.
50
51SSL_SESSION_set1_alpn_selected() returns 1 on success or 0 on error.
52
53=head1 SEE ALSO
54
55L<ssl(7)>,
56L<d2i_SSL_SESSION(3)>,
57L<SSL_SESSION_get_time(3)>,
58L<SSL_SESSION_free(3)>
59
60=head1 HISTORY
61
62The SSL_SESSION_set1_hostname(), SSL_SESSION_get0_alpn_selected() and
63SSL_SESSION_set1_alpn_selected() functions were added in OpenSSL 1.1.1.
64
65=head1 COPYRIGHT
66
67Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
68
69Licensed under the OpenSSL license (the "License").  You may not use
70this file except in compliance with the License.  You can obtain a copy
71in the file LICENSE in the source distribution or at
72L<https://www.openssl.org/source/license.html>.
73
74=cut
75