1eb971f736b0a66f17eb2d5a28d16a19df0cd42b
[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 SERVER_HELLO_MAX_LENGTH         20000
22 #define ENCRYPTED_EXTENSIONS_MAX_LENGTH 20000
23 #define SERVER_KEY_EXCH_MAX_LENGTH      102400
24 #define SERVER_HELLO_DONE_MAX_LENGTH    0
25 #define CCS_MAX_LENGTH                  1
26 /* Max should actually be 36 but we are generous */
27 #define FINISHED_MAX_LENGTH             64
28
29 /* Extension context codes */
30 /* This extension is only allowed in TLS */
31 #define EXT_TLS_ONLY                        0x0001
32 /* This extension is only allowed in DTLS */
33 #define EXT_DTLS_ONLY                       0x0002
34 /* Some extensions may be allowed in DTLS but we don't implement them for it */
35 #define EXT_TLS_IMPLEMENTATION_ONLY         0x0004
36 /* Most extensions are not defined for SSLv3 but EXT_TYPE_renegotiate is */
37 #define EXT_SSL3_ALLOWED                    0x0008
38 /* Extension is only defined for TLS1.2 and above */
39 #define EXT_TLS1_2_AND_BELOW_ONLY           0x0010
40 /* Extension is only defined for TLS1.3 and above */
41 #define EXT_TLS1_3_ONLY                     0x0020
42 #define EXT_CLIENT_HELLO                    0x0040
43 /* Really means TLS1.2 or below */
44 #define EXT_TLS1_2_SERVER_HELLO             0x0080
45 #define EXT_TLS1_3_SERVER_HELLO             0x0100
46 #define EXT_TLS1_3_ENCRYPTED_EXTENSIONS     0x0200
47 #define EXT_TLS1_3_HELLO_RETRY_REQUEST      0x0400
48 #define EXT_TLS1_3_CERTIFICATE              0x0800
49 #define EXT_TLS1_3_NEW_SESSION_TICKET       0x1000
50
51 /* Message processing return codes */
52 typedef enum {
53     /* Something bad happened */
54     MSG_PROCESS_ERROR,
55     /* We've finished reading - swap to writing */
56     MSG_PROCESS_FINISHED_READING,
57     /*
58      * We've completed the main processing of this message but there is some
59      * post processing to be done.
60      */
61     MSG_PROCESS_CONTINUE_PROCESSING,
62     /* We've finished this message - read the next message */
63     MSG_PROCESS_CONTINUE_READING
64 } MSG_PROCESS_RETURN;
65
66 /* Flush the write BIO */
67 int statem_flush(SSL *s);
68
69 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
70
71 /*
72  * TLS/DTLS client state machine functions
73  */
74 int ossl_statem_client_read_transition(SSL *s, int mt);
75 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
76 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
77 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
78 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
79                                          confunc_f *confunc, int *mt);
80 size_t ossl_statem_client_max_message_size(SSL *s);
81 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
82 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
83
84 /*
85  * TLS/DTLS server state machine functions
86  */
87 int ossl_statem_server_read_transition(SSL *s, int mt);
88 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
89 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
90 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
91 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
92                                          confunc_f *confunc,int *mt);
93 size_t ossl_statem_server_max_message_size(SSL *s);
94 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
95 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
96
97 /* Functions for getting new message data */
98 __owur int tls_get_message_header(SSL *s, int *mt);
99 __owur int tls_get_message_body(SSL *s, size_t *len);
100 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
101
102 /* Message construction and processing functions */
103 __owur int tls_process_initial_server_flight(SSL *s, int *al);
104 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
105 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
106 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
107 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
108
109 __owur int tls_construct_finished(SSL *s, WPACKET *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 MSG_PROCESS_RETURN tls13_process_new_session_ticket(SSL *s, PACKET *pkt);
119 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
120 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
121 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
122 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
123 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
124 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
125 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
126 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
127 __owur int tls_client_key_exchange_post_work(SSL *s);
128 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
129 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
130 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
131 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
132 __owur int ssl3_check_cert_and_algorithm(SSL *s);
133 #ifndef OPENSSL_NO_NEXTPROTONEG
134 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
135 #endif
136 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
137 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *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
157
158 /* Extension processing */
159
160 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
161                                   RAW_EXTENSION **res, int *al);
162 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
163                                RAW_EXTENSION *exts,  X509 *x, size_t chainidx,
164                                int *al);
165 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
166                                     X509 *x, size_t chainidx, int *al);
167 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
168                                     X509 *x, size_t chainidx, int *al);
169
170 /* Server Extension processing */
171 int tls_parse_ctos_renegotiate(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
172                                int *al);
173 int tls_parse_ctos_server_name(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
174                                int *al);
175 #ifndef OPENSSL_NO_SRP
176 int tls_parse_ctos_srp(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
177 #endif
178 #ifndef OPENSSL_NO_EC
179 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
180                                  int *al);
181 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, X509 *x,
182                                     size_t chainidx, int *al);
183 #endif
184 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
185                                   int *al);
186 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
187                             int *al);
188 #ifndef OPENSSL_NO_OCSP
189 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
190                                   int *al);
191 #endif
192 #ifndef OPENSSL_NO_NEXTPROTONEG
193 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
194 #endif
195 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
196 #ifndef OPENSSL_NO_SRTP
197 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
198                             int *al);
199 #endif
200 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
201 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
202                              int *al);
203 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
204 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
205                                  int *al);
206
207 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, X509 *x,
208                                    size_t chainidx, int *al);
209 int tls_construct_stoc_server_name(SSL *s, WPACKET *pkt, X509 *x,
210                                    size_t chainidx, int *al);
211 #ifndef OPENSSL_NO_EC
212 int tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt, X509 *x,
213                                      size_t chainidx, int *al);
214 #endif
215 int tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt, X509 *x,
216                                       size_t chainidx, int *al);
217 #ifndef OPENSSL_NO_OCSP
218 int tls_construct_stoc_status_request(SSL *s, WPACKET *pkt, X509 *x,
219                                       size_t chainidx, int *al);
220 #endif
221 #ifndef OPENSSL_NO_NEXTPROTONEG
222 int tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt, X509 *x,
223                                       size_t chainidx, int *al);
224 #endif
225 int tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
226                             int *al);
227 #ifndef OPENSSL_NO_SRTP
228 int tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
229                                 int *al);
230 #endif
231 int tls_construct_stoc_etm(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
232                            int *al);
233 int tls_construct_stoc_ems(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
234                            int *al);
235 int tls_construct_stoc_key_share(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
236                                  int *al);
237 /*
238  * Not in public headers as this is not an official extension. Only used when
239  * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
240  */
241 #define TLSEXT_TYPE_cryptopro_bug      0xfde8
242 int tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt, X509 *x,
243                                      size_t chainidx, int *al);
244
245 /* Client Extension processing */
246 int tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, X509 *x,
247                                    size_t chainidx, int *al);
248 int tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, X509 *x,
249                                    size_t chainidx, int *al);
250 #ifndef OPENSSL_NO_SRP
251 int tls_construct_ctos_srp(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
252                                    int *al);
253 #endif
254 #ifndef OPENSSL_NO_EC
255 int tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt, X509 *x,
256                                      size_t chainidx, int *al);
257 int tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt, X509 *x,
258                                         size_t chainidx, int *al);
259 #endif
260 int tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt, X509 *x,
261                                       size_t chainidx, int *al);
262 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
263                                 int *al);
264 #ifndef OPENSSL_NO_OCSP
265 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt, X509 *x,
266                                       size_t chainidx, int *al);
267 #endif
268 #ifndef OPENSSL_NO_NEXTPROTONEG
269 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
270                            int *al);
271 #endif
272 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
273                             int *al);
274 #ifndef OPENSSL_NO_SRTP
275 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
276                                 int *al);
277 #endif
278 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
279                            int *al);
280 #ifndef OPENSSL_NO_CT
281 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
282                            int *al);
283 #endif
284 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
285                            int *al);
286 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt, X509 *x,
287                                           size_t chainidx, int *al);
288 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
289                                  int *al);
290 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, X509 *x,
291                                      size_t chainidx, int *al);
292 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, X509 *x, size_t chainidx,
293                                int *al);
294 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
295                                int *al);
296 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
297                                int *al);
298 #ifndef OPENSSL_NO_EC
299 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
300                                  int *al);
301 #endif
302 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
303                                   int *al);
304 #ifndef OPENSSL_NO_OCSP
305 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
306                                   int *al);
307 #endif
308 #ifndef OPENSSL_NO_CT
309 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
310 #endif
311 #ifndef OPENSSL_NO_NEXTPROTONEG
312 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
313 #endif
314 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
315 #ifndef OPENSSL_NO_SRTP
316 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
317                             int *al);
318 #endif
319 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
320 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, X509 *x, size_t chainidx, int *al);
321 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, X509 *x, size_t chainidx,
322                              int *al);