formats

Documentation

Index

• type ComponentRow
• type ComponentTableRow
  • func ConvertToComponentTableRow(rows []ComponentRow) (tableRows []ComponentTableRow)
• type CveRow
• type CveTableRow
  • func ConvertToCveTableRow(rows []CveRow) (tableRows []CveTableRow)
• type JfrogResearchInformation
• type JfrogResearchSeverityReason
• type LicenseRow
• type LicenseTableRow
  • func ConvertToLicenseTableRow(rows []LicenseRow) (tableRows []LicenseTableRow)
• type LicenseViolationRow
• type LicenseViolationTableRow
  • func ConvertToLicenseViolationTableRow(rows []LicenseViolationRow) (tableRows []LicenseViolationTableRow)
• type OperationalRiskViolationRow
• type OperationalRiskViolationTableRow
  • func ConvertToOperationalRiskViolationTableRow(rows []OperationalRiskViolationRow) (tableRows []OperationalRiskViolationTableRow)
• type SimpleJsonError
• type SimpleJsonResults
• type VulnerabilityOrViolationRow
• type VulnerabilityTableRow
  • func ConvertToVulnerabilityTableRow(rows []VulnerabilityOrViolationRow) (tableRows []VulnerabilityTableRow)

Types

type ComponentRow

type ComponentRow struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type ComponentTableRow

type ComponentTableRow struct {
	Name    string `col-name:"Component"`
	Version string `col-name:"Component\nVersion"`
}

func ConvertToComponentTableRow

func ConvertToComponentTableRow(rows []ComponentRow) (tableRows []ComponentTableRow)

type CveRow

type CveRow struct {
	Id     string `json:"id"`
	CvssV2 string `json:"cvssV2"`
	CvssV3 string `json:"cvssV3"`
}

type CveTableRow

type CveTableRow struct {
	Id     string `col-name:"CVE"`
	CvssV2 string `col-name:"CVSS\nv2" extended:"true"`
	CvssV3 string `col-name:"CVSS\nv3" extended:"true"`
}

func ConvertToCveTableRow

func ConvertToCveTableRow(rows []CveRow) (tableRows []CveTableRow)

type JfrogResearchInformation

type JfrogResearchInformation struct {
	Summary         string                        `json:"summary,omitempty"`
	Details         string                        `json:"details,omitempty"`
	Severity        string                        `json:"severity,omitempty"`
	SeverityReasons []JfrogResearchSeverityReason `json:"severityReasons,omitempty"`
	Remediation     string                        `json:"remediation,omitempty"`
}

type JfrogResearchSeverityReason

type JfrogResearchSeverityReason struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	IsPositive  bool   `json:"isPositive,omitempty"`
}

type LicenseRow

type LicenseRow struct {
	LicenseKey             string           `json:"licenseKey"`
	ImpactedPackageName    string           `json:"impactedPackageName"`
	ImpactedPackageVersion string           `json:"impactedPackageVersion"`
	ImpactedPackageType    string           `json:"impactedPackageType"`
	Components             []ComponentRow   `json:"components"`
	ImpactPaths            [][]ComponentRow `json:"impactPaths"`
}

type LicenseTableRow

type LicenseTableRow struct {
	LicenseKey             string              `col-name:"License"`
	ImpactedPackageName    string              `col-name:"Impacted\nPackage"`
	ImpactedPackageVersion string              `col-name:"Impacted\nPackage\nVersion"`
	ImpactedPackageType    string              `col-name:"Type"`
	Components             []ComponentTableRow `embed-table:"true"`
}

func ConvertToLicenseTableRow

func ConvertToLicenseTableRow(rows []LicenseRow) (tableRows []LicenseTableRow)

type LicenseViolationRow

type LicenseViolationRow struct {
	LicenseKey             string         `json:"licenseKey"`
	Severity               string         `json:"severity"`
	SeverityNumValue       int            `json:"-"` // For sorting
	ImpactedPackageName    string         `json:"impactedPackageName"`
	ImpactedPackageVersion string         `json:"impactedPackageVersion"`
	ImpactedPackageType    string         `json:"impactedPackageType"`
	Components             []ComponentRow `json:"components"`
}

type LicenseViolationTableRow

type LicenseViolationTableRow struct {
	LicenseKey             string              `col-name:"License"`
	Severity               string              `col-name:"Severity"`
	SeverityNumValue       int                 // For sorting
	ImpactedPackageName    string              `col-name:"Impacted\nPackage"`
	ImpactedPackageVersion string              `col-name:"Impacted\nPackage\nVersion"`
	ImpactedPackageType    string              `col-name:"Type"`
	Components             []ComponentTableRow `embed-table:"true"`
}

func ConvertToLicenseViolationTableRow

func ConvertToLicenseViolationTableRow(rows []LicenseViolationRow) (tableRows []LicenseViolationTableRow)

