2 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
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
10 /*****************************************************************************
12 * The following definitions are PRIVATE to the state machine. They should *
13 * NOT be used outside of the state machine. *
15 *****************************************************************************/
17 /* Max message length definitions */
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
32 /* The maximum number of incoming KeyUpdate messages we will accept */
33 #define MAX_KEY_UPDATE_MESSAGES 32
35 /* Extension context codes */
36 /* This extension is only allowed in TLS */
37 #define EXT_TLS_ONLY 0x0001
38 /* This extension is only allowed in DTLS */
39 #define EXT_DTLS_ONLY 0x0002
40 /* Some extensions may be allowed in DTLS but we don't implement them for it */
41 #define EXT_TLS_IMPLEMENTATION_ONLY 0x0004
42 /* Most extensions are not defined for SSLv3 but EXT_TYPE_renegotiate is */
43 #define EXT_SSL3_ALLOWED 0x0008
44 /* Extension is only defined for TLS1.2 and above */
45 #define EXT_TLS1_2_AND_BELOW_ONLY 0x0010
46 /* Extension is only defined for TLS1.3 and above */
47 #define EXT_TLS1_3_ONLY 0x0020
48 #define EXT_CLIENT_HELLO 0x0040
49 /* Really means TLS1.2 or below */
50 #define EXT_TLS1_2_SERVER_HELLO 0x0080
51 #define EXT_TLS1_3_SERVER_HELLO 0x0100
52 #define EXT_TLS1_3_ENCRYPTED_EXTENSIONS 0x0200
53 #define EXT_TLS1_3_HELLO_RETRY_REQUEST 0x0400
54 #define EXT_TLS1_3_CERTIFICATE 0x0800
55 #define EXT_TLS1_3_NEW_SESSION_TICKET 0x1000
57 /* Dummy message type */
58 #define SSL3_MT_DUMMY -1
60 /* Message processing return codes */
62 /* Something bad happened */
64 /* We've finished reading - swap to writing */
65 MSG_PROCESS_FINISHED_READING,
67 * We've completed the main processing of this message but there is some
68 * post processing to be done.
70 MSG_PROCESS_CONTINUE_PROCESSING,
71 /* We've finished this message - read the next message */
72 MSG_PROCESS_CONTINUE_READING
75 /* Flush the write BIO */
76 int statem_flush(SSL *s);
78 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
80 int check_in_list(SSL *s, unsigned int group_id, const unsigned char *groups,
81 size_t num_groups, int checkallow);
82 int create_synthetic_message_hash(SSL *s);
83 int parse_ca_names(SSL *s, PACKET *pkt, int *al);
84 int construct_ca_names(SSL *s, WPACKET *pkt);
87 * TLS/DTLS client state machine functions
89 int ossl_statem_client_read_transition(SSL *s, int mt);
90 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
91 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
92 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
93 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
94 confunc_f *confunc, int *mt);
95 size_t ossl_statem_client_max_message_size(SSL *s);
96 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
97 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
100 * TLS/DTLS server state machine functions
102 int ossl_statem_server_read_transition(SSL *s, int mt);
103 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
104 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
105 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
106 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
107 confunc_f *confunc,int *mt);
108 size_t ossl_statem_server_max_message_size(SSL *s);
109 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
110 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
112 /* Functions for getting new message data */
113 __owur int tls_get_message_header(SSL *s, int *mt);
114 __owur int tls_get_message_body(SSL *s, size_t *len);
115 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
117 /* Message construction and processing functions */
118 __owur int tls_process_initial_server_flight(SSL *s, int *al);
119 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
120 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
121 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
122 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
124 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
125 __owur int tls_construct_key_update(SSL *s, WPACKET *pkt);
126 __owur MSG_PROCESS_RETURN tls_process_key_update(SSL *s, PACKET *pkt);
127 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
128 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
130 /* some client-only functions */
131 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
132 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
133 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
134 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
135 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
136 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
137 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
138 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
139 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
140 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
141 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
142 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
143 __owur int tls_client_key_exchange_post_work(SSL *s);
144 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
145 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
146 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
147 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
148 __owur int ssl3_check_cert_and_algorithm(SSL *s);
149 #ifndef OPENSSL_NO_NEXTPROTONEG
150 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
152 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
153 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
154 __owur int tls_construct_end_of_early_data(SSL *s, WPACKET *pkt);
156 /* some server-only functions */
157 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
158 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
159 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
160 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
161 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
162 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
163 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
164 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
165 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
166 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
167 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
168 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
169 #ifndef OPENSSL_NO_NEXTPROTONEG
170 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
172 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
173 MSG_PROCESS_RETURN tls_process_end_of_early_data(SSL *s, PACKET *pkt);
176 /* Extension processing */
178 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
179 RAW_EXTENSION **res, int *al, size_t *len);
180 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
181 RAW_EXTENSION *exts, X509 *x, size_t chainidx,
183 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
184 X509 *x, size_t chainidx, int *al);
185 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
186 X509 *x, size_t chainidx, int *al);
188 __owur int tls_psk_do_binder(SSL *s, const EVP_MD *md,
189 const unsigned char *msgstart,
190 size_t binderoffset, const unsigned char *binderin,
191 unsigned char *binderout,
192 SSL_SESSION *sess, int sign);
194 /* Server Extension processing */
195 int tls_parse_ctos_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
196 X509 *x, size_t chainidx, int *al);
197 int tls_parse_ctos_server_name(SSL *s, PACKET *pkt, unsigned int context,
198 X509 *x, size_t chainidx, int *al);
199 #ifndef OPENSSL_NO_SRP
200 int tls_parse_ctos_srp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
201 size_t chainidx, int *al);
203 int tls_parse_ctos_early_data(SSL *s, PACKET *pkt, unsigned int context,
204 X509 *x, size_t chainidx, int *al);
205 #ifndef OPENSSL_NO_EC
206 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
207 X509 *x, size_t chainidx, int *al);
208 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
209 X509 *x, size_t chainidx, int *al);
211 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
212 X509 *x, size_t chainidx, int *al);
213 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
214 size_t chainidx, int *al);
215 #ifndef OPENSSL_NO_OCSP
216 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
217 X509 *x, size_t chainidx, int *al);
219 #ifndef OPENSSL_NO_NEXTPROTONEG
220 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
221 size_t chainidx, int *al);
223 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
224 size_t chainidx, int *al);
225 #ifndef OPENSSL_NO_SRTP
226 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
227 size_t chainidx, int *al);
229 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
230 size_t chainidx, int *al);
231 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
232 size_t chainidx, int *al);
233 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
234 size_t chainidx, int *al);
235 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
236 X509 *x, size_t chainidx, int *al);
237 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
238 size_t chainidx, int *al);
240 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
241 X509 *x, size_t chainidx, int *al);
242 int tls_construct_stoc_server_name(SSL *s, WPACKET *pkt, unsigned int context,
243 X509 *x, size_t chainidx, int *al);
244 int tls_construct_stoc_early_data(SSL *s, WPACKET *pkt, unsigned int context,
245 X509 *x, size_t chainidx, int *al);
246 #ifndef OPENSSL_NO_EC
247 int tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
248 X509 *x, size_t chainidx, int *al);
250 int tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
251 unsigned int context, X509 *x,
252 size_t chainidx, int *al);
253 #ifndef OPENSSL_NO_OCSP
254 int tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
255 unsigned int context, X509 *x,
256 size_t chainidx, int *al);
258 #ifndef OPENSSL_NO_NEXTPROTONEG
259 int tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
260 unsigned int context, X509 *x,
261 size_t chainidx, int *al);
263 int tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
264 size_t chainidx, int *al);
265 #ifndef OPENSSL_NO_SRTP
266 int tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
267 X509 *x, size_t chainidx, int *al);
269 int tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
270 size_t chainidx, int *al);
271 int tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
272 size_t chainidx, int *al);
273 int tls_construct_stoc_key_share(SSL *s, WPACKET *pkt, unsigned int context,
274 X509 *x, size_t chainidx, int *al);
276 * Not in public headers as this is not an official extension. Only used when
277 * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
279 #define TLSEXT_TYPE_cryptopro_bug 0xfde8
280 int tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt, unsigned int context,
281 X509 *x, size_t chainidx, int *al);
282 int tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
283 size_t chainidx, int *al);
285 /* Client Extension processing */
286 int tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
287 X509 *x, size_t chainidx, int *al);
288 int tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, unsigned int context,
289 X509 *x, size_t chainidx, int *al);
290 #ifndef OPENSSL_NO_SRP
291 int tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
292 size_t chainidx, int *al);
294 #ifndef OPENSSL_NO_EC
295 int tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
296 X509 *x, size_t chainidx, int *al);
297 int tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
298 unsigned int context, X509 *x,
299 size_t chainidx, int *al);
301 int tls_construct_ctos_early_data(SSL *s, WPACKET *pkt, unsigned int context,
302 X509 *x, size_t chainidx, int *al);
303 int tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
304 unsigned int context, X509 *x,
305 size_t chainidx, int *al);
306 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, unsigned int context,
307 X509 *x, size_t chainidx, int *al);
308 #ifndef OPENSSL_NO_OCSP
309 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
310 unsigned int context, X509 *x,
311 size_t chainidx, int *al);
313 #ifndef OPENSSL_NO_NEXTPROTONEG
314 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
315 size_t chainidx, int *al);
317 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
318 size_t chainidx, int *al);
319 #ifndef OPENSSL_NO_SRTP
320 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
321 X509 *x, size_t chainidx, int *al);
323 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
324 size_t chainidx, int *al);
325 #ifndef OPENSSL_NO_CT
326 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
327 size_t chainidx, int *al);
329 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
330 size_t chainidx, int *al);
331 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
332 unsigned int context, X509 *x,
333 size_t chainidx, int *al);
334 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, unsigned int context,
335 X509 *x, size_t chainidx, int *al);
336 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, unsigned int context,
337 X509 *x, size_t chainidx, int *al);
338 int tls_construct_ctos_cookie(SSL *s, WPACKET *pkt, unsigned int context,
339 X509 *x, size_t chainidx, int *al);
340 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, unsigned int context,
341 X509 *x, size_t chainidx, int *al);
342 int tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
343 size_t chainidx, int *al);
344 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
345 X509 *x, size_t chainidx, int *al);
346 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
347 X509 *x, size_t chainidx, int *al);
348 int tls_parse_stoc_early_data(SSL *s, PACKET *pkt, unsigned int context,
349 X509 *x, size_t chainidx, int *al);
350 #ifndef OPENSSL_NO_EC
351 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
352 X509 *x, size_t chainidx, int *al);
354 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
355 X509 *x, size_t chainidx, int *al);
356 #ifndef OPENSSL_NO_OCSP
357 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
358 X509 *x, size_t chainidx, int *al);
360 #ifndef OPENSSL_NO_CT
361 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
362 size_t chainidx, int *al);
364 #ifndef OPENSSL_NO_NEXTPROTONEG
365 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
366 size_t chainidx, int *al);
368 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
369 size_t chainidx, int *al);
370 #ifndef OPENSSL_NO_SRTP
371 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
372 size_t chainidx, int *al);
374 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
375 size_t chainidx, int *al);
376 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
377 size_t chainidx, int *al);
378 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
379 size_t chainidx, int *al);
380 int tls_parse_stoc_cookie(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
381 size_t chainidx, int *al);
382 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
383 size_t chainidx, int *al);