fix: add git worktree support in PrepareRepo #4690
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes trufflesecurity#4553 The issue was introduced in v3.90.10 by PR trufflesecurity#4502 which added local git config sanitization. When scanning a local file:// repository, the code copies the git index file to support staged changes scanning. However, it assumed .git is always a directory. In git worktrees, .git is a file containing a "gitdir: <path>" reference to the actual git directory location. This caused the error: "failed to read index file: open .../.git/index: not a directory" This commit adds a resolveGitDir() helper function that: - Checks if .git is a file or directory - If it's a file (worktree), parses the gitdir reference - Returns the resolved path to the actual git directory The PrepareRepo() function now uses this helper to correctly locate the index file in both regular repositories and worktrees.
Explicitly discard the error return value from os.RemoveAll in deferred cleanup to satisfy the errcheck linter.
Author
Testing locally
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Fixes #4553 - TruffleHog fails when scanning git worktrees with error "failed to read index file: .../.git/index: not a directory".
Root Cause:
In git worktrees,
.gitis a file containing agitdir: <path>reference, not a directory. ThePrepareRepo()function assumed.gitwas always a directory when copying the index file.Solution:
Added
resolveGitDir()helper function that:.gitis a file or directorygitdir:referenceThis allows TruffleHog to correctly scan staged changes in git worktrees.
Checklist:
make test-community)?make lint)?