a46e6c79711a9058eb501296f88e85ab90f3be05
[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 SERVER_KEY_EXCH_MAX_LENGTH      102400
23 #define SERVER_HELLO_DONE_MAX_LENGTH    0
24 #define CCS_MAX_LENGTH                  1
25 /* Max should actually be 36 but we are generous */
26 #define FINISHED_MAX_LENGTH             64
27
28 /* Message processing return codes */
29 typedef enum {
30     /* Something bad happened */
31     MSG_PROCESS_ERROR,
32     /* We've finished reading - swap to writing */
33     MSG_PROCESS_FINISHED_READING,
34     /*
35      * We've completed the main processing of this message but there is some
36      * post processing to be done.
37      */
38     MSG_PROCESS_CONTINUE_PROCESSING,
39     /* We've finished this message - read the next message */
40     MSG_PROCESS_CONTINUE_READING
41 } MSG_PROCESS_RETURN;
42
43 /* Flush the write BIO */
44 int statem_flush(SSL *s);
45
46 /*
47  * TLS/DTLS client state machine functions
48  */
49 int ossl_statem_client_read_transition(SSL *s, int mt);
50 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
51 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
52 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
53 int ossl_statem_client_construct_message(SSL *s);
54 unsigned long ossl_statem_client_max_message_size(SSL *s);
55 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
56 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
57
58 /*
59  * TLS/DTLS server state machine functions
60  */
61 int ossl_statem_server_read_transition(SSL *s, int mt);
62 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
63 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
64 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
65 int ossl_statem_server_construct_message(SSL *s);
66 unsigned long ossl_statem_server_max_message_size(SSL *s);
67 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
68 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
69
70 /* Functions for getting new message data */
71 __owur int tls_get_message_header(SSL *s, int *mt);
72 __owur int tls_get_message_body(SSL *s, unsigned long *len);
73 __owur int dtls_get_message(SSL *s, int *mt, unsigned long *len);
74
75 /* Message construction and processing functions */
76 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
77 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
78 __owur int tls_construct_change_cipher_spec(SSL *s);
79 __owur int dtls_construct_change_cipher_spec(SSL *s);
80
81 __owur int tls_construct_finished(SSL *s, const char *sender, int slen);
82 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst);
83 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
84
85 /* some client-only functions */
86 __owur int tls_construct_client_hello(SSL *s);
87 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
88 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
89 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
90 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
91 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
92 __owur int tls_construct_client_verify(SSL *s);
93 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
94 __owur int tls_construct_client_certificate(SSL *s);
95 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
96 __owur int tls_construct_client_key_exchange(SSL *s);
97 __owur int tls_client_key_exchange_post_work(SSL *s);
98 __owur int tls_construct_cert_status(SSL *s);
99 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
100 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
101 __owur int ssl3_check_cert_and_algorithm(SSL *s);
102 #ifndef OPENSSL_NO_NEXTPROTONEG
103 __owur int tls_construct_next_proto(SSL *s);
104 #endif
105 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
106
107 /* some server-only functions */
108 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
109 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
110 __owur int tls_construct_server_hello(SSL *s);
111 __owur int tls_construct_hello_request(SSL *s);
112 __owur int dtls_construct_hello_verify_request(SSL *s);
113 __owur int tls_construct_server_certificate(SSL *s);
114 __owur int tls_construct_server_key_exchange(SSL *s);
115 __owur int tls_construct_certificate_request(SSL *s);
116 __owur int tls_construct_server_done(SSL *s);
117 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
118 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
119 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
120 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
121 #ifndef OPENSSL_NO_NEXTPROTONEG
122 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
123 #endif
124 __owur int tls_construct_new_session_ticket(SSL *s);