File: s2n_connection_protocol_versions_test.c

package info (click to toggle)
aws-crt-python 0.20.4%2Bdfsg-1~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 72,656 kB
  • sloc: ansic: 381,805; python: 23,008; makefile: 6,251; sh: 4,536; cpp: 699; ruby: 208; java: 77; perl: 73; javascript: 46; xml: 11
file content (390 lines) | stat: -rw-r--r-- 19,808 bytes parent folder | download | duplicates (2)
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
/*
* 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 "api/s2n.h"
#include "s2n_test.h"
#include "testlib/s2n_testlib.h"
#include "tls/s2n_tls.h"

static S2N_RESULT s2n_write_test_supported_versions_extension(struct s2n_blob *supported_versions_blob, uint8_t version,
        uint8_t extension_length)
{
    RESULT_ENSURE_REF(supported_versions_blob);

    struct s2n_stuffer supported_versions_stuffer = { 0 };
    RESULT_GUARD_POSIX(s2n_stuffer_init(&supported_versions_stuffer, supported_versions_blob));

    /* Write the length byte. */
    RESULT_GUARD_POSIX(s2n_stuffer_write_uint8(&supported_versions_stuffer, extension_length));
    /* Write the supported version. */
    RESULT_GUARD_POSIX(s2n_stuffer_write_uint8(&supported_versions_stuffer, version / 10));
    RESULT_GUARD_POSIX(s2n_stuffer_write_uint8(&supported_versions_stuffer, version % 10));

    return S2N_RESULT_OK;
}

struct s2n_overwrite_client_hello_ctx {
    uint8_t client_hello_version;
    uint8_t client_supported_version;
    uint8_t extension_length;

    uint8_t supported_versions_data[3];
    int invoked_count;
};

static int s2n_overwrite_client_hello_cb(struct s2n_connection *conn, void *ctx)
{
    EXPECT_NOT_NULL(conn);
    EXPECT_NOT_NULL(ctx);

    struct s2n_overwrite_client_hello_ctx *context = (struct s2n_overwrite_client_hello_ctx *) ctx;
    context->invoked_count += 1;

    if (context->extension_length) {
        struct s2n_blob supported_versions_blob = { 0 };
        EXPECT_SUCCESS(s2n_blob_init(&supported_versions_blob, context->supported_versions_data,
                sizeof(context->supported_versions_data)));

        struct s2n_client_hello *client_hello = s2n_connection_get_client_hello(conn);
        EXPECT_NOT_NULL(client_hello);

        s2n_extension_type_id supported_versions_id = 0;
        EXPECT_SUCCESS(s2n_extension_supported_iana_value_to_id(S2N_EXTENSION_SUPPORTED_VERSIONS, &supported_versions_id));
        s2n_parsed_extension *extension = &client_hello->extensions.parsed_extensions[supported_versions_id];

        EXPECT_OK(s2n_write_test_supported_versions_extension(&supported_versions_blob,
                context->client_supported_version, context->extension_length));

        extension->extension_type = S2N_EXTENSION_SUPPORTED_VERSIONS;
        extension->extension = supported_versions_blob;
    }

    /* The client version fields are set when parsing the client hello before the client hello
     * callback is invoked. The version fields are overridden to emulate receiving a client hello
     * with a different version.
     */
    if (context->client_hello_version) {
        conn->client_hello_version = context->client_hello_version;
        conn->client_protocol_version = context->client_hello_version;
    }

    return S2N_SUCCESS;
}

