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
|
/*
* 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/unstable/custom_x509_extensions.h"
#include "crypto/s2n_libcrypto.h"
#include "s2n_test.h"
#include "testlib/s2n_testlib.h"
#include "tls/s2n_config.h"
#define S2N_SINGLE_OID_CERT_CHAIN "../pems/custom_oids/single_oid_cert_chain.pem"
#define S2N_SINGLE_OID_KEY "../pems/custom_oids/single_oid_key.pem"
#define S2N_MULTIPLE_OIDS_CERT_CHAIN "../pems/custom_oids/multiple_oids_cert_chain.pem"
#define S2N_MULTIPLE_OIDS_KEY "../pems/custom_oids/multiple_oids_key.pem"
const char *invalid_oid[] = { "1.3.4.2" };
const char *single_oid[] = { "1.3.187.25240.2" };
const char *multiple_oids[] = { "1.3.187.25240.2", "1.3.187.25240.3" };
const uint32_t multiple_oid_count = s2n_array_len(multiple_oids);
int main(int argc, char *argv[])
{
BEGIN_TEST();
/* Test adding custom critical cert extensions.
*
* By default, s2n-tls will reject certificates with custom critical extensions. Calling
* s2n_config_add_custom_x509_extension() allows s2n-tls to ingore these extensions during validation.
* Validation should succeed when added custom critical extensions match the ones provided in the certificate.
*/
{
/* Safety Check */
{
EXPECT_FAILURE_WITH_ERRNO(s2n_config_add_custom_x509_extension(NULL, (uint8_t *) single_oid[0], strlen(single_oid[0])),
S2N_ERR_INVALID_ARGUMENT);
DEFER_CLEANUP(struct s2n_config *test_config = s2n_config_new_minimal(), s2n_config_ptr_free);
EXPECT_NOT_NULL(test_config);
EXPECT_FAILURE_WITH_ERRNO(s2n_config_add_custom_x509_extension(test_config, NULL, 0), S2N_ERR_INVALID_ARGUMENT);
}
/* Ensure custom extensions can't be added when linked to an unsupported libcrypto. */
if (!s2n_libcrypto_supports_custom_oid()) {
DEFER_CLEANUP(struct s2n_config *test_config = s2n_config_new_minimal(), s2n_config_ptr_free);
EXPECT_NOT_NULL(test_config);
EXPECT_FAILURE_WITH_ERRNO(s2n_config_add_custom_x509_extension(test_config, (uint8_t *) single_oid[0], strlen(single_oid[0])),
S2N_ERR_API_UNSUPPORTED_BY_LIBCRYPTO);
END_TEST();
}
/* clang-format off */
struct {
const char *cert_pem_path;
const char *key_pem_path;
const char **custom_critical_oids;
uint32_t custom_oid_count;
unsigned set_oids : 1;
s2n_error expected_error;
} test_cases[] = {
/* Receive a certificate with a single custom extension. */
{
.cert_pem_path = S2N_SINGLE_OID_CERT_CHAIN,
.key_pem_path = S2N_SINGLE_OID_KEY,
.custom_critical_oids = single_oid,
.custom_oid_count = 1,
.set_oids = true,
.expected_error = S2N_ERR_OK,
},
/* Receive a certificate with multiple custom extensions. */
{
.cert_pem_path = S2N_MULTIPLE_OIDS_CERT_CHAIN,
.key_pem_path = S2N_MULTIPLE_OIDS_KEY,
.custom_critical_oids = multiple_oids,
.custom_oid_count = multiple_oid_count,
.set_oids = true,
.expected_error = S2N_ERR_OK,
},
/* Validation should fail without calling s2n_config_add_custom_x509_extension(). */
{
.cert_pem_path = S2N_MULTIPLE_OIDS_CERT_CHAIN,
.key_pem_path = S2N_MULTIPLE_OIDS_KEY,
.custom_critical_oids = multiple_oids,
.custom_oid_count = multiple_oid_count,
.set_oids = false,
.expected_error = S2N_ERR_CERT_UNHANDLED_CRITICAL_EXTENSION,
},
/* Validation should fail with mismatched custom extensions. */
{
.cert_pem_path = S2N_SINGLE_OID_CERT_CHAIN,
.key_pem_path = S2N_SINGLE_OID_KEY,
.custom_critical_oids = invalid_oid,
.custom_oid_count = 1,
.set_oids = true,
.expected_error = S2N_ERR_CERT_UNHANDLED_CRITICAL_EXTENSION,
},
/* Validation should fail with missing custom extensions. */
{
.cert_pem_path = S2N_MULTIPLE_OIDS_CERT_CHAIN,
.key_pem_path = S2N_MULTIPLE_OIDS_KEY,
.custom_critical_oids = single_oid,
.custom_oid_count = 1,
.set_oids = true,
.expected_error = S2N_ERR_CERT_UNHANDLED_CRITICAL_EXTENSION,
},
};
/* clang-format on */
/* Self-talk: add custom critical extensions for server auth */
for (int test_idx = 0; test_idx < s2n_array_len(test_cases); test_idx++) {
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,
test_cases[test_idx].cert_pem_path, test_cases[test_idx].key_pem_path));
DEFER_CLEANUP(struct s2n_config *config = s2n_config_new(), s2n_config_ptr_free);
EXPECT_NOT_NULL(config);
EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(config, chain_and_key));
EXPECT_SUCCESS(s2n_config_set_verification_ca_location(config, test_cases[test_idx].cert_pem_path, NULL));
EXPECT_SUCCESS(s2n_config_set_cipher_preferences(config, "default"));
const char **custom_oids = test_cases[test_idx].custom_critical_oids;
uint32_t custom_oid_count = test_cases[test_idx].custom_oid_count;
EXPECT_NULL(config->custom_x509_extension_oids);
if (test_cases[test_idx].set_oids) {
for (int i = 0; i < custom_oid_count; i++) {
uint8_t *custom_oid = (uint8_t *) custom_oids[i];
EXPECT_SUCCESS(s2n_config_add_custom_x509_extension(config, custom_oid, strlen(custom_oids[i])));
}
EXPECT_EQUAL(sk_ASN1_OBJECT_num(config->custom_x509_extension_oids), custom_oid_count);
}
DEFER_CLEANUP(struct s2n_connection *server_conn = s2n_connection_new(S2N_SERVER), s2n_connection_ptr_free);
EXPECT_NOT_NULL(server_conn);
EXPECT_SUCCESS(s2n_connection_set_config(server_conn, config));
DEFER_CLEANUP(struct s2n_connection *client_conn = s2n_connection_new(S2N_CLIENT), s2n_connection_ptr_free);
EXPECT_NOT_NULL(client_conn);
EXPECT_SUCCESS(s2n_connection_set_config(client_conn, config));
EXPECT_SUCCESS(s2n_connection_set_blinding(client_conn, S2N_SELF_SERVICE_BLINDING));
EXPECT_SUCCESS(s2n_set_server_name(client_conn, "localhost"));
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_connection_set_io_pair(client_conn, &io_pair));
EXPECT_SUCCESS(s2n_connection_set_io_pair(server_conn, &io_pair));
s2n_error expected_error = test_cases[test_idx].expected_error;
if (expected_error == S2N_ERR_OK) {
EXPECT_SUCCESS(s2n_negotiate_test_server_and_client(server_conn, client_conn));
} else {
EXPECT_FAILURE_WITH_ERRNO(s2n_negotiate_test_server_and_client(server_conn, client_conn),
expected_error);
}
}
/* Self-talk: add custom critical extensions for client auth */
for (int test_idx = 0; test_idx < s2n_array_len(test_cases); test_idx++) {
DEFER_CLEANUP(struct s2n_cert_chain_and_key *default_chain_and_key = NULL, s2n_cert_chain_and_key_ptr_free);
EXPECT_SUCCESS(s2n_test_cert_chain_and_key_new(&default_chain_and_key,
S2N_DEFAULT_TEST_CERT_CHAIN, S2N_DEFAULT_TEST_PRIVATE_KEY));
DEFER_CLEANUP(struct s2n_config *server_config = s2n_config_new(), s2n_config_ptr_free);
EXPECT_NOT_NULL(server_config);
EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(server_config, default_chain_and_key));
EXPECT_SUCCESS(s2n_config_set_verification_ca_location(server_config, test_cases[test_idx].cert_pem_path, NULL));
EXPECT_SUCCESS(s2n_config_set_cipher_preferences(server_config, "default"));
EXPECT_SUCCESS(s2n_config_set_client_auth_type(server_config, S2N_CERT_AUTH_REQUIRED));
const char **custom_oids = test_cases[test_idx].custom_critical_oids;
uint32_t custom_oid_count = test_cases[test_idx].custom_oid_count;
EXPECT_NULL(server_config->custom_x509_extension_oids);
if (test_cases[test_idx].set_oids) {
for (int i = 0; i < custom_oid_count; i++) {
uint8_t *custom_oid = (uint8_t *) custom_oids[i];
EXPECT_SUCCESS(s2n_config_add_custom_x509_extension(server_config, custom_oid, strlen(custom_oids[i])));
}
EXPECT_EQUAL(sk_ASN1_OBJECT_num(server_config->custom_x509_extension_oids), custom_oid_count);
}
DEFER_CLEANUP(struct s2n_connection *server_conn = s2n_connection_new(S2N_SERVER), s2n_connection_ptr_free);
EXPECT_NOT_NULL(server_conn);
EXPECT_SUCCESS(s2n_connection_set_config(server_conn, server_config));
EXPECT_SUCCESS(s2n_connection_set_blinding(server_conn, S2N_SELF_SERVICE_BLINDING));
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,
test_cases[test_idx].cert_pem_path, test_cases[test_idx].key_pem_path));
DEFER_CLEANUP(struct s2n_config *client_config = s2n_config_new(), s2n_config_ptr_free);
EXPECT_NOT_NULL(client_config);
EXPECT_SUCCESS(s2n_config_add_cert_chain_and_key_to_store(client_config, chain_and_key));
EXPECT_SUCCESS(s2n_config_set_verification_ca_location(client_config, S2N_DEFAULT_TEST_CERT_CHAIN, NULL));
EXPECT_SUCCESS(s2n_config_set_cipher_preferences(client_config, "default"));
EXPECT_SUCCESS(s2n_config_set_client_auth_type(client_config, S2N_CERT_AUTH_OPTIONAL));
DEFER_CLEANUP(struct s2n_connection *client_conn = s2n_connection_new(S2N_CLIENT), s2n_connection_ptr_free);
EXPECT_NOT_NULL(client_conn);
EXPECT_SUCCESS(s2n_connection_set_config(client_conn, client_config));
EXPECT_SUCCESS(s2n_set_server_name(client_conn, "localhost"));
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_connection_set_io_pair(client_conn, &io_pair));
EXPECT_SUCCESS(s2n_connection_set_io_pair(server_conn, &io_pair));
s2n_error expected_error = test_cases[test_idx].expected_error;
if (expected_error == S2N_ERR_OK) {
EXPECT_SUCCESS(s2n_negotiate_test_server_and_client(server_conn, client_conn));
} else {
EXPECT_FAILURE_WITH_ERRNO(s2n_negotiate_test_server_and_client(server_conn, client_conn),
expected_error);
}
/* Verify that both connections negotiated mutual auth. */
EXPECT_TRUE(IS_CLIENT_AUTH_HANDSHAKE(server_conn));
EXPECT_TRUE(IS_CLIENT_AUTH_HANDSHAKE(client_conn));
}
}
END_TEST();
}
|
