faa62d124b655360018cd90a5403552683e83115
[openssl.git] / doc / man3 / SSL_read_early.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_write_early_data,
11 SSL_read_early_data,
12 SSL_get_early_data_status
13 - functions for sending and receiving early data
14
15 =head1 SYNOPSIS
16
17  #include <openssl/ssl.h>
18
19  int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data);
20  uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx);
21  int SSL_set_max_early_data(SSL *s, uint32_t max_early_data);
22  uint32_t SSL_get_max_early_data(const SSL_CTX *s);
23  uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s);
24
25  int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written);
26
27  int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes);
28
29  int SSL_get_early_data_status(const SSL *s);
30
31 =head1 DESCRIPTION
32
33 These functions are used to send and recieve early data. Early data can be sent
34 by the client immediately after its initial ClientHello without having to wait
35 for the server to complete the handshake. Early data can only be sent if a
36 session has previously been established with the server, and the server is known
37 to support it. Additionally these functions can be used to send data from the
38 server to the client when the client has not yet completed the authentication
39 stage of the handshake.
40
41 Early data has weaker security properties than other data sent over an SSL/TLS
42 connection. In particular the data is not forward secret and the server has no
43 guarantees that the same early data was not replayed across multiple
44 connections. For this reason extreme care should be exercised when using early
45 data.
46
47 When a server receives early data it may opt to immediately respond by sending
48 application data back to the client. Data sent by the server at this stage is
49 done before the full handshake has been completed. Specifically the client's
50 authentication messages have not yet been received, i.e. the client is
51 unauthenticated at this point.
52
53 A server or client can determine whether the full handshake has been completed
54 or not by calling L<SSL_is_init_finished(3)>.
55
56 On the client side the function SSL_SESSION_get_max_early_data() can be used to
57 determine whether a session established with a server can be used to send early
58 data. If the session cannot be used then this function will return 0. Otherwise
59 it will return the maximum number of early data bytes that can be sent.
60
61 A client uses the function SSL_write_early_data() to send early data. This
62 function works in the same way as the L<SSL_write_ex(3)> function, but with a
63 few differences. Refer to the L<SSL_write_ex(3)> documentation for
64 information on how to write bytes to the underlying connection, and how to
65 handle any errors that may arise. This page will detail the differences between
66 SSL_write_early_data() and L<SSL_write_ex(3)>.
67
68 When called by a client, SSL_write_early_data() must be the first IO function
69 called on a new connection, i.e. it must occur before any calls to
70 L<SSL_write_ex(3)>, L<SSL_read_ex(3)>, L<SSL_connect(3)>, L<SSL_do_handshake(3)>
71 or other similar functions. It may be called multiple times to stream data to
72 the server, but the total number of bytes written must not exceed the value
73 returned from SSL_SESSION_get_max_early_data(). Once the initial
74 SSL_write_early_data() call has completed successfully the client may interleave
75 calls to L<SSL_read_ex(3)> and L<SSL_read(3)> with calls to
76 SSL_write_early_data() as required.
77
78 If SSL_write_early_data() fails you should call L<SSL_get_error(3)> to determine
79 the correct course of action, as for L<SSL_write_ex(3)>.
80
81 When the client no longer wishes to send any more early data then it should
82 complete the handshake by calling a function such as L<SSL_connect(3)> or
83 L<SSL_do_handshake(3)>. Alternatively you can call a standard write function
84 such as L<SSL_write_ex(3)>, which will transparently complete the connection and
85 write the requested data.
86
87 A server may choose to ignore early data that has been sent to it. Once the
88 connection has been completed you can determine whether the server accepted or
89 rejected the early data by calling SSL_get_early_data_status(). This will return
90 SSL_EARLY_DATA_ACCEPTED if the data was accepted, SSL_EARLY_DATA_REJECTED if it
91 was rejected or SSL_EARLY_DATA_NOT_SENT if no early data was sent. This function
92 may be called by either the client or the server.
93
94 A server uses the SSL_read_early_data() function to receive early data on a
95 connection. As for SSL_write_early_data() this must be the first IO function
96 called on a connection, i.e. it must occur before any calls to
97 L<SSL_write_ex(3)>, L<SSL_read_ex(3)>, L<SSL_accept(3)>, L<SSL_do_handshake(3)>,
98 or other similar functions.
99
100 SSL_read_early_data() works in the same way as L<SSL_read_ex(3)> except for the
101 differences noted here. Refer to the L<SSL_read_ex(3)> documentation for full
102 details.
103
104 SSL_read_early_data() may return 3 possible values:
105
106 =over 4
107
108 =item SSL_READ_EARLY_DATA_ERROR
109
110 This indicates an IO or some other error occured. This should be treated in the
111 same way as a 0 return value from L<SSL_read_ex(3)>.
112
113 =item SSL_READ_EARLY_DATA_SUCCESS
114
115 This indicates that early data was successfully read. This should be treated in
116 the same way as a 1 return value from L<SSL_read_ex(3)>. You should continue to
117 call SSL_read_early_data() to read more data.
118
119 =item SSL_READ_EARLY_DATA_FINISH
120
121 This indicates that no more early data can be read. It may be returned on the
122 first call to SSL_read_early_data() if the client has not sent any early data,
123 or if the early data was rejected.
124
125 =back
126
127 Once the initial SSL_read_early_data() call has completed successfully (i.e. it
128 has returned SSL_READ_EARLY_DATA_SUCCESS or SSL_READ_EARLY_DATA_FINISH) then the
129 server may choose to write data immediately to the unauthenticated client using
130 SSL_write_early_data(). If SSL_read_early_data() returned
131 SSL_READ_EARLY_DATA_FINISH then in some situations (e.g. if the client only
132 support TLSv1.2) the handshake may have already been completed and calls
133 to SSL_write_early_data() are not allowed. Call L<SSL_is_init_finished(3)> to
134 determine whether the handshake has completed or not. If the handshake is still
135 in progress then the server may interleave calls to SSL_write_early_data() with
136 calls to SSL_read_early_data() as required.
137
138 Servers must not call L<SSL_read_ex(3)>, L<SSL_read(3)>, L<SSL_write_ex(3)> or
139 L<SSL_write(3)>  until SSL_read_early_data() has returned with
140 SSL_READ_EARLY_DATA_FINISH. Once it has done so the connection to the client
141 still needs to be completed. Complete the connection by calling a function such
142 as L<SSL_accept(3)> or L<SSL_do_handshake(3)>. Alternatively you can call a
143 standard read function such as L<SSL_read_ex(3)>, which will transparently
144 complete the connection and read the requested data. Note that it is an error to
145 attempt to complete the connection before SSL_read_early_data() has returned
146 SSL_READ_EARLY_DATA_FINISH.
147
148 Only servers may call SSL_read_early_data().
149
150 Calls to SSL_read_early_data() may, in certain circumstances, complete the
151 connection immediately without further need to call a function such as
152 L<SSL_accept(3)>. Applications can test for this by calling
153 L<SSL_is_init_finished(3)>. Alternatively, applications may choose to call
154 L<SSL_accept(3)> anway. Such a call will successfully return immediately with no
155 further action taken.
156
157 When a session is created between a server and a client the server will specify
158 the maximum amount of any early data that it will accept on any future
159 connection attempt. By default this is approximately 16k. A server may override
160 this default value by calling SSL_CTX_set_max_early_data() or
161 SSL_set_max_early_data() to set it for the whole SSL_CTX or an individual SSL
162 object respectively. Similarly the SSL_CTX_get_max_early_data() and
163 SSL_get_max_early_data() functions can be used to obtain the current maximum
164 early data settings for the SSL_CTX and SSL objects respectively.
165
166 In the event that the current maximum early data setting for the server is
167 different to that originally specified in a session that a client is resuming
168 with then the lower of the two values will apply.
169
170 =head1 RETURN VALUES
171
172 SSL_write_early_data() returns 1 for success or 0 for failure. In the event of a
173 failure call L<SSL_get_error(3)> to determine the correct course of action.
174
175 SSL_read_early_data() returns SSL_READ_EARLY_DATA_ERROR for failure,
176 SSL_READ_EARLY_DATA_SUCCESS for success with more data to read and
177 SSL_READ_EARLY_DATA_FINISH for no more to data be read. In the event of a
178 failure call L<SSL_get_error(3)> to determine the correct course of action.
179
180 SSL_get_max_early_data(), SSL_CTX_get_max_early_data() and
181 SSL_SESSION_get_max_early_data() return the maximum number of early data bytes
182 that may be sent.
183
184 SSL_set_max_early_data() and SSL_CTX_set_max_early_data() return 1 for success
185 or 0 for failure.
186
187 SSL_get_early_data_status() returns SSL_EARLY_DATA_ACCEPTED if early data was
188 accepted by the server, SSL_EARLY_DATA_REJECTED if early data was rejected by
189 the server, or SSL_EARLY_DATA_NOT_SENT if no early data was sent.
190
191 =head1 SEE ALSO
192
193 L<SSL_get_error(3)>,
194 L<SSL_write_ex(3)>,
195 L<SSL_read_ex(3)>,
196 L<SSL_connect(3)>,
197 L<SSL_accept(3)>,
198 L<SSL_do_handshake(3)>,
199 L<ssl(7)>
200
201 =head1 HISTORY
202
203 All of the functions described above were added in OpenSSL 1.1.1.
204
205 =head1 COPYRIGHT
206
207 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
208
209 Licensed under the OpenSSL license (the "License").  You may not use
210 this file except in compliance with the License.  You can obtain a copy
211 in the file LICENSE in the source distribution or at
212 L<https://www.openssl.org/source/license.html>.
213
214 =cut