a1da2a4418d112eac0f88beb28b6428065bbc0f6
[openssl.git] / ssl / statem / statem.c
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 #include <openssl/rand.h>
11 #include "../ssl_locl.h"
12 #include "statem_locl.h"
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 |
38  * | | MSG_FLOW_READING | | MSG_FLOW_WRITING | | Event      | machine         |
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 */
49 typedef enum {
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
56 } SUB_STATE_RETURN;
57
58 static int state_machine(SSL *s, int server);
59 static void init_read_state_machine(SSL *s);
60 static SUB_STATE_RETURN read_state_machine(SSL *s);
61 static void init_write_state_machine(SSL *s);
62 static SUB_STATE_RETURN write_state_machine(SSL *s);
63
64 OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl)
65 {
66     return ssl->statem.hand_state;
67 }
68
69 int SSL_in_init(SSL *s)
70 {
71     return s->statem.in_init;
72 }
73
74 int SSL_is_init_finished(SSL *s)
75 {
76     return !(s->statem.in_init) && (s->statem.hand_state == TLS_ST_OK);
77 }
78
79 int 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
92 /*
93  * Clear the state machine state and reset back to MSG_FLOW_UNINITED
94  */
95 void ossl_statem_clear(SSL *s)
96 {
97     s->statem.state = MSG_FLOW_UNINITED;
98     s->statem.hand_state = TLS_ST_BEFORE;
99     s->statem.in_init = 1;
100     s->statem.no_cert_verify = 0;
101 }
102
103 /*
104  * Set the state machine up ready for a renegotiation handshake
105  */
106 void ossl_statem_set_renegotiate(SSL *s)
107 {
108     s->statem.state = MSG_FLOW_RENEGOTIATE;
109     s->statem.in_init = 1;
110 }
111
112 /*
113  * Put the state machine into an error state. This is a permanent error for
114  * the current connection.
115  */
116 void ossl_statem_set_error(SSL *s)
117 {
118     s->statem.state = MSG_FLOW_ERROR;
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  */
128 int ossl_statem_in_error(const SSL *s)
129 {
130     if (s->statem.state == MSG_FLOW_ERROR)
131         return 1;
132
133     return 0;
134 }
135
136 void ossl_statem_set_in_init(SSL *s, int init)
137 {
138     s->statem.in_init = init;
139 }
140
141 int ossl_statem_get_in_handshake(SSL *s)
142 {
143     return s->statem.in_handshake;
144 }
145
146 void 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
154 void 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
168 int ossl_statem_connect(SSL *s)
169 {
170     return state_machine(s, 0);
171 }
172
173 int ossl_statem_accept(SSL *s)
174 {
175     return state_machine(s, 1);
176 }
177
178 typedef void (*info_cb) (const SSL *, int, int);
179
180 static info_cb get_callback(SSL *s)
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
190 /*
191  * The main message flow state machine. We start in the MSG_FLOW_UNINITED or
192  * MSG_FLOW_RENEGOTIATE state and finish in MSG_FLOW_FINISHED. Valid states and
193  * transitions are as follows:
194  *
195  * MSG_FLOW_UNINITED     MSG_FLOW_RENEGOTIATE
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  */
218 static int state_machine(SSL *s, int server)
219 {
220     BUF_MEM *buf = NULL;
221     unsigned long Time = (unsigned long)time(NULL);
222     void (*cb) (const SSL *ssl, int type, int val) = NULL;
223     OSSL_STATEM *st = &s->statem;
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
236     cb = get_callback(s);
237
238     st->in_handshake++;
239     if (!SSL_in_init(s) || SSL_in_before(s)) {
240         if (!SSL_clear(s))
241             return -1;
242     }
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,
250                  st->in_handshake, NULL);
251     }
252 #endif
253
254     /* Initialise state machine */
255
256     if (st->state == MSG_FLOW_RENEGOTIATE) {
257         s->renegotiate = 1;
258         if (!server)
259             s->ctx->stats.sess_connect_renegotiate++;
260     }
261
262     if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE) {
263         if (st->state == MSG_FLOW_UNINITED) {
264             st->hand_state = TLS_ST_BEFORE;
265         }
266
267         s->server = server;
268         if (cb != NULL)
269             cb(s, SSL_CB_HANDSHAKE_START, 1);
270
271         if (SSL_IS_DTLS(s)) {
272             if ((s->version & 0xff00) != (DTLS1_VERSION & 0xff00) &&
273                 (server || (s->version & 0xff00) != (DTLS1_BAD_VER & 0xff00))) {
274                 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
275                 goto end;
276             }
277         } else {
278             if ((s->version >> 8) != SSL3_VERSION_MAJOR) {
279                 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
280                 goto end;
281             }
282         }
283
284         if (!ssl_security(s, SSL_SECOP_VERSION, 0, s->version, NULL)) {
285             SSLerr(SSL_F_STATE_MACHINE, SSL_R_VERSION_TOO_LOW);
286             goto end;
287         }
288
289         if (s->init_buf == NULL) {
290             if ((buf = BUF_MEM_new()) == NULL) {
291                 goto end;
292             }
293             if (!BUF_MEM_grow(buf, SSL3_RT_MAX_PLAIN_LENGTH)) {
294                 goto end;
295             }
296             s->init_buf = buf;
297             buf = NULL;
298         }
299
300         if (!ssl3_setup_buffers(s)) {
301             goto end;
302         }
303         s->init_num = 0;
304
305         /*
306          * Should have been reset by tls_process_finished, too.
307          */
308         s->s3->change_cipher_spec = 0;
309
310         /*
311          * Ok, we now need to push on a buffering BIO ...but not with
312          * SCTP
313          */
314 #ifndef OPENSSL_NO_SCTP
315         if (!SSL_IS_DTLS(s) || !BIO_dgram_is_sctp(SSL_get_wbio(s)))
316 #endif
317             if (!ssl_init_wbio_buffer(s)) {
318                 goto end;
319             }
320
321         if (!server || st->state != MSG_FLOW_RENEGOTIATE) {
322             if (!ssl3_init_finished_mac(s)) {
323                 ossl_statem_set_error(s);
324                 goto end;
325             }
326         }
327
328         if (server) {
329             if (st->state != MSG_FLOW_RENEGOTIATE) {
330                 s->ctx->stats.sess_accept++;
331             } else if (!s->s3->send_connection_binding &&
332                        !(s->options &
333                          SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
334                 /*
335                  * Server attempting to renegotiate with client that doesn't
336                  * support secure renegotiation.
337                  */
338                 SSLerr(SSL_F_STATE_MACHINE,
339                        SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
340                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
341                 ossl_statem_set_error(s);
342                 goto end;
343             } else {
344                 /*
345                  * st->state == MSG_FLOW_RENEGOTIATE, we will just send a
346                  * HelloRequest
347                  */
348                 s->ctx->stats.sess_accept_renegotiate++;
349             }
350         } else {
351             s->ctx->stats.sess_connect++;
352
353             /* mark client_random uninitialized */
354             memset(s->s3->client_random, 0, sizeof(s->s3->client_random));
355             s->hit = 0;
356
357             s->s3->tmp.cert_request = 0;
358
359             if (SSL_IS_DTLS(s)) {
360                 st->use_timer = 1;
361             }
362         }
363
364         st->state = MSG_FLOW_WRITING;
365         init_write_state_machine(s);
366         st->read_state_first_init = 1;
367     }
368
369     while (st->state != MSG_FLOW_FINISHED) {
370         if (st->state == MSG_FLOW_READING) {
371             ssret = read_state_machine(s);
372             if (ssret == SUB_STATE_FINISHED) {
373                 st->state = MSG_FLOW_WRITING;
374                 init_write_state_machine(s);
375             } else {
376                 /* NBIO or error */
377                 goto end;
378             }
379         } else if (st->state == MSG_FLOW_WRITING) {
380             ssret = write_state_machine(s);
381             if (ssret == SUB_STATE_FINISHED) {
382                 st->state = MSG_FLOW_READING;
383                 init_read_state_machine(s);
384             } else if (ssret == SUB_STATE_END_HANDSHAKE) {
385                 st->state = MSG_FLOW_FINISHED;
386             } else {
387                 /* NBIO or error */
388                 goto end;
389             }
390         } else {
391             /* Error */
392             ossl_statem_set_error(s);
393             goto end;
394         }
395     }
396
397     st->state = MSG_FLOW_UNINITED;
398     ret = 1;
399
400  end:
401     st->in_handshake--;
402
403 #ifndef OPENSSL_NO_SCTP
404     if (SSL_IS_DTLS(s)) {
405         /*
406          * Notify SCTP BIO socket to leave handshake mode and allow stream
407          * identifier other than 0. Will be ignored if no SCTP is used.
408          */
409         BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
410                  st->in_handshake, NULL);
411     }
412 #endif
413
414     BUF_MEM_free(buf);
415     if (cb != NULL) {
416         if (server)
417             cb(s, SSL_CB_ACCEPT_EXIT, ret);
418         else
419             cb(s, SSL_CB_CONNECT_EXIT, ret);
420     }
421     return ret;
422 }
423
424 /*
425  * Initialise the MSG_FLOW_READING sub-state machine
426  */
427 static void init_read_state_machine(SSL *s)
428 {
429     OSSL_STATEM *st = &s->statem;
430
431     st->read_state = READ_STATE_HEADER;
432 }
433
434 static int grow_init_buf(SSL *s, size_t size) {
435
436     size_t msg_offset = (char *)s->init_msg - s->init_buf->data;
437
438     if (!BUF_MEM_grow_clean(s->init_buf, (int)size))
439         return 0;
440
441     if (size < msg_offset)
442         return 0;
443
444     s->init_msg = s->init_buf->data + msg_offset;
445
446     return 1;
447 }
448
449 /*
450  * This function implements the sub-state machine when the message flow is in
451  * MSG_FLOW_READING. The valid sub-states and transitions are:
452  *
453  * READ_STATE_HEADER <--+<-------------+
454  *        |             |              |
455  *        v             |              |
456  * READ_STATE_BODY -----+-->READ_STATE_POST_PROCESS
457  *        |                            |
458  *        +----------------------------+
459  *        v
460  * [SUB_STATE_FINISHED]
461  *
462  * READ_STATE_HEADER has the responsibility for reading in the message header
463  * and transitioning the state of the handshake state machine.
464  *
465  * READ_STATE_BODY reads in the rest of the message and then subsequently
466  * processes it.
467  *
468  * READ_STATE_POST_PROCESS is an optional step that may occur if some post
469  * processing activity performed on the message may block.
470  *
471  * Any of the above states could result in an NBIO event occurring in which case
472  * control returns to the calling application. When this function is recalled we
473  * will resume in the same state where we left off.
474  */
475 static SUB_STATE_RETURN read_state_machine(SSL *s)
476 {
477     OSSL_STATEM *st = &s->statem;
478     int ret, mt;
479     size_t len = 0;
480     int (*transition) (SSL *s, int mt);
481     PACKET pkt;
482     MSG_PROCESS_RETURN(*process_message) (SSL *s, PACKET *pkt);
483     WORK_STATE(*post_process_message) (SSL *s, WORK_STATE wst);
484     size_t (*max_message_size) (SSL *s);
485     void (*cb) (const SSL *ssl, int type, int val) = NULL;
486
487     cb = get_callback(s);
488
489     if (s->server) {
490         transition = ossl_statem_server_read_transition;
491         process_message = ossl_statem_server_process_message;
492         max_message_size = ossl_statem_server_max_message_size;
493         post_process_message = ossl_statem_server_post_process_message;
494     } else {
495         transition = ossl_statem_client_read_transition;
496         process_message = ossl_statem_client_process_message;
497         max_message_size = ossl_statem_client_max_message_size;
498         post_process_message = ossl_statem_client_post_process_message;
499     }
500
501     if (st->read_state_first_init) {
502         s->first_packet = 1;
503         st->read_state_first_init = 0;
504     }
505
506     while (1) {
507         switch (st->read_state) {
508         case READ_STATE_HEADER:
509             /* Get the state the peer wants to move to */
510             if (SSL_IS_DTLS(s)) {
511                 /*
512                  * In DTLS we get the whole message in one go - header and body
513                  */
514                 ret = dtls_get_message(s, &mt, &len);
515             } else {
516                 ret = tls_get_message_header(s, &mt);
517             }
518
519             if (ret == 0) {
520                 /* Could be non-blocking IO */
521                 return SUB_STATE_ERROR;
522             }
523
524             if (cb != NULL) {
525                 /* Notify callback of an impending state change */
526                 if (s->server)
527                     cb(s, SSL_CB_ACCEPT_LOOP, 1);
528                 else
529                     cb(s, SSL_CB_CONNECT_LOOP, 1);
530             }
531             /*
532              * Validate that we are allowed to move to the new state and move
533              * to that state if so
534              */
535             if (!transition(s, mt)) {
536                 ossl_statem_set_error(s);
537                 return SUB_STATE_ERROR;
538             }
539
540             if (s->s3->tmp.message_size > max_message_size(s)) {
541                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
542                 SSLerr(SSL_F_READ_STATE_MACHINE, SSL_R_EXCESSIVE_MESSAGE_SIZE);
543                 return SUB_STATE_ERROR;
544             }
545
546             /* dtls_get_message already did this */
547             if (!SSL_IS_DTLS(s)
548                     && s->s3->tmp.message_size > 0
549                     && !grow_init_buf(s, s->s3->tmp.message_size
550                                          + SSL3_HM_HEADER_LENGTH)) {
551                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
552                 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_BUF_LIB);
553                 return SUB_STATE_ERROR;
554             }
555
556             st->read_state = READ_STATE_BODY;
557             /* Fall through */
558
559         case READ_STATE_BODY:
560             if (!SSL_IS_DTLS(s)) {
561                 /* We already got this above for DTLS */
562                 ret = tls_get_message_body(s, &len);
563                 if (ret == 0) {
564                     /* Could be non-blocking IO */
565                     return SUB_STATE_ERROR;
566                 }
567             }
568
569             s->first_packet = 0;
570             if (!PACKET_buf_init(&pkt, s->init_msg, len)) {
571                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
572                 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
573                 return SUB_STATE_ERROR;
574             }
575             ret = process_message(s, &pkt);
576
577             /* Discard the packet data */
578             s->init_num = 0;
579
580             switch (ret) {
581             case MSG_PROCESS_ERROR:
582                 return SUB_STATE_ERROR;
583
584             case MSG_PROCESS_FINISHED_READING:
585                 if (SSL_IS_DTLS(s)) {
586                     dtls1_stop_timer(s);
587                 }
588                 return SUB_STATE_FINISHED;
589
590             case MSG_PROCESS_CONTINUE_PROCESSING:
591                 st->read_state = READ_STATE_POST_PROCESS;
592                 st->read_state_work = WORK_MORE_A;
593                 break;
594
595             default:
596                 st->read_state = READ_STATE_HEADER;
597                 break;
598             }
599             break;
600
601         case READ_STATE_POST_PROCESS:
602             st->read_state_work = post_process_message(s, st->read_state_work);
603             switch (st->read_state_work) {
604             case WORK_ERROR:
605             case WORK_MORE_A:
606             case WORK_MORE_B:
607                 return SUB_STATE_ERROR;
608
609             case WORK_FINISHED_CONTINUE:
610                 st->read_state = READ_STATE_HEADER;
611                 break;
612
613             case WORK_FINISHED_STOP:
614                 if (SSL_IS_DTLS(s)) {
615                     dtls1_stop_timer(s);
616                 }
617                 return SUB_STATE_FINISHED;
618             }
619             break;
620
621         default:
622             /* Shouldn't happen */
623             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
624             SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
625             ossl_statem_set_error(s);
626             return SUB_STATE_ERROR;
627         }
628     }
629 }
630
631 /*
632  * Send a previously constructed message to the peer.
633  */
634 static int statem_do_write(SSL *s)
635 {
636     OSSL_STATEM *st = &s->statem;
637
638     if (st->hand_state == TLS_ST_CW_CHANGE
639         || st->hand_state == TLS_ST_SW_CHANGE) {
640         if (SSL_IS_DTLS(s))
641             return dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
642         else
643             return ssl3_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
644     } else {
645         return ssl_do_write(s);
646     }
647 }
648
649 /*
650  * Initialise the MSG_FLOW_WRITING sub-state machine
651  */
652 static void init_write_state_machine(SSL *s)
653 {
654     OSSL_STATEM *st = &s->statem;
655
656     st->write_state = WRITE_STATE_TRANSITION;
657 }
658
659 /*
660  * This function implements the sub-state machine when the message flow is in
661  * MSG_FLOW_WRITING. The valid sub-states and transitions are:
662  *
663  * +-> WRITE_STATE_TRANSITION ------> [SUB_STATE_FINISHED]
664  * |             |
665  * |             v
666  * |      WRITE_STATE_PRE_WORK -----> [SUB_STATE_END_HANDSHAKE]
667  * |             |
668  * |             v
669  * |       WRITE_STATE_SEND
670  * |             |
671  * |             v
672  * |     WRITE_STATE_POST_WORK
673  * |             |
674  * +-------------+
675  *
676  * WRITE_STATE_TRANSITION transitions the state of the handshake state machine
677
678  * WRITE_STATE_PRE_WORK performs any work necessary to prepare the later
679  * sending of the message. This could result in an NBIO event occurring in
680  * which case control returns to the calling application. When this function
681  * is recalled we will resume in the same state where we left off.
682  *
683  * WRITE_STATE_SEND sends the message and performs any work to be done after
684  * sending.
685  *
686  * WRITE_STATE_POST_WORK performs any work necessary after the sending of the
687  * message has been completed. As for WRITE_STATE_PRE_WORK this could also
688  * result in an NBIO event.
689  */
690 static SUB_STATE_RETURN write_state_machine(SSL *s)
691 {
692     OSSL_STATEM *st = &s->statem;
693     int ret;
694     WRITE_TRAN(*transition) (SSL *s);
695     WORK_STATE(*pre_work) (SSL *s, WORK_STATE wst);
696     WORK_STATE(*post_work) (SSL *s, WORK_STATE wst);
697     int (*get_construct_message_f) (SSL *s, WPACKET *pkt,
698                                     int (**confunc) (SSL *s, WPACKET *pkt),
699                                     int *mt);
700     void (*cb) (const SSL *ssl, int type, int val) = NULL;
701     int (*confunc) (SSL *s, WPACKET *pkt);
702     int mt;
703     WPACKET pkt;
704
705     cb = get_callback(s);
706
707     if (s->server) {
708         transition = ossl_statem_server_write_transition;
709         pre_work = ossl_statem_server_pre_work;
710         post_work = ossl_statem_server_post_work;
711         get_construct_message_f = ossl_statem_server_construct_message;
712     } else {
713         transition = ossl_statem_client_write_transition;
714         pre_work = ossl_statem_client_pre_work;
715         post_work = ossl_statem_client_post_work;
716         get_construct_message_f = ossl_statem_client_construct_message;
717     }
718
719     while (1) {
720         switch (st->write_state) {
721         case WRITE_STATE_TRANSITION:
722             if (cb != NULL) {
723                 /* Notify callback of an impending state change */
724                 if (s->server)
725                     cb(s, SSL_CB_ACCEPT_LOOP, 1);
726                 else
727                     cb(s, SSL_CB_CONNECT_LOOP, 1);
728             }
729             switch (transition(s)) {
730             case WRITE_TRAN_CONTINUE:
731                 st->write_state = WRITE_STATE_PRE_WORK;
732                 st->write_state_work = WORK_MORE_A;
733                 break;
734
735             case WRITE_TRAN_FINISHED:
736                 return SUB_STATE_FINISHED;
737                 break;
738
739             case WRITE_TRAN_ERROR:
740                 return SUB_STATE_ERROR;
741             }
742             break;
743
744         case WRITE_STATE_PRE_WORK:
745             switch (st->write_state_work = pre_work(s, st->write_state_work)) {
746             case WORK_ERROR:
747             case WORK_MORE_A:
748             case WORK_MORE_B:
749                 return SUB_STATE_ERROR;
750
751             case WORK_FINISHED_CONTINUE:
752                 st->write_state = WRITE_STATE_SEND;
753                 break;
754
755             case WORK_FINISHED_STOP:
756                 return SUB_STATE_END_HANDSHAKE;
757             }
758             if (!WPACKET_init(&pkt, s->init_buf)
759                     || !get_construct_message_f(s, &pkt, &confunc, &mt)
760                     || !ssl_set_handshake_header(s, &pkt, mt)
761                     || (confunc != NULL && !confunc(s, &pkt))
762                     || !ssl_close_construct_packet(s, &pkt, mt)
763                     || !WPACKET_finish(&pkt)) {
764                 WPACKET_cleanup(&pkt);
765                 ossl_statem_set_error(s);
766                 return SUB_STATE_ERROR;
767             }
768
769             /* Fall through */
770
771         case WRITE_STATE_SEND:
772             if (SSL_IS_DTLS(s) && st->use_timer) {
773                 dtls1_start_timer(s);
774             }
775             ret = statem_do_write(s);
776             if (ret <= 0) {
777                 return SUB_STATE_ERROR;
778             }
779             st->write_state = WRITE_STATE_POST_WORK;
780             st->write_state_work = WORK_MORE_A;
781             /* Fall through */
782
783         case WRITE_STATE_POST_WORK:
784             switch (st->write_state_work = post_work(s, st->write_state_work)) {
785             case WORK_ERROR:
786             case WORK_MORE_A:
787             case WORK_MORE_B:
788                 return SUB_STATE_ERROR;
789
790             case WORK_FINISHED_CONTINUE:
791                 st->write_state = WRITE_STATE_TRANSITION;
792                 break;
793
794             case WORK_FINISHED_STOP:
795                 return SUB_STATE_END_HANDSHAKE;
796             }
797             break;
798
799         default:
800             return SUB_STATE_ERROR;
801         }
802     }
803 }
804
805 /*
806  * Flush the write BIO
807  */
808 int statem_flush(SSL *s)
809 {
810     s->rwstate = SSL_WRITING;
811     if (BIO_flush(s->wbio) <= 0) {
812         return 0;
813     }
814     s->rwstate = SSL_NOTHING;
815
816     return 1;
817 }
818
819 /*
820  * Called by the record layer to determine whether application data is
821  * allowed to be sent in the current handshake state or not.
822  *
823  * Return values are:
824  *   1: Yes (application data allowed)
825  *   0: No (application data not allowed)
826  */
827 int ossl_statem_app_data_allowed(SSL *s)
828 {
829     OSSL_STATEM *st = &s->statem;
830
831     if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE)
832         return 0;
833
834     if (!s->s3->in_read_app_data || (s->s3->total_renegotiations == 0))
835         return 0;
836
837     if (s->server) {
838         /*
839          * If we're a server and we haven't got as far as writing our
840          * ServerHello yet then we allow app data
841          */
842         if (st->hand_state == TLS_ST_BEFORE
843             || st->hand_state == TLS_ST_SR_CLNT_HELLO)
844             return 1;
845     } else {
846         /*
847          * If we're a client and we haven't read the ServerHello yet then we
848          * allow app data
849          */
850         if (st->hand_state == TLS_ST_CW_CLNT_HELLO)
851             return 1;
852     }
853
854     return 0;
855 }
856
857 #ifndef OPENSSL_NO_SCTP
858 /*
859  * Set flag used by SCTP to determine whether we are in the read sock state
860  */
861 void ossl_statem_set_sctp_read_sock(SSL *s, int read_sock)
862 {
863     s->statem.in_sctp_read_sock = read_sock;
864 }
865
866 /*
867  * Called by the record layer to determine whether we are in the read sock
868  * state or not.
869  *
870  * Return values are:
871  *   1: Yes (we are in the read sock state)
872  *   0: No (we are not in the read sock state)
873  */
874 int ossl_statem_in_sctp_read_sock(SSL *s)
875 {
876     return s->statem.in_sctp_read_sock;
877 }
878 #endif