clair

package

v1.1.1 Latest Latest Go to latest Published: Aug 20, 2020 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/goharbor/harbor-scanner-clair

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Client
- func NewClient(tlsConfig etc.TLSConfig, cfg etc.ClairConfig) (Client, error)
type Error
type Feature
type Layer
type LayerEnvelope
type Vulnerability

Constants ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	ScanLayer(layer Layer) error
	GetLayer(layerName string) (*LayerEnvelope, error)
	GetVulnerabilityDatabaseUpdatedAt() (*time.Time, error)
}

Client communicates with clair endpoint to scan image and get detailed scan result

func NewClient ¶

func NewClient(tlsConfig etc.TLSConfig, cfg etc.ClairConfig) (Client, error)

NewClient constructs a new client for Clair REST API pointing to the specified endpoint URL.

type Error ¶

type Error struct {
	Message string `json:"Message,omitempty"`
}

Error ...

type Feature ¶

type Feature struct {
	Name            string          `json:"Name,omitempty"`
	NamespaceName   string          `json:"NamespaceName,omitempty"`
	VersionFormat   string          `json:"VersionFormat,omitempty"`
	Version         string          `json:"Version,omitempty"`
	Vulnerabilities []Vulnerability `json:"Vulnerabilities,omitempty"`
	AddedBy         string          `json:"AddedBy,omitempty"`
}

Feature anything that when present in a filesystem could be an indication of a vulnerability (e.g. the presence of a file or an installed software package).

type Layer ¶

type Layer struct {
	Name           string            `json:"Name,omitempty"`
	NamespaceNames []string          `json:"NamespaceNames,omitempty"`
	Path           string            `json:"Path,omitempty"`
	Headers        map[string]string `json:"Headers,omitempty"`
	ParentName     string            `json:"ParentName,omitempty"`
	Format         string            `json:"Format,omitempty"`
	Features       []Feature         `json:"Features,omitempty"`
}

Layer is one of the tarballs used in the composition of an image, often expressed as a filesystem delta from another layer.

type LayerEnvelope ¶

type LayerEnvelope struct {
	Layer *Layer `json:"Layer,omitempty"`
	Error *Error `json:"Error,omitempty"`
}

LayerEnvelope ...

type Vulnerability ¶

type Vulnerability struct {
	Name          string                 `json:"Name,omitempty"`
	NamespaceName string                 `json:"NamespaceName,omitempty"`
	Description   string                 `json:"Description,omitempty"`
	Link          string                 `json:"Link,omitempty"`
	Severity      string                 `json:"Severity,omitempty"`
	Metadata      map[string]interface{} `json:"Metadata,omitempty"`
	FixedBy       string                 `json:"FixedBy,omitempty"`
	FixedIn       []Feature              `json:"FixedIn,omitempty"`
}

Vulnerability ...

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL