models

Documentation

Overview

Package models contains structs and interfaces used by bomber

Index

• type Credentials
• type Enricher
• type Epss
• type EpssScore
• type FailSeverity
• type Issue
• type Meta
• type Package
• type Provider
• type Renderer
• type Results
  • func NewResults(packages []Package, summary Summary, scanned []ScannedFile, licenses []string, ...) Results
• type ScannedFile
• type Summary
• type Vulnerability

Types

type Credentials

type Credentials struct {
	Username string
	Token    string
}

Credentials the user credentials used by a provider to authenticate to an API

type Enricher

type Enricher interface {
	Enrich(vulnerabilities []Vulnerability) (enriched []Vulnerability, err error)
}

Enricher defines methods that can enrich a collection of vulnerabilities

type Epss

type Epss struct {
	Status     string      `json:"status,omitempty"`
	StatusCode int64       `json:"status-code,omitempty"`
	Version    string      `json:"version,omitempty"`
	Access     string      `json:"access,omitempty"`
	Total      int64       `json:"total,omitempty"`
	Offset     int64       `json:"offset,omitempty"`
	Limit      int64       `json:"limit,omitempty"`
	Scores     []EpssScore `json:"data,omitempty"`
}

Epss encapsulates the response of a query to the Epss scoring API

type EpssScore

type EpssScore struct {
	Cve        string `json:"cve,omitempty"`
	Epss       string `json:"epss,omitempty"`
	Percentile string `json:"percentile,omitempty"`
	Date       string `json:"date,omitempty"`
}

EpssScore contains epss score data for a specific CVE

type FailSeverity

type FailSeverity int

const (
	UNDEFINED FailSeverity = 10
	LOW       FailSeverity = 11
	MODERATE  FailSeverity = 12
	HIGH      FailSeverity = 13
	CRITICAL  FailSeverity = 14
)

type Issue

type Issue struct {
	Err       error  `json:"error,omitempty"`
	IssueType string `json:"issueType,omitempty"`
	Purl      string `json:"purl,omitempty"`
	Message   string `json:"message,omitempty"`
}

Issue encapsulates an issue with the processing of an SBOM

type Meta

type Meta struct {
	Generator      string    `json:"generator"`
	URL            string    `json:"url"`
	Version        string    `json:"version"`
	Provider       string    `json:"provider"`
	SeverityFilter string    `json:"severityFilter"`
	Date           time.Time `json:"date"`
}

Meta contains system and execution information about the results from bomber

type Package

type Package struct {
	Purl            string          `json:"coordinates"`
	Reference       string          `json:"reference,omitempty"`
	Description     string          `json:"description,omitempty"`
	Vulnerabilities []Vulnerability `json:"vulnerabilities"`
}

Package encapsulates information about a package/component and it's vulnerabilities

type Provider

type Provider interface {
	Info() string
	Scan(purls []string, credentials *Credentials) (packages []Package, err error)
}

Provider defines the methods that a provider must contain

type Renderer

type Renderer interface {
	Render(results Results) error
}

Renderer defines the methods that a renderer must contain

type Results

type Results struct {
	Meta     Meta          `json:"meta,omitempty"`
	Files    []ScannedFile `json:"files,omitempty"`
	Licenses []string      `json:"licenses,omitempty"`
	Summary  Summary       `json:"summary,omitempty"`
	Packages []Package     `json:"packages,omitempty"`
}

Results is the high level JSON object used to define vulnerabilities processed by bomber.

func NewResults

func NewResults(packages []Package, summary Summary, scanned []ScannedFile, licenses []string, version, providerName string, severityFilter string) Results

NewResults defines the high level output of bomber

type ScannedFile

type ScannedFile struct {
	Name   string `json:"name"`
	SHA256 string `json:"sha256"`
}

ScannedFile contains the absolute name and sha256 of a processed file

type Summary

type Summary struct {
	Unspecified int
	Low         int
	Moderate    int
	High        int
	Critical    int
}

Summary is a struct used to keep track of severity counts

type Vulnerability

type Vulnerability struct {
	ID                 string        `json:"id,omitempty"`
	DisplayName        string        `json:"displayName,omitempty"`
	Title              string        `json:"title,omitempty"`
	Description        string        `json:"description,omitempty"`
	CvssScore          float64       `json:"cvssScore,omitempty"`
	CvssVector         string        `json:"cvssVector,omitempty"`
	Cwe                string        `json:"cwe,omitempty"`
	Cve                string        `json:"cve,omitempty"`
	Reference          string        `json:"reference,omitempty"`
	ExternalReferences []interface{} `json:"externalReferences,omitempty"`
	Severity           string        `json:"severity,omitempty"`
	Epss               EpssScore     `json:"epss,omitempty"`
}

Vulnerability encapsulates the information describing a detected vulnerability