//go:build !integration package download import ( "errors" "io" "os" "path/filepath" "strings" "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "go.uber.org/mock/gomock" gitlab "gitlab.com/gitlab-org/api/client-go/v3" gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing" "gitlab.com/gitlab-org/cli/internal/testing/cmdtest" ) const ( fileContents = "Hello" fileContentsChecksum = "185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969" repoName = "OWNER/REPO" fileName = "localfile.txt" ) func Test_SecurefileDownload(t *testing.T) { testCases := []struct { Name string ExpectedMsg []string expectedFileName string wantErr bool cli string wantStderr string setupMocks func(*gitlabtesting.TestClient) }{ { Name: "Download secure file to current folder with checksum verification via id arg", ExpectedMsg: []string{"Downloaded secure file 'downloaded.tmp' (ID: 1)\n"}, expectedFileName: "downloaded.tmp", cli: "1", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: fileName, Checksum: fileContentsChecksum, }, nil, nil) }, }, { Name: "Download secure file to current folder with checksum verification via id flag", ExpectedMsg: []string{"Downloaded secure file 'downloaded.tmp' (ID: 1)\n"}, expectedFileName: "downloaded.tmp", cli: "--id 1", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: fileName, Checksum: fileContentsChecksum, }, nil, nil) }, }, { Name: "Download secure file to custom folder", ExpectedMsg: []string{"Downloaded secure file 'new.txt' (ID: 1)\n"}, expectedFileName: "newdir/new.txt", cli: "1 --path=newdir/new.txt", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: fileName, Checksum: fileContentsChecksum, }, nil, nil) }, }, { Name: "Download secure file to custom folder with path traversal", ExpectedMsg: []string{"Downloaded secure file 'new.txt' (ID: 1)\n"}, cli: "1 --path=../../newdir/new.txt", wantErr: true, wantStderr: `relative path "../../newdir/new.txt" escapes the working directory`, setupMocks: func(testClient *gitlabtesting.TestClient) {}, }, { Name: "Download secure file without checksum verification", ExpectedMsg: []string{"Downloaded secure file 'downloaded.tmp' (ID: 1)\n"}, expectedFileName: "downloaded.tmp", cli: "1 --no-verify", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) }, }, { Name: "Download secure file with invalid checksum", ExpectedMsg: []string{"checksum verification failed for localfile.txt: expected invalid_checksum, got 185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969\n"}, expectedFileName: "downloaded.tmp", cli: "1", wantErr: true, wantStderr: "checksum verification failed for localfile.txt: expected invalid_checksum, got 185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: fileName, Checksum: "invalid_checksum", }, nil, nil) }, }, { Name: "Force download secure file with invalid checksum", ExpectedMsg: []string{ "Checksum verification failed for localfile.txt: expected invalid_checksum, got 185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969\n", "Force-download selected, continuing to download file.\n", "Downloaded secure file 'downloaded.tmp' (ID: 1)\n", }, expectedFileName: "downloaded.tmp", cli: "1 --force-download", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: fileName, Checksum: "invalid_checksum", }, nil, nil) }, }, { Name: "Download secure file by name to current directory", ExpectedMsg: []string{ "Downloaded secure file 'file2.txt' (Name: file2.txt)\n", }, cli: "--name file2.txt", expectedFileName: "file2.txt", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{ ListOptions: gitlab.ListOptions{ Page: 1, PerPage: 100, }, }, nil). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, {ID: 2, Name: "file2.txt", Checksum: fileContentsChecksum}, }, nil, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(2), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(2), gomock.Any()). Return(&gitlab.SecureFile{ ID: 2, Name: "file2.txt", Checksum: fileContentsChecksum, }, nil, nil) }, }, { Name: "Download secure file by name to custom output directory", ExpectedMsg: []string{ "Downloaded secure file 'file1.txt' (Name: file1.txt)", }, cli: "--name file1.txt --path=secure_files/file1.txt", expectedFileName: "secure_files/file1.txt", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{ ListOptions: gitlab.ListOptions{ Page: 1, PerPage: 100, }, }, nil). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file2.pdf", Checksum: fileContentsChecksum}, {ID: 2, Name: "file1.txt", Checksum: fileContentsChecksum}, }, nil, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(2), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(2), gomock.Any()). Return(&gitlab.SecureFile{ ID: 2, Name: "file1.txt", Checksum: fileContentsChecksum, }, nil, nil) }, }, { Name: "Download secure file by name without checksum verification", ExpectedMsg: []string{ "Downloaded secure file 'file1.txt' (Name: file1.txt)", }, cli: "--name file1.txt --no-verify", expectedFileName: "file1.txt", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{ ListOptions: gitlab.ListOptions{ Page: 1, PerPage: 100, }, }, nil). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, }, nil, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) }, }, { Name: "Download secure file by name with force download on checksum failure", ExpectedMsg: []string{ "Checksum verification failed for file1.txt: expected invalid_checksum, got 185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969", "Force-download selected, continuing to download file.", "Downloaded secure file 'file1.txt' (Name: file1.txt)", }, cli: "--name file1.txt --force-download", expectedFileName: "file1.txt", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{ ListOptions: gitlab.ListOptions{ Page: 1, PerPage: 100, }, }, nil). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: "invalid_checksum"}, }, nil, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: "file1.txt", Checksum: "invalid_checksum", }, nil, nil) }, }, { Name: "Handle empty secure files list", ExpectedMsg: []string{}, cli: "--name notfound", expectedFileName: "", wantErr: true, wantStderr: "couldn't locate secure file with name notfound", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{ ListOptions: gitlab.ListOptions{ Page: 1, PerPage: 100, }, }, nil). Return([]*gitlab.SecureFile{}, &gitlab.Response{ NextPage: 0, NextLink: "", }, nil) }, }, { Name: "Error when --name flag is used with fileID argument", cli: "--name foobar 1", wantErr: true, wantStderr: "name flag is not compatible with arguments", setupMocks: func(testClient *gitlabtesting.TestClient) {}, }, { Name: "Error when --name flag is used with --id flag", cli: "--name foobar --id 1", wantErr: true, wantStderr: "if any flags in the group [id name all] are set none of the others can be; [id name] were all set", setupMocks: func(testClient *gitlabtesting.TestClient) {}, }, { Name: "Error when output-dir flag is used without all flag", cli: "1 --output-dir=secure_files", wantErr: true, wantStderr: "output-dir flag is only compatible with all flag", setupMocks: func(testClient *gitlabtesting.TestClient) {}, }, } for _, tc := range testCases { t.Run(tc.Name, func(t *testing.T) { tempDir := t.TempDir() t.Chdir(tempDir) testClient := gitlabtesting.NewTestClient(t) tc.setupMocks(testClient) exec := cmdtest.SetupCmdForTest(t, NewCmdDownload, false, cmdtest.WithGitLabClient(testClient.Client), ) out, err := exec(tc.cli) if tc.wantErr { if assert.Error(t, err) { require.Equal(t, tc.wantStderr, err.Error()) } if tc.expectedFileName != "" { // Ensure downloaded file and temp files are not persisted/cleaned up following an error files, err := os.ReadDir(filepath.Dir(tc.expectedFileName)) require.NoError(t, err, "Failed to read directory") assert.Empty(t, files, "Directory should be empty after error") } return } require.NoError(t, err) for _, msg := range tc.ExpectedMsg { require.Contains(t, out.String(), msg) } _, err = os.Stat(tc.expectedFileName) require.NoError(t, err) actualContent, err := os.ReadFile(tc.expectedFileName) require.NoError(t, err, "Failed to read downloaded test file") assert.Equal(t, "Hello", string(actualContent), "File content should match") }) } } func Test_SecurefileDownloadAll(t *testing.T) { testCases := []struct { Name string ExpectedMsg []string cli string wantErr bool wantStderr string expectedFiles []string setupMocks func(*gitlabtesting.TestClient) }{ { Name: "Download all secure files to current directory", ExpectedMsg: []string{ "Downloaded secure file 'file1.txt' (ID: 1)", "Downloaded secure file 'file2.pdf' (ID: 2)", }, cli: "--all", expectedFiles: []string{"file1.txt", "file2.pdf"}, setupMocks: func(testClient *gitlabtesting.TestClient) { firstPage := testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, }, &gitlab.Response{NextPage: 2}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum, }, nil, nil) secondPage := testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 2, Name: "file2.pdf", Checksum: fileContentsChecksum}, }, &gitlab.Response{}, nil) gomock.InOrder(firstPage, secondPage) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(2), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(2), gomock.Any()). Return(&gitlab.SecureFile{ ID: 2, Name: "file2.pdf", Checksum: fileContentsChecksum, }, nil, nil) }, }, { Name: "Return an error from a subsequent page", cli: "--all", wantErr: true, wantStderr: "error fetching secure files: next page unavailable", setupMocks: func(testClient *gitlabtesting.TestClient) { firstPage := testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, }, &gitlab.Response{NextPage: 2}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum, }, nil, nil) secondPage := testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return(nil, nil, errors.New("next page unavailable")) gomock.InOrder(firstPage, secondPage) }, }, { Name: "Download all secure files to custom output directory", ExpectedMsg: []string{ "Downloaded secure file 'file1.txt' (ID: 1)", "Downloaded secure file 'file2.pdf' (ID: 2)", }, cli: "--all --output-dir=secure_files", expectedFiles: []string{"secure_files/file1.txt", "secure_files/file2.pdf"}, setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, {ID: 2, Name: "file2.pdf", Checksum: fileContentsChecksum}, }, &gitlab.Response{}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum, }, nil, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(2), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(2), gomock.Any()). Return(&gitlab.SecureFile{ ID: 2, Name: "file2.pdf", Checksum: fileContentsChecksum, }, nil, nil) }, }, { Name: "Download all secure files without checksum verification", ExpectedMsg: []string{ "Downloaded secure file 'file1.txt' (ID: 1)", }, cli: "--all --no-verify", expectedFiles: []string{"file1.txt"}, setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, }, &gitlab.Response{}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) }, }, { Name: "Download all secure files with force download on checksum failure", ExpectedMsg: []string{ "Checksum verification failed for file1.txt: expected invalid_checksum, got 185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969", "Force-download selected, continuing to download file.", "Downloaded secure file 'file1.txt' (ID: 1)", }, cli: "--all --force-download", expectedFiles: []string{"file1.txt"}, setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: "invalid_checksum"}, }, &gitlab.Response{}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: "file1.txt", Checksum: "invalid_checksum", }, nil, nil) }, }, { Name: "Error when --all flag is used with fileID argument", cli: "--all 1", wantErr: true, wantStderr: "all flag is not compatible with arguments", setupMocks: func(testClient *gitlabtesting.TestClient) {}, }, { Name: "Handle empty secure files list", ExpectedMsg: []string{}, cli: "--all", expectedFiles: []string{}, setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{}, &gitlab.Response{}, nil) }, }, { Name: "Handle secure file with path traversal", ExpectedMsg: []string{ "Downloaded secure file 'passwd' (ID: 1)\n", }, cli: "--all --output-dir=../../secure_files", wantErr: true, wantStderr: "error downloading secure file '/etc/passwd' (ID: 1): name would write outside the output directory", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 1, Name: "/etc/passwd", Checksum: fileContentsChecksum}, }, &gitlab.Response{}, nil) }, }, { Name: "Download all secure files with checksum error", cli: "--all", wantErr: true, wantStderr: "error downloading secure file 'file2.pdf' (ID: 2): checksum verification failed for file2.pdf: expected invalid_checksum, got 185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969", setupMocks: func(testClient *gitlabtesting.TestClient) { testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{ {ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, {ID: 2, Name: "file2.pdf", Checksum: "invalid_checksum"}, }, &gitlab.Response{}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum, }, nil, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(2), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(2), gomock.Any()). Return(&gitlab.SecureFile{ ID: 2, Name: "file2.pdf", Checksum: "invalid_checksum", }, nil, nil) }, }, } for _, tc := range testCases { t.Run(tc.Name, func(t *testing.T) { tempDir := t.TempDir() t.Chdir(tempDir) testClient := gitlabtesting.NewTestClient(t) tc.setupMocks(testClient) exec := cmdtest.SetupCmdForTest(t, NewCmdDownload, false, cmdtest.WithGitLabClient(testClient.Client), ) out, err := exec(tc.cli) if tc.wantErr { if assert.Error(t, err) { require.Equal(t, tc.wantStderr, err.Error()) } return } require.NoError(t, err) for _, msg := range tc.ExpectedMsg { require.Contains(t, out.String(), msg) } for _, expectedFile := range tc.expectedFiles { _, err = os.Stat(expectedFile) require.NoError(t, err, "Expected file %s should exist", expectedFile) actualContent, err := os.ReadFile(expectedFile) require.NoError(t, err, "Failed to read downloaded test file %s", expectedFile) assert.Equal(t, "Hello", string(actualContent), "File content should match for %s", expectedFile) } }) } } // The table-driven cases above can only carry static CLI strings, so the // absolute-path cases live here where a t.TempDir() can be interpolated. func Test_SecurefileDownload_AbsoluteDestination(t *testing.T) { newFile := func(t *testing.T, checksum string) *gitlabtesting.TestClient { t.Helper() testClient := gitlabtesting.NewTestClient(t) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ID: 1, Name: fileName, Checksum: checksum}, nil, nil) return testClient } t.Run("absolute path creates missing parents and writes the file", func(t *testing.T) { t.Chdir(t.TempDir()) dest := filepath.Join(t.TempDir(), "nested", "deeper", "secure.txt") exec := cmdtest.SetupCmdForTest(t, NewCmdDownload, false, cmdtest.WithGitLabClient(newFile(t, fileContentsChecksum).Client)) out, err := exec("1 --path=" + dest) require.NoError(t, err) assert.Contains(t, out.String(), "Downloaded secure file 'secure.txt' (ID: 1)") got, err := os.ReadFile(dest) require.NoError(t, err) assert.Equal(t, fileContents, string(got)) }) t.Run("absolute path with --name", func(t *testing.T) { t.Chdir(t.TempDir()) dest := filepath.Join(t.TempDir(), "out", "renamed.pem") testClient := gitlabtesting.NewTestClient(t) testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{{ID: 1, Name: fileName, Checksum: fileContentsChecksum}}, &gitlab.Response{}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ID: 1, Name: fileName, Checksum: fileContentsChecksum}, nil, nil) exec := cmdtest.SetupCmdForTest(t, NewCmdDownload, false, cmdtest.WithGitLabClient(testClient.Client)) out, err := exec("--name " + fileName + " --path=" + dest) require.NoError(t, err) assert.Contains(t, out.String(), "Downloaded secure file 'renamed.pem' (Name: "+fileName+")") got, err := os.ReadFile(dest) require.NoError(t, err) assert.Equal(t, fileContents, string(got)) }) // Cleanup has to work through the absolute root too: this is the case that // leaked a temporary file in the previous attempt at this fix (!2761). t.Run("failed checksum leaves no temporary file behind", func(t *testing.T) { t.Chdir(t.TempDir()) destDir := t.TempDir() dest := filepath.Join(destDir, "secure.txt") exec := cmdtest.SetupCmdForTest(t, NewCmdDownload, false, cmdtest.WithGitLabClient(newFile(t, "invalid_checksum").Client)) _, err := exec("1 --path=" + dest) require.Error(t, err) entries, readErr := os.ReadDir(destDir) require.NoError(t, readErr) assert.Empty(t, entries, "destination directory should hold no temporary leftovers") }) t.Run("absolute --output-dir with --all", func(t *testing.T) { t.Chdir(t.TempDir()) destDir := t.TempDir() testClient := gitlabtesting.NewTestClient(t) testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{{ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}}, &gitlab.Response{}, nil) testClient.MockSecureFiles.EXPECT(). DownloadSecureFile(repoName, int64(1), gomock.Any()). Return(io.NopCloser(strings.NewReader(fileContents)), nil, nil) testClient.MockSecureFiles.EXPECT(). ShowSecureFileDetails(repoName, int64(1), gomock.Any()). Return(&gitlab.SecureFile{ID: 1, Name: "file1.txt", Checksum: fileContentsChecksum}, nil, nil) exec := cmdtest.SetupCmdForTest(t, NewCmdDownload, false, cmdtest.WithGitLabClient(testClient.Client)) _, err := exec("--all --output-dir=" + destDir) require.NoError(t, err) got, err := os.ReadFile(filepath.Join(destDir, "file1.txt")) require.NoError(t, err) assert.Equal(t, fileContents, string(got)) }) // An absolute --output-dir removes the working-directory root that would // otherwise reject a traversing name, so the name is checked directly. t.Run("absolute --output-dir rejects a traversing server name", func(t *testing.T) { t.Chdir(t.TempDir()) destDir := t.TempDir() // The name below climbs two levels, so this is where it would land if // --output-dir did not confine it. outputDir := filepath.Join(destDir, "a", "b") escaped := filepath.Join(destDir, "outside.txt") testClient := gitlabtesting.NewTestClient(t) // The name is rejected before anything is fetched, so no download or // details call should be made. testClient.MockSecureFiles.EXPECT(). ListProjectSecureFiles(repoName, gomock.Any(), gomock.Any(), gomock.Any()). Return([]*gitlab.SecureFile{{ID: 1, Name: "../../outside.txt", Checksum: fileContentsChecksum}}, &gitlab.Response{}, nil) exec := cmdtest.SetupCmdForTest(t, NewCmdDownload, false, cmdtest.WithGitLabClient(testClient.Client)) _, err := exec("--all --output-dir=" + outputDir) require.Error(t, err) assert.Equal(t, "error downloading secure file '../../outside.txt' (ID: 1): name would write outside the output directory", err.Error()) assert.NoFileExists(t, escaped, "server-supplied name must not escape --output-dir") assert.NoFileExists(t, filepath.Join(outputDir, "outside.txt")) }) }