$NetBSD: SSL_SESSION_get0_hostname.3,v 1.9 2024/09/08 13:08:33 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "SSL_SESSION_get0_hostname 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
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 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 Header "DESCRIPTION" \fBSSL_SESSION_get0_hostname() retrieves the SNI 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 NULL is returned. Note that in TLSv1.3 the SNI 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 SNI value for the hostname to a copy of the string provided in hostname.

\fBSSL_SESSION_get0_alpn_selected() retrieves the selected ALPN 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 ALPN 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.

Header "RETURN VALUES" \fBSSL_SESSION_get0_hostname() returns either a string or NULL based on if there is the SNI 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.

Header "SEE ALSO" \fBssl\|(7), \fBd2i_SSL_SESSION\|(3), \fBSSL_SESSION_get_time\|(3), \fBSSL_SESSION_free\|(3) 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. Header "COPYRIGHT" Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.

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