You need to sign in or sign up before continuing.
statem.c 24.8 KB
Newer Older
1
/*
R
Rich Salz 已提交
2
 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
3
 *
R
Rich Salz 已提交
4 5 6 7
 * Licensed under the OpenSSL license (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
8 9 10
 */

#include <openssl/rand.h>
M
Matt Caswell 已提交
11
#include "../ssl_locl.h"
M
Matt Caswell 已提交
12
#include "statem_locl.h"
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

/*
 * This file implements the SSL/TLS/DTLS state machines.
 *
 * There are two primary state machines:
 *
 * 1) Message flow state machine
 * 2) Handshake state machine
 *
 * The Message flow state machine controls the reading and sending of messages
 * including handling of non-blocking IO events, flushing of the underlying
 * write BIO, handling unexpected messages, etc. It is itself broken into two
 * separate sub-state machines which control reading and writing respectively.
 *
 * The Handshake state machine keeps track of the current SSL/TLS handshake
 * state. Transitions of the handshake state are the result of events that
 * occur within the Message flow state machine.
 *
 * Overall it looks like this:
 *
 * ---------------------------------------------            -------------------
 * |                                           |            |                 |
 * | Message flow state machine                |            |                 |
 * |                                           |            |                 |
 * | -------------------- -------------------- | Transition | Handshake state |
M
Matt Caswell 已提交
38
 * | | MSG_FLOW_READING | | MSG_FLOW_WRITING | | Event      | machine         |
39 40 41 42 43 44 45 46 47 48
 * | | sub-state        | | sub-state        | |----------->|                 |
 * | | machine for      | | machine for      | |            |                 |
 * | | reading messages | | writing messages | |            |                 |
 * | -------------------- -------------------- |            |                 |
 * |                                           |            |                 |
 * ---------------------------------------------            -------------------
 *
 */

/* Sub state machine return values */
E
Emilia Kasper 已提交
49
typedef enum {
50 51 52 53 54 55
    /* Something bad happened or NBIO */
    SUB_STATE_ERROR,
    /* Sub state finished go to the next sub state */
    SUB_STATE_FINISHED,
    /* Sub state finished and handshake was completed */
    SUB_STATE_END_HANDSHAKE
56
} SUB_STATE_RETURN;
57

M
Matt Caswell 已提交
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);
M
Matt Caswell 已提交
63

M
Matt Caswell 已提交
64
OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl)
M
Matt Caswell 已提交
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
{
    return ssl->statem.hand_state;
}

int SSL_in_init(SSL *s)
{
    return s->statem.in_init;
}

int SSL_is_init_finished(SSL *s)
{
    return !(s->statem.in_init) && (s->statem.hand_state == TLS_ST_OK);
}

int SSL_in_before(SSL *s)
{
    /*
     * Historically being "in before" meant before anything had happened. In the
     * current code though we remain in the "before" state for a while after we
     * have started the handshake process (e.g. as a server waiting for the
     * first message to arrive). There "in before" is taken to mean "in before"
     * and not started any handshake process yet.
     */
    return (s->statem.hand_state == TLS_ST_BEFORE)
        && (s->statem.state == MSG_FLOW_UNINITED);
}

92 93 94
/*
 * Clear the state machine state and reset back to MSG_FLOW_UNINITED
 */
M
Matt Caswell 已提交
95
void ossl_statem_clear(SSL *s)
96 97
{
    s->statem.state = MSG_FLOW_UNINITED;
M
Matt Caswell 已提交
98 99
    s->statem.hand_state = TLS_ST_BEFORE;
    s->statem.in_init = 1;
100
    s->statem.no_cert_verify = 0;
101 102 103 104 105
}

/*
 * Set the state machine up ready for a renegotiation handshake
 */
M
Matt Caswell 已提交
106
void ossl_statem_set_renegotiate(SSL *s)
107 108
{
    s->statem.state = MSG_FLOW_RENEGOTIATE;
M
Matt Caswell 已提交
109
    s->statem.in_init = 1;
110 111 112 113 114 115
}

/*
 * Put the state machine into an error state. This is a permanent error for
 * the current connection.
 */
