-
Notifications
You must be signed in to change notification settings - Fork 715
/
hfsplus.c
1585 lines (1385 loc) · 66.8 KB
/
hfsplus.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
/*
* Copyright (C) 2013-2024 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
* Copyright (C) 2013 Sourcefire, Inc.
*
* Authors: David Raynor <[email protected]>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
/**
* Documentation:
* - https://digital-forensics.sans.org/media/FOR518-Reference-Sheet.pdf
* - https://github.com/sleuthkit/sleuthkit/blob/develop/tsk/fs/tsk_hfs.h
* - https://github.com/unsound/hfsexplorer/tree/master/src/java/org/catacombae/hfs
*/
#if HAVE_CONFIG_H
#include "clamav-config.h"
#endif
#include <fcntl.h>
#include "clamav.h"
#include "others.h"
#include "hfsplus.h"
#include "scanners.h"
#include "entconv.h"
#define DECMPFS_HEADER_MAGIC 0x636d7066
#define DECMPFS_HEADER_MAGIC_LE 0x66706d63
static void headerrecord_to_host(hfsHeaderRecord *);
static void headerrecord_print(const char *, hfsHeaderRecord *);
static void nodedescriptor_to_host(hfsNodeDescriptor *);
static void nodedescriptor_print(const char *, hfsNodeDescriptor *);
static void forkdata_to_host(hfsPlusForkData *);
static void forkdata_print(const char *, hfsPlusForkData *);
static cl_error_t hfsplus_volumeheader(cli_ctx *, hfsPlusVolumeHeader **);
static cl_error_t hfsplus_readheader(cli_ctx *, hfsPlusVolumeHeader *, hfsNodeDescriptor *,
hfsHeaderRecord *, int, const char *);
static cl_error_t hfsplus_scanfile(cli_ctx *, hfsPlusVolumeHeader *, hfsHeaderRecord *,
hfsPlusForkData *, const char *, char **, char *);
static cl_error_t hfsplus_validate_catalog(cli_ctx *, hfsPlusVolumeHeader *, hfsHeaderRecord *);
static cl_error_t hfsplus_fetch_node(cli_ctx *, hfsPlusVolumeHeader *, hfsHeaderRecord *,
hfsHeaderRecord *, hfsPlusForkData *, uint32_t, uint8_t *,
size_t);
static cl_error_t hfsplus_walk_catalog(cli_ctx *, hfsPlusVolumeHeader *, hfsHeaderRecord *,
hfsHeaderRecord *, hfsHeaderRecord *, const char *);
/* Header Record : fix endianness for useful fields */
static void headerrecord_to_host(hfsHeaderRecord *hdr)
{
hdr->treeDepth = be16_to_host(hdr->treeDepth);
hdr->rootNode = be32_to_host(hdr->rootNode);
hdr->leafRecords = be32_to_host(hdr->leafRecords);
hdr->firstLeafNode = be32_to_host(hdr->firstLeafNode);
hdr->lastLeafNode = be32_to_host(hdr->lastLeafNode);
hdr->nodeSize = be16_to_host(hdr->nodeSize);
hdr->maxKeyLength = be16_to_host(hdr->maxKeyLength);
hdr->totalNodes = be32_to_host(hdr->totalNodes);
hdr->freeNodes = be32_to_host(hdr->freeNodes);
hdr->attributes = be32_to_host(hdr->attributes); /* not too useful */
}
/* Header Record : print details in debug mode */
static void headerrecord_print(const char *pfx, hfsHeaderRecord *hdr)
{
cli_dbgmsg("%s Header: depth %hu root %u leafRecords %u firstLeaf %u lastLeaf %u nodeSize %hu\n",
pfx, hdr->treeDepth, hdr->rootNode, hdr->leafRecords, hdr->firstLeafNode,
hdr->lastLeafNode, hdr->nodeSize);
cli_dbgmsg("%s Header: maxKeyLength %hu totalNodes %u freeNodes %u btreeType %hhu attributes %x\n",
pfx, hdr->maxKeyLength, hdr->totalNodes, hdr->freeNodes,
hdr->btreeType, hdr->attributes);
}
/* Node Descriptor : fix endianness for useful fields */
static void nodedescriptor_to_host(hfsNodeDescriptor *node)
{
node->fLink = be32_to_host(node->fLink);
node->bLink = be32_to_host(node->bLink);
node->numRecords = be16_to_host(node->numRecords);
}
/* Node Descriptor : print details in debug mode */
static void nodedescriptor_print(const char *pfx, hfsNodeDescriptor *node)
{
cli_dbgmsg("%s Desc: fLink %u bLink %u kind %d height %u numRecords %u\n",
pfx, node->fLink, node->bLink, node->kind, node->height, node->numRecords);
}
/* ForkData : fix endianness */
static void forkdata_to_host(hfsPlusForkData *fork)
{
int i;
fork->logicalSize = be64_to_host(fork->logicalSize);
fork->clumpSize = be32_to_host(fork->clumpSize); /* does this matter for read-only? */
fork->totalBlocks = be32_to_host(fork->totalBlocks);
for (i = 0; i < 8; i++) {
fork->extents[i].startBlock = be32_to_host(fork->extents[i].startBlock);
fork->extents[i].blockCount = be32_to_host(fork->extents[i].blockCount);
}
}
/* ForkData : print details in debug mode */
static void forkdata_print(const char *pfx, hfsPlusForkData *fork)
{
int i;
cli_dbgmsg("%s logicalSize " STDu64 " clumpSize " STDu32 " totalBlocks " STDu32 "\n", pfx,
fork->logicalSize, fork->clumpSize, fork->totalBlocks);
for (i = 0; i < 8; i++) {
if (fork->extents[i].startBlock == 0)
break;
cli_dbgmsg("%s extent[%d] startBlock " STDu32 " blockCount " STDu32 "\n", pfx, i,
fork->extents[i].startBlock, fork->extents[i].blockCount);
}
}
/* Read and convert the HFS+ volume header */
static cl_error_t hfsplus_volumeheader(cli_ctx *ctx, hfsPlusVolumeHeader **header)
{
hfsPlusVolumeHeader *volHeader;
const uint8_t *mPtr;
if (!header) {
return CL_ENULLARG;
}
/* Start with volume header, 512 bytes at offset 1024 */
if (ctx->fmap->len < 1536) {
cli_dbgmsg("hfsplus_volumeheader: too short for HFS+\n");
return CL_EFORMAT;
}
mPtr = fmap_need_off_once(ctx->fmap, 1024, 512);
if (!mPtr) {
cli_errmsg("hfsplus_volumeheader: cannot read header from map\n");
return CL_EMAP;
}
volHeader = malloc(sizeof(hfsPlusVolumeHeader));
if (!volHeader) {
cli_errmsg("hfsplus_volumeheader: header malloc failed\n");
return CL_EMEM;
}
*header = volHeader;
memcpy(volHeader, mPtr, 512);
volHeader->signature = be16_to_host(volHeader->signature);
volHeader->version = be16_to_host(volHeader->version);
if ((volHeader->signature == 0x482B) && (volHeader->version == 4)) {
cli_dbgmsg("hfsplus_volumeheader: HFS+ signature matched\n");
} else if ((volHeader->signature == 0x4858) && (volHeader->version == 5)) {
cli_dbgmsg("hfsplus_volumeheader: HFSX v5 signature matched\n");
} else {
cli_dbgmsg("hfsplus_volumeheader: no matching signature\n");
return CL_EFORMAT;
}
/* skip fields that will definitely be ignored */
volHeader->attributes = be32_to_host(volHeader->attributes);
volHeader->fileCount = be32_to_host(volHeader->fileCount);
volHeader->folderCount = be32_to_host(volHeader->folderCount);
volHeader->blockSize = be32_to_host(volHeader->blockSize);
volHeader->totalBlocks = be32_to_host(volHeader->totalBlocks);
cli_dbgmsg("HFS+ Header:\n");
cli_dbgmsg("Signature: %x\n", volHeader->signature);
cli_dbgmsg("Attributes: %x\n", volHeader->attributes);
cli_dbgmsg("File Count: " STDu32 "\n", volHeader->fileCount);
cli_dbgmsg("Folder Count: " STDu32 "\n", volHeader->folderCount);
cli_dbgmsg("Block Size: " STDu32 "\n", volHeader->blockSize);
cli_dbgmsg("Total Blocks: " STDu32 "\n", volHeader->totalBlocks);
/* Block Size must be power of 2 between 512 and 1 MB */
if ((volHeader->blockSize < 512) || (volHeader->blockSize > (1 << 20))) {
cli_dbgmsg("hfsplus_volumeheader: Invalid blocksize\n");
return CL_EFORMAT;
}
if (volHeader->blockSize & (volHeader->blockSize - 1)) {
cli_dbgmsg("hfsplus_volumeheader: Invalid blocksize\n");
return CL_EFORMAT;
}
forkdata_to_host(&(volHeader->allocationFile));
forkdata_to_host(&(volHeader->extentsFile));
forkdata_to_host(&(volHeader->catalogFile));
forkdata_to_host(&(volHeader->attributesFile));
forkdata_to_host(&(volHeader->startupFile));
if (cli_debug_flag) {
forkdata_print("allocationFile", &(volHeader->allocationFile));
forkdata_print("extentsFile", &(volHeader->extentsFile));
forkdata_print("catalogFile", &(volHeader->catalogFile));
forkdata_print("attributesFile", &(volHeader->attributesFile));
forkdata_print("startupFile", &(volHeader->startupFile));
}
return CL_CLEAN;
}
/* Read and convert the header node */
static cl_error_t hfsplus_readheader(cli_ctx *ctx, hfsPlusVolumeHeader *volHeader, hfsNodeDescriptor *nodeDesc,
hfsHeaderRecord *headerRec, int headerType, const char *name)
{
const uint8_t *mPtr = NULL;
off_t offset;
uint32_t minSize, maxSize;
/* From TN1150: Node Size must be power of 2 between 512 and 32768 */
/* Node Size for Catalog or Attributes must be at least 4096 */
maxSize = 32768; /* Doesn't seem to vary */
switch (headerType) {
case HFS_FILETREE_ALLOCATION:
offset = volHeader->allocationFile.extents[0].startBlock * volHeader->blockSize;
minSize = 512;
break;
case HFS_FILETREE_EXTENTS:
offset = volHeader->extentsFile.extents[0].startBlock * volHeader->blockSize;
minSize = 512;
break;
case HFS_FILETREE_CATALOG:
offset = volHeader->catalogFile.extents[0].startBlock * volHeader->blockSize;
minSize = 4096;
break;
case HFS_FILETREE_ATTRIBUTES:
offset = volHeader->attributesFile.extents[0].startBlock * volHeader->blockSize;
minSize = 4096;
break;
case HFS_FILETREE_STARTUP:
offset = volHeader->startupFile.extents[0].startBlock * volHeader->blockSize;
minSize = 512;
break;
default:
cli_errmsg("hfsplus_readheader: %s: invalid headerType %d\n", name, headerType);
return CL_EARG;
}
mPtr = fmap_need_off_once(ctx->fmap, offset, volHeader->blockSize);
if (!mPtr) {
cli_dbgmsg("hfsplus_readheader: %s: headerNode is out-of-range\n", name);
return CL_EFORMAT;
}
/* Node descriptor first */
memcpy(nodeDesc, mPtr, sizeof(hfsNodeDescriptor));
nodedescriptor_to_host(nodeDesc);
nodedescriptor_print(name, nodeDesc);
if (nodeDesc->kind != HFS_NODEKIND_HEADER) {
cli_dbgmsg("hfsplus_readheader: %s: headerNode not header kind\n", name);
return CL_EFORMAT;
}
if ((nodeDesc->bLink != 0) || (nodeDesc->height != 0) || (nodeDesc->numRecords != 3)) {
cli_dbgmsg("hfsplus_readheader: %s: Invalid headerNode\n", name);
return CL_EFORMAT;
}
/* Then header record */
memcpy(headerRec, mPtr + sizeof(hfsNodeDescriptor), sizeof(hfsHeaderRecord));
headerrecord_to_host(headerRec);
headerrecord_print(name, headerRec);
if ((headerRec->nodeSize < minSize) || (headerRec->nodeSize > maxSize)) {
cli_dbgmsg("hfsplus_readheader: %s: Invalid nodesize\n", name);
return CL_EFORMAT;
}
if (headerRec->nodeSize & (headerRec->nodeSize - 1)) {
cli_dbgmsg("hfsplus_readheader: %s: Invalid nodesize\n", name);
return CL_EFORMAT;
}
/* KeyLength must be between 6 and 516 for catalog */
if (headerType == HFS_FILETREE_CATALOG) {
if ((headerRec->maxKeyLength < 6) || (headerRec->maxKeyLength > 516)) {
cli_dbgmsg("hfsplus_readheader: %s: Invalid cat maxKeyLength\n", name);
return CL_EFORMAT;
}
if (headerRec->maxKeyLength > (headerRec->nodeSize / 2)) {
cli_dbgmsg("hfsplus_readheader: %s: Invalid cat maxKeyLength based on nodeSize\n", name);
return CL_EFORMAT;
}
} else if (headerType == HFS_FILETREE_EXTENTS) {
if (headerRec->maxKeyLength != 10) {
cli_dbgmsg("hfsplus_readheader: %s: Invalid ext maxKeyLength\n", name);
return CL_EFORMAT;
}
}
/* hdr->treeDepth = rootnode->height */
return CL_CLEAN;
}
/**
* @brief Read and dump a file for scanning.
*
* If the filename pointer is provided, the file name will be set and the
* resulting file will __NOT__ be scanned. The returned pointer must be freed
* by the caller. If the pointer is NULL, the file will be scanned and,
* depending on the --leave-temps value, deleted or not.
*
* @param ctx The current scan context
* @param volHeader Volume header
* @param extHeader Extent overflow file header
* @param fork Fork Data
* @param dirname Temp directory name
* @param[out] filename (optional) temp file name
* @param orig_filename (optional) Original filename
* @return cl_error_t
*/
static cl_error_t hfsplus_scanfile(cli_ctx *ctx, hfsPlusVolumeHeader *volHeader, hfsHeaderRecord *extHeader,
hfsPlusForkData *fork, const char *dirname, char **filename, char *orig_filename)
{
cl_error_t status = CL_SUCCESS;
hfsPlusExtentDescriptor *currExt;
const uint8_t *mPtr = NULL;
char *tmpname = NULL;
int ofd = -1;
uint64_t targetSize;
uint32_t outputBlocks = 0;
uint8_t ext;
UNUSEDPARAM(extHeader);
/* bad record checks */
if (!fork || (fork->logicalSize == 0) || (fork->totalBlocks == 0)) {
cli_dbgmsg("hfsplus_scanfile: Empty file.\n");
goto done;
}
/* check limits */
targetSize = fork->logicalSize;
#if SIZEOF_LONG < 8
if (targetSize > ULONG_MAX) {
cli_dbgmsg("hfsplus_scanfile: File too large for limit check.\n");
status = CL_EFORMAT;
goto done;
}
#endif
status = cli_checklimits("hfsplus_scanfile", ctx, targetSize, 0, 0);
if (status != CL_SUCCESS) {
goto done;
}
/* open file */
status = cli_gentempfd(dirname, &tmpname, &ofd);
if (status != CL_SUCCESS) {
cli_dbgmsg("hfsplus_scanfile: Cannot generate temporary file.\n");
goto done;
}
cli_dbgmsg("hfsplus_scanfile: Extracting to %s\n", tmpname);
ext = 0;
/* Dump file, extent by extent */
do {
uint32_t currBlock, endBlock, outputSize = 0;
if (targetSize == 0) {
cli_dbgmsg("hfsplus_scanfile: output complete\n");
break;
}
if (outputBlocks >= fork->totalBlocks) {
cli_dbgmsg("hfsplus_scanfile: output all blocks, remaining size " STDu64 "\n", targetSize);
break;
}
/* Prepare extent */
if (ext < 8) {
currExt = &(fork->extents[ext]);
cli_dbgmsg("hfsplus_scanfile: extent %u\n", ext);
} else {
cli_dbgmsg("hfsplus_scanfile: need next extent from ExtentOverflow\n");
/* Not implemented yet */
status = CL_EFORMAT;
goto done;
}
/* have extent, so validate and get block range */
if ((currExt->startBlock == 0) || (currExt->blockCount == 0)) {
cli_dbgmsg("hfsplus_scanfile: next extent empty, done\n");
break;
}
if ((currExt->startBlock & 0x10000000) && (currExt->blockCount & 0x10000000)) {
cli_dbgmsg("hfsplus_scanfile: next extent illegal!\n");
status = CL_EFORMAT;
goto done;
}
currBlock = currExt->startBlock;
endBlock = currExt->startBlock + currExt->blockCount - 1;
if ((currBlock > volHeader->totalBlocks) || (endBlock > volHeader->totalBlocks) || (currExt->blockCount > volHeader->totalBlocks)) {
cli_dbgmsg("hfsplus_scanfile: bad extent!\n");
status = CL_EFORMAT;
goto done;
}
/* Write the blocks, walking the map */
while (currBlock <= endBlock) {
size_t to_write = MIN(targetSize, volHeader->blockSize);
size_t written;
off_t offset = currBlock * volHeader->blockSize;
/* move map to next block */
mPtr = fmap_need_off_once(ctx->fmap, offset, volHeader->blockSize);
if (!mPtr) {
cli_errmsg("hfsplus_scanfile: map error\n");
status = CL_EMAP;
goto done;
}
written = cli_writen(ofd, mPtr, to_write);
if (written != to_write) {
cli_errmsg("hfsplus_scanfile: write error\n");
status = CL_EWRITE;
goto done;
}
targetSize -= to_write;
outputSize += to_write;
currBlock++;
if (targetSize == 0) {
cli_dbgmsg("hfsplus_scanfile: all data written\n");
break;
}
if (outputBlocks >= fork->totalBlocks) {
cli_dbgmsg("hfsplus_scanfile: output all blocks, remaining size " STDu64 "\n", targetSize);
break;
}
}
/* Finished the extent, move to next */
ext++;
} while (status == CL_SUCCESS);
/* Now that we're done, ...
* A) if filename output param is provided, just pass back the filename.
* B) otherwise scan the file.
*/
if (filename) {
*filename = tmpname;
} else {
status = cli_magic_scan_desc(ofd, tmpname, ctx, orig_filename, LAYER_ATTRIBUTES_NONE);
if (status != CL_SUCCESS) {
goto done;
}
/* TODO: Scan overlay if outputBlocks >= fork->totalBlocks ? */
}
done:
if (ofd >= 0) {
close(ofd);
}
if ((NULL == filename) || // output param not provided, which means we should clean up the temp file,
(status != CL_SUCCESS)) { // or we failed, so we should clean up the temp file.
if (tmpname) {
if (!ctx->engine->keeptmp) {
(void)cli_unlink(tmpname);
}
free(tmpname);
}
}
return status;
}
/* Calculate true node limit for catalogFile */
static cl_error_t hfsplus_validate_catalog(cli_ctx *ctx, hfsPlusVolumeHeader *volHeader, hfsHeaderRecord *catHeader)
{
hfsPlusForkData *catFork;
UNUSEDPARAM(ctx);
catFork = &(volHeader->catalogFile);
if (catFork->totalBlocks >= volHeader->totalBlocks) {
cli_dbgmsg("hfsplus_validate_catalog: catFork totalBlocks too large!\n");
return CL_EFORMAT;
}
if (catFork->logicalSize > (catFork->totalBlocks * volHeader->blockSize)) {
cli_dbgmsg("hfsplus_validate_catalog: catFork logicalSize too large!\n");
return CL_EFORMAT;
}
if (catFork->logicalSize < (catHeader->totalNodes * catHeader->nodeSize)) {
cli_dbgmsg("hfsplus_validate_catalog: too many nodes for catFile\n");
return CL_EFORMAT;
}
return CL_CLEAN;
}
/* Check if an attribute is present in the attribute map */
static cl_error_t hfsplus_check_attribute(cli_ctx *ctx, hfsPlusVolumeHeader *volHeader, hfsHeaderRecord *attrHeader, uint32_t expectedCnid, const uint8_t name[], uint32_t nameLen, int *found, uint8_t record[], size_t *recordSize)
{
cl_error_t status = CL_SUCCESS;
uint16_t nodeSize, recordNum, topOfOffsets;
uint16_t recordStart, nextDist, nextStart;
uint8_t *nodeBuf = NULL;
uint32_t thisNode, nodeLimit, nodesScanned = 0;
bool foundAttr = false;
if (found) {
*found = 0;
}
if (!attrHeader) {
return CL_EARG;
}
nodeLimit = MIN(attrHeader->totalNodes, HFSPLUS_NODE_LIMIT);
thisNode = attrHeader->firstLeafNode;
nodeSize = attrHeader->nodeSize;
/* Need to buffer current node, map will keep moving */
nodeBuf = cli_max_malloc(nodeSize);
if (!nodeBuf) {
cli_dbgmsg("hfsplus_check_attribute: failed to acquire node buffer, "
"size " STDu32 "\n",
nodeSize);
status = CL_EMEM;
goto done;
}
/* Walk catalog leaf nodes, and scan contents of each */
/* Because we want to scan them all, the index nodes add no value */
while (status == CL_SUCCESS && !foundAttr) {
hfsNodeDescriptor nodeDesc;
if (thisNode == 0) {
cli_dbgmsg("hfsplus_check_attribute: reached end of leaf nodes.\n");
break;
}
if (nodesScanned++ > nodeLimit) {
cli_dbgmsg("hfsplus_check_attribute: node scan limit reached.\n");
break;
}
/* fetch node into buffer */
status = hfsplus_fetch_node(ctx, volHeader, attrHeader, NULL, &(volHeader->attributesFile), thisNode, nodeBuf, nodeSize);
if (status != CL_SUCCESS) {
cli_dbgmsg("hfsplus_check_attribute: node fetch failed.\n");
goto done;
}
memcpy(&nodeDesc, nodeBuf, 14);
/* convert and validate node */
nodedescriptor_to_host(&nodeDesc);
nodedescriptor_print("leaf attribute node", &nodeDesc);
if ((nodeDesc.kind != HFS_NODEKIND_LEAF) || (nodeDesc.height != 1)) {
cli_dbgmsg("hfsplus_check_attribute: invalid leaf node!\n");
status = CL_EFORMAT;
goto done;
}
if ((nodeSize / 4) < nodeDesc.numRecords) {
cli_dbgmsg("hfsplus_check_attribute: too many leaf records for one node!\n");
status = CL_EFORMAT;
goto done;
}
/* Walk this node's records and scan */
recordStart = 14; /* 1st record can be after end of node descriptor */
/* offsets take 1 u16 per at the end of the node, along with an empty space offset */
topOfOffsets = nodeSize - (nodeDesc.numRecords * 2) - 2;
for (recordNum = 0; recordNum < nodeDesc.numRecords; recordNum++) {
uint16_t keylen;
hfsPlusAttributeKey attrKey;
hfsPlusAttributeRecord attrRec;
/* Locate next record */
nextDist = nodeSize - (recordNum * 2) - 2;
nextStart = nodeBuf[nextDist] * 0x100 + nodeBuf[nextDist + 1];
/* Check record location */
if ((nextStart > topOfOffsets - 1) || (nextStart < recordStart)) {
cli_dbgmsg("hfsplus_check_attribute: bad record location %x for %u!\n", nextStart, recordNum);
status = CL_EFORMAT;
goto done;
}
recordStart = nextStart;
if (recordStart + sizeof(attrKey) >= topOfOffsets) {
cli_dbgmsg("hfsplus_check_attribute: Not enough data for an attribute key at location %x for %u!\n",
nextStart, recordNum);
status = CL_EFORMAT;
goto done;
}
memcpy(&attrKey, &nodeBuf[recordStart], sizeof(attrKey));
attrKey.keyLength = be16_to_host(attrKey.keyLength);
attrKey.cnid = be32_to_host(attrKey.cnid);
attrKey.startBlock = be32_to_host(attrKey.startBlock);
attrKey.nameLength = be16_to_host(attrKey.nameLength);
/* Get record key length */
keylen = nodeBuf[recordStart] * 0x100 + nodeBuf[recordStart + 1];
keylen += keylen % 2; /* pad 1 byte if required to make 2-byte align */
/* Validate keylen */
if (recordStart + attrKey.keyLength + 4 >= topOfOffsets) {
cli_dbgmsg("hfsplus_check_attribute: key too long for location %x for %u!\n",
nextStart, recordNum);
status = CL_EFORMAT;
goto done;
}
if (recordStart + sizeof(hfsPlusAttributeKey) + attrKey.nameLength >= topOfOffsets) {
cli_dbgmsg("hfsplus_check_attribute: Attribute name is longer than expected: %u\n", attrKey.nameLength);
status = CL_EFORMAT;
goto done;
}
if (attrKey.cnid == expectedCnid && attrKey.nameLength * 2 == nameLen && memcmp(&nodeBuf[recordStart + 14], name, nameLen) == 0) {
memcpy(&attrRec, &(nodeBuf[recordStart + sizeof(hfsPlusAttributeKey) + attrKey.nameLength * 2]), sizeof(attrRec));
attrRec.recordType = be32_to_host(attrRec.recordType);
attrRec.attributeSize = be32_to_host(attrRec.attributeSize);
if (attrRec.recordType != HFSPLUS_RECTYPE_INLINE_DATA_ATTRIBUTE) {
cli_dbgmsg("hfsplus_check_attribute: Unexpected attribute record type 0x%x\n", attrRec.recordType);
continue;
}
if (attrRec.attributeSize > *recordSize) {
status = CL_EFORMAT;
goto done;
}
memcpy(record, &(nodeBuf[recordStart + sizeof(hfsPlusAttributeKey) + attrKey.nameLength * 2 + sizeof(attrRec)]), attrRec.attributeSize);
*recordSize = attrRec.attributeSize;
if (found) {
*found = 1;
}
foundAttr = true;
break;
}
}
}
done:
if (nodeBuf != NULL) {
free(nodeBuf);
nodeBuf = NULL;
}
return status;
}
/* Fetch a node's contents into the buffer */
static cl_error_t hfsplus_fetch_node(cli_ctx *ctx, hfsPlusVolumeHeader *volHeader, hfsHeaderRecord *catHeader,
hfsHeaderRecord *extHeader, hfsPlusForkData *catFork, uint32_t node, uint8_t *buff,
size_t buffSize)
{
bool foundBlock = false;
uint64_t catalogOffset;
uint32_t startBlock, startOffset;
uint32_t endBlock, endSize;
uint32_t curBlock;
uint32_t extentNum = 0, realFileBlock;
uint32_t readSize;
size_t fileOffset = 0;
uint32_t searchBlock;
uint32_t buffOffset = 0;
UNUSEDPARAM(extHeader);
/* Make sure node is in range */
if (node >= catHeader->totalNodes) {
cli_dbgmsg("hfsplus_fetch_node: invalid node number " STDu32 "\n", node);
return CL_EFORMAT;
}
/* Need one block */
/* First, calculate the node's offset within the catalog */
catalogOffset = (uint64_t)node * catHeader->nodeSize;
/* Determine which block of the catalog we need */
startBlock = (uint32_t)(catalogOffset / volHeader->blockSize);
startOffset = (uint32_t)(catalogOffset % volHeader->blockSize);
endBlock = (uint32_t)((catalogOffset + catHeader->nodeSize - 1) / volHeader->blockSize);
endSize = (uint32_t)(((catalogOffset + catHeader->nodeSize - 1) % volHeader->blockSize) + 1);
cli_dbgmsg("hfsplus_fetch_node: need catalog block " STDu32 "\n", startBlock);
if (startBlock >= catFork->totalBlocks || endBlock >= catFork->totalBlocks) {
cli_dbgmsg("hfsplus_fetch_node: block number invalid!\n");
return CL_EFORMAT;
}
for (curBlock = startBlock; curBlock <= endBlock; ++curBlock) {
foundBlock = false;
searchBlock = curBlock;
/* Find which extent has that block */
for (extentNum = 0; extentNum < 8; extentNum++) {
hfsPlusExtentDescriptor *currExt = &(catFork->extents[extentNum]);
/* Beware empty extent */
if ((currExt->startBlock == 0) || (currExt->blockCount == 0)) {
cli_dbgmsg("hfsplus_fetch_node: extent " STDu32 " empty!\n", extentNum);
return CL_EFORMAT;
}
/* Beware too long extent */
if ((currExt->startBlock & 0x10000000) && (currExt->blockCount & 0x10000000)) {
cli_dbgmsg("hfsplus_fetch_node: extent " STDu32 " illegal!\n", extentNum);
return CL_EFORMAT;
}
/* Check if block found in current extent */
if (searchBlock < currExt->blockCount) {
cli_dbgmsg("hfsplus_fetch_node: found block in extent " STDu32 "\n", extentNum);
realFileBlock = currExt->startBlock + searchBlock;
foundBlock = true;
break;
} else {
cli_dbgmsg("hfsplus_fetch_node: not in extent " STDu32 "\n", extentNum);
searchBlock -= currExt->blockCount;
}
}
if (foundBlock == false) {
cli_dbgmsg("hfsplus_fetch_node: not in first 8 extents\n");
cli_dbgmsg("hfsplus_fetch_node: finding this node requires extent overflow support\n");
return CL_EFORMAT;
}
/* Block found */
if (realFileBlock >= volHeader->totalBlocks) {
cli_dbgmsg("hfsplus_fetch_node: block past end of volume\n");
return CL_EFORMAT;
}
fileOffset = realFileBlock * volHeader->blockSize;
readSize = volHeader->blockSize;
if (curBlock == startBlock) {
fileOffset += startOffset;
} else if (curBlock == endBlock) {
readSize = endSize;
}
if ((buffOffset + readSize) > buffSize) {
cli_dbgmsg("hfsplus_fetch_node: Not enough space for read\n");
return CL_EFORMAT;
}
if (fmap_readn(ctx->fmap, buff + buffOffset, fileOffset, readSize) != readSize) {
cli_dbgmsg("hfsplus_fetch_node: not all bytes read\n");
return CL_EFORMAT;
}
buffOffset += readSize;
}
return CL_CLEAN;
}
static cl_error_t hfsplus_seek_to_cmpf_resource(int fd, size_t *size)
{
cl_error_t status = CL_SUCCESS;
hfsPlusResourceHeader resourceHeader;
hfsPlusResourceMap resourceMap;
hfsPlusResourceType resourceType;
hfsPlusReferenceEntry entry;
int i;
int cmpfInstanceIdx = -1;
int curInstanceIdx = 0;
size_t dataOffset;
uint32_t dataLength;
if (!size) {
status = CL_ENULLARG;
goto done;
}
if (cli_readn(fd, &resourceHeader, sizeof(resourceHeader)) != sizeof(resourceHeader)) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to read resource header from temporary file\n");
status = CL_EREAD;
goto done;
}
resourceHeader.dataOffset = be32_to_host(resourceHeader.dataOffset);
resourceHeader.mapOffset = be32_to_host(resourceHeader.mapOffset);
resourceHeader.dataLength = be32_to_host(resourceHeader.dataLength);
resourceHeader.mapLength = be32_to_host(resourceHeader.mapLength);
// TODO: Need to get offset of cmpf resource in data stream
if (lseek(fd, resourceHeader.mapOffset, SEEK_SET) != resourceHeader.mapOffset) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to seek to map in temporary file\n");
status = CL_ESEEK;
goto done;
}
if (cli_readn(fd, &resourceMap, sizeof(resourceMap)) != sizeof(resourceMap)) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to read resource map from temporary file\n");
status = CL_EREAD;
goto done;
}
resourceMap.resourceForkAttributes = be16_to_host(resourceMap.resourceForkAttributes);
resourceMap.typeListOffset = be16_to_host(resourceMap.typeListOffset);
resourceMap.nameListOffset = be16_to_host(resourceMap.nameListOffset);
resourceMap.typeCount = be16_to_host(resourceMap.typeCount);
for (i = 0; i < resourceMap.typeCount + 1; ++i) {
if (cli_readn(fd, &resourceType, sizeof(resourceType)) != sizeof(resourceType)) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to read resource type from temporary file\n");
status = CL_EREAD;
goto done;
}
resourceType.instanceCount = be16_to_host(resourceType.instanceCount);
resourceType.referenceListOffset = be16_to_host(resourceType.referenceListOffset);
if (memcmp(resourceType.type, "cmpf", 4) == 0) {
if (cmpfInstanceIdx != -1) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: There are several cmpf resource types in the file\n");
status = CL_EFORMAT;
goto done;
}
cmpfInstanceIdx = curInstanceIdx;
cli_dbgmsg("Found compressed resource type!\n");
}
curInstanceIdx += resourceType.instanceCount + 1;
}
if (cmpfInstanceIdx < 0) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Didn't find cmpf resource type\n");
status = CL_EFORMAT;
goto done;
}
if (lseek(fd, cmpfInstanceIdx * sizeof(hfsPlusReferenceEntry), SEEK_CUR) < 0) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to seek to instance index\n");
status = CL_ESEEK;
goto done;
}
if (cli_readn(fd, &entry, sizeof(entry)) != sizeof(entry)) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to read resource entry from temporary file\n");
status = CL_EREAD;
goto done;
}
dataOffset = (entry.resourceDataOffset[0] << 16) | (entry.resourceDataOffset[1] << 8) | entry.resourceDataOffset[2];
if (lseek(fd, resourceHeader.dataOffset + dataOffset, SEEK_SET) < 0) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to seek to data offset\n");
status = CL_ESEEK;
goto done;
}
if (cli_readn(fd, &dataLength, sizeof(dataLength)) != sizeof(dataLength)) {
cli_dbgmsg("hfsplus_seek_to_cmpf_resource: Failed to read data length from temporary file\n");
status = CL_EREAD;
goto done;
}
*size = be32_to_host(dataLength);
done:
return status;
}
/**
* @brief Read the table from the provided file.
*
* The caller is responsible for freeing the table.
*
* @param fd File descriptor of the file to read from.
* @param [out] numBlocks Number of blocks in the table, as determined from reading the file.
* @param [out] table Will be allocated and populated with table data.
* @return cl_error_t CL_SUCCESS on success, CL_E* on failure.
*/
static cl_error_t hfsplus_read_block_table(int fd, uint32_t *numBlocks, hfsPlusResourceBlockTable **table)
{
cl_error_t status = CL_SUCCESS;
uint32_t i;
if (!table || !numBlocks) {
status = CL_ENULLARG;
goto done;
}
if (cli_readn(fd, numBlocks, sizeof(*numBlocks)) != sizeof(*numBlocks)) {
cli_dbgmsg("hfsplus_read_block_table: Failed to read block count\n");
status = CL_EREAD;
goto done;
}
*numBlocks = le32_to_host(*numBlocks); // Let's do a little little endian just for fun, shall we?
*table = cli_max_malloc(sizeof(hfsPlusResourceBlockTable) * *numBlocks);
if (!*table) {
cli_dbgmsg("hfsplus_read_block_table: Failed to allocate memory for block table\n");
status = CL_EMEM;
goto done;
}
if (cli_readn(fd, *table, *numBlocks * sizeof(hfsPlusResourceBlockTable)) != *numBlocks * sizeof(hfsPlusResourceBlockTable)) {
cli_dbgmsg("hfsplus_read_block_table: Failed to read table\n");
status = CL_EREAD;
goto done;
}
for (i = 0; i < *numBlocks; ++i) {
(*table)[i].offset = le32_to_host((*table)[i].offset);
(*table)[i].length = le32_to_host((*table)[i].length);
}
done:
if (CL_SUCCESS != status) {
if (NULL != table) {
free(*table);
*table = NULL;
}
}
return status;
}
/* Given the catalog and other details, scan all the volume contents */
static cl_error_t hfsplus_walk_catalog(cli_ctx *ctx, hfsPlusVolumeHeader *volHeader, hfsHeaderRecord *catHeader,
hfsHeaderRecord *extHeader, hfsHeaderRecord *attrHeader, const char *dirname)
{
cl_error_t status = CL_SUCCESS;
uint32_t thisNode, nodeLimit, nodesScanned = 0;
uint16_t nodeSize, recordNum, topOfOffsets;
uint16_t recordStart, nextDist, nextStart;
uint8_t *nodeBuf = NULL;
const uint8_t COMPRESSED_ATTR[] = {0, 'c', 0, 'o', 0, 'm', 0, '.', 0, 'a', 0, 'p', 0, 'p', 0, 'l', 0, 'e', 0, '.', 0, 'd', 0, 'e', 0, 'c', 0, 'm', 0, 'p', 0, 'f', 0, 's'};
char *tmpname = NULL;
uint8_t *uncompressed = NULL;
char *resourceFile = NULL;
int ifd = -1;
int ofd = -1;
char *name_utf8 = NULL;
size_t name_utf8_size = 0;
bool extracted_file = false;
hfsPlusResourceBlockTable *table = NULL;
nodeLimit = MIN(catHeader->totalNodes, HFSPLUS_NODE_LIMIT);
thisNode = catHeader->firstLeafNode;
nodeSize = catHeader->nodeSize;
/* Need to buffer current node, map will keep moving */
nodeBuf = cli_max_malloc(nodeSize);
if (!nodeBuf) {
cli_dbgmsg("hfsplus_walk_catalog: failed to acquire node buffer, "
"size " STDu32 "\n",
nodeSize);
return CL_EMEM;
}
/* Walk catalog leaf nodes, and scan contents of each */
/* Because we want to scan them all, the index nodes add no value */
while (status == CL_SUCCESS) {
hfsNodeDescriptor nodeDesc;
if (thisNode == 0) {
cli_dbgmsg("hfsplus_walk_catalog: reached end of leaf nodes.\n");
goto done;
}
if (nodesScanned++ > nodeLimit) {
cli_dbgmsg("hfsplus_walk_catalog: node scan limit reached.\n");
goto done;
}
/* fetch node into buffer */
status = hfsplus_fetch_node(ctx, volHeader, catHeader, extHeader, &(volHeader->catalogFile), thisNode, nodeBuf, nodeSize);
if (status != CL_SUCCESS) {
cli_dbgmsg("hfsplus_walk_catalog: node fetch failed.\n");
goto done;
}
memcpy(&nodeDesc, nodeBuf, 14);
/* convert and validate node */
nodedescriptor_to_host(&nodeDesc);
nodedescriptor_print("leaf node", &nodeDesc);
if ((nodeDesc.kind != HFS_NODEKIND_LEAF) || (nodeDesc.height != 1)) {
cli_dbgmsg("hfsplus_walk_catalog: invalid leaf node!\n");
status = CL_EFORMAT;
goto done;
}
if ((nodeSize / 4) < nodeDesc.numRecords) {
cli_dbgmsg("hfsplus_walk_catalog: too many leaf records for one node!\n");
status = CL_EFORMAT;
goto done;
}
/* Walk this node's records and scan */
recordStart = 14; /* 1st record can be after end of node descriptor */
/* offsets take 1 u16 per at the end of the node, along with an empty space offset */
topOfOffsets = nodeSize - (nodeDesc.numRecords * 2) - 2;
for (recordNum = 0; recordNum < nodeDesc.numRecords; recordNum++) {
uint16_t keylen;