type OperationalRiskViolationRow

type OperationalRiskViolationRow struct {
	Severity               string         `json:"severity"`
	SeverityNumValue       int            `json:"-"` // For sorting
	ImpactedPackageName    string         `json:"impactedPackageName"`
	ImpactedPackageVersion string         `json:"impactedPackageVersion"`
	ImpactedPackageType    string         `json:"impactedPackageType"`
	Components             []ComponentRow `json:"components"`
	RiskReason             string         `json:"riskReason"`
	IsEol                  string         `json:"isEndOfLife"`
	EolMessage             string         `json:"endOfLifeMessage"`
	Cadence                string         `json:"cadence"`
	Commits                string         `json:"commits"`
	Committers             string         `json:"committers"`
	NewerVersions          string         `json:"newerVersions"`
	LatestVersion          string         `json:"latestVersion"`
}

type OperationalRiskViolationTableRow

type OperationalRiskViolationTableRow struct {
	Severity               string              `col-name:"Severity"`
	SeverityNumValue       int                 // For sorting
	ImpactedPackageName    string              `col-name:"Impacted\nPackage"`
	ImpactedPackageVersion string              `col-name:"Impacted\nPackage\nVersion"`
	ImpactedPackageType    string              `col-name:"Type"`
	Components             []ComponentTableRow `embed-table:"true"`
	RiskReason             string              `col-name:"Risk\nReason"`
	IsEol                  string              `col-name:"Is\nEnd\nOf\nLife" extended:"true"`
	EolMessage             string              `col-name:"End\nOf\nLife\nMessage" extended:"true"`
	Cadence                string              `col-name:"Cadence"  extended:"true"`
	Commits                string              `col-name:"Commits"  extended:"true"`
	Committers             string              `col-name:"Committers"  extended:"true"`
	NewerVersions          string              `col-name:"Newer\nVersions" extended:"true"`
	LatestVersion          string              `col-name:"Latest\nVersion" extended:"true"`
}

func ConvertToOperationalRiskViolationTableRow

func ConvertToOperationalRiskViolationTableRow(rows []OperationalRiskViolationRow) (tableRows []OperationalRiskViolationTableRow)

type SimpleJsonError

type SimpleJsonError struct {
	FilePath     string `json:"filePath"`
	ErrorMessage string `json:"errorMessage"`
}

type SimpleJsonResults

type SimpleJsonResults struct {
	Vulnerabilities           []VulnerabilityOrViolationRow `json:"vulnerabilities"`
	SecurityViolations        []VulnerabilityOrViolationRow `json:"securityViolations"`
	LicensesViolations        []LicenseViolationRow         `json:"licensesViolations"`
	Licenses                  []LicenseRow                  `json:"licenses"`
	OperationalRiskViolations []OperationalRiskViolationRow `json:"operationalRiskViolations"`
	Errors                    []SimpleJsonError             `json:"errors"`
}

This struct holds the sorted results of the simple-json output.

type VulnerabilityOrViolationRow

type VulnerabilityOrViolationRow struct {
	Summary                  string                    `json:"summary"`
	Severity                 string                    `json:"severity"`
	SeverityNumValue         int                       `json:"-"` // For sorting
	ImpactedPackageName      string                    `json:"impactedPackageName"`
	ImpactedPackageVersion   string                    `json:"impactedPackageVersion"`
	ImpactedPackageType      string                    `json:"impactedPackageType"`
	FixedVersions            []string                  `json:"fixedVersions"`
	Components               []ComponentRow            `json:"components"`
	Cves                     []CveRow                  `json:"cves"`
	IssueId                  string                    `json:"issueId"`
	References               []string                  `json:"references"`
	ImpactPaths              [][]ComponentRow          `json:"impactPaths"`
	JfrogResearchInformation *JfrogResearchInformation `json:"jfrogResearchInformation"`
	Technology               coreutils.Technology      `json:"-"`
}

Used for vulnerabilities and security violations

type VulnerabilityTableRow

type VulnerabilityTableRow struct {
	Severity               string              `col-name:"Severity"`
	SeverityNumValue       int                 // For sorting
	ImpactedPackageName    string              `col-name:"Impacted\nPackage"`
	ImpactedPackageVersion string              `col-name:"Impacted\nPackage\nVersion"`
	ImpactedPackageType    string              `col-name:"Type"`
	FixedVersions          string              `col-name:"Fixed\nVersions"`
	Components             []ComponentTableRow `embed-table:"true"`
	Cves                   []CveTableRow       `embed-table:"true"`
	IssueId                string              `col-name:"Issue ID" extended:"true"`
}

Used for vulnerabilities and security violations

func ConvertToVulnerabilityTableRow

func ConvertToVulnerabilityTableRow(rows []VulnerabilityOrViolationRow) (tableRows []VulnerabilityTableRow)