ssl/statem/statem.c

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