873ed0e7bf6b68a5778c704e5d78dfa53a2e9501
[openssl.git] / ssl / statem / statem.h
1 /* ssl/statem/statem.h */
2 /* ====================================================================
3  * Copyright (c) 1998-2015 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@openssl.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55
56 /*****************************************************************************
57  *                                                                           *
58  * These emums should be considered PRIVATE to the state machine. No         *
59  * non-state machine code should need to use these                           *
60  *                                                                           *
61  *****************************************************************************/
62 /*
63  * Valid return codes used for functions performing work prior to or after
64  * sending or receiving a message
65  */
66 enum WORK_STATE {
67     /* Something went wrong */
68     WORK_ERROR,
69     /* We're done working and there shouldn't be anything else to do after */
70     WORK_FINISHED_STOP,
71     /* We're done working move onto the next thing */
72     WORK_FINISHED_CONTINUE,
73     /* We're working on phase A */
74     WORK_MORE_A,
75     /* We're working on phase B */
76     WORK_MORE_B
77 };
78
79 /* Write transition return codes */
80 enum WRITE_TRAN {
81     /* Something went wrong */
82     WRITE_TRAN_ERROR,
83     /* A transition was successfully completed and we should continue */
84     WRITE_TRAN_CONTINUE,
85     /* There is no more write work to be done */
86     WRITE_TRAN_FINISHED
87 };
88
89 /* Message flow states */
90 enum MSG_FLOW_STATE {
91     /* No handshake in progress */
92     MSG_FLOW_UNINITED,
93     /* A permanent error with this connection */
94     MSG_FLOW_ERROR,
95     /* We are about to renegotiate */
96     MSG_FLOW_RENEGOTIATE,
97     /* We are reading messages */
98     MSG_FLOW_READING,
99     /* We are writing messages */
100     MSG_FLOW_WRITING,
101     /* Handshake has finished */
102     MSG_FLOW_FINISHED
103 };
104
105 /* Read states */
106 enum READ_STATE {
107     READ_STATE_HEADER,
108     READ_STATE_BODY,
109     READ_STATE_POST_PROCESS
110 };
111
112 /* Write states */
113 enum WRITE_STATE {
114     WRITE_STATE_TRANSITION,
115     WRITE_STATE_PRE_WORK,
116     WRITE_STATE_SEND,
117     WRITE_STATE_POST_WORK
118 };
119
120
121 /*****************************************************************************
122  *                                                                           *
123  * This structure should be considered "opaque" to anything outside of the   *
124  * state machine. No non-state machine code should be accessing the members  *
125  * of this structure.                                                        *
126  *                                                                           *
127  *****************************************************************************/
128
129 struct statem_st {
130     enum MSG_FLOW_STATE state;
131     enum WRITE_STATE write_state;
132     enum WORK_STATE write_state_work;
133     enum READ_STATE read_state;
134     enum WORK_STATE read_state_work;
135     enum HANDSHAKE_STATE hand_state;
136     int in_init;
137     int read_state_first_init;
138     int use_timer;
139 #ifndef OPENSSL_NO_SCTP
140     int in_sctp_read_sock;
141 #endif
142 };
143 typedef struct statem_st STATEM;
144
145
146 /*****************************************************************************
147  *                                                                           *
148  * The following macros/functions represent the libssl internal API to the   *
149  * state machine. Any libssl code may call these functions/macros            *
150  *                                                                           *
151  *****************************************************************************/
152
153 __owur int statem_accept(SSL *s);
154 __owur int statem_connect(SSL *s);
155 void statem_clear(SSL *s);
156 void statem_set_renegotiate(SSL *s);
157 void statem_set_error(SSL *s);
158 int statem_in_error(const SSL *s);
159 void statem_set_in_init(SSL *s, int init);
160 __owur int statem_app_data_allowed(SSL *s);
161 #ifndef OPENSSL_NO_SCTP
162 void statem_set_sctp_read_sock(SSL *s, int read_sock);
163 __owur int statem_in_sctp_read_sock(SSL *s);
164 #endif
165
166