1 /* ssl/statem/statem.h */
2 /* ====================================================================
3 * Copyright (c) 1998-2015 The OpenSSL Project. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
31 * 6. Redistributions of any form whatsoever must retain the following
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
56 /*****************************************************************************
58 * These emums should be considered PRIVATE to the state machine. No *
59 * non-state machine code should need to use these *
61 *****************************************************************************/
63 * Valid return codes used for functions performing work prior to or after
64 * sending or receiving a message
67 /* Something went wrong */
69 /* We're done working and there shouldn't be anything else to do after */
71 /* We're done working move onto the next thing */
72 WORK_FINISHED_CONTINUE,
73 /* We're working on phase A */
75 /* We're working on phase B */
79 /* Write transition return codes */
81 /* Something went wrong */
83 /* A transition was successfully completed and we should continue */
85 /* There is no more write work to be done */
89 /* Message processing return codes */
90 enum MSG_PROCESS_RETURN {
92 MSG_PROCESS_FINISHED_READING,
93 MSG_PROCESS_CONTINUE_PROCESSING,
94 MSG_PROCESS_CONTINUE_READING
97 /* Message flow states */
99 /* No handshake in progress */
101 /* A permanent error with this connection */
103 /* We are about to renegotiate */
104 MSG_FLOW_RENEGOTIATE,
105 /* We are reading messages */
107 /* We are writing messages */
109 /* Handshake has finished */
117 READ_STATE_POST_PROCESS
122 WRITE_STATE_TRANSITION,
123 WRITE_STATE_PRE_WORK,
125 WRITE_STATE_POST_WORK
129 /*****************************************************************************
131 * This structure should be considered "opaque" to anything outside of the *
132 * state machine. No non-state machine code should be accessing the members *
133 * of this structure. *
135 *****************************************************************************/
138 enum MSG_FLOW_STATE state;
139 enum WRITE_STATE write_state;
140 enum WORK_STATE write_state_work;
141 enum READ_STATE read_state;
142 enum WORK_STATE read_state_work;
143 enum HANDSHAKE_STATE hand_state;
145 int read_state_first_init;
147 #ifndef OPENSSL_NO_SCTP
148 int in_sctp_read_sock;
151 typedef struct statem_st STATEM;
154 /*****************************************************************************
156 * The following macros/functions represent the libssl internal API to the *
157 * state machine. Any libssl code may call these functions/macros *
159 *****************************************************************************/
161 __owur int statem_accept(SSL *s);
162 __owur int statem_connect(SSL *s);
163 void statem_clear(SSL *s);
164 void statem_set_renegotiate(SSL *s);
165 void statem_set_error(SSL *s);
166 int statem_in_error(const SSL *s);
167 void statem_set_in_init(SSL *s, int init);
168 __owur int statem_app_data_allowed(SSL *s);
169 #ifndef OPENSSL_NO_SCTP
170 void statem_set_sctp_read_sock(SSL *s, int read_sock);
171 __owur int statem_in_sctp_read_sock(SSL *s);