Categorygithub.com/adevinta/vulcan-report
modulepackage
1.0.0
Repository: https://github.com/adevinta/vulcan-report.git
Documentation: pkg.go.dev

# README

Vulcan Report

Package to store models and helper functions for generating and manipulating Vulcan reports.

# Functions

AggregateScore returns an aggregated score for a group of vulnerabilities.
RankSeverity returns the severity rank according to predefined score thresholds.
ScoreSeverity returns the maximum score according to a severity rank.
SecurityStatus returns a grade from A to F (A is good, F is bad) given a target aggregated score.
ValidateReport validates a Report.
ValidateVulnerability validates a Vulnerability.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SeverityCritical defines vulnerabilities with critical impact.
SeverityHigh defines vulnerabilities with high impact.
SeverityLow defines vulnerabilities with low impact.
SeverityMedium defines vulnerabilities with medium impact.
SeverityNone defines interesting findings that are not vulnerabilities.
SeverityThresholdCritical defines vulnerabilities with critical impact.
SeverityThresholdHigh defines vulnerabilities with high impact.
SeverityThresholdLow defines vulnerabilities with low impact.
SeverityThresholdMedium defines vulnerabilities with medium impact.
SeverityThresholdNone defines interesting findings that are not vulnerabilities.

# Structs

Attachment found when running the check.
CheckData defines the data about the execution of the check that generated the report.
Report represents a check vulnerability report.
ResourcesGroup a self-defined table for resources sharing the same attributes.
ResultData contains the data regarding result of the execution of a check, for instance: vulnerabilities, notes, etc.
Vulnerability represents a single security vulnerability found while running a check.

# Type aliases

No description provided by the author
No description provided by the author