Skip to content
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

Jump to bottom

feat: git plugin - option to limit depth of historical scans #118

Merged
merged 10 commits into from
Jun 29, 2023
Merged

feat: git plugin - option to limit depth of historical scans #118

Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2bd6172
add depth option to git plugin
tcdsv Jun 28, 2023
778611b
Merge branch 'master' into git-plugin-limit-depth-of-scan
jossef Jun 28, 2023
7a1b24b
limit depth field scope
tcdsv Jun 28, 2023
6637e56
add --all option to scan all branches
tcdsv Jun 28, 2023
2297445
Merge branch 'master' into git-plugin-limit-depth-of-scan
tcdsv Jun 28, 2023
e5fac38
Merge branch 'git-plugin-limit-depth-of-scan' of https://github.com/t…
tcdsv Jun 28, 2023
2ec9d7e
cleanup
tcdsv Jun 28, 2023
73a892b
improve naming
tcdsv Jun 28, 2023
1f21a73
improve command description
tcdsv Jun 28, 2023
b84808a
Merge branch 'master' into git-plugin-limit-depth-of-scan
Jun 29, 2023
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
30 changes: 26 additions & 4 deletions plugins/git.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,24 @@ package plugins
import (
"fmt"
"os"
"strings"

"github.com/gitleaks/go-gitdiff/gitdiff"
"github.com/rs/zerolog/log"
"github.com/spf13/cobra"
"github.com/zricethezav/gitleaks/v8/detect/git"
)

const (
argDepth = "depth"
argScanAllBranches = "all"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please call it all-branches, otherwise it is not clear all- what?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

)

type GitPlugin struct {
Plugin
Channels
depth int
scanAllBranches bool
}

func (p *GitPlugin) GetName() string {
Expand All @@ -29,15 +37,29 @@ func (p *GitPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
Args: cobra.MatchAll(cobra.ExactArgs(1), validGitRepoArgs),
Run: func(cmd *cobra.Command, args []string) {
log.Info().Msg("Git plugin started")
scanGit(args[0], channels.Items, channels.Errors)
scanGit(args[0], p.buildScanOptions(), channels.Items, channels.Errors)
},
}

flags := command.Flags()
flags.BoolVar(&p.scanAllBranches, argScanAllBranches, false, "scan all branches")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it will print default: false in the help message?

If not, please add [default: false] to the end of the description.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

flags.IntVar(&p.depth, argDepth, 0, "number of commits to scan from HEAD")
return command, nil
}

func scanGit(path string, itemsChan chan Item, errChan chan error) {
fileChan, err := git.GitLog(path, "")
func (p *GitPlugin) buildScanOptions() string {
var options []string
options = append(options, "--full-history")
tcdsv marked this conversation as resolved.
Show resolved Hide resolved
if p.scanAllBranches {
options = append(options, "--all")
}
if p.depth > 0 {
options = append(options, fmt.Sprintf("-n %d", p.depth))
}
return strings.Join(options, " ")
}

func scanGit(path string, scanOptions string, itemsChan chan Item, errChan chan error) {
fileChan, err := git.GitLog(path, scanOptions)
if err != nil {
errChan <- fmt.Errorf("error while scanning git repository: %w", err)
}
Expand Down