secure/lib/libcrypto/man/man3/SSL_get_session.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  72 .    \" fudge factors for nroff and troff
  73 .if n \{\
  74 .    ds #H 0
  75 .    ds #V .8m
  76 .    ds #F .3m
  77 .    ds #[ \f1
  78 .    ds #] \fP
  79 .\}
  80 .if t \{\
  81 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  82 .    ds #V .6m
  83 .    ds #F 0
  84 .    ds #[ \&
  85 .    ds #] \&
  86 .\}
  87 .    \" simple accents for nroff and troff
  88 .if n \{\
  89 .    ds ' \&
  90 .    ds ` \&
  91 .    ds ^ \&
  92 .    ds , \&
  93 .    ds ~ ~
  94 .    ds /
  95 .\}
  96 .if t \{\
  97 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  98 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  99 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 100 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 101 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 102 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 103 .\}
 104 .    \" troff and (daisy-wheel) nroff accents
 105 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 106 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 107 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 108 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 109 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 110 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 111 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 112 .ds ae a\h'-(\w'a'u*4/10)'e
 113 .ds Ae A\h'-(\w'A'u*4/10)'E
 114 .    \" corrections for vroff
 115 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 116 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 117 .    \" for low resolution devices (crt and lpr)
 118 .if \n(.H>23 .if \n(.V>19 \
 119 \{\
 120 .    ds : e
 121 .    ds 8 ss
 122 .    ds o a
 123 .    ds d- d\h'-1'\(ga
 124 .    ds D- D\h'-1'\(hy
 125 .    ds th \o'bp'
 126 .    ds Th \o'LP'
 127 .    ds ae ae
 128 .    ds Ae AE
 129 .\}
 130 .rm #[ #] #H #V #F C
 131 .\" ========================================================================
 132 .\"
 133 .IX Title "SSL_GET_SESSION 3ossl"
 134 .TH SSL_GET_SESSION 3ossl "2023-09-19" "3.0.11" "OpenSSL"
 135 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 136 .\" way too many mistakes in technical documents.
 137 .if n .ad l
 138 .nh
 139 .SH "NAME"
 140 SSL_get_session, SSL_get0_session, SSL_get1_session \- retrieve TLS/SSL session data
 141 .SH "SYNOPSIS"
 142 .IX Header "SYNOPSIS"
 143 .Vb 1
 144 \& #include <openssl/ssl.h>
 145 \&
 146 \& SSL_SESSION *SSL_get_session(const SSL *ssl);
 147 \& SSL_SESSION *SSL_get0_session(const SSL *ssl);
 148 \& SSL_SESSION *SSL_get1_session(SSL *ssl);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fBSSL_get_session()\fR returns a pointer to the \fB\s-1SSL_SESSION\s0\fR actually used in
 153 \&\fBssl\fR. The reference count of the \fB\s-1SSL_SESSION\s0\fR is not incremented, so
 154 that the pointer can become invalid by other operations.
 155 .PP
 156 \&\fBSSL_get0_session()\fR is the same as \fBSSL_get_session()\fR.
 157 .PP
 158 \&\fBSSL_get1_session()\fR is the same as \fBSSL_get_session()\fR, but the reference
 159 count of the \fB\s-1SSL_SESSION\s0\fR is incremented by one.
 160 .SH "NOTES"
 161 .IX Header "NOTES"
 162 The ssl session contains all information required to re-establish the
 163 connection without a full handshake for \s-1SSL\s0 versions up to and including
 164 TLSv1.2. In TLSv1.3 the same is true, but sessions are established after the
 165 main handshake has occurred. The server will send the session information to the
 166 client at a time of its choosing, which may be some while after the initial
 167 connection is established (or never). Calling these functions on the client side
 168 in TLSv1.3 before the session has been established will still return an
 169 \&\s-1SSL_SESSION\s0 object but that object cannot be used for resuming the session. See
 170 \&\fBSSL_SESSION_is_resumable\fR\|(3) for information on how to determine whether an
 171 \&\s-1SSL_SESSION\s0 object can be used for resumption or not.
 172 .PP
 173 Additionally, in TLSv1.3, a server can send multiple messages that establish a
 174 session for a single connection. In that case, on the client side, the above
 175 functions will only return information on the last session that was received. On
 176 the server side they will only return information on the last session that was
 177 sent, or if no session tickets were sent then the session for the current
 178 connection.
 179 .PP
 180 The preferred way for applications to obtain a resumable \s-1SSL_SESSION\s0 object is
 181 to use a new session callback as described in \fBSSL_CTX_sess_set_new_cb\fR\|(3).
 182 The new session callback is only invoked when a session is actually established,
 183 so this avoids the problem described above where an application obtains an
 184 \&\s-1SSL_SESSION\s0 object that cannot be used for resumption in TLSv1.3. It also
 185 enables applications to obtain information about all sessions sent by the
 186 server.
 187 .PP
 188 A session will be automatically removed from the session cache and marked as
 189 non-resumable if the connection is not closed down cleanly, e.g. if a fatal
 190 error occurs on the connection or \fBSSL_shutdown\fR\|(3) is not called prior to
 191 \&\fBSSL_free\fR\|(3).
 192 .PP
 193 In TLSv1.3 it is recommended that each \s-1SSL_SESSION\s0 object is only used for
 194 resumption once.
 195 .PP
 196 \&\fBSSL_get0_session()\fR returns a pointer to the actual session. As the
 197 reference counter is not incremented, the pointer is only valid while
 198 the connection is in use. If \fBSSL_clear\fR\|(3) or
 199 \&\fBSSL_free\fR\|(3) is called, the session may be removed completely
 200 (if considered bad), and the pointer obtained will become invalid. Even
 201 if the session is valid, it can be removed at any time due to timeout
 202 during \fBSSL_CTX_flush_sessions\fR\|(3).
 203 .PP
 204 If the data is to be kept, \fBSSL_get1_session()\fR will increment the reference
 205 count, so that the session will not be implicitly removed by other operations
 206 but stays in memory. In order to remove the session
 207 \&\fBSSL_SESSION_free\fR\|(3) must be explicitly called once
 208 to decrement the reference count again.
 209 .PP
 210 \&\s-1SSL_SESSION\s0 objects keep internal link information about the session cache
 211 list, when being inserted into one \s-1SSL_CTX\s0 object's session cache.
 212 One \s-1SSL_SESSION\s0 object, regardless of its reference count, must therefore
 213 only be used with one \s-1SSL_CTX\s0 object (and the \s-1SSL\s0 objects created
 214 from this \s-1SSL_CTX\s0 object).
 215 .SH "RETURN VALUES"
 216 .IX Header "RETURN VALUES"
 217 The following return values can occur:
 218 .IP "\s-1NULL\s0" 4
 219 .IX Item "NULL"
 220 There is no session available in \fBssl\fR.
 221 .IP "Pointer to an \s-1SSL_SESSION\s0" 4
 222 .IX Item "Pointer to an SSL_SESSION"
 223 The return value points to the data of an \s-1SSL\s0 session.
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fBssl\fR\|(7), \fBSSL_free\fR\|(3),
 227 \&\fBSSL_clear\fR\|(3),
 228 \&\fBSSL_SESSION_free\fR\|(3)
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the Apache License 2.0 (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.