statem.c 25.6 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
{
M
Matt Caswell 已提交
108
    s->statem.in_init = 1;
109
    s->statem.request_state = TLS_ST_SW_HELLO_REQ;
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--;
}

M
Matt Caswell 已提交
154 155 156
/* Are we in a sensible state to skip over unreadable early data? */
int ossl_statem_skip_early_data(SSL *s)
{
157
    if (s->ext.early_data != SSL_EARLY_DATA_REJECTED)
M
Matt Caswell 已提交
158 159
        return 0;

160 161 162 163 164 165 166
    if (s->hello_retry_request) {
        if (s->statem.hand_state != TLS_ST_SW_HELLO_RETRY_REQUEST)
            return 0;
    } else {
        if (s->statem.hand_state != TLS_ST_SW_FINISHED)
            return 0;
    }
M
Matt Caswell 已提交
167 168 169 170

    return 1;
}

171 172
void ossl_statem_check_finish_init(SSL *s, int send)
{
173 174 175 176 177
    if (!s->server) {
        if ((send && s->statem.hand_state == TLS_ST_PENDING_EARLY_DATA_END)
                || (!send && s->statem.hand_state == TLS_ST_EARLY_DATA))
            ossl_statem_set_in_init(s, 1);
    }
178 179
}

180 181 182 183 184 185 186 187 188 189 190 191 192 193
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 已提交
194 195
int ossl_statem_connect(SSL *s)
{
M
Matt Caswell 已提交
196 197 198
    return state_machine(s, 0);
}

M
Matt Caswell 已提交
199
int ossl_statem_accept(SSL *s)
200 201 202 203
{
    return state_machine(s, 1);
}

E
Emilia Kasper 已提交
204 205 206
typedef void (*info_cb) (const SSL *, int, int);

static info_cb get_callback(SSL *s)
207 208 209 210 211 212 213 214 215
{
    if (s->info_callback != NULL)
        return s->info_callback;
    else if (s->ctx->info_callback != NULL)
        return s->ctx->info_callback;

    return NULL;
}

216 217
/*
 * The main message flow state machine. We start in the MSG_FLOW_UNINITED or
218
 * MSG_FLOW_FINISHED state and finish in MSG_FLOW_FINISHED. Valid states and
219 220
 * transitions are as follows:
 *
221
 * MSG_FLOW_UNINITED     MSG_FLOW_FINISHED
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
 *        |                       |
 *        +-----------------------+
 *        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
 */
244 245
static int state_machine(SSL *s, int server)
{
246 247 248
    BUF_MEM *buf = NULL;
    unsigned long Time = (unsigned long)time(NULL);
    void (*cb) (const SSL *ssl, int type, int val) = NULL;
M
Matt Caswell 已提交
249
    OSSL_STATEM *st = &s->statem;
250 251 252 253 254 255 256 257 258 259 260 261
    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();

262
    cb = get_callback(s);
263

M
Matt Caswell 已提交
264
    st->in_handshake++;
265 266 267 268
    if (!SSL_in_init(s) || SSL_in_before(s)) {
        if (!SSL_clear(s))
            return -1;
    }
269 270 271 272 273 274 275
#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 已提交
276
                 st->in_handshake, NULL);
277 278 279
    }
#endif

280
    /* Initialise state machine */
281 282
    if (st->state == MSG_FLOW_UNINITED
            || st->state == MSG_FLOW_FINISHED) {
283 284
        if (st->state == MSG_FLOW_UNINITED) {
            st->hand_state = TLS_ST_BEFORE;
285
            st->request_state = TLS_ST_BEFORE;
286 287 288 289 290 291 292 293
        }

        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 已提交
294
                (server || (s->version & 0xff00) != (DTLS1_BAD_VER & 0xff00))) {
295 296 297 298
                SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
                goto end;
            }
        } else {
299
            if ((s->version >> 8) != SSL3_VERSION_MAJOR) {
300 301 302 303 304
                SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
                goto end;
            }
        }

305 306 307
        if (!ssl_security(s, SSL_SECOP_VERSION, 0, s->version, NULL)) {
            SSLerr(SSL_F_STATE_MACHINE, SSL_R_VERSION_TOO_LOW);
            goto end;
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
        }

        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 已提交
331 332 333 334
        /*
         * Ok, we now need to push on a buffering BIO ...but not with
         * SCTP
         */
335
#ifndef OPENSSL_NO_SCTP
M
Matt Caswell 已提交
336
        if (!SSL_IS_DTLS(s) || !BIO_dgram_is_sctp(SSL_get_wbio(s)))
337
#endif
M
Matt Caswell 已提交
338 339 340
            if (!ssl_init_wbio_buffer(s)) {
                goto end;
            }
341