int main(int argc, char **argv)
{
    BEGIN_TEST();

    DEFER_CLEANUP(struct s2n_cert_chain_and_key *chain_and_key = NULL, s2n_cert_chain_and_key_ptr_free);
    EXPECT_SUCCESS(s2n_test_cert_chain_and_key_new(&chain_and_key,
            S2N_DEFAULT_TEST_CERT_CHAIN, S2N_DEFAULT_TEST_PRIVATE_KEY));

    /* Safety */
    {
        EXPECT_FAILURE_WITH_ERRNO(s2n_connection_get_client_protocol_version(NULL), S2N_ERR_NULL);
        EXPECT_FAILURE_WITH_ERRNO(s2n_connection_get_client_hello_version(NULL), S2N_ERR_NULL);
        EXPECT_FAILURE_WITH_ERRNO(s2n_connection_get_server_protocol_version(NULL), S2N_ERR_NULL);
        EXPECT_FAILURE_WITH_ERRNO(s2n_connection_get_actual_protocol_version(NULL), S2N_ERR_NULL);
    }

    /* Test protocol version getters on the server when a supported versions extension is received */
    for (uint8_t server_version = S2N_TLS12; server_version <= S2N_TLS13; server_version++) {
        for (uint8_t client_hello_version = S2N_SSLv3; client_hello_version <= S2N_TLS12; client_hello_version++) {
            for (uint8_t client_supported_version = S2N_SSLv3; client_supported_version <= S2N_TLS13; client_supported_version++) {
                DEFER_CLEANUP(struct s2n_config *config = s2n_config_new(), s2n_config_ptr_free);
                EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(config, chain_and_key));

                if (server_version == S2N_TLS12) {
                    EXPECT_SUCCESS(s2n_config_set_cipher_preferences(config, "test_all_tls12"));
                } else if (s2n_is_tls13_fully_supported()) {
                    EXPECT_SUCCESS(s2n_config_set_cipher_preferences(config, "test_all"));
                } else {
                    continue;
                }

                struct s2n_overwrite_client_hello_ctx context = {
                    .client_hello_version = client_hello_version,
                    .client_supported_version = client_supported_version,
                    .extension_length = 2,
                };
                EXPECT_SUCCESS(s2n_config_set_client_hello_cb(config, s2n_overwrite_client_hello_cb, &context));

                DEFER_CLEANUP(struct s2n_connection *client = s2n_connection_new(S2N_CLIENT),
                        s2n_connection_ptr_free);
                EXPECT_NOT_NULL(client);
                EXPECT_SUCCESS(s2n_connection_set_config(client, config));

                DEFER_CLEANUP(struct s2n_connection *server = s2n_connection_new(S2N_SERVER),
                        s2n_connection_ptr_free);
                EXPECT_NOT_NULL(server);
                EXPECT_SUCCESS(s2n_connection_set_config(server, config));

                DEFER_CLEANUP(struct s2n_test_io_pair io_pair = { 0 }, s2n_io_pair_close);
                EXPECT_SUCCESS(s2n_io_pair_init_non_blocking(&io_pair));
                EXPECT_SUCCESS(s2n_connections_set_io_pair(client, server, &io_pair));

                EXPECT_OK(s2n_negotiate_test_server_and_client_until_message(server, client, SERVER_HELLO));
                EXPECT_EQUAL(context.invoked_count, 1);

                /* Ensure that a supported versions extension was received. */
                bool supported_versions_received = false;
                EXPECT_SUCCESS(s2n_client_hello_has_extension(&server->client_hello, S2N_EXTENSION_SUPPORTED_VERSIONS,
                        &supported_versions_received));
                EXPECT_TRUE(supported_versions_received);

                EXPECT_EQUAL(s2n_connection_get_server_protocol_version(server), server_version);
                EXPECT_EQUAL(s2n_connection_get_client_hello_version(server), client_hello_version);

                /* The reported client protocol version should always match the version specified
                 * in the supported versions extension, even for TLS 1.2 servers which don't
                 * process the extension for version selection.
                 */
                EXPECT_EQUAL(s2n_connection_get_client_protocol_version(server), client_supported_version);

                uint8_t actual_protocol_version = s2n_connection_get_actual_protocol_version(server);
                if (server_version == S2N_TLS12) {
                    /* For backwards compatibility, TLS 1.2 servers always use the client hello
                     * version to determine the client's maximum version, even if a supported
                     * versions extension was received.
                     */
                    EXPECT_EQUAL(actual_protocol_version, MIN(server_version, client_hello_version));
                } else {
                    /* TLS 1.3 servers always use the version in the supported versions extension,
                     * regardless of the client hello version.
                     */
                    EXPECT_EQUAL(actual_protocol_version, MIN(server_version, client_supported_version));
                }
            }
        }
    }

    /* Test protocol version getters on the server when a supported versions extension isn't received */
    for (uint8_t server_version = S2N_TLS12; server_version <= S2N_TLS13; server_version++) {
        for (uint8_t client_hello_version = S2N_SSLv3; client_hello_version <= S2N_TLS12; client_hello_version++) {
            DEFER_CLEANUP(struct s2n_config *client_config = s2n_config_new(), s2n_config_ptr_free);

            /* A TLS 1.2 security policy is set to prevent the client from sending a supported
             * versions extension.
             */
            EXPECT_SUCCESS(s2n_config_set_cipher_preferences(client_config, "test_all_tls12"));

            DEFER_CLEANUP(struct s2n_config *server_config = s2n_config_new(), s2n_config_ptr_free);
            EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(server_config, chain_and_key));

            if (server_version == S2N_TLS12) {
                EXPECT_SUCCESS(s2n_config_set_cipher_preferences(server_config, "test_all_tls12"));
            } else if (s2n_is_tls13_fully_supported()) {
                EXPECT_SUCCESS(s2n_config_set_cipher_preferences(server_config, "test_all"));
            } else {
                continue;
            }

            struct s2n_overwrite_client_hello_ctx context = {
                .client_hello_version = client_hello_version,
            };
            EXPECT_SUCCESS(s2n_config_set_client_hello_cb(server_config, s2n_overwrite_client_hello_cb, &context));

            DEFER_CLEANUP(struct s2n_connection *client = s2n_connection_new(S2N_CLIENT),
                    s2n_connection_ptr_free);
            EXPECT_NOT_NULL(client);
            EXPECT_SUCCESS(s2n_connection_set_config(client, client_config));

            DEFER_CLEANUP(struct s2n_connection *server = s2n_connection_new(S2N_SERVER),
                    s2n_connection_ptr_free);
            EXPECT_NOT_NULL(server);
            EXPECT_SUCCESS(s2n_connection_set_config(server, server_config));

            DEFER_CLEANUP(struct s2n_test_io_pair io_pair = { 0 }, s2n_io_pair_close);
            EXPECT_SUCCESS(s2n_io_pair_init_non_blocking(&io_pair));
            EXPECT_SUCCESS(s2n_connections_set_io_pair(client, server, &io_pair));

            EXPECT_OK(s2n_negotiate_test_server_and_client_until_message(server, client, SERVER_HELLO));
            EXPECT_EQUAL(context.invoked_count, 1);

            /* Ensure that a supported versions extension wasn't received. */
            bool supported_versions_received = false;
            EXPECT_SUCCESS(s2n_client_hello_has_extension(&server->client_hello, S2N_EXTENSION_SUPPORTED_VERSIONS,
                    &supported_versions_received));
            EXPECT_FALSE(supported_versions_received);

            EXPECT_EQUAL(s2n_connection_get_server_protocol_version(server), server_version);
            EXPECT_EQUAL(s2n_connection_get_client_protocol_version(server), client_hello_version);
            EXPECT_EQUAL(s2n_connection_get_client_hello_version(server), client_hello_version);
            EXPECT_EQUAL(s2n_connection_get_actual_protocol_version(server), client_hello_version);
        }
    }

    /* Test protocol version getters on the client */
    for (uint8_t server_version = S2N_SSLv3; server_version <= S2N_TLS13; server_version++) {
        if (server_version == S2N_TLS13 && !s2n_is_tls13_fully_supported()) {
            continue;
        }

        DEFER_CLEANUP(struct s2n_config *config = s2n_config_new(), s2n_config_ptr_free);
        EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(config, chain_and_key));
        EXPECT_SUCCESS(s2n_config_set_cipher_preferences(config, "test_all"));

        DEFER_CLEANUP(struct s2n_connection *client = s2n_connection_new(S2N_CLIENT), s2n_connection_ptr_free);
        EXPECT_NOT_NULL(client);
        EXPECT_SUCCESS(s2n_connection_set_config(client, config));

        DEFER_CLEANUP(struct s2n_connection *server = s2n_connection_new(S2N_SERVER), s2n_connection_ptr_free);
        EXPECT_NOT_NULL(server);
        EXPECT_SUCCESS(s2n_connection_set_config(server, config));
        server->server_protocol_version = server_version;

        DEFER_CLEANUP(struct s2n_test_io_pair io_pair = { 0 }, s2n_io_pair_close);
        EXPECT_SUCCESS(s2n_io_pair_init_non_blocking(&io_pair));
        EXPECT_SUCCESS(s2n_connections_set_io_pair(client, server, &io_pair));

        EXPECT_OK(s2n_negotiate_test_server_and_client_until_message(server, client, SERVER_CERT));

        EXPECT_EQUAL(s2n_connection_get_server_protocol_version(client), server_version);
        EXPECT_EQUAL(s2n_connection_get_client_protocol_version(client), s2n_get_highest_fully_supported_tls_version());
        EXPECT_EQUAL(s2n_connection_get_client_hello_version(client), S2N_TLS12);
        EXPECT_EQUAL(s2n_connection_get_actual_protocol_version(client), server_version);
    }

    /* Ensure that TLS 1.2 servers report the client hello version as the client protocol version
     * if a malformed supported versions extension was received
     */
    for (uint8_t client_hello_version = S2N_SSLv3; client_hello_version <= S2N_TLS12; client_hello_version++) {
        DEFER_CLEANUP(struct s2n_config *config = s2n_config_new(), s2n_config_ptr_free);
        EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(config, chain_and_key));
        EXPECT_SUCCESS(s2n_config_set_cipher_preferences(config, "test_all_tls12"));

        struct s2n_overwrite_client_hello_ctx context = {
            .client_hello_version = client_hello_version,
            .client_supported_version = S2N_TLS13,
            /* Write an invalid length */
            .extension_length = 11,
        };
        EXPECT_SUCCESS(s2n_config_set_client_hello_cb(config, s2n_overwrite_client_hello_cb, &context));

        DEFER_CLEANUP(struct s2n_connection *client = s2n_connection_new(S2N_CLIENT),
                s2n_connection_ptr_free);
        EXPECT_NOT_NULL(client);
        EXPECT_SUCCESS(s2n_connection_set_config(client, config));

        DEFER_CLEANUP(struct s2n_connection *server = s2n_connection_new(S2N_SERVER),
                s2n_connection_ptr_free);
        EXPECT_NOT_NULL(server);
        EXPECT_SUCCESS(s2n_connection_set_config(server, config));

        DEFER_CLEANUP(struct s2n_test_io_pair io_pair = { 0 }, s2n_io_pair_close);
        EXPECT_SUCCESS(s2n_io_pair_init_non_blocking(&io_pair));
        EXPECT_SUCCESS(s2n_connections_set_io_pair(client, server, &io_pair));

        EXPECT_OK(s2n_negotiate_test_server_and_client_until_message(server, client, SERVER_HELLO));
        EXPECT_EQUAL(context.invoked_count, 1);

        /* Ensure that a supported versions extension was received. */
        bool supported_versions_received = false;
        EXPECT_SUCCESS(s2n_client_hello_has_extension(&server->client_hello, S2N_EXTENSION_SUPPORTED_VERSIONS,
                &supported_versions_received));
        EXPECT_TRUE(supported_versions_received);

        EXPECT_EQUAL(s2n_connection_get_client_protocol_version(server), client_hello_version);
    }

    /* Ensure that TLS 1.2 servers report the client hello version as the client protocol version
     * if an invalid supported version is received
     */
    for (uint8_t client_hello_version = S2N_SSLv3; client_hello_version <= S2N_TLS12; client_hello_version++) {
        DEFER_CLEANUP(struct s2n_config *config = s2n_config_new(), s2n_config_ptr_free);
        EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(config, chain_and_key));
        EXPECT_SUCCESS(s2n_config_set_cipher_preferences(config, "test_all_tls12"));

        struct s2n_overwrite_client_hello_ctx context = {
            .client_hello_version = client_hello_version,
            /* Write an invalid version */
            .client_supported_version = S2N_TLS13 + 10,
            .extension_length = 2,
        };
        EXPECT_SUCCESS(s2n_config_set_client_hello_cb(config, s2n_overwrite_client_hello_cb, &context));

        DEFER_CLEANUP(struct s2n_connection *client = s2n_connection_new(S2N_CLIENT),
                s2n_connection_ptr_free);
        EXPECT_NOT_NULL(client);
        EXPECT_SUCCESS(s2n_connection_set_config(client, config));

        DEFER_CLEANUP(struct s2n_connection *server = s2n_connection_new(S2N_SERVER),
                s2n_connection_ptr_free);
        EXPECT_NOT_NULL(server);
        EXPECT_SUCCESS(s2n_connection_set_config(server, config));

        DEFER_CLEANUP(struct s2n_test_io_pair io_pair = { 0 }, s2n_io_pair_close);
        EXPECT_SUCCESS(s2n_io_pair_init_non_blocking(&io_pair));
        EXPECT_SUCCESS(s2n_connections_set_io_pair(client, server, &io_pair));

        EXPECT_OK(s2n_negotiate_test_server_and_client_until_message(server, client, SERVER_HELLO));
        EXPECT_EQUAL(context.invoked_count, 1);

        /* Ensure that a supported versions extension was received. */
        bool supported_versions_received = false;
        EXPECT_SUCCESS(s2n_client_hello_has_extension(&server->client_hello, S2N_EXTENSION_SUPPORTED_VERSIONS,
                &supported_versions_received));
        EXPECT_TRUE(supported_versions_received);

        EXPECT_EQUAL(s2n_connection_get_client_protocol_version(server), client_hello_version);
    }

    /* Ensure that TLS 1.3 servers report an unknown protocol version if a supported versions
     * extension can't be processed
     */
    if (s2n_is_tls13_fully_supported()) {
        DEFER_CLEANUP(struct s2n_config *config = s2n_config_new(), s2n_config_ptr_free);
        EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(config, chain_and_key));
        EXPECT_SUCCESS(s2n_config_set_cipher_preferences(config, "test_all"));

        struct s2n_overwrite_client_hello_ctx context = {
            .client_supported_version = S2N_TLS13,
            /* Write an invalid length */
            .extension_length = 11,
        };
        EXPECT_SUCCESS(s2n_config_set_client_hello_cb(config, s2n_overwrite_client_hello_cb, &context));

        DEFER_CLEANUP(struct s2n_connection *client = s2n_connection_new(S2N_CLIENT),
                s2n_connection_ptr_free);
        EXPECT_NOT_NULL(client);
        EXPECT_SUCCESS(s2n_connection_set_config(client, config));

        DEFER_CLEANUP(struct s2n_connection *server = s2n_connection_new(S2N_SERVER),
                s2n_connection_ptr_free);
        EXPECT_NOT_NULL(server);
        EXPECT_SUCCESS(s2n_connection_set_config(server, config));
        EXPECT_SUCCESS(s2n_connection_set_blinding(server, S2N_SELF_SERVICE_BLINDING));

        DEFER_CLEANUP(struct s2n_test_io_pair io_pair = { 0 }, s2n_io_pair_close);
        EXPECT_SUCCESS(s2n_io_pair_init_non_blocking(&io_pair));
        EXPECT_SUCCESS(s2n_connections_set_io_pair(client, server, &io_pair));

        EXPECT_ERROR_WITH_ERRNO(s2n_negotiate_test_server_and_client_until_message(server, client, SERVER_HELLO),
                S2N_ERR_BAD_MESSAGE);
        EXPECT_EQUAL(context.invoked_count, 1);

        /* Ensure that a supported versions extension was received. */
        bool supported_versions_received = false;
        EXPECT_SUCCESS(s2n_client_hello_has_extension(&server->client_hello, S2N_EXTENSION_SUPPORTED_VERSIONS,
                &supported_versions_received));
        EXPECT_TRUE(supported_versions_received);

        EXPECT_EQUAL(s2n_connection_get_server_protocol_version(server), S2N_TLS13);
        EXPECT_EQUAL(s2n_connection_get_client_protocol_version(server), s2n_unknown_protocol_version);
        EXPECT_EQUAL(s2n_connection_get_actual_protocol_version(server), s2n_unknown_protocol_version);
    }

    END_TEST();
}