-
Notifications
You must be signed in to change notification settings - Fork 342
Expand file tree
/
Copy pathArchiveReaderTests.swift
More file actions
774 lines (593 loc) · 33.9 KB
/
Copy pathArchiveReaderTests.swift
File metadata and controls
774 lines (593 loc) · 33.9 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
//===----------------------------------------------------------------------===//
// Copyright © 2026 Apple Inc. and the Containerization project authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//
import Foundation
import SystemPackage
import Testing
@testable import ContainerizationArchive
struct ArchiveReaderTests {
// MARK: - Helper Methods
func createTestArchive(name: String, entries: [(path: String, type: EntryType, target: String?)]) throws -> URL {
let testDirectory = createTemporaryDirectory(baseName: "ArchiveReaderTests")!
let archiveURL = testDirectory.appendingPathComponent("\(name).tar")
let archiver = try ArchiveWriter(format: .paxRestricted, filter: .none, file: archiveURL)
for entry in entries {
let writeEntry = WriteEntry()
writeEntry.path = entry.path
writeEntry.permissions = 0o644
writeEntry.owner = 1000
writeEntry.group = 1000
switch entry.type {
case .regular(let content):
writeEntry.fileType = .regular
let data = content.data(using: .utf8)!
writeEntry.size = numericCast(data.count)
try archiver.writeEntry(entry: writeEntry, data: data)
case .directory:
writeEntry.fileType = .directory
writeEntry.permissions = 0o755
writeEntry.size = 0
try archiver.writeEntry(entry: writeEntry, data: nil)
case .symlink:
guard let target = entry.target else {
throw ArchiveError.failedToExtractArchive("symlink requires target")
}
writeEntry.fileType = .symbolicLink
writeEntry.symlinkTarget = target
writeEntry.size = 0
try archiver.writeEntry(entry: writeEntry, data: nil)
}
}
try archiver.finishEncoding()
return archiveURL
}
func createExtractionDirectory(name: String) throws -> URL {
let testDirectory = createTemporaryDirectory(baseName: "ArchiveReaderTests.\(name)")!
return testDirectory.appendingPathComponent("extract")
}
enum EntryType {
case regular(String) // Content
case directory
case symlink
}
// MARK: - Benign Archive Tests
@Test func extractBenignArchive() throws {
let archiveURL = try createTestArchive(
name: "benign",
entries: [
("dir/", .directory, nil),
("dir/file.txt", .regular("test content"), nil),
("dir/subdir/", .directory, nil),
("dir/subdir/file2.txt", .regular("more content"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "benign")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty, "Benign archive should not reject any entries")
// Verify files were extracted
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("dir/file.txt").path))
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("dir/subdir/file2.txt").path))
// Verify content
let content1 = try String(contentsOf: extractDir.appendingPathComponent("dir/file.txt"), encoding: .utf8)
#expect(content1 == "test content")
let content2 = try String(contentsOf: extractDir.appendingPathComponent("dir/subdir/file2.txt"), encoding: .utf8)
#expect(content2 == "more content")
}
@Test func extractRootLevelFile() throws {
let archiveURL = try createTestArchive(
name: "root-level",
entries: [
("file.txt", .regular("root file"), nil)
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "root-level")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty)
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("file.txt").path))
let content = try String(contentsOf: extractDir.appendingPathComponent("file.txt"), encoding: .utf8)
#expect(content == "root file")
}
// MARK: - Absolute Path Tests
@Test func convertAbsolutePathToRelative() throws {
let filename1: String = "/tmp/\(UUID())"
let filename2: String = "//tmp//\(UUID())"
let archiveURL = try createTestArchive(
name: "benign-absolute",
entries: [
("/tmp/\(filename1)", .regular("hello"), nil),
("//tmp//\(filename2)", .regular("world"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "benign-absolute")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Absolute paths should be rejected
#expect(
rejectedPaths.isEmpty,
"Expected absolute paths allowed, but got rejected paths \(rejectedPaths)")
// Verify nothing was extracted to /tmp or /etc
#expect(!FileManager.default.fileExists(atPath: filename1))
#expect(!FileManager.default.fileExists(atPath: filename2))
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("tmp/\(filename1)").path))
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("tmp/\(filename2)").path))
}
// MARK: - Path Traversal Attack Tests
@Test func rejectPathTraversal() throws {
let archiveURL = try createTestArchive(
name: "evil-traversal",
entries: [
("../etc/pwned", .regular("evil"), nil),
("foo/../../etc/pwned", .regular("evil"), nil),
("dir/../../../etc/pwned", .regular("evil"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "evil-traversal")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Path traversal entries should be rejected
#expect(
Set(rejectedPaths) == Set(["../etc/pwned", "foo/../../etc/pwned", "dir/../../../etc/pwned"]),
"Expected path traversal entries to be rejected, got \(rejectedPaths)")
// Verify nothing escaped
let parentDir = extractDir.deletingLastPathComponent()
#expect(!FileManager.default.fileExists(atPath: parentDir.appendingPathComponent("etc/pwned").path))
}
@Test func rejectPathTraversalWithValidEntries() throws {
let archiveURL = try createTestArchive(
name: "mixed-traversal",
entries: [
("safe.txt", .regular("safe content"), nil),
("dir/", .directory, nil),
("dir/file.txt", .regular("also safe"), nil),
("../etc/pwned", .regular("evil"), nil),
("more/safe.txt", .regular("still safe"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "mixed-traversal")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Only the path traversal entry should be rejected
#expect(
rejectedPaths == ["../etc/pwned"],
"Expected only path traversal entry to be rejected, got \(rejectedPaths)")
// Valid entries should have been extracted
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("safe.txt").path))
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("dir/file.txt").path))
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("more/safe.txt").path))
// Verify nothing escaped
let parentDir = extractDir.deletingLastPathComponent()
#expect(!FileManager.default.fileExists(atPath: parentDir.appendingPathComponent("etc/pwned").path))
}
@Test func rejectDotDotInMiddle() throws {
let archiveURL = try createTestArchive(
name: "evil-dotdot-middle",
entries: [
("safe/../pwned.txt", .regular("evil"), nil)
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "evil-dotdot-middle")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths == ["safe/../pwned.txt"])
#expect(!FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("pwned.txt").path))
}
// MARK: - Symlink Attack Tests
@Test func allowValidSymlink() throws {
let archiveURL = try createTestArchive(
name: "safe-symlink",
entries: [
("dir/", .directory, nil),
("dir/target.txt", .regular("target content"), nil),
("dir/link", .symlink, "target.txt"),
("link2", .symlink, "dir/target.txt"),
("dir/passwd", .symlink, "/etc/passwd"),
("dir2/passwd", .symlink, "../../../../etc/passwd"),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "safe-symlink")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty, "Valid symlinks should be allowed")
// Verify symlinks were created
let linkPath = extractDir.appendingPathComponent("dir/link").path
#expect(FileManager.default.fileExists(atPath: linkPath))
let link2Path = extractDir.appendingPathComponent("link2").path
#expect(FileManager.default.fileExists(atPath: link2Path))
// Verify symlinks point to correct targets
let linkTarget = try FileManager.default.destinationOfSymbolicLink(atPath: linkPath)
#expect(linkTarget == "target.txt")
let link2Target = try FileManager.default.destinationOfSymbolicLink(atPath: link2Path)
#expect(link2Target == "dir/target.txt")
}
@Test func allowSymlinkWithDotDot() throws {
let archiveURL = try createTestArchive(
name: "safe-symlink-dotdot",
entries: [
("dir/", .directory, nil),
("dir/subdir/", .directory, nil),
("target.txt", .regular("target"), nil),
("dir/subdir/link", .symlink, "../../target.txt"),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "safe-symlink-dotdot")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty, "Symlink with .. that stays in root should be allowed")
let linkPath = extractDir.appendingPathComponent("dir/subdir/link").path
#expect(FileManager.default.fileExists(atPath: linkPath))
let linkTarget = try FileManager.default.destinationOfSymbolicLink(atPath: linkPath)
#expect(linkTarget == "../../target.txt")
}
// MARK: - Deep Nesting Tests
@Test func extractDeepNesting() throws {
var entries: [(String, EntryType, String?)] = []
// Create 50 levels deep
var path = ""
for i in 0..<50 {
if i > 0 { path += "/" }
path += "level\(i)"
entries.append((path + "/", .directory, nil))
}
entries.append((path + "/deep.txt", .regular("deep file"), nil))
let archiveURL = try createTestArchive(name: "deep-nesting", entries: entries)
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "deep-nesting")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty)
// Verify deep file exists
let deepFilePath = extractDir.appendingPathComponent(path + "/deep.txt").path
#expect(FileManager.default.fileExists(atPath: deepFilePath))
let content = try String(contentsOfFile: deepFilePath, encoding: .utf8)
#expect(content == "deep file")
}
// MARK: - Normalization Tests
@Test func handleDotSlashPrefix() throws {
let archiveURL = try createTestArchive(
name: "dot-slash",
entries: [
("./safe.txt", .regular("content"), nil),
("./dir/", .directory, nil),
("./dir/file.txt", .regular("more content"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "dot-slash")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty, "./ prefix should be normalized and allowed")
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("safe.txt").path))
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("dir/file.txt").path))
}
@Test func handleDoubleSlashes() throws {
let archiveURL = try createTestArchive(
name: "double-slash",
entries: [
("dir//subdir/", .directory, nil),
("dir//subdir//file.txt", .regular("content"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "double-slash")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty, "Double slashes should be normalized")
// Verify file exists at normalized path
let normalizedPath = "dir/subdir/file.txt"
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent(normalizedPath).path))
}
// MARK: - File Permissions Tests
@Test func preserveFilePermissions() throws {
let archiveURL = try createTestArchive(
name: "permissions",
entries: [
("executable.sh", .regular("#!/bin/bash\necho test"), nil)
])
// Manually set executable permissions
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
for (entry, _) in reader {
if entry.path == "executable.sh" {
entry.permissions = 0o755
}
}
// Re-create archive with proper permissions
let testDirectory = createTemporaryDirectory(baseName: "ArchiveReaderTests")!
let archiveURL2 = testDirectory.appendingPathComponent("permissions2.tar")
let archiver = try ArchiveWriter(format: .paxRestricted, filter: .none, file: archiveURL2)
let writeEntry = WriteEntry()
writeEntry.path = "executable.sh"
writeEntry.fileType = .regular
writeEntry.permissions = 0o755
let data = "#!/bin/bash\necho test".data(using: .utf8)!
writeEntry.size = numericCast(data.count)
try archiver.writeEntry(entry: writeEntry, data: data)
try archiver.finishEncoding()
defer { try? FileManager.default.removeItem(at: testDirectory) }
let extractDir = try createExtractionDirectory(name: "permissions")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader2 = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL2)
let rejectedPaths = try reader2.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty)
// Verify permissions were preserved
let filePath = extractDir.appendingPathComponent("executable.sh").path
let attrs = try FileManager.default.attributesOfItem(atPath: filePath)
let perms = (attrs[.posixPermissions] as? NSNumber)?.uint16Value ?? 0
let permMask: UInt16 = 0o777
#expect((perms & permMask) == 0o755, "Permissions should be preserved")
}
// MARK: - Duplicate Entry Tests
@Test func duplicateRegularFiles() throws {
let archiveURL = try createTestArchive(
name: "duplicate-regular",
entries: [
("file.txt", .regular("first content"), nil),
("file.txt", .regular("second content"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "duplicate-regular")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Last entry wins - second file should replace first
#expect(rejectedPaths.isEmpty, "Duplicate files follow last-entry-wins")
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("file.txt").path))
let content = try String(contentsOf: extractDir.appendingPathComponent("file.txt"), encoding: .utf8)
#expect(content == "second content", "Last entry should win")
}
@Test func duplicateDirectories() throws {
let archiveURL = try createTestArchive(
name: "duplicate-dirs",
entries: [
("dir/", .directory, nil),
("dir/", .directory, nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "duplicate-dirs")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Both directories should be accepted (merged)
#expect(rejectedPaths.isEmpty, "Duplicate directories should be merged")
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("dir").path))
}
@Test func regularFileToDirectory() throws {
let archiveURL = try createTestArchive(
name: "file-to-dir",
entries: [
("path", .regular("content"), nil),
("path/", .directory, nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "file-to-dir")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Directory should replace the file
#expect(rejectedPaths.isEmpty, "Directory should replace regular file")
let attrs = try FileManager.default.attributesOfItem(atPath: extractDir.appendingPathComponent("path").path)
let fileType = attrs[.type] as? FileAttributeType
#expect(fileType == .typeDirectory, "Path should be a directory")
}
@Test func directoryToRegularFile() throws {
let archiveURL = try createTestArchive(
name: "dir-to-file",
entries: [
("path/", .directory, nil),
("path", .regular("content"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "dir-to-file")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Last entry wins - file should replace directory
#expect(rejectedPaths.isEmpty, "Regular file should replace directory")
// Should now be a regular file
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("path").path))
let content = try String(contentsOf: extractDir.appendingPathComponent("path"), encoding: .utf8)
#expect(content == "content", "Should have file content")
}
@Test func regularFileToSymlink() throws {
let archiveURL = try createTestArchive(
name: "file-to-symlink",
entries: [
("target.txt", .regular("target"), nil),
("path", .regular("content"), nil),
("path", .symlink, "target.txt"),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "file-to-symlink")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Last entry wins - symlink should replace file
#expect(rejectedPaths.isEmpty, "Symlink should replace regular file")
// Should now be a symlink
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("path").path))
let linkTarget = try FileManager.default.destinationOfSymbolicLink(atPath: extractDir.appendingPathComponent("path").path)
#expect(linkTarget == "target.txt")
}
@Test func symlinkToRegularFile() throws {
let archiveURL = try createTestArchive(
name: "symlink-to-file",
entries: [
("target.txt", .regular("target"), nil),
("path", .symlink, "target.txt"),
("path", .regular("new content"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "symlink-to-file")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Last entry wins - file should replace symlink
#expect(rejectedPaths.isEmpty, "Regular file should replace symlink")
// Should now be a regular file
#expect(FileManager.default.fileExists(atPath: extractDir.appendingPathComponent("path").path))
let content = try String(contentsOf: extractDir.appendingPathComponent("path"), encoding: .utf8)
#expect(content == "new content")
}
@Test func symlinkToDirectory() throws {
let archiveURL = try createTestArchive(
name: "symlink-to-dir",
entries: [
("target/", .directory, nil),
("path", .symlink, "target"),
("path/", .directory, nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "symlink-to-dir")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Directory should replace symlink
#expect(rejectedPaths.isEmpty, "Directory should replace symlink")
// Path should now be a directory
let attrs = try FileManager.default.attributesOfItem(atPath: extractDir.appendingPathComponent("path").path)
let fileType = attrs[.type] as? FileAttributeType
#expect(fileType == .typeDirectory, "Path should be a directory")
}
@Test func duplicateSymlinks() throws {
let archiveURL = try createTestArchive(
name: "duplicate-symlinks",
entries: [
("target1.txt", .regular("target1"), nil),
("target2.txt", .regular("target2"), nil),
("link", .symlink, "target1.txt"),
("link", .symlink, "target2.txt"),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "duplicate-symlinks")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
// Last entry wins - second symlink should replace first
#expect(rejectedPaths.isEmpty, "Second symlink should replace first")
let linkTarget = try FileManager.default.destinationOfSymbolicLink(atPath: extractDir.appendingPathComponent("link").path)
#expect(linkTarget == "target2.txt", "Last symlink should win")
}
// MARK: - Empty Archive Tests
@Test func rejectEmptyArchive() throws {
let testDirectory = createTemporaryDirectory(baseName: "ArchiveReaderTests")!
let archiveURL = testDirectory.appendingPathComponent("empty.tar")
let archiver = try ArchiveWriter(format: .paxRestricted, filter: .none, file: archiveURL)
try archiver.finishEncoding()
defer { try? FileManager.default.removeItem(at: testDirectory) }
let extractDir = try createExtractionDirectory(name: "empty")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let reader = try ArchiveReader(format: .paxRestricted, filter: .none, file: archiveURL)
#expect(throws: ArchiveError.self) {
_ = try reader.extractContents(to: extractDir)
}
}
// MARK: - FileHandle Stream Auto-Detect Tests
/// The stream-based auto-detecting reader must accept an uncompressed tar
/// stream, matching `docker cp -` / `podman cp -` input semantics.
@Test func readUncompressedTarFromFileHandle() throws {
let archiveURL = try createTestArchive(
name: "stream-plain",
entries: [
("dir/", .directory, nil),
("dir/file.txt", .regular("streamed plain"), nil),
])
defer { try? FileManager.default.removeItem(at: archiveURL.deletingLastPathComponent()) }
let extractDir = try createExtractionDirectory(name: "stream-plain")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let fh = try FileHandle(forReadingFrom: archiveURL)
defer { try? fh.close() }
let reader = try ArchiveReader(fileHandle: fh)
let rejected = try reader.extractContents(to: extractDir)
#expect(rejected.isEmpty)
let content = try String(contentsOf: extractDir.appendingPathComponent("dir/file.txt"), encoding: .utf8)
#expect(content == "streamed plain")
}
/// The stream-based auto-detecting reader must also accept a gzip-compressed
/// tar stream (the format the guest emits internally for directory copies),
/// without being told the filter up front.
@Test func readGzipTarFromFileHandle() throws {
let testDirectory = createTemporaryDirectory(baseName: "ArchiveReaderTests")!
defer { try? FileManager.default.removeItem(at: testDirectory) }
let archiveURL = testDirectory.appendingPathComponent("stream-gzip.tar.gz")
let writer = try ArchiveWriter(configuration: .init(format: .pax, filter: .gzip))
try writer.open(file: archiveURL)
let entry = WriteEntry()
entry.path = "hello.txt"
entry.fileType = .regular
entry.permissions = 0o644
let data = "streamed gzip".data(using: .utf8)!
entry.size = numericCast(data.count)
try writer.writeEntry(entry: entry, data: data)
try writer.finishEncoding()
let extractDir = try createExtractionDirectory(name: "stream-gzip")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
let fh = try FileHandle(forReadingFrom: archiveURL)
defer { try? fh.close() }
let reader = try ArchiveReader(fileHandle: fh)
let rejected = try reader.extractContents(to: extractDir)
#expect(rejected.isEmpty)
let content = try String(contentsOf: extractDir.appendingPathComponent("hello.txt"), encoding: .utf8)
#expect(content == "streamed gzip")
}
// MARK: - Zstd Compression Tests
@Test func readZstdCompressedArchive() throws {
guard let resourceURL = Bundle.module.url(forResource: "test", withExtension: "tar.zst") else {
Issue.record("Test resource test.tar.zst not found")
return
}
let extractDir = try createExtractionDirectory(name: "zstd-test")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
// Test with explicit filter
let reader = try ArchiveReader(format: .paxRestricted, filter: .zstd, file: resourceURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty, "No paths should be rejected")
// Check extracted files
let testFile = extractDir.appendingPathComponent("test.txt")
let file2 = extractDir.appendingPathComponent("file2.txt")
#expect(FileManager.default.fileExists(atPath: testFile.path), "test.txt should exist")
#expect(FileManager.default.fileExists(atPath: file2.path), "file2.txt should exist")
let testContent = try String(contentsOf: testFile, encoding: .utf8)
#expect(testContent == "Hello from zstd compressed archive", "Content should match")
let file2Content = try String(contentsOf: file2, encoding: .utf8)
#expect(file2Content == "Another file", "Content should match")
}
@Test func readZstdCompressedArchiveAutoDetect() throws {
guard let resourceURL = Bundle.module.url(forResource: "test", withExtension: "tar.zst") else {
Issue.record("Test resource test.tar.zst not found")
return
}
let extractDir = try createExtractionDirectory(name: "zstd-auto-test")
defer { try? FileManager.default.removeItem(at: extractDir.deletingLastPathComponent()) }
// Test with auto-detect
let reader = try ArchiveReader(file: resourceURL)
let rejectedPaths = try reader.extractContents(to: extractDir)
#expect(rejectedPaths.isEmpty, "No paths should be rejected")
// Check extracted files
let testFile = extractDir.appendingPathComponent("test.txt")
#expect(FileManager.default.fileExists(atPath: testFile.path), "test.txt should exist")
let testContent = try String(contentsOf: testFile, encoding: .utf8)
#expect(testContent == "Hello from zstd compressed archive", "Content should match")
}
}