M
Matt Caswell 已提交
116
void ossl_statem_set_error(SSL *s)
117 118
{
    s->statem.state = MSG_FLOW_ERROR;
M
Matt Caswell 已提交
119 120 121 122 123 124 125 126 127
}

/*
 * Discover whether the current connection is in the error state.
 *
 * Valid return values are:
 *   1: Yes
 *   0: No
 */
M
Matt Caswell 已提交
128
int ossl_statem_in_error(const SSL *s)
M
Matt Caswell 已提交
129 130 131 132 133 134 135
{
    if (s->statem.state == MSG_FLOW_ERROR)
        return 1;

    return 0;
}

M
Matt Caswell 已提交
136
void ossl_statem_set_in_init(SSL *s, int init)
M
Matt Caswell 已提交
137 138
{
    s->statem.in_init = init;
139 140
}

M
Matt Caswell 已提交
141 142 143 144 145 146 147 148 149 150 151 152 153
int ossl_statem_get_in_handshake(SSL *s)
{
    return s->statem.in_handshake;
}

void ossl_statem_set_in_handshake(SSL *s, int inhand)
{
    if (inhand)
        s->statem.in_handshake++;
    else
        s->statem.in_handshake--;
}

154 155 156 157 158 159 160 161 162 163 164 165 166 167
void ossl_statem_set_hello_verify_done(SSL *s)
{
    s->statem.state = MSG_FLOW_UNINITED;
    s->statem.in_init = 1;
    /*
     * This will get reset (briefly) back to TLS_ST_BEFORE when we enter
     * state_machine() because |state| is MSG_FLOW_UNINITED, but until then any
     * calls to SSL_in_before() will return false. Also calls to
     * SSL_state_string() and SSL_state_string_long() will return something
     * sensible.
     */
    s->statem.hand_state = TLS_ST_SR_CLNT_HELLO;
}

E
Emilia Kasper 已提交
168 169
int ossl_statem_connect(SSL *s)
{
M
Matt Caswell 已提交
170 171 172
    return state_machine(s, 0);
}

M
Matt Caswell 已提交
173
int ossl_statem_accept(SSL *s)
174 175 176 177
{
    return state_machine(s, 1);
}

E
Emilia Kasper 已提交
178 179 180
typedef void (*info_cb) (const SSL *, int, int);

static info_cb get_callback(SSL *s)
181 182 183 184 185 186 187 188 189
{
    if (s->info_callback != NULL)
        return s->info_callback;
    else if (s->ctx->info_callback != NULL)
        return s->ctx->info_callback;

    return NULL;
}

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
/*
 * The main message flow state machine. We start in the MSG_FLOW_UNINITED or
 * MSG_FLOW_RENEGOTIATE state and finish in MSG_FLOW_FINISHED. Valid states and
 * transitions are as follows:
 *
 * MSG_FLOW_UNINITED     MSG_FLOW_RENEGOTIATE
 *        |                       |
 *        +-----------------------+
 *        v
 * MSG_FLOW_WRITING <---> MSG_FLOW_READING
 *        |
 *        V
 * MSG_FLOW_FINISHED
 *        |
 *        V
 *    [SUCCESS]
 *
 * We may exit at any point due to an error or NBIO event. If an NBIO event
 * occurs then we restart at the point we left off when we are recalled.
 * MSG_FLOW_WRITING and MSG_FLOW_READING have sub-state machines associated with them.
 *
 * In addition to the above there is also the MSG_FLOW_ERROR state. We can move
 * into that state at any point in the event that an irrecoverable error occurs.
 *
 * Valid return values are:
 *   1: Success
 * <=0: NBIO or error
 */
218 219
static int state_machine(SSL *s, int server)
{
220 221 222
    BUF_MEM *buf = NULL;
    unsigned long Time = (unsigned long)time(NULL);
    void (*cb) (const SSL *ssl, int type, int val) = NULL;
M
Matt Caswell 已提交
223
    OSSL_STATEM *st = &s->statem;
224 225 226 227 228 229 230 231 232 233 234 235
    int ret = -1;
    int ssret;

    if (st->state == MSG_FLOW_ERROR) {
        /* Shouldn't have been called if we're already in the error state */
        return -1;
    }

    RAND_add(&Time, sizeof(Time), 0);
    ERR_clear_error();
    clear_sys_error();

236
    cb = get_callback(s);
237

M
Matt Caswell 已提交
238
    st->in_handshake++;
239 240 241 242
    if (!SSL_in_init(s) || SSL_in_before(s)) {
        if (!SSL_clear(s))
            return -1;
    }
243 244 245 246 247 248 249
#ifndef OPENSSL_NO_SCTP
    if (SSL_IS_DTLS(s)) {
        /*
         * Notify SCTP BIO socket to enter handshake mode and prevent stream
         * identifier other than 0. Will be ignored if no SCTP is used.
         */
        BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
M
Matt Caswell 已提交
250
                 st->in_handshake, NULL);
251 252 253
    }
