openssl/ssl/quic/quic_dummy_handshake.c
Hugo Landau f71ae05a4d QUIC: Dummy Handshake Layer for Prototyping
This disables -Wtype-limits /
-Wtautological-constant-out-of-range-compare. Since it generates
warnings for valid and reasonable code, IMO this actually encourages
people to write worse code.

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19703)
2023-01-13 13:20:09 +00:00

329 lines
12 KiB
C

/*
* Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (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
*/
#include <openssl/macros.h>
#include <openssl/objects.h>
#include "internal/quic_dummy_handshake.h"
#define QUIC_DHS_MSG_TYPE_CH 0x01
#define QUIC_DHS_MSG_TYPE_SH 0x02
#define QUIC_DHS_MSG_TYPE_EE 0x08
#define QUIC_DHS_MSG_TYPE_CERT 0x0B
#define QUIC_DHS_MSG_TYPE_CERT_VERIFY 0x0F
#define QUIC_DHS_MSG_TYPE_FINISHED 0x14
#define QUIC_DHS_STATE_INITIAL 0
#define QUIC_DHS_STATE_SENT_CH 1
#define QUIC_DHS_STATE_RECEIVED_SH 2
#define QUIC_DHS_STATE_RECEIVED_EE_HDR 8
#define QUIC_DHS_STATE_RECEIVED_EE 3
#define QUIC_DHS_STATE_RECEIVED_CERT 4
#define QUIC_DHS_STATE_RECEIVED_CERT_VERIFY 5
#define QUIC_DHS_STATE_RECEIVED_FINISHED 6
#define QUIC_DHS_STATE_SENT_FINISHED 7
#define QUIC_DHS_STATE_ERROR 0xFF
struct quic_dhs_st {
QUIC_DHS_ARGS args;
unsigned char state;
unsigned char *server_transport_params;
size_t server_transport_params_len;
unsigned char rx_hdr[4];
size_t rx_hdr_bytes_read;
size_t rx_ee_bytes_read;
};
QUIC_DHS *ossl_quic_dhs_new(const QUIC_DHS_ARGS *args)
{
QUIC_DHS *dhs;
if (args->crypto_send_cb == NULL
|| args->crypto_recv_cb == NULL)
return NULL;
dhs = OPENSSL_zalloc(sizeof(*dhs));
if (dhs == NULL)
return NULL;
dhs->args = *args;
dhs->state = QUIC_DHS_STATE_INITIAL;
return dhs;
}
void ossl_quic_dhs_free(QUIC_DHS *dhs)
{
if (dhs == NULL)
return;
OPENSSL_free(dhs->server_transport_params);
OPENSSL_free(dhs);
}
static int dhs_send(QUIC_DHS *dhs, unsigned char type,
const void *buf, size_t buf_len)
{
size_t consumed = 0;
uint32_t len;
unsigned char hdr[4];
len = buf_len;
hdr[0] = type;
hdr[1] = (len >> 16) & 0xFF;
hdr[2] = (len >> 8) & 0xFF;
hdr[3] = (len ) & 0xFF;
if (!dhs->args.crypto_send_cb(hdr, sizeof(hdr), &consumed,
dhs->args.crypto_send_cb_arg)
|| consumed < sizeof(hdr)
|| (buf_len > 0 && (!dhs->args.crypto_send_cb(buf, buf_len, &consumed,
dhs->args.crypto_send_cb_arg)
|| consumed < buf_len)))
/*
* We do not handle a full buffer here properly but the DHS produces so
* little data this should not matter. By the time we want to fix this
* the real handshake layer will be ready.
*/
return 0;
return 1;
}
static int dhs_recv_sof(QUIC_DHS *dhs, uint32_t *type, size_t *frame_len)
{
size_t bytes_read = 0;
uint32_t l;
if (!dhs->args.crypto_recv_cb(dhs->rx_hdr + dhs->rx_hdr_bytes_read,
sizeof(dhs->rx_hdr) - dhs->rx_hdr_bytes_read,
&bytes_read,
dhs->args.crypto_recv_cb_arg))
return 0;
dhs->rx_hdr_bytes_read += bytes_read;
if (dhs->rx_hdr_bytes_read < sizeof(dhs->rx_hdr)) {
/* Not got entire header yet. */
*type = UINT32_MAX;
*frame_len = 0;
return 2;
}
l = (((uint32_t)dhs->rx_hdr[1]) << 16)
| (((uint32_t)dhs->rx_hdr[2]) << 8)
| (uint32_t)dhs->rx_hdr[3];
if (l > SIZE_MAX)
return 0;
*type = dhs->rx_hdr[0];
*frame_len = (size_t)l;
dhs->rx_hdr_bytes_read = 0;
return 1;
}
static int dhs_recv_body(QUIC_DHS *dhs, unsigned char *buf, size_t buf_len,
size_t *bytes_read)
{
if (!dhs->args.crypto_recv_cb(buf, buf_len, bytes_read,
dhs->args.crypto_recv_cb_arg))
return 0;
if (*bytes_read == 0)
return 2;
return 1;
}
static const unsigned char default_handshake_read[32] = {42, 2};
static const unsigned char default_handshake_write[32] = {42, 1};
static const unsigned char default_1rtt_read[32] = {43, 2};
static const unsigned char default_1rtt_write[32] = {43, 1};
int ossl_quic_dhs_tick(QUIC_DHS *dhs)
{
int ret;
uint32_t type;
size_t frame_len, bytes_read = 0;
for (;;) {
switch (dhs->state) {
case QUIC_DHS_STATE_INITIAL:
/* We need to send a CH */
if (!dhs_send(dhs, QUIC_DHS_MSG_TYPE_CH,
dhs->args.transport_params,
dhs->args.transport_params_len))
return 0;
dhs->state = QUIC_DHS_STATE_SENT_CH;
break;
case QUIC_DHS_STATE_SENT_CH:
ret = dhs_recv_sof(dhs, &type, &frame_len);
if (ret == 1) {
if (type == QUIC_DHS_MSG_TYPE_SH && frame_len == 0) {
dhs->state = QUIC_DHS_STATE_RECEIVED_SH;
if (!dhs->args.yield_secret_cb(QUIC_ENC_LEVEL_HANDSHAKE,
/*TX=*/0,
QRL_SUITE_AES128GCM,
NULL,
default_handshake_read,
sizeof(default_handshake_read),
dhs->args.yield_secret_cb_arg))
return 0;
if (!dhs->args.yield_secret_cb(QUIC_ENC_LEVEL_HANDSHAKE,
/*TX=*/1,
QRL_SUITE_AES128GCM,
NULL,
default_handshake_write,
sizeof(default_handshake_write),
dhs->args.yield_secret_cb_arg))
return 0;
} else {
return 0; /* error state, unexpected type */
}
} else if (ret == 2) {
return 1; /* no more data yet, not an error */
} else {
return 0;
}
break;
case QUIC_DHS_STATE_RECEIVED_SH:
ret = dhs_recv_sof(dhs, &type, &frame_len);
if (ret == 1) {
if (type == QUIC_DHS_MSG_TYPE_EE) {
dhs->state = QUIC_DHS_STATE_RECEIVED_EE_HDR;
dhs->rx_ee_bytes_read = 0;
dhs->server_transport_params_len = frame_len;
dhs->server_transport_params
= OPENSSL_malloc(dhs->server_transport_params_len);
if (dhs->server_transport_params == NULL)
return 0;
} else {
return 0; /* error state, unexpected type */
}
} else if (ret == 2) {
return 1; /* no more data yet, not an error */
} else {
return 0;
}
break;
case QUIC_DHS_STATE_RECEIVED_EE_HDR:
ret = dhs_recv_body(dhs, dhs->server_transport_params + dhs->rx_ee_bytes_read,
dhs->server_transport_params_len - dhs->rx_ee_bytes_read,
&bytes_read);
if (ret == 1) {
dhs->rx_ee_bytes_read += bytes_read;
if (bytes_read == dhs->server_transport_params_len) {
if (!dhs->args.got_transport_params_cb(dhs->server_transport_params,
dhs->server_transport_params_len,
dhs->args.got_transport_params_cb_arg))
return 0;
dhs->state = QUIC_DHS_STATE_RECEIVED_EE;
}
} else if (ret == 2) {
return 1; /* no more data yet, not an error */
} else {
return 0;
}
break;
case QUIC_DHS_STATE_RECEIVED_EE:
/* Expect Cert */
ret = dhs_recv_sof(dhs, &type, &frame_len);
if (ret == 1) {
if (type == QUIC_DHS_MSG_TYPE_CERT && frame_len == 0)
dhs->state = QUIC_DHS_STATE_RECEIVED_CERT;
else
return 0; /* error state, unexpected type */
} else if (ret == 2) {
return 1; /* no more data yet, not an error */
} else {
return 0;
}
break;
case QUIC_DHS_STATE_RECEIVED_CERT:
/* Expect CertVerify */
ret = dhs_recv_sof(dhs, &type, &frame_len);
if (ret == 1) {
if (type == QUIC_DHS_MSG_TYPE_CERT_VERIFY && frame_len == 0)
dhs->state = QUIC_DHS_STATE_RECEIVED_CERT_VERIFY;
else
return 0; /* error state, unexpected type */
} else if (ret == 2) {
return 1; /* no more data yet, not an error */
} else {
return 0;
}
break;
case QUIC_DHS_STATE_RECEIVED_CERT_VERIFY:
/* Expect Finished */
ret = dhs_recv_sof(dhs, &type, &frame_len);
if (ret == 1) {
if (type == QUIC_DHS_MSG_TYPE_FINISHED && frame_len == 0)
dhs->state = QUIC_DHS_STATE_RECEIVED_FINISHED;
else
return 0; /* error state, unexpected type */
} else if (ret == 2) {
return 1; /* no more data yet, not an error */
} else {
return 0;
}
break;
case QUIC_DHS_STATE_RECEIVED_FINISHED:
/* Send Finished */
if (!dhs_send(dhs, QUIC_DHS_MSG_TYPE_FINISHED, NULL, 0))
return 0;
dhs->state = QUIC_DHS_STATE_SENT_FINISHED;
if (!dhs->args.yield_secret_cb(QUIC_ENC_LEVEL_1RTT,
/*TX=*/0,
QRL_SUITE_AES128GCM,
NULL,
default_1rtt_read,
sizeof(default_1rtt_read),
dhs->args.yield_secret_cb_arg))
return 0;
if (!dhs->args.yield_secret_cb(QUIC_ENC_LEVEL_1RTT,
/*TX=*/1,
QRL_SUITE_AES128GCM,
NULL,
default_1rtt_write,
sizeof(default_1rtt_write),
dhs->args.yield_secret_cb_arg))
return 0;
if (!dhs->args.handshake_complete_cb(dhs->args.handshake_complete_cb_arg))
return 0;
break;
case QUIC_DHS_STATE_SENT_FINISHED:
/* Nothing to do, handshake complete. */
return 1;
default:
return 0; /* error state */
}
}
return 1;
}