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