-
Notifications
You must be signed in to change notification settings - Fork 315
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into feature/kicsbot-update-queries-docs
- Loading branch information
Showing
5 changed files
with
321 additions
and
6 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| // Package scan implements functions and helpers to ensure the proper scan of the specified files | ||
| package scan | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "github.com/Checkmarx/kics/pkg/engine/secrets" | ||
| "github.com/Checkmarx/kics/pkg/model" | ||
| ) | ||
|
|
||
| func maskPreviewLines(secretsPath string, scanResults *Results) error { | ||
| secretsRegexRulesContent, err := getSecretsRegexRules(secretsPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var allRegexQueries secrets.RegexRuleStruct | ||
|
|
||
| err = json.Unmarshal([]byte(secretsRegexRulesContent), &allRegexQueries) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| allowRules, err := secrets.CompileRegex(allRegexQueries.AllowRules) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| rules, err := compileRegexQueries(allRegexQueries.Rules) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for i := range scanResults.Results { | ||
| item := scanResults.Results[i] | ||
| hideSecret(item.VulnLines, &allowRules, &rules) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func compileRegexQueries(allRegexQueries []secrets.RegexQuery) ([]secrets.RegexQuery, error) { | ||
| for i := range allRegexQueries { | ||
| compiledRegexp, err := regexp.Compile(allRegexQueries[i].RegexStr) | ||
| if err != nil { | ||
| return allRegexQueries, err | ||
| } | ||
| allRegexQueries[i].Regex = compiledRegexp | ||
|
|
||
| for j := range allRegexQueries[i].AllowRules { | ||
| allRegexQueries[i].AllowRules[j].Regex = regexp.MustCompile(allRegexQueries[i].AllowRules[j].RegexStr) | ||
| } | ||
| } | ||
| return allRegexQueries, nil | ||
| } | ||
|
|
||
| func hideSecret(lines *[]model.CodeLine, allowRules *[]secrets.AllowRule, rules *[]secrets.RegexQuery) { | ||
| for idx, line := range *lines { | ||
| for i := range *rules { | ||
| rule := (*rules)[i] | ||
|
|
||
| isSecret, groups := isSecret(line.Line, &rule, allowRules) | ||
| // if not a secret skip to next line | ||
| if !isSecret { | ||
| continue | ||
| } | ||
|
|
||
| if len(rule.Entropies) == 0 { | ||
| maskSecret(&rule, lines, idx) | ||
| } | ||
|
|
||
| if len(groups[0]) > 0 { | ||
| for _, entropy := range rule.Entropies { | ||
| // if matched group does not exist continue | ||
| if len(groups[0]) <= entropy.Group { | ||
| return | ||
| } | ||
| isMatch, _ := secrets.CheckEntropyInterval( | ||
| entropy, | ||
| groups[0][entropy.Group], | ||
| ) | ||
| if isMatch { | ||
| maskSecret(&rule, lines, idx) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func maskSecret(rule *secrets.RegexQuery, lines *[]model.CodeLine, idx int) { | ||
| if rule.SpecialMask == "all" { | ||
| (*lines)[idx].Line = "<SECRET-MASKED-ON-PURPOSE>" | ||
| return | ||
| } | ||
|
|
||
| regex := rule.RegexStr | ||
| line := (*lines)[idx] | ||
|
|
||
| if len(rule.SpecialMask) > 0 { | ||
| regex = "(.+)" + rule.SpecialMask | ||
| } | ||
|
|
||
| var re = regexp.MustCompile(regex) | ||
| match := re.FindString(line.Line) | ||
|
|
||
| if len(rule.SpecialMask) > 0 { | ||
| match = line.Line[len(match):] | ||
| } | ||
|
|
||
| if match != "" { | ||
| (*lines)[idx].Line = strings.Replace(line.Line, match, "<SECRET-MASKED-ON-PURPOSE>", 1) | ||
| } else { | ||
| (*lines)[idx].Line = "<SECRET-MASKED-ON-PURPOSE>" | ||
| } | ||
| } | ||
|
|
||
| // repurposed isSecret from inspector | ||
| func isSecret(line string, rule *secrets.RegexQuery, allowRules *[]secrets.AllowRule) (isSecretRet bool, groups [][]string) { | ||
| if secrets.IsAllowRule(line, *allowRules) { | ||
| return false, [][]string{} | ||
| } | ||
|
|
||
| groups = rule.Regex.FindAllStringSubmatch(line, -1) | ||
|
|
||
| for _, group := range groups { | ||
| splitedText := strings.Split(line, "\n") | ||
| max := -1 | ||
| for i, splited := range splitedText { | ||
| if len(groups) < rule.Multiline.DetectLineGroup { | ||
| if strings.Contains(splited, group[rule.Multiline.DetectLineGroup]) && i > max { | ||
| max = i | ||
| } | ||
| } | ||
| } | ||
| if max == -1 { | ||
| continue | ||
| } | ||
| secret, newGroups := isSecret(strings.Join(append(splitedText[:max], splitedText[max+1:]...), "\n"), rule, allowRules) | ||
| if !secret { | ||
| continue | ||
| } | ||
| groups = append(groups, newGroups...) | ||
| } | ||
|
|
||
| if len(groups) > 0 { | ||
| return true, groups | ||
| } | ||
| return false, [][]string{} | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| package scan | ||
|
|
||
| import ( | ||
| "github.com/Checkmarx/kics/internal/tracker" | ||
| "github.com/Checkmarx/kics/pkg/model" | ||
| "github.com/Checkmarx/kics/pkg/printer" | ||
| "github.com/Checkmarx/kics/pkg/progress" | ||
| "github.com/stretchr/testify/require" | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| func Test_maskSecrets(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| filename string | ||
| scanParameters Parameters | ||
| tracker tracker.CITracker | ||
| scanResults *Results | ||
| }{ | ||
| { | ||
| name: "print with masked secrets", | ||
| filename: "results", | ||
| scanParameters: Parameters{ | ||
| DisableSecrets: true, | ||
| }, | ||
| tracker: tracker.CITracker{ | ||
| FoundFiles: 1, | ||
| FoundCountLines: 9, | ||
| ParsedCountLines: 9, | ||
| ParsedFiles: 1, | ||
| LoadedQueries: 146, | ||
| ExecutingQueries: 146, | ||
| ExecutedQueries: 146, | ||
| FailedSimilarityID: 0, | ||
| Version: model.Version{ | ||
| Latest: true, | ||
| LatestVersionTag: "Dev", | ||
| }, | ||
| }, | ||
| scanResults: &Results{ | ||
| Results: []model.Vulnerability{ | ||
| { | ||
| VulnLines: &[]model.CodeLine{ | ||
| { | ||
| Position: 4, | ||
| Line: " metadata:", | ||
| }, | ||
| { | ||
| Position: 5, | ||
| Line: " name: secret-basic-auth:", | ||
| }, { | ||
| Position: 6, | ||
| Line: " password: \"abcd\"", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| c := Client{} | ||
| c.Tracker = &tt.tracker | ||
| c.ScanParams = &tt.scanParameters | ||
| c.ProBarBuilder = progress.InitializePbBuilder(true, false, true) | ||
| c.Printer = printer.NewPrinter(true) | ||
|
|
||
| err := c.postScan(tt.scanResults) | ||
| require.NoError(t, err) | ||
|
|
||
| for _, line := range (*tt.scanResults).Results { | ||
| for _, vulnLine := range *line.VulnLines { | ||
| if strings.Contains(vulnLine.Line, "password") { | ||
| require.Contains(t, vulnLine.Line, "<SECRET-MASKED-ON-PURPOSE>") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| }) | ||
|
|
||
| } | ||
| } | ||
|
|
||
| func Test_maskSecretsEntropies(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| filename string | ||
| scanParameters Parameters | ||
| tracker tracker.CITracker | ||
| scanResults *Results | ||
| }{ | ||
| { | ||
| name: "not print with masked secrets with invalid entropies", | ||
| filename: "results", | ||
| scanParameters: Parameters{ | ||
| DisableSecrets: true, | ||
| }, | ||
| tracker: tracker.CITracker{ | ||
| FoundFiles: 1, | ||
| FoundCountLines: 9, | ||
| ParsedCountLines: 9, | ||
| ParsedFiles: 1, | ||
| LoadedQueries: 146, | ||
| ExecutingQueries: 146, | ||
| ExecutedQueries: 146, | ||
| FailedSimilarityID: 0, | ||
| Version: model.Version{ | ||
| Latest: true, | ||
| LatestVersionTag: "Dev", | ||
| }, | ||
| }, | ||
| scanResults: &Results{ | ||
| Results: []model.Vulnerability{ | ||
| { | ||
| VulnLines: &[]model.CodeLine{ | ||
| { | ||
| Position: 4, | ||
| Line: "secret = \"eeeeee\"", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| c := Client{} | ||
| c.Tracker = &tt.tracker | ||
| c.ScanParams = &tt.scanParameters | ||
| c.ProBarBuilder = progress.InitializePbBuilder(true, false, true) | ||
| c.Printer = printer.NewPrinter(true) | ||
|
|
||
| err := c.postScan(tt.scanResults) | ||
| require.NoError(t, err) | ||
|
|
||
| for _, line := range (*tt.scanResults).Results { | ||
| for _, vulnLine := range *line.VulnLines { | ||
| require.NotContains(t, vulnLine.Line, "<SECRET-MASKED-ON-PURPOSE>") | ||
|
|
||
| } | ||
| } | ||
|
|
||
| }) | ||
|
|
||
| } | ||
| } |