]> git.ipfire.org Git - thirdparty/openssl.git/blame - ssl/statem/statem.c
Move state machine knowledge out of the record layer
[thirdparty/openssl.git] / ssl / statem / statem.c
CommitLineData
f8e0a557 1/*
846e33c7 2 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
f8e0a557 3 *
846e33c7
RS
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
f8e0a557
MC
8 */
9
10#include <openssl/rand.h>
8ba708e5 11#include "../ssl_locl.h"
61ae935a 12#include "statem_locl.h"
f8e0a557
MC
13
14/*
15 * This file implements the SSL/TLS/DTLS state machines.
16 *
17 * There are two primary state machines:
18 *
19 * 1) Message flow state machine
20 * 2) Handshake state machine
21 *
22 * The Message flow state machine controls the reading and sending of messages
23 * including handling of non-blocking IO events, flushing of the underlying
24 * write BIO, handling unexpected messages, etc. It is itself broken into two
25 * separate sub-state machines which control reading and writing respectively.
26 *
27 * The Handshake state machine keeps track of the current SSL/TLS handshake
28 * state. Transitions of the handshake state are the result of events that
29 * occur within the Message flow state machine.
30 *
31 * Overall it looks like this:
32 *
33 * --------------------------------------------- -------------------
34 * | | | |
35 * | Message flow state machine | | |
36 * | | | |
37 * | -------------------- -------------------- | Transition | Handshake state |
61ae935a 38 * | | MSG_FLOW_READING | | MSG_FLOW_WRITING | | Event | machine |
f8e0a557
MC
39 * | | sub-state | | sub-state | |----------->| |
40 * | | machine for | | machine for | | | |
41 * | | reading messages | | writing messages | | | |
42 * | -------------------- -------------------- | | |
43 * | | | |
44 * --------------------------------------------- -------------------
45 *
46 */
47
48/* Sub state machine return values */
a230b26e 49typedef enum {
f8e0a557
MC
50 /* Something bad happened or NBIO */
51 SUB_STATE_ERROR,
52 /* Sub state finished go to the next sub state */
53 SUB_STATE_FINISHED,
54 /* Sub state finished and handshake was completed */
55 SUB_STATE_END_HANDSHAKE
d78052cf 56} SUB_STATE_RETURN;
f8e0a557 57
8723588e 58static int state_machine(SSL *s, int server);
f8e0a557 59static void init_read_state_machine(SSL *s);
d78052cf 60static SUB_STATE_RETURN read_state_machine(SSL *s);
f8e0a557 61static void init_write_state_machine(SSL *s);
d78052cf 62static SUB_STATE_RETURN write_state_machine(SSL *s);
49ae7423 63
5998e290 64OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl)
49ae7423
MC
65{
66 return ssl->statem.hand_state;
67}
68
49ae7423
MC
69int SSL_in_init(SSL *s)
70{
71 return s->statem.in_init;
72}
73
74int SSL_is_init_finished(SSL *s)
75{
76 return !(s->statem.in_init) && (s->statem.hand_state == TLS_ST_OK);
77}
78
79int SSL_in_before(SSL *s)
80{
81 /*
82 * Historically being "in before" meant before anything had happened. In the
83 * current code though we remain in the "before" state for a while after we
84 * have started the handshake process (e.g. as a server waiting for the
85 * first message to arrive). There "in before" is taken to mean "in before"
86 * and not started any handshake process yet.
87 */
88 return (s->statem.hand_state == TLS_ST_BEFORE)
89 && (s->statem.state == MSG_FLOW_UNINITED);
90}
91
f8e0a557
MC
92/*
93 * Clear the state machine state and reset back to MSG_FLOW_UNINITED
94 */
fe3a3291 95void ossl_statem_clear(SSL *s)
f8e0a557
MC
96{
97 s->statem.state = MSG_FLOW_UNINITED;
49ae7423
MC
98 s->statem.hand_state = TLS_ST_BEFORE;
99 s->statem.in_init = 1;
a71a4966 100 s->statem.no_cert_verify = 0;
f8e0a557
MC
101}
102
103/*
104 * Set the state machine up ready for a renegotiation handshake
105 */
fe3a3291 106void ossl_statem_set_renegotiate(SSL *s)
f8e0a557 107{
c64359db 108 s->statem.in_init = 1;
0386aad1 109 s->statem.request_state = TLS_ST_SW_HELLO_REQ;
f8e0a557
MC
110}
111
112/*
113 * Put the state machine into an error state. This is a permanent error for
114 * the current connection.
115 */
fe3a3291 116void ossl_statem_set_error(SSL *s)
f8e0a557
MC
117{
118 s->statem.state = MSG_FLOW_ERROR;
49ae7423
MC
119}
120
121/*
122 * Discover whether the current connection is in the error state.
123 *
124 * Valid return values are:
125 * 1: Yes
126 * 0: No
127 */
fe3a3291 128int ossl_statem_in_error(const SSL *s)
49ae7423
MC
129{
130 if (s->statem.state == MSG_FLOW_ERROR)
131 return 1;
132
133 return 0;
134}
135
fe3a3291 136void ossl_statem_set_in_init(SSL *s, int init)
49ae7423
MC
137{
138 s->statem.in_init = init;
f8e0a557
MC
139}
140
024f543c
MC
141int ossl_statem_get_in_handshake(SSL *s)
142{
143 return s->statem.in_handshake;
144}
145
146void ossl_statem_set_in_handshake(SSL *s, int inhand)
147{
148 if (inhand)
149 s->statem.in_handshake++;
150 else
151 s->statem.in_handshake--;
152}
153
31fd10e6
MC
154void ossl_statem_set_hello_verify_done(SSL *s)
155{
156 s->statem.state = MSG_FLOW_UNINITED;
157 s->statem.in_init = 1;
158 /*
159 * This will get reset (briefly) back to TLS_ST_BEFORE when we enter
160 * state_machine() because |state| is MSG_FLOW_UNINITED, but until then any
161 * calls to SSL_in_before() will return false. Also calls to
162 * SSL_state_string() and SSL_state_string_long() will return something
163 * sensible.
164 */
165 s->statem.hand_state = TLS_ST_SR_CLNT_HELLO;
166}
167
a230b26e
EK
168int ossl_statem_connect(SSL *s)
169{
8723588e
MC
170 return state_machine(s, 0);
171}
172
fe3a3291 173int ossl_statem_accept(SSL *s)
c130dd8e
MC
174{
175 return state_machine(s, 1);
176}
177
a230b26e
EK
178typedef void (*info_cb) (const SSL *, int, int);
179
180static info_cb get_callback(SSL *s)
91eac8d5
MC
181{
182 if (s->info_callback != NULL)
183 return s->info_callback;
184 else if (s->ctx->info_callback != NULL)
185 return s->ctx->info_callback;
186
187 return NULL;
188}
189
f8e0a557
MC
190/*
191 * The main message flow state machine. We start in the MSG_FLOW_UNINITED or
c7f47786 192 * MSG_FLOW_FINISHED state and finish in MSG_FLOW_FINISHED. Valid states and
f8e0a557
MC
193 * transitions are as follows:
194 *
c7f47786 195 * MSG_FLOW_UNINITED MSG_FLOW_FINISHED
f8e0a557
MC
196 * | |
197 * +-----------------------+
198 * v
199 * MSG_FLOW_WRITING <---> MSG_FLOW_READING
200 * |
201 * V
202 * MSG_FLOW_FINISHED
203 * |
204 * V
205 * [SUCCESS]
206 *
207 * We may exit at any point due to an error or NBIO event. If an NBIO event
208 * occurs then we restart at the point we left off when we are recalled.
209 * MSG_FLOW_WRITING and MSG_FLOW_READING have sub-state machines associated with them.
210 *
211 * In addition to the above there is also the MSG_FLOW_ERROR state. We can move
212 * into that state at any point in the event that an irrecoverable error occurs.
213 *
214 * Valid return values are:
215 * 1: Success
216 * <=0: NBIO or error
217 */
4fa52141
VD
218static int state_machine(SSL *s, int server)
219{
f8e0a557
MC
220 BUF_MEM *buf = NULL;
221 unsigned long Time = (unsigned long)time(NULL);
222 void (*cb) (const SSL *ssl, int type, int val) = NULL;
d6f1a6e9 223 OSSL_STATEM *st = &s->statem;
f8e0a557
MC
224 int ret = -1;
225 int ssret;
226
227 if (st->state == MSG_FLOW_ERROR) {
228 /* Shouldn't have been called if we're already in the error state */
229 return -1;
230 }
231
232 RAND_add(&Time, sizeof(Time), 0);
233 ERR_clear_error();
234 clear_sys_error();
235
91eac8d5 236 cb = get_callback(s);
f8e0a557 237
024f543c 238 st->in_handshake++;
f8e0a557
MC
239 if (!SSL_in_init(s) || SSL_in_before(s)) {
240 if (!SSL_clear(s))
241 return -1;
242 }
473483d4
MC
243#ifndef OPENSSL_NO_SCTP
244 if (SSL_IS_DTLS(s)) {
245 /*
246 * Notify SCTP BIO socket to enter handshake mode and prevent stream
247 * identifier other than 0. Will be ignored if no SCTP is used.
248 */
249 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
024f543c 250 st->in_handshake, NULL);
473483d4
MC
251 }
252#endif
253
f8e0a557 254 /* Initialise state machine */
0386aad1 255 if (st->state == MSG_FLOW_UNINITED
0386aad1 256 || st->state == MSG_FLOW_FINISHED) {
f8e0a557
MC
257 if (st->state == MSG_FLOW_UNINITED) {
258 st->hand_state = TLS_ST_BEFORE;
0386aad1 259 st->request_state = TLS_ST_BEFORE;
f8e0a557
MC
260 }
261
262 s->server = server;
263 if (cb != NULL)
264 cb(s, SSL_CB_HANDSHAKE_START, 1);
265
266 if (SSL_IS_DTLS(s)) {
267 if ((s->version & 0xff00) != (DTLS1_VERSION & 0xff00) &&
a230b26e 268 (server || (s->version & 0xff00) != (DTLS1_BAD_VER & 0xff00))) {
f8e0a557
MC
269 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
270 goto end;
271 }
272 } else {
4fa52141 273 if ((s->version >> 8) != SSL3_VERSION_MAJOR) {
f8e0a557
MC
274 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
275 goto end;
276 }
277 }
278
4fa52141
VD
279 if (!ssl_security(s, SSL_SECOP_VERSION, 0, s->version, NULL)) {
280 SSLerr(SSL_F_STATE_MACHINE, SSL_R_VERSION_TOO_LOW);
281 goto end;
f8e0a557
MC
282 }
283
f8e0a557
MC
284 if (s->init_buf == NULL) {
285 if ((buf = BUF_MEM_new()) == NULL) {
286 goto end;
287 }
288 if (!BUF_MEM_grow(buf, SSL3_RT_MAX_PLAIN_LENGTH)) {
289 goto end;
290 }
291 s->init_buf = buf;
292 buf = NULL;
293 }
294
295 if (!ssl3_setup_buffers(s)) {
296 goto end;
297 }
298 s->init_num = 0;
299
300 /*
301 * Should have been reset by tls_process_finished, too.
302 */
303 s->s3->change_cipher_spec = 0;
304
46417569
MC
305 /*
306 * Ok, we now need to push on a buffering BIO ...but not with
307 * SCTP
308 */
f8e0a557 309#ifndef OPENSSL_NO_SCTP
46417569 310 if (!SSL_IS_DTLS(s) || !BIO_dgram_is_sctp(SSL_get_wbio(s)))
f8e0a557 311#endif
46417569
MC
312 if (!ssl_init_wbio_buffer(s)) {
313 goto end;
314 }
f8e0a557 315
c7f47786
MC
316 if (SSL_IS_FIRST_HANDSHAKE(s) || s->renegotiate) {
317 if (!tls_setup_handshake(s)) {
318 ossl_statem_set_error(s);
319 goto end;
f8e0a557 320 }
0386aad1 321
c7f47786
MC
322 if (SSL_IS_FIRST_HANDSHAKE(s))
323 st->read_state_first_init = 1;
f8e0a557
MC
324 }
325
326 st->state = MSG_FLOW_WRITING;
327 init_write_state_machine(s);
f8e0a557
MC
328 }
329
e8aa8b6c
F
330 while (st->state != MSG_FLOW_FINISHED) {
331 if (st->state == MSG_FLOW_READING) {
f8e0a557
MC
332 ssret = read_state_machine(s);
333 if (ssret == SUB_STATE_FINISHED) {
334 st->state = MSG_FLOW_WRITING;
335 init_write_state_machine(s);
336 } else {
337 /* NBIO or error */
338 goto end;
339 }
340 } else if (st->state == MSG_FLOW_WRITING) {
341 ssret = write_state_machine(s);
342 if (ssret == SUB_STATE_FINISHED) {
343 st->state = MSG_FLOW_READING;
344 init_read_state_machine(s);
345 } else if (ssret == SUB_STATE_END_HANDSHAKE) {
346 st->state = MSG_FLOW_FINISHED;
347 } else {
348 /* NBIO or error */
349 goto end;
350 }
351 } else {
352 /* Error */
fe3a3291 353 ossl_statem_set_error(s);
f8e0a557
MC
354 goto end;
355 }
356 }
357
f8e0a557
MC
358 ret = 1;
359
360 end:
024f543c 361 st->in_handshake--;
473483d4
MC
362
363#ifndef OPENSSL_NO_SCTP
364 if (SSL_IS_DTLS(s)) {
365 /*
366 * Notify SCTP BIO socket to leave handshake mode and allow stream
367 * identifier other than 0. Will be ignored if no SCTP is used.
368 */
369 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
024f543c 370 st->in_handshake, NULL);
473483d4
MC
371 }
372#endif
373
f8e0a557
MC
374 BUF_MEM_free(buf);
375 if (cb != NULL) {
376 if (server)
377 cb(s, SSL_CB_ACCEPT_EXIT, ret);
378 else
379 cb(s, SSL_CB_CONNECT_EXIT, ret);
380 }
381 return ret;
382}
383
384/*
385 * Initialise the MSG_FLOW_READING sub-state machine
386 */
387static void init_read_state_machine(SSL *s)
388{
d6f1a6e9 389 OSSL_STATEM *st = &s->statem;
f8e0a557
MC
390
391 st->read_state = READ_STATE_HEADER;
392}
393
0d698f66
MC
394static int grow_init_buf(SSL *s, size_t size) {
395
396 size_t msg_offset = (char *)s->init_msg - s->init_buf->data;
397
398 if (!BUF_MEM_grow_clean(s->init_buf, (int)size))
399 return 0;
400
401 if (size < msg_offset)
402 return 0;
403
404 s->init_msg = s->init_buf->data + msg_offset;
405
406 return 1;
407}
408
f8e0a557
MC
409/*
410 * This function implements the sub-state machine when the message flow is in
411 * MSG_FLOW_READING. The valid sub-states and transitions are:
412 *
413 * READ_STATE_HEADER <--+<-------------+
414 * | | |
415 * v | |
416 * READ_STATE_BODY -----+-->READ_STATE_POST_PROCESS
417 * | |
418 * +----------------------------+
419 * v
420 * [SUB_STATE_FINISHED]
421 *
422 * READ_STATE_HEADER has the responsibility for reading in the message header
423 * and transitioning the state of the handshake state machine.
424 *
425 * READ_STATE_BODY reads in the rest of the message and then subsequently
426 * processes it.
427 *
428 * READ_STATE_POST_PROCESS is an optional step that may occur if some post
429 * processing activity performed on the message may block.
430 *
0d4fb843 431 * Any of the above states could result in an NBIO event occurring in which case
f8e0a557
MC
432 * control returns to the calling application. When this function is recalled we
433 * will resume in the same state where we left off.
434 */
a230b26e
EK
435static SUB_STATE_RETURN read_state_machine(SSL *s)
436{
d6f1a6e9 437 OSSL_STATEM *st = &s->statem;
f8e0a557 438 int ret, mt;
eda75751 439 size_t len = 0;
a230b26e 440 int (*transition) (SSL *s, int mt);
73999b62 441 PACKET pkt;
a230b26e
EK
442 MSG_PROCESS_RETURN(*process_message) (SSL *s, PACKET *pkt);
443 WORK_STATE(*post_process_message) (SSL *s, WORK_STATE wst);
eda75751 444 size_t (*max_message_size) (SSL *s);
f8e0a557
MC
445 void (*cb) (const SSL *ssl, int type, int val) = NULL;
446
91eac8d5 447 cb = get_callback(s);
f8e0a557 448
e8aa8b6c 449 if (s->server) {
8481f583
MC
450 transition = ossl_statem_server_read_transition;
451 process_message = ossl_statem_server_process_message;
452 max_message_size = ossl_statem_server_max_message_size;
453 post_process_message = ossl_statem_server_post_process_message;
f8e0a557 454 } else {
8481f583
MC
455 transition = ossl_statem_client_read_transition;
456 process_message = ossl_statem_client_process_message;
457 max_message_size = ossl_statem_client_max_message_size;
458 post_process_message = ossl_statem_client_post_process_message;
f8e0a557
MC
459 }
460
461 if (st->read_state_first_init) {
462 s->first_packet = 1;
463 st->read_state_first_init = 0;
464 }
465
e8aa8b6c
F
466 while (1) {
467 switch (st->read_state) {
f8e0a557 468 case READ_STATE_HEADER:
f8e0a557 469 /* Get the state the peer wants to move to */
76af3037
MC
470 if (SSL_IS_DTLS(s)) {
471 /*
472 * In DTLS we get the whole message in one go - header and body
473 */
474 ret = dtls_get_message(s, &mt, &len);
475 } else {
476 ret = tls_get_message_header(s, &mt);
477 }
f8e0a557
MC
478
479 if (ret == 0) {
480 /* Could be non-blocking IO */
481 return SUB_STATE_ERROR;
482 }
483
484 if (cb != NULL) {
485 /* Notify callback of an impending state change */
486 if (s->server)
487 cb(s, SSL_CB_ACCEPT_LOOP, 1);
488 else
489 cb(s, SSL_CB_CONNECT_LOOP, 1);
490 }
491 /*
492 * Validate that we are allowed to move to the new state and move
493 * to that state if so
494 */
e8aa8b6c 495 if (!transition(s, mt)) {
672f3337 496 ossl_statem_set_error(s);
f8e0a557
MC
497 return SUB_STATE_ERROR;
498 }
499
500 if (s->s3->tmp.message_size > max_message_size(s)) {
501 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
502 SSLerr(SSL_F_READ_STATE_MACHINE, SSL_R_EXCESSIVE_MESSAGE_SIZE);
503 return SUB_STATE_ERROR;
504 }
505
c1ef7c97
MC
506 /* dtls_get_message already did this */
507 if (!SSL_IS_DTLS(s)
508 && s->s3->tmp.message_size > 0
0d698f66
MC
509 && !grow_init_buf(s, s->s3->tmp.message_size
510 + SSL3_HM_HEADER_LENGTH)) {
c1ef7c97 511 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
a449b47c 512 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_BUF_LIB);
c1ef7c97
MC
513 return SUB_STATE_ERROR;
514 }
515
f8e0a557
MC
516 st->read_state = READ_STATE_BODY;
517 /* Fall through */
518
519 case READ_STATE_BODY:
520 if (!SSL_IS_DTLS(s)) {
521 /* We already got this above for DTLS */
522 ret = tls_get_message_body(s, &len);
523 if (ret == 0) {
524 /* Could be non-blocking IO */
525 return SUB_STATE_ERROR;
526 }
527 }
528
529 s->first_packet = 0;
73999b62
MC
530 if (!PACKET_buf_init(&pkt, s->init_msg, len)) {
531 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
532 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
533 return SUB_STATE_ERROR;
534 }
535 ret = process_message(s, &pkt);
1689e7e6
MC
536
537 /* Discard the packet data */
538 s->init_num = 0;
539
4f8a5f4d
AG
540 switch (ret) {
541 case MSG_PROCESS_ERROR:
f8e0a557 542 return SUB_STATE_ERROR;
f8e0a557 543
4f8a5f4d 544 case MSG_PROCESS_FINISHED_READING:
f8e0a557
MC
545 if (SSL_IS_DTLS(s)) {
546 dtls1_stop_timer(s);
547 }
548 return SUB_STATE_FINISHED;
f8e0a557 549
4f8a5f4d 550 case MSG_PROCESS_CONTINUE_PROCESSING:
f8e0a557
MC
551 st->read_state = READ_STATE_POST_PROCESS;
552 st->read_state_work = WORK_MORE_A;
4f8a5f4d
AG
553 break;
554
555 default:
f8e0a557 556 st->read_state = READ_STATE_HEADER;
4f8a5f4d 557 break;
f8e0a557
MC
558 }
559 break;
560
561 case READ_STATE_POST_PROCESS:
562 st->read_state_work = post_process_message(s, st->read_state_work);
e8aa8b6c 563 switch (st->read_state_work) {
f3b3d7f0
RS
564 case WORK_ERROR:
565 case WORK_MORE_A:
566 case WORK_MORE_B:
f8e0a557
MC
567 return SUB_STATE_ERROR;
568
569 case WORK_FINISHED_CONTINUE:
570 st->read_state = READ_STATE_HEADER;
571 break;
572
573 case WORK_FINISHED_STOP:
574 if (SSL_IS_DTLS(s)) {
575 dtls1_stop_timer(s);
576 }
577 return SUB_STATE_FINISHED;
578 }
579 break;
580
581 default:
582 /* Shouldn't happen */
583 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
584 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
fe3a3291 585 ossl_statem_set_error(s);
f8e0a557
MC
586 return SUB_STATE_ERROR;
587 }
588 }
589}
590
591/*
592 * Send a previously constructed message to the peer.
593 */
594static int statem_do_write(SSL *s)
595{
d6f1a6e9 596 OSSL_STATEM *st = &s->statem;
f8e0a557
MC
597
598 if (st->hand_state == TLS_ST_CW_CHANGE
a230b26e 599 || st->hand_state == TLS_ST_SW_CHANGE) {
f8e0a557
MC
600 if (SSL_IS_DTLS(s))
601 return dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
602 else
603 return ssl3_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
604 } else {
605 return ssl_do_write(s);
606 }
607}
608
609/*
610 * Initialise the MSG_FLOW_WRITING sub-state machine
611 */
612static void init_write_state_machine(SSL *s)
613{
d6f1a6e9 614 OSSL_STATEM *st = &s->statem;
f8e0a557
MC
615
616 st->write_state = WRITE_STATE_TRANSITION;
617}
618
619/*
620 * This function implements the sub-state machine when the message flow is in
621 * MSG_FLOW_WRITING. The valid sub-states and transitions are:
622 *
623 * +-> WRITE_STATE_TRANSITION ------> [SUB_STATE_FINISHED]
624 * | |
625 * | v
626 * | WRITE_STATE_PRE_WORK -----> [SUB_STATE_END_HANDSHAKE]
627 * | |
628 * | v
629 * | WRITE_STATE_SEND
630 * | |
631 * | v
632 * | WRITE_STATE_POST_WORK
633 * | |
634 * +-------------+
635 *
636 * WRITE_STATE_TRANSITION transitions the state of the handshake state machine
637
638 * WRITE_STATE_PRE_WORK performs any work necessary to prepare the later
0d4fb843 639 * sending of the message. This could result in an NBIO event occurring in
f8e0a557
MC
640 * which case control returns to the calling application. When this function
641 * is recalled we will resume in the same state where we left off.
642 *
643 * WRITE_STATE_SEND sends the message and performs any work to be done after
644 * sending.
645 *
646 * WRITE_STATE_POST_WORK performs any work necessary after the sending of the
647 * message has been completed. As for WRITE_STATE_PRE_WORK this could also
648 * result in an NBIO event.
649 */
d78052cf 650static SUB_STATE_RETURN write_state_machine(SSL *s)
f8e0a557 651{
d6f1a6e9 652 OSSL_STATEM *st = &s->statem;
f8e0a557 653 int ret;
a230b26e
EK
654 WRITE_TRAN(*transition) (SSL *s);
655 WORK_STATE(*pre_work) (SSL *s, WORK_STATE wst);
656 WORK_STATE(*post_work) (SSL *s, WORK_STATE wst);
6392fb8e
MC
657 int (*get_construct_message_f) (SSL *s, WPACKET *pkt,
658 int (**confunc) (SSL *s, WPACKET *pkt),
659 int *mt);
f8e0a557 660 void (*cb) (const SSL *ssl, int type, int val) = NULL;
6392fb8e
MC
661 int (*confunc) (SSL *s, WPACKET *pkt);
662 int mt;
7cea05dc 663 WPACKET pkt;
f8e0a557 664
91eac8d5 665 cb = get_callback(s);
f8e0a557 666
e8aa8b6c 667 if (s->server) {
8481f583
MC
668 transition = ossl_statem_server_write_transition;
669 pre_work = ossl_statem_server_pre_work;
670 post_work = ossl_statem_server_post_work;
6392fb8e 671 get_construct_message_f = ossl_statem_server_construct_message;
f8e0a557 672 } else {
8481f583
MC
673 transition = ossl_statem_client_write_transition;
674 pre_work = ossl_statem_client_pre_work;
675 post_work = ossl_statem_client_post_work;
6392fb8e 676 get_construct_message_f = ossl_statem_client_construct_message;
f8e0a557
MC
677 }
678
e8aa8b6c
F
679 while (1) {
680 switch (st->write_state) {
f8e0a557
MC
681 case WRITE_STATE_TRANSITION:
682 if (cb != NULL) {
683 /* Notify callback of an impending state change */
684 if (s->server)
685 cb(s, SSL_CB_ACCEPT_LOOP, 1);
686 else
687 cb(s, SSL_CB_CONNECT_LOOP, 1);
688 }
e8aa8b6c 689 switch (transition(s)) {
f8e0a557
MC
690 case WRITE_TRAN_CONTINUE:
691 st->write_state = WRITE_STATE_PRE_WORK;
692 st->write_state_work = WORK_MORE_A;
693 break;
694
695 case WRITE_TRAN_FINISHED:
696 return SUB_STATE_FINISHED;
697 break;
698
f3b3d7f0 699 case WRITE_TRAN_ERROR:
f8e0a557
MC
700 return SUB_STATE_ERROR;
701 }
702 break;
703
704 case WRITE_STATE_PRE_WORK:
e8aa8b6c 705 switch (st->write_state_work = pre_work(s, st->write_state_work)) {
f3b3d7f0
RS
706 case WORK_ERROR:
707 case WORK_MORE_A:
708 case WORK_MORE_B:
f8e0a557
MC
709 return SUB_STATE_ERROR;
710
711 case WORK_FINISHED_CONTINUE:
712 st->write_state = WRITE_STATE_SEND;
713 break;
714
715 case WORK_FINISHED_STOP:
716 return SUB_STATE_END_HANDSHAKE;
717 }
7cea05dc 718 if (!WPACKET_init(&pkt, s->init_buf)
6392fb8e
MC
719 || !get_construct_message_f(s, &pkt, &confunc, &mt)
720 || !ssl_set_handshake_header(s, &pkt, mt)
721 || (confunc != NULL && !confunc(s, &pkt))
722 || !ssl_close_construct_packet(s, &pkt, mt)
7cea05dc
MC
723 || !WPACKET_finish(&pkt)) {
724 WPACKET_cleanup(&pkt);
725 ossl_statem_set_error(s);
f8e0a557 726 return SUB_STATE_ERROR;
7cea05dc 727 }
f8e0a557
MC
728
729 /* Fall through */
730
731 case WRITE_STATE_SEND:
732 if (SSL_IS_DTLS(s) && st->use_timer) {
733 dtls1_start_timer(s);
734 }
735 ret = statem_do_write(s);
736 if (ret <= 0) {
737 return SUB_STATE_ERROR;
738 }
739 st->write_state = WRITE_STATE_POST_WORK;
740 st->write_state_work = WORK_MORE_A;
741 /* Fall through */
742
743 case WRITE_STATE_POST_WORK:
e8aa8b6c 744 switch (st->write_state_work = post_work(s, st->write_state_work)) {
f3b3d7f0
RS
745 case WORK_ERROR:
746 case WORK_MORE_A:
747 case WORK_MORE_B:
f8e0a557
MC
748 return SUB_STATE_ERROR;
749
750 case WORK_FINISHED_CONTINUE:
751 st->write_state = WRITE_STATE_TRANSITION;
752 break;
753
754 case WORK_FINISHED_STOP:
755 return SUB_STATE_END_HANDSHAKE;
756 }
757 break;
758
759 default:
760 return SUB_STATE_ERROR;
761 }
762 }
763}
764
8723588e
MC
765/*
766 * Flush the write BIO
767 */
61ae935a 768int statem_flush(SSL *s)
8723588e
MC
769{
770 s->rwstate = SSL_WRITING;
771 if (BIO_flush(s->wbio) <= 0) {
772 return 0;
773 }
774 s->rwstate = SSL_NOTHING;
775
776 return 1;
777}
778
f8e0a557
MC
779/*
780 * Called by the record layer to determine whether application data is
c7f47786 781 * allowed to be received in the current handshake state or not.
f8e0a557
MC
782 *
783 * Return values are:
784 * 1: Yes (application data allowed)
785 * 0: No (application data not allowed)
786 */
fe3a3291 787int ossl_statem_app_data_allowed(SSL *s)
f8e0a557 788{
d6f1a6e9 789 OSSL_STATEM *st = &s->statem;
f8e0a557 790
c7f47786 791 if (st->state == MSG_FLOW_UNINITED)
8723588e
MC
792 return 0;
793
94836de2
MC
794 if (!s->s3->in_read_app_data || (s->s3->total_renegotiations == 0))
795 return 0;
8723588e 796
94836de2
MC
797 if (s->server) {
798 /*
799 * If we're a server and we haven't got as far as writing our
800 * ServerHello yet then we allow app data
801 */
802 if (st->hand_state == TLS_ST_BEFORE
a230b26e 803 || st->hand_state == TLS_ST_SR_CLNT_HELLO)
94836de2
MC
804 return 1;
805 } else {
806 /*
807 * If we're a client and we haven't read the ServerHello yet then we
808 * allow app data
809 */
810 if (st->hand_state == TLS_ST_CW_CLNT_HELLO)
8723588e 811 return 1;
8723588e
MC
812 }
813
8723588e
MC
814 return 0;
815}
816
8723588e
MC
817#ifndef OPENSSL_NO_SCTP
818/*
819 * Set flag used by SCTP to determine whether we are in the read sock state
820 */
fe3a3291 821void ossl_statem_set_sctp_read_sock(SSL *s, int read_sock)
8723588e
MC
822{
823 s->statem.in_sctp_read_sock = read_sock;
824}
825
826/*
827 * Called by the record layer to determine whether we are in the read sock
828 * state or not.
829 *
830 * Return values are:
831 * 1: Yes (we are in the read sock state)
832 * 0: No (we are not in the read sock state)
833 */
d99b0691 834int ossl_statem_in_sctp_read_sock(SSL *s)
8723588e
MC
835{
836 return s->statem.in_sctp_read_sock;
837}
838#endif