{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 1k
Expand file tree
/
Copy pathworktree_fs_test.go
More file actions
1605 lines (1324 loc) · 46.6 KB
/
Copy pathworktree_fs_test.go
File metadata and controls
1605 lines (1324 loc) · 46.6 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
package git
import (
"bytes"
"fmt"
"os"
"os/exec"
"path/filepath"
"runtime"
"sort"
"strings"
"testing"
billy "github.com/go-git/go-billy/v6"
"github.com/go-git/go-billy/v6/memfs"
"github.com/go-git/go-billy/v6/osfs"
"github.com/go-git/go-billy/v6/util"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/go-git/go-git/v6/internal/pathutil"
"github.com/go-git/go-git/v6/plumbing"
"github.com/go-git/go-git/v6/plumbing/filemode"
"github.com/go-git/go-git/v6/plumbing/object"
"github.com/go-git/go-git/v6/plumbing/storer"
"github.com/go-git/go-git/v6/storage/memory"
)
func TestValidPath(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
tests := []struct {
path string
wantErr bool
}{
{".git", true},
{".git/b", true},
{".git\\b", true},
{"git~1", true},
{"a/../b", true},
{"a\\..\\b", true},
{"/", true},
{"", true},
{".gitmodules", false},
{".gitignore", false},
{"a..b", false},
{".", true},
{"a/.git/b", true},
{"a\\.git\\b", true},
{"a/.git", false},
{"a\\.git", false},
{"a\x01b", true}, // explicit byte-oriented control-char rejection
{"foo\x7fbar", true}, // DEL byte
}
for _, tc := range tests {
t.Run(tc.path, func(t *testing.T) {
t.Parallel()
err := fs.validPath(tc.path)
if tc.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
})
}
}
func TestWorktreeFilesystemRejectsInvalidPaths(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
badPaths := []string{
".git/config",
".git/objects/pack/file",
"git~1/HEAD",
"../escape",
"a/../../etc/passwd",
}
for _, p := range badPaths {
t.Run(p, func(t *testing.T) {
t.Parallel()
_, err := fs.Create(p)
assert.Error(t, err, "Create should reject %q", p)
_, err = fs.OpenFile(p, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
assert.Error(t, err, "OpenFile should reject %q", p)
err = fs.Remove(p)
assert.Error(t, err, "Remove should reject %q", p)
err = fs.MkdirAll(p, 0o755)
assert.Error(t, err, "MkdirAll should reject %q", p)
err = fs.Symlink("target", p)
assert.Error(t, err, "Symlink should reject %q", p)
})
}
for _, p := range badPaths {
t.Run("Rename/from/"+p, func(t *testing.T) {
t.Parallel()
err := fs.Rename(p, "dst")
assert.Error(t, err, "Rename should reject from=%q", p)
})
t.Run("Rename/to/"+p, func(t *testing.T) {
t.Parallel()
err := fs.Rename("src", p)
assert.Error(t, err, "Rename should reject to=%q", p)
})
}
}
func TestWorktreeFilesystemAllowsValidPaths(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
validPaths := []string{
"readme.md",
"src/main.go",
".gitignore",
}
for _, p := range validPaths {
t.Run(p, func(t *testing.T) {
t.Parallel()
f, err := fs.Create(p)
require.NoError(t, err, "Create should allow %q", p)
require.NoError(t, f.Close())
err = fs.Remove(p)
assert.NoError(t, err, "Remove should allow %q", p)
})
}
}
// TestWorktreeFilesystemMkdirAllRootIsNoop locks in the contract that
// MkdirAll on a root-equivalent path is a silent no-op against the
// wrapper. validPath itself still rejects "", ".", and "/" (see
// TestValidPath), but MkdirAll specifically tolerates them because
// "ensure the root exists" is always trivially satisfied.
func TestWorktreeFilesystemMkdirAllRootIsNoop(t *testing.T) {
t.Parallel()
rootPaths := []string{"", ".", "/"}
for _, p := range rootPaths {
t.Run(p, func(t *testing.T) {
t.Parallel()
mfs := memfs.New()
fs := newWorktreeFilesystem(mfs, true, true)
require.NoError(t, fs.MkdirAll(p, 0o755))
entries, err := mfs.ReadDir("/")
require.NoError(t, err)
assert.Empty(t, entries, "MkdirAll(%q) must not materialise a directory entry", p)
})
}
}
func TestWorktreeFilesystemReturnsWorktreeFilesystem(t *testing.T) {
t.Parallel()
t.Run("via Repository.Worktree", func(t *testing.T) {
t.Parallel()
mfs := memfs.New()
r, err := Init(memory.NewStorage(), WithWorkTree(mfs))
require.NoError(t, err)
defer func() { _ = r.Close() }()
w, err := r.Worktree()
require.NoError(t, err)
assert.Equal(t, mfs, w.Filesystem())
_, err = w.filesystem.Create(".git/file")
assert.Error(t, err, "Create through worktreeFilesystem should reject .git paths")
})
t.Run("via struct literal", func(t *testing.T) {
t.Parallel()
mfs := memfs.New()
w := &Worktree{filesystem: newWorktreeFilesystem(mfs, false, false)}
assert.Equal(t, mfs, w.Filesystem())
_, err := w.filesystem.Create(".git/file")
assert.Error(t, err)
})
}
// assertOpsRejected exercises the read/write surface of the wrapper
// against a dangerous path and asserts every operation is rejected. Used
// across the symlink tests to demonstrate that the wrapper's protections
// hold no matter how the call site got there.
func assertOpsRejected(t *testing.T, fs *worktreeFilesystem, p string) {
t.Helper()
_, err := fs.Open(p)
assert.ErrorContains(t, err, "open:", "Open should reject %q", p)
_, err = fs.Create(p)
assert.ErrorContains(t, err, "create:", "Create should reject %q", p)
_, err = fs.OpenFile(p, os.O_RDWR, 0o644)
assert.ErrorContains(t, err, "openfile:", "OpenFile should reject %q", p)
err = fs.Remove(p)
assert.ErrorContains(t, err, "remove:", "Remove should reject %q", p)
_, err = fs.Lstat(p)
assert.ErrorContains(t, err, "lstat:", "Lstat should reject %q", p)
_, err = fs.Readlink(p)
assert.ErrorContains(t, err, "readlink:", "Readlink should reject %q", p)
}
func TestWorktreeFilesystemSymlinkRejectsDangerousLinkNames(t *testing.T) {
t.Parallel()
badPaths := []string{
".git",
".git/config",
".git/hooks/pre-commit",
"git~1/HEAD",
"../escape",
"a/../../etc/passwd",
}
for _, p := range badPaths {
t.Run(p, func(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
err := fs.Symlink("safe-target.txt", p)
assert.ErrorContains(t, err, "symlink:", "Symlink should reject link name %q", p)
assertOpsRejected(t, fs, p)
})
}
}
func TestWorktreeFilesystemSymlinkAllowsValidLink(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
require.NoError(t, fs.Symlink("target.txt", "link"))
got, err := fs.Readlink("link")
require.NoError(t, err)
assert.Equal(t, "target.txt", got)
assertOpsRejected(t, fs, ".git/config")
}
func TestWorktreeFilesystemSymlinkAllowsArbitraryTargets(t *testing.T) {
t.Parallel()
targets := []string{
"/etc/passwd",
"/absolute/path/to/file",
"../sibling",
"../../elsewhere",
"a/../b",
".git/config",
}
for _, target := range targets {
t.Run(target, func(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
link := "link"
require.NoError(t, fs.Symlink(target, link))
got, err := fs.Readlink(link)
require.NoError(t, err)
assert.Equal(t, filepath.FromSlash(target), got)
})
}
}
func TestWorktreeFilesystemReadlinkValidatesPath(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
require.NoError(t, fs.Symlink("target.txt", "good-link"))
t.Run("rejects bad link path", func(t *testing.T) {
t.Parallel()
_, err := fs.Readlink(".git/config")
assert.ErrorContains(t, err, "readlink:")
})
t.Run("allows valid link path", func(t *testing.T) {
t.Parallel()
got, err := fs.Readlink("good-link")
require.NoError(t, err)
assert.Equal(t, "target.txt", got)
})
assertOpsRejected(t, fs, ".git/config")
}
// TestWorktreeFilesystemFollowsSymlinkOnOpen verifies that Open on a
// symlink-named path follows the link via the underlying billy.Filesystem
// for legitimate links, while still rejecting any operation that targets a
// dangerous path directly.
func TestWorktreeFilesystemFollowsSymlinkOnOpen(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
require.NoError(t, util.WriteFile(fs, "data.txt", []byte("hello"), 0o644))
require.NoError(t, fs.Symlink("data.txt", "alias"))
f, err := fs.Open("alias")
require.NoError(t, err)
defer f.Close()
buf := make([]byte, 5)
n, err := f.Read(buf)
require.NoError(t, err)
assert.Equal(t, "hello", string(buf[:n]))
assertOpsRejected(t, fs, ".git/config")
}
// TestWorktreeFilesystemRejectsOpsOnPreExistingDotGitSymlink covers the case
// where a `.git` symlink was placed on the underlying filesystem before the
// wrapper saw it (e.g. a crafted on-disk repository). The wrapper validates
// the path the caller passed, so every operation against the `.git` name is
// refused regardless of what the symlink resolves to.
func TestWorktreeFilesystemRejectsOpsOnPreExistingDotGitSymlink(t *testing.T) {
t.Parallel()
mfs := memfs.New()
require.NoError(t, util.WriteFile(mfs, "real.txt", []byte("data"), 0o644))
require.NoError(t, mfs.Symlink("real.txt", ".git"))
fs := newWorktreeFilesystem(mfs, false, false)
assertOpsRejected(t, fs, ".git")
assertOpsRejected(t, fs, ".git/config")
}
// TestWorktreeFilesystemRejectsSymlinkTraversal pins the leading-path
// symlink invariant at the wrapper boundary. Every operation on "s/<name>"
// must be refused while "s" is an existing symlink, so no worktree code
// path, read or write, can follow the link out of the worktree. The path
// string is innocent, so validPath alone would allow it. validNoLeadingSymlink
// is what catches it. Chroot is additionally refused when the final
// component is itself a symlink, the "valid path, wrong target" case that
// Submodule.Repository relies on.
//
// It runs against both memfs and osfs so real on-disk symlink semantics
// are exercised alongside the pure abstraction.
func TestWorktreeFilesystemRejectsSymlinkTraversal(t *testing.T) {
t.Parallel()
const wantSubstr = "is a symlink"
backends := []struct {
name string
makeFS func(t *testing.T) billy.Filesystem
}{
{"memfs", func(*testing.T) billy.Filesystem { return memfs.New() }},
{"osfs", func(t *testing.T) billy.Filesystem { return osfs.New(t.TempDir()) }},
}
// symlinkFS wraps a fresh backend filesystem with "s" and "a/b/s"
// planted as symlinks. Each subtest gets its own, so the parallel
// subtests never share filesystem state.
symlinkFS := func(t *testing.T, makeFS func(*testing.T) billy.Filesystem) *worktreeFilesystem {
t.Helper()
base := makeFS(t)
require.NoError(t, base.MkdirAll("elsewhere", 0o755))
require.NoError(t, base.MkdirAll("a/b", 0o755))
if err := base.Symlink("elsewhere", "s"); err != nil {
if isSymlinkWindowsNonAdmin(err) {
t.Skipf("symlink creation requires elevated privileges: %v", err)
}
require.NoError(t, err)
}
require.NoError(t, base.Symlink("elsewhere", "a/b/s"))
return newWorktreeFilesystem(base, false, false)
}
for _, bk := range backends {
t.Run(bk.name, func(t *testing.T) {
t.Parallel()
for _, p := range []string{"s/file", "s/deeper/file", "a/b/s/file"} {
t.Run(p, func(t *testing.T) {
t.Parallel()
fs := symlinkFS(t, bk.makeFS)
_, err := fs.Create(p)
assert.ErrorContains(t, err, wantSubstr, "Create should reject %q", p)
_, err = fs.OpenFile(p, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
assert.ErrorContains(t, err, wantSubstr, "OpenFile should reject %q", p)
_, err = fs.Open(p)
assert.ErrorContains(t, err, wantSubstr, "Open should reject read through symlink %q", p)
err = fs.MkdirAll(p, 0o755)
assert.ErrorContains(t, err, wantSubstr, "MkdirAll should reject %q", p)
err = fs.Symlink("target", p)
assert.ErrorContains(t, err, wantSubstr, "Symlink should reject %q", p)
err = fs.Rename("readme.md", p)
assert.ErrorContains(t, err, wantSubstr, "Rename should reject destination %q", p)
err = fs.Remove(p)
assert.ErrorContains(t, err, wantSubstr, "Remove should reject %q", p)
})
}
t.Run("Chroot through leading symlink", func(t *testing.T) {
t.Parallel()
fs := symlinkFS(t, bk.makeFS)
_, err := fs.Chroot("s/sub")
assert.ErrorContains(t, err, wantSubstr, "Chroot should reject a leading symlink")
})
// The submodule-scoping case: Submodule.Repository chroots into
// the tree-controlled submodule path. A symlink as the final
// component must not redirect the scope out of the worktree.
t.Run("Chroot onto symlink target", func(t *testing.T) {
t.Parallel()
fs := symlinkFS(t, bk.makeFS)
_, err := fs.Chroot("s")
assert.ErrorContains(t, err, wantSubstr, "Chroot should reject a symlink as the final component")
})
})
}
}
// assertOpsAllowed verifies the round-trip read/write surface for a path
// the wrapper should accept: write a payload, read it back, and Lstat it.
func assertOpsAllowed(t *testing.T, fs *worktreeFilesystem, p string) {
t.Helper()
const payload = "payload"
require.NoError(t, util.WriteFile(fs, p, []byte(payload), 0o644))
f, err := fs.Open(p)
require.NoError(t, err, "Open should accept %q", p)
t.Cleanup(func() { _ = f.Close() })
buf := make([]byte, len(payload))
n, err := f.Read(buf)
require.NoError(t, err)
assert.Equal(t, payload, string(buf[:n]))
fi, err := fs.Lstat(p)
require.NoError(t, err, "Lstat should accept %q", p)
assert.Equal(t, int64(len(payload)), fi.Size())
}
func TestWorktreeFilesystemAbsolutePaths(t *testing.T) {
t.Parallel()
tests := []struct {
name string
path string
wantReject bool
}{
{"reject /.git", "/.git", true},
{"reject /.git/config", "/.git/config", true},
{"reject /.git/objects/pack/file", "/.git/objects/pack/file", true},
{"reject /git~1/HEAD", "/git~1/HEAD", true},
{"reject /sub/.git/config", "/sub/.git/config", true},
{"allow /readme.md", "/readme.md", false},
{"allow /src/main.go", "/src/main.go", false},
{"allow /.gitignore", "/.gitignore", false},
{"allow /submodule/.git", "/submodule/.git", false},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
fs := newWorktreeFilesystem(memfs.New(), false, false)
if tc.wantReject {
assertOpsRejected(t, fs, tc.path)
err := fs.Symlink("safe-target.txt", tc.path)
assert.ErrorContains(t, err, "symlink:", "Symlink should reject link %q", tc.path)
return
}
assertOpsAllowed(t, fs, tc.path)
})
}
}
// TestCherryPickPathValidationMatchesGit verifies that go-git and upstream
// Git both reject cherry-picking commits that contain dangerous paths.
//
// For each test case, a commit is crafted (via go-git plumbing) in an
// on-disk repository with a tree containing a single bad path. Both go-git
// CherryPick and `git cherry-pick` are run against it. Both must reject.
func TestCherryPickPathValidationMatchesGit(t *testing.T) {
if testing.Short() {
t.Skip("skipping path validation conformance test in short mode")
}
t.Parallel()
tests := []struct {
name string
// path is the file path to place in the crafted commit's tree.
// Nested paths (containing /) are built as nested tree objects.
path string
// config overrides to set before running cherry-pick.
config map[string]string
// skipGit skips the upstream git cherry-pick check. Used for
// checks that go-git enforces but upstream git does not on this
// platform (e.g. reserved device names are only checked by
// compat/mingw.c, which is not compiled on non-Windows).
skipGit bool
}{
{
name: ".git at root",
path: ".git/config",
},
{
name: ".git in subdirectory",
path: "subdir/.git/config",
},
{
// Final-component .git as a regular blob mimics an attacker
// trying to overwrite a submodule's gitlink pointer via tree
// content. Upstream verify_path rejects this at every position
// and so does pathutil.ValidTreePath, called from
// Tree.FindEntry. The legitimate submodule shape is the
// directory entry itself (mode 160000 at "submodule"); a
// `.git` file inside is a checkout-time artifact, not a tree
// entry.
name: "final-component .git in subdirectory",
path: "submodule/.git",
},
{
name: "git~1 8.3 short name",
path: "git~1/config",
skipGit: !gitAtLeast(t, 2, 24),
},
{
name: "dot-dot traversal",
path: "a/../../etc/passwd",
},
{
name: "single dot component",
path: "a/./b",
},
{
name: "NTFS trailing space on .git",
path: ".git /config",
config: map[string]string{"core.protectNTFS": "true"},
},
{
name: "NTFS trailing dot on .git",
path: ".git./config",
config: map[string]string{"core.protectNTFS": "true"},
},
{
name: "NTFS alternate data stream",
path: ".git::$INDEX_ALLOCATION/config",
config: map[string]string{"core.protectNTFS": "true"},
skipGit: !gitAtLeast(t, 2, 24),
},
{
name: "NTFS reserved device name CON",
path: "CON/file",
config: map[string]string{"core.protectNTFS": "true"},
skipGit: runtime.GOOS != "windows",
},
{
name: "NTFS reserved device name NUL",
path: "NUL",
config: map[string]string{"core.protectNTFS": "true"},
skipGit: runtime.GOOS != "windows",
},
{
name: "HFS+ zero-width character in .git",
path: ".g\u200cit/config",
config: map[string]string{"core.protectHFS": "true"},
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
dir := t.TempDir()
r1, err := PlainInit(dir, false)
require.NoError(t, err)
defer func() { _ = r1.Close() }()
w, err := r1.Worktree()
require.NoError(t, err)
require.NoError(t, util.WriteFile(w.Filesystem(), "README", []byte("init"), 0o644))
_, err = w.Add("README")
require.NoError(t, err)
initHash, err := w.Commit("initial commit\n", &CommitOptions{Author: defaultSignature()})
require.NoError(t, err)
for k, v := range tc.config {
gitConfig(t, dir, k, v)
}
initCommit, err := r1.CommitObject(initHash)
require.NoError(t, err)
badCommit := buildCommitWithEntry(t, r1.Storer, initCommit, initHash, tc.path, filemode.Regular)
// Re-open so config overrides take effect in the worktreeFilesystem.
r2, err := PlainOpen(dir)
require.NoError(t, err)
defer func() { _ = r2.Close() }()
w, err = r2.Worktree()
require.NoError(t, err)
goGitErr := w.CherryPick(
&CommitOptions{Author: defaultSignature(), AllowEmptyCommits: true},
TheirsMergeStrategy, badCommit,
)
assert.Error(t, goGitErr, "go-git should reject cherry-pick of %q", tc.path)
if !tc.skipGit {
require.NoError(t, w.Reset(&ResetOptions{Commit: initHash, Mode: HardReset}))
gitErr := gitCherryPick(t, dir, badCommit.Hash.String())
assert.Error(t, gitErr, "git should reject cherry-pick of %q", tc.path)
}
})
}
}
func TestCherryPickDoesNotWriteThroughLeadingSymlink(t *testing.T) {
t.Parallel()
dir := t.TempDir()
r, err := PlainInit(dir, false)
require.NoError(t, err)
defer func() { _ = r.Close() }()
w, err := r.Worktree()
require.NoError(t, err)
require.NoError(t, util.WriteFile(w.Filesystem(), "README", []byte("init"), 0o644))
_, err = w.Add("README")
require.NoError(t, err)
initHash, err := w.Commit("initial commit\n", &CommitOptions{Author: defaultSignature()})
require.NoError(t, err)
initCommit, err := r.CommitObject(initHash)
require.NoError(t, err)
configPath := filepath.Join(dir, ".git", "config")
originalConfig, err := os.ReadFile(configPath)
require.NoError(t, err)
attack := buildCommitWithEntry(t, r.Storer, initCommit, initHash, "s/config", filemode.Regular)
err = w.Filesystem().Symlink(".git", "s")
if err != nil && isSymlinkWindowsNonAdmin(err) {
t.Skipf("symlink creation requires elevated privileges on this platform: %v", err)
}
require.NoError(t, err)
err = w.CherryPick(
&CommitOptions{Author: defaultSignature(), AllowEmptyCommits: true},
TheirsMergeStrategy, attack,
)
require.NoError(t, err)
gotConfig, err := os.ReadFile(configPath)
require.NoError(t, err)
require.Equal(t, originalConfig, gotConfig, "CherryPick must not write s/config through symlink s -> .git")
got, err := os.ReadFile(filepath.Join(dir, "s", "config"))
require.NoError(t, err)
require.Equal(t, "exploit", string(got))
}
func TestCherryPickDoesNotWriteThroughFinalSymlink(t *testing.T) {
t.Parallel()
dir := t.TempDir()
r, err := PlainInit(dir, false)
require.NoError(t, err)
defer func() { _ = r.Close() }()
w, err := r.Worktree()
require.NoError(t, err)
require.NoError(t, util.WriteFile(w.Filesystem(), "README", []byte("init"), 0o644))
_, err = w.Add("README")
require.NoError(t, err)
initHash, err := w.Commit("initial commit\n", &CommitOptions{Author: defaultSignature()})
require.NoError(t, err)
initCommit, err := r.CommitObject(initHash)
require.NoError(t, err)
configPath := filepath.Join(dir, ".git", "config")
originalConfig, err := os.ReadFile(configPath)
require.NoError(t, err)
attack := buildCommitWithEntry(t, r.Storer, initCommit, initHash, "s", filemode.Regular)
err = w.Filesystem().Symlink(".git/config", "s")
if err != nil && isSymlinkWindowsNonAdmin(err) {
t.Skipf("symlink creation requires elevated privileges on this platform: %v", err)
}
require.NoError(t, err)
err = w.CherryPick(
&CommitOptions{Author: defaultSignature(), AllowEmptyCommits: true},
TheirsMergeStrategy, attack,
)
gotConfig, readErr := os.ReadFile(configPath)
require.NoError(t, readErr)
require.Equal(t, originalConfig, gotConfig, "CherryPick must not write s through symlink s -> .git/config")
if err == nil {
fi, statErr := os.Lstat(filepath.Join(dir, "s"))
require.NoError(t, statErr)
require.Zero(t, fi.Mode()&os.ModeSymlink, "successful CherryPick must replace the symlink with a regular file")
got, readErr := os.ReadFile(filepath.Join(dir, "s"))
require.NoError(t, readErr)
require.Equal(t, "exploit", string(got))
}
}
func TestCherryPickModifyTrackedSymlinkToRegularFileDoesNotWriteThroughSymlink(t *testing.T) {
t.Parallel()
dir := t.TempDir()
r, err := PlainInit(dir, false)
require.NoError(t, err)
defer func() { _ = r.Close() }()
w, err := r.Worktree()
require.NoError(t, err)
require.NoError(t, util.WriteFile(w.Filesystem(), "README", []byte("init"), 0o644))
_, err = w.Add("README")
require.NoError(t, err)
_, err = w.Commit("initial commit\n", &CommitOptions{Author: defaultSignature()})
require.NoError(t, err)
err = w.Filesystem().Symlink(".git/config", "s")
if err != nil && isSymlinkWindowsNonAdmin(err) {
t.Skipf("symlink creation requires elevated privileges on this platform: %v", err)
}
require.NoError(t, err)
_, err = w.Add("s")
require.NoError(t, err)
linkHash, err := w.Commit("add symlink\n", &CommitOptions{Author: defaultSignature()})
require.NoError(t, err)
linkCommit, err := r.CommitObject(linkHash)
require.NoError(t, err)
configPath := filepath.Join(dir, ".git", "config")
originalConfig, err := os.ReadFile(configPath)
require.NoError(t, err)
attack := buildCommitReplacingRootEntry(t, r.Storer, linkCommit, linkHash, object.TreeEntry{
Name: "s",
Mode: filemode.Regular,
Hash: writeBlob(t, r.Storer, []byte("exploit")),
})
err = w.CherryPick(
&CommitOptions{Author: defaultSignature(), AllowEmptyCommits: true},
TheirsMergeStrategy, attack,
)
gotConfig, readErr := os.ReadFile(configPath)
require.NoError(t, readErr)
require.Equal(t, originalConfig, gotConfig, "CherryPick must not write tracked symlink s through to .git/config")
require.NoError(t, err)
fi, err := os.Lstat(filepath.Join(dir, "s"))
require.NoError(t, err)
require.Zero(t, fi.Mode()&os.ModeSymlink, "CherryPick should replace the tracked symlink with a regular file")
got, err := os.ReadFile(filepath.Join(dir, "s"))
require.NoError(t, err)
require.Equal(t, "exploit", string(got))
}
func buildCommitWithEntry(t *testing.T, s storer.Storer, parent *object.Commit, parentHash plumbing.Hash, filePath string, leafMode filemode.FileMode) *object.Commit {
t.Helper()
leafHash := writeBlob(t, s, []byte("exploit"))
// Build nested tree structure from leaf to root.
parts := strings.Split(filePath, "/")
for i := len(parts) - 1; i >= 1; i-- {
entry := object.TreeEntry{Name: parts[i], Mode: leafMode, Hash: leafHash}
leafHash = storeRawTree(t, s, []object.TreeEntry{entry})
leafMode = filemode.Dir
}
return buildCommitWithEntries(t, s, parent, parentHash,
[]object.TreeEntry{{Name: parts[0], Mode: leafMode, Hash: leafHash}},
"bad path: "+filePath+"\n")
}
func buildCommitReplacingRootEntry(t *testing.T, s storer.Storer, parent *object.Commit, parentHash plumbing.Hash, replacement object.TreeEntry) *object.Commit {
t.Helper()
parentTree, err := parent.Tree()
require.NoError(t, err)
entries := make([]object.TreeEntry, 0, len(parentTree.Entries)+1)
for _, e := range parentTree.Entries {
if e.Name == replacement.Name {
continue
}
entries = append(entries, e)
}
entries = append(entries, replacement)
sort.Sort(object.TreeEntrySorter(entries))
rootHash := storeRawTree(t, s, entries)
commit := &object.Commit{
Author: *defaultSignature(),
Committer: *defaultSignature(),
Message: "replace " + replacement.Name + "\n",
TreeHash: rootHash,
ParentHashes: []plumbing.Hash{parentHash},
}
commitObj := s.NewEncodedObject()
require.NoError(t, commit.Encode(commitObj))
commitHash, err := s.SetEncodedObject(commitObj)
require.NoError(t, err)
result, err := object.GetCommit(s, commitHash)
require.NoError(t, err)
return result
}
// writeBlob stores content as a blob object and returns its hash.
func writeBlob(t *testing.T, s storer.Storer, content []byte) plumbing.Hash {
t.Helper()
obj := s.NewEncodedObject()
obj.SetType(plumbing.BlobObject)
obj.SetSize(int64(len(content)))
w, err := obj.Writer()
require.NoError(t, err)
_, err = w.Write(content)
require.NoError(t, err)
require.NoError(t, w.Close())
hash, err := s.SetEncodedObject(obj)
require.NoError(t, err)
return hash
}
// buildCommitWithEntries builds a commit on top of parent whose tree is
// the parent tree plus extra. Unlike buildCommitWithEntry it takes
// fully-formed entries, so callers can plant symlinks and subtrees.
func buildCommitWithEntries(t *testing.T, s storer.Storer, parent *object.Commit, parentHash plumbing.Hash, extra []object.TreeEntry, message string) *object.Commit {
t.Helper()
parentTree, err := parent.Tree()
require.NoError(t, err)
entries := make([]object.TreeEntry, len(parentTree.Entries), len(parentTree.Entries)+len(extra))
copy(entries, parentTree.Entries)
entries = append(entries, extra...)
sort.Sort(object.TreeEntrySorter(entries))
rootHash := storeRawTree(t, s, entries)
commit := &object.Commit{
Author: *defaultSignature(),
Committer: *defaultSignature(),
Message: message,
TreeHash: rootHash,
ParentHashes: []plumbing.Hash{parentHash},
}
commitObj := s.NewEncodedObject()
require.NoError(t, commit.Encode(commitObj))
commitHash, err := s.SetEncodedObject(commitObj)
require.NoError(t, err)
result, err := object.GetCommit(s, commitHash)
require.NoError(t, err)
return result
}
// storeRawTree writes a tree object to s by assembling the raw
// `<mode> SP <name> NUL <hash>` bytes for each entry. Tests that plant
// trees containing components like ".git", "..", or HFS+/NTFS variants
// use this helper because Tree.Encode runs Tree.Validate and refuses
// those names — the escape hatch documented on Tree.Encode's godoc.
func storeRawTree(t *testing.T, s storer.Storer, entries []object.TreeEntry) plumbing.Hash {
t.Helper()
var buf bytes.Buffer
for _, e := range entries {
fmt.Fprintf(&buf, "%o %s", e.Mode, e.Name)
buf.WriteByte(0)
buf.Write(e.Hash.Bytes())
}
obj := s.NewEncodedObject()
obj.SetType(plumbing.TreeObject)
w, err := obj.Writer()
require.NoError(t, err)
_, err = w.Write(buf.Bytes())
require.NoError(t, err)
require.NoError(t, w.Close())
hash, err := s.SetEncodedObject(obj)
require.NoError(t, err)
return hash
}
func gitConfig(t *testing.T, dir, key, value string) {
t.Helper()
cmd := exec.Command("git", "config", key, value)
cmd.Dir = dir
out, err := cmd.CombinedOutput()
require.NoError(t, err, "git config %s %s: %s", key, value, out)
}
// gitAtLeast reports whether the local `git` is at least the given version.
// Used to skip upstream cherry-pick assertions for protections that older
// Git releases (e.g. 2.11) do not implement, such as the git~1 8.3 short
// name check (CVE-2014-9390 hardening) and the .git::$INDEX_ALLOCATION
// NTFS Alternate Data Stream check (CVE-2019-1351).
func gitAtLeast(t *testing.T, major, minor int) bool {
t.Helper()
out, err := exec.Command("git", "--version").Output()
if err != nil {
return false
}
var maj, mnr int
if _, err := fmt.Sscanf(string(out), "git version %d.%d", &maj, &mnr); err != nil {
return false
}
if maj != major {
return maj > major
}
return mnr >= minor
}
func gitCherryPick(t *testing.T, dir, hash string) error {
t.Helper()
cmd := exec.Command("git", "cherry-pick", hash)
cmd.Dir = dir
cmd.Env = append(os.Environ(),
"GIT_AUTHOR_NAME=test",
"GIT_AUTHOR_EMAIL=test@test",
"GIT_COMMITTER_NAME=test",
"GIT_COMMITTER_EMAIL=test@test",
)
out, err := cmd.CombinedOutput()
if err != nil {
abort := exec.Command("git", "cherry-pick", "--abort")
abort.Dir = dir
_ = abort.Run()
return fmt.Errorf("git cherry-pick %s: %s: %w", hash, out, err)
You can’t perform that action at this time.