#endif

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
#ifndef OPENSSL_NO_HEARTBEATS
    /*
     * If we're awaiting a HeartbeatResponse, pretend we already got and
     * don't await it anymore, because Heartbeats don't make sense during
     * handshakes anyway.
     */
    if (s->tlsext_hb_pending) {
        if (SSL_IS_DTLS(s))
            dtls1_stop_timer(s);
        s->tlsext_hb_pending = 0;
        s->tlsext_hb_seq++;
    }
#endif

    /* Initialise state machine */

    if (st->state == MSG_FLOW_RENEGOTIATE) {
        s->renegotiate = 1;
        if (!server)
            s->ctx->stats.sess_connect_renegotiate++;
    }

    if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE) {
        if (st->state == MSG_FLOW_UNINITED) {
            st->hand_state = TLS_ST_BEFORE;
        }

        s->server = server;
        if (cb != NULL)
            cb(s, SSL_CB_HANDSHAKE_START, 1);

        if (SSL_IS_DTLS(s)) {
            if ((s->version & 0xff00) != (DTLS1_VERSION & 0xff00) &&
E
Emilia Kasper 已提交
287
                (server || (s->version & 0xff00) != (DTLS1_BAD_VER & 0xff00))) {
288 289 290 291
                SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
                goto end;
            }
        } else {
292
            if ((s->version >> 8) != SSL3_VERSION_MAJOR) {
293 294 295 296 297
                SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
                goto end;
            }
        }

298 299 300
        if (!ssl_security(s, SSL_SECOP_VERSION, 0, s->version, NULL)) {
            SSLerr(SSL_F_STATE_MACHINE, SSL_R_VERSION_TOO_LOW);
            goto end;
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
        }

        if (s->init_buf == NULL) {
            if ((buf = BUF_MEM_new()) == NULL) {
                goto end;
            }
            if (!BUF_MEM_grow(buf, SSL3_RT_MAX_PLAIN_LENGTH)) {
                goto end;
            }
            s->init_buf = buf;
            buf = NULL;
        }

        if (!ssl3_setup_buffers(s)) {
            goto end;
        }
        s->init_num = 0;

        /*
         * Should have been reset by tls_process_finished, too.
         */
        s->s3->change_cipher_spec = 0;

M
Matt Caswell 已提交
324 325 326 327
        /*
         * Ok, we now need to push on a buffering BIO ...but not with
         * SCTP
         */
328
#ifndef OPENSSL_NO_SCTP
M
Matt Caswell 已提交
329
        if (!SSL_IS_DTLS(s) || !BIO_dgram_is_sctp(SSL_get_wbio(s)))
330
#endif
M
Matt Caswell 已提交
331 332 333
            if (!ssl_init_wbio_buffer(s)) {
                goto end;
            }
334

335 336 337 338 339 340
        if (!server || st->state != MSG_FLOW_RENEGOTIATE) {
            if (!ssl3_init_finished_mac(s)) {
                ossl_statem_set_error(s);
                goto end;
            }
        }
341 342 343 344 345 346 347 348 349 350 351 352 353 354

        if (server) {
            if (st->state != MSG_FLOW_RENEGOTIATE) {
                s->ctx->stats.sess_accept++;
            } else if (!s->s3->send_connection_binding &&
                       !(s->options &
                         SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
                /*
                 * Server attempting to renegotiate with client that doesn't
                 * support secure renegotiation.
                 */
                SSLerr(SSL_F_STATE_MACHINE,
                       SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
                ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
M
Matt Caswell 已提交
355
                ossl_statem_set_error(s);
356 357 358
                goto end;
            } else {
                /*
M
Matt Caswell 已提交
359
                 * st->state == MSG_FLOW_RENEGOTIATE, we will just send a
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
                 * HelloRequest
                 */
                s->ctx->stats.sess_accept_renegotiate++;
            }
        } else {
            s->ctx->stats.sess_connect++;

            /* mark client_random uninitialized */
            memset(s->s3->client_random, 0, sizeof(s->s3->client_random));
            s->hit = 0;

            s->s3->tmp.cert_request = 0;

            if (SSL_IS_DTLS(s)) {
                st->use_timer = 1;
            }
        }

        st->state = MSG_FLOW_WRITING;
        init_write_state_machine(s);
        st->read_state_first_init = 1;
    }

383 384
    while (st->state != MSG_FLOW_FINISHED) {
        if (st->state == MSG_FLOW_READING) {
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
            ssret = read_state_machine(s);
            if (ssret == SUB_STATE_FINISHED) {
                st->state = MSG_FLOW_WRITING;
                init_write_state_machine(s);
            } else {
                /* NBIO or error */
                goto end;
            }
        } else if (st->state == MSG_FLOW_WRITING) {
            ssret = write_state_machine(s);
            if (ssret == SUB_STATE_FINISHED) {
                st->state = MSG_FLOW_READING;
                init_read_state_machine(s);
            } else if (ssret == SUB_STATE_END_HANDSHAKE) {
                st->state = MSG_FLOW_FINISHED;
            } else {
                /* NBIO or error */
                goto end;
            }
        } else {
            /* Error */
M
Matt Caswell 已提交
406
            ossl_statem_set_error(s);
407 408 409 410 411 412 413 414
            goto end;
        }
    }

    st->state = MSG_FLOW_UNINITED;
    ret = 1;

 end:
M
Matt Caswell 已提交
415
    st->in_handshake--;
416 417 418 419 420 421 422 423

#ifndef OPENSSL_NO_SCTP
    if (SSL_IS_DTLS(s)) {
        /*
         * Notify SCTP BIO socket to leave handshake mode and allow stream
         * identifier other than 0. Will be ignored if no SCTP is used.
         */
        BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
M
Matt Caswell 已提交
424
                 st->in_handshake, NULL);
425 426 427
    }
#endif

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    BUF_MEM_free(buf);
    if (cb != NULL) {
        if (server)
            cb(s, SSL_CB_ACCEPT_EXIT, ret);
        else
            cb(s, SSL_CB_CONNECT_EXIT, ret);
    }
    return ret;
}

