Debian Codegraph @

upstream/debian-unstable/man3/SSL_SESSION_get0_hostname.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_SESSION_GET0_HOSTNAME 3SSL"
58 .TH SSL_SESSION_GET0_HOSTNAME 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_SESSION_get0_hostname,
65 SSL_SESSION_set1_hostname,
66 SSL_SESSION_get0_alpn_selected,
67 SSL_SESSION_set1_alpn_selected
68 \&\- get and set SNI and ALPN data associated with a session
69 .SH SYNOPSIS
70 .IX Header "SYNOPSIS"
71 .Vb 1
72 \& #include <openssl/ssl.h>
73 \&
74 \& const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s);
75 \& int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname);
76 \&
77 \& void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
78 \& const unsigned char **alpn,
79 \& size_t *len);
80 \& int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s, const unsigned char *alpn,
81 \& size_t len);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 \&\fBSSL_SESSION_get0_hostname()\fR retrieves the Server Name Indication (SNI) value
86 that was sent by the client when the session was created if the server
87 acknowledged the client's SNI extension by including an empty SNI extension
88 in response. Otherwise NULL is returned.
89 .PP
90 The value returned is a pointer to memory maintained within \fBs\fR and
91 should not be free'd.
92 .PP
93 \&\fBSSL_SESSION_set1_hostname()\fR sets the SNI value for the hostname to a copy of
94 the string provided in hostname.
95 .PP
96 \&\fBSSL_SESSION_get0_alpn_selected()\fR retrieves the selected ALPN protocol for this
97 session and its associated length in bytes. The returned value of \fB*alpn\fR is a
98 pointer to memory maintained within \fBs\fR and should not be free'd.
99 .PP
100 \&\fBSSL_SESSION_set1_alpn_selected()\fR sets the ALPN protocol for this session to the
101 value in \fBalpn\fR which should be of length \fBlen\fR bytes. A copy of the input
102 value is made, and the caller retains ownership of the memory pointed to by
103 \&\fBalpn\fR.
104 .SH "RETURN VALUES"
105 .IX Header "RETURN VALUES"
106 \&\fBSSL_SESSION_get0_hostname()\fR returns the SNI string if available, or NULL if not.
107 .PP
108 \&\fBSSL_SESSION_set1_hostname()\fR returns 1 on success or 0 on error.
109 .PP
110 \&\fBSSL_SESSION_set1_alpn_selected()\fR returns 1 on success or 0 on error.
111 .SH "SEE ALSO"
112 .IX Header "SEE ALSO"
113 \&\fBssl\fR\|(7),
114 \&\fBd2i_SSL_SESSION\fR\|(3),
115 \&\fBSSL_SESSION_get_time\fR\|(3),
116 \&\fBSSL_SESSION_free\fR\|(3)
117 .SH HISTORY
118 .IX Header "HISTORY"
119 The \fBSSL_SESSION_set1_hostname()\fR, \fBSSL_SESSION_get0_alpn_selected()\fR and
120 \&\fBSSL_SESSION_set1_alpn_selected()\fR functions were added in OpenSSL 1.1.1.
121 .SH COPYRIGHT
122 .IX Header "COPYRIGHT"
123 Copyright 2016\-2025 The OpenSSL Project Authors. All Rights Reserved.
124 .PP
125 Licensed under the Apache License 2.0 (the "License"). You may not use
126 this file except in compliance with the License. You can obtain a copy
127 in the file LICENSE in the source distribution or at
128 <https://www.openssl.org/source/license.html>.