Verify that extensions are used in the correct context
[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 #define EXT_DTLS_ONLY                       0x01
31 #define EXT_CLIENT_HELLO                    0x02
32 /* Really means TLS1.2 or below */
33 #define EXT_TLS1_2_SERVER_HELLO             0x04
34 #define EXT_TLS1_3_SERVER_HELLO             0x08
35 #define EXT_TLS1_3_ENCRYPTED_EXTENSIONS     0x10
36 #define EXT_TLS1_3_HELLO_RETRY_REQUEST      0x20
37 #define EXT_TLS1_3_CERTIFICATE              0x40
38 #define EXT_TLS1_3_NEW_SESSION_TICKET       0x80
39
40 /* Message processing return codes */
41 typedef enum {
42     /* Something bad happened */
43     MSG_PROCESS_ERROR,
44     /* We've finished reading - swap to writing */
45     MSG_PROCESS_FINISHED_READING,
46     /*
47      * We've completed the main processing of this message but there is some
48      * post processing to be done.
49      */
50     MSG_PROCESS_CONTINUE_PROCESSING,
51     /* We've finished this message - read the next message */
52     MSG_PROCESS_CONTINUE_READING
53 } MSG_PROCESS_RETURN;
54
55 /* Flush the write BIO */
56 int statem_flush(SSL *s);
57
58 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
59
60 /*
61  * TLS/DTLS client state machine functions
62  */
63 int ossl_statem_client_read_transition(SSL *s, int mt);
64 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
65 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
66 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
67 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
68                                          confunc_f *confunc, int *mt);
69 size_t ossl_statem_client_max_message_size(SSL *s);
70 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
71 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
72
73 /*
74  * TLS/DTLS server state machine functions
75  */
76 int ossl_statem_server_read_transition(SSL *s, int mt);
77 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
78 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
79 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
80 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
81                                          confunc_f *confunc,int *mt);
82 size_t ossl_statem_server_max_message_size(SSL *s);
83 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
84 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
85
86 /* Functions for getting new message data */
87 __owur int tls_get_message_header(SSL *s, int *mt);
88 __owur int tls_get_message_body(SSL *s, size_t *len);
89 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
90
91 /* Message construction and processing functions */
92 __owur int tls_process_initial_server_flight(SSL *s, int *al);
93 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
94 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
95 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
96 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
97
98 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
99 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst);
100 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
101
102 int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
103                            RAW_EXTENSION **res, size_t *numfound, int *ad);
104
105 /* some client-only functions */
106 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
107 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
108 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
109 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
110 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
111 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
112 __owur int tls_construct_client_verify(SSL *s, WPACKET *pkt);
113 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
114 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
115 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
116 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
117 __owur int tls_client_key_exchange_post_work(SSL *s);
118 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
119 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
120 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
121 __owur int ssl3_check_cert_and_algorithm(SSL *s);
122 #ifndef OPENSSL_NO_NEXTPROTONEG
123 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
124 #endif
125 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
126
127 /* some server-only functions */
128 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
129 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
130 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
131 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
132 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
133 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
134 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
135 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
136 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
137 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
138 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
139 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
140 #ifndef OPENSSL_NO_NEXTPROTONEG
141 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
142 #endif
143 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);