/*
 * Initialise the MSG_FLOW_READING sub-state machine
 */
static void init_read_state_machine(SSL *s)
{
M
Matt Caswell 已提交
443
    OSSL_STATEM *st = &s->statem;
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469

    st->read_state = READ_STATE_HEADER;
}

/*
 * This function implements the sub-state machine when the message flow is in
 * MSG_FLOW_READING. The valid sub-states and transitions are:
 *
 * READ_STATE_HEADER <--+<-------------+
 *        |             |              |
 *        v             |              |
 * READ_STATE_BODY -----+-->READ_STATE_POST_PROCESS
 *        |                            |
 *        +----------------------------+
 *        v
 * [SUB_STATE_FINISHED]
 *
 * READ_STATE_HEADER has the responsibility for reading in the message header
 * and transitioning the state of the handshake state machine.
 *
 * READ_STATE_BODY reads in the rest of the message and then subsequently
 * processes it.
 *
 * READ_STATE_POST_PROCESS is an optional step that may occur if some post
 * processing activity performed on the message may block.
 *
F
FdaSilvaYY 已提交
470
 * Any of the above states could result in an NBIO event occurring in which case
471 472 473
 * control returns to the calling application. When this function is recalled we
 * will resume in the same state where we left off.
 */
E
Emilia Kasper 已提交
474 475
static SUB_STATE_RETURN read_state_machine(SSL *s)
{
M
Matt Caswell 已提交
476
    OSSL_STATEM *st = &s->statem;
477
    int ret, mt;
M
Matt Caswell 已提交
478
    unsigned long len = 0;
E
Emilia Kasper 已提交
479
    int (*transition) (SSL *s, int mt);
480
    PACKET pkt;
E
Emilia Kasper 已提交
481 482 483
    MSG_PROCESS_RETURN(*process_message) (SSL *s, PACKET *pkt);
    WORK_STATE(*post_process_message) (SSL *s, WORK_STATE wst);
    unsigned long (*max_message_size) (SSL *s);
484 485
    void (*cb) (const SSL *ssl, int type, int val) = NULL;

486
    cb = get_callback(s);
487

488
    if (s->server) {
489 490 491 492
        transition = ossl_statem_server_read_transition;
        process_message = ossl_statem_server_process_message;
        max_message_size = ossl_statem_server_max_message_size;
        post_process_message = ossl_statem_server_post_process_message;
493
    } else {
494 495 496 497
        transition = ossl_statem_client_read_transition;
        process_message = ossl_statem_client_process_message;
        max_message_size = ossl_statem_client_max_message_size;
        post_process_message = ossl_statem_client_post_process_message;
498 499 500 501 502 503 504
    }

    if (st->read_state_first_init) {
        s->first_packet = 1;
        st->read_state_first_init = 0;
    }

505 506
    while (1) {
        switch (st->read_state) {
507 508
        case READ_STATE_HEADER:
            /* Get the state the peer wants to move to */
509 510 511 512 513 514 515 516
            if (SSL_IS_DTLS(s)) {
                /*
                 * In DTLS we get the whole message in one go - header and body
                 */
                ret = dtls_get_message(s, &mt, &len);
            } else {
                ret = tls_get_message_header(s, &mt);
            }
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

            if (ret == 0) {
                /* Could be non-blocking IO */
                return SUB_STATE_ERROR;
            }

            if (cb != NULL) {
                /* Notify callback of an impending state change */
                if (s->server)
                    cb(s, SSL_CB_ACCEPT_LOOP, 1);
                else
                    cb(s, SSL_CB_CONNECT_LOOP, 1);
            }
            /*
             * Validate that we are allowed to move to the new state and move
             * to that state if so
             */
534
            if (!transition(s, mt)) {
535
                ossl_statem_set_error(s);
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
                return SUB_STATE_ERROR;
            }

            if (s->s3->tmp.message_size > max_message_size(s)) {
                ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
                SSLerr(SSL_F_READ_STATE_MACHINE, SSL_R_EXCESSIVE_MESSAGE_SIZE);
                return SUB_STATE_ERROR;
            }

            st->read_state = READ_STATE_BODY;
            /* Fall through */

        case READ_STATE_BODY:
            if (!SSL_IS_DTLS(s)) {
                /* We already got this above for DTLS */
                ret = tls_get_message_body(s, &len);
                if (ret == 0) {
                    /* Could be non-blocking IO */
                    return SUB_STATE_ERROR;
                }
            }

            s->first_packet = 0;
559 560 561 562 563 564
            if (!PACKET_buf_init(&pkt, s->init_msg, len)) {
                ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
                SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
                return SUB_STATE_ERROR;
            }
            ret = process_message(s, &pkt);
565 566 567 568

            /* Discard the packet data */
            s->init_num = 0;

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
            if (ret == MSG_PROCESS_ERROR) {
                return SUB_STATE_ERROR;
            }

            if (ret == MSG_PROCESS_FINISHED_READING) {
                if (SSL_IS_DTLS(s)) {
                    dtls1_stop_timer(s);
                }
                return SUB_STATE_FINISHED;
            }

            if (ret == MSG_PROCESS_CONTINUE_PROCESSING) {
                st->read_state = READ_STATE_POST_PROCESS;
                st->read_state_work = WORK_MORE_A;
            } else {
                st->read_state = READ_STATE_HEADER;
            }
            break;

        case READ_STATE_POST_PROCESS:
            st->read_state_work = post_process_message(s, st->read_state_work);
590
            switch (st->read_state_work) {
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
            default:
                return SUB_STATE_ERROR;

            case WORK_FINISHED_CONTINUE:
                st->read_state = READ_STATE_HEADER;
                break;

            case WORK_FINISHED_STOP:
                if (SSL_IS_DTLS(s)) {
                    dtls1_stop_timer(s);
                }
                return SUB_STATE_FINISHED;
            }
            break;

        default:
            /* Shouldn't happen */
            ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
            SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
M
Matt Caswell 已提交
610
            ossl_statem_set_error(s);
611 612 613 614 615 616 617 618 619 620
            return SUB_STATE_ERROR;
        }
    }
}