342
        if ((SSL_IS_FIRST_HANDSHAKE(s)
343 344
                    && s->early_data_state != SSL_EARLY_DATA_FINISHED_WRITING
                    && s->early_data_state != SSL_EARLY_DATA_FINISHED_READING)
345
                || s->renegotiate) {
346 347 348
            if (!tls_setup_handshake(s)) {
                ossl_statem_set_error(s);
                goto end;
349
            }
350

351 352
            if (SSL_IS_FIRST_HANDSHAKE(s))
                st->read_state_first_init = 1;
353 354 355 356 357 358
        }

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

359 360
    while (st->state != MSG_FLOW_FINISHED) {
        if (st->state == MSG_FLOW_READING) {
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
            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 已提交
382
            ossl_statem_set_error(s);
383 384 385 386 387 388 389
            goto end;
        }
    }

    ret = 1;

 end:
M
Matt Caswell 已提交
390
    st->in_handshake--;
391 392 393 394 395 396 397 398

#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 已提交
399
                 st->in_handshake, NULL);
400 401 402
    }
#endif

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
    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 已提交
418
    OSSL_STATEM *st = &s->statem;
419 420 421 422

    st->read_state = READ_STATE_HEADER;
}

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
static int grow_init_buf(SSL *s, size_t size) {

    size_t msg_offset = (char *)s->init_msg - s->init_buf->data;

    if (!BUF_MEM_grow_clean(s->init_buf, (int)size))
        return 0;

    if (size < msg_offset)
        return 0;

    s->init_msg = s->init_buf->data + msg_offset;

    return 1;
}

438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
/*
 * 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 已提交
460
 * Any of the above states could result in an NBIO event occurring in which case
461 462 463
 * 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 已提交
464 465
static SUB_STATE_RETURN read_state_machine(SSL *s)
{
M
Matt Caswell 已提交
466
    OSSL_STATEM *st = &s->statem;
467
    int ret, mt;
468
    size_t len = 0;
E
Emilia Kasper 已提交
469
    int (*transition) (SSL *s, int mt);
470
    PACKET pkt;
E
Emilia Kasper 已提交
471 472
    MSG_PROCESS_RETURN(*process_message) (SSL *s, PACKET *pkt);
    WORK_STATE(*post_process_message) (SSL *s, WORK_STATE wst);
473
    size_t (*max_message_size) (SSL *s);
474 475
    void (*cb) (const SSL *ssl, int type, int val) = NULL;

476
    cb = get_callback(s);
477

478
    if (s->server) {
479 480 481 482
        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;
483
    } else {
484 485 486 487
        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;
488 489 490 491 492 493 494
    }

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

495 496
    while (1) {
        switch (st->read_state) {
497 498
        case READ_STATE_HEADER:
            /* Get the state the peer wants to move to */
499 500 501 502 503 504 505 506
            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);
            }
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523

            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
             */
524
            if (!transition(s, mt)) {
525
                ossl_statem_set_error(s);
526 527 528 529 530 531 532 533 534
                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;
            }

535 536 537
            /* dtls_get_message already did this */
            if (!SSL_IS_DTLS(s)
                    && s->s3->tmp.message_size > 0
538 539
                    && !grow_init_buf(s, s->s3->tmp.message_size
                                         + SSL3_HM_HEADER_LENGTH)) {
540
                ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
541
                SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_BUF_LIB);
542 543 544
                return SUB_STATE_ERROR;
            }

545 546 547 548 549 550 551 552 553 554 555 556 557 558
            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
            switch (ret) {
            case MSG_PROCESS_ERROR:
571 572
                return SUB_STATE_ERROR;

573
            case MSG_PROCESS_FINISHED_READING:
574 575 576 577 578
                if (SSL_IS_DTLS(s)) {
                    dtls1_stop_timer(s);
                }
                return SUB_STATE_FINISHED;

579
            case MSG_PROCESS_CONTINUE_PROCESSING:
580 581
                st->read_state = READ_STATE_POST_PROCESS;
                st->read_state_work = WORK_MORE_A;
582 583 584
                break;

            default:
585
                st->read_state = READ_STATE_HEADER;
586
                break;
587 588 589 590 591
            }
            break;

        case READ_STATE_POST_PROCESS:
            st->read_state_work = post_process_message(s, st->read_state_work);
