xref: /freebsd/secure/lib/libcrypto/man/man3/SSL_SESSION_get0_hostname.3 (revision 174c0ac687ec4ccb0b56ee30d48c0a7b8b9c4e15)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "SSL_SESSION_GET0_HOSTNAME 3ossl"
SSL_SESSION_GET0_HOSTNAME 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
SSL_SESSION_get0_hostname, SSL_SESSION_set1_hostname, SSL_SESSION_get0_alpn_selected, SSL_SESSION_set1_alpn_selected \- get and set SNI and ALPN data associated with a session
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s); int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname); \& void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s, const unsigned char **alpn, size_t *len); int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s, const unsigned char *alpn, size_t len); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBSSL_SESSION_get0_hostname() retrieves the \s-1SNI\s0 value that was sent by the client when the session was created if it was accepted by the server and TLSv1.2 or below was negotiated. Otherwise \s-1NULL\s0 is returned. Note that in TLSv1.3 the \s-1SNI\s0 hostname is negotiated with each handshake including resumption handshakes and is therefore never associated with the session.

The value returned is a pointer to memory maintained within s and should not be free'd.

\fBSSL_SESSION_set1_hostname() sets the \s-1SNI\s0 value for the hostname to a copy of the string provided in hostname.

\fBSSL_SESSION_get0_alpn_selected() retrieves the selected \s-1ALPN\s0 protocol for this session and its associated length in bytes. The returned value of *alpn is a pointer to memory maintained within s and should not be free'd.

\fBSSL_SESSION_set1_alpn_selected() sets the \s-1ALPN\s0 protocol for this session to the value in alpn which should be of length len bytes. A copy of the input value is made, and the caller retains ownership of the memory pointed to by \fBalpn.

"RETURN VALUES"
Header "RETURN VALUES" \fBSSL_SESSION_get0_hostname() returns either a string or \s-1NULL\s0 based on if there is the \s-1SNI\s0 value sent by client.

\fBSSL_SESSION_set1_hostname() returns 1 on success or 0 on error.

\fBSSL_SESSION_set1_alpn_selected() returns 1 on success or 0 on error.

"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7), \fBd2i_SSL_SESSION\|(3), \fBSSL_SESSION_get_time\|(3), \fBSSL_SESSION_free\|(3)
"HISTORY"
Header "HISTORY" The SSL_SESSION_set1_hostname(), SSL_SESSION_get0_alpn_selected() and \fBSSL_SESSION_set1_alpn_selected() functions were added in OpenSSL 1.1.1.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.