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
|
// Copyright (c) 2021-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package archive
import (
"os"
"path"
"path/filepath"
"testing"
"github.com/sylabs/singularity/v4/internal/pkg/test"
"github.com/sylabs/singularity/v4/internal/pkg/util/fs"
"github.com/sylabs/singularity/v4/pkg/sylog"
)
func TestCopyWithTar(t *testing.T) {
copyFunc := func(src, dst string) error {
return CopyWithTar(src, dst, false)
}
t.Run("unprivileged", func(t *testing.T) {
test.DropPrivilege(t)
defer test.ResetPrivilege(t)
testCopy(t, copyFunc)
})
}
func TestCopyWithTarRoot(t *testing.T) {
copyFunc := func(src, dst string) error {
return CopyWithTarWithRoot(src, dst, dst, false)
}
t.Run("unprivileged", func(t *testing.T) {
test.DropPrivilege(t)
defer test.ResetPrivilege(t)
testCopy(t, copyFunc)
})
test.DropPrivilege(t)
t.Run("relLinkTarget", testRelLinkTarget)
}
func testCopy(t *testing.T, copyFunc func(src, dst string) error) {
srcRoot := t.TempDir()
t.Logf("srcRoot location: %s\n", srcRoot)
// Source Files
srcFile := filepath.Join(srcRoot, "srcFile")
if err := os.WriteFile(srcFile, []byte("test"), 0o644); err != nil {
t.Fatal(err)
}
// Source Dirs
srcDir := filepath.Join(srcRoot, "srcDir")
if err := os.Mkdir(srcDir, 0o755); err != nil {
t.Fatal(err)
}
// Source Symlink
srcLink := filepath.Join(srcRoot, "srcLink")
if err := os.Symlink("srcFile", srcLink); err != nil {
t.Fatal(err)
}
dstRoot := t.TempDir()
t.Logf("dstRoot location: %s\n", dstRoot)
// Perform the actual copy to a subdir of our dst tempdir.
// This ensures CopyWithTar has to create the dest directory, which is
// where the non-wrapped call would fail for unprivileged users.
err := copyFunc(srcRoot, path.Join(dstRoot, "dst"))
if err != nil {
t.Fatalf("Error during CopyWithTar: %v", err)
}
tests := []struct {
name string
expectPath string
expectFile bool
expectDir bool
expectLink bool
}{
{
name: "file",
expectPath: "dst/srcFile",
expectFile: true,
},
{
name: "dir",
expectPath: "dst/srcDir",
expectDir: true,
},
{
name: "symlink",
expectPath: "dst/srcLink",
expectFile: true,
expectLink: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
dstFinal := filepath.Join(dstRoot, tt.expectPath)
// verify file was copied
_, err = os.Stat(dstFinal)
if err != nil && !os.IsNotExist(err) {
t.Fatalf("while checking for destination file: %s", err)
}
if os.IsNotExist(err) {
t.Errorf("expected destination %s does not exist", dstFinal)
}
// File when expected?
if tt.expectFile && !fs.IsFile(dstFinal) {
t.Errorf("destination %s should be a file, but isn't", dstFinal)
}
// Dir when expected?
if tt.expectDir && !fs.IsDir(dstFinal) {
t.Errorf("destination %s should be a directory, but isn't", dstFinal)
}
// Symlink when expected
if tt.expectLink && !fs.IsLink(dstFinal) {
t.Errorf("destination %s should be a symlink, but isn't", dstFinal)
}
if !tt.expectLink && fs.IsLink(dstFinal) {
t.Errorf("destination %s should be a symlink, but is", dstFinal)
}
})
}
}
// Test that CopyWithTarWithRoot doesn't allow relative symlink targets above
// the dstRoot, but does allow them within the dstRoot, above dst.
//
// See - https://github.com/sylabs/singularity/issues/2607
func testRelLinkTarget(t *testing.T) {
tmpDir := t.TempDir()
linkTargetFile := filepath.Join(tmpDir, "target")
if err := os.WriteFile(linkTargetFile, []byte("test"), 0o644); err != nil {
t.Fatal(err)
}
tests := []struct {
name string
linkPath string
linkTarget string
src string
dst string
dstRoot string
expectError bool
}{
{
name: "symlinkEscape",
linkPath: filepath.Join(tmpDir, "symlinkEscape", "myLink"),
linkTarget: "../target",
src: filepath.Join(tmpDir, "symlinkEscape"),
dst: filepath.Join(tmpDir, "symlinkEscapeDest"),
dstRoot: filepath.Join(tmpDir, "symlinkEscapeDest"),
expectError: true,
},
{
name: "symLinkWithinRoot",
linkPath: filepath.Join(tmpDir, "symlinkWithinRoot", "myLink"),
linkTarget: "../target",
src: filepath.Join(tmpDir, "symlinkWithinRoot"),
dst: filepath.Join(tmpDir, "symlinkWithinRootDest"),
dstRoot: tmpDir,
expectError: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := os.MkdirAll(filepath.Dir(tt.linkPath), 0o755); err != nil {
t.Fatal(err)
}
if err := os.Symlink(tt.linkTarget, tt.linkPath); err != nil {
t.Fatal(err)
}
err := CopyWithTarWithRoot(tt.src, tt.dst, tt.dstRoot, false)
if err == nil && tt.expectError {
sylog.Errorf("expected error, but none returned")
}
if err != nil && !tt.expectError {
sylog.Errorf("unexpected error %v", err)
}
})
}
}
|