592
            switch (st->read_state_work) {
R
Rich Salz 已提交
593 594 595
            case WORK_ERROR:
            case WORK_MORE_A:
            case WORK_MORE_B:
B
Benjamin Kaduk 已提交
596
            case WORK_MORE_C:
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
                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 已提交
615
            ossl_statem_set_error(s);
616 617 618 619 620 621 622 623 624 625
            return SUB_STATE_ERROR;
        }
    }
}

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

    if (st->hand_state == TLS_ST_CW_CHANGE
E
Emilia Kasper 已提交
629
        || st->hand_state == TLS_ST_SW_CHANGE) {
630 631 632 633 634 635 636 637 638 639 640 641 642 643
        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 已提交
644
    OSSL_STATEM *st = &s->statem;
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668

    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 已提交
669
 * sending of the message. This could result in an NBIO event occurring in
670 671 672 673 674 675 676 677 678 679
 * 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.
 */
680
static SUB_STATE_RETURN write_state_machine(SSL *s)
681
{
M
Matt Caswell 已提交
682
    OSSL_STATEM *st = &s->statem;
683
    int ret;
E
Emilia Kasper 已提交
684 685 686
    WRITE_TRAN(*transition) (SSL *s);
    WORK_STATE(*pre_work) (SSL *s, WORK_STATE wst);
    WORK_STATE(*post_work) (SSL *s, WORK_STATE wst);
687 688 689
    int (*get_construct_message_f) (SSL *s, WPACKET *pkt,
                                    int (**confunc) (SSL *s, WPACKET *pkt),
                                    int *mt);
690
    void (*cb) (const SSL *ssl, int type, int val) = NULL;
691 692
    int (*confunc) (SSL *s, WPACKET *pkt);
    int mt;
693
    WPACKET pkt;
694

695
    cb = get_callback(s);
696

697
    if (s->server) {
698 699 700
        transition = ossl_statem_server_write_transition;
        pre_work = ossl_statem_server_pre_work;
        post_work = ossl_statem_server_post_work;
701
        get_construct_message_f = ossl_statem_server_construct_message;
702
    } else {
703 704 705
        transition = ossl_statem_client_write_transition;
        pre_work = ossl_statem_client_pre_work;
        post_work = ossl_statem_client_post_work;
706
        get_construct_message_f = ossl_statem_client_construct_message;
707 708
    }

709 710
    while (1) {
        switch (st->write_state) {
711 712 713 714 715 716 717 718
        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);
            }
719
            switch (transition(s)) {
720 721 722 723 724 725 726 727 728
            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;

R
Rich Salz 已提交
729
            case WRITE_TRAN_ERROR:
730 731 732 733 734
                return SUB_STATE_ERROR;
            }
            break;

        case WRITE_STATE_PRE_WORK:
735
            switch (st->write_state_work = pre_work(s, st->write_state_work)) {
R
Rich Salz 已提交
736 737 738
            case WORK_ERROR:
            case WORK_MORE_A:
            case WORK_MORE_B:
B
Benjamin Kaduk 已提交
739
            case WORK_MORE_C:
740 741 742 743 744 745 746 747 748
                return SUB_STATE_ERROR;

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

            case WORK_FINISHED_STOP:
                return SUB_STATE_END_HANDSHAKE;
            }
749
            if (!WPACKET_init(&pkt, s->init_buf)
750 751 752 753
                    || !get_construct_message_f(s, &pkt, &confunc, &mt)
                    || !ssl_set_handshake_header(s, &pkt, mt)
                    || (confunc != NULL && !confunc(s, &pkt))
                    || !ssl_close_construct_packet(s, &pkt, mt)
754 755 756
                    || !WPACKET_finish(&pkt)) {
                WPACKET_cleanup(&pkt);
                ossl_statem_set_error(s);
757
                return SUB_STATE_ERROR;
758
            }
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

            /* 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:
775
            switch (st->write_state_work = post_work(s, st->write_state_work)) {
R
Rich Salz 已提交
776 777 778
            case WORK_ERROR:
            case WORK_MORE_A:
            case WORK_MORE_B:
B
Benjamin Kaduk 已提交
779
            case WORK_MORE_C:
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
                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 已提交
797 798 799
/*
 * Flush the write BIO
 */
M
Matt Caswell 已提交
800
int statem_flush(SSL *s)
M
Matt Caswell 已提交
801 802 803 804 805 806 807 808 809 810
{
    s->rwstate = SSL_WRITING;
    if (BIO_flush(s->wbio) <= 0) {
        return 0;
    }
    s->rwstate = SSL_NOTHING;

    return 1;
}

811 812
/*
 * Called by the record layer to determine whether application data is
813
 * allowed to be received in the current handshake state or not.
814 815 816 817 818
 *
 * Return values are:
 *   1: Yes (application data allowed)
 *   0: No (application data not allowed)
 */
M
Matt Caswell 已提交
819
int ossl_statem_app_data_allowed(SSL *s)
820
{
M
Matt Caswell 已提交
821
    OSSL_STATEM *st = &s->statem;
822

823
    if (st->state == MSG_FLOW_UNINITED)
M
Matt Caswell 已提交
824 825
        return 0;

826 827
    if (!s->s3->in_read_app_data || (s->s3->total_renegotiations == 0))
        return 0;
M
Matt Caswell 已提交
828

829 830 831 832 833 834
    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 已提交
835
            || st->hand_state == TLS_ST_SR_CLNT_HELLO)
836 837 838 839 840 841 842
            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 已提交
843 844 845 846 847 848 849 850 851 852
            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 已提交
853
void ossl_statem_set_sctp_read_sock(SSL *s, int read_sock)
M
Matt Caswell 已提交
854 855 856 857 858 859 860 861 862 863 864 865
{
    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 已提交
866
int ossl_statem_in_sctp_read_sock(SSL *s)
M
Matt Caswell 已提交
867 868 869 870
{
    return s->statem.in_sctp_read_sock;
}
#endif