Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
netxduo![]()
nx_secure/src/nx_secure_x509_certificate_revocation_list_parse.c
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
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Secure Component */
/** */
/** X.509 Digital Certificates */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_secure_x509.h"
#ifndef NX_SECURE_X509_DISABLE_CRL
/* Helper functions. */
static UINT _nx_secure_x509_crl_tbscert_list_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl);
static UINT _nx_secure_x509_crl_signature_algorithm_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed,
NX_SECURE_X509_CRL *crl);
static UINT _nx_secure_x509_crl_signature_data_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl);
static UINT _nx_secure_x509_crl_version_parse(const UCHAR *buffer, ULONG length, UINT *bytes_processed,
NX_SECURE_X509_CRL *crl);
static UINT _nx_secure_x509_crl_issuer_parse(const UCHAR *buffer, ULONG length, UINT *bytes_processed,
NX_SECURE_X509_CRL *crl);
static UINT _nx_secure_x509_crl_update_times_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl);
static UINT _nx_secure_x509_crl_revoked_certs_list_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed,
NX_SECURE_X509_CRL *crl);
static UINT _nx_secure_x509_crl_extensions_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl);
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_certificate_revocation_list_parse PORTABLE C */
/* 6.1.6 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses a DER-encoded X509 Certificate Revocation List */
/* (CRL) with the express purpose of identifying whether the supplied */
/* certificate is present in the supplied CRL and therefore has been */
/* revoked by the issuing CA. */
/* */
/* INPUT */
/* */
/* certificate Certificate being verified */
/* crl Pointer to CRL data */
/* crl_length Length of CRL data */
/* */
/* OUTPUT */
/* */
/* certificate status NX_SUCCESS if cert is good */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* _nx_secure_x509_crl_signature_algorithm_parse */
/* Parse signature algorithm in */
/* _nx_secure_x509_crl_signature_data_parse */
/* Parse signature data in crl */
/* _nx_secure_x509_crl_tbscert_list_parse */
/* Parse TBSCertList in crl */
/* */
/* CALLED BY */
/* */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* 04-02-2021 Timothy Stapko Modified comment(s), */
/* removed dependency on TLS, */
/* resulting in version 6.1.6 */
/* */
/**************************************************************************/
UINT _nx_secure_x509_certificate_revocation_list_parse(const UCHAR *buffer, UINT length,
UINT *bytes_processed,
NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
UINT bytes;
const UCHAR *tlv_data;
ULONG header_length;
UINT status;
/* ASN.1 for CRL structure from RFC 5280:
* CertificateList ::= SEQUENCE
* {
* tbsCertList TBSCertList,
* signatureAlgorithm AlgorithmIdentifier,
* signatureValue BIT STRING
* }
*
* TBSCertList ::= SEQUENCE
* {
* version Version OPTIONAL,
* -- if present, MUST be v2
* signature AlgorithmIdentifier,
* issuer Name,
* thisUpdate Time,
* nextUpdate Time OPTIONAL,
* revokedCertificates SEQUENCE OF SEQUENCE
* {
* userCertificate CertificateSerialNumber,
* revocationDate Time,
* crlEntryExtensions Extensions OPTIONAL
* -- if present, version MUST be v2
* } OPTIONAL,
* crlExtensions [0] EXPLICIT Extensions OPTIONAL
* -- if present, version MUST be v2
* }
*
* Version ::= INTEGER { v1(0), v2(1), v3(2) }
*
* CertificateSerialNumber ::= INTEGER
*
* Time ::= CHOICE
* {
* utcTime UTCTime,
* generalTime GeneralizedTime
* }
*
* Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
*
* Extension ::= SEQUENCE
* {
* extnID OBJECT IDENTIFIER,
* critical BOOLEAN DEFAULT FALSE,
* extnValue OCTET STRING
* -- contains the DER encoding of an ASN.1 value
* -- corresponding to the extension type identified
* -- by extnID
* }
*
*/
/* Parse a TLV block - first block should be the CertificateList. */
status = _nx_secure_x509_asn1_tlv_block_parse(buffer, (ULONG *)&length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
if (tlv_type != NX_SECURE_ASN_TAG_SEQUENCE || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
return(NX_SECURE_X509_INVALID_CERTIFICATE_SEQUENCE);
}
*bytes_processed = header_length;
length = tlv_length;
/* Next block should be the TBSCertList. */
status = _nx_secure_x509_crl_tbscert_list_parse(tlv_data, tlv_length, &bytes, crl);
if (status != 0)
{
return(status);
}
*bytes_processed += bytes;
/* Following the certificate data is the signature algorithm data. */
tlv_data = &tlv_data[bytes];
length -= bytes;
status = _nx_secure_x509_crl_signature_algorithm_parse(tlv_data, length, &bytes, crl);
if (status != 0)
{
return(status);
}
*bytes_processed += bytes;
/* Finally, the signature itself is at the end of the CRL. */
tlv_data = &tlv_data[bytes];
length -= bytes;
status = _nx_secure_x509_crl_signature_data_parse(tlv_data, length, &bytes, crl);
if (status != 0)
{
return(status);
}
/* Return the number of bytes we processed. */
*bytes_processed += bytes;
/* Successfully parsed an X509 CRL. */
return(NX_SECURE_X509_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_tbscert_list_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the top-level ASN.1 sequence of a Certificate */
/* Revocation List (CRL). The sequence contains the list of */
/* certificates that have been revoked by the providing issuer. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if CRL was parsed */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* _nx_secure_x509_crl_extensions_parse Parse extensions in crl */
/* _nx_secure_x509_crl_issuer_parse Parse issuer in crl */
/* _nx_secure_x509_crl_revoked_certs_list_parse */
/* Parse revoked certificate list*/
/* _nx_secure_x509_crl_signature_algorithm_parse */
/* Parse signature algorithm in */
/* crl */
/* _nx_secure_x509_crl_update_times_parse */
/* Parse update times in crl */
/* _nx_secure_x509_crl_version_parse Parse version in crl */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_certificate_revocation_list_parse */
/* Parse revocation list */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_tbscert_list_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
UINT bytes;
UINT cur_length;
const UCHAR *tlv_data;
ULONG header_length;
UINT status;
/*
* TBSCertList ::= SEQUENCE
* {
* version Version OPTIONAL,
* -- if present, MUST be v2
* signature AlgorithmIdentifier,
* issuer Name,
* thisUpdate Time,
* nextUpdate Time OPTIONAL,
* revokedCertificates SEQUENCE OF SEQUENCE
* {
* userCertificate CertificateSerialNumber,
* revocationDate Time,
* crlEntryExtensions Extensions OPTIONAL
* -- if present, version MUST be v2
* } OPTIONAL,
* crlExtensions [0] EXPLICIT Extensions OPTIONAL
* -- if present, version MUST be v2
* }
*/
/* Parse the sequence container for TBSCertList. */
status = _nx_secure_x509_asn1_tlv_block_parse(buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
/* Buffer should contain the certificate data sequence. */
if (tlv_type != NX_SECURE_ASN_TAG_SEQUENCE || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
return(NX_SECURE_X509_INVALID_CERTIFICATE_DATA);
}
/* Save off a pointer to the data for later use in verification. Includes the complete TBSCertList structure. */
crl -> nx_secure_x509_crl_verify_data = buffer;
crl -> nx_secure_x509_crl_verify_data_length = (USHORT)(tlv_length + header_length);
*bytes_processed = header_length;
cur_length = tlv_length;
/* First up is the version data. */
status = _nx_secure_x509_crl_version_parse(tlv_data, tlv_length, &bytes, crl);
if (status != 0)
{
return(status);
}
/* Next, the signature algorithm. */
tlv_data = &tlv_data[bytes];
cur_length -= bytes;
*bytes_processed += bytes;
status = _nx_secure_x509_crl_signature_algorithm_parse(tlv_data, cur_length, &bytes, crl);
if (status != 0)
{
return(status);
}
/* Next is the issuer data. */
tlv_data = &tlv_data[bytes];
cur_length -= bytes;
*bytes_processed += bytes;
status = _nx_secure_x509_crl_issuer_parse(tlv_data, cur_length, &bytes, crl);
if (status != 0)
{
return(status);
}
/* Update times - both this and the next update. */
tlv_data = &tlv_data[bytes];
cur_length -= bytes;
*bytes_processed += bytes;
status = _nx_secure_x509_crl_update_times_parse(tlv_data, cur_length, &bytes, crl);
if (status != 0)
{
return(status);
}
/* Parse the revoked certificates list. */
tlv_data = &tlv_data[bytes];
cur_length -= bytes;
*bytes_processed += bytes;
status = _nx_secure_x509_crl_revoked_certs_list_parse(tlv_data, cur_length, &bytes, crl);
if (status != 0)
{
return(status);
}
/* Parse extensions. */
tlv_data = &tlv_data[bytes];
cur_length -= bytes;
*bytes_processed += bytes;
/* The following fields are all optional, so stop parsing with success if
they were not included. */
if (cur_length == 0)
{
return(NX_SECURE_X509_SUCCESS);
}
status = _nx_secure_x509_crl_extensions_parse(tlv_data, cur_length, &bytes, crl);
if (status != 0)
{
return(status);
}
*bytes_processed += bytes;
/* Parsed X509 certificate data successfully. */
return(NX_SECURE_X509_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_signature_algorithm_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the signature algorithm field in an X.509 CRL. */
/* The signature algorithm identifies which cryptographic routines */
/* were used to sign the CRL. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if parsing success */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* _nx_secure_x509_oid_parse Parse OID in certificate */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_certificate_revocation_list_parse */
/* Parse revocation list */
/* _nx_secure_x509_crl_tbscert_list_parse */
/* Parse TBSCertList in crl */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_signature_algorithm_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed,
NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
const UCHAR *tlv_data;
UINT oid;
ULONG header_length;
UINT status;
UCHAR oid_found = NX_CRYPTO_FALSE;
/* The signature algorithm is a sequence of OIDs that is terminated by a NULL ASN.1 tag. */
*bytes_processed = 0;
/* First, parse the sequence. */
status = _nx_secure_x509_asn1_tlv_block_parse(buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
if (tlv_type != NX_SECURE_ASN_TAG_SEQUENCE || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
return(NX_SECURE_X509_UNEXPECTED_ASN1_TAG);
}
/* Limit the length to the sequence length. */
length = tlv_length;
/* While the tag is not NULL and we don't run out of buffer, keep parsing OIDs. */
*bytes_processed += header_length;
while (length > 0)
{
status = _nx_secure_x509_asn1_tlv_block_parse(tlv_data, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
if (status != 0)
{
return status;
}
/* Update bytes processed. */
*bytes_processed += (header_length + tlv_length);
/* Now check out what we got. */
if (tlv_type == NX_SECURE_ASN_TAG_OID)
{
_nx_secure_x509_oid_parse(tlv_data, tlv_length, &oid);
crl -> nx_secure_x509_crl_signature_algorithm = (USHORT)oid;
oid_found = NX_CRYPTO_TRUE;
}
else if (tlv_type == NX_SECURE_ASN_TAG_NULL)
{
break;
}
else
{
return(NX_SECURE_X509_UNEXPECTED_ASN1_TAG);
}
/* Advance the data pointer. */
tlv_data = &tlv_data[tlv_length];
}
if (oid_found == NX_CRYPTO_TRUE)
{
return(NX_SECURE_X509_SUCCESS);
}
/* We were expecting a signature algorithm OID but didn't find one. */
return(NX_SECURE_X509_MISSING_SIGNATURE_ALGORITHM);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_signature_data_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the signature field of an X.509 CRL. The */
/* signature is used to verify that the CRL came from the actual */
/* issuer and is not a forgery by an attacker. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if parsing success */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_certificate_revocation_list_parse */
/* Parse revocation list */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_signature_data_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
const UCHAR *tlv_data;
ULONG header_length;
UINT status;
/* First, parse the sequence. */
status = _nx_secure_x509_asn1_tlv_block_parse(buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
if (tlv_type != NX_SECURE_ASN_TAG_BIT_STRING || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
return(NX_SECURE_X509_UNEXPECTED_ASN1_TAG);
}
/* Save off a pointer to the signature data and its length. */
/* Signature has a 0 byte at the front we need to skip.
* This is due to the data being encoded as an ASN.1 bit string, which may
* require padding bits to get to a multiple of 8 for byte alignment. The byte
* represents the number of padding bits, but in X509 it should always be 0. */
crl -> nx_secure_x509_crl_signature_data = &tlv_data[1];
crl -> nx_secure_x509_crl_signature_data_length = tlv_length - 1;
/* Return the number of bytes we processed. */
*bytes_processed = header_length + tlv_length;
return(NX_SECURE_X509_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_version_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the version field of an X.509 CRL, giving the */
/* version of X.509 the CRL uses. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if parsing success */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_crl_tbscert_list_parse */
/* Parse TBSCertList in crl */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_version_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
const UCHAR *tlv_data;
ULONG header_length;
UINT status;
/* Parse a TLV block and get information to continue parsing. */
status = _nx_secure_x509_asn1_tlv_block_parse(buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
/* Check to see if version exists. If the version is present it will have a type
* of NX_SECURE_ASN_TAG_BER. Otherwise it is an X509v1 certificate or invalid
* (determined higher up the call stack). */
if (tlv_type != NX_SECURE_ASN_TAG_INTEGER || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
/* No Version field found, assume v1. */
crl -> nx_secure_x509_crl_version = 0;
*bytes_processed = 0;
return(NX_SECURE_X509_SUCCESS);
}
crl -> nx_secure_x509_crl_version = (USHORT)tlv_data[0];
/* Return the number of bytes we processed. */
*bytes_processed = header_length + tlv_length;
/* Always return success - this field is optional. */
return(NX_SECURE_X509_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_issuer_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the issuer distinguished name field in an */
/* X.509 CRL. The issuer is the CA entity that created and signed the */
/* CRL. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if parsing success */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* _nx_secure_x509_distinguished_name_parse */
/* Parse Distinguished Name */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_crl_tbscert_list_parse */
/* Parse TBSCertList in crl */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_issuer_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
UINT bytes;
const UCHAR *tlv_data;
ULONG header_length;
UINT status;
/* First, parse the sequence. */
status = _nx_secure_x509_asn1_tlv_block_parse(buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
if (tlv_type != NX_SECURE_ASN_TAG_SEQUENCE || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
return(NX_SECURE_X509_UNEXPECTED_ASN1_TAG);
}
/* Now, parse the distinguished name. */
status = _nx_secure_x509_distinguished_name_parse(tlv_data, tlv_length, &bytes, &crl -> nx_secure_x509_crl_issuer);
/* Return the number of bytes we processed. */
*bytes_processed = bytes + header_length;
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_update_times_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the update times field in an X.509 CRL. The */
/* update times provided indicate when the next CRL should be */
/* available for download. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if parsing success */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_crl_tbscert_list_parse */
/* Parse TBSCertList in crl */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_update_times_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
const UCHAR *tlv_data;
ULONG header_length;
UINT status;
const UCHAR *current_buffer;
current_buffer = buffer;
/* Parse the "thisUpdate" field. */
status = _nx_secure_x509_asn1_tlv_block_parse(current_buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
if ((tlv_type != NX_SECURE_ASN_TAG_UTC_TIME && tlv_type != NX_SECURE_ASN_TAG_GENERALIZED_TIME) || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
return(NX_SECURE_X509_UNEXPECTED_ASN1_TAG);
}
/* Extract the data we need. */
crl -> nx_secure_x509_crl_time_format = tlv_type;
crl -> nx_secure_x509_crl_this_update = tlv_data;
crl -> nx_secure_x509_crl_this_update_length = (USHORT)tlv_length;
/* Advance to our next item. */
current_buffer = current_buffer + (tlv_length + header_length);
/* Return our bytes processed. */
*bytes_processed = header_length + tlv_length;
/* Parse the optional "nextUpdate" field, if it exists. */
status = _nx_secure_x509_asn1_tlv_block_parse(current_buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
/* The "nextUpdate" field is optional, so if we don't parse a time type here, that is OK. */
if ((tlv_type != NX_SECURE_ASN_TAG_UTC_TIME && tlv_type != NX_SECURE_ASN_TAG_GENERALIZED_TIME) || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
crl -> nx_secure_x509_crl_next_update = NX_CRYPTO_NULL;
crl -> nx_secure_x509_crl_next_update_length = 0;
return(NX_SECURE_X509_SUCCESS);
}
crl -> nx_secure_x509_crl_next_update = tlv_data;
crl -> nx_secure_x509_crl_next_update_length = (USHORT)tlv_length;
/* Return our bytes processed. */
*bytes_processed += header_length + tlv_length;
return(NX_SECURE_X509_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_revoked_certs_list_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the revokedCertificates list from an X.509 */
/* CRL. The certificates list is not parsed here, but a pointer to the */
/* list is saved in the CRL information structure so later searches */
/* for revoked certificates can be done quickly. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if parsing success */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_crl_tbscert_list_parse */
/* Parse TBSCertList in crl */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_revoked_certs_list_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed,
NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
const UCHAR *tlv_data;
ULONG header_length;
UINT status;
const UCHAR *current_buffer;
current_buffer = buffer;
/* Parse the sequence container for TBSCertList. */
status = _nx_secure_x509_asn1_tlv_block_parse(current_buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
/* Buffer should contain the certificate data sequence. */
if (tlv_type != NX_SECURE_ASN_TAG_SEQUENCE || tlv_type_class != NX_SECURE_ASN_TAG_CLASS_UNIVERSAL)
{
return(NX_SECURE_X509_INVALID_CERTIFICATE_DATA);
}
*bytes_processed = header_length + tlv_length;
/* Save off a pointer to the beginning of the revoked certificates list for later use. */
crl -> nx_secure_x509_crl_revoked_certs = tlv_data;
crl -> nx_secure_x509_crl_revoked_certs_length = tlv_length;
return(NX_SECURE_X509_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_x509_crl_extensions_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the extensions field in an X.509 CRL. */
/* Currently, no extensions are supported so the function simply */
/* advances the parsing position in the raw CRL data buffer. */
/* */
/* INPUT */
/* */
/* buffer Pointer to CRL data */
/* length Length of data in buffer */
/* bytes_processed Return bytes parsed */
/* crl CRL information structure */
/* */
/* OUTPUT */
/* */
/* status NX_SUCCESS if parsing success */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_asn1_tlv_block_parse Parse ASN.1 block */
/* */
/* CALLED BY */
/* */
/* _nx_secure_x509_crl_tbscert_list_parse */
/* Parse TBSCertList in crl */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_secure_x509_crl_extensions_parse(const UCHAR *buffer, ULONG length,
UINT *bytes_processed, NX_SECURE_X509_CRL *crl)
{
USHORT tlv_type;
USHORT tlv_type_class;
ULONG tlv_length;
/*
ULONG extensions_sequence_length;
UINT extension_oid;
*/
const UCHAR *tlv_data;
const UCHAR *current_buffer;
ULONG header_length;
UINT status;
NX_CRYPTO_PARAMETER_NOT_USED(bytes_processed);
NX_CRYPTO_PARAMETER_NOT_USED(crl);
current_buffer = buffer;
/* First, parse the context-specific tag (if it exists). */
status = _nx_secure_x509_asn1_tlv_block_parse(current_buffer, &length, &tlv_type, &tlv_type_class, &tlv_length, &tlv_data, &header_length);
/* Make sure we parsed the block alright. */
if (status != 0)
{
return(status);
}
/* Make sure we update our bytes processed. */
*bytes_processed = header_length + tlv_length;
/* If the next item up is not a sequence, then it isn't an extensions block. */
if (!(tlv_type_class == NX_SECURE_ASN_TAG_CLASS_CONTEXT && tlv_type == NX_SECURE_X509_CRL_TAG_EXTENSIONS))
{
/* No extensions block is OK because it is OPTIONAL. */
return(NX_SECURE_X509_SUCCESS);
}
return(NX_SECURE_X509_SUCCESS);
}
#endif /* NX_SECURE_X509_DISABLE_CRL */