/*
 * Send a previously constructed message to the peer.
 */
static int statem_do_write(SSL *s)
{
M
Matt Caswell 已提交
621
    OSSL_STATEM *st = &s->statem;
622 623

    if (st->hand_state == TLS_ST_CW_CHANGE
E
Emilia Kasper 已提交
624
        || st->hand_state == TLS_ST_SW_CHANGE) {
625 626 627 628 629 630 631 632 633 634 635 636 637 638
        if (SSL_IS_DTLS(s))
            return dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
        else
            return ssl3_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
    } else {
        return ssl_do_write(s);
    }
}

/*
 * Initialise the MSG_FLOW_WRITING sub-state machine
 */
static void init_write_state_machine(SSL *s)
{
M
Matt Caswell 已提交
639
    OSSL_STATEM *st = &s->statem;
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

    st->write_state = WRITE_STATE_TRANSITION;
}

/*
 * This function implements the sub-state machine when the message flow is in
 * MSG_FLOW_WRITING. The valid sub-states and transitions are:
 *
 * +-> WRITE_STATE_TRANSITION ------> [SUB_STATE_FINISHED]
 * |             |
 * |             v
 * |      WRITE_STATE_PRE_WORK -----> [SUB_STATE_END_HANDSHAKE]
 * |             |
 * |             v
 * |       WRITE_STATE_SEND
 * |             |
 * |             v
 * |     WRITE_STATE_POST_WORK
 * |             |
 * +-------------+
 *
 * WRITE_STATE_TRANSITION transitions the state of the handshake state machine

 * WRITE_STATE_PRE_WORK performs any work necessary to prepare the later
F
FdaSilvaYY 已提交
664
 * sending of the message. This could result in an NBIO event occurring in
665 666 667 668 669 670 671 672 673 674
 * which case control returns to the calling application. When this function
 * is recalled we will resume in the same state where we left off.
 *
 * WRITE_STATE_SEND sends the message and performs any work to be done after
 * sending.
 *
 * WRITE_STATE_POST_WORK performs any work necessary after the sending of the
 * message has been completed. As for WRITE_STATE_PRE_WORK this could also
 * result in an NBIO event.
 */
