1 2 3 4 5 6 7 8 9 10 11 12 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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
|
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
#include "testlib/s2n_ktls_test_utils.h"
S2N_RESULT s2n_ktls_set_control_data(struct msghdr *msg, char *buf, size_t buf_size,
int cmsg_type, uint8_t record_type);
S2N_RESULT s2n_ktls_get_control_data(struct msghdr *msg, int cmsg_type, uint8_t *record_type);
/* Since it is possible to read partial data, we need a way to update the length
* of the previous record for the mock stuffer IO implementation. */
static S2N_RESULT s2n_test_ktls_update_prev_header_len(struct s2n_test_ktls_io_stuffer *io_ctx,
uint16_t remaining_len)
{
RESULT_ENSURE_REF(io_ctx);
RESULT_ENSURE(remaining_len > 0, S2N_ERR_IO);
/* rewind so we can read the last header with the updated len */
RESULT_GUARD_POSIX(s2n_stuffer_rewind_read(&io_ctx->ancillary_buffer, S2N_TEST_KTLS_MOCK_HEADER_SIZE));
/* get position for the last header's length */
uint32_t rewrite_len_ptr = io_ctx->ancillary_buffer.read_cursor + S2N_TEST_KTLS_MOCK_HEADER_TAG_SIZE;
/* create a new stuffer pointing to len data and rewrite it */
struct s2n_stuffer rewrite_len_stuffer = io_ctx->ancillary_buffer;
RESULT_GUARD_POSIX(s2n_stuffer_rewrite(&rewrite_len_stuffer));
RESULT_GUARD_POSIX(s2n_stuffer_skip_write(&rewrite_len_stuffer, rewrite_len_ptr));
RESULT_GUARD_POSIX(s2n_stuffer_write_uint16(&rewrite_len_stuffer, remaining_len));
return S2N_RESULT_OK;
}
ssize_t s2n_test_ktls_sendmsg_io_stuffer(void *io_context, const struct msghdr *msg)
{
errno = EINVAL;
POSIX_ENSURE_REF(msg);
struct s2n_test_ktls_io_stuffer *io_ctx = (struct s2n_test_ktls_io_stuffer *) io_context;
POSIX_ENSURE_REF(io_ctx);
struct s2n_stuffer *data_buffer = &io_ctx->data_buffer;
io_ctx->sendmsg_invoked_count++;
uint8_t record_type = 0;
struct msghdr msg_to_parse = *msg;
POSIX_GUARD_RESULT(s2n_ktls_get_control_data(&msg_to_parse, S2N_TLS_SET_RECORD_TYPE, &record_type));
size_t total_len = 0;
for (size_t count = 0; count < msg->msg_iovlen; count++) {
POSIX_ENSURE_REF(msg->msg_iov);
uint8_t *buf = msg->msg_iov[count].iov_base;
size_t len = msg->msg_iov[count].iov_len;
if (s2n_stuffer_write_bytes(data_buffer, buf, len) != S2N_SUCCESS) {
size_t partial_len = MIN(len, s2n_stuffer_space_remaining(data_buffer));
POSIX_GUARD(s2n_stuffer_write_bytes(data_buffer, buf, partial_len));
total_len += partial_len;
if (total_len) {
break;
}
errno = EAGAIN;
return -1;
}
total_len += len;
}
if (total_len) {
/* write record_type and len after some data was written successfully */
POSIX_GUARD(s2n_stuffer_write_uint8(&io_ctx->ancillary_buffer, record_type));
POSIX_GUARD(s2n_stuffer_write_uint16(&io_ctx->ancillary_buffer, total_len));
}
return total_len;
}
/* In userspace TLS, s2n first reads the header to determine the length of next record
* and then reads the entire record into conn->in. In kTLS it is not possible to know
* the length of the next record. Instead the socket returns the minimum of
* bytes-requested and data-available, reading multiple consecutive records if they
* are of the same type. */
ssize_t s2n_test_ktls_recvmsg_io_stuffer(void *io_context, struct msghdr *msg)
{
errno = EINVAL;
POSIX_ENSURE_REF(msg);
POSIX_ENSURE_REF(msg->msg_iov);
struct s2n_test_ktls_io_stuffer *io_ctx = (struct s2n_test_ktls_io_stuffer *) io_context;
POSIX_ENSURE_REF(io_ctx);
io_ctx->recvmsg_invoked_count++;
uint8_t *buf = msg->msg_iov->iov_base;
POSIX_ENSURE_REF(buf);
/* There is no data available so return blocked */
if (!s2n_stuffer_data_available(&io_ctx->ancillary_buffer)) {
errno = EAGAIN;
return -1;
}
/* s2n only receives using msg_iovlen of 1 */
POSIX_ENSURE_EQ(msg->msg_iovlen, 1);
size_t size = msg->msg_iov->iov_len;
uint8_t record_type = 0;
POSIX_GUARD(s2n_stuffer_read_uint8(&io_ctx->ancillary_buffer, &record_type));
POSIX_GUARD_RESULT(s2n_ktls_set_control_data(msg, msg->msg_control, msg->msg_controllen,
S2N_TLS_GET_RECORD_TYPE, record_type));
ssize_t bytes_read = 0;
while (bytes_read < size) {
uint16_t n_avail = 0;
POSIX_GUARD(s2n_stuffer_read_uint16(&io_ctx->ancillary_buffer, &n_avail));
size_t n_read = MIN(size - bytes_read, n_avail);
POSIX_ENSURE_GT(n_read, 0);
POSIX_GUARD(s2n_stuffer_read_bytes(&io_ctx->data_buffer, buf + bytes_read, n_read));
bytes_read += n_read;
/* handle partially read records */
ssize_t remaining_len = n_avail - n_read;
if (remaining_len) {
POSIX_GUARD_RESULT(s2n_test_ktls_update_prev_header_len(io_ctx, remaining_len));
break;
}
/* attempt to read multiple records (must be of the same type) */
uint8_t next_record_type = 0;
int ret = s2n_stuffer_peek_char(&io_ctx->ancillary_buffer, (char *) &next_record_type);
bool no_more_records = ret != S2N_SUCCESS;
if (no_more_records) {
break;
}
bool next_record_different_type = next_record_type != record_type;
if (next_record_different_type) {
break;
}
POSIX_GUARD(s2n_stuffer_skip_read(&io_ctx->ancillary_buffer, sizeof(record_type)));
}
return bytes_read;
}
S2N_RESULT s2n_test_init_ktls_io_stuffer_send(struct s2n_connection *conn,
struct s2n_test_ktls_io_stuffer *io)
{
RESULT_ENSURE_REF(conn);
RESULT_ENSURE_REF(io);
RESULT_GUARD_POSIX(s2n_stuffer_growable_alloc(&io->data_buffer, 0));
RESULT_GUARD_POSIX(s2n_stuffer_growable_alloc(&io->ancillary_buffer, 0));
RESULT_GUARD(s2n_ktls_set_sendmsg_cb(conn, s2n_test_ktls_sendmsg_io_stuffer, io));
return S2N_RESULT_OK;
}
S2N_RESULT s2n_test_init_ktls_io_stuffer(struct s2n_connection *server,
struct s2n_connection *client, struct s2n_test_ktls_io_stuffer_pair *io_pair)
{
RESULT_ENSURE_REF(server);
RESULT_ENSURE_REF(client);
RESULT_ENSURE_REF(io_pair);
/* setup stuffer IO */
RESULT_GUARD_POSIX(s2n_stuffer_growable_alloc(&io_pair->server_in.data_buffer, 0));
RESULT_GUARD_POSIX(s2n_stuffer_growable_alloc(&io_pair->server_in.ancillary_buffer, 0));
RESULT_GUARD_POSIX(s2n_stuffer_growable_alloc(&io_pair->client_in.data_buffer, 0));
RESULT_GUARD_POSIX(s2n_stuffer_growable_alloc(&io_pair->client_in.ancillary_buffer, 0));
RESULT_GUARD(s2n_ktls_set_sendmsg_cb(server, s2n_test_ktls_sendmsg_io_stuffer, &io_pair->client_in));
RESULT_GUARD(s2n_ktls_set_recvmsg_cb(server, s2n_test_ktls_recvmsg_io_stuffer, &io_pair->server_in));
RESULT_GUARD(s2n_ktls_set_sendmsg_cb(client, s2n_test_ktls_sendmsg_io_stuffer, &io_pair->server_in));
RESULT_GUARD(s2n_ktls_set_recvmsg_cb(client, s2n_test_ktls_recvmsg_io_stuffer, &io_pair->client_in));
return S2N_RESULT_OK;
}
S2N_CLEANUP_RESULT s2n_ktls_io_stuffer_free(struct s2n_test_ktls_io_stuffer *io)
{
RESULT_ENSURE_REF(io);
RESULT_GUARD_POSIX(s2n_stuffer_free(&io->data_buffer));
RESULT_GUARD_POSIX(s2n_stuffer_free(&io->ancillary_buffer));
return S2N_RESULT_OK;
}
S2N_CLEANUP_RESULT s2n_ktls_io_stuffer_pair_free(struct s2n_test_ktls_io_stuffer_pair *pair)
{
RESULT_ENSURE_REF(pair);
RESULT_GUARD(s2n_ktls_io_stuffer_free(&pair->client_in));
RESULT_GUARD(s2n_ktls_io_stuffer_free(&pair->server_in));
return S2N_RESULT_OK;
}
S2N_RESULT s2n_test_validate_data(struct s2n_test_ktls_io_stuffer *ktls_io,
const uint8_t *expected_data, uint16_t expected_len)
{
RESULT_ENSURE_REF(ktls_io);
RESULT_ENSURE_REF(expected_data);
struct s2n_stuffer validate_data_stuffer = ktls_io->data_buffer;
RESULT_ENSURE_EQ(s2n_stuffer_data_available(&validate_data_stuffer), expected_len);
uint8_t *data_ptr = s2n_stuffer_raw_read(&validate_data_stuffer, expected_len);
RESULT_ENSURE_REF(data_ptr);
RESULT_ENSURE_EQ(memcmp(data_ptr, expected_data, expected_len), 0);
return S2N_RESULT_OK;
}
S2N_RESULT s2n_test_validate_ancillary(struct s2n_test_ktls_io_stuffer *ktls_io,
uint8_t expected_record_type, uint16_t expected_len)
{
RESULT_ENSURE_REF(ktls_io);
struct s2n_stuffer validate_ancillary_stuffer = ktls_io->ancillary_buffer;
uint8_t tag = 0;
RESULT_GUARD_POSIX(s2n_stuffer_read_uint8(&validate_ancillary_stuffer, &tag));
RESULT_ENSURE_EQ(tag, expected_record_type);
uint16_t len = 0;
RESULT_GUARD_POSIX(s2n_stuffer_read_uint16(&validate_ancillary_stuffer, &len));
RESULT_ENSURE_EQ(len, expected_len);
return S2N_RESULT_OK;
}
S2N_RESULT s2n_test_records_in_ancillary(struct s2n_test_ktls_io_stuffer *ktls_io,
uint16_t expected_records)
{
RESULT_ENSURE_REF(ktls_io);
size_t size = s2n_stuffer_data_available(&ktls_io->ancillary_buffer);
size_t records = size / S2N_TEST_KTLS_MOCK_HEADER_SIZE;
size_t extra = size % S2N_TEST_KTLS_MOCK_HEADER_SIZE;
RESULT_ENSURE_EQ(records, expected_records);
RESULT_ENSURE_EQ(extra, 0);
return S2N_RESULT_OK;
}
|