ssl/statem/statem.c

   1 /* ssl/statem/statem.c */
   2 /*
   3  * Written by Matt Caswell for the OpenSSL project.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1998-2015 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    openssl-core@openssl.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #include <openssl/rand.h>
  60 #include "../ssl_locl.h"
  61 #include "statem_locl.h"
  62
  63 /*
  64  * This file implements the SSL/TLS/DTLS state machines.
  65  *
  66  * There are two primary state machines:
  67  *
  68  * 1) Message flow state machine
  69  * 2) Handshake state machine
  70  *
  71  * The Message flow state machine controls the reading and sending of messages
  72  * including handling of non-blocking IO events, flushing of the underlying
  73  * write BIO, handling unexpected messages, etc. It is itself broken into two
  74  * separate sub-state machines which control reading and writing respectively.
  75  *
  76  * The Handshake state machine keeps track of the current SSL/TLS handshake
  77  * state. Transitions of the handshake state are the result of events that
  78  * occur within the Message flow state machine.
  79  *
  80  * Overall it looks like this:
  81  *
  82  * ---------------------------------------------            -------------------
  83  * |                                           |            |                 |
  84  * | Message flow state machine                |            |                 |
  85  * |                                           |            |                 |
  86  * | -------------------- -------------------- | Transition | Handshake state |
  87  * | | MSG_FLOW_READING | | MSG_FLOW_WRITING | | Event      | machine         |
  88  * | | sub-state        | | sub-state        | |----------->|                 |
  89  * | | machine for      | | machine for      | |            |                 |
  90  * | | reading messages | | writing messages | |            |                 |
  91  * | -------------------- -------------------- |            |                 |
  92  * |                                           |            |                 |
  93  * ---------------------------------------------            -------------------
  94  *
  95  */
  96
  97 /* Sub state machine return values */
  98 typedef enum  {
  99     /* Something bad happened or NBIO */
 100     SUB_STATE_ERROR,
 101     /* Sub state finished go to the next sub state */
 102     SUB_STATE_FINISHED,
 103     /* Sub state finished and handshake was completed */
 104     SUB_STATE_END_HANDSHAKE
 105 } SUB_STATE_RETURN;
 106
 107 static int state_machine(SSL *s, int server);
 108 static void init_read_state_machine(SSL *s);
 109 static SUB_STATE_RETURN read_state_machine(SSL *s);
 110 static void init_write_state_machine(SSL *s);
 111 static SUB_STATE_RETURN write_state_machine(SSL *s);
 112
 113 OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl)
 114 {
 115     return ssl->statem.hand_state;
 116 }
 117
 118 int SSL_in_init(SSL *s)
 119 {
 120     return s->statem.in_init;
 121 }
 122
 123 int SSL_is_init_finished(SSL *s)
 124 {
 125     return !(s->statem.in_init) && (s->statem.hand_state == TLS_ST_OK);
 126 }
 127
 128 int SSL_in_before(SSL *s)
 129 {
 130     /*
 131      * Historically being "in before" meant before anything had happened. In the
 132      * current code though we remain in the "before" state for a while after we
 133      * have started the handshake process (e.g. as a server waiting for the
 134      * first message to arrive). There "in before" is taken to mean "in before"
 135      * and not started any handshake process yet.
 136      */
 137     return (s->statem.hand_state == TLS_ST_BEFORE)
 138         && (s->statem.state == MSG_FLOW_UNINITED);
 139 }
 140
 141 /*
 142  * Clear the state machine state and reset back to MSG_FLOW_UNINITED
 143  */
 144 void ossl_statem_clear(SSL *s)
 145 {
 146     s->statem.state = MSG_FLOW_UNINITED;
 147     s->statem.hand_state = TLS_ST_BEFORE;
 148     s->statem.in_init = 1;
 149     s->statem.no_cert_verify = 0;
 150 }
 151
 152 /*
 153  * Set the state machine up ready for a renegotiation handshake
 154  */
 155 void ossl_statem_set_renegotiate(SSL *s)
 156 {
 157     s->statem.state = MSG_FLOW_RENEGOTIATE;
 158     s->statem.in_init = 1;
 159 }
 160
 161 /*
 162  * Put the state machine into an error state. This is a permanent error for
 163  * the current connection.
 164  */
 165 void ossl_statem_set_error(SSL *s)
 166 {
 167     s->statem.state = MSG_FLOW_ERROR;
 168 }
 169
 170 /*
 171  * Discover whether the current connection is in the error state.
 172  *
 173  * Valid return values are:
 174  *   1: Yes
 175  *   0: No
 176  */
 177 int ossl_statem_in_error(const SSL *s)
 178 {
 179     if (s->statem.state == MSG_FLOW_ERROR)
 180         return 1;
 181
 182     return 0;
 183 }
 184
 185 void ossl_statem_set_in_init(SSL *s, int init)
 186 {
 187     s->statem.in_init = init;
 188 }
 189
 190 int ossl_statem_get_in_handshake(SSL *s)
 191 {
 192     return s->statem.in_handshake;
 193 }
 194
 195 void ossl_statem_set_in_handshake(SSL *s, int inhand)
 196 {
 197     if (inhand)
 198         s->statem.in_handshake++;
 199     else
 200         s->statem.in_handshake--;
 201 }
 202
 203 void ossl_statem_set_hello_verify_done(SSL *s)
 204 {
 205     s->statem.state = MSG_FLOW_UNINITED;
 206     s->statem.in_init = 1;
 207     /*
 208      * This will get reset (briefly) back to TLS_ST_BEFORE when we enter
 209      * state_machine() because |state| is MSG_FLOW_UNINITED, but until then any
 210      * calls to SSL_in_before() will return false. Also calls to
 211      * SSL_state_string() and SSL_state_string_long() will return something
 212      * sensible.
 213      */
 214     s->statem.hand_state = TLS_ST_SR_CLNT_HELLO;
 215 }
 216
 217 int ossl_statem_connect(SSL *s) {
 218     return state_machine(s, 0);
 219 }
 220
 221 int ossl_statem_accept(SSL *s)
 222 {
 223     return state_machine(s, 1);
 224 }
 225
 226 static void (*get_callback(SSL *s))(const SSL *, int, int)
 227 {
 228     if (s->info_callback != NULL)
 229         return s->info_callback;
 230     else if (s->ctx->info_callback != NULL)
 231         return s->ctx->info_callback;
 232
 233     return NULL;
 234 }
 235
 236 /*
 237  * The main message flow state machine. We start in the MSG_FLOW_UNINITED or
 238  * MSG_FLOW_RENEGOTIATE state and finish in MSG_FLOW_FINISHED. Valid states and
 239  * transitions are as follows:
 240  *
 241  * MSG_FLOW_UNINITED     MSG_FLOW_RENEGOTIATE
 242  *        |                       |
 243  *        +-----------------------+
 244  *        v
 245  * MSG_FLOW_WRITING <---> MSG_FLOW_READING
 246  *        |
 247  *        V
 248  * MSG_FLOW_FINISHED
 249  *        |
 250  *        V
 251  *    [SUCCESS]
 252  *
 253  * We may exit at any point due to an error or NBIO event. If an NBIO event
 254  * occurs then we restart at the point we left off when we are recalled.
 255  * MSG_FLOW_WRITING and MSG_FLOW_READING have sub-state machines associated with them.
 256  *
 257  * In addition to the above there is also the MSG_FLOW_ERROR state. We can move
 258  * into that state at any point in the event that an irrecoverable error occurs.
 259  *
 260  * Valid return values are:
 261  *   1: Success
 262  * <=0: NBIO or error
 263  */
 264 static int state_machine(SSL *s, int server)
 265 {
 266     BUF_MEM *buf = NULL;
 267     unsigned long Time = (unsigned long)time(NULL);
 268     void (*cb) (const SSL *ssl, int type, int val) = NULL;
 269     OSSL_STATEM *st = &s->statem;
 270     int ret = -1;
 271     int ssret;
 272
 273     if (st->state == MSG_FLOW_ERROR) {
 274         /* Shouldn't have been called if we're already in the error state */
 275         return -1;
 276     }
 277
 278     RAND_add(&Time, sizeof(Time), 0);
 279     ERR_clear_error();
 280     clear_sys_error();
 281
 282     cb = get_callback(s);
 283
 284     st->in_handshake++;
 285     if (!SSL_in_init(s) || SSL_in_before(s)) {
 286         if (!SSL_clear(s))
 287             return -1;
 288     }
 289
 290 #ifndef OPENSSL_NO_SCTP
 291     if (SSL_IS_DTLS(s)) {
 292         /*
 293          * Notify SCTP BIO socket to enter handshake mode and prevent stream
 294          * identifier other than 0. Will be ignored if no SCTP is used.
 295          */
 296         BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
 297                  st->in_handshake, NULL);
 298     }
 299 #endif
 300
 301 #ifndef OPENSSL_NO_HEARTBEATS
 302     /*
 303      * If we're awaiting a HeartbeatResponse, pretend we already got and
 304      * don't await it anymore, because Heartbeats don't make sense during
 305      * handshakes anyway.
 306      */
 307     if (s->tlsext_hb_pending) {
 308         if (SSL_IS_DTLS(s))
 309             dtls1_stop_timer(s);
 310         s->tlsext_hb_pending = 0;
 311         s->tlsext_hb_seq++;
 312     }
 313 #endif
 314
 315     /* Initialise state machine */
 316
 317     if (st->state == MSG_FLOW_RENEGOTIATE) {
 318         s->renegotiate = 1;
 319         if (!server)
 320             s->ctx->stats.sess_connect_renegotiate++;
 321     }
 322
 323     if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE) {
 324         if (st->state == MSG_FLOW_UNINITED) {
 325             st->hand_state = TLS_ST_BEFORE;
 326         }
 327
 328         s->server = server;
 329         if (cb != NULL)
 330             cb(s, SSL_CB_HANDSHAKE_START, 1);
 331
 332         if (SSL_IS_DTLS(s)) {
 333             if ((s->version & 0xff00) != (DTLS1_VERSION & 0xff00) &&
 334                     (server
 335                     || (s->version & 0xff00) != (DTLS1_BAD_VER & 0xff00))) {
 336                 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
 337                 goto end;
 338             }
 339         } else {
 340             if ((s->version >> 8) != SSL3_VERSION_MAJOR) {
 341                 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
 342                 goto end;
 343             }
 344         }
 345
 346         if (!ssl_security(s, SSL_SECOP_VERSION, 0, s->version, NULL)) {
 347             SSLerr(SSL_F_STATE_MACHINE, SSL_R_VERSION_TOO_LOW);
 348             goto end;
 349         }
 350
 351         if (s->init_buf == NULL) {
 352             if ((buf = BUF_MEM_new()) == NULL) {
 353                 goto end;
 354             }
 355             if (!BUF_MEM_grow(buf, SSL3_RT_MAX_PLAIN_LENGTH)) {
 356                 goto end;
 357             }
 358             s->init_buf = buf;
 359             buf = NULL;
 360         }
 361
 362         if (!ssl3_setup_buffers(s)) {
 363             goto end;
 364         }
 365         s->init_num = 0;
 366
 367         /*
 368          * Should have been reset by tls_process_finished, too.
 369          */
 370         s->s3->change_cipher_spec = 0;
 371
 372         if (!server || st->state != MSG_FLOW_RENEGOTIATE) {
 373                 /*
 374                  * Ok, we now need to push on a buffering BIO ...but not with
 375                  * SCTP
 376                  */
 377 #ifndef OPENSSL_NO_SCTP
 378                 if (!SSL_IS_DTLS(s) || !BIO_dgram_is_sctp(SSL_get_wbio(s)))
 379 #endif
 380                     if (!ssl_init_wbio_buffer(s, server ? 1 : 0)) {
 381                         goto end;
 382                     }
 383
 384             ssl3_init_finished_mac(s);
 385         }
 386
 387         if (server) {
 388             if (st->state != MSG_FLOW_RENEGOTIATE) {
 389                 s->ctx->stats.sess_accept++;
 390             } else if (!s->s3->send_connection_binding &&
 391                        !(s->options &
 392                          SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
 393                 /*
 394                  * Server attempting to renegotiate with client that doesn't
 395                  * support secure renegotiation.
 396                  */
 397                 SSLerr(SSL_F_STATE_MACHINE,
 398                        SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
 399                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
 400                 ossl_statem_set_error(s);
 401                 goto end;
 402             } else {
 403                 /*
 404                  * st->state == MSG_FLOW_RENEGOTIATE, we will just send a
 405                  * HelloRequest
 406                  */
 407                 s->ctx->stats.sess_accept_renegotiate++;
 408             }
 409         } else {
 410             s->ctx->stats.sess_connect++;
 411
 412             /* mark client_random uninitialized */
 413             memset(s->s3->client_random, 0, sizeof(s->s3->client_random));
 414             s->hit = 0;
 415
 416             s->s3->tmp.cert_request = 0;
 417
 418             if (SSL_IS_DTLS(s)) {
 419                 st->use_timer = 1;
 420             }
 421         }
 422
 423         st->state = MSG_FLOW_WRITING;
 424         init_write_state_machine(s);
 425         st->read_state_first_init = 1;
 426     }
 427
 428     while(st->state != MSG_FLOW_FINISHED) {
 429         if(st->state == MSG_FLOW_READING) {
 430             ssret = read_state_machine(s);
 431             if (ssret == SUB_STATE_FINISHED) {
 432                 st->state = MSG_FLOW_WRITING;
 433                 init_write_state_machine(s);
 434             } else {
 435                 /* NBIO or error */
 436                 goto end;
 437             }
 438         } else if (st->state == MSG_FLOW_WRITING) {
 439             ssret = write_state_machine(s);
 440             if (ssret == SUB_STATE_FINISHED) {
 441                 st->state = MSG_FLOW_READING;
 442                 init_read_state_machine(s);
 443             } else if (ssret == SUB_STATE_END_HANDSHAKE) {
 444                 st->state = MSG_FLOW_FINISHED;
 445             } else {
 446                 /* NBIO or error */
 447                 goto end;
 448             }
 449         } else {
 450             /* Error */
 451             ossl_statem_set_error(s);
 452             goto end;
 453         }
 454     }
 455
 456     st->state = MSG_FLOW_UNINITED;
 457     ret = 1;
 458
 459  end:
 460     st->in_handshake--;
 461
 462 #ifndef OPENSSL_NO_SCTP
 463     if (SSL_IS_DTLS(s)) {
 464         /*
 465          * Notify SCTP BIO socket to leave handshake mode and allow stream
 466          * identifier other than 0. Will be ignored if no SCTP is used.
 467          */
 468         BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
 469                  st->in_handshake, NULL);
 470     }
 471 #endif
 472
 473     BUF_MEM_free(buf);
 474     if (cb != NULL) {
 475         if (server)
 476             cb(s, SSL_CB_ACCEPT_EXIT, ret);
 477         else
 478             cb(s, SSL_CB_CONNECT_EXIT, ret);
 479     }
 480     return ret;
 481 }
 482
 483 /*
 484  * Initialise the MSG_FLOW_READING sub-state machine
 485  */
 486 static void init_read_state_machine(SSL *s)
 487 {
 488     OSSL_STATEM *st = &s->statem;
 489
 490     st->read_state = READ_STATE_HEADER;
 491 }
 492
 493 /*
 494  * This function implements the sub-state machine when the message flow is in
 495  * MSG_FLOW_READING. The valid sub-states and transitions are:
 496  *
 497  * READ_STATE_HEADER <--+<-------------+
 498  *        |             |              |
 499  *        v             |              |
 500  * READ_STATE_BODY -----+-->READ_STATE_POST_PROCESS
 501  *        |                            |
 502  *        +----------------------------+
 503  *        v
 504  * [SUB_STATE_FINISHED]
 505  *
 506  * READ_STATE_HEADER has the responsibility for reading in the message header
 507  * and transitioning the state of the handshake state machine.
 508  *
 509  * READ_STATE_BODY reads in the rest of the message and then subsequently
 510  * processes it.
 511  *
 512  * READ_STATE_POST_PROCESS is an optional step that may occur if some post
 513  * processing activity performed on the message may block.
 514  *
 515  * Any of the above states could result in an NBIO event occuring in which case
 516  * control returns to the calling application. When this function is recalled we
 517  * will resume in the same state where we left off.
 518  */
 519 static SUB_STATE_RETURN read_state_machine(SSL *s) {
 520     OSSL_STATEM *st = &s->statem;
 521     int ret, mt;
 522     unsigned long len = 0;
 523     int (*transition)(SSL *s, int mt);
 524     PACKET pkt;
 525     MSG_PROCESS_RETURN (*process_message)(SSL *s, PACKET *pkt);
 526     WORK_STATE (*post_process_message)(SSL *s, WORK_STATE wst);
 527     unsigned long (*max_message_size)(SSL *s);
 528     void (*cb) (const SSL *ssl, int type, int val) = NULL;
 529
 530     cb = get_callback(s);
 531
 532     if(s->server) {
 533         transition = ossl_statem_server_read_transition;
 534         process_message = ossl_statem_server_process_message;
 535         max_message_size = ossl_statem_server_max_message_size;
 536         post_process_message = ossl_statem_server_post_process_message;
 537     } else {
 538         transition = ossl_statem_client_read_transition;
 539         process_message = ossl_statem_client_process_message;
 540         max_message_size = ossl_statem_client_max_message_size;
 541         post_process_message = ossl_statem_client_post_process_message;
 542     }
 543
 544     if (st->read_state_first_init) {
 545         s->first_packet = 1;
 546         st->read_state_first_init = 0;
 547     }
 548
 549     while(1) {
 550         switch(st->read_state) {
 551         case READ_STATE_HEADER:
 552             s->init_num = 0;
 553             /* Get the state the peer wants to move to */
 554             if (SSL_IS_DTLS(s)) {
 555                 /*
 556                  * In DTLS we get the whole message in one go - header and body
 557                  */
 558                 ret = dtls_get_message(s, &mt, &len);
 559             } else {
 560                 ret = tls_get_message_header(s, &mt);
 561             }
 562
 563             if (ret == 0) {
 564                 /* Could be non-blocking IO */
 565                 return SUB_STATE_ERROR;
 566             }
 567
 568             if (cb != NULL) {
 569                 /* Notify callback of an impending state change */
 570                 if (s->server)
 571                     cb(s, SSL_CB_ACCEPT_LOOP, 1);
 572                 else
 573                     cb(s, SSL_CB_CONNECT_LOOP, 1);
 574             }
 575             /*
 576              * Validate that we are allowed to move to the new state and move
 577              * to that state if so
 578              */
 579             if(!transition(s, mt)) {
 580                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL3_AD_UNEXPECTED_MESSAGE);
 581                 SSLerr(SSL_F_READ_STATE_MACHINE, SSL_R_UNEXPECTED_MESSAGE);
 582                 return SUB_STATE_ERROR;
 583             }
 584
 585             if (s->s3->tmp.message_size > max_message_size(s)) {
 586                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
 587                 SSLerr(SSL_F_READ_STATE_MACHINE, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 588                 return SUB_STATE_ERROR;
 589             }
 590
 591             st->read_state = READ_STATE_BODY;
 592             /* Fall through */
 593
 594         case READ_STATE_BODY:
 595             if (!SSL_IS_DTLS(s)) {
 596                 /* We already got this above for DTLS */
 597                 ret = tls_get_message_body(s, &len);
 598                 if (ret == 0) {
 599                     /* Could be non-blocking IO */
 600                     return SUB_STATE_ERROR;
 601                 }
 602             }
 603
 604             s->first_packet = 0;
 605             if (!PACKET_buf_init(&pkt, s->init_msg, len)) {
 606                 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 607                 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
 608                 return SUB_STATE_ERROR;
 609             }
 610             ret = process_message(s, &pkt);
 611             if (ret == MSG_PROCESS_ERROR) {
 612                 return SUB_STATE_ERROR;
 613             }
 614
 615             if (ret == MSG_PROCESS_FINISHED_READING) {
 616                 if (SSL_IS_DTLS(s)) {
 617                     dtls1_stop_timer(s);
 618                 }
 619                 return SUB_STATE_FINISHED;
 620             }
 621
 622             if (ret == MSG_PROCESS_CONTINUE_PROCESSING) {
 623                 st->read_state = READ_STATE_POST_PROCESS;
 624                 st->read_state_work = WORK_MORE_A;
 625             } else {
 626                 st->read_state = READ_STATE_HEADER;
 627             }
 628             break;
 629
 630         case READ_STATE_POST_PROCESS:
 631             st->read_state_work = post_process_message(s, st->read_state_work);
 632             switch(st->read_state_work) {
 633             default:
 634                 return SUB_STATE_ERROR;
 635
 636             case WORK_FINISHED_CONTINUE:
 637                 st->read_state = READ_STATE_HEADER;
 638                 break;
 639
 640             case WORK_FINISHED_STOP:
 641                 if (SSL_IS_DTLS(s)) {
 642                     dtls1_stop_timer(s);
 643                 }
 644                 return SUB_STATE_FINISHED;
 645             }
 646             break;
 647
 648         default:
 649             /* Shouldn't happen */
 650             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 651             SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
 652             ossl_statem_set_error(s);
 653             return SUB_STATE_ERROR;
 654         }
 655     }
 656 }
 657
 658 /*
 659  * Send a previously constructed message to the peer.
 660  */
 661 static int statem_do_write(SSL *s)
 662 {
 663     OSSL_STATEM *st = &s->statem;
 664
 665     if (st->hand_state == TLS_ST_CW_CHANGE
 666             || st->hand_state == TLS_ST_SW_CHANGE) {
 667         if (SSL_IS_DTLS(s))
 668             return dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
 669         else
 670             return ssl3_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
 671     } else {
 672         return ssl_do_write(s);
 673     }
 674 }
 675
 676 /*
 677  * Initialise the MSG_FLOW_WRITING sub-state machine
 678  */
 679 static void init_write_state_machine(SSL *s)
 680 {
 681     OSSL_STATEM *st = &s->statem;
 682
 683     st->write_state = WRITE_STATE_TRANSITION;
 684 }
 685
 686 /*
 687  * This function implements the sub-state machine when the message flow is in
 688  * MSG_FLOW_WRITING. The valid sub-states and transitions are:
 689  *
 690  * +-> WRITE_STATE_TRANSITION ------> [SUB_STATE_FINISHED]
 691  * |             |
 692  * |             v
 693  * |      WRITE_STATE_PRE_WORK -----> [SUB_STATE_END_HANDSHAKE]
 694  * |             |
 695  * |             v
 696  * |       WRITE_STATE_SEND
 697  * |             |
 698  * |             v
 699  * |     WRITE_STATE_POST_WORK
 700  * |             |
 701  * +-------------+
 702  *
 703  * WRITE_STATE_TRANSITION transitions the state of the handshake state machine
 704
 705  * WRITE_STATE_PRE_WORK performs any work necessary to prepare the later
 706  * sending of the message. This could result in an NBIO event occuring in
 707  * which case control returns to the calling application. When this function
 708  * is recalled we will resume in the same state where we left off.
 709  *
 710  * WRITE_STATE_SEND sends the message and performs any work to be done after
 711  * sending.
 712  *
 713  * WRITE_STATE_POST_WORK performs any work necessary after the sending of the
 714  * message has been completed. As for WRITE_STATE_PRE_WORK this could also
 715  * result in an NBIO event.
 716  */
 717 static SUB_STATE_RETURN write_state_machine(SSL *s)
 718 {
 719     OSSL_STATEM *st = &s->statem;
 720     int ret;
 721     WRITE_TRAN (*transition)(SSL *s);
 722     WORK_STATE (*pre_work)(SSL *s, WORK_STATE wst);
 723     WORK_STATE (*post_work)(SSL *s, WORK_STATE wst);
 724     int (*construct_message)(SSL *s);
 725     void (*cb) (const SSL *ssl, int type, int val) = NULL;
 726
 727     cb = get_callback(s);
 728
 729     if(s->server) {
 730         transition = ossl_statem_server_write_transition;
 731         pre_work = ossl_statem_server_pre_work;
 732         post_work = ossl_statem_server_post_work;
 733         construct_message = ossl_statem_server_construct_message;
 734     } else {
 735         transition = ossl_statem_client_write_transition;
 736         pre_work = ossl_statem_client_pre_work;
 737         post_work = ossl_statem_client_post_work;
 738         construct_message = ossl_statem_client_construct_message;
 739     }
 740
 741     while(1) {
 742         switch(st->write_state) {
 743         case WRITE_STATE_TRANSITION:
 744             if (cb != NULL) {
 745                 /* Notify callback of an impending state change */
 746                 if (s->server)
 747                     cb(s, SSL_CB_ACCEPT_LOOP, 1);
 748                 else
 749                     cb(s, SSL_CB_CONNECT_LOOP, 1);
 750             }
 751             switch(transition(s)) {
 752             case WRITE_TRAN_CONTINUE:
 753                 st->write_state = WRITE_STATE_PRE_WORK;
 754                 st->write_state_work = WORK_MORE_A;
 755                 break;
 756
 757             case WRITE_TRAN_FINISHED:
 758                 return SUB_STATE_FINISHED;
 759                 break;
 760
 761             default:
 762                 return SUB_STATE_ERROR;
 763             }
 764             break;
 765
 766         case WRITE_STATE_PRE_WORK:
 767             switch(st->write_state_work = pre_work(s, st->write_state_work)) {
 768             default:
 769                 return SUB_STATE_ERROR;
 770
 771             case WORK_FINISHED_CONTINUE:
 772                 st->write_state = WRITE_STATE_SEND;
 773                 break;
 774
 775             case WORK_FINISHED_STOP:
 776                 return SUB_STATE_END_HANDSHAKE;
 777             }
 778             if(construct_message(s) == 0)
 779                 return SUB_STATE_ERROR;
 780
 781             /* Fall through */
 782
 783         case WRITE_STATE_SEND:
 784             if (SSL_IS_DTLS(s) && st->use_timer) {
 785                 dtls1_start_timer(s);
 786             }
 787             ret = statem_do_write(s);
 788             if (ret <= 0) {
 789                 return SUB_STATE_ERROR;
 790             }
 791             st->write_state = WRITE_STATE_POST_WORK;
 792             st->write_state_work = WORK_MORE_A;
 793             /* Fall through */
 794
 795         case WRITE_STATE_POST_WORK:
 796             switch(st->write_state_work = post_work(s, st->write_state_work)) {
 797             default:
 798                 return SUB_STATE_ERROR;
 799
 800             case WORK_FINISHED_CONTINUE:
 801                 st->write_state = WRITE_STATE_TRANSITION;
 802                 break;
 803
 804             case WORK_FINISHED_STOP:
 805                 return SUB_STATE_END_HANDSHAKE;
 806             }
 807             break;
 808
 809         default:
 810             return SUB_STATE_ERROR;
 811         }
 812     }
 813 }
 814
 815 /*
 816  * Flush the write BIO
 817  */
 818 int statem_flush(SSL *s)
 819 {
 820     s->rwstate = SSL_WRITING;
 821     if (BIO_flush(s->wbio) <= 0) {
 822         return 0;
 823     }
 824     s->rwstate = SSL_NOTHING;
 825
 826     return 1;
 827 }
 828
 829 /*
 830  * Called by the record layer to determine whether application data is
 831  * allowed to be sent in the current handshake state or not.
 832  *
 833  * Return values are:
 834  *   1: Yes (application data allowed)
 835  *   0: No (application data not allowed)
 836  */
 837 int ossl_statem_app_data_allowed(SSL *s)
 838 {
 839     OSSL_STATEM *st = &s->statem;
 840
 841     if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE)
 842         return 0;
 843
 844     if (!s->s3->in_read_app_data || (s->s3->total_renegotiations == 0))
 845         return 0;
 846
 847     if (s->server) {
 848         /*
 849          * If we're a server and we haven't got as far as writing our
 850          * ServerHello yet then we allow app data
 851          */
 852         if (st->hand_state == TLS_ST_BEFORE
 853                 || st->hand_state == TLS_ST_SR_CLNT_HELLO)
 854             return 1;
 855     } else {
 856         /*
 857          * If we're a client and we haven't read the ServerHello yet then we
 858          * allow app data
 859          */
 860         if (st->hand_state == TLS_ST_CW_CLNT_HELLO)
 861             return 1;
 862     }
 863
 864     return 0;
 865 }
 866
 867 #ifndef OPENSSL_NO_SCTP
 868 /*
 869  * Set flag used by SCTP to determine whether we are in the read sock state
 870  */
 871 void ossl_statem_set_sctp_read_sock(SSL *s, int read_sock)
 872 {
 873     s->statem.in_sctp_read_sock = read_sock;
 874 }
 875
 876 /*
 877  * Called by the record layer to determine whether we are in the read sock
 878  * state or not.
 879  *
 880  * Return values are:
 881  *   1: Yes (we are in the read sock state)
 882  *   0: No (we are not in the read sock state)
 883  */
 884 int ossl_statem_in_sctp_read_sock(SSL *s)
 885 {
 886     return s->statem.in_sctp_read_sock;
 887 }
 888 #endif