675
static SUB_STATE_RETURN write_state_machine(SSL *s)
676
{
M
Matt Caswell 已提交
677
    OSSL_STATEM *st = &s->statem;
678
    int ret;
E
Emilia Kasper 已提交
679 680 681 682
    WRITE_TRAN(*transition) (SSL *s);
    WORK_STATE(*pre_work) (SSL *s, WORK_STATE wst);
    WORK_STATE(*post_work) (SSL *s, WORK_STATE wst);
    int (*construct_message) (SSL *s);
683 684
    void (*cb) (const SSL *ssl, int type, int val) = NULL;

685
    cb = get_callback(s);
686

687
    if (s->server) {
688 689 690 691
        transition = ossl_statem_server_write_transition;
        pre_work = ossl_statem_server_pre_work;
        post_work = ossl_statem_server_post_work;
        construct_message = ossl_statem_server_construct_message;
692
    } else {
693 694 695 696
        transition = ossl_statem_client_write_transition;
        pre_work = ossl_statem_client_pre_work;
        post_work = ossl_statem_client_post_work;
        construct_message = ossl_statem_client_construct_message;
697 698
    }

699 700
    while (1) {
        switch (st->write_state) {
701 702 703 704 705 706 707 708
        case WRITE_STATE_TRANSITION:
            if (cb != NULL) {
                /* Notify callback of an impending state change */
                if (s->server)
                    cb(s, SSL_CB_ACCEPT_LOOP, 1);
                else
                    cb(s, SSL_CB_CONNECT_LOOP, 1);
            }
709
            switch (transition(s)) {
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
            case WRITE_TRAN_CONTINUE:
                st->write_state = WRITE_STATE_PRE_WORK;
                st->write_state_work = WORK_MORE_A;
                break;

            case WRITE_TRAN_FINISHED:
                return SUB_STATE_FINISHED;
                break;

            default:
                return SUB_STATE_ERROR;
            }
            break;

        case WRITE_STATE_PRE_WORK:
725
            switch (st->write_state_work = pre_work(s, st->write_state_work)) {
726 727 728 729 730 731 732 733 734 735
            default:
                return SUB_STATE_ERROR;

            case WORK_FINISHED_CONTINUE:
                st->write_state = WRITE_STATE_SEND;
                break;

            case WORK_FINISHED_STOP:
                return SUB_STATE_END_HANDSHAKE;
            }
736
            if (construct_message(s) == 0)
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
                return SUB_STATE_ERROR;

            /* Fall through */

        case WRITE_STATE_SEND:
            if (SSL_IS_DTLS(s) && st->use_timer) {
                dtls1_start_timer(s);
            }
            ret = statem_do_write(s);
            if (ret <= 0) {
                return SUB_STATE_ERROR;
            }
            st->write_state = WRITE_STATE_POST_WORK;
            st->write_state_work = WORK_MORE_A;
            /* Fall through */

        case WRITE_STATE_POST_WORK:
754
            switch (st->write_state_work = post_work(s, st->write_state_work)) {
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
            default:
                return SUB_STATE_ERROR;

            case WORK_FINISHED_CONTINUE:
                st->write_state = WRITE_STATE_TRANSITION;
                break;

            case WORK_FINISHED_STOP:
                return SUB_STATE_END_HANDSHAKE;
            }
            break;

        default:
            return SUB_STATE_ERROR;
        }
    }
}

