Add documentation for the early data functions
[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,
11 SSL_write_early_finish,
12 SSL_read_early,
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_CTX *s);
24  uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s);
25
26  int SSL_write_early(SSL *s, const void *buf, size_t num, size_t *written);
27  int SSL_write_early_finish(SSL *s);
28
29  int SSL_read_early(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 recieve early data. Early data can be sent
36 by the client immediately after its initial ClientHello without having to wait
37 for the server to complete the handshake. Early data can only be sent if a
38 session has previously been established with the server, and the server is known
39 to support it.
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 On the client side the function SSL_SESSION_get_max_early_data() can be used to
48 determine whether a session established with a server can be used to send early
49 data. If the session cannot be used then this function will return 0. Otherwise
50 it will return the maximum number of early data bytes that can be sent.
51
52 A client uses the function SSL_write_early() to send early data. This function
53 works in the same way as the L<SSL_write_ex(3)> function, but with a few
54 differences. Refer to the L<SSL_write_ex(3)> documentation for
55 information on how to write bytes to the underlying connection, and how to
56 handle any errors that may arise. This page will detail the differences between
57 SSL_write_early() and L<SSL_write_ex(3)>.
58
59 SSL_write_early() must be the first IO function called on a new connection, i.e.
60 it must occur before any calls to L<SSL_write_ex(3)>, L<SSL_read_ex(3)>,
61 L<SSL_connect(3)>, L<SSL_do_handshake(3)> or other similar functions. It may be
62 called multiple times to stream data to the server, but the total number of
63 bytes written must not exceed the value returned from
64 SSL_SESSION_get_max_early_data().
65
66 Once finished writing early data you must then call SSL_write_early_finish().
67 This sends a message to the server signalling the end of early data.
68
69 If either SSL_write_early() or SSL_write_early_finish() fail you should call
70 L<SSL_get_error(3)> to determine the correct course of action, as for
71 L<SSL_write_ex(3)>.
72
73 Following an SSL_write_early_finish() call the connection to the server still
74 needs to be completed. Complete the connection by calling a function such as
75 L<SSL_connect(3)> or L<SSL_do_handshake(3)>. Alternatively you can call a
76 "normal" read/write function such as L<SSL_read_ex(3)> or L<SSL_write_ex(3)>,
77 which will transparently complete the connection and read/write the requested
78 data.
79
80 Only clients may call SSL_write_early() or SSL_write_early_finish().
81
82 A server may choose to ignore early data that has been sent to it. Once the
83 connection has been completed you can determine whether the server accepted or
84 rejected the early data by calling SSL_get_early_data_status(). This will return
85 SSL_EARLY_DATA_ACCEPTED if the data was accepted, SSL_EARLY_DATA_REJECTED if it
86 was rejected or SSL_EARLY_DATA_NOT_SENT if no early data was sent. This function
87 may be called by either the client or the server.
88
89 A server uses the SSL_read_early() function to receive early data on a
90 connection. As for SSL_write_early() this must be the first IO function called
91 on a connection, i.e. it must occur before any calls to L<SSL_write_ex(3)>,
92 L<SSL_read_ex(3)>, L<SSL_accept(3)>, L<SSL_do_handshake(3)>, or other similar
93 functions.
94
95 SSL_read_early() works in the same way as L<SSL_read_ex(3)> except for the
96 differences noted here. Refer to the L<SSL_read_ex(3)> documentation for full
97 details.
98
99 SSL_read_early() may return 3 possible values:
100
101 =over 4
102
103 =item SSL_READ_EARLY_ERROR
104
105 This indicates an IO or some other error occured. This should be treated in the
106 same way as a 0 return value from L<SSL_read_ex(3)>.
107
108 =item SSL_READ_EARLY_SUCCESS
109
110 This indicates that early data was successfully read. This should be treated in
111 the same way as a 1 return value from L<SSL_read_ex(3)>. You should continue to
112 call SSL_read_early() to read more data.
113
114 =item SSL_READ_EARLY_FINISH
115
116 This indicates that no more early data can be read. It may be returned on the
117 first call to SSL_read_early() if the client has not sent any early data, or
118 if the early data was rejected.
119
120 =back
121
122 Once SSL_read_early() returns SSL_READ_EARLY_FINISH the connection to the client
123 still needs to be completed. Complete the connection by calling a function such
124 as L<SSL_accept(3)> or L<SSL_do_handshake(3)>. Alternatively you can call a
125 "normal" read/write function such as L<SSL_read_ex(3)> or L<SSL_write_ex(3)>,
126 which will transparently complete the connection and read/write the requested
127 data. Note that it is an error to attempt to complete the connection before
128 SSL_read_early() has returned SSL_READ_EARLY_FINISH.
129
130 Only servers may call SSL_read_early().
131
132 When a session is created between a server and a client the server will specify
133 the maximum amount of any early data that it will accept on any future
134 connection attempt. By default this is approximately 16k. A server may override
135 this default value by calling SSL_CTX_set_max_early_data() or
136 SSL_set_max_early_data() to set it for the whole SSL_CTX or an individual SSL
137 object respectively. Similarly the SSL_CTX_get_max_early_data() and
138 SSL_get_max_early_data() functions can be used to obtain the current maximum
139 early data settings for the SSL_CTX and SSL objects respectively.
140
141 In the event that the current maximum early data setting for the server is
142 different to that originally specified in a session that a client is resuming
143 with then the lower of the two values will apply.
144
145 =head1 RETURN VALUES
146
147 SSL_write_early() and SSL_write_early_finish() return 1 for success or 0 for
148 failure. In the event of a failure call L<SSL_get_error(3)> to determine the
149 correct course of action.
150
151 SSL_read_early() returns SSL_READ_EARLY_ERROR for failure,
152 SSL_READ_EARLY_SUCCESS for success with more data to read and
153 SSL_READ_EARLY_FINISH for no more to data be read. In the event of a failure
154 call L<SSL_get_error(3)> to determine the correct course of action.
155
156 SSL_get_max_early_data(), SSL_CTX_get_max_early_data() and
157 SSL_SESSION_get_max_early_data() return the maximum number of early data bytes
158 that may be sent.
159
160 SSL_set_max_early_data() and SSL_CTX_set_max_early_data() return 1 for success
161 or 0 for failure.
162
163 SSL_get_early_data_status() returns SSL_EARLY_DATA_ACCEPTED if early data was
164 accepted by the server, SSL_EARLY_DATA_REJECTED if early data was rejected by
165 the server, or SSL_EARLY_DATA_NOT_SENT if no early data was sent.
166
167 =head1 SEE ALSO
168
169 L<SSL_get_error(3)>,
170 L<SSL_write_ex(3)>,
171 L<SSL_read_ex(3)>,
172 L<SSL_connect(3)>,
173 L<SSL_accept(3)>,
174 L<SSL_do_handshake(3)>,
175 L<ssl(7)>
176
177 =head1 HISTORY
178
179 All of the functions described above were added in OpenSSL 1.1.1.
180
181 =head1 COPYRIGHT
182
183 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
184
185 Licensed under the OpenSSL license (the "License").  You may not use
186 this file except in compliance with the License.  You can obtain a copy
187 in the file LICENSE in the source distribution or at
188 L<https://www.openssl.org/source/license.html>.
189
190 =cut