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