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 SERVER_HELLO_MAX_LENGTH 20000
22 #define HELLO_RETRY_REQUEST_MAX_LENGTH 20000
23 #define ENCRYPTED_EXTENSIONS_MAX_LENGTH 20000
24 #define SERVER_KEY_EXCH_MAX_LENGTH 102400
25 #define SERVER_HELLO_DONE_MAX_LENGTH 0
26 #define KEY_UPDATE_MAX_LENGTH 1
27 #define CCS_MAX_LENGTH 1
28 /* Max should actually be 36 but we are generous */
29 #define FINISHED_MAX_LENGTH 64
31 /* The maximum number of incoming KeyUpdate messages we will accept */
32 #define MAX_KEY_UPDATE_MESSAGES 32
34 /* Extension context codes */
35 /* This extension is only allowed in TLS */
36 #define EXT_TLS_ONLY 0x0001
37 /* This extension is only allowed in DTLS */
38 #define EXT_DTLS_ONLY 0x0002
39 /* Some extensions may be allowed in DTLS but we don't implement them for it */
40 #define EXT_TLS_IMPLEMENTATION_ONLY 0x0004
41 /* Most extensions are not defined for SSLv3 but EXT_TYPE_renegotiate is */
42 #define EXT_SSL3_ALLOWED 0x0008
43 /* Extension is only defined for TLS1.2 and above */
44 #define EXT_TLS1_2_AND_BELOW_ONLY 0x0010
45 /* Extension is only defined for TLS1.3 and above */
46 #define EXT_TLS1_3_ONLY 0x0020
47 #define EXT_CLIENT_HELLO 0x0040
48 /* Really means TLS1.2 or below */
49 #define EXT_TLS1_2_SERVER_HELLO 0x0080
50 #define EXT_TLS1_3_SERVER_HELLO 0x0100
51 #define EXT_TLS1_3_ENCRYPTED_EXTENSIONS 0x0200
52 #define EXT_TLS1_3_HELLO_RETRY_REQUEST 0x0400
53 #define EXT_TLS1_3_CERTIFICATE 0x0800
54 #define EXT_TLS1_3_NEW_SESSION_TICKET 0x1000
56 /* Message processing return codes */
58 /* Something bad happened */
60 /* We've finished reading - swap to writing */
61 MSG_PROCESS_FINISHED_READING,
63 * We've completed the main processing of this message but there is some
64 * post processing to be done.
66 MSG_PROCESS_CONTINUE_PROCESSING,
67 /* We've finished this message - read the next message */
68 MSG_PROCESS_CONTINUE_READING
71 /* Flush the write BIO */
72 int statem_flush(SSL *s);
74 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
76 int check_in_list(SSL *s, unsigned int group_id, const unsigned char *groups,
77 size_t num_groups, int checkallow);
80 * TLS/DTLS client state machine functions
82 int ossl_statem_client_read_transition(SSL *s, int mt);
83 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
84 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
85 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
86 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
87 confunc_f *confunc, int *mt);
88 size_t ossl_statem_client_max_message_size(SSL *s);
89 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
90 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
93 * TLS/DTLS server state machine functions
95 int ossl_statem_server_read_transition(SSL *s, int mt);
96 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
97 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
98 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
99 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
100 confunc_f *confunc,int *mt);
101 size_t ossl_statem_server_max_message_size(SSL *s);
102 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
103 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
105 /* Functions for getting new message data */
106 __owur int tls_get_message_header(SSL *s, int *mt);
107 __owur int tls_get_message_body(SSL *s, size_t *len);
108 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
110 /* Message construction and processing functions */
111 __owur int tls_process_initial_server_flight(SSL *s, int *al);
112 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
113 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
114 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
115 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
117 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
118 __owur int tls_construct_key_update(SSL *s, WPACKET *pkt);
119 __owur MSG_PROCESS_RETURN tls_process_key_update(SSL *s, PACKET *pkt);
120 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
121 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
123 /* some client-only functions */
124 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
125 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
126 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
127 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
128 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
129 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
130 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
131 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
132 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
133 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
134 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
135 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
136 __owur int tls_client_key_exchange_post_work(SSL *s);
137 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
138 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
139 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
140 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
141 __owur int ssl3_check_cert_and_algorithm(SSL *s);
142 #ifndef OPENSSL_NO_NEXTPROTONEG
143 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
145 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
146 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
148 /* some server-only functions */
149 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
150 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
151 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
152 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
153 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
154 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
155 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
156 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
157 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
158 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
159 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
160 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
161 #ifndef OPENSSL_NO_NEXTPROTONEG
162 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
164 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
167 /* Extension processing */
169 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
170 RAW_EXTENSION **res, int *al, size_t *len);
171 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
172 RAW_EXTENSION *exts, X509 *x, size_t chainidx,
174 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
175 X509 *x, size_t chainidx, int *al);
176 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
177 X509 *x, size_t chainidx, int *al);
179 __owur int tls_psk_do_binder(SSL *s, const EVP_MD *md,
180 const unsigned char *msgstart,
181 size_t binderoffset, const unsigned char *binderin,
182 unsigned char *binderout,
183 SSL_SESSION *sess, int sign);
185 /* Server Extension processing */
186 int tls_parse_ctos_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
187 X509 *x, size_t chainidx, int *al);
188 int tls_parse_ctos_server_name(SSL *s, PACKET *pkt, unsigned int context,
189 X509 *x, size_t chainidx, int *al);
190 #ifndef OPENSSL_NO_SRP
191 int tls_parse_ctos_srp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
192 size_t chainidx, int *al);
194 #ifndef OPENSSL_NO_EC
195 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
196 X509 *x, size_t chainidx, int *al);
197 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
198 X509 *x, size_t chainidx, int *al);
200 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
201 X509 *x, size_t chainidx, int *al);
202 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
203 size_t chainidx, int *al);
204 #ifndef OPENSSL_NO_OCSP
205 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
206 X509 *x, size_t chainidx, int *al);
208 #ifndef OPENSSL_NO_NEXTPROTONEG
209 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
210 size_t chainidx, int *al);
212 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
213 size_t chainidx, int *al);
214 #ifndef OPENSSL_NO_SRTP
215 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
216 size_t chainidx, int *al);
218 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
219 size_t chainidx, int *al);
220 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
221 size_t chainidx, int *al);
222 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
223 size_t chainidx, int *al);
224 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
225 X509 *x, size_t chainidx, int *al);
226 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
227 size_t chainidx, int *al);
229 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
230 X509 *x, size_t chainidx, int *al);
231 int tls_construct_stoc_server_name(SSL *s, WPACKET *pkt, unsigned int context,
232 X509 *x, size_t chainidx, int *al);
233 #ifndef OPENSSL_NO_EC
234 int tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
235 X509 *x, size_t chainidx, int *al);
237 int tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
238 unsigned int context, X509 *x,
239 size_t chainidx, int *al);
240 #ifndef OPENSSL_NO_OCSP
241 int tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
242 unsigned int context, X509 *x,
243 size_t chainidx, int *al);
245 #ifndef OPENSSL_NO_NEXTPROTONEG
246 int tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
247 unsigned int context, X509 *x,
248 size_t chainidx, int *al);
250 int tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
251 size_t chainidx, int *al);
252 #ifndef OPENSSL_NO_SRTP
253 int tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
254 X509 *x, size_t chainidx, int *al);
256 int tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
257 size_t chainidx, int *al);
258 int tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
259 size_t chainidx, int *al);
260 int tls_construct_stoc_key_share(SSL *s, WPACKET *pkt, unsigned int context,
261 X509 *x, size_t chainidx, int *al);
263 * Not in public headers as this is not an official extension. Only used when
264 * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
266 #define TLSEXT_TYPE_cryptopro_bug 0xfde8
267 int tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt, unsigned int context,
268 X509 *x, size_t chainidx, int *al);
269 int tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
270 size_t chainidx, int *al);
272 /* Client Extension processing */
273 int tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
274 X509 *x, size_t chainidx, int *al);
275 int tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, unsigned int context,
276 X509 *x, size_t chainidx, int *al);
277 #ifndef OPENSSL_NO_SRP
278 int tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
279 size_t chainidx, int *al);
281 #ifndef OPENSSL_NO_EC
282 int tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
283 X509 *x, size_t chainidx, int *al);
284 int tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
285 unsigned int context, X509 *x,
286 size_t chainidx, int *al);
288 int tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
289 unsigned int context, X509 *x,
290 size_t chainidx, int *al);
291 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, unsigned int context,
292 X509 *x, size_t chainidx, int *al);
293 #ifndef OPENSSL_NO_OCSP
294 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
295 unsigned int context, X509 *x,
296 size_t chainidx, int *al);
298 #ifndef OPENSSL_NO_NEXTPROTONEG
299 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
300 size_t chainidx, int *al);
302 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
303 size_t chainidx, int *al);
304 #ifndef OPENSSL_NO_SRTP
305 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
306 X509 *x, size_t chainidx, int *al);
308 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
309 size_t chainidx, int *al);
310 #ifndef OPENSSL_NO_CT
311 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
312 size_t chainidx, int *al);
314 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
315 size_t chainidx, int *al);
316 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
317 unsigned int context, X509 *x,
318 size_t chainidx, int *al);
319 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, unsigned int context,
320 X509 *x, size_t chainidx, int *al);
321 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, unsigned int context,
322 X509 *x, size_t chainidx, int *al);
323 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, unsigned int context,
324 X509 *x, size_t chainidx, int *al);
325 int tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
326 size_t chainidx, int *al);
327 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
328 X509 *x, size_t chainidx, int *al);
329 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
330 X509 *x, size_t chainidx, int *al);
331 #ifndef OPENSSL_NO_EC
332 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
333 X509 *x, size_t chainidx, int *al);
335 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
336 X509 *x, size_t chainidx, int *al);
337 #ifndef OPENSSL_NO_OCSP
338 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
339 X509 *x, size_t chainidx, int *al);
341 #ifndef OPENSSL_NO_CT
342 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
343 size_t chainidx, int *al);
345 #ifndef OPENSSL_NO_NEXTPROTONEG
346 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
347 size_t chainidx, int *al);
349 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
350 size_t chainidx, int *al);
351 #ifndef OPENSSL_NO_SRTP
352 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
353 size_t chainidx, int *al);
355 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
356 size_t chainidx, int *al);
357 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
358 size_t chainidx, int *al);
359 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
360 size_t chainidx, int *al);
361 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
362 size_t chainidx, int *al);