2 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include <openssl/rand.h>
11 #include "../ssl_locl.h"
12 #include "statem_locl.h"
15 * This file implements the SSL/TLS/DTLS state machines.
17 * There are two primary state machines:
19 * 1) Message flow state machine
20 * 2) Handshake state machine
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.
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.
31 * Overall it looks like this:
33 * --------------------------------------------- -------------------
35 * | Message flow state machine | | |
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 * | -------------------- -------------------- | | |
44 * --------------------------------------------- -------------------
48 /* Sub state machine return values */
50 /* Something bad happened or NBIO */
52 /* Sub state finished go to the next sub state */
54 /* Sub state finished and handshake was completed */
55 SUB_STATE_END_HANDSHAKE
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);
64 OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl)
66 return ssl->statem.hand_state;
69 int SSL_in_init(SSL *s)
71 return s->statem.in_init;
74 int SSL_is_init_finished(SSL *s)
76 return !(s->statem.in_init) && (s->statem.hand_state == TLS_ST_OK);
79 int SSL_in_before(SSL *s)
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.
88 return (s->statem.hand_state == TLS_ST_BEFORE)
89 && (s->statem.state == MSG_FLOW_UNINITED);
93 * Clear the state machine state and reset back to MSG_FLOW_UNINITED
95 void ossl_statem_clear(SSL *s)
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;
104 * Set the state machine up ready for a renegotiation handshake
106 void ossl_statem_set_renegotiate(SSL *s)
108 s->statem.state = MSG_FLOW_RENEGOTIATE;
109 s->statem.in_init = 1;
113 * Put the state machine into an error state. This is a permanent error for
114 * the current connection.
116 void ossl_statem_set_error(SSL *s)
118 s->statem.state = MSG_FLOW_ERROR;
122 * Discover whether the current connection is in the error state.
124 * Valid return values are:
128 int ossl_statem_in_error(const SSL *s)
130 if (s->statem.state == MSG_FLOW_ERROR)
136 void ossl_statem_set_in_init(SSL *s, int init)
138 s->statem.in_init = init;
141 int ossl_statem_get_in_handshake(SSL *s)
143 return s->statem.in_handshake;
146 void ossl_statem_set_in_handshake(SSL *s, int inhand)
149 s->statem.in_handshake++;
151 s->statem.in_handshake--;
154 void ossl_statem_set_hello_verify_done(SSL *s)
156 s->statem.state = MSG_FLOW_UNINITED;
157 s->statem.in_init = 1;
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
165 s->statem.hand_state = TLS_ST_SR_CLNT_HELLO;
168 int ossl_statem_connect(SSL *s)
170 return state_machine(s, 0);
173 int ossl_statem_accept(SSL *s)
175 return state_machine(s, 1);
178 typedef void (*info_cb) (const SSL *, int, int);
180 static info_cb get_callback(SSL *s)
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;
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:
195 * MSG_FLOW_UNINITED MSG_FLOW_RENEGOTIATE
197 * +-----------------------+
199 * MSG_FLOW_WRITING <---> MSG_FLOW_READING
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.
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.
214 * Valid return values are:
218 static int state_machine(SSL *s, int server)
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;
227 if (st->state == MSG_FLOW_ERROR) {
228 /* Shouldn't have been called if we're already in the error state */
232 RAND_add(&Time, sizeof(Time), 0);
236 cb = get_callback(s);
239 if (!SSL_in_init(s) || SSL_in_before(s)) {
243 #ifndef OPENSSL_NO_SCTP
244 if (SSL_IS_DTLS(s)) {
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.
249 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
250 st->in_handshake, NULL);
254 #ifndef OPENSSL_NO_HEARTBEATS
256 * If we're awaiting a HeartbeatResponse, pretend we already got and
257 * don't await it anymore, because Heartbeats don't make sense during
260 if (s->tlsext_hb_pending) {
263 s->tlsext_hb_pending = 0;
268 /* Initialise state machine */
270 if (st->state == MSG_FLOW_RENEGOTIATE) {
273 s->ctx->stats.sess_connect_renegotiate++;
276 if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE) {
277 if (st->state == MSG_FLOW_UNINITED) {
278 st->hand_state = TLS_ST_BEFORE;
283 cb(s, SSL_CB_HANDSHAKE_START, 1);
285 if (SSL_IS_DTLS(s)) {
286 if ((s->version & 0xff00) != (DTLS1_VERSION & 0xff00) &&
287 (server || (s->version & 0xff00) != (DTLS1_BAD_VER & 0xff00))) {
288 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
292 if ((s->version >> 8) != SSL3_VERSION_MAJOR) {
293 SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
298 if (!ssl_security(s, SSL_SECOP_VERSION, 0, s->version, NULL)) {
299 SSLerr(SSL_F_STATE_MACHINE, SSL_R_VERSION_TOO_LOW);
303 if (s->init_buf == NULL) {
304 if ((buf = BUF_MEM_new()) == NULL) {
307 if (!BUF_MEM_grow(buf, SSL3_RT_MAX_PLAIN_LENGTH)) {
314 if (!ssl3_setup_buffers(s)) {
320 * Should have been reset by tls_process_finished, too.
322 s->s3->change_cipher_spec = 0;
325 * Ok, we now need to push on a buffering BIO ...but not with
328 #ifndef OPENSSL_NO_SCTP
329 if (!SSL_IS_DTLS(s) || !BIO_dgram_is_sctp(SSL_get_wbio(s)))
331 if (!ssl_init_wbio_buffer(s)) {
335 if (!server || st->state != MSG_FLOW_RENEGOTIATE) {
336 if (!ssl3_init_finished_mac(s)) {
337 ossl_statem_set_error(s);
343 if (st->state != MSG_FLOW_RENEGOTIATE) {
344 s->ctx->stats.sess_accept++;
345 } else if (!s->s3->send_connection_binding &&
347 SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
349 * Server attempting to renegotiate with client that doesn't
350 * support secure renegotiation.
352 SSLerr(SSL_F_STATE_MACHINE,
353 SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
354 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
355 ossl_statem_set_error(s);
359 * st->state == MSG_FLOW_RENEGOTIATE, we will just send a
362 s->ctx->stats.sess_accept_renegotiate++;
365 s->ctx->stats.sess_connect++;
367 /* mark client_random uninitialized */
368 memset(s->s3->client_random, 0, sizeof(s->s3->client_random));
371 s->s3->tmp.cert_request = 0;
373 if (SSL_IS_DTLS(s)) {
378 st->state = MSG_FLOW_WRITING;
379 init_write_state_machine(s);
380 st->read_state_first_init = 1;
383 while (st->state != MSG_FLOW_FINISHED) {
384 if (st->state == MSG_FLOW_READING) {
385 ssret = read_state_machine(s);
386 if (ssret == SUB_STATE_FINISHED) {
387 st->state = MSG_FLOW_WRITING;
388 init_write_state_machine(s);
393 } else if (st->state == MSG_FLOW_WRITING) {
394 ssret = write_state_machine(s);
395 if (ssret == SUB_STATE_FINISHED) {
396 st->state = MSG_FLOW_READING;
397 init_read_state_machine(s);
398 } else if (ssret == SUB_STATE_END_HANDSHAKE) {
399 st->state = MSG_FLOW_FINISHED;
406 ossl_statem_set_error(s);
411 st->state = MSG_FLOW_UNINITED;
417 #ifndef OPENSSL_NO_SCTP
418 if (SSL_IS_DTLS(s)) {
420 * Notify SCTP BIO socket to leave handshake mode and allow stream
421 * identifier other than 0. Will be ignored if no SCTP is used.
423 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE,
424 st->in_handshake, NULL);
431 cb(s, SSL_CB_ACCEPT_EXIT, ret);
433 cb(s, SSL_CB_CONNECT_EXIT, ret);
439 * Initialise the MSG_FLOW_READING sub-state machine
441 static void init_read_state_machine(SSL *s)
443 OSSL_STATEM *st = &s->statem;
445 st->read_state = READ_STATE_HEADER;
448 static int grow_init_buf(SSL *s, size_t size) {
450 size_t msg_offset = (char *)s->init_msg - s->init_buf->data;
452 if (!BUF_MEM_grow_clean(s->init_buf, (int)size))
455 if (size < msg_offset)
458 s->init_msg = s->init_buf->data + msg_offset;
464 * This function implements the sub-state machine when the message flow is in
465 * MSG_FLOW_READING. The valid sub-states and transitions are:
467 * READ_STATE_HEADER <--+<-------------+
470 * READ_STATE_BODY -----+-->READ_STATE_POST_PROCESS
472 * +----------------------------+
474 * [SUB_STATE_FINISHED]
476 * READ_STATE_HEADER has the responsibility for reading in the message header
477 * and transitioning the state of the handshake state machine.
479 * READ_STATE_BODY reads in the rest of the message and then subsequently
482 * READ_STATE_POST_PROCESS is an optional step that may occur if some post
483 * processing activity performed on the message may block.
485 * Any of the above states could result in an NBIO event occurring in which case
486 * control returns to the calling application. When this function is recalled we
487 * will resume in the same state where we left off.
489 static SUB_STATE_RETURN read_state_machine(SSL *s)
491 OSSL_STATEM *st = &s->statem;
494 int (*transition) (SSL *s, int mt);
496 MSG_PROCESS_RETURN(*process_message) (SSL *s, PACKET *pkt);
497 WORK_STATE(*post_process_message) (SSL *s, WORK_STATE wst);
498 size_t (*max_message_size) (SSL *s);
499 void (*cb) (const SSL *ssl, int type, int val) = NULL;
501 cb = get_callback(s);
504 transition = ossl_statem_server_read_transition;
505 process_message = ossl_statem_server_process_message;
506 max_message_size = ossl_statem_server_max_message_size;
507 post_process_message = ossl_statem_server_post_process_message;
509 transition = ossl_statem_client_read_transition;
510 process_message = ossl_statem_client_process_message;
511 max_message_size = ossl_statem_client_max_message_size;
512 post_process_message = ossl_statem_client_post_process_message;
515 if (st->read_state_first_init) {
517 st->read_state_first_init = 0;
521 switch (st->read_state) {
522 case READ_STATE_HEADER:
523 /* Get the state the peer wants to move to */
524 if (SSL_IS_DTLS(s)) {
526 * In DTLS we get the whole message in one go - header and body
528 ret = dtls_get_message(s, &mt, &len);
530 ret = tls_get_message_header(s, &mt);
534 /* Could be non-blocking IO */
535 return SUB_STATE_ERROR;
539 /* Notify callback of an impending state change */
541 cb(s, SSL_CB_ACCEPT_LOOP, 1);
543 cb(s, SSL_CB_CONNECT_LOOP, 1);
546 * Validate that we are allowed to move to the new state and move
547 * to that state if so
549 if (!transition(s, mt)) {
550 ossl_statem_set_error(s);
551 return SUB_STATE_ERROR;
554 if (s->s3->tmp.message_size > max_message_size(s)) {
555 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
556 SSLerr(SSL_F_READ_STATE_MACHINE, SSL_R_EXCESSIVE_MESSAGE_SIZE);
557 return SUB_STATE_ERROR;
560 /* dtls_get_message already did this */
562 && s->s3->tmp.message_size > 0
563 && !grow_init_buf(s, s->s3->tmp.message_size
564 + SSL3_HM_HEADER_LENGTH)) {
565 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
566 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_BUF_LIB);
567 return SUB_STATE_ERROR;
570 st->read_state = READ_STATE_BODY;
573 case READ_STATE_BODY:
574 if (!SSL_IS_DTLS(s)) {
575 /* We already got this above for DTLS */
576 ret = tls_get_message_body(s, &len);
578 /* Could be non-blocking IO */
579 return SUB_STATE_ERROR;
584 if (!PACKET_buf_init(&pkt, s->init_msg, len)) {
585 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
586 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
587 return SUB_STATE_ERROR;
589 ret = process_message(s, &pkt);
591 /* Discard the packet data */
595 case MSG_PROCESS_ERROR:
596 return SUB_STATE_ERROR;
598 case MSG_PROCESS_FINISHED_READING:
599 if (SSL_IS_DTLS(s)) {
602 return SUB_STATE_FINISHED;
604 case MSG_PROCESS_CONTINUE_PROCESSING:
605 st->read_state = READ_STATE_POST_PROCESS;
606 st->read_state_work = WORK_MORE_A;
610 st->read_state = READ_STATE_HEADER;
615 case READ_STATE_POST_PROCESS:
616 st->read_state_work = post_process_message(s, st->read_state_work);
617 switch (st->read_state_work) {
621 return SUB_STATE_ERROR;
623 case WORK_FINISHED_CONTINUE:
624 st->read_state = READ_STATE_HEADER;
627 case WORK_FINISHED_STOP:
628 if (SSL_IS_DTLS(s)) {
631 return SUB_STATE_FINISHED;
636 /* Shouldn't happen */
637 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
638 SSLerr(SSL_F_READ_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
639 ossl_statem_set_error(s);
640 return SUB_STATE_ERROR;
646 * Send a previously constructed message to the peer.
648 static int statem_do_write(SSL *s)
650 OSSL_STATEM *st = &s->statem;
652 if (st->hand_state == TLS_ST_CW_CHANGE
653 || st->hand_state == TLS_ST_SW_CHANGE) {
655 return dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
657 return ssl3_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC);
659 return ssl_do_write(s);
664 * Initialise the MSG_FLOW_WRITING sub-state machine
666 static void init_write_state_machine(SSL *s)
668 OSSL_STATEM *st = &s->statem;
670 st->write_state = WRITE_STATE_TRANSITION;
674 * This function implements the sub-state machine when the message flow is in
675 * MSG_FLOW_WRITING. The valid sub-states and transitions are:
677 * +-> WRITE_STATE_TRANSITION ------> [SUB_STATE_FINISHED]
680 * | WRITE_STATE_PRE_WORK -----> [SUB_STATE_END_HANDSHAKE]
686 * | WRITE_STATE_POST_WORK
690 * WRITE_STATE_TRANSITION transitions the state of the handshake state machine
692 * WRITE_STATE_PRE_WORK performs any work necessary to prepare the later
693 * sending of the message. This could result in an NBIO event occurring in
694 * which case control returns to the calling application. When this function
695 * is recalled we will resume in the same state where we left off.
697 * WRITE_STATE_SEND sends the message and performs any work to be done after
700 * WRITE_STATE_POST_WORK performs any work necessary after the sending of the
701 * message has been completed. As for WRITE_STATE_PRE_WORK this could also
702 * result in an NBIO event.
704 static SUB_STATE_RETURN write_state_machine(SSL *s)
706 OSSL_STATEM *st = &s->statem;
708 WRITE_TRAN(*transition) (SSL *s);
709 WORK_STATE(*pre_work) (SSL *s, WORK_STATE wst);
710 WORK_STATE(*post_work) (SSL *s, WORK_STATE wst);
711 int (*get_construct_message_f) (SSL *s, WPACKET *pkt,
712 int (**confunc) (SSL *s, WPACKET *pkt),
714 void (*cb) (const SSL *ssl, int type, int val) = NULL;
715 int (*confunc) (SSL *s, WPACKET *pkt);
719 cb = get_callback(s);
722 transition = ossl_statem_server_write_transition;
723 pre_work = ossl_statem_server_pre_work;
724 post_work = ossl_statem_server_post_work;
725 get_construct_message_f = ossl_statem_server_construct_message;
727 transition = ossl_statem_client_write_transition;
728 pre_work = ossl_statem_client_pre_work;
729 post_work = ossl_statem_client_post_work;
730 get_construct_message_f = ossl_statem_client_construct_message;
734 switch (st->write_state) {
735 case WRITE_STATE_TRANSITION:
737 /* Notify callback of an impending state change */
739 cb(s, SSL_CB_ACCEPT_LOOP, 1);
741 cb(s, SSL_CB_CONNECT_LOOP, 1);
743 switch (transition(s)) {
744 case WRITE_TRAN_CONTINUE:
745 st->write_state = WRITE_STATE_PRE_WORK;
746 st->write_state_work = WORK_MORE_A;
749 case WRITE_TRAN_FINISHED:
750 return SUB_STATE_FINISHED;
753 case WRITE_TRAN_ERROR:
754 return SUB_STATE_ERROR;
758 case WRITE_STATE_PRE_WORK:
759 switch (st->write_state_work = pre_work(s, st->write_state_work)) {
763 return SUB_STATE_ERROR;
765 case WORK_FINISHED_CONTINUE:
766 st->write_state = WRITE_STATE_SEND;
769 case WORK_FINISHED_STOP:
770 return SUB_STATE_END_HANDSHAKE;
772 if (!WPACKET_init(&pkt, s->init_buf)
773 || !get_construct_message_f(s, &pkt, &confunc, &mt)
774 || !ssl_set_handshake_header(s, &pkt, mt)
775 || (confunc != NULL && !confunc(s, &pkt))
776 || !ssl_close_construct_packet(s, &pkt, mt)
777 || !WPACKET_finish(&pkt)) {
778 WPACKET_cleanup(&pkt);
779 ossl_statem_set_error(s);
780 return SUB_STATE_ERROR;
785 case WRITE_STATE_SEND:
786 if (SSL_IS_DTLS(s) && st->use_timer) {
787 dtls1_start_timer(s);
789 ret = statem_do_write(s);
791 return SUB_STATE_ERROR;
793 st->write_state = WRITE_STATE_POST_WORK;
794 st->write_state_work = WORK_MORE_A;
797 case WRITE_STATE_POST_WORK:
798 switch (st->write_state_work = post_work(s, st->write_state_work)) {
802 return SUB_STATE_ERROR;
804 case WORK_FINISHED_CONTINUE:
805 st->write_state = WRITE_STATE_TRANSITION;
808 case WORK_FINISHED_STOP:
809 return SUB_STATE_END_HANDSHAKE;
814 return SUB_STATE_ERROR;
820 * Flush the write BIO
822 int statem_flush(SSL *s)
824 s->rwstate = SSL_WRITING;
825 if (BIO_flush(s->wbio) <= 0) {
828 s->rwstate = SSL_NOTHING;
834 * Called by the record layer to determine whether application data is
835 * allowed to be sent in the current handshake state or not.
838 * 1: Yes (application data allowed)
839 * 0: No (application data not allowed)
841 int ossl_statem_app_data_allowed(SSL *s)
843 OSSL_STATEM *st = &s->statem;
845 if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE)
848 if (!s->s3->in_read_app_data || (s->s3->total_renegotiations == 0))
853 * If we're a server and we haven't got as far as writing our
854 * ServerHello yet then we allow app data
856 if (st->hand_state == TLS_ST_BEFORE
857 || st->hand_state == TLS_ST_SR_CLNT_HELLO)
861 * If we're a client and we haven't read the ServerHello yet then we
864 if (st->hand_state == TLS_ST_CW_CLNT_HELLO)
871 #ifndef OPENSSL_NO_SCTP
873 * Set flag used by SCTP to determine whether we are in the read sock state
875 void ossl_statem_set_sctp_read_sock(SSL *s, int read_sock)
877 s->statem.in_sctp_read_sock = read_sock;
881 * Called by the record layer to determine whether we are in the read sock
885 * 1: Yes (we are in the read sock state)
886 * 0: No (we are not in the read sock state)
888 int ossl_statem_in_sctp_read_sock(SSL *s)
890 return s->statem.in_sctp_read_sock;