schema

Documentation

Index

• type Fix
• type Meta
• type Outdated
• type Package
• type PackageManager
• type Report
  • func (r *Report) ComputeSummary()
• type Runtime
• type Severity
• type Status
• type Summary
• type VulnSummary
• type Vulnerability

Types

type Fix

type Fix struct {
	Type    string `json:"type"` // upgrade | remove | replace
	Command string `json:"command"`
}

type Meta

type Meta struct {
	Version    string    `json:"version"`
	Timestamp  time.Time `json:"timestamp"`
	Target     string    `json:"target"`
	Path       string    `json:"path,omitempty"`
	DurationMs int64     `json:"duration_ms"`
	OS         string    `json:"os,omitempty"`
	OSVersion  string    `json:"os_version,omitempty"`
	Arch       string    `json:"arch,omitempty"`
	Chip       string    `json:"chip,omitempty"`
}

type Outdated

type Outdated struct {
	Name      string   `json:"name"`
	Current   string   `json:"current"`
	Latest    string   `json:"latest"`
	Ecosystem string   `json:"ecosystem"`
	Severity  Severity `json:"severity"` // patch | minor | major (reusing type)
}

type Package

type Package struct {
	Name      string   `json:"name"`
	Version   string   `json:"version"`
	Latest    string   `json:"latest,omitempty"`
	Ecosystem string   `json:"ecosystem"`
	Scope     string   `json:"scope"` // global | project
	Direct    bool     `json:"direct"`
	Path      string   `json:"path,omitempty"`
	Parents   []string `json:"parents,omitempty"` // packages that pulled this in as a transitive dep
}

type PackageManager

type PackageManager struct {
	Name      string `json:"name"`
	Version   string `json:"version"`
	Global    bool   `json:"global"`
	Ecosystem string `json:"ecosystem"`
}

type Report

type Report struct {
	Meta            Meta              `json:"meta"`
	System          map[string]string `json:"system"`
	Projects        []string          `json:"projects,omitempty"`
	Runtimes        []Runtime         `json:"runtimes"`
	PackageManagers []PackageManager  `json:"package_managers"`
	Packages        []Package         `json:"packages"`
	Vulnerabilities []Vulnerability   `json:"vulnerabilities"`
	Outdated        []Outdated        `json:"outdated"`
	Summary         Summary           `json:"summary"`
}

func (*Report) ComputeSummary

func (r *Report) ComputeSummary()

type Runtime

type Runtime struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Latest  string `json:"latest,omitempty"`
	Status  Status `json:"status"`
	Path    string `json:"path"`
}

type Severity

type Severity string

const (
	SeverityCritical Severity = "critical"
	SeverityHigh     Severity = "high"
	SeverityMedium   Severity = "medium"
	SeverityLow      Severity = "low"
	SeverityUnknown  Severity = "unknown"
)

type Status

type Status string

const (
	StatusOK       Status = "ok"
	StatusOutdated Status = "outdated"
	StatusEOL      Status = "eol"
	StatusUnknown  Status = "unknown"
)

type Summary

type Summary struct {
	Runtimes        int         `json:"runtimes"`
	Packages        int         `json:"packages"`
	Vulnerabilities VulnSummary `json:"vulnerabilities"`
	Outdated        int         `json:"outdated"`
}

type VulnSummary

type VulnSummary struct {
	Critical int `json:"critical"`
	High     int `json:"high"`
	Medium   int `json:"medium"`
	Low      int `json:"low"`
	Unknown  int `json:"unknown"`
}

type Vulnerability

type Vulnerability struct {
	ID               string   `json:"id"`
	Package          string   `json:"package"`
	Ecosystem        string   `json:"ecosystem"`
	InstalledVersion string   `json:"installed_version"`
	Paths            []string `json:"paths,omitempty"`
	Parents          []string `json:"parents,omitempty"` // direct packages that pulled this in
	Severity         Severity `json:"severity"`
	Title            string   `json:"title"`
	Description      string   `json:"description,omitempty"`
	FixedIn          string   `json:"fixed_in,omitempty"`
	References       []string `json:"references,omitempty"`
	Fix              *Fix     `json:"fix,omitempty"`
}