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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
|
/*
* 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 <arpa/inet.h>
#include <openssl/asn1.h>
#include <openssl/err.h>
#include <openssl/x509.h>
#include <sys/socket.h>
#include "crypto/s2n_openssl.h"
#include "crypto/s2n_openssl_x509.h"
#include "tls/extensions/s2n_extension_list.h"
#include "tls/s2n_config.h"
#include "tls/s2n_connection.h"
#include "tls/s2n_crl.h"
#include "utils/s2n_asn1_time.h"
#include "utils/s2n_result.h"
#include "utils/s2n_rfc5952.h"
#include "utils/s2n_safety.h"
#if S2N_OCSP_STAPLING_SUPPORTED
#include <openssl/ocsp.h>
DEFINE_POINTER_CLEANUP_FUNC(OCSP_RESPONSE *, OCSP_RESPONSE_free);
DEFINE_POINTER_CLEANUP_FUNC(OCSP_BASICRESP *, OCSP_BASICRESP_free);
#endif
#ifndef X509_V_FLAG_PARTIAL_CHAIN
#define X509_V_FLAG_PARTIAL_CHAIN 0x80000
#endif
#define DEFAULT_MAX_CHAIN_DEPTH 7
/* Time used by default for nextUpdate if none provided in OCSP: 1 hour since thisUpdate. */
#define DEFAULT_OCSP_NEXT_UPDATE_PERIOD 3600000000000
DEFINE_POINTER_CLEANUP_FUNC(STACK_OF(X509_CRL) *, sk_X509_CRL_free);
DEFINE_POINTER_CLEANUP_FUNC(STACK_OF(GENERAL_NAME) *, GENERAL_NAMES_free);
uint8_t s2n_x509_ocsp_stapling_supported(void)
{
return S2N_OCSP_STAPLING_SUPPORTED;
}
void s2n_x509_trust_store_init_empty(struct s2n_x509_trust_store *store)
{
store->trust_store = NULL;
}
uint8_t s2n_x509_trust_store_has_certs(struct s2n_x509_trust_store *store)
{
return store->trust_store ? (uint8_t) 1 : (uint8_t) 0;
}
int s2n_x509_trust_store_add_pem(struct s2n_x509_trust_store *store, const char *pem)
{
POSIX_ENSURE_REF(store);
POSIX_ENSURE_REF(pem);
if (!store->trust_store) {
store->trust_store = X509_STORE_new();
}
DEFER_CLEANUP(struct s2n_stuffer pem_in_stuffer = { 0 }, s2n_stuffer_free);
DEFER_CLEANUP(struct s2n_stuffer der_out_stuffer = { 0 }, s2n_stuffer_free);
POSIX_GUARD(s2n_stuffer_alloc_ro_from_string(&pem_in_stuffer, pem));
POSIX_GUARD(s2n_stuffer_growable_alloc(&der_out_stuffer, 2048));
do {
DEFER_CLEANUP(struct s2n_blob next_cert = { 0 }, s2n_free);
POSIX_GUARD(s2n_stuffer_certificate_from_pem(&pem_in_stuffer, &der_out_stuffer));
POSIX_GUARD(s2n_alloc(&next_cert, s2n_stuffer_data_available(&der_out_stuffer)));
POSIX_GUARD(s2n_stuffer_read(&der_out_stuffer, &next_cert));
const uint8_t *data = next_cert.data;
DEFER_CLEANUP(X509 *ca_cert = d2i_X509(NULL, &data, next_cert.size), X509_free_pointer);
S2N_ERROR_IF(ca_cert == NULL, S2N_ERR_DECODE_CERTIFICATE);
if (!X509_STORE_add_cert(store->trust_store, ca_cert)) {
unsigned long error = ERR_get_error();
POSIX_ENSURE(ERR_GET_REASON(error) == X509_R_CERT_ALREADY_IN_HASH_TABLE, S2N_ERR_DECODE_CERTIFICATE);
}
} while (s2n_stuffer_data_available(&pem_in_stuffer));
return 0;
}
int s2n_x509_trust_store_from_ca_file(struct s2n_x509_trust_store *store, const char *ca_pem_filename, const char *ca_dir)
{
if (!store->trust_store) {
store->trust_store = X509_STORE_new();
POSIX_ENSURE_REF(store->trust_store);
}
int err_code = X509_STORE_load_locations(store->trust_store, ca_pem_filename, ca_dir);
if (!err_code) {
s2n_x509_trust_store_wipe(store);
POSIX_BAIL(S2N_ERR_X509_TRUST_STORE);
}
/* It's a likely scenario if this function is called, a self-signed certificate is used, and that is was generated
* without a trust anchor. However if you call this function, the assumption is you trust ca_file or path and if a certificate
* is encountered that's in that path, it should be trusted. The following flag tells libcrypto to not care that the cert
* is missing a root anchor. */
unsigned long flags = X509_V_FLAG_PARTIAL_CHAIN;
X509_STORE_set_flags(store->trust_store, flags);
return 0;
}
void s2n_x509_trust_store_wipe(struct s2n_x509_trust_store *store)
{
if (store->trust_store) {
X509_STORE_free(store->trust_store);
store->trust_store = NULL;
store->loaded_system_certs = false;
}
}
int s2n_x509_validator_init_no_x509_validation(struct s2n_x509_validator *validator)
{
POSIX_ENSURE_REF(validator);
validator->trust_store = NULL;
validator->store_ctx = NULL;
validator->skip_cert_validation = 1;
validator->check_stapled_ocsp = 0;
validator->max_chain_depth = DEFAULT_MAX_CHAIN_DEPTH;
validator->state = INIT;
validator->cert_chain_from_wire = sk_X509_new_null();
validator->crl_lookup_list = NULL;
return 0;
}
int s2n_x509_validator_init(struct s2n_x509_validator *validator, struct s2n_x509_trust_store *trust_store, uint8_t check_ocsp)
{
POSIX_ENSURE_REF(trust_store);
validator->trust_store = trust_store;
validator->skip_cert_validation = 0;
validator->check_stapled_ocsp = check_ocsp;
validator->max_chain_depth = DEFAULT_MAX_CHAIN_DEPTH;
validator->store_ctx = NULL;
if (validator->trust_store->trust_store) {
validator->store_ctx = X509_STORE_CTX_new();
POSIX_ENSURE_REF(validator->store_ctx);
}
validator->cert_chain_from_wire = sk_X509_new_null();
validator->state = INIT;
validator->crl_lookup_list = NULL;
return 0;
}
static inline void wipe_cert_chain(STACK_OF(X509) *cert_chain)
{
if (cert_chain) {
sk_X509_pop_free(cert_chain, X509_free);
}
}
int s2n_x509_validator_wipe(struct s2n_x509_validator *validator)
{
if (validator->store_ctx) {
X509_STORE_CTX_free(validator->store_ctx);
validator->store_ctx = NULL;
}
wipe_cert_chain(validator->cert_chain_from_wire);
validator->cert_chain_from_wire = NULL;
validator->trust_store = NULL;
validator->skip_cert_validation = 0;
validator->state = UNINIT;
validator->max_chain_depth = 0;
if (validator->crl_lookup_list) {
POSIX_GUARD_RESULT(s2n_array_free(validator->crl_lookup_list));
validator->crl_lookup_list = NULL;
}
return S2N_SUCCESS;
}
int s2n_x509_validator_set_max_chain_depth(struct s2n_x509_validator *validator, uint16_t max_depth)
{
POSIX_ENSURE_REF(validator);
S2N_ERROR_IF(max_depth == 0, S2N_ERR_INVALID_ARGUMENT);
validator->max_chain_depth = max_depth;
return 0;
}
static S2N_RESULT s2n_verify_host_information_san_entry(struct s2n_connection *conn, GENERAL_NAME *current_name, bool *san_found)
{
RESULT_ENSURE_REF(conn);
RESULT_ENSURE_REF(current_name);
RESULT_ENSURE_REF(san_found);
if (current_name->type == GEN_DNS || current_name->type == GEN_URI) {
*san_found = true;
const char *name = (const char *) ASN1_STRING_data(current_name->d.ia5);
RESULT_ENSURE_REF(name);
int name_len = ASN1_STRING_length(current_name->d.ia5);
RESULT_ENSURE_GT(name_len, 0);
RESULT_ENSURE(conn->verify_host_fn(name, name_len, conn->data_for_verify_host), S2N_ERR_CERT_UNTRUSTED);
return S2N_RESULT_OK;
}
if (current_name->type == GEN_IPADD) {
*san_found = true;
/* try to validate an IP address if it's in the subject alt name. */
const unsigned char *ip_addr = current_name->d.iPAddress->data;
RESULT_ENSURE_REF(ip_addr);
int ip_addr_len = current_name->d.iPAddress->length;
RESULT_ENSURE_GT(ip_addr_len, 0);
RESULT_STACK_BLOB(address, INET6_ADDRSTRLEN + 1, INET6_ADDRSTRLEN + 1);
if (ip_addr_len == 4) {
RESULT_GUARD(s2n_inet_ntop(AF_INET, ip_addr, &address));
} else if (ip_addr_len == 16) {
RESULT_GUARD(s2n_inet_ntop(AF_INET6, ip_addr, &address));
} else {
/* we aren't able to parse this value so skip it */
RESULT_BAIL(S2N_ERR_CERT_UNTRUSTED);
}
/* strlen should be safe here since we made sure we were null terminated AND that inet_ntop succeeded */
const char *name = (const char *) address.data;
size_t name_len = strlen(name);
RESULT_ENSURE(conn->verify_host_fn(name, name_len, conn->data_for_verify_host), S2N_ERR_CERT_UNTRUSTED);
return S2N_RESULT_OK;
}
/* we don't understand this entry type so skip it */
RESULT_BAIL(S2N_ERR_CERT_UNTRUSTED);
}
static S2N_RESULT s2n_verify_host_information_san(struct s2n_connection *conn, X509 *public_cert, bool *san_found)
{
RESULT_ENSURE_REF(conn);
RESULT_ENSURE_REF(public_cert);
RESULT_ENSURE_REF(san_found);
*san_found = false;
DEFER_CLEANUP(STACK_OF(GENERAL_NAME) *names_list = NULL, GENERAL_NAMES_free_pointer);
names_list = X509_get_ext_d2i(public_cert, NID_subject_alt_name, NULL, NULL);
RESULT_ENSURE(names_list, S2N_ERR_CERT_UNTRUSTED);
int n = sk_GENERAL_NAME_num(names_list);
RESULT_ENSURE(n > 0, S2N_ERR_CERT_UNTRUSTED);
s2n_result result = S2N_RESULT_OK;
for (int i = 0; i < n; i++) {
GENERAL_NAME *current_name = sk_GENERAL_NAME_value(names_list, i);
/* return success on the first entry that passes verification */
result = s2n_verify_host_information_san_entry(conn, current_name, san_found);
if (s2n_result_is_ok(result)) {
return S2N_RESULT_OK;
}
}
/* if an error was set by one of the entries, then just propagate the error from the last SAN entry call */
RESULT_GUARD(result);
RESULT_BAIL(S2N_ERR_CERT_UNTRUSTED);
}
static S2N_RESULT s2n_verify_host_information_common_name(struct s2n_connection *conn, X509 *public_cert, bool *cn_found)
{
RESULT_ENSURE_REF(conn);
RESULT_ENSURE_REF(public_cert);
RESULT_ENSURE_REF(cn_found);
X509_NAME *subject_name = X509_get_subject_name(public_cert);
RESULT_ENSURE(subject_name, S2N_ERR_CERT_UNTRUSTED);
int curr_idx = -1;
while (true) {
int next_idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, curr_idx);
if (next_idx >= 0) {
curr_idx = next_idx;
} else {
break;
}
}
RESULT_ENSURE(curr_idx >= 0, S2N_ERR_CERT_UNTRUSTED);
ASN1_STRING *common_name = X509_NAME_ENTRY_get_data(X509_NAME_get_entry(subject_name, curr_idx));
RESULT_ENSURE(common_name, S2N_ERR_CERT_UNTRUSTED);
/* X520CommonName allows the following ANSI string types per RFC 5280 Appendix A.1 */
RESULT_ENSURE(ASN1_STRING_type(common_name) == V_ASN1_TELETEXSTRING
|| ASN1_STRING_type(common_name) == V_ASN1_PRINTABLESTRING
|| ASN1_STRING_type(common_name) == V_ASN1_UNIVERSALSTRING
|| ASN1_STRING_type(common_name) == V_ASN1_UTF8STRING
|| ASN1_STRING_type(common_name) == V_ASN1_BMPSTRING,
S2N_ERR_CERT_UNTRUSTED);
/* at this point we have a valid CN value */
*cn_found = true;
char peer_cn[255] = { 0 };
int cn_len = ASN1_STRING_length(common_name);
RESULT_ENSURE_GT(cn_len, 0);
uint32_t len = (uint32_t) cn_len;
RESULT_ENSURE_LTE(len, s2n_array_len(peer_cn) - 1);
RESULT_CHECKED_MEMCPY(peer_cn, ASN1_STRING_data(common_name), len);
RESULT_ENSURE(conn->verify_host_fn(peer_cn, len, conn->data_for_verify_host), S2N_ERR_CERT_UNTRUSTED);
return S2N_RESULT_OK;
}
/*
* For each name in the cert. Iterate them. Call the callback. If one returns true, then consider it validated,
* if none of them return true, the cert is considered invalid.
*/
static S2N_RESULT s2n_verify_host_information(struct s2n_connection *conn, X509 *public_cert)
{
bool entry_found = false;
/* Check SubjectAltNames before CommonName as per RFC 6125 6.4.4 */
s2n_result result = s2n_verify_host_information_san(conn, public_cert, &entry_found);
/*
*= https://www.rfc-editor.org/rfc/rfc6125#section-6.4.4
*# As noted, a client MUST NOT seek a match for a reference identifier
*# of CN-ID if the presented identifiers include a DNS-ID, SRV-ID,
*# URI-ID, or any application-specific identifier types supported by the
*# client.
*/
if (entry_found) {
return result;
}
/*
*= https://www.rfc-editor.org/rfc/rfc6125#section-6.4.4
*# Therefore, if and only if the presented identifiers do not include a
*# DNS-ID, SRV-ID, URI-ID, or any application-specific identifier types
*# supported by the client, then the client MAY as a last resort check
*# for a string whose form matches that of a fully qualified DNS domain
*# name in a Common Name field of the subject field (i.e., a CN-ID).
*/
result = s2n_verify_host_information_common_name(conn, public_cert, &entry_found);
if (entry_found) {
return result;
}
/* make a null-terminated string in case the callback tries to use strlen */
const char *name = "";
size_t name_len = 0;
/* at this point, we don't have anything to identify the certificate with so pass an empty string to the callback */
RESULT_ENSURE(conn->verify_host_fn(name, name_len, conn->data_for_verify_host), S2N_ERR_CERT_UNTRUSTED);
return S2N_RESULT_OK;
}
static S2N_RESULT s2n_x509_validator_read_asn1_cert(struct s2n_stuffer *cert_chain_in_stuffer, struct s2n_blob *asn1_cert)
{
uint32_t certificate_size = 0;
RESULT_GUARD_POSIX(s2n_stuffer_read_uint24(cert_chain_in_stuffer, &certificate_size));
RESULT_ENSURE(certificate_size > 0, S2N_ERR_CERT_INVALID);
RESULT_ENSURE(certificate_size <= s2n_stuffer_data_available(cert_chain_in_stuffer), S2N_ERR_CERT_INVALID);
asn1_cert->size = certificate_size;
asn1_cert->data = s2n_stuffer_raw_read(cert_chain_in_stuffer, certificate_size);
RESULT_ENSURE_REF(asn1_cert->data);
return S2N_RESULT_OK;
}
static S2N_RESULT s2n_x509_validator_read_cert_chain(struct s2n_x509_validator *validator, struct s2n_connection *conn,
uint8_t *cert_chain_in, uint32_t cert_chain_len)
{
RESULT_ENSURE(validator->skip_cert_validation || s2n_x509_trust_store_has_certs(validator->trust_store), S2N_ERR_CERT_UNTRUSTED);
RESULT_ENSURE(validator->state == INIT, S2N_ERR_INVALID_CERT_STATE);
struct s2n_blob cert_chain_blob = { 0 };
RESULT_GUARD_POSIX(s2n_blob_init(&cert_chain_blob, cert_chain_in, cert_chain_len));
DEFER_CLEANUP(struct s2n_stuffer cert_chain_in_stuffer = { 0 }, s2n_stuffer_free);
RESULT_GUARD_POSIX(s2n_stuffer_init(&cert_chain_in_stuffer, &cert_chain_blob));
RESULT_GUARD_POSIX(s2n_stuffer_write(&cert_chain_in_stuffer, &cert_chain_blob));
X509 *server_cert = NULL;
while (s2n_stuffer_data_available(&cert_chain_in_stuffer)
&& sk_X509_num(validator->cert_chain_from_wire) < validator->max_chain_depth) {
struct s2n_blob asn1_cert = { 0 };
RESULT_GUARD(s2n_x509_validator_read_asn1_cert(&cert_chain_in_stuffer, &asn1_cert));
const uint8_t *data = asn1_cert.data;
/* the cert is der encoded, just convert it. */
server_cert = d2i_X509(NULL, &data, asn1_cert.size);
RESULT_ENSURE_REF(server_cert);
/* add the cert to the chain. */
if (!sk_X509_push(validator->cert_chain_from_wire, server_cert)) {
/* After the cert is added to cert_chain_from_wire, it will be freed with the call to
* s2n_x509_validator_wipe. If adding the cert fails, free it now instead. */
X509_free(server_cert);
RESULT_BAIL(S2N_ERR_INTERNAL_LIBCRYPTO_ERROR);
}
if (!validator->skip_cert_validation) {
RESULT_ENSURE_OK(s2n_validate_certificate_signature(conn, server_cert), S2N_ERR_CERT_UNTRUSTED);
}
/* certificate extensions is a field in TLS 1.3 - https://tools.ietf.org/html/rfc8446#section-4.4.2 */
if (conn->actual_protocol_version >= S2N_TLS13) {
s2n_parsed_extensions_list parsed_extensions_list = { 0 };
RESULT_GUARD_POSIX(s2n_extension_list_parse(&cert_chain_in_stuffer, &parsed_extensions_list));
}
}
/* if this occurred we exceeded validator->max_chain_depth */
RESULT_ENSURE(validator->skip_cert_validation || s2n_stuffer_data_available(&cert_chain_in_stuffer) == 0,
S2N_ERR_CERT_MAX_CHAIN_DEPTH_EXCEEDED);
RESULT_ENSURE(sk_X509_num(validator->cert_chain_from_wire) > 0, S2N_ERR_NO_CERT_FOUND);
return S2N_RESULT_OK;
}
static S2N_RESULT s2n_x509_validator_process_cert_chain(struct s2n_x509_validator *validator, struct s2n_connection *conn,
uint8_t *cert_chain_in, uint32_t cert_chain_len)
{
RESULT_ENSURE(validator->state == INIT, S2N_ERR_INVALID_CERT_STATE);
RESULT_GUARD(s2n_x509_validator_read_cert_chain(validator, conn, cert_chain_in, cert_chain_len));
if (validator->skip_cert_validation) {
return S2N_RESULT_OK;
}
X509 *leaf = sk_X509_value(validator->cert_chain_from_wire, 0);
RESULT_ENSURE_REF(leaf);
if (conn->verify_host_fn) {
RESULT_GUARD(s2n_verify_host_information(conn, leaf));
}
RESULT_GUARD_OSSL(X509_STORE_CTX_init(validator->store_ctx, validator->trust_store->trust_store, leaf,
validator->cert_chain_from_wire),
S2N_ERR_INTERNAL_LIBCRYPTO_ERROR);
if (conn->config->crl_lookup_cb) {
RESULT_GUARD(s2n_crl_invoke_lookup_callbacks(conn, validator));
RESULT_GUARD(s2n_crl_handle_lookup_callback_result(validator));
}
validator->state = READY_TO_VERIFY;
return S2N_RESULT_OK;
}
static S2N_RESULT s2n_x509_validator_verify_cert_chain(struct s2n_x509_validator *validator, struct s2n_connection *conn)
{
RESULT_ENSURE(validator->state == READY_TO_VERIFY, S2N_ERR_INVALID_CERT_STATE);
X509_VERIFY_PARAM *param = X509_STORE_CTX_get0_param(validator->store_ctx);
X509_VERIFY_PARAM_set_depth(param, validator->max_chain_depth);
DEFER_CLEANUP(STACK_OF(X509_CRL) *crl_stack = NULL, sk_X509_CRL_free_pointer);
if (conn->config->crl_lookup_cb) {
X509_STORE_CTX_set_verify_cb(validator->store_ctx, s2n_crl_ossl_verify_callback);
crl_stack = sk_X509_CRL_new_null();
RESULT_GUARD(s2n_crl_get_crls_from_lookup_list(validator, crl_stack));
/* Set the CRL list that the libcrypto will use to validate certificates with */
X509_STORE_CTX_set0_crls(validator->store_ctx, crl_stack);
/* Enable CRL validation for certificates in X509_verify_cert */
RESULT_GUARD_OSSL(X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK),
S2N_ERR_INTERNAL_LIBCRYPTO_ERROR);
/* Enable CRL validation for all certificates, not just the leaf */
RESULT_GUARD_OSSL(X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK_ALL),
S2N_ERR_INTERNAL_LIBCRYPTO_ERROR);
}
uint64_t current_sys_time = 0;
RESULT_GUARD(s2n_config_wall_clock(conn->config, ¤t_sys_time));
/* this wants seconds not nanoseconds */
time_t current_time = (time_t) (current_sys_time / 1000000000);
X509_STORE_CTX_set_time(validator->store_ctx, 0, current_time);
int verify_ret = X509_verify_cert(validator->store_ctx);
if (verify_ret <= 0) {
int ossl_error = X509_STORE_CTX_get_error(validator->store_ctx);
switch (ossl_error) {
case X509_V_ERR_CERT_HAS_EXPIRED:
RESULT_BAIL(S2N_ERR_CERT_EXPIRED);
case X509_V_ERR_CERT_REVOKED:
RESULT_BAIL(S2N_ERR_CERT_REVOKED);
case X509_V_ERR_UNABLE_TO_GET_CRL:
case X509_V_ERR_DIFFERENT_CRL_SCOPE:
RESULT_BAIL(S2N_ERR_CRL_LOOKUP_FAILED);
case X509_V_ERR_CRL_SIGNATURE_FAILURE:
RESULT_BAIL(S2N_ERR_CRL_SIGNATURE);
case X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER:
RESULT_BAIL(S2N_ERR_CRL_ISSUER);
case X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION:
RESULT_BAIL(S2N_ERR_CRL_UNHANDLED_CRITICAL_EXTENSION);
default:
RESULT_BAIL(S2N_ERR_CERT_UNTRUSTED);
}
}
validator->state = VALIDATED;
return S2N_RESULT_OK;
}
static S2N_RESULT s2n_x509_validator_read_leaf_info(struct s2n_connection *conn, uint8_t *cert_chain_in, uint32_t cert_chain_len,
struct s2n_pkey *public_key, s2n_pkey_type *pkey_type, s2n_parsed_extensions_list *first_certificate_extensions)
{
struct s2n_blob cert_chain_blob = { 0 };
RESULT_GUARD_POSIX(s2n_blob_init(&cert_chain_blob, cert_chain_in, cert_chain_len));
DEFER_CLEANUP(struct s2n_stuffer cert_chain_in_stuffer = { 0 }, s2n_stuffer_free);
RESULT_GUARD_POSIX(s2n_stuffer_init(&cert_chain_in_stuffer, &cert_chain_blob));
RESULT_GUARD_POSIX(s2n_stuffer_write(&cert_chain_in_stuffer, &cert_chain_blob));
struct s2n_blob asn1_cert = { 0 };
RESULT_GUARD(s2n_x509_validator_read_asn1_cert(&cert_chain_in_stuffer, &asn1_cert));
RESULT_ENSURE(s2n_asn1der_to_public_key_and_type(public_key, pkey_type, &asn1_cert) == 0,
S2N_ERR_CERT_UNTRUSTED);
/* certificate extensions is a field in TLS 1.3 - https://tools.ietf.org/html/rfc8446#section-4.4.2 */
if (conn->actual_protocol_version >= S2N_TLS13) {
s2n_parsed_extensions_list parsed_extensions_list = { 0 };
RESULT_GUARD_POSIX(s2n_extension_list_parse(&cert_chain_in_stuffer, &parsed_extensions_list));
*first_certificate_extensions = parsed_extensions_list;
}
return S2N_RESULT_OK;
}
S2N_RESULT s2n_x509_validator_validate_cert_chain(struct s2n_x509_validator *validator, struct s2n_connection *conn,
uint8_t *cert_chain_in, uint32_t cert_chain_len, s2n_pkey_type *pkey_type, struct s2n_pkey *public_key_out)
{
switch (validator->state) {
case INIT:
break;
case AWAITING_CRL_CALLBACK:
RESULT_GUARD(s2n_crl_handle_lookup_callback_result(validator));
break;
default:
RESULT_BAIL(S2N_ERR_INVALID_CERT_STATE);
}
if (validator->state == INIT) {
RESULT_GUARD(s2n_x509_validator_process_cert_chain(validator, conn, cert_chain_in, cert_chain_len));
}
if (validator->state == READY_TO_VERIFY) {
RESULT_GUARD(s2n_x509_validator_verify_cert_chain(validator, conn));
}
DEFER_CLEANUP(struct s2n_pkey public_key = { 0 }, s2n_pkey_free);
s2n_pkey_zero_init(&public_key);
s2n_parsed_extensions_list first_certificate_extensions = { 0 };
RESULT_GUARD(s2n_x509_validator_read_leaf_info(conn, cert_chain_in, cert_chain_len, &public_key, pkey_type,
&first_certificate_extensions));
if (conn->actual_protocol_version >= S2N_TLS13) {
/* Only process certificate extensions received in the first certificate. Extensions received in all other
* certificates are ignored.
*
*= https://tools.ietf.org/rfc/rfc8446#section-4.4.2
*# If an extension applies to the entire chain, it SHOULD be included in
*# the first CertificateEntry.
*/
RESULT_GUARD_POSIX(s2n_extension_list_process(S2N_EXTENSION_LIST_CERTIFICATE, conn, &first_certificate_extensions));
}
*public_key_out = public_key;
/* Reset the old struct, so we don't clean up public_key_out */
s2n_pkey_zero_init(&public_key);
return S2N_RESULT_OK;
}
S2N_RESULT s2n_x509_validator_validate_cert_stapled_ocsp_response(struct s2n_x509_validator *validator,
struct s2n_connection *conn, const uint8_t *ocsp_response_raw, uint32_t ocsp_response_length)
{
if (validator->skip_cert_validation || !validator->check_stapled_ocsp) {
validator->state = OCSP_VALIDATED;
return S2N_RESULT_OK;
}
RESULT_ENSURE(validator->state == VALIDATED, S2N_ERR_INVALID_CERT_STATE);
#if !S2N_OCSP_STAPLING_SUPPORTED
/* Default to safety */
RESULT_BAIL(S2N_ERR_CERT_UNTRUSTED);
#else
RESULT_ENSURE_REF(ocsp_response_raw);
DEFER_CLEANUP(OCSP_RESPONSE *ocsp_response = d2i_OCSP_RESPONSE(NULL, &ocsp_response_raw, ocsp_response_length),
OCSP_RESPONSE_free_pointer);
RESULT_ENSURE(ocsp_response != NULL, S2N_ERR_INVALID_OCSP_RESPONSE);
int ocsp_status = OCSP_response_status(ocsp_response);
RESULT_ENSURE(ocsp_status == OCSP_RESPONSE_STATUS_SUCCESSFUL, S2N_ERR_CERT_UNTRUSTED);
DEFER_CLEANUP(OCSP_BASICRESP *basic_response = OCSP_response_get1_basic(ocsp_response), OCSP_BASICRESP_free_pointer);
RESULT_ENSURE(basic_response != NULL, S2N_ERR_INVALID_OCSP_RESPONSE);
/* X509_STORE_CTX_get0_chain() is better because it doesn't return a copy. But it's not available for Openssl 1.0.2.
* Therefore, we call this variant and clean it up at the end of the function.
* See the comments here:
* https://www.openssl.org/docs/man1.0.2/man3/X509_STORE_CTX_get1_chain.html
*/
DEFER_CLEANUP(STACK_OF(X509) *cert_chain = X509_STORE_CTX_get1_chain(validator->store_ctx),
s2n_openssl_x509_stack_pop_free);
RESULT_ENSURE_REF(cert_chain);
const int certs_in_chain = sk_X509_num(cert_chain);
RESULT_ENSURE(certs_in_chain > 0, S2N_ERR_NO_CERT_FOUND);
/* leaf is the top: not the bottom. */
X509 *subject = sk_X509_value(cert_chain, 0);
X509 *issuer = NULL;
/* find the issuer in the chain. If it's not there. Fail everything. */
for (int i = 0; i < certs_in_chain; ++i) {
X509 *issuer_candidate = sk_X509_value(cert_chain, i);
const int issuer_value = X509_check_issued(issuer_candidate, subject);
if (issuer_value == X509_V_OK) {
issuer = issuer_candidate;
break;
}
}
RESULT_ENSURE(issuer != NULL, S2N_ERR_CERT_UNTRUSTED);
/* Important: this checks that the stapled ocsp response CAN be verified, not that it has been verified. */
const int ocsp_verify_res = OCSP_basic_verify(basic_response, cert_chain, validator->trust_store->trust_store, 0);
RESULT_GUARD_OSSL(ocsp_verify_res, S2N_ERR_CERT_UNTRUSTED);
/* do the crypto checks on the response.*/
int status = 0;
int reason = 0;
/* sha1 is the only supported OCSP digest */
OCSP_CERTID *cert_id = OCSP_cert_to_id(EVP_sha1(), subject, issuer);
RESULT_ENSURE_REF(cert_id);
ASN1_GENERALIZEDTIME *revtime, *thisupd, *nextupd;
/* Actual verification of the response */
const int ocsp_resp_find_status_res = OCSP_resp_find_status(basic_response, cert_id, &status, &reason, &revtime, &thisupd, &nextupd);
OCSP_CERTID_free(cert_id);
RESULT_GUARD_OSSL(ocsp_resp_find_status_res, S2N_ERR_CERT_UNTRUSTED);
uint64_t this_update = 0;
RESULT_GUARD(s2n_asn1_time_to_nano_since_epoch_ticks((const char *) thisupd->data,
(uint32_t) thisupd->length, &this_update));
uint64_t next_update = 0;
if (nextupd) {
RESULT_GUARD(s2n_asn1_time_to_nano_since_epoch_ticks((const char *) nextupd->data,
(uint32_t) nextupd->length, &next_update));
} else {
next_update = this_update + DEFAULT_OCSP_NEXT_UPDATE_PERIOD;
}
uint64_t current_time = 0;
RESULT_GUARD(s2n_config_wall_clock(conn->config, ¤t_time));
RESULT_ENSURE(current_time >= this_update, S2N_ERR_CERT_INVALID);
RESULT_ENSURE(current_time <= next_update, S2N_ERR_CERT_EXPIRED);
switch (status) {
case V_OCSP_CERTSTATUS_GOOD:
validator->state = OCSP_VALIDATED;
return S2N_RESULT_OK;
case V_OCSP_CERTSTATUS_REVOKED:
RESULT_BAIL(S2N_ERR_CERT_REVOKED);
default:
RESULT_BAIL(S2N_ERR_CERT_UNTRUSTED);
}
#endif /* S2N_OCSP_STAPLING_SUPPORTED */
}
S2N_RESULT s2n_validate_certificate_signature(struct s2n_connection *conn, X509 *x509_cert)
{
RESULT_ENSURE_REF(conn);
RESULT_ENSURE_REF(x509_cert);
const struct s2n_security_policy *security_policy;
RESULT_GUARD_POSIX(s2n_connection_get_security_policy(conn, &security_policy));
/**
* We only restrict the signature algorithm on the certificates in the
* peer's certificate chain if the certificate_signature_preferences field
* is set in the security policy. This is contrary to the RFC, which
* specifies that the signatures in the "signature_algorithms" extension
* apply to signatures in the certificate chain in certain scenarios, so RFC
* compliance would imply validating that the certificate chain signature
* algorithm matches one of the algorithms specified in the
* "signature_algorithms" extension.
*
*= https://www.rfc-editor.org/rfc/rfc5246#section-7.4.2
*= type=exception
*= reason=not implemented due to lack of utility
*# If the client provided a "signature_algorithms" extension, then all
*# certificates provided by the server MUST be signed by a
*# hash/signature algorithm pair that appears in that extension.
*
*= https://www.rfc-editor.org/rfc/rfc8446#section-4.2.3
*= type=exception
*= reason=not implemented due to lack of utility
*# If no "signature_algorithms_cert" extension is present, then the
*# "signature_algorithms" extension also applies to signatures appearing in
*# certificates.
*/
if (security_policy->certificate_signature_preferences == NULL) {
return S2N_RESULT_OK;
}
X509_NAME *issuer_name = X509_get_issuer_name(x509_cert);
RESULT_ENSURE_REF(issuer_name);
X509_NAME *subject_name = X509_get_subject_name(x509_cert);
RESULT_ENSURE_REF(subject_name);
/* Do not validate any self-signed certificates */
if (X509_NAME_cmp(issuer_name, subject_name) == 0) {
return S2N_RESULT_OK;
}
RESULT_GUARD(s2n_validate_sig_scheme_supported(conn, x509_cert, security_policy->certificate_signature_preferences));
return S2N_RESULT_OK;
}
S2N_RESULT s2n_validate_sig_scheme_supported(struct s2n_connection *conn, X509 *x509_cert,
const struct s2n_signature_preferences *cert_sig_preferences)
{
RESULT_ENSURE_REF(conn);
RESULT_ENSURE_REF(x509_cert);
RESULT_ENSURE_REF(cert_sig_preferences);
int nid = 0;
#if defined(LIBRESSL_VERSION_NUMBER) && (LIBRESSL_VERSION_NUMBER < 0x02070000f)
RESULT_ENSURE_REF(x509_cert->sig_alg);
nid = OBJ_obj2nid(x509_cert->sig_alg->algorithm);
#else
nid = X509_get_signature_nid(x509_cert);
#endif
for (size_t i = 0; i < cert_sig_preferences->count; i++) {
if (cert_sig_preferences->signature_schemes[i]->libcrypto_nid == nid) {
/* SHA-1 algorithms are not supported in certificate signatures in TLS1.3 */
RESULT_ENSURE(!(conn->actual_protocol_version >= S2N_TLS13
&& cert_sig_preferences->signature_schemes[i]->hash_alg == S2N_HASH_SHA1),
S2N_ERR_CERT_UNTRUSTED);
return S2N_RESULT_OK;
}
}
RESULT_BAIL(S2N_ERR_CERT_UNTRUSTED);
}
bool s2n_x509_validator_is_cert_chain_validated(const struct s2n_x509_validator *validator)
{
return validator && (validator->state == VALIDATED || validator->state == OCSP_VALIDATED);
}
|