Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
[THOG-709] - Recover from detector panics (#810)
ahrav92f40c20316e
diff --git a/pkg/common/recover.go b/pkg/common/recover.goindex 56888dd0f..da75e330c 100644--- a/pkg/common/recover.go+++ b/pkg/common/recover.go@@ -11,8 +11,22 @@ import ("github.com/trufflesecurity/trufflehog/v3/pkg/context")-// Recover handles panics and reports to Sentry before exiting.+// Recover handles panics and reports to Sentry.func Recover(ctx context.Context) {+ if err := recover(); err != nil {+ panicStack := string(debug.Stack())+ if eventID := sentry.CurrentHub().Recover(err); eventID != nil {+ ctx.Logger().Info("panic captured", "event_id", *eventID)+ }+ fmt.Fprint(os.Stderr, panicStack)+ if !sentry.Flush(time.Second * 5) {+ ctx.Logger().Info("sentry flush failed")+ }+ }+}++// RecoverWithExit handles panics and reports to Sentry before exiting.+func RecoverWithExit(ctx context.Context) {if err := recover(); err != nil {panicStack := string(debug.Stack())if eventID := sentry.CurrentHub().Recover(err); eventID != nil {diff --git a/pkg/engine/engine.go b/pkg/engine/engine.goindex 4b579a9e1..3df37f192 100644--- a/pkg/engine/engine.go+++ b/pkg/engine/engine.go@@ -98,7 +98,7 @@ func Start(ctx context.Context, options ...EngineOption) *Engine {for i := 0; i < e.concurrency; i++ {e.workersWg.Add(1)go func() {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer e.workersWg.Done()e.detectorWorker(ctx)}()@@ -111,7 +111,7 @@ func Start(ctx context.Context, options ...EngineOption) *Engine {// chunks before closing their respective channels. Once Finish is called, no// more sources may be scanned by the engine.func (e *Engine) Finish(ctx context.Context) {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)// wait for the sources to finish putting chunks onto the chunks channele.sourcesWg.Wait()close(e.chunks)@@ -163,7 +163,12 @@ func (e *Engine) detectorWorker(ctx context.Context) {for chunk := range e.chunks {fragStart, mdLine := fragmentFirstLine(chunk)for _, decoder := range e.decoders {- decoded := decoder.FromChunk(chunk)+ decoded := func(ctx context.Context) *sources.Chunk {+ defer func(ctx context.Context) {+ common.Recover(ctx)+ }(ctx)+ return decoder.FromChunk(chunk)+ }(ctx)if decoded == nil {continue}diff --git a/pkg/engine/filesystem.go b/pkg/engine/filesystem.goindex 7823303cc..ea1680525 100644--- a/pkg/engine/filesystem.go+++ b/pkg/engine/filesystem.go@@ -34,7 +34,7 @@ func (e *Engine) ScanFileSystem(ctx context.Context, c sources.Config) error {}e.sourcesWg.Add(1)go func() {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer e.sourcesWg.Done()err := fileSystemSource.Chunks(ctx, e.ChunksChan())if err != nil {diff --git a/pkg/engine/git.go b/pkg/engine/git.goindex 379b90442..c0bd34d45 100644--- a/pkg/engine/git.go+++ b/pkg/engine/git.go@@ -107,7 +107,7 @@ func (e *Engine) ScanGit(ctx context.Context, c sources.Config) error {e.sourcesWg.Add(1)go func() {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer e.sourcesWg.Done()err := gitSource.ScanRepo(ctx, repo, c.RepoPath, scanOptions, e.ChunksChan())if err != nil {diff --git a/pkg/engine/github.go b/pkg/engine/github.goindex 0c8f9d157..7256e7fe6 100644--- a/pkg/engine/github.go+++ b/pkg/engine/github.go@@ -43,7 +43,7 @@ func (e *Engine) ScanGitHub(ctx context.Context, c sources.Config) error {e.sourcesWg.Add(1)go func() {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer e.sourcesWg.Done()err := source.Chunks(ctx, e.ChunksChan())if err != nil {diff --git a/pkg/engine/gitlab.go b/pkg/engine/gitlab.goindex cf3fbfcfc..b5586d2dd 100644--- a/pkg/engine/gitlab.go+++ b/pkg/engine/gitlab.go@@ -52,7 +52,7 @@ func (e *Engine) ScanGitLab(ctx context.Context, c sources.Config) error {e.sourcesWg.Add(1)go func() {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer e.sourcesWg.Done()err := gitlabSource.Chunks(ctx, e.ChunksChan())if err != nil {diff --git a/pkg/engine/s3.go b/pkg/engine/s3.goindex 7c1df9f36..98f9ca721 100644--- a/pkg/engine/s3.go+++ b/pkg/engine/s3.go@@ -54,7 +54,7 @@ func (e *Engine) ScanS3(ctx context.Context, c sources.Config) error {e.sourcesWg.Add(1)go func() {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer e.sourcesWg.Done()err := s3Source.Chunks(ctx, e.ChunksChan())if err != nil {diff --git a/pkg/engine/syslog.go b/pkg/engine/syslog.goindex ff1754ab2..361f3cfe9 100644--- a/pkg/engine/syslog.go+++ b/pkg/engine/syslog.go@@ -52,7 +52,7 @@ func (e *Engine) ScanSyslog(ctx context.Context, c sources.Config) error {e.sourcesWg.Add(1)go func() {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer e.sourcesWg.Done()err := source.Chunks(ctx, e.ChunksChan())if err != nil {diff --git a/pkg/gitparse/gitparse.go b/pkg/gitparse/gitparse.goindex c24eefd1f..86ccb0f3b 100644--- a/pkg/gitparse/gitparse.go+++ b/pkg/gitparse/gitparse.go@@ -142,7 +142,7 @@ func FromReader(ctx context.Context, stdOut io.Reader, commitChan chan Commit) {var currentCommit *Commitvar currentDiff *Diff- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)for {line, err := outReader.ReadBytes([]byte("\n")[0])if err != nil && len(line) == 0 {@@ -313,7 +313,7 @@ func isMinusDiffLine(line []byte) bool {return false}-// fmt.Println("ok")+// fmt.Println("ok")func isContextDiffLine(line []byte) bool {if len(line) >= 1 && bytes.Equal(line[:1], []byte(" ")) {return truediff --git a/pkg/sources/s3/s3.go b/pkg/sources/s3/s3.goindex b4f1dc45b..582740359 100644--- a/pkg/sources/s3/s3.go+++ b/pkg/sources/s3/s3.go@@ -194,7 +194,7 @@ func (s *Source) pageChunker(ctx context.Context, client *s3.S3, chunksChan chan}wg.Add(1)go func(ctx context.Context, wg *sync.WaitGroup, sem *semaphore.Weighted, obj *s3.Object) {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)defer sem.Release(1)defer wg.Done()// defer log.Debugf("DONE - %s", *obj.Key)diff --git a/pkg/sources/syslog/syslog.go b/pkg/sources/syslog/syslog.goindex 11b4784ba..7770f0a51 100644--- a/pkg/sources/syslog/syslog.go+++ b/pkg/sources/syslog/syslog.go@@ -210,7 +210,7 @@ func (s *Source) parseSyslogMetadata(input []byte, remote string) (*source_metad}func (s *Source) monitorConnection(ctx context.Context, conn net.Conn, chunksChan chan *sources.Chunk) {- defer common.Recover(ctx)+ defer common.RecoverWithExit(ctx)for {if common.IsDone(ctx) {return