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

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   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 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_GET_SESSION 3"
 136 .TH SSL_GET_SESSION 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_get_session, SSL_get0_session, SSL_get1_session \- retrieve TLS/SSL session data
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& SSL_SESSION *SSL_get_session(const SSL *ssl);
 149 \& SSL_SESSION *SSL_get0_session(const SSL *ssl);
 150 \& SSL_SESSION *SSL_get1_session(SSL *ssl);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fBSSL_get_session()\fR returns a pointer to the \fB\s-1SSL_SESSION\s0\fR actually used in
 155 \&\fBssl\fR. The reference count of the \fB\s-1SSL_SESSION\s0\fR is not incremented, so
 156 that the pointer can become invalid by other operations.
 157 .PP
 158 \&\fBSSL_get0_session()\fR is the same as \fBSSL_get_session()\fR.
 159 .PP
 160 \&\fBSSL_get1_session()\fR is the same as \fBSSL_get_session()\fR, but the reference
 161 count of the \fB\s-1SSL_SESSION\s0\fR is incremented by one.
 162 .SH "NOTES"
 163 .IX Header "NOTES"
 164 The ssl session contains all information required to re-establish the
 165 connection without a full handshake for \s-1SSL\s0 versions up to and including
 166 TLSv1.2. In TLSv1.3 the same is true, but sessions are established after the
 167 main handshake has occurred. The server will send the session information to the
 168 client at a time of its choosing, which may be some while after the initial
 169 connection is established (or never). Calling these functions on the client side
 170 in TLSv1.3 before the session has been established will still return an
 171 \&\s-1SSL_SESSION\s0 object but that object cannot be used for resuming the session. See
 172 \&\fBSSL_SESSION_is_resumable\fR\|(3) for information on how to determine whether an
 173 \&\s-1SSL_SESSION\s0 object can be used for resumption or not.
 174 .PP
 175 Additionally, in TLSv1.3, a server can send multiple messages that establish a
 176 session for a single connection. In that case, on the client side, the above
 177 functions will only return information on the last session that was received. On
 178 the server side they will only return information on the last session that was
 179 sent, or if no session tickets were sent then the session for the current
 180 connection.
 181 .PP
 182 The preferred way for applications to obtain a resumable \s-1SSL_SESSION\s0 object is
 183 to use a new session callback as described in \fBSSL_CTX_sess_set_new_cb\fR\|(3).
 184 The new session callback is only invoked when a session is actually established,
 185 so this avoids the problem described above where an application obtains an
 186 \&\s-1SSL_SESSION\s0 object that cannot be used for resumption in TLSv1.3. It also
 187 enables applications to obtain information about all sessions sent by the
 188 server.
 189 .PP
 190 A session will be automatically removed from the session cache and marked as
 191 non-resumable if the connection is not closed down cleanly, e.g. if a fatal
 192 error occurs on the connection or \fBSSL_shutdown\fR\|(3) is not called prior to
 193 \&\fBSSL_free\fR\|(3).
 194 .PP
 195 In TLSv1.3 it is recommended that each \s-1SSL_SESSION\s0 object is only used for
 196 resumption once.
 197 .PP
 198 \&\fBSSL_get0_session()\fR returns a pointer to the actual session. As the
 199 reference counter is not incremented, the pointer is only valid while
 200 the connection is in use. If \fBSSL_clear\fR\|(3) or
 201 \&\fBSSL_free\fR\|(3) is called, the session may be removed completely
 202 (if considered bad), and the pointer obtained will become invalid. Even
 203 if the session is valid, it can be removed at any time due to timeout
 204 during \fBSSL_CTX_flush_sessions\fR\|(3).
 205 .PP
 206 If the data is to be kept, \fBSSL_get1_session()\fR will increment the reference
 207 count, so that the session will not be implicitly removed by other operations
 208 but stays in memory. In order to remove the session
 209 \&\fBSSL_SESSION_free\fR\|(3) must be explicitly called once
 210 to decrement the reference count again.
 211 .PP
 212 \&\s-1SSL_SESSION\s0 objects keep internal link information about the session cache
 213 list, when being inserted into one \s-1SSL_CTX\s0 object's session cache.
 214 One \s-1SSL_SESSION\s0 object, regardless of its reference count, must therefore
 215 only be used with one \s-1SSL_CTX\s0 object (and the \s-1SSL\s0 objects created
 216 from this \s-1SSL_CTX\s0 object).
 217 .SH "RETURN VALUES"
 218 .IX Header "RETURN VALUES"
 219 The following return values can occur:
 220 .IP "\s-1NULL\s0" 4
 221 .IX Item "NULL"
 222 There is no session available in \fBssl\fR.
 223 .IP "Pointer to an \s-1SSL_SESSION\s0" 4
 224 .IX Item "Pointer to an SSL_SESSION"
 225 The return value points to the data of an \s-1SSL\s0 session.
 226 .SH "SEE ALSO"
 227 .IX Header "SEE ALSO"
 228 \&\fBssl\fR\|(7), \fBSSL_free\fR\|(3),
 229 \&\fBSSL_clear\fR\|(3),
 230 \&\fBSSL_SESSION_free\fR\|(3)
 231 .SH "COPYRIGHT"
 232 .IX Header "COPYRIGHT"
 233 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
 234 .PP
 235 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 236 this file except in compliance with the License.  You can obtain a copy
 237 in the file \s-1LICENSE\s0 in the source distribution or at
 238 <https://www.openssl.org/source/license.html>.