types

Documentation

Index

• Constants
• func GetDockerOption(timeout time.Duration) (types.DockerOption, error)
• type BySeverity
  • func (v BySeverity) Len() int
  • func (v BySeverity) Less(i, j int) bool
  • func (v BySeverity) Swap(i, j int)
• type DetectedMisconfiguration
• type DetectedVulnerability
• type DockerConfig
• type Library
• type MisconfStatus
• type ScanOptions
• type SecurityCheck
  • func NewSecurityCheck(s string) SecurityCheck
• type VulnType
  • func NewVulnType(s string) VulnType

Constants

const (
	// VulnTypeUnknown is a vulnerability type of unknown
	VulnTypeUnknown = VulnType("unknown")

	// VulnTypeOS is a vulnerability type of OS packages
	VulnTypeOS = VulnType("os")

	// VulnTypeLibrary is a vulnerability type of programming language dependencies
	VulnTypeLibrary = VulnType("library")

	// SecurityCheckUnknown is a security check of unknown
	SecurityCheckUnknown = SecurityCheck("unknown")

	// SecurityCheckVulnerability is a security check of vulnerabilities
	SecurityCheckVulnerability = SecurityCheck("vuln")

	// SecurityCheckConfig is a security check of misconfigurations
	SecurityCheckConfig = SecurityCheck("config")
)

Functions

func GetDockerOption

func GetDockerOption(timeout time.Duration) (types.DockerOption, error)

GetDockerOption returns the Docker scanning options using DockerConfig

Types

type BySeverity

type BySeverity []DetectedVulnerability

BySeverity implements sort.Interface based on the Severity field.

func (BySeverity) Len

func (v BySeverity) Len() int

Len returns the length of DetectedVulnerabilities

func (BySeverity) Less

func (v BySeverity) Less(i, j int) bool

Less compares 2 DetectedVulnerabilities based on package name, severity and vulnerabilityID

func (BySeverity) Swap

func (v BySeverity) Swap(i, j int)

Swap swaps 2 vulnerability

type DetectedMisconfiguration

type DetectedMisconfiguration struct {
	Type        string             `json:",omitempty"`
	ID          string             `json:",omitempty"`
	Title       string             `json:",omitempty"`
	Description string             `json:",omitempty"`
	Message     string             `json:",omitempty"`
	Namespace   string             `json:",omitempty"`
	Query       string             `json:",omitempty"`
	Resolution  string             `json:",omitempty"`
	Severity    string             `json:",omitempty"`
	PrimaryURL  string             `json:",omitempty"`
	References  []string           `json:",omitempty"`
	Status      MisconfStatus      `json:",omitempty"`
	Layer       ftypes.Layer       `json:",omitempty"`
	IacMetadata ftypes.IacMetadata `json:",omitempty"`

	// For debugging
	Traces []string `json:",omitempty"`
}

DetectedMisconfiguration holds detected misconfigurations

type DetectedVulnerability

type DetectedVulnerability struct {
	VulnerabilityID  string       `json:",omitempty"`
	VendorIDs        []string     `json:",omitempty"`
	PkgName          string       `json:",omitempty"`
	PkgPath          string       `json:",omitempty"` // It will be filled in the case of language-specific packages such as egg/wheel and gemspec
	InstalledVersion string       `json:",omitempty"`
	FixedVersion     string       `json:",omitempty"`
	Layer            ftypes.Layer `json:",omitempty"`
	SeveritySource   string       `json:",omitempty"`
	PrimaryURL       string       `json:",omitempty"`

	// Custom is for extensibility and not supposed to be used in OSS
	Custom interface{} `json:",omitempty"`

	// Embed vulnerability details
	types.Vulnerability
}

DetectedVulnerability holds the information of detected vulnerabilities

type DockerConfig

type DockerConfig struct {
	UserName      string `env:"TRIVY_USERNAME"`
	Password      string `env:"TRIVY_PASSWORD"`
	RegistryToken string `env:"TRIVY_REGISTRY_TOKEN"`
	Insecure      bool   `env:"TRIVY_INSECURE" envDefault:"false"`
	NonSSL        bool   `env:"TRIVY_NON_SSL" envDefault:"false"`
}

DockerConfig holds the config of Docker

type Library

type Library struct {
	Name    string
	Version string
}

Library holds the attribute of a package library

type MisconfStatus

type MisconfStatus string

MisconfStatus represents a status of misconfiguration

const (
	// StatusPassed represents successful status
	StatusPassed MisconfStatus = "PASS"

	// StatusFailure represents failure status
	StatusFailure MisconfStatus = "FAIL"

	// StatusException Passed represents the status of exception
	StatusException MisconfStatus = "EXCEPTION"
)

type ScanOptions

type ScanOptions struct {
	VulnType            []string
	SecurityChecks      []string
	ScanRemovedPackages bool
	ListAllPackages     bool
}

ScanOptions holds the attributes for scanning vulnerabilities

type SecurityCheck

type SecurityCheck = string

SecurityCheck represents the type of security check

func NewSecurityCheck

func NewSecurityCheck(s string) SecurityCheck

NewSecurityCheck returns an instance of SecurityCheck

type VulnType

type VulnType = string

VulnType represents vulnerability type

func NewVulnType

func NewVulnType(s string) VulnType

NewVulnType returns an instance of VulnType