feat: add metrics #9
Open
Conversation
This file contains hidden or 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
Open
afdesk
requested changes
Apr 23, 2023
csv.tpl
Outdated
Comment on lines
13
to
78
| {{- if isFieldAvailable "Vulnerability Class" }} | ||
| {{- printf "%s" $class | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Target Type" }} | ||
| {{- $vulnerabilityType | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Vulnerability ID" }} | ||
| {{- .VulnerabilityID | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Severity" }} | ||
| {{- .Vulnerability.Severity | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "PackageName" }} | ||
| {{- .PkgName | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Installed Version" }} | ||
| {{- .InstalledVersion | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Fixed Version" }} | ||
| {{- .FixedVersion | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Title" }} | ||
| {{- if (eq (len .Title) 0) }} | ||
| {{- printf "%s: %s - %s severity vulnerability" .PkgName .InstalledVersion .Vulnerability.Severity | escapeCsv }}, | ||
| {{- else }} | ||
| {{- abbrev 100 .Title | escapeCsv }}, | ||
| {{- end }} | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Description" }} | ||
| {{- abbrev 500 .Vulnerability.Description | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Resolution" }} | ||
| {{- if .FixedVersion }} | ||
| {{- printf "Update %s to version %s or higher." .PkgName .FixedVersion | escapeCsv }}, | ||
| {{- else }} | ||
| {{- printf "No resolution provided." | escapeCsv }}, | ||
| {{- end }} | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Reference" }} | ||
| {{- .PrimaryURL | escapeCsv }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
| {{- if isFieldAvailable "Additional Reference" }} | ||
| {{- $reference := false }} | ||
| {{- range .References }} | ||
| {{- if contains "nvd.nist.gov" . }} | ||
| {{- . | escapeCsv }} | ||
| {{- $reference = true }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- if not $reference }} | ||
| {{- printf "" | escapeCsv }} | ||
| {{- end }}, | ||
| {{- else -}} | ||
| {{- end }} | ||
|
|
Owner
There was a problem hiding this comment.
it seems this template was copied from Trivy.
csv-report should implement the single feature.
so we can move any logic to main.go, the template will save the table only.
maybe simple formatting only like printf "%.1f"
main.go
Outdated
| tempTemplateFileName = "csv-report-template-temp.tpl" | ||
| templateFileName = "csv.tpl" | ||
| availableFields = []string{"Target", "Vulnerability Class", "Target Type", "Vulnerability ID", "Severity", "PackageName", "Installed Version", "Fixed Version", "Title", "Description", "Resolution", "Reference", "Additional Reference", "CVSS V3 Score", "CVSS V3 Vector"} | ||
| availableFlags = []string{"--csv-result", "--delimiter", "--include", "--exclude"} |
Owner
There was a problem hiding this comment.
let's use more specific names for the flags: --csv-delimiter, --csv-include, --csv-exclude
nikpivkin
requested changes
Apr 26, 2023
| if availableFieldsMap["cvss v3 vector"] { | ||
| fieldValue := "" | ||
| if cvssRh.V3Vector != "" { | ||
| fieldValue = cvssNvd.V3Vector |
Collaborator
There was a problem hiding this comment.
here should be the following:
fieldValue = cvssRh.V3Vector| trivyCommand := os.Args[1 : len(os.Args)-1] | ||
| outputFileName := os.Args[len(os.Args)-1] | ||
| tempFileName := filepath.Join(os.TempDir(), tempJsonFileName) | ||
| trivyCommand := excludePluginFlags(os.Args, availableFlags)[1:] |
Collaborator
There was a problem hiding this comment.
now the plugin and trivy arguments can be obtained using the package github.com/afdesk/trivy-go-plugin/pkg/common
| tempTemplate, err := getChangedDelimiterTemplate() | ||
| if err != nil { | ||
| panic(err) | ||
| return "", nil |
Collaborator
There was a problem hiding this comment.
why is nil returned and not an error?
| if delimiter == "," { | ||
| ex, err := os.Executable() | ||
| if err != nil { | ||
| return "", nil |
Collaborator
There was a problem hiding this comment.
why is nil returned and not an error?
| availableFieldsMap[strings.ToLower(name)] = true | ||
| } | ||
|
|
||
| if includeFlagValue != "" { |
Collaborator
There was a problem hiding this comment.
I would simplify this by using a single loop
var include bool
var argValue string
if includeFlagValue != "" {
include = true
argValue = includeFlagValue
} else if excludeFlagValue != "" {
include = false
argValue = excludeFlagValue
} else {
return
}
for ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
--delimitersets the delimiter, by default ",".If
--includeis specified, only the fields specified in this flag will be included.If
--excludeis specified, all fields except those specified in the flag will be shown.to specify the file in which the result will be saved, you need to specify the
--csv-resultflag--includeand--excludeflags at the same time--csv-resultis not specified, will be set the default value "result.csv"