Skip to content

[Security] Prevent option injection in checkIfIgnoredInGitRepository #8375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gonzaloriestra wants to merge 1 commit into
base: main
Choose a base branch
from
+34 −1
Draft

[Security] Prevent option injection in checkIfIgnoredInGitRepository #8375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions packages/cli-kit/src/public/node/git.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,3 +538,34 @@ describe('removeGitRemote()', () => {
expect(mockedExeca).not.toHaveBeenCalledWith('git', ['remote', 'remove', remoteName], {cwd: directory})
})
})

describe('checkIfIgnoredInGitRepository()', () => {
test('returns empty array without calling git if files array is empty', async () => {
const directory = '/test/directory'

const result = await git.checkIfIgnoredInGitRepository(directory, [])

expect(result).toEqual([])
expect(mockedExeca).not.toHaveBeenCalled()
})

test('passes -- before file paths to prevent option injection', async () => {
const directory = '/test/directory'
mockGitCommand('file1.txt\n')

const result = await git.checkIfIgnoredInGitRepository(directory, ['file1.txt', '-v'])

expect(mockedExeca).toHaveBeenCalledWith('git', ['check-ignore', '--', 'file1.txt', '-v'], {cwd: directory})
expect(result).toEqual(['file1.txt'])
})

test('returns empty array when git check-ignore exits with code 1', async () => {
const directory = '/test/directory'
const error = Object.assign(new Error('no files ignored'), {exitCode: 1})
mockedExeca.mockRejectedValue(error)

const result = await git.checkIfIgnoredInGitRepository(directory, ['file1.txt'])

expect(result).toEqual([])
})
})
4 changes: 3 additions & 1 deletion packages/cli-kit/src/public/node/git.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,10 @@ export async function initializeGitRepository(directory: string, initialBranch =
* @returns Files ignored by the lockfile.
*/
export async function checkIfIgnoredInGitRepository(directory: string, files: string[]): Promise<string[]> {
if (files.length === 0) return []
try {
const stdout = await gitCommand(['check-ignore', ...files], directory)
// Pass '--' to separate git check-ignore options from file paths and prevent option injection
const stdout = await gitCommand(['check-ignore', '--', ...files], directory)
return stdout.split('\n').filter(Boolean)
} catch (error) {
// git check-ignore exits with code 1 when no files are ignored
Expand Down
Loading