2015-07-29 13:23:56 +00:00
|
|
|
/*
|
2016-05-17 18:18:30 +00:00
|
|
|
* Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
|
2015-07-29 13:23:56 +00:00
|
|
|
*
|
2016-05-17 18:18:30 +00:00
|
|
|
* 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
|
2015-07-29 13:23:56 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include <openssl/rand.h>
|
2015-09-11 09:48:59 +00:00
|
|
|
#include "../ssl_locl.h"
|
2015-09-11 10:23:20 +00:00
|
|
|
#include "statem_locl.h"
|
2015-07-29 13:23:56 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* 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 |
|
2015-09-11 10:23:20 +00:00
|
|
|
* | | MSG_FLOW_READING | | MSG_FLOW_WRITING | | Event | machine |
|
2015-07-29 13:23:56 +00:00
|
|
|
* | | sub-state | | sub-state | |----------->| |
|
|
|
|
* | | machine for | | machine for | | | |
|
|
|
|
* | | reading messages | | writing messages | | | |
|
|
|
|
* | -------------------- -------------------- | | |
|
|
|
|
* | | | |
|
|
|
|
* --------------------------------------------- -------------------
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Sub state machine return values */
|
2015-10-05 10:03:27 +00:00
|
|
|
typedef enum {
|
2015-07-29 13:23:56 +00:00
|
|
|
/* 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
|
2015-10-05 10:03:27 +00:00
|
|
|
} SUB_STATE_RETURN;
|
2015-07-29 13:23:56 +00:00
|
|
|
|
2015-09-07 15:36:53 +00:00
|
|
|
static int state_machine(SSL *s, int server);
|
2015-07-29 13:23:56 +00:00
|
|
|
static void init_read_state_machine(SSL *s);
|
2015-10-05 10:03:27 +00:00
|
|
|
static SUB_STATE_RETURN read_state_machine(SSL *s);
|
2015-07-29 13:23:56 +00:00
|
|
|
static void init_write_state_machine(SSL *s);
|
2015-10-05 10:03:27 +00:00
|
|
|
static SUB_STATE_RETURN write_state_machine(SSL *s);
|
2015-09-08 08:13:50 +00:00
|
|
|
|
2015-10-05 09:49:15 +00:00
|
|
|
OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl)
|
2015-09-08 08:13:50 +00:00
|
|
|
{
|
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
2015-07-29 13:23:56 +00:00
|
|
|
/*
|
|
|
|
* Clear the state machine state and reset back to MSG_FLOW_UNINITED
|
|
|
|
*/
|
2015-10-05 09:39:54 +00:00
|
|
|
void ossl_statem_clear(SSL *s)
|
2015-07-29 13:23:56 +00:00
|
|
|
{
|
|
|
|
s->statem.state = MSG_FLOW_UNINITED;
|
2015-09-08 08:13:50 +00:00
|
|
|
s->statem.hand_state = TLS_ST_BEFORE;
|
|
|
|
s->statem.in_init = 1;
|
2015-10-05 09:44:41 +00:00
|
|
|
s->statem.no_cert_verify = 0;
|
2015-07-29 13:23:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Set the state machine up ready for a renegotiation handshake
|
|
|
|
*/
|
2015-10-05 09:39:54 +00:00
|
|
|
void ossl_statem_set_renegotiate(SSL *s)
|
2015-07-29 13:23:56 +00:00
|
|
|
{
|
|
|
|
s->statem.state = MSG_FLOW_RENEGOTIATE;
|
2015-09-10 08:11:41 +00:00
|
|
|
s->statem.in_init = 1;
|
2015-07-29 13:23:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Put the state machine into an error state. This is a permanent error for
|
|
|
|
* the current connection.
|
|
|
|
*/
|
2015-10-05 09:39:54 +00:00
|
|
|
void ossl_statem_set_error(SSL *s)
|
2015-07-29 13:23:56 +00:00
|
|
|
{
|
|
|
|
s->statem.state = MSG_FLOW_ERROR;
|
2015-09-08 08:13:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Discover whether the current connection is in the error state.
|
|
|
|
*
|
|
|
|
* Valid return values are:
|
|
|
|
* 1: Yes
|
|
|
|
* 0: No
|
|
|
|
*/
|
2015-10-05 09:39:54 +00:00
|
|
|
int ossl_statem_in_error(const SSL *s)
|
2015-09-08 08:13:50 +00:00
|
|
|
{
|
|
|
|
if (s->statem.state == MSG_FLOW_ERROR)
|
|
|
|
return 1;
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2015-10-05 09:39:54 +00:00
|
|
|
void ossl_statem_set_in_init(SSL *s, int init)
|
2015-09-08 08:13:50 +00:00
|
|
|
{
|
|
|
|
s->statem.in_init = init;
|
2015-07-29 13:23:56 +00:00
|
|
|
}
|
|
|
|
|
2015-10-22 12:57:18 +00:00
|
|
|
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--;
|
|
|
|
}
|
|
|
|
|
2015-10-22 11:18:45 +00:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2015-10-05 09:39:54 +00:00
|
|
|
int ossl_statem_connect(SSL *s) {
|
2015-09-07 15:36:53 +00:00
|
|
|
return state_machine(s, 0);
|
|
|
|
}
|
|
|
|
|
2015-10-05 09:39:54 +00:00
|
|
|
int ossl_statem_accept(SSL *s)
|
2015-09-04 12:51:49 +00:00
|
|
|
{
|
|
|
|
return state_machine(s, 1);
|
|
|
|
}
|
|
|
|
|
2015-10-05 10:28:51 +00:00
|
|
|
static void (*get_callback(SSL *s))(const SSL *, int, int)
|
|
|
|
{
|
|
|
|
if (s->info_callback != NULL)
|
|
|
|
return s->info_callback;
|
|
|
|
else if (s->ctx->info_callback != NULL)
|
|
|
|
return s->ctx->info_callback;
|
|
|
|
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2015-07-29 13:23:56 +00:00
|
|
|
/*
|
|
|
|
* 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
|
|
|
|
*/
|
2015-12-29 08:24:17 +00:00
|
|
|
static int state_machine(SSL *s, int server)
|
|
|
|
{
|
2015-07-29 13:23:56 +00:00
|
|
|
BUF_MEM *buf = NULL;
|
|
|
|
unsigned long Time = (unsigned long)time(NULL);
|
|
|
|
void (*cb) (const SSL *ssl, int type, int val) = NULL;
|
2015-10-05 09:58:52 +00:00
|
|
|
OSSL_STATEM *st = &s->statem;
|
2015-07-29 13:23:56 +00:00
|
|
|
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();
|
|
|
|
|
2015-10-05 10:28:51 +00:00
|
|
|
cb = get_callback(s);
|
2015-07-29 13:23:56 +00:00
|
|
|
|
2015-10-22 12:57:18 +00:00
|
|
|
st->in_handshake++;
|
2015-07-29 13:23:56 +00:00
|
|
|
if (!SSL_in_init(s) || SSL_in_before(s)) {
|
|
|
|
if (!SSL_clear(s))
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
2015-09-07 21:00:36 +00:00
|
|
|
#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,
|
2015-10-22 12:57:18 +00:00
|
|
|
st->in_handshake, NULL);
|
2015-09-07 21:00:36 +00:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2015-07-29 13:23:56 +00:00
|
|
|
#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) &&
|
|
|
|
(server
|
|
|
|
|| (s->version & 0xff00) != (DTLS1_BAD_VER & 0xff00))) {
|
|
|
|
SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
|
|
|
|
goto end;
|
|
|
|
}
|
|
|
|
} else {
|
2015-12-29 08:24:17 +00:00
|
|
|
if ((s->version >> 8) != SSL3_VERSION_MAJOR) {
|
2015-07-29 13:23:56 +00:00
|
|
|
SSLerr(SSL_F_STATE_MACHINE, ERR_R_INTERNAL_ERROR);
|
|
|
|
goto end;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-12-29 08:24:17 +00:00
|
|
|
if (!ssl_security(s, SSL_SECOP_VERSION, 0, s->version, NULL)) {
|
|
|
|
SSLerr(SSL_F_STATE_MACHINE, SSL_R_VERSION_TOO_LOW);
|
|
|
|
goto end;
|
2015-07-29 13:23:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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;
|
|
|
|
|
2016-05-17 11:28:14 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Ok, we now need to push on a buffering BIO ...but not with
|
|
|
|
* SCTP
|
|
|
|
*/
|
2015-07-29 13:23:56 +00:00
|
|
|
#ifndef OPENSSL_NO_SCTP
|
2016-05-17 11:28:14 +00:00
|
|
|
if (!SSL_IS_DTLS(s) || !BIO_dgram_is_sctp(SSL_get_wbio(s)))
|
2015-07-29 13:23:56 +00:00
|
|
|
#endif
|
2016-05-17 11:28:14 +00:00
|
|
|
if (!ssl_init_wbio_buffer(s)) {
|
|
|
|
goto end;
|
|
|
|
}
|
2015-07-29 13:23:56 +00:00
|
|
|
|
2016-06-03 10:59:19 +00:00
|
|
|
if (!server || st->state != MSG_FLOW_RENEGOTIATE) {
|
|
|
|
if (!ssl3_init_finished_mac(s)) {
|
|
|
|
ossl_statem_set_error(s);
|
|
|
|
goto end;
|
|
|
|
}
|
|
|
|
}
|
2015-07-29 13:23:56 +00:00
|
|
|
|
|
|
|
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);
|
2015-10-05 09:39:54 +00:00
|
|
|
ossl_statem_set_error(s);
|
2015-07-29 13:23:56 +00:00
|
|
|
goto end;
|
|
|
|
} else {
|
|
|
|
/*
|
2015-09-11 11:11:39 +00:00
|
|
|
* st->state == MSG_FLOW_RENEGOTIATE, we will just send a
|
2015-07-29 13:23:56 +00:00
|
|
|
* 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;
|
|
|
|
}
|
|
|
|
|
2016-06-28 22:18:50 +00:00
|
|
|
while (st->state != MSG_FLOW_FINISHED) {
|
|
|
|
if (st->state == MSG_FLOW_READING) {
|
2015-07-29 13:23:56 +00:00
|
|
|
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 */
|
2015-10-05 09:39:54 +00:00
|
|
|
ossl_statem_set_error(s);
|
2015-07-29 13:23:56 +00:00
|
|
|
goto end;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
st->state = MSG_FLOW_UNINITED;
|
|
|
|
ret = 1;
|
|
|
|
|
|
|
|
end:
|
2015-10-22 12:57:18 +00:00
|
|
|
st->in_handshake--;
|
2015-09-07 21:00:36 +00:00
|
|
|
|
|
|
|
#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,
|
2015-10-22 12:57:18 +00:00
|
|
|
st->in_handshake, NULL);
|
2015-09-07 21:00:36 +00:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2015-07-29 13:23:56 +00:00
|
|
|
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)
|
|
|
|
{
|
2015-10-05 09:58:52 +00:00
|
|
|
OSSL_STATEM *st = &s->statem;
|
2015-07-29 13:23:56 +00:00
|
|
|
|
|
|
|
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.
|
|
|
|
*
|
2016-02-05 20:23:54 +00:00
|
|
|
* Any of the above states could result in an NBIO event occurring in which case
|
2015-07-29 13:23:56 +00:00
|
|
|
* control returns to the calling application. When this function is recalled we
|
|
|
|
* will resume in the same state where we left off.
|
|
|
|
*/
|
2015-10-05 10:03:27 +00:00
|
|
|
static SUB_STATE_RETURN read_state_machine(SSL *s) {
|
2015-10-05 09:58:52 +00:00
|
|
|
OSSL_STATEM *st = &s->statem;
|
2015-07-29 13:23:56 +00:00
|
|
|
int ret, mt;
|
2015-10-22 14:13:20 +00:00
|
|
|
unsigned long len = 0;
|
2015-07-29 13:23:56 +00:00
|
|
|
int (*transition)(SSL *s, int mt);
|
2015-09-10 09:22:30 +00:00
|
|
|
PACKET pkt;
|
2015-10-26 11:46:33 +00:00
|
|
|
MSG_PROCESS_RETURN (*process_message)(SSL *s, PACKET *pkt);
|
|
|
|
WORK_STATE (*post_process_message)(SSL *s, WORK_STATE wst);
|
2015-07-29 13:23:56 +00:00
|
|
|
unsigned long (*max_message_size)(SSL *s);
|
|
|
|
void (*cb) (const SSL *ssl, int type, int val) = NULL;
|
|
|
|
|
2015-10-05 10:28:51 +00:00
|
|
|
cb = get_callback(s);
|
2015-07-29 13:23:56 +00:00
|
|
|
|
2016-06-28 22:18:50 +00:00
|
|
|
if (s->server) {
|
2015-10-26 11:54:17 +00:00
|
|
|
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;
|
2015-07-29 13:23:56 +00:00
|
|
|
} else {
|
2015-10-26 11:54:17 +00:00
|
|
|
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;
|
2015-07-29 13:23:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (st->read_state_first_init) {
|
|
|
|
s->first_packet = 1;
|
|
|
|
st->read_state_first_init = 0;
|
|
|
|
}
|
|
|
|
|
2016-06-28 22:18:50 +00:00
|
|
|
while (1) {
|
|
|
|
switch (st->read_state) {
|
2015-07-29 13:23:56 +00:00
|
|
|
case READ_STATE_HEADER:
|
|
|
|
/* Get the state the peer wants to move to */
|
2015-08-11 10:41:03 +00:00
|
|
|
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);
|
|
|
|
}
|
2015-07-29 13:23:56 +00:00
|
|
|
|
|
|
|
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
|
|
|
|
*/
|
2016-06-28 22:18:50 +00:00
|
|
|
if (!transition(s, mt)) {
|
2016-06-22 18:43:46 +00:00
|
|
|
ossl_statem_set_error(s);
|
2015-07-29 13:23:56 +00:00
|
|
|
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;
|
2015-09-10 09:22:30 +00:00
|
|
|
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);
|
2016-05-12 16:18:32 +00:00
|
|
|
|
|
|
|
/* Discard the packet data */
|
|
|
|
s->init_num = 0;
|
|
|
|
|
2015-07-29 13:23:56 +00:00
|
|
|
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);
|
2016-06-28 22:18:50 +00:00
|
|
|
switch (st->read_state_work) {
|
2015-07-29 13:23:56 +00:00
|
|
|
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);
|
2015-10-05 09:39:54 +00:00
|
|
|
ossl_statem_set_error(s);
|
2015-07-29 13:23:56 +00:00
|
|
|
return SUB_STATE_ERROR;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Send a previously constructed message to the peer.
|
|
|
|
*/
|
|
|
|
static int statem_do_write(SSL *s)
|
|
|
|
{
|
2015-10-05 09:58:52 +00:00
|
|
|
OSSL_STATEM *st = &s->statem;
|
2015-07-29 13:23:56 +00:00
|
|
|
|
|
|
|
if (st->hand_state == TLS_ST_CW_CHANGE
|
|
|
|
|| st->hand_state == TLS_ST_SW_CHANGE) {
|
|
|
|
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)
|
|
|
|
{
|
2015-10-05 09:58:52 +00:00
|
|
|
OSSL_STATEM *st = &s->statem;
|
2015-07-29 13:23:56 +00:00
|
|
|
|
|
|
|
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
|
2016-02-05 20:23:54 +00:00
|
|
|
* sending of the message. This could result in an NBIO event occurring in
|
2015-07-29 13:23:56 +00:00
|
|
|
* 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.
|
|
|
|
*/
|
2015-10-05 10:03:27 +00:00
|
|
|
static SUB_STATE_RETURN write_state_machine(SSL *s)
|
2015-07-29 13:23:56 +00:00
|
|
|
{
|
2015-10-05 09:58:52 +00:00
|
|
|
OSSL_STATEM *st = &s->statem;
|
2015-07-29 13:23:56 +00:00
|
|
|
int ret;
|
2015-10-26 11:46:33 +00:00
|
|
|
WRITE_TRAN (*transition)(SSL *s);
|
|
|
|
WORK_STATE (*pre_work)(SSL *s, WORK_STATE wst);
|
|
|
|
WORK_STATE (*post_work)(SSL *s, WORK_STATE wst);
|
2015-07-29 13:23:56 +00:00
|
|
|
int (*construct_message)(SSL *s);
|
|
|
|
void (*cb) (const SSL *ssl, int type, int val) = NULL;
|
|
|
|
|
2015-10-05 10:28:51 +00:00
|
|
|
cb = get_callback(s);
|
2015-07-29 13:23:56 +00:00
|
|
|
|
2016-06-28 22:18:50 +00:00
|
|
|
if (s->server) {
|
2015-10-26 11:54:17 +00:00
|
|
|
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;
|
2015-07-29 13:23:56 +00:00
|
|
|
} else {
|
2015-10-26 11:54:17 +00:00
|
|
|
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;
|
2015-07-29 13:23:56 +00:00
|
|
|
}
|
|
|
|
|
2016-06-28 22:18:50 +00:00
|
|
|
while (1) {
|
|
|
|
switch (st->write_state) {
|
2015-07-29 13:23:56 +00:00
|
|
|
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);
|
|
|
|
}
|
2016-06-28 22:18:50 +00:00
|
|
|
switch (transition(s)) {
|
2015-07-29 13:23:56 +00:00
|
|
|
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:
|
2016-06-28 22:18:50 +00:00
|
|
|
switch (st->write_state_work = pre_work(s, st->write_state_work)) {
|
2015-07-29 13:23:56 +00:00
|
|
|
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;
|
|
|
|
}
|
2016-06-28 22:18:50 +00:00
|
|
|
if (construct_message(s) == 0)
|
2015-07-29 13:23:56 +00:00
|
|
|
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:
|
2016-06-28 22:18:50 +00:00
|
|
|
switch (st->write_state_work = post_work(s, st->write_state_work)) {
|
2015-07-29 13:23:56 +00:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-09-07 15:36:53 +00:00
|
|
|
/*
|
|
|
|
* Flush the write BIO
|
|
|
|
*/
|
2015-09-11 10:23:20 +00:00
|
|
|
int statem_flush(SSL *s)
|
2015-09-07 15:36:53 +00:00
|
|
|
{
|
|
|
|
s->rwstate = SSL_WRITING;
|
|
|
|
if (BIO_flush(s->wbio) <= 0) {
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
s->rwstate = SSL_NOTHING;
|
|
|
|
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
|
2015-07-29 13:23:56 +00:00
|
|
|
/*
|
|
|
|
* 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)
|
|
|
|
*/
|
2015-10-05 09:39:54 +00:00
|
|
|
int ossl_statem_app_data_allowed(SSL *s)
|
2015-07-29 13:23:56 +00:00
|
|
|
{
|
2015-10-05 09:58:52 +00:00
|
|
|
OSSL_STATEM *st = &s->statem;
|
2015-07-29 13:23:56 +00:00
|
|
|
|
2015-09-08 08:19:22 +00:00
|
|
|
if (st->state == MSG_FLOW_UNINITED || st->state == MSG_FLOW_RENEGOTIATE)
|
2015-09-07 15:36:53 +00:00
|
|
|
return 0;
|
|
|
|
|
2015-09-08 08:19:22 +00:00
|
|
|
if (!s->s3->in_read_app_data || (s->s3->total_renegotiations == 0))
|
|
|
|
return 0;
|
2015-09-07 15:36:53 +00:00
|
|
|
|
2015-09-08 08:19:22 +00:00
|
|
|
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
|
|
|
|
|| st->hand_state == TLS_ST_SR_CLNT_HELLO)
|
|
|
|
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)
|
2015-09-07 15:36:53 +00:00
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
#ifndef OPENSSL_NO_SCTP
|
|
|
|
/*
|
|
|
|
* Set flag used by SCTP to determine whether we are in the read sock state
|
|
|
|
*/
|
2015-10-05 09:39:54 +00:00
|
|
|
void ossl_statem_set_sctp_read_sock(SSL *s, int read_sock)
|
2015-09-07 15:36:53 +00:00
|
|
|
{
|
|
|
|
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)
|
|
|
|
*/
|
2015-11-06 10:25:08 +00:00
|
|
|
int ossl_statem_in_sctp_read_sock(SSL *s)
|
2015-09-07 15:36:53 +00:00
|
|
|
{
|
|
|
|
return s->statem.in_sctp_read_sock;
|
|
|
|
}
|
|
|
|
#endif
|