Store groups as uint16_t
[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 int check_in_list(SSL *s, uint16_t group_id, const uint16_t *groups,
59                   size_t num_groups, int checkallow);
60 int create_synthetic_message_hash(SSL *s);
61 int parse_ca_names(SSL *s, PACKET *pkt, int *al);
62 int construct_ca_names(SSL *s, WPACKET *pkt);
63 size_t construct_key_exchange_tbs(const SSL *s, unsigned char **ptbs,
64                                   const void *param, size_t paramlen);
65
66 /*
67  * TLS/DTLS client state machine functions
68  */
69 int ossl_statem_client_read_transition(SSL *s, int mt);
70 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
71 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
72 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
73 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
74                                          confunc_f *confunc, int *mt);
75 size_t ossl_statem_client_max_message_size(SSL *s);
76 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
77 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
78
79 /*
80  * TLS/DTLS server state machine functions
81  */
82 int ossl_statem_server_read_transition(SSL *s, int mt);
83 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
84 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
85 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
86 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
87                                          confunc_f *confunc,int *mt);
88 size_t ossl_statem_server_max_message_size(SSL *s);
89 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
90 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
91
92 /* Functions for getting new message data */
93 __owur int tls_get_message_header(SSL *s, int *mt);
94 __owur int tls_get_message_body(SSL *s, size_t *len);
95 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
96
97 /* Message construction and processing functions */
98 __owur int tls_process_initial_server_flight(SSL *s, int *al);
99 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
100 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
101 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
102 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
103
104 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
105 __owur int tls_construct_key_update(SSL *s, WPACKET *pkt);
106 __owur MSG_PROCESS_RETURN tls_process_key_update(SSL *s, PACKET *pkt);
107 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
108 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
109
110 /* some client-only functions */
111 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
112 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
113 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
114 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
115 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
116 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
117 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
118 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
119 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
120 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
121 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
122 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
123 __owur int tls_client_key_exchange_post_work(SSL *s);
124 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
125 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
126 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
127 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
128 __owur int ssl3_check_cert_and_algorithm(SSL *s);
129 #ifndef OPENSSL_NO_NEXTPROTONEG
130 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
131 #endif
132 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
133 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
134 __owur int tls_construct_end_of_early_data(SSL *s, WPACKET *pkt);
135
136 /* some server-only functions */
137 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
138 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
139 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
140 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
141 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
142 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
143 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
144 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
145 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
146 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
147 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
148 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
149 #ifndef OPENSSL_NO_NEXTPROTONEG
150 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
151 #endif
152 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
153 MSG_PROCESS_RETURN tls_process_end_of_early_data(SSL *s, PACKET *pkt);
154
155
156 /* Extension processing */
157
158 typedef enum ext_return_en {
159     EXT_RETURN_FAIL,
160     EXT_RETURN_SENT,
161     EXT_RETURN_NOT_SENT
162 } EXT_RETURN;
163
164 __owur int extension_is_relevant(SSL *s, unsigned int extctx,
165                                  unsigned int thisctx);
166 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
167                                   RAW_EXTENSION **res, int *al, size_t *len,
168                                   int init);
169 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
170                                RAW_EXTENSION *exts,  X509 *x, size_t chainidx,
171                                int *al);
172 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
173                                     X509 *x, size_t chainidx, int *al, int fin);
174 __owur int should_add_extension(SSL *s, unsigned int extctx,
175                                 unsigned int thisctx, int max_version);
176 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
177                                     X509 *x, size_t chainidx, int *al);
178
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, int external);
184
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);
193 #endif
194 int tls_parse_ctos_early_data(SSL *s, PACKET *pkt, unsigned int context,
195                               X509 *x, size_t chainidx, int *al);
196 #ifndef OPENSSL_NO_EC
197 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
198                                  X509 *x, size_t chainidx, int *al);
199 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
200                                     X509 *x, size_t chainidx, int *al);
201 #endif
202 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
203                                   X509 *x, size_t chainidx, int *al);
204 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
205                             size_t chainidx, int *al);
206 #ifndef OPENSSL_NO_OCSP
207 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
208                                   X509 *x, size_t chainidx, int *al);
209 #endif
210 #ifndef OPENSSL_NO_NEXTPROTONEG
211 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
212                        size_t chainidx, int *al);
213 #endif
214 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
215                         size_t chainidx, int *al);
216 #ifndef OPENSSL_NO_SRTP
217 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
218                             size_t chainidx, int *al);
219 #endif
220 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
221                        size_t chainidx, int *al);
222 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
223                              size_t chainidx, int *al);
224 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
225                        size_t chainidx, int *al);
226 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
227                                  X509 *x, size_t chainidx, int *al);
228 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
229                        size_t chainidx, int *al);
230
231 EXT_RETURN tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt,
232                                           unsigned int context, X509 *x,
233                                           size_t chainidx, int *al);
234 EXT_RETURN tls_construct_stoc_server_name(SSL *s, WPACKET *pkt,
235                                           unsigned int context, X509 *x,
236                                           size_t chainidx, int *al);
237 EXT_RETURN tls_construct_stoc_early_data(SSL *s, WPACKET *pkt,
238                                          unsigned int context, X509 *x,
239                                          size_t chainidx, int *al);
240 #ifndef OPENSSL_NO_EC
241 EXT_RETURN tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt,
242                                             unsigned int context, X509 *x,
243                                             size_t chainidx, int *al);
244 #endif
245 EXT_RETURN tls_construct_stoc_supported_groups(SSL *s, WPACKET *pkt,
246                                                unsigned int context, X509 *x,
247                                                size_t chainidx, int *al);
248 EXT_RETURN tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
249                                              unsigned int context, X509 *x,
250                                              size_t chainidx, int *al);
251 #ifndef OPENSSL_NO_OCSP
252 EXT_RETURN tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
253                                              unsigned int context, X509 *x,
254                                              size_t chainidx, int *al);
255 #endif
256 #ifndef OPENSSL_NO_NEXTPROTONEG
257 EXT_RETURN tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
258                                              unsigned int context, X509 *x,
259                                              size_t chainidx, int *al);
260 #endif
261 EXT_RETURN tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context,
262                                    X509 *x, size_t chainidx, int *al);
263 #ifndef OPENSSL_NO_SRTP
264 EXT_RETURN tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
265                                 X509 *x, size_t chainidx, int *al);
266 #endif
267 EXT_RETURN tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context,
268                                   X509 *x, size_t chainidx, int *al);
269 EXT_RETURN tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context,
270                                   X509 *x, size_t chainidx, int *al);
271 EXT_RETURN tls_construct_stoc_key_share(SSL *s, WPACKET *pkt,
272                                         unsigned int context, X509 *x,
273                                         size_t chainidx, int *al);
274 /*
275  * Not in public headers as this is not an official extension. Only used when
276  * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
277  */
278 #define TLSEXT_TYPE_cryptopro_bug      0xfde8
279 EXT_RETURN tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt,
280                                             unsigned int context, X509 *x,
281                                             size_t chainidx, int *al);
282 EXT_RETURN tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context,
283                                   X509 *x, size_t chainidx, int *al);
284
285 /* Client Extension processing */
286 EXT_RETURN tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
287                                    X509 *x, size_t chainidx, int *al);
288 EXT_RETURN 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 EXT_RETURN tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
292                            size_t chainidx, int *al);
293 #endif
294 #ifndef OPENSSL_NO_EC
295 EXT_RETURN tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt,
296                                             unsigned int context, X509 *x,
297                                             size_t chainidx, int *al);
298 EXT_RETURN tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
299                                                unsigned int context, X509 *x,
300                                                size_t chainidx, int *al);
301 #endif
302 EXT_RETURN tls_construct_ctos_early_data(SSL *s, WPACKET *pkt,
303                                          unsigned int context, X509 *x,
304                                          size_t chainidx, int *al);
305 EXT_RETURN tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
306                                              unsigned int context, X509 *x,
307                                              size_t chainidx, int *al);
308 EXT_RETURN tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt,
309                                        unsigned int context, X509 *x,
310                                        size_t chainidx, int *al);
311 #ifndef OPENSSL_NO_OCSP
312 EXT_RETURN tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
313                                              unsigned int context, X509 *x,
314                                              size_t chainidx, int *al);
315 #endif
316 #ifndef OPENSSL_NO_NEXTPROTONEG
317 EXT_RETURN tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context,
318                                   X509 *x, size_t chainidx, int *al);
319 #endif
320 EXT_RETURN tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context,
321                                    X509 *x, size_t chainidx, int *al);
322 #ifndef OPENSSL_NO_SRTP
323 EXT_RETURN tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
324                                        X509 *x, size_t chainidx, int *al);
325 #endif
326 EXT_RETURN tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context,
327                                   X509 *x, size_t chainidx, int *al);
328 #ifndef OPENSSL_NO_CT
329 EXT_RETURN tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context,
330                                   X509 *x, size_t chainidx, int *al);
331 #endif
332 EXT_RETURN tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context,
333                                   X509 *x, size_t chainidx, int *al);
334 EXT_RETURN tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
335                                                  unsigned int context, X509 *x,
336                                                  size_t chainidx, int *al);
337 EXT_RETURN tls_construct_ctos_key_share(SSL *s, WPACKET *pkt,
338                                         unsigned int context, X509 *x,
339                                         size_t chainidx, int *al);
340 EXT_RETURN tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt,
341                                             unsigned int context, X509 *x,
342                                             size_t chainidx, int *al);
343 EXT_RETURN tls_construct_ctos_cookie(SSL *s, WPACKET *pkt, unsigned int context,
344                                      X509 *x, size_t chainidx, int *al);
345 EXT_RETURN tls_construct_ctos_padding(SSL *s, WPACKET *pkt,
346                                       unsigned int context, X509 *x,
347                                       size_t chainidx, int *al);
348 EXT_RETURN tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context,
349                                   X509 *x, size_t chainidx, int *al);
350 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
351                                X509 *x, size_t chainidx, int *al);
352 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
353                                X509 *x, size_t chainidx, int *al);
354 int tls_parse_stoc_early_data(SSL *s, PACKET *pkt, unsigned int context,
355                               X509 *x, size_t chainidx, int *al);
356 #ifndef OPENSSL_NO_EC
357 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
358                                  X509 *x, size_t chainidx, int *al);
359 #endif
360 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
361                                   X509 *x, size_t chainidx, int *al);
362 #ifndef OPENSSL_NO_OCSP
363 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
364                                   X509 *x, size_t chainidx, int *al);
365 #endif
366 #ifndef OPENSSL_NO_CT
367 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
368                        size_t chainidx, int *al);
369 #endif
370 #ifndef OPENSSL_NO_NEXTPROTONEG
371 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
372                        size_t chainidx, int *al);
373 #endif
374 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
375                         size_t chainidx, int *al);
376 #ifndef OPENSSL_NO_SRTP
377 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
378                             size_t chainidx, int *al);
379 #endif
380 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
381                        size_t chainidx, int *al);
382 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
383                        size_t chainidx, int *al);
384 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
385                              size_t chainidx, int *al);
386 int tls_parse_stoc_cookie(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
387                        size_t chainidx, int *al);
388 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
389                        size_t chainidx, int *al);
390
391 int tls_handle_alpn(SSL *s, int *al);