Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
Only scan gist comments or repo comments. (#1646)
ahravd51e3b6d83f3
diff --git a/pkg/sources/github/github.go b/pkg/sources/github/github.goindex bf7157e6e..26e615bb7 100644--- a/pkg/sources/github/github.go+++ b/pkg/sources/github/github.go@@ -988,44 +988,49 @@ func (s *Source) scanComments(ctx context.Context, repoPath string, chunksChan ctrimmedURL := removeURLAndSplit(repoURL.String())if repoURL.Host == "gist.github.com" && s.includeGistComments {- s.log.Info("scanning github gist comments", "repository", repoPath)- // GitHub Gist URL.- var gistId string- if len(trimmedURL) == 2 {- // https://gist.github.com/<id>- gistId = trimmedURL[1]- } else if len(trimmedURL) == 3 {- // https://gist.github.com/<owner>/<id>- gistId = trimmedURL[2]- } else {- return fmt.Errorf("failed to parse Gist URL: '%s'", repoURL.String())- }+ return s.processGistComments(ctx, repoPath, trimmedURL, repoURL, chunksChan)+ }+ return s.processRepoComments(ctx, repoPath, trimmedURL, repoURL, chunksChan)+}- options := &github.ListOptions{- PerPage: defaultPagination,- Page: initialPage,+func (s *Source) processGistComments(ctx context.Context, repoPath string, trimmedURL []string, repoURL *url.URL, chunksChan chan *sources.Chunk) error {+ s.log.Info("scanning github gist comments", "repository", repoPath)+ // GitHub Gist URL.+ gistID, err := extractGistID(trimmedURL)+ if err != nil {+ return err+ }++ options := &github.ListOptions{+ PerPage: defaultPagination,+ Page: initialPage,+ }+ for {+ comments, resp, err := s.apiClient.Gists.ListComments(ctx, gistID, options)+ if s.handleRateLimit(err, resp) {+ break+ }+ if err != nil {+ return err}- for {- comments, resp, err := s.apiClient.Gists.ListComments(ctx, gistId, options)- if s.handleRateLimit(err, resp) {- break- }- if err != nil {- return err- }- err = s.chunkGistComments(ctx, repoURL.String(), comments, chunksChan)- if err != nil {- return err- }+ if err = s.chunkGistComments(ctx, repoURL.String(), comments, chunksChan); err != nil {+ return err+ }- options.Page++- if len(comments) < options.PerPage {- break- }+ options.Page+++ if len(comments) < options.PerPage {+ break}}- return s.processRepoComments(ctx, repoPath, trimmedURL, repoURL, chunksChan)+ return nil+}++func extractGistID(url []string) (string, error) {+ if len(url) < 2 || len(url) > 3 {+ return "", fmt.Errorf("failed to parse Gist URL: length of trimmedURL should be 2 or 3")+ }+ return url[len(url)-1], nil}// Note: these can't be consts because the address is needed when using with the GitHub library.diff --git a/pkg/sources/github/github_test.go b/pkg/sources/github/github_test.goindex 73890bb04..4f5b51294 100644--- a/pkg/sources/github/github_test.go+++ b/pkg/sources/github/github_test.go@@ -743,3 +743,22 @@ func TestProcessRepoComments(t *testing.T) {})}}++func TestGetGistID(t *testing.T) {+ tests := []struct {+ trimmedURL []string+ expected string+ err bool+ }{+ {[]string{"https://gist.github.com", "12345"}, "12345", false},+ {[]string{"https://gist.github.com", "owner", "12345"}, "12345", false},+ {[]string{"https://gist.github.com"}, "", true},+ {[]string{"https://gist.github.com", "owner", "12345", "extra"}, "", true},+ }++ for _, tt := range tests {+ got, err := extractGistID(tt.trimmedURL)+ assert.Equal(t, tt.err, err != nil)+ assert.Equal(t, tt.expected, got)+ }+}