]> git.ipfire.org Git - thirdparty/openssl.git/blob - ssl/statem/statem_locl.h
Add TLSv1.3 server side external PSK support
[thirdparty/openssl.git] / ssl / statem / statem_locl.h
1 /*
2 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10 /*****************************************************************************
11 * *
12 * The following definitions are PRIVATE to the state machine. They should *
13 * NOT be used outside of the state machine. *
14 * *
15 *****************************************************************************/
16
17 /* Max message length definitions */
18
19 /* The spec allows for a longer length than this, but we limit it */
20 #define HELLO_VERIFY_REQUEST_MAX_LENGTH 258
21 #define END_OF_EARLY_DATA_MAX_LENGTH 0
22 #define SERVER_HELLO_MAX_LENGTH 20000
23 #define HELLO_RETRY_REQUEST_MAX_LENGTH 20000
24 #define ENCRYPTED_EXTENSIONS_MAX_LENGTH 20000
25 #define SERVER_KEY_EXCH_MAX_LENGTH 102400
26 #define SERVER_HELLO_DONE_MAX_LENGTH 0
27 #define KEY_UPDATE_MAX_LENGTH 1
28 #define CCS_MAX_LENGTH 1
29 /* Max should actually be 36 but we are generous */
30 #define FINISHED_MAX_LENGTH 64
31
32 /* The maximum number of incoming KeyUpdate messages we will accept */
33 #define MAX_KEY_UPDATE_MESSAGES 32
34
35 /* Dummy message type */
36 #define SSL3_MT_DUMMY -1
37
38 /* Message processing return codes */
39 typedef enum {
40 /* Something bad happened */
41 MSG_PROCESS_ERROR,
42 /* We've finished reading - swap to writing */
43 MSG_PROCESS_FINISHED_READING,
44 /*
45 * We've completed the main processing of this message but there is some
46 * post processing to be done.
47 */
48 MSG_PROCESS_CONTINUE_PROCESSING,
49 /* We've finished this message - read the next message */
50 MSG_PROCESS_CONTINUE_READING
51 } MSG_PROCESS_RETURN;
52
53 /* Flush the write BIO */
54 int statem_flush(SSL *s);
55
56 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
57
58 #define GET_GROUP_ID(group, idx) \
59 (unsigned int)(((group)[(idx) * 2] << 8) | (group)[((idx) * 2) + 1])
60
61 int check_in_list(SSL *s, unsigned int group_id, const unsigned char *groups,
62 size_t num_groups, int checkallow);
63 int create_synthetic_message_hash(SSL *s);
64 int parse_ca_names(SSL *s, PACKET *pkt, int *al);
65 int construct_ca_names(SSL *s, WPACKET *pkt);
66 size_t construct_key_exchange_tbs(const SSL *s, unsigned char **ptbs,
67 const void *param, size_t paramlen);
68
69 /*
70 * TLS/DTLS client state machine functions
71 */
72 int ossl_statem_client_read_transition(SSL *s, int mt);
73 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
74 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
75 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
76 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
77 confunc_f *confunc, int *mt);
78 size_t ossl_statem_client_max_message_size(SSL *s);
79 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
80 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
81
82 /*
83 * TLS/DTLS server state machine functions
84 */
85 int ossl_statem_server_read_transition(SSL *s, int mt);
86 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
87 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
88 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
89 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
90 confunc_f *confunc,int *mt);
91 size_t ossl_statem_server_max_message_size(SSL *s);
92 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
93 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
94
95 /* Functions for getting new message data */
96 __owur int tls_get_message_header(SSL *s, int *mt);
97 __owur int tls_get_message_body(SSL *s, size_t *len);
98 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
99
100 /* Message construction and processing functions */
101 __owur int tls_process_initial_server_flight(SSL *s, int *al);
102 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
103 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
104 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
105 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
106
107 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
108 __owur int tls_construct_key_update(SSL *s, WPACKET *pkt);
109 __owur MSG_PROCESS_RETURN tls_process_key_update(SSL *s, PACKET *pkt);
110 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
111 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
112
113 /* some client-only functions */
114 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
115 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
116 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
117 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
118 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
119 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
120 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
121 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
122 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
123 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
124 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
125 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
126 __owur int tls_client_key_exchange_post_work(SSL *s);
127 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
128 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
129 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
130 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
131 __owur int ssl3_check_cert_and_algorithm(SSL *s);
132 #ifndef OPENSSL_NO_NEXTPROTONEG
133 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
134 #endif
135 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
136 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
137 __owur int tls_construct_end_of_early_data(SSL *s, WPACKET *pkt);
138
139 /* some server-only functions */
140 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
141 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
142 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
143 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
144 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
145 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
146 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
147 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
148 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
149 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
150 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
151 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
152 #ifndef OPENSSL_NO_NEXTPROTONEG
153 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
154 #endif
155 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
156 MSG_PROCESS_RETURN tls_process_end_of_early_data(SSL *s, PACKET *pkt);
157
158
159 /* Extension processing */
160
161 typedef enum ext_return_en {
162 EXT_RETURN_FAIL,
163 EXT_RETURN_SENT,
164 EXT_RETURN_NOT_SENT
165 } EXT_RETURN;
166
167 __owur int extension_is_relevant(SSL *s, unsigned int extctx,
168 unsigned int thisctx);
169 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
170 RAW_EXTENSION **res, int *al, size_t *len,
171 int init);
172 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
173 RAW_EXTENSION *exts, X509 *x, size_t chainidx,
174 int *al);
175 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
176 X509 *x, size_t chainidx, int *al, int fin);
177 __owur int should_add_extension(SSL *s, unsigned int extctx,
178 unsigned int thisctx, int max_version);
179 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
180 X509 *x, size_t chainidx, int *al);
181
182 __owur int tls_psk_do_binder(SSL *s, const EVP_MD *md,
183 const unsigned char *msgstart,
184 size_t binderoffset, const unsigned char *binderin,
185 unsigned char *binderout,
186 SSL_SESSION *sess, int sign, int external);
187
188 /* Server Extension processing */
189 int tls_parse_ctos_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
190 X509 *x, size_t chainidx, int *al);
191 int tls_parse_ctos_server_name(SSL *s, PACKET *pkt, unsigned int context,
192 X509 *x, size_t chainidx, int *al);
193 #ifndef OPENSSL_NO_SRP
194 int tls_parse_ctos_srp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
195 size_t chainidx, int *al);
196 #endif
197 int tls_parse_ctos_early_data(SSL *s, PACKET *pkt, unsigned int context,
198 X509 *x, size_t chainidx, int *al);
199 #ifndef OPENSSL_NO_EC
200 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
201 X509 *x, size_t chainidx, int *al);
202 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
203 X509 *x, size_t chainidx, int *al);
204 #endif
205 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
206 X509 *x, size_t chainidx, int *al);
207 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
208 size_t chainidx, int *al);
209 #ifndef OPENSSL_NO_OCSP
210 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
211 X509 *x, size_t chainidx, int *al);
212 #endif
213 #ifndef OPENSSL_NO_NEXTPROTONEG
214 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
215 size_t chainidx, int *al);
216 #endif
217 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
218 size_t chainidx, int *al);
219 #ifndef OPENSSL_NO_SRTP
220 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
221 size_t chainidx, int *al);
222 #endif
223 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
224 size_t chainidx, int *al);
225 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
226 size_t chainidx, int *al);
227 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
228 size_t chainidx, int *al);
229 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
230 X509 *x, size_t chainidx, int *al);
231 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
232 size_t chainidx, int *al);
233
234 EXT_RETURN tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt,
235 unsigned int context, X509 *x,
236 size_t chainidx, int *al);
237 EXT_RETURN tls_construct_stoc_server_name(SSL *s, WPACKET *pkt,
238 unsigned int context, X509 *x,
239 size_t chainidx, int *al);
240 EXT_RETURN tls_construct_stoc_early_data(SSL *s, WPACKET *pkt,
241 unsigned int context, X509 *x,
242 size_t chainidx, int *al);
243 #ifndef OPENSSL_NO_EC
244 EXT_RETURN tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt,
245 unsigned int context, X509 *x,
246 size_t chainidx, int *al);
247 #endif
248 EXT_RETURN tls_construct_stoc_supported_groups(SSL *s, WPACKET *pkt,
249 unsigned int context, X509 *x,
250 size_t chainidx, int *al);
251 EXT_RETURN tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
252 unsigned int context, X509 *x,
253 size_t chainidx, int *al);
254 #ifndef OPENSSL_NO_OCSP
255 EXT_RETURN tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
256 unsigned int context, X509 *x,
257 size_t chainidx, int *al);
258 #endif
259 #ifndef OPENSSL_NO_NEXTPROTONEG
260 EXT_RETURN tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
261 unsigned int context, X509 *x,
262 size_t chainidx, int *al);
263 #endif
264 EXT_RETURN tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context,
265 X509 *x, size_t chainidx, int *al);
266 #ifndef OPENSSL_NO_SRTP
267 EXT_RETURN tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
268 X509 *x, size_t chainidx, int *al);
269 #endif
270 EXT_RETURN tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context,
271 X509 *x, size_t chainidx, int *al);
272 EXT_RETURN tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context,
273 X509 *x, size_t chainidx, int *al);
274 EXT_RETURN tls_construct_stoc_key_share(SSL *s, WPACKET *pkt,
275 unsigned int context, X509 *x,
276 size_t chainidx, int *al);
277 /*
278 * Not in public headers as this is not an official extension. Only used when
279 * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
280 */
281 #define TLSEXT_TYPE_cryptopro_bug 0xfde8
282 EXT_RETURN tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt,
283 unsigned int context, X509 *x,
284 size_t chainidx, int *al);
285 EXT_RETURN tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context,
286 X509 *x, size_t chainidx, int *al);
287
288 /* Client Extension processing */
289 EXT_RETURN tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
290 X509 *x, size_t chainidx, int *al);
291 EXT_RETURN tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, unsigned int context,
292 X509 *x, size_t chainidx, int *al);
293 #ifndef OPENSSL_NO_SRP
294 EXT_RETURN tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
295 size_t chainidx, int *al);
296 #endif
297 #ifndef OPENSSL_NO_EC
298 EXT_RETURN tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt,
299 unsigned int context, X509 *x,
300 size_t chainidx, int *al);
301 EXT_RETURN tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
302 unsigned int context, X509 *x,
303 size_t chainidx, int *al);
304 #endif
305 EXT_RETURN tls_construct_ctos_early_data(SSL *s, WPACKET *pkt,
306 unsigned int context, X509 *x,
307 size_t chainidx, int *al);
308 EXT_RETURN tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
309 unsigned int context, X509 *x,
310 size_t chainidx, int *al);
311 EXT_RETURN tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt,
312 unsigned int context, X509 *x,
313 size_t chainidx, int *al);
314 #ifndef OPENSSL_NO_OCSP
315 EXT_RETURN tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
316 unsigned int context, X509 *x,
317 size_t chainidx, int *al);
318 #endif
319 #ifndef OPENSSL_NO_NEXTPROTONEG
320 EXT_RETURN tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context,
321 X509 *x, size_t chainidx, int *al);
322 #endif
323 EXT_RETURN tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context,
324 X509 *x, size_t chainidx, int *al);
325 #ifndef OPENSSL_NO_SRTP
326 EXT_RETURN tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
327 X509 *x, size_t chainidx, int *al);
328 #endif
329 EXT_RETURN tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context,
330 X509 *x, size_t chainidx, int *al);
331 #ifndef OPENSSL_NO_CT
332 EXT_RETURN tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context,
333 X509 *x, size_t chainidx, int *al);
334 #endif
335 EXT_RETURN tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context,
336 X509 *x, size_t chainidx, int *al);
337 EXT_RETURN tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
338 unsigned int context, X509 *x,
339 size_t chainidx, int *al);
340 EXT_RETURN tls_construct_ctos_key_share(SSL *s, WPACKET *pkt,
341 unsigned int context, X509 *x,
342 size_t chainidx, int *al);
343 EXT_RETURN tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt,
344 unsigned int context, X509 *x,
345 size_t chainidx, int *al);
346 EXT_RETURN tls_construct_ctos_cookie(SSL *s, WPACKET *pkt, unsigned int context,
347 X509 *x, size_t chainidx, int *al);
348 EXT_RETURN tls_construct_ctos_padding(SSL *s, WPACKET *pkt,
349 unsigned int context, X509 *x,
350 size_t chainidx, int *al);
351 EXT_RETURN tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context,
352 X509 *x, size_t chainidx, int *al);
353 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
354 X509 *x, size_t chainidx, int *al);
355 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
356 X509 *x, size_t chainidx, int *al);
357 int tls_parse_stoc_early_data(SSL *s, PACKET *pkt, unsigned int context,
358 X509 *x, size_t chainidx, int *al);
359 #ifndef OPENSSL_NO_EC
360 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
361 X509 *x, size_t chainidx, int *al);
362 #endif
363 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
364 X509 *x, size_t chainidx, int *al);
365 #ifndef OPENSSL_NO_OCSP
366 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
367 X509 *x, size_t chainidx, int *al);
368 #endif
369 #ifndef OPENSSL_NO_CT
370 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
371 size_t chainidx, int *al);
372 #endif
373 #ifndef OPENSSL_NO_NEXTPROTONEG
374 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
375 size_t chainidx, int *al);
376 #endif
377 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
378 size_t chainidx, int *al);
379 #ifndef OPENSSL_NO_SRTP
380 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
381 size_t chainidx, int *al);
382 #endif
383 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
384 size_t chainidx, int *al);
385 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
386 size_t chainidx, int *al);
387 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
388 size_t chainidx, int *al);
389 int tls_parse_stoc_cookie(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
390 size_t chainidx, int *al);
391 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
392 size_t chainidx, int *al);