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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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_KEY_UPDATE 3"
 136 .TH SSL_KEY_UPDATE 3 "2020-03-31" "1.1.1f" "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_key_update, SSL_get_key_update_type, SSL_renegotiate, SSL_renegotiate_abbreviated, SSL_renegotiate_pending \&\- initiate and obtain information about updating connection keys
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_key_update(SSL *s, int updatetype);
 149 \& int SSL_get_key_update_type(const SSL *s);
 150 \&
 151 \& int SSL_renegotiate(SSL *s);
 152 \& int SSL_renegotiate_abbreviated(SSL *s);
 153 \& int SSL_renegotiate_pending(const SSL *s);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 \&\fBSSL_key_update()\fR schedules an update of the keys for the current \s-1TLS\s0 connection.
 158 If the \fBupdatetype\fR parameter is set to \fB\s-1SSL_KEY_UPDATE_NOT_REQUESTED\s0\fR then
 159 the sending keys for this connection will be updated and the peer will be
 160 informed of the change. If the \fBupdatetype\fR parameter is set to
 161 \&\fB\s-1SSL_KEY_UPDATE_REQUESTED\s0\fR then the sending keys for this connection will be
 162 updated and the peer will be informed of the change along with a request for the
 163 peer to additionally update its sending keys. It is an error if \fBupdatetype\fR is
 164 set to \fB\s-1SSL_KEY_UPDATE_NONE\s0\fR.
 165 .PP
 166 \&\fBSSL_key_update()\fR must only be called after the initial handshake has been
 167 completed and TLSv1.3 has been negotiated. The key update will not take place
 168 until the next time an \s-1IO\s0 operation such as \fBSSL_read_ex()\fR or \fBSSL_write_ex()\fR
 169 takes place on the connection. Alternatively \fBSSL_do_handshake()\fR can be called to
 170 force the update to take place immediately.
 171 .PP
 172 \&\fBSSL_get_key_update_type()\fR can be used to determine whether a key update
 173 operation has been scheduled but not yet performed. The type of the pending key
 174 update operation will be returned if there is one, or \s-1SSL_KEY_UPDATE_NONE\s0
 175 otherwise.
 176 .PP
 177 \&\fBSSL_renegotiate()\fR and \fBSSL_renegotiate_abbreviated()\fR should only be called for
 178 connections that have negotiated TLSv1.2 or less. Calling them on any other
 179 connection will result in an error.
 180 .PP
 181 When called from the client side, \fBSSL_renegotiate()\fR schedules a completely new
 182 handshake over an existing \s-1SSL/TLS\s0 connection. The next time an \s-1IO\s0 operation
 183 such as \fBSSL_read_ex()\fR or \fBSSL_write_ex()\fR takes place on the connection a check
 184 will be performed to confirm that it is a suitable time to start a
 185 renegotiation. If so, then it will be initiated immediately. OpenSSL will not
 186 attempt to resume any session associated with the connection in the new
 187 handshake.
 188 .PP
 189 When called from the client side, \fBSSL_renegotiate_abbreviated()\fR works in the
 190 same was as \fBSSL_renegotiate()\fR except that OpenSSL will attempt to resume the
 191 session associated with the current connection in the new handshake.
 192 .PP
 193 When called from the server side, \fBSSL_renegotiate()\fR and
 194 \&\fBSSL_renegotiate_abbreviated()\fR behave identically. They both schedule a request
 195 for a new handshake to be sent to the client. The next time an \s-1IO\s0 operation is
 196 performed then the same checks as on the client side are performed and then, if
 197 appropriate, the request is sent. The client may or may not respond with a new
 198 handshake and it may or may not attempt to resume an existing session. If
 199 a new handshake is started then this will be handled transparently by calling
 200 any OpenSSL \s-1IO\s0 function.
 201 .PP
 202 If an OpenSSL client receives a renegotiation request from a server then again
 203 this will be handled transparently through calling any OpenSSL \s-1IO\s0 function. For
 204 a \s-1TLS\s0 connection the client will attempt to resume the current session in the
 205 new handshake. For historical reasons, \s-1DTLS\s0 clients will not attempt to resume
 206 the session in the new handshake.
 207 .PP
 208 The \fBSSL_renegotiate_pending()\fR function returns 1 if a renegotiation or
 209 renegotiation request has been scheduled but not yet acted on, or 0 otherwise.
 210 .SH "RETURN VALUES"
 211 .IX Header "RETURN VALUES"
 212 \&\fBSSL_key_update()\fR, \fBSSL_renegotiate()\fR and \fBSSL_renegotiate_abbreviated()\fR return 1
 213 on success or 0 on error.
 214 .PP
 215 \&\fBSSL_get_key_update_type()\fR returns the update type of the pending key update
 216 operation or \s-1SSL_KEY_UPDATE_NONE\s0 if there is none.
 217 .PP
 218 \&\fBSSL_renegotiate_pending()\fR returns 1 if a renegotiation or renegotiation request
 219 has been scheduled but not yet acted on, or 0 otherwise.
 220 .SH "SEE ALSO"
 221 .IX Header "SEE ALSO"
 222 \&\fBssl\fR\|(7), \fBSSL_read_ex\fR\|(3),
 223 \&\fBSSL_write_ex\fR\|(3),
 224 \&\fBSSL_do_handshake\fR\|(3)
 225 .SH "HISTORY"
 226 .IX Header "HISTORY"
 227 The \fBSSL_key_update()\fR and \fBSSL_get_key_update_type()\fR functions were added in
 228 OpenSSL 1.1.1.
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2017\-2019 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (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>.