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