forked from aquasecurity/trivy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(misconf): Add special output format for misconfigurations (aquas…
- Loading branch information
Showing
11 changed files
with
510 additions
and
257 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
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,156 @@ | ||
| package report | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/liamg/tml" | ||
| "golang.org/x/crypto/ssh/terminal" | ||
|
|
||
| "github.com/aquasecurity/trivy/pkg/types" | ||
| ) | ||
|
|
||
| const ( | ||
| severityCritical = "CRITICAL" | ||
| severityHigh = "HIGH" | ||
| severityMedium = "MEDIUM" | ||
| severityLow = "LOW" | ||
| ) | ||
|
|
||
| type misconfigRenderer struct { | ||
| target string | ||
| misconfs []types.DetectedMisconfiguration | ||
| includeNonFailures bool | ||
| w *bytes.Buffer | ||
| width int | ||
| ansi bool | ||
| } | ||
|
|
||
| func NewMisconfigRenderer(target string, misconfs []types.DetectedMisconfiguration, includeNonFailures bool, ansi bool) *misconfigRenderer { | ||
| width, _, err := terminal.GetSize(0) | ||
| if err != nil || width == 0 { | ||
| width = 40 | ||
| } | ||
| if !ansi { | ||
| tml.DisableFormatting() | ||
| } | ||
| return &misconfigRenderer{ | ||
| w: bytes.NewBuffer([]byte{}), | ||
| target: target, | ||
| misconfs: misconfs, | ||
| includeNonFailures: includeNonFailures, | ||
| width: width, | ||
| ansi: ansi, | ||
| } | ||
| } | ||
|
|
||
| func (r *misconfigRenderer) Render() string { | ||
| for _, m := range r.misconfs { | ||
| r.renderSingle(m) | ||
| } | ||
| return r.w.String() | ||
| } | ||
|
|
||
| func (r *misconfigRenderer) printf(format string, args ...interface{}) { | ||
| // nolint | ||
| _ = tml.Fprintf(r.w, format, args...) | ||
| } | ||
|
|
||
| func (r *misconfigRenderer) printDoubleDivider() { | ||
| r.printf("<dim>%s\r\n", strings.Repeat("═", r.width)) | ||
| } | ||
|
|
||
| func (r *misconfigRenderer) printSingleDivider() { | ||
| r.printf("<dim>%s\r\n", strings.Repeat("─", r.width)) | ||
| } | ||
|
|
||
| func (r *misconfigRenderer) renderSingle(misconf types.DetectedMisconfiguration) { | ||
| r.renderSummary(misconf) | ||
| r.renderCode(misconf) | ||
| r.printf("\r\n\r\n") | ||
| } | ||
|
|
||
| func (r *misconfigRenderer) renderSummary(misconf types.DetectedMisconfiguration) { | ||
|
|
||
| // show pass/fail/exception unless we are only showing failures | ||
| if r.includeNonFailures { | ||
| switch misconf.Status { | ||
| case types.StatusPassed: | ||
| r.printf("<green><bold>%s: ", misconf.Status) | ||
| case types.StatusFailure: | ||
| r.printf("<red><bold>%s: ", misconf.Status) | ||
| case types.StatusException: | ||
| r.printf("<yellow><bold>%s: ", misconf.Status) | ||
| } | ||
| } | ||
|
|
||
| // severity | ||
| switch misconf.Severity { | ||
| case severityCritical: | ||
| r.printf("<red><bold>%s: ", misconf.Severity) | ||
| case severityHigh: | ||
| r.printf("<red>%s: ", misconf.Severity) | ||
| case severityMedium: | ||
| r.printf("<yellow>%s: ", misconf.Severity) | ||
| case severityLow: | ||
| r.printf("%s: ", misconf.Severity) | ||
| default: | ||
| r.printf("<blue>%s: ", misconf.Severity) | ||
| } | ||
|
|
||
| // heading | ||
| r.printf("%s\r\n", misconf.Message) | ||
| r.printDoubleDivider() | ||
|
|
||
| // description | ||
| r.printf("<dim>%s\r\n", misconf.Description) | ||
|
|
||
| // show link if we have one | ||
| if misconf.PrimaryURL != "" { | ||
| r.printf("\r\n<dim>See %s\r\n", misconf.PrimaryURL) | ||
| } | ||
|
|
||
| r.printSingleDivider() | ||
| } | ||
|
|
||
| func (r *misconfigRenderer) renderCode(misconf types.DetectedMisconfiguration) { | ||
| // highlight code if we can... | ||
| if lines := misconf.CauseMetadata.Code.Lines; len(lines) > 0 { | ||
|
|
||
| var lineInfo string | ||
| if misconf.CauseMetadata.StartLine > 0 { | ||
| lineInfo = tml.Sprintf("<dim>:</dim><blue>%d", misconf.CauseMetadata.StartLine) | ||
| if misconf.CauseMetadata.EndLine > misconf.CauseMetadata.StartLine { | ||
| lineInfo = tml.Sprintf("%s<blue>-%d", lineInfo, misconf.CauseMetadata.EndLine) | ||
| } | ||
| } | ||
| r.printf(" <blue>%s%s\r\n", r.target, lineInfo) | ||
| r.printSingleDivider() | ||
| for i, line := range lines { | ||
| if line.Truncated { | ||
| r.printf("<dim>%4s ", strings.Repeat(".", len(fmt.Sprintf("%d", line.Number)))) | ||
| } else if line.IsCause { | ||
| r.printf("<red>%4d ", line.Number) | ||
| switch { | ||
| case (line.FirstCause && line.LastCause) || len(lines) == 1: | ||
| r.printf("<red>[ ") | ||
| case line.FirstCause || i == 0: | ||
| r.printf("<red>┌ ") | ||
| case line.LastCause || i == len(lines)-1: | ||
| r.printf("<red>└ ") | ||
| default: | ||
| r.printf("<red>│ ") | ||
| } | ||
| } else { | ||
| r.printf("<dim>%4d ", line.Number) | ||
| } | ||
| if r.ansi { | ||
| r.printf("%s\r\n", line.Highlighted) | ||
| } else { | ||
| r.printf("%s\r\n", line.Content) | ||
| } | ||
| } | ||
| r.printSingleDivider() | ||
| } | ||
| } |
Oops, something went wrong.