ssl/statem/statem.c

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