doc/man3/SSL_read_early_data.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_set_max_early_data,
   6 SSL_CTX_set_max_early_data,
   7 SSL_get_max_early_data,
   8 SSL_CTX_get_max_early_data,
   9 SSL_SESSION_get_max_early_data,
  10 SSL_SESSION_set_max_early_data,
  11 SSL_write_early_data,
  12 SSL_read_early_data,
  13 SSL_get_early_data_status,
  14 SSL_allow_early_data_cb_fn,
  15 SSL_CTX_set_allow_early_data_cb,
  16 SSL_set_allow_early_data_cb
  17 - functions for sending and receiving early data
  18
  19 =head1 SYNOPSIS
  20
  21  #include <openssl/ssl.h>
  22
  23  int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data);
  24  uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx);
  25  int SSL_set_max_early_data(SSL *s, uint32_t max_early_data);
  26  uint32_t SSL_get_max_early_data(const SSL *s);
  27  uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s);
  28  int SSL_SESSION_set_max_early_data(SSL_SESSION *s, uint32_t max_early_data);
  29
  30  int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written);
  31
  32  int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes);
  33
  34  int SSL_get_early_data_status(const SSL *s);
  35
  36
  37  typedef int (*SSL_allow_early_data_cb_fn)(SSL *s, void *arg);
  38
  39  void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
  40                                       SSL_allow_early_data_cb_fn cb,
  41                                       void *arg);
  42  void SSL_set_allow_early_data_cb(SSL *s,
  43                                   SSL_allow_early_data_cb_fn cb,
  44                                   void *arg);
  45
  46 =head1 DESCRIPTION
  47
  48 These functions are used to send and receive early data where TLSv1.3 has been
  49 negotiated. Early data can be sent by the client immediately after its initial
  50 ClientHello without having to wait for the server to complete the handshake.
  51 Early data can only be sent if a session has previously been established with
  52 the server, and the server is known to support it. Additionally these functions
  53 can be used to send data from the server to the client when the client has not
  54 yet completed the authentication stage of the handshake.
  55
  56 Early data has weaker security properties than other data sent over an SSL/TLS
  57 connection. In particular the data does not have forward secrecy. There are also
  58 additional considerations around replay attacks (see L<REPLAY PROTECTION>
  59 below). For these reasons extreme care should be exercised when using early
  60 data. For specific details, consult the TLS 1.3 specification.
  61
  62 When a server receives early data it may opt to immediately respond by sending
  63 application data back to the client. Data sent by the server at this stage is
  64 done before the full handshake has been completed. Specifically the client's
  65 authentication messages have not yet been received, i.e. the client is
  66 unauthenticated at this point and care should be taken when using this
  67 capability.
  68
  69 A server or client can determine whether the full handshake has been completed
  70 or not by calling L<SSL_is_init_finished(3)>.
  71
  72 On the client side, the function SSL_SESSION_get_max_early_data() can be used to
  73 determine if a session established with a server can be used to send early data.
  74 If the session cannot be used then this function will return 0. Otherwise it
  75 will return the maximum number of early data bytes that can be sent.
  76
  77 The function SSL_SESSION_set_max_early_data() sets the maximum number of early
  78 data bytes that can be sent for a session. This would typically be used when
  79 creating a PSK session file (see L<SSL_CTX_set_psk_use_session_callback(3)>). If
  80 using a ticket based PSK then this is set automatically to the value provided by
  81 the server.
  82
  83 A client uses the function SSL_write_early_data() to send early data. This
  84 function is similar to the L<SSL_write_ex(3)> function, but with the following
  85 differences. See L<SSL_write_ex(3)> for information on how to write bytes to
  86 the underlying connection, and how to handle any errors that may arise. This
  87 page describes the differences between SSL_write_early_data() and
  88 L<SSL_write_ex(3)>.
  89
  90 When called by a client, SSL_write_early_data() must be the first IO function
  91 called on a new connection, i.e. it must occur before any calls to
  92 L<SSL_write_ex(3)>, L<SSL_read_ex(3)>, L<SSL_connect(3)>, L<SSL_do_handshake(3)>
  93 or other similar functions. It may be called multiple times to stream data to
  94 the server, but the total number of bytes written must not exceed the value
  95 returned from SSL_SESSION_get_max_early_data(). Once the initial
  96 SSL_write_early_data() call has completed successfully the client may interleave
  97 calls to L<SSL_read_ex(3)> and L<SSL_read(3)> with calls to
  98 SSL_write_early_data() as required.
  99
 100 If SSL_write_early_data() fails you should call L<SSL_get_error(3)> to determine
 101 the correct course of action, as for L<SSL_write_ex(3)>.
 102
 103 When the client no longer wishes to send any more early data then it should
 104 complete the handshake by calling a function such as L<SSL_connect(3)> or
 105 L<SSL_do_handshake(3)>. Alternatively you can call a standard write function
 106 such as L<SSL_write_ex(3)>, which will transparently complete the connection and
 107 write the requested data.
 108
 109 A server may choose to ignore early data that has been sent to it. Once the
 110 connection has been completed you can determine whether the server accepted or
 111 rejected the early data by calling SSL_get_early_data_status(). This will return
 112 SSL_EARLY_DATA_ACCEPTED if the data was accepted, SSL_EARLY_DATA_REJECTED if it
 113 was rejected or SSL_EARLY_DATA_NOT_SENT if no early data was sent. This function
 114 may be called by either the client or the server.
 115
 116 A server uses the SSL_read_early_data() function to receive early data on a
 117 connection for which early data has been enabled using
 118 SSL_CTX_set_max_early_data() or SSL_set_max_early_data(). As for
 119 SSL_write_early_data(), this must be the first IO function
 120 called on a connection, i.e. it must occur before any calls to
 121 L<SSL_write_ex(3)>, L<SSL_read_ex(3)>, L<SSL_accept(3)>, L<SSL_do_handshake(3)>,
 122 or other similar functions.
 123
 124 SSL_read_early_data() is similar to L<SSL_read_ex(3)> with the following
 125 differences. Refer to L<SSL_read_ex(3)> for full details.
 126
 127 SSL_read_early_data() may return 3 possible values:
 128
 129 =over 4
 130
 131 =item SSL_READ_EARLY_DATA_ERROR
 132
 133 This indicates an IO or some other error occurred. This should be treated in the
 134 same way as a 0 return value from L<SSL_read_ex(3)>.
 135
 136 =item SSL_READ_EARLY_DATA_SUCCESS
 137
 138 This indicates that early data was successfully read. This should be treated in
 139 the same way as a 1 return value from L<SSL_read_ex(3)>. You should continue to
 140 call SSL_read_early_data() to read more data.
 141
 142 =item SSL_READ_EARLY_DATA_FINISH
 143
 144 This indicates that no more early data can be read. It may be returned on the
 145 first call to SSL_read_early_data() if the client has not sent any early data,
 146 or if the early data was rejected.
 147
 148 =back
 149
 150 Once the initial SSL_read_early_data() call has completed successfully (i.e. it
 151 has returned SSL_READ_EARLY_DATA_SUCCESS or SSL_READ_EARLY_DATA_FINISH) then the
 152 server may choose to write data immediately to the unauthenticated client using
 153 SSL_write_early_data(). If SSL_read_early_data() returned
 154 SSL_READ_EARLY_DATA_FINISH then in some situations (e.g. if the client only
 155 supports TLSv1.2) the handshake may have already been completed and calls
 156 to SSL_write_early_data() are not allowed. Call L<SSL_is_init_finished(3)> to
 157 determine whether the handshake has completed or not. If the handshake is still
 158 in progress then the server may interleave calls to SSL_write_early_data() with
 159 calls to SSL_read_early_data() as required.
 160
 161 Servers must not call L<SSL_read_ex(3)>, L<SSL_read(3)>, L<SSL_write_ex(3)> or
 162 L<SSL_write(3)>  until SSL_read_early_data() has returned with
 163 SSL_READ_EARLY_DATA_FINISH. Once it has done so the connection to the client
 164 still needs to be completed. Complete the connection by calling a function such
 165 as L<SSL_accept(3)> or L<SSL_do_handshake(3)>. Alternatively you can call a
 166 standard read function such as L<SSL_read_ex(3)>, which will transparently
 167 complete the connection and read the requested data. Note that it is an error to
 168 attempt to complete the connection before SSL_read_early_data() has returned
 169 SSL_READ_EARLY_DATA_FINISH.
 170
 171 Only servers may call SSL_read_early_data().
 172
 173 Calls to SSL_read_early_data() may, in certain circumstances, complete the
 174 connection immediately without further need to call a function such as
 175 L<SSL_accept(3)>. This can happen if the client is using a protocol version less
 176 than TLSv1.3. Applications can test for this by calling
 177 L<SSL_is_init_finished(3)>. Alternatively, applications may choose to call
 178 L<SSL_accept(3)> anyway. Such a call will successfully return immediately with no
 179 further action taken.
 180
 181 When a session is created between a server and a client the server will specify
 182 the maximum amount of any early data that it will accept on any future
 183 connection attempt. By default the server does not accept early data; a
 184 server may indicate support for early data by calling
 185 SSL_CTX_set_max_early_data() or
 186 SSL_set_max_early_data() to set it for the whole SSL_CTX or an individual SSL
 187 object respectively. The B<max_early_data> parameter specifies the maximum
 188 amount of early data in bytes that is permitted to be sent on a single
 189 connection. Similarly the SSL_CTX_get_max_early_data() and
 190 SSL_get_max_early_data() functions can be used to obtain the current maximum
 191 early data settings for the SSL_CTX and SSL objects respectively. Generally a
 192 server application will either use both of SSL_read_early_data() and
 193 SSL_CTX_set_max_early_data() (or SSL_set_max_early_data()), or neither of them,
 194 since there is no practical benefit from using only one of them. If the maximum
 195 early data setting for a server is non-zero then replay protection is
 196 automatically enabled (see L</REPLAY PROTECTION> below).
 197
 198 In the event that the current maximum early data setting for the server is
 199 different to that originally specified in a session that a client is resuming
 200 with then the lower of the two values will apply.
 201
 202 Some server applications may wish to have more control over whether early data
 203 is accepted or not, for example to mitigate replay risks (see L</REPLAY PROTECTION>
 204 below) or to decline early_data when the server is heavily loaded. The functions
 205 SSL_CTX_set_allow_early_data_cb() and SSL_set_allow_early_data_cb() set a
 206 callback which is called at a point in the handshake immediately before a
 207 decision is made to accept or reject early data. The callback is provided with a
 208 pointer to the user data argument that was provided when the callback was first
 209 set. Returning 1 from the callback will allow early data and returning 0 will
 210 reject it. Note that the OpenSSL library may reject early data for other reasons
 211 in which case this callback will not get called. Notably, the built-in replay
 212 protection feature will still be used even if a callback is present unless it
 213 has been explicitly disabled using the SSL_OP_NO_ANTI_REPLAY option. See
 214 L</REPLAY PROTECTION> below.
 215
 216 =head1 NOTES
 217
 218 The whole purpose of early data is to enable a client to start sending data to
 219 the server before a full round trip of network traffic has occurred. Application
 220 developers should ensure they consider optimisation of the underlying TCP socket
 221 to obtain a performant solution. For example Nagle's algorithm is commonly used
 222 by operating systems in an attempt to avoid lots of small TCP packets. In many
 223 scenarios this is beneficial for performance, but it does not work well with the
 224 early data solution as implemented in OpenSSL. In Nagle's algorithm the OS will
 225 buffer outgoing TCP data if a TCP packet has already been sent which we have not
 226 yet received an ACK for from the peer. The buffered data will only be
 227 transmitted if enough data to fill an entire TCP packet is accumulated, or if
 228 the ACK is received from the peer. The initial ClientHello will be sent in the
 229 first TCP packet along with any data from the first call to
 230 SSL_write_early_data(). If the amount of data written will exceed the size of a
 231 single TCP packet, or if there are more calls to SSL_write_early_data() then
 232 that additional data will be sent in subsequent TCP packets which will be
 233 buffered by the OS and not sent until an ACK is received for the first packet
 234 containing the ClientHello. This means the early data is not actually
 235 sent until a complete round trip with the server has occurred which defeats the
 236 objective of early data.
 237
 238 In many operating systems the TCP_NODELAY socket option is available to disable
 239 Nagle's algorithm. If an application opts to disable Nagle's algorithm
 240 consideration should be given to turning it back on again after the handshake is
 241 complete if appropriate.
 242
 243 =head1 REPLAY PROTECTION
 244
 245 When early data is in use the TLS protocol provides no security guarantees that
 246 the same early data was not replayed across multiple connections. As a
 247 mitigation for this issue OpenSSL automatically enables replay protection if the
 248 server is configured with a non-zero max early data value. With replay
 249 protection enabled sessions are forced to be single use only. If a client
 250 attempts to reuse a session ticket more than once, then the second and
 251 subsequent attempts will fall back to a full handshake (and any early data that
 252 was submitted will be ignored). Note that single use tickets are enforced even
 253 if a client does not send any early data.
 254
 255 The replay protection mechanism relies on the internal OpenSSL server session
 256 cache (see L<SSL_CTX_set_session_cache_mode(3)>). When replay protection is
 257 being used the server will operate as if the SSL_OP_NO_TICKET option had been
 258 selected (see L<SSL_CTX_set_options(3)>). Sessions will be added to the cache
 259 whenever a session ticket is issued. When a client attempts to resume the
 260 session, OpenSSL will check for its presence in the internal cache. If it exists
 261 then the resumption is allowed and the session is removed from the cache. If it
 262 does not exist then the resumption is not allowed and a full handshake will
 263 occur.
 264
 265 Note that some applications may maintain an external cache of sessions (see
 266 L<SSL_CTX_sess_set_new_cb(3)> and similar functions). It is the application's
 267 responsibility to ensure that any sessions in the external cache are also
 268 populated in the internal cache and that once removed from the internal cache
 269 they are similarly removed from the external cache. Failing to do this could
 270 result in an application becoming vulnerable to replay attacks. Note that
 271 OpenSSL will lock the internal cache while a session is removed but that lock is
 272 not held when the remove session callback (see L<SSL_CTX_sess_set_remove_cb(3)>)
 273 is called. This could result in a small amount of time where the session has
 274 been removed from the internal cache but is still available in the external
 275 cache. Applications should be designed with this in mind in order to minimise
 276 the possibility of replay attacks.
 277
 278 The OpenSSL replay protection does not apply to external Pre Shared Keys (PSKs)
 279 (e.g. see SSL_CTX_set_psk_find_session_callback(3)). Therefore extreme caution
 280 should be applied when combining external PSKs with early data.
 281
 282 Some applications may mitigate the replay risks in other ways. For those
 283 applications it is possible to turn off the built-in replay protection feature
 284 using the B<SSL_OP_NO_ANTI_REPLAY> option. See L<SSL_CTX_set_options(3)> for
 285 details. Applications can also set a callback to make decisions about accepting
 286 early data or not. See SSL_CTX_set_allow_early_data_cb() above for details.
 287
 288 =head1 RETURN VALUES
 289
 290 SSL_write_early_data() returns 1 for success or 0 for failure. In the event of a
 291 failure call L<SSL_get_error(3)> to determine the correct course of action.
 292
 293 SSL_read_early_data() returns SSL_READ_EARLY_DATA_ERROR for failure,
 294 SSL_READ_EARLY_DATA_SUCCESS for success with more data to read and
 295 SSL_READ_EARLY_DATA_FINISH for success with no more to data be read. In the
 296 event of a failure call L<SSL_get_error(3)> to determine the correct course of
 297 action.
 298
 299 SSL_get_max_early_data(), SSL_CTX_get_max_early_data() and
 300 SSL_SESSION_get_max_early_data() return the maximum number of early data bytes
 301 that may be sent.
 302
 303 SSL_set_max_early_data(), SSL_CTX_set_max_early_data() and
 304 SSL_SESSION_set_max_early_data() return 1 for success or 0 for failure.
 305
 306 SSL_get_early_data_status() returns SSL_EARLY_DATA_ACCEPTED if early data was
 307 accepted by the server, SSL_EARLY_DATA_REJECTED if early data was rejected by
 308 the server, or SSL_EARLY_DATA_NOT_SENT if no early data was sent.
 309
 310 =head1 SEE ALSO
 311
 312 L<SSL_get_error(3)>,
 313 L<SSL_write_ex(3)>,
 314 L<SSL_read_ex(3)>,
 315 L<SSL_connect(3)>,
 316 L<SSL_accept(3)>,
 317 L<SSL_do_handshake(3)>,
 318 L<SSL_CTX_set_psk_use_session_callback(3)>,
 319 L<ssl(7)>
 320
 321 =head1 HISTORY
 322
 323 All of the functions described above were added in OpenSSL 1.1.1.
 324
 325 =head1 COPYRIGHT
 326
 327 Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
 328
 329 Licensed under the OpenSSL license (the "License").  You may not use
 330 this file except in compliance with the License.  You can obtain a copy
 331 in the file LICENSE in the source distribution or at
 332 L<https://www.openssl.org/source/license.html>.
 333
 334 =cut