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