secure/lib/libcrypto/man/SSL_get_session.3

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