Mirrors/trufflehog
2
0
Fork 0
mirror of https://github.com/trufflesecurity/trufflehog.git synced 2024-11-10 07:04:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Skip filtration for targeted scans #3243

Browse source 
There is a scenario in which results filtration is known to cause problems, and this PR disables it in that scenario. (It should cause problems more generally, but lacking any concrete cases of that, I want to tread lightly.)
This commit is contained in:
Cody Rose 2024-08-23 10:59:07 -04:00 committed by GitHub
parent f39a5254ff
commit 8f299ff8cd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
pkg/engine/engine.go
View file

@ -905,7 +905,15 @@ func (e *Engine) verificationOverlapWorker(ctx context.Context) {
detectorKeysWithResults[detector.Key] = detector detectorKeysWithResults[detector.Key] = detector
} }
// If results filtration eliminates a rotated secret, then that rotation will never be reported. This
// problem can theoretically occur for any scan, but we've only actually seen it in practice during
// targeted scans. (The reason for this discrepancy is unclear.) The simplest fix is therefore to
// disable filtration for targeted scans, but if you're here because this problem surfaced for a
// non-targeted scan then we'll have to solve it correctly.
if chunk.chunk.SecretID == 0 {
results = e.filterResults(ctx, detector, results) results = e.filterResults(ctx, detector, results)
}
for _, res := range results { for _, res := range results {
var val []byte var val []byte
if res.RawV2 != nil { if res.RawV2 != nil {
@ -1043,7 +1051,14 @@ func (e *Engine) detectChunk(ctx context.Context, data detectableChunk) {
e.metrics.detectorAvgTime.Store(detectorName, avgTime) e.metrics.detectorAvgTime.Store(detectorName, avgTime)
} }
// If results filtration eliminates a rotated secret, then that rotation will never be reported. This problem
// can theoretically occur for any scan, but we've only actually seen it in practice during targeted scans. (The
// reason for this discrepancy is unclear.) The simplest fix is therefore to disable filtration for targeted
// scans, but if you're here because this problem surfaced for a non-targeted scan then we'll have to solve it
// correctly.
if data.chunk.SecretID == 0 {
results = e.filterResults(ctx, data.detector, results) results = e.filterResults(ctx, data.detector, results)
}
for _, res := range results { for _, res := range results {
e.processResult(ctx, data, res, isFalsePositive) e.processResult(ctx, data, res, isFalsePositive)