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