feat(secret): enhance secret scanning for python binary files #7223
Conversation
This file contains 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
afdesk
changed the title
afdesk
changed the title
knqyf263
reviewed
Aug 16, 2024
pkg/fanal/utils/utils.go
Outdated
| printalbe = append(printalbe, byte(' ')) | ||
| wasReadable = true | ||
| } | ||
| printalbe = append(printalbe, current[0]) |
There was a problem hiding this comment.
This implementation concats all single printable characters, leading to the long string. Even in a binary file, there are many printable character strings when viewed on a per-byte basis. I think the strings way, setting the minimum length, is better like I shared.
pkg/fanal/analyzer/secret/secret.go
Outdated
| @@ -63,6 +66,10 @@ func init() { | |||
| analyzer.RegisterAnalyzer(NewSecretAnalyzer(secret.Scanner{}, "")) | |||
| } | |||
|
|
|||
| func isAllowedBinary(filename string) bool { | |||
There was a problem hiding this comment.
What if we omit the is prefix?
Suggested change
| func isAllowedBinary(filename string) bool { | |
| func allowedBinary(filename string) bool { |
pkg/fanal/secret/scanner.go
Outdated
Comment on lines
439
to
454
| if args.Binary { | ||
| for _, match := range matched { | ||
| findings = append(findings, types.SecretFinding{ | ||
| RuleID: match.Rule.ID, | ||
| Category: match.Rule.Category, | ||
| Severity: lo.Ternary(match.Rule.Severity == "", "UNKNOWN", match.Rule.Severity), | ||
| Title: match.Rule.Title, | ||
| Match: fmt.Sprintf("Binary file %q matches a rule %q", args.FilePath, match.Rule.Title), | ||
| StartLine: 1, | ||
| EndLine: 1, | ||
| }) | ||
| } | ||
| } else { | ||
| for _, match := range matched { | ||
| findings = append(findings, toFinding(match.Rule, match.Location, censored)) | ||
| } |
There was a problem hiding this comment.
I sugest to use toFinding function.
something like this:
Suggested change
| if args.Binary { | |
| for _, match := range matched { | |
| findings = append(findings, types.SecretFinding{ | |
| RuleID: match.Rule.ID, | |
| Category: match.Rule.Category, | |
| Severity: lo.Ternary(match.Rule.Severity == "", "UNKNOWN", match.Rule.Severity), | |
| Title: match.Rule.Title, | |
| Match: fmt.Sprintf("Binary file %q matches a rule %q", args.FilePath, match.Rule.Title), | |
| StartLine: 1, | |
| EndLine: 1, | |
| }) | |
| } | |
| } else { | |
| for _, match := range matched { | |
| findings = append(findings, toFinding(match.Rule, match.Location, censored)) | |
| } | |
| for _, match := range matched { | |
| finding := toFinding(match.Rule, match.Location, censored) | |
| // These fields will be unreadable for binaries, | |
| // Therefore overwrite them. | |
| if args.Binary { | |
| finding.Match = fmt.Sprintf("Binary file %q matches a rule %q", args.FilePath, match.Rule.Title) | |
| finding.Code = types.Code{} | |
| } | |
| findings = append(findings, finding) | |
| } |
It might make sense to add flag to toFinding function to skip findLocation.
wdyt?
There was a problem hiding this comment.
sure! it's a better way!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Notes
this way doesn't detect secrets inside
.odt(LibreOffice format) and.pdf.Demo file:
$ python3 -m compileall .Before:
After:
Related issues
Checklist