-
-
Notifications
You must be signed in to change notification settings - Fork 282
Expand file tree
/
Copy pathNTFS.hexpat
More file actions
1571 lines (1379 loc) · 60.7 KB
/
NTFS.hexpat
File metadata and controls
1571 lines (1379 loc) · 60.7 KB
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
#pragma author MODIFIED BY: Formula Zero One Technologies
#pragma description NT File System (NTFS_v2.0)
#pragma endian little
// -----------------------------------------------------------------------------
// CREDIT
// -----------------------------------------------------------------------------
// OG AUTHOR: Hrant Tadevosyan (Axcient, now ConnectWise)
// OG DESC: ntfs.hexpat_v1.0
// So much work went into this pattern; NICE JOB!!
// -----------------------------------------------------------------------------
// NOTES FOR v2.0
// -----------------------------------------------------------------------------
// Imported by DISK_PARSER.hexpat
// Added recursive parsing for all $MFT records
// Added D/T conversions
// Changed most ntfschar to char16 to show filenames on hover
// Added comments to DFIR fields of interest
// Changed pattern output naming/structure. Similar to RunTime's DiskExplorer -- FREntry > FRHeader > ATTRName > ATTRHeader > ATTRBody > ATTREnd
// Reconfigured x50 ATTR and ACL processing
// Modified RunList - File Content Pointer
// -----------------------------------------------------------------------------
// NTFS MANTRAS FROM NW3C...
// -----------------------------------------------------------------------------
// --- 1 --- EVERYTHING IN NTFS IS A FILE (RECORD) (INCLUDING DIRs)
// --- 2 --- EVERY FILE (& DIR) HAS AN ENTRY IN THE $MFT, INCLUDING THE $MFT ITSELF
// --- 3 --- EVERY FILE (RECORD) IS MADE UP OF ATTRIBUTES
// --------- FILES = x10/x30/x80 (minimum)
// --------- DIRs = x10/x30/x90 (minimum)
// -----------------------------------------------------------------------------
// -------------------------------------------------------------------------
// IMPORTS
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
import std.core;
import std.array;
import std.ptr;
import std.io;
import std.mem;
import std.string;
import std.time;
import type.magic;
import type.time;
import type.guid;
import type.base;
// -------------------------------------------------------------------------
// FWD DECs - GLOBALS
// -------------------------------------------------------------------------
// *** ATTENTION ***
// ---*******---*******----vvvv--- |
const bool VOLUME_REPORT = true;
// ---*******---*******----^^^^--- |
u64 VBR_OFFSET;
u64 prev_lcn = 0;
u32 MFT_Count;
u32 Unused_Count;
u8 NT_Major;
u8 NT_Minor;
type::Hex<u32> mft_num;
type::Hex<u32> seq_num;
str Vol_Label;
u8 PRENT_MFT;
u8 PRENT_SEQ;
// -------------------------------------------------------------------------
// GENERAL HELPERS RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
using ntfschar = u16;
using leVCN = u64;
using leLCN = u64;
using leLSN = u64;
using leMFT_REF = u64;
bitfield RUNLIST_HEADER {
unsigned SE_Offset : 4;
unsigned Length : 4;
} [[bitfield_order(std::core::BitfieldOrder::MostToLeastSignificant, 8)]];
// -------------------------------------------------------------------------
// RUNLIST
// -------------------------------------------------------------------------
struct RUNLIST {
RUNLIST_HEADER RunList_Header
[[comment("Left Nibble = S.E. Bytes | Right Nibble = S.E. Length")]];
// Highlight the Stream Extent bytes
char run_extent[RunList_Header.SE_Offset + RunList_Header.Length] @ $
[[name(std::format("Run_Extent: {} + {} = {} Bytes ",
RunList_Header.SE_Offset,
RunList_Header.Length,
RunList_Header.SE_Offset + RunList_Header.Length)),
comment("Start/Run Extent | Derived from Header")]];
// Get number of clusters as a string
str NoC_value = std::string::to_string(
std::mem::read_unsigned($, RunList_Header.Length));
// Highlight exactly RunList_Header.Length bytes
char Num_of_Clusters[RunList_Header.Length]
[[name(std::format("Num_of_Clusters = {} ", NoC_value)),
comment("Number of Clusters in a Run")]];
// Needed for mft_get_dat_attr_lcn function only
u8 Logical_Cluster_Num[RunList_Header.SE_Offset] [[hidden]];
if (RunList_Header.SE_Offset > 0) {
// Read run length (little-endian)
u64 num_clusters = std::mem::read_unsigned(
$ - (RunList_Header.SE_Offset + RunList_Header.Length),
RunList_Header.Length);
// Read signed LCN delta
s64 lcn_delta = std::mem::read_signed(
$ - RunList_Header.SE_Offset,
RunList_Header.SE_Offset);
u64 data_size = num_clusters * cluster_size;
u64 content_offset = VBR_OFFSET + (lcn_delta * cluster_size);
// Show both decimal LCN and absolute byte offset in the label
char Start_LCN[RunList_Header.SE_Offset] @ $ - RunList_Header.SE_Offset
[[name(std::format("Start_LCN {} | Offset 0x{:X} ",
lcn_delta,
content_offset)),
comment("Starting Logical Cluster Number")]];
// Pointer to the file content
char MAGIC_BYTES[4] @ content_offset - VBR_OFFSET //u8 as needed...
[[comment("Pointer to Start Cluster"), static, sealed]];
// Select all allocated clusters for easy Section View
// May error - array grew past end of data....
//u8 CLUSTER_CONTENT[data_size] @ content_offset - VBR_OFFSET
// [[comment("Pointer to Cluster Content"), static, sealed]];
//if (MAGIC_BYTES == 0xFFD8FF) {
// IMPORT AND CALL jpeg.hexpat
//}
}
// Look ahead at the next byte to detect another run
u8 next_byte @ $ [[hidden]];
if (next_byte != 0x00) {
RUNLIST Next_Run; // recursively parse next run
}
} [[inline]];
fn calc_lcn_str(u64 start_offset, u32 len) {
if (len == 0)
return "0";
return std::mem::read_unsigned(start_offset, len);
};
// -------------------------------------------------------------------------
// SIGNATURE HELPER
// -------------------------------------------------------------------------
enum VBRSignature : u16 {
VBR_SIG = 0xAA55
};
// -------------------------------------------------------------------------
// WINDOWS FILETIME FUNC
// -------------------------------------------------------------------------
fn parse_filetime(u64 raw_ft) {
// Convert raw FILETIME to Unix time
u64 unix_time = type::impl::format_filetime_as_unix(raw_ft);
// Convert Unix time to structured UTC time
std::time::Time ts = std::time::to_utc(unix_time);
// Format as string
str formatted = std::time::format(ts, "%Y-%m-%d %H:%M:%S");
return formatted;
};
// -------------------------------------------------------------------------
// NTFS VOLUME BOOT RECORD RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
struct BIOS_PARAMETER_BLOCK {
u16 bytes_per_sector [[comment("Bytes per Sector")]];
u8 sectors_per_cluster [[comment("Sectors per Cluster")]];
u16 reserved_sectors [[comment("Reserved")]];;
u8 fats [[comment("Zeros")]];;
u16 root_entries [[comment("Unused")]];
u16 sectors [[comment("Unused")]];
u8 media_descriptor [[comment("Always F8-2003+")]];
u16 sectors_per_fat [[comment("Legacy")]];
u16 sectors_per_track [[comment("Legacy")]];
u16 heads [[comment("Legacy")]];
u32 hidden_sectors [[comment("Sectors before Volume")]];
u32 large_sectors [[comment("Legacy")]];
};
// -------------------------------------------------------------------------
// FILE RECORD ENTRY RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
enum NTFS_RECORD_TYPES : u32 {
magic_FILE = 0x454c4946,
magic_INDX = 0x58444e49,
magic_HOLE = 0x454c4f48,
magic_RSTR = 0x52545352,
magic_RCRD = 0x44524352,
magic_CHKD = 0x444b4843,
magic_BAAD = 0x44414142,
magic_empty = 0xffffffff,
};
// For other records, such as Index
struct NTFS_RECORD {
NTFS_RECORD_TYPES magic [[comment("File Record Signature 'FILE'")]];;
u16 usa_ofs [[comment("Offset to Fix Up Array")]];
u16 usa_count [[comment("# of 2 Byte Entries in FUA")]];
};
enum MFT_RECORD_FLAGS : u16 {
MFT_RECORD_NOT_IN_USE = 0x0000,
MFT_RECORD_IN_USE = 0x0001,
MFT_RECORD_IS_DIRECTORY = 0x0002,
MFT_RECORD_IS_4 = 0x0004,
MFT_RECORD_IS_VIEW_INDEX = 0x0008,
MFT_REC_SPACE_FILLER = 0xffff,
};
// -------------------------------------------------------------------------
// FILE RECORD ATTRIBUTE RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
enum ATTR_TYPES : u32 {
AT_UNUSED = 0x00,
AT_STANDARD_INFORMATION = 0x10,
AT_ATTRIBUTE_LIST = 0x20,
AT_FILE_NAME = 0x30,
AT_OBJECT_ID = 0x40,
AT_SECURITY_DESCRIPTOR = 0x50,
AT_VOLUME_NAME = 0x60,
AT_VOLUME_INFORMATION = 0x70,
AT_DATA = 0x80,
AT_INDEX_ROOT = 0x90,
AT_INDEX_ALLOCATION = 0xa0,
AT_BITMAP = 0xb0,
AT_REPARSE_POINT = 0xc0,
AT_EA_INFORMATION = 0xd0,
AT_EA = 0xe0,
AT_PROPERTY_SET = 0xf0,
AT_LOGGED_UTILITY_STREAM = 0x100,
AT_FIRST_USER_DEFINED_ATTRIBUTE = 0x1000,
AT_END = 0xffffffff,
};
enum ATTR_DEF_FLAGS : u32 {
ATTR_DEF_INDEXABLE = 0x02,
ATTR_DEF_MULTIPLE = 0x04,
ATTR_DEF_NOT_ZERO = 0x08,
ATTR_DEF_INDEXED_UNIQUE = 0x10,
ATTR_DEF_NAMED_UNIQUE = 0x20,
ATTR_DEF_RESIDENT = 0x40,
ATTR_DEF_ALWAYS_LOG = 0x80,
};
enum COLLATION_RULES : u32 {
COLLATION_BINARY = 0,
COLLATION_FILE_NAME = 1,
COLLATION_UNICODE_STRING = 2,
COLLATION_NTOFS_ULONG = 16,
COLLATION_NTOFS_SID = 17,
COLLATION_NTOFS_SECURITY_HASH = 18,
COLLATION_NTOFS_ULONGS = 19,
};
struct ATTR_DEF {
//ntfschar name[0x40];
char16 name[0x40];
ATTR_TYPES type;
u32 display_rule;
COLLATION_RULES collation_rule;
ATTR_DEF_FLAGS flags;
u64 min_size;
u64 max_size;
};
enum ATTR_FLAGS : u16 {
ATTR_IS_COMPRESSED = 0x0001,
ATTR_COMPRESSION_MASK = 0x00ff,
ATTR_IS_ENCRYPTED = 0x4000,
ATTR_IS_SPARSE = 0x8000,
};
enum RESIDENT_ATTR_FLAGS : u8 {
RESIDENT_ATTR_IS_INDEXED = 0x01,
RESIDENT_ATTR_NOT_INDEXED = 0x00,
};
enum FILE_ATTR_FLAGS : u32 {
FILE_ATTR_READONLY = 0x00000001,
FILE_ATTR_HIDDEN = 0x00000002,
FILE_ATTR_SYSTEM = 0x00000004,
FILE_ATTR_DIRECTORY = 0x00000010,
FILE_ATTR_ARCHIVE = 0x00000020,
FILE_ATTR_DEVICE = 0x00000040,
FILE_ATTR_NORMAL = 0x00000080,
FILE_ATTR_TEMPORARY = 0x00000100,
FILE_ATTR_SPARSE_FILE = 0x00000200,
FILE_ATTR_REPARSE_POINT = 0x00000400,
FILE_ATTR_COMPRESSED = 0x00000800,
FILE_ATTR_OFFLINE = 0x00001000,
FILE_ATTR_NOT_CONTENT_INDEXED = 0x00002000,
FILE_ATTR_ENCRYPTED = 0x00004000,
FILE_ATTRIBUTE_RECALL_ON_OPEN = 0x00040000,
FILE_ATTR_VALID_FLAGS = 0x00047fb7,
FILE_ATTR_VALID_SET_FLAGS = 0x000031a7,
FILE_ATTR_I30_INDEX_PRESENT = 0x10000000,
FILE_ATTR_VIEW_INDEX_PRESENT = 0x20000000,
};
enum FILE_NAME_TYPE_FLAGS : u8 {
FILE_NAME_POSIX = 0x00,
FILE_NAME_WIN32 = 0x01,
FILE_NAME_DOS = 0x02,
FILE_NAME_WIN32_AND_DOS = 0x03,
};
// -------------------------------------------------------------------------
// STANDARD INFO ATTRIBUTE RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
struct STANDARD_INFORMATION_BODY_OLD {
u64 Created_DT_UTC [[format("parse_filetime"), comment("Created DT UTC")]];
u64 Modified_DT_UTC [[format("parse_filetime"), comment("Modified DT UTC")]];
u64 MFT_Mod_DT_UTC [[format("parse_filetime"), comment("$MFT Mod DT UTC")]];
u64 Accessed_DT_UTC [[format("parse_filetime"), comment("Accessed DT UTC")]];
FILE_ATTR_FLAGS file_attributes [[comment("RASH ATTR")]];;
} [[static]];
struct STANDARD_INFORMATION_OLD {
u64 Created_DT_UTC [[format("parse_filetime"), comment("Created DT UTC")]];
u64 Modified_DT_UTC [[format("parse_filetime"), comment("Modified DT UTC")]];
u64 MFT_Mod_DT_UTC [[format("parse_filetime"), comment("$MFT Mod DT UTC")]];
u64 Accessed_DT_UTC [[format("parse_filetime"), comment("Accessed DT UTC")]];
FILE_ATTR_FLAGS file_attributes [[comment("RASH ATTR")]];;
u8 reserved12[12];
} [[static]];
struct STANDARD_INFORMATION {
u64 Created_DT_UTC [[format("parse_filetime"), comment("Created DT UTC")]];
u64 Modified_DT_UTC [[format("parse_filetime"), comment("Modified DT UTC")]];
u64 MFT_Mod_DT_UTC [[format("parse_filetime"), comment("$MFT Mod DT UTC")]];
u64 Accessed_DT_UTC [[format("parse_filetime"), comment("Accessed DT UTC")]];
FILE_ATTR_FLAGS file_attributes [[comment("RASH ATTR")]];;
u32 maximum_versions [[comment("Maximum Versions Allowed: Disabled = 0x00")]];;
u32 version_number [[comment("File Version Number")]];;
u32 class_id [[comment("Class ID")]];;
u32 owner_id [[comment("Owner ID - $Quota")]];;
u32 security_id [[comment("Security Permission Settings")]];;
u64 quota_charged [[comment("Number of Bytes Towards User Quota")]];;
u64 usn [[comment("Update Sequence Number - $USNJournal Index")]];;
} [[static]];
struct FILE_NAME_ATTR_PACKED {
u16 packed_ea_size [[comment("Size of xE0 ATTR")]];;
u16 reserved [[comment("Reserved")]];;
} [[static]];
union FILE_NAME_ATTR_FORM {
FILE_NAME_ATTR_PACKED packed; // [[inline]];
u32 reparse_point_tag [[comment("Reparse Point Tag")]];;
} [[static]];
struct FILE_NAME_ATTR {
PRENT_MFT = 0x00;
PRENT_SEQ = 0x00;
u8 MFT_Parent_Dir[6] [[comment("Parent Directory $MFT File Record Number")]];
u16 Parent_Seq_Num [[comment("Parent Directory $MFT Sequence Number")]];
u64 Created_DT_UTC [[format("parse_filetime"), comment("Created DT in UTC")]];
u64 Modified_DT_UTC [[format("parse_filetime"), comment("Modified DT in UTC")]];
u64 MFT_Mod_DT_UTC [[format("parse_filetime"), comment("MFT Mod DT in UTC")]];
u64 Accessed_DT_UTC [[format("parse_filetime"), comment("Accessed DT in UTC")]];
u64 allocated_size [[comment("Size on Disk")]];
u64 data_size [[comment("Logical File Size")]];
FILE_ATTR_FLAGS file_attributes [[comment("RASH ATTR")]];
FILE_NAME_ATTR_FORM form [[inline, comment("Reparse Value")]];
u8 file_name_length [[comment("File Name Length")]];
FILE_NAME_TYPE_FLAGS file_name_type [[comment("Namespace Type: POSIX = 0x00 | Win32 = 0x01 | DOS_SFN = 0x02 | Win32&DOS = 0x03")]];
char16 file_name[file_name_length] [[comment("The Actual File Name")]];
PRENT_MFT = MFT_Parent_Dir;
PRENT_SEQ = Parent_Seq_Num;
};
// -------------------------------------------------------------------------
// SECURITY DESC | OBJECT ID RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
struct OBJECT_ID_ATTR_INFO {
type::GUID birth_volume_id;
type::GUID birth_object_id;
type::GUID domain_id;
};
union OBJECT_ID_ATTR_FORM {
OBJECT_ID_ATTR_INFO info [[inline]];
u8 extended_info[48];
};
struct OBJECT_ID_ATTR {
type::GUID object_id;
OBJECT_ID_ATTR_FORM form [[inline]];
};
enum VOLUME_FLAGS : u16 {
VOLUME_IS_DIRTY = 0x0001,
VOLUME_RESIZE_LOG_FILE = 0x0002,
VOLUME_UPGRADE_ON_MOUNT = 0x0004,
VOLUME_MOUNTED_ON_NT4 = 0x0008,
VOLUME_DELETE_USN_UNDERWAY = 0x0010,
VOLUME_REPAIR_OBJECT_ID = 0x0020,
VOLUME_CHKDSK_UNDERWAY = 0x4000,
VOLUME_MODIFIED_BY_CHKDSK = 0x8000,
VOLUME_FLAGS_MASK = 0xc03f,
};
struct VOLUME_INFORMATION {
u64 reserved;
u8 major_ver;
u8 minor_ver;
VOLUME_FLAGS flags;
NT_Major = major_ver;
NT_Minor = minor_ver;
} [[static]];
enum SECURITY_DESCRIPTOR_CONTROL : u16 {
SE_OWNER_DEFAULTED = 0x0001,
SE_GROUP_DEFAULTED = 0x0002,
SE_DACL_PRESENT = 0x0004,
SE_DACL_DEFAULTED = 0x0008,
SE_SACL_PRESENT = 0x0010,
SE_SACL_DEFAULTED = 0x0020,
SE_DACL_AUTO_INHERIT_REQ = 0x0100,
SE_SACL_AUTO_INHERIT_REQ = 0x0200,
SE_DACL_AUTO_INHERITED = 0x0400,
SE_SACL_AUTO_INHERITED = 0x0800,
SE_DACL_PROTECTED = 0x1000,
SE_SACL_PROTECTED = 0x2000,
SE_RM_CONTROL_VALID = 0x4000,
SE_SELF_RELATIVE = 0x8000,
};
// ------------------------------
// Enums
// ------------------------------
enum ACE_TYPES : u8 {
ACCESS_MIN_MS_ACE_TYPE = 0,
ACCESS_ALLOWED_ACE_TYPE = 0,
ACCESS_DENIED_ACE_TYPE = 1,
SYSTEM_AUDIT_ACE_TYPE = 2,
SYSTEM_ALARM_ACE_TYPE = 3,
ACCESS_MAX_MS_V2_ACE_TYPE = 3,
ACCESS_ALLOWED_COMPOUND_ACE_TYPE = 4,
ACCESS_MAX_MS_V3_ACE_TYPE = 4,
ACCESS_MIN_MS_OBJECT_ACE_TYPE = 5,
ACCESS_ALLOWED_OBJECT_ACE_TYPE = 5,
ACCESS_DENIED_OBJECT_ACE_TYPE = 6,
SYSTEM_AUDIT_OBJECT_ACE_TYPE = 7,
SYSTEM_ALARM_OBJECT_ACE_TYPE = 8,
ACCESS_MAX_MS_OBJECT_ACE_TYPE = 8,
ACCESS_MAX_MS_V4_ACE_TYPE = 8,
ACCESS_MAX_MS_ACE_TYPE = 8,
ACCESS_ALLOWED_CALLBACK_ACE_TYPE = 9,
ACCESS_DENIED_CALLBACK_ACE_TYPE = 10,
ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE = 11,
ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE = 12,
SYSTEM_AUDIT_CALLBACK_ACE_TYPE = 13,
SYSTEM_ALARM_CALLBACK_ACE_TYPE = 14,
SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE = 15,
SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE = 16,
SYSTEM_MANDATORY_LABEL_ACE_TYPE = 17,
SYSTEM_RESOURCE_ATTRIBUTE_ACE_TYPE = 18,
SYSTEM_SCOPED_POLICY_ID_ACE_TYPE = 19,
SYSTEM_PROCESS_TRUST_LABEL_ACE_TYPE = 20,
};
enum ACE_FLAGS : u8 {
OBJECT_INHERIT_ACE = 0x01,
CONTAINER_INHERIT_ACE = 0x02,
NO_PROPAGATE_INHERIT_ACE = 0x04,
INHERIT_ONLY_ACE = 0x08,
INHERITED_ACE = 0x10,
VALID_INHERIT_FLAGS = 0x1f,
SUCCESSFUL_ACCESS_ACE_FLAG = 0x40,
FAILED_ACCESS_ACE_FLAG = 0x80,
};
enum ACCESS_MASK : u32 {
FILE_READ_DATA = 0x00000001,
FILE_LIST_DIRECTORY = 0x00000001,
FILE_WRITE_DATA = 0x00000002,
FILE_ADD_FILE = 0x00000002,
FILE_APPEND_DATA = 0x00000004,
FILE_ADD_SUBDIRECTORY = 0x00000004,
FILE_READ_EA = 0x00000008,
FILE_WRITE_EA = 0x00000010,
FILE_EXECUTE = 0x00000020,
FILE_TRAVERSE = 0x00000020,
FILE_DELETE_CHILD = 0x00000040,
FILE_READ_ATTRIBUTES = 0x00000080,
FILE_WRITE_ATTRIBUTES = 0x00000100,
DELETE = 0x00010000,
READ_CONTROL = 0x00020000,
WRITE_DAC = 0x00040000,
WRITE_OWNER = 0x00080000,
SYNCHRONIZE = 0x00100000,
STANDARD_RIGHTS_READ = 0x00020000,
STANDARD_RIGHTS_WRITE = 0x00020000,
STANDARD_RIGHTS_EXECUTE = 0x00020000,
STANDARD_RIGHTS_REQUIRED = 0x000f0000,
STANDARD_RIGHTS_ALL = 0x001f0000,
ACCESS_SYSTEM_SECURITY = 0x01000000,
MAXIMUM_ALLOWED = 0x02000000,
GENERIC_ALL = 0x10000000,
GENERIC_EXECUTE = 0x20000000,
GENERIC_WRITE = 0x40000000,
GENERIC_READ = 0x80000000,
};
enum OBJECT_ACE_FLAGS : u32 {
ACE_OBJECT_TYPE_PRESENT = 1,
ACE_INHERITED_OBJECT_TYPE_PRESENT = 2,
};
// ------------------------------
// ACE/SID
// ------------------------------
struct ACE_HEADER {
ACE_TYPES type;
ACE_FLAGS flags;
u16 size;
};
struct SID {
u8 revision;
u8 sub_authority_count;
u8 identifier_authority[6];
u32 sub_authority[sub_authority_count];
};
struct ACCESS_ALLOWED_ACE {
ACE_HEADER header [[inline]];
ACCESS_MASK mask;
SID sid;
};
using ACCESS_DENIED_ACE = ACCESS_ALLOWED_ACE;
using SYSTEM_ALARM_ACE = ACCESS_ALLOWED_ACE;
using SYSTEM_AUDIT_ACE = ACCESS_ALLOWED_ACE;
struct ACCESS_ALLOWED_OBJECT_ACE {
ACE_HEADER header [[inline]];
ACCESS_MASK mask;
OBJECT_ACE_FLAGS object_flags;
type::GUID object_type;
type::GUID inherited_object_type;
SID sid;
};
using ACCESS_DENIED_OBJECT_ACE = ACCESS_ALLOWED_OBJECT_ACE;
using SYSTEM_AUDIT_OBJECT_ACE = ACCESS_ALLOWED_OBJECT_ACE;
using SYSTEM_ALARM_OBJECT_ACE = ACCESS_ALLOWED_OBJECT_ACE;
// ------------------------------
// ACE HELPER
// ------------------------------
union ACE {
ACE_HEADER hdr [[hidden]];
match (hdr.type) {
(ACE_TYPES::ACCESS_ALLOWED_ACE_TYPE): ACCESS_ALLOWED_ACE allowed;
(ACE_TYPES::ACCESS_DENIED_ACE_TYPE): ACCESS_DENIED_ACE denied;
(ACE_TYPES::SYSTEM_AUDIT_ACE_TYPE): SYSTEM_AUDIT_ACE audit;
(ACE_TYPES::SYSTEM_ALARM_ACE_TYPE): SYSTEM_ALARM_ACE alarm;
(ACE_TYPES::ACCESS_ALLOWED_OBJECT_ACE_TYPE): ACCESS_ALLOWED_OBJECT_ACE obj_allowed;
(ACE_TYPES::ACCESS_DENIED_OBJECT_ACE_TYPE): ACCESS_DENIED_OBJECT_ACE obj_denied;
(ACE_TYPES::SYSTEM_AUDIT_OBJECT_ACE_TYPE): SYSTEM_AUDIT_OBJECT_ACE obj_audit;
(ACE_TYPES::SYSTEM_ALARM_OBJECT_ACE_TYPE): SYSTEM_ALARM_OBJECT_ACE obj_alarm;
}
// Consume remaining bytes as raw padding
padding[hdr.size - sizeof(ACE_HEADER)];
};
// ------------------------------
// ACL
// ------------------------------
struct ACL {
u8 revision;
u8 alignment1;
u16 size;
u16 ace_count;
u16 alignment2;
ACE aces[ace_count];
};
// ------------------------------
// SECURITY DESCRIPTOR
// ------------------------------
#define SECURITY_DESCRIPTOR_RELATIVE_SIZE (20)
struct SECURITY_DESCRIPTOR_RELATIVE {
u32 struct_start = $;
u8 revision;
u8 alignment;
u16 control; // SECURITY_DESCRIPTOR_CONTROL
u32 owner;
u32 group;
u32 sacl;
u32 dacl;
if (control & SECURITY_DESCRIPTOR_CONTROL::SE_DACL_PRESENT) {
if (dacl != 0) {
// Skip to the relative offset
if ($ - struct_start < dacl) {
padding[dacl - ($ - struct_start)];
}
ACL dacl_acl;
}
}
if (control & SECURITY_DESCRIPTOR_CONTROL::SE_SACL_PRESENT) {
if (sacl != 0) {
if ($ - struct_start < sacl) {
padding[sacl - ($ - struct_start)];
}
ACL sacl_acl;
}
}
if (owner > 0) {
u32 owner_bytes = $ - struct_start;
if (owner > owner_bytes) {
padding[owner - owner_bytes];
}
SID owner_sid;
}
if (group > 0) {
u32 group_bytes = $ - struct_start;
if (group > group_bytes) {
padding[group - group_bytes];
}
SID group_sid;
}
};
// -------------------------------------------------------------------------
// INDEX RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
// ------------------------------
// INDEX HEADER HELPER
// ------------------------------
enum INDEX_HEADER_FLAGS : u8 {
SMALL_INDEX = 0,
LARGE_INDEX = 1,
LEAF_NODE = 0,
INDEX_NODE = 1,
NODE_MASK = 1,
};
// ------------------------------
// INDEX HEADER PARSER
// ------------------------------
struct INDEX_HEADER {
u32 entries_offset;
u32 index_length;
u32 allocated_size;
INDEX_HEADER_FLAGS ih_flags;
u8 reserved[3];
};
// ------------------------------
// REPARSE INDEX KEY PARSER
// ------------------------------
struct REPARSE_INDEX_KEY {
u32 reparse_tag;
leMFT_REF file_id;
};
// ------------------------------
// SDS_ENTRY PARSER
// ------------------------------
struct SDS_ENTRY {
u32 hash;
u32 security_id;
u64 offset;
u32 length;
SECURITY_DESCRIPTOR_RELATIVE sid;
};
using SII_INDEX_KEY = u32 ;
// ------------------------------
// SDH INDEX KEY PARSER
// ------------------------------
struct SDH_INDEX_KEY {
u32 hash;
u32 security_id;
};
// ------------------------------
// INDEX ENTRY FLAG HELPER
// ------------------------------
enum INDEX_ENTRY_FLAGS : u16 {
INDEX_ENTRY_NODE = 1,
INDEX_ENTRY_END = 2,
INDEX_ENTRY_SPACE_FILLER = 0xffff,
};
// ------------------------------
// INDEX HEADER POINTER
// ------------------------------
struct INDEX_ENTR_HEADER_PTR {
u16 data_offset;
u16 data_length;
u32 reservedV;
};
// ------------------------------
// INDEX HEADER HELPER
// ------------------------------
union INDEX_ENTR_HEADER_REF {
leMFT_REF indexed_file;
INDEX_ENTR_HEADER_PTR ptr;
};
// ------------------------------
// INDEX HEADER PARSER
// ------------------------------
struct INDEX_ENTRY_HEADER {
INDEX_ENTR_HEADER_REF file_ref;
u16 length;
u16 key_length;
u16 flags; // INDEX_ENTRY_FLAGS
u16 reserved;
};
// ------------------------------
// INDEX ENTRY FN ATTR
// Duplicated so that parent mft# and parent seq# tracking doesn't break.
// ------------------------------
struct IDX_FILE_NAME_ATTR{
u8 MFT_Parent_Dir[6] [[comment("Parent Directory $MFT File Record Number")]];
u16 Parent_Seq_Num [[comment("Parent Directory $MFT Sequence Number")]];
u64 Created_DT_UTC [[format("parse_filetime"), comment("Created DT in UTC")]];
u64 Modified_DT_UTC [[format("parse_filetime"), comment("Modified DT in UTC")]];
u64 MFT_Mod_DT_UTC [[format("parse_filetime"), comment("MFT Mod DT in UTC")]];
u64 Accessed_DT_UTC [[format("parse_filetime"), comment("Accessed DT in UTC")]];
u64 allocated_size [[comment("Size on Disk")]];
u64 data_size [[comment("Logical File Size")]];
FILE_ATTR_FLAGS file_attributes [[comment("RASH ATTR")]];
FILE_NAME_ATTR_FORM form [[inline, comment("Reparse Value")]];
u8 file_name_length [[comment("File Name Length")]];
FILE_NAME_TYPE_FLAGS file_name_type [[comment("Namespace Type: POSIX = 0x00 | Win32 = 0x01 | DOS_SFN = 0x02 | Win32&DOS = 0x03")]];
char16 file_name[file_name_length] [[comment("The Actual File Name")]];
};
// ------------------------------
// INDEX ENTRY FN PARSER
// ------------------------------
struct INDEX_ENTRY_FILE_NAME {
INDEX_ENTRY_HEADER header;
if (!(header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END)) {
// Workaround -- Using new structure for IDX FNs -- Allows for setting parent info on non-IDX items
IDX_FILE_NAME_ATTR key;
}
if (header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_NODE) {
leVCN vcn;
}
std::mem::AlignTo<8>;
};
// ------------------------------
// INDEX ENTRY SII PARSER
// ------------------------------
struct INDEX_ENTRY_SII {
INDEX_ENTRY_HEADER header;
if (!(header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END)) {
SII_INDEX_KEY key;
}
if (header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_NODE) {
leVCN vcn;
}
std::mem::AlignTo<8>;
};
// ------------------------------
// INDEX ENTRY SDH PARSER
// ------------------------------
struct INDEX_ENTRY_SDH {
INDEX_ENTRY_HEADER header;
if (!(header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END)) {
SDH_INDEX_KEY key;
}
if (header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_NODE) {
leVCN vcn;
}
std::mem::AlignTo<8>;
};
// ------------------------------
// INDEX ENTRY OBJECT ID PARSER
// ------------------------------
struct INDEX_ENTRY_OBJ_ID {
INDEX_ENTRY_HEADER header;
if (!(header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END)) {
type::GUID key;
}
if (header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_NODE) {
leVCN vcn;
}
std::mem::AlignTo<8>;
};
// ------------------------------
// INDEX ENTRY REPARSE POINT PARSER
// ------------------------------
struct INDEX_ENTRY_REPARSE {
INDEX_ENTRY_HEADER header;
if (!(header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END)) {
REPARSE_INDEX_KEY key;
}
if (header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_NODE) {
leVCN vcn;
}
std::mem::AlignTo<8>;
};
// ------------------------------
// INDEX ENTRY SID PARSER
// ------------------------------
struct INDEX_ENTRY_SID {
INDEX_ENTRY_HEADER header;
if (!(header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END)) {
SID key;
}
if (header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_NODE) {
leVCN vcn;
}
std::mem::AlignTo<8>;
};
// ------------------------------
// INDEX ENTRY OWNER ID PARSER
// ------------------------------
struct INDEX_ENTRY_OWNER_ID {
INDEX_ENTRY_HEADER header;
if (!(header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END)) {
u64 key;
}
if (header.flags & INDEX_ENTRY_FLAGS::INDEX_ENTRY_NODE) {
leVCN vcn;
}
std::mem::AlignTo<8>;
};
// ------------------------------
// INDEX FLAGS FUNC
// ------------------------------
fn index_get_flags(u64 offset) {
INDEX_ENTRY_HEADER index_entry_header @ offset;
return index_entry_header.flags;
};
// ------------------------------
// INDEX BLOCK PARSER
// ------------------------------
struct INDEX_BLOCK {
NTFS_RECORD header [[inline]];
leLSN lsn;
leVCN index_block_vcn;
u32 index_head = $;
INDEX_HEADER index;
if (index.entries_offset > sizeof (index)) {
padding[index.entries_offset - sizeof (index)];
}
INDEX_ENTRY_FILE_NAME ents[while(!(index_get_flags($) & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END))];
INDEX_ENTRY_FILE_NAME ent_end;
u32 index_used = $ - index_head;
if (index.index_length > index_used) {
padding[index.index_length - index_used];
}
};
// ------------------------------
// INDEX ROOT PARSER
// ------------------------------
struct INDEX_ROOT {
ATTR_TYPES type;
COLLATION_RULES collation_rule;
u32 index_block_size;
s8 clusters_per_index_block;
u8 reserved[3] [[static, sealed]];
u32 index_head = $;
INDEX_HEADER index;
if (index.entries_offset > sizeof (index)) {
padding[index.entries_offset - sizeof (index)];
}
match (type) {
(ATTR_TYPES::AT_FILE_NAME): {
INDEX_ENTRY_FILE_NAME ents[while(!(index_get_flags($) & INDEX_ENTRY_FLAGS::INDEX_ENTRY_END))];
INDEX_ENTRY_FILE_NAME ent_end;
}
}
u32 index_used = $ - index_head;
if (index.index_length > index_used) {
padding[index.index_length - index_used];
}
};
// -------------------------------------------------------------------------
// RESTART AREA RELATED
// -------------------------------------------------------------------------
// V V V V V V V V V
// -------------------------------------------------------------------------
// ------------------------------
// RESTART AREA HEADER PARSER
// ------------------------------
struct RESTART_PAGE_HEADER {
NTFS_RECORD_TYPES magic;
u16 usa_ofs;
u16 usa_count;
leLSN chkdsk_lsn;
u32 system_page_size;
u32 log_page_size;
u16 restart_area_offset;
u16 minor_ver;
u16 major_ver;
u16 usn;
};
// ------------------------------
// RESTART AREA FLAG PARSER
// ------------------------------
enum RESTART_AREA_FLAGS : u16 {
RESTART_VOLUME_IS_CLEAN = 0x0002,
RESTART_SPACE_FILLER = 0xffff,
};
// ------------------------------
// RESTART AREA PARSER
// ------------------------------
struct RESTART_AREA {
leLSN current_lsn;
u16 log_clients;
u16 client_free_list;
u16 client_in_use_list;
RESTART_AREA_FLAGS flags;
u32 seq_number_bits;
u16 restart_area_length;
u16 client_array_offset;
u64 file_size;