clair

Documentation

Index

• Constants
• type API
• type Clair
  • func NewClair(url string, version int, timeout time.Duration) Clair
  • func (c *Clair) Analyse(image *docker.Image) ([]*Vulnerability, error)
  • func (c *Clair) Annotate(image *docker.Image) ([]*Feature, error)
• type Feature
• type Vulnerability

Constants

const EMPTY_LAYER_BLOB_SUM = "sha256:a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4"

Types

type API

type API interface {
	Annotate(image *docker.Image) ([]*Feature, error)
	Analyze(image *docker.Image) ([]*Vulnerability, error)
	Push(image *docker.Image) error
}

type Clair

type Clair struct {
	// contains filtered or unexported fields
}

Clair is representation of Clair server

func NewClair

func NewClair(url string, version int, timeout time.Duration) Clair

NewClair construct Clair entity using potentially incomplete server URL If protocol is missing HTTP will be used. If port is missing 6060 will be used

func (*Clair) Analyse

func (c *Clair) Analyse(image *docker.Image) ([]*Vulnerability, error)

Analyse sent each layer from Docker image to Clair and returns a list of found vulnerabilities

func (*Clair) Annotate

func (c *Clair) Annotate(image *docker.Image) ([]*Feature, error)

Analyse sent each layer from Docker image to Clair and returns a list of found vulnerabilities

type Feature

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

type Vulnerability

type Vulnerability struct {
	Name           string                 `json:"Name,omitempty" predicate:"rdfs:label"`
	Description    string                 `json:"Description,omitempty" predicate:"vocab:description"`
	Link           string                 `json:"Link,omitempty" predicate:"vocab:link"`
	Severity       string                 `json:"Severity,omitempty" predicate:"vocab:severity"`
	Metadata       map[string]interface{} `json:"Metadata,omitempty" predicate:"vocab:metadata"`
	NamespaceName  string                 `json:"NamespaceName,omitempty"`
	FixedBy        string                 `json:"FixedBy,omitempty"`
	FixedIn        []Feature              `json:"FixedIn,omitempty"`
	FeatureName    string                 `json:"featureName",omitempty"`
	FeatureVersion string                 `json:"featureName",omitempty"`
}

Vulnerability represents vulnerability entity returned by Clair