ssl/statem/statem.c

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