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 and there are
  45 no guarantees that the same early data was not replayed across multiple
  46 connections. For this reason 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)>).
  67
  68 A client uses the function SSL_write_early_data() to send early data. This
  69 function is similar to the L<SSL_write_ex(3)> function, but with the following
  70 differences. See L<SSL_write_ex(3)> for information on how to write bytes to
  71 the underlying connection, and how to handle any errors that may arise. This
  72 page describes the differences between SSL_write_early_data() and
  73 L<SSL_write_ex(3)>.
  74
  75 When called by a client, SSL_write_early_data() must be the first IO function
  76 called on a new connection, i.e. it must occur before any calls to
  77 L<SSL_write_ex(3)>, L<SSL_read_ex(3)>, L<SSL_connect(3)>, L<SSL_do_handshake(3)>
  78 or other similar functions. It may be called multiple times to stream data to
  79 the server, but the total number of bytes written must not exceed the value
  80 returned from SSL_SESSION_get_max_early_data(). Once the initial
  81 SSL_write_early_data() call has completed successfully the client may interleave
  82 calls to L<SSL_read_ex(3)> and L<SSL_read(3)> with calls to
  83 SSL_write_early_data() as required.
  84
  85 If SSL_write_early_data() fails you should call L<SSL_get_error(3)> to determine
  86 the correct course of action, as for L<SSL_write_ex(3)>.
  87
  88 When the client no longer wishes to send any more early data then it should
  89 complete the handshake by calling a function such as L<SSL_connect(3)> or
  90 L<SSL_do_handshake(3)>. Alternatively you can call a standard write function
  91 such as L<SSL_write_ex(3)>, which will transparently complete the connection and
  92 write the requested data.
  93
  94 A server may choose to ignore early data that has been sent to it. Once the
  95 connection has been completed you can determine whether the server accepted or
  96 rejected the early data by calling SSL_get_early_data_status(). This will return
  97 SSL_EARLY_DATA_ACCEPTED if the data was accepted, SSL_EARLY_DATA_REJECTED if it
  98 was rejected or SSL_EARLY_DATA_NOT_SENT if no early data was sent. This function
  99 may be called by either the client or the server.
 100
 101 A server uses the SSL_read_early_data() function to receive early data on a
 102 connection. As for SSL_write_early_data() this must be the first IO function
 103 called on a connection, i.e. it must occur before any calls to
 104 L<SSL_write_ex(3)>, L<SSL_read_ex(3)>, L<SSL_accept(3)>, L<SSL_do_handshake(3)>,
 105 or other similar functions.
 106
 107 SSL_read_early_data() is similar to L<SSL_read_ex(3)> with the following
 108 differences. Refer to L<SSL_read_ex(3)> for full details.
 109
 110 SSL_read_early_data() may return 3 possible values:
 111
 112 =over 4
 113
 114 =item SSL_READ_EARLY_DATA_ERROR
 115
 116 This indicates an IO or some other error occured. This should be treated in the
 117 same way as a 0 return value from L<SSL_read_ex(3)>.
 118
 119 =item SSL_READ_EARLY_DATA_SUCCESS
 120
 121 This indicates that early data was successfully read. This should be treated in
 122 the same way as a 1 return value from L<SSL_read_ex(3)>. You should continue to
 123 call SSL_read_early_data() to read more data.
 124
 125 =item SSL_READ_EARLY_DATA_FINISH
 126
 127 This indicates that no more early data can be read. It may be returned on the
 128 first call to SSL_read_early_data() if the client has not sent any early data,
 129 or if the early data was rejected.
 130
 131 =back
 132
 133 Once the initial SSL_read_early_data() call has completed successfully (i.e. it
 134 has returned SSL_READ_EARLY_DATA_SUCCESS or SSL_READ_EARLY_DATA_FINISH) then the
 135 server may choose to write data immediately to the unauthenticated client using
 136 SSL_write_early_data(). If SSL_read_early_data() returned
 137 SSL_READ_EARLY_DATA_FINISH then in some situations (e.g. if the client only
 138 supports TLSv1.2) the handshake may have already been completed and calls
 139 to SSL_write_early_data() are not allowed. Call L<SSL_is_init_finished(3)> to
 140 determine whether the handshake has completed or not. If the handshake is still
 141 in progress then the server may interleave calls to SSL_write_early_data() with
 142 calls to SSL_read_early_data() as required.
 143
 144 Servers must not call L<SSL_read_ex(3)>, L<SSL_read(3)>, L<SSL_write_ex(3)> or
 145 L<SSL_write(3)>  until SSL_read_early_data() has returned with
 146 SSL_READ_EARLY_DATA_FINISH. Once it has done so the connection to the client
 147 still needs to be completed. Complete the connection by calling a function such
 148 as L<SSL_accept(3)> or L<SSL_do_handshake(3)>. Alternatively you can call a
 149 standard read function such as L<SSL_read_ex(3)>, which will transparently
 150 complete the connection and read the requested data. Note that it is an error to
 151 attempt to complete the connection before SSL_read_early_data() has returned
 152 SSL_READ_EARLY_DATA_FINISH.
 153
 154 Only servers may call SSL_read_early_data().
 155
 156 Calls to SSL_read_early_data() may, in certain circumstances, complete the
 157 connection immediately without further need to call a function such as
 158 L<SSL_accept(3)>. This can happen if the client is using a protocol version less
 159 than TLSv1.3. Applications can test for this by calling
 160 L<SSL_is_init_finished(3)>. Alternatively, applications may choose to call
 161 L<SSL_accept(3)> anyway. Such a call will successfully return immediately with no
 162 further action taken.
 163
 164 When a session is created between a server and a client the server will specify
 165 the maximum amount of any early data that it will accept on any future
 166 connection attempt. By default this is approximately 16k. A server may override
 167 this default value by calling SSL_CTX_set_max_early_data() or
 168 SSL_set_max_early_data() to set it for the whole SSL_CTX or an individual SSL
 169 object respectively. Similarly the SSL_CTX_get_max_early_data() and
 170 SSL_get_max_early_data() functions can be used to obtain the current maximum
 171 early data settings for the SSL_CTX and SSL objects respectively.
 172
 173 In the event that the current maximum early data setting for the server is
 174 different to that originally specified in a session that a client is resuming
 175 with then the lower of the two values will apply.
 176
 177 =head1 NOTES
 178
 179 The whole purpose of early data is to enable a client to start sending data to
 180 the server before a full round trip of network traffic has occurred. Application
 181 developers should ensure they consider optimisation of the underlying TCP socket
 182 to obtain a performant solution. For example Nagle's algorithm is commonly used
 183 by operating systems in an attempt to avoid lots of small TCP packets. In many
 184 scenarios this is beneficial for performance, but it does not work well with the
 185 early data solution as implemented in OpenSSL. In Nagle's algorithm the OS will
 186 buffer outgoing TCP data if a TCP packet has already been sent which we have not
 187 yet received an ACK for from the peer. The buffered data will only be
 188 transmitted if enough data to fill an entire TCP packet is accumulated, or if
 189 the ACK is received from the peer. The initial ClientHello will be sent as the
 190 first TCP packet, causing the early application data from calls to
 191 SSL_write_early_data() to be buffered by the OS and not sent until an ACK is
 192 received for the ClientHello packet. This means the early data is not actually
 193 sent until a complete round trip with the server has occurred which defeats the
 194 objective of early data.
 195
 196 In many operating systems the TCP_NODELAY socket option is available to disable
 197 Nagle's algorithm. If an application opts to disable Nagle's algorithm
 198 consideration should be given to turning it back on again after the handshake is
 199 complete if appropriate.
 200
 201 =head1 RETURN VALUES
 202
 203 SSL_write_early_data() returns 1 for success or 0 for failure. In the event of a
 204 failure call L<SSL_get_error(3)> to determine the correct course of action.
 205
 206 SSL_read_early_data() returns SSL_READ_EARLY_DATA_ERROR for failure,
 207 SSL_READ_EARLY_DATA_SUCCESS for success with more data to read and
 208 SSL_READ_EARLY_DATA_FINISH for success with no more to data be read. In the
 209 event of a failure call L<SSL_get_error(3)> to determine the correct course of
 210 action.
 211
 212 SSL_get_max_early_data(), SSL_CTX_get_max_early_data() and
 213 SSL_SESSION_get_max_early_data() return the maximum number of early data bytes
 214 that may be sent.
 215
 216 SSL_set_max_early_data(), SSL_CTX_set_max_early_data() and
 217 SSL_SESSION_set_max_early_data() return 1 for success or 0 for failure.
 218
 219 SSL_get_early_data_status() returns SSL_EARLY_DATA_ACCEPTED if early data was
 220 accepted by the server, SSL_EARLY_DATA_REJECTED if early data was rejected by
 221 the server, or SSL_EARLY_DATA_NOT_SENT if no early data was sent.
 222
 223 =head1 SEE ALSO
 224
 225 L<SSL_get_error(3)>,
 226 L<SSL_write_ex(3)>,
 227 L<SSL_read_ex(3)>,
 228 L<SSL_connect(3)>,
 229 L<SSL_accept(3)>,
 230 L<SSL_do_handshake(3)>,
 231 L<SSL_CTX_set_psk_use_session_callback(3)>,
 232 L<ssl(7)>
 233
 234 =head1 HISTORY
 235
 236 All of the functions described above were added in OpenSSL 1.1.1.
 237
 238 =head1 COPYRIGHT
 239
 240 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
 241
 242 Licensed under the OpenSSL license (the "License").  You may not use
 243 this file except in compliance with the License.  You can obtain a copy
 244 in the file LICENSE in the source distribution or at
 245 L<https://www.openssl.org/source/license.html>.
 246
 247 =cut