M
Matt Caswell 已提交
773 774 775
/*
 * Flush the write BIO
 */
M
Matt Caswell 已提交
776
int statem_flush(SSL *s)
M
Matt Caswell 已提交
777 778 779 780 781 782 783 784 785 786
{
    s->rwstate = SSL_WRITING;
    if (BIO_flush(s->wbio) <= 0) {
        return 0;
    }
    s->rwstate = SSL_NOTHING;

    return 1;
}

787 788 789 790 791 792 793 794
/*
 * Called by the record layer to determine whether application data is
 * allowed to be sent in the current handshake state or not.
 *
 * Return values are:
 *   1: Yes (application data allowed)
 *   0: No (application data not allowed)
 */
M
Matt Caswell 已提交
795
int ossl_statem_app_data_allowed(SSL *s)
796
{
M
Matt Caswell 已提交
797
    OSSL_STATEM *st = &s->statem;
798

799
    if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE)
M
Matt Caswell 已提交
800 801
        return 0;

802 803
    if (!s->s3->in_read_app_data || (s->s3->total_renegotiations == 0))
        return 0;
M
Matt Caswell 已提交
804

805 806 807 808 809 810
    if (s->server) {
        /*
         * If we're a server and we haven't got as far as writing our
         * ServerHello yet then we allow app data
         */
        if (st->hand_state == TLS_ST_BEFORE
E
Emilia Kasper 已提交
811
            || st->hand_state == TLS_ST_SR_CLNT_HELLO)
812 813 814 815 816 817 818
            return 1;
    } else {
        /*
         * If we're a client and we haven't read the ServerHello yet then we
         * allow app data
         */
        if (st->hand_state == TLS_ST_CW_CLNT_HELLO)
M
Matt Caswell 已提交
819 820 821 822 823 824 825 826 827 828
            return 1;
    }

    return 0;
}

#ifndef OPENSSL_NO_SCTP
/*
 * Set flag used by SCTP to determine whether we are in the read sock state
 */
M
Matt Caswell 已提交
829
void ossl_statem_set_sctp_read_sock(SSL *s, int read_sock)
M
Matt Caswell 已提交
830 831 832 833 834 835 836 837 838 839 840 841
{
    s->statem.in_sctp_read_sock = read_sock;
}

/*
 * Called by the record layer to determine whether we are in the read sock
 * state or not.
 *
 * Return values are:
 *   1: Yes (we are in the read sock state)
 *   0: No (we are not in the read sock state)
 */
M
Matt Caswell 已提交
842
int ossl_statem_in_sctp_read_sock(SSL *s)
M
Matt Caswell 已提交
843 844 845 846
{
    return s->statem.in_sctp_read_sock;
}
#endif