query

Documentation

Index

• func CheckAuth(workspace string, apiKey string) (bool, error)
• func Detect(img *v1.Image, excludeSelf bool, workspace string, apiKey string) (*[]Image, int, error)
• func ForBaseImageInDb(digest digest.Digest, workspace string, apiKey string) (*[]Image, error)
• func ForBaseImageInIndex(digest digest.Digest, workspace string, apiKey string) (*[]Image, error)
• func ForBaseImageWithoutCve(cve string, name string, img *v1.Image, workspace string, apiKey string) (*[]Image, error)
• func FormatCve(sb *types.Sbom, c *types.Cve)
• func FormatImage(image *Image) string
• func FormatPackageRemediation(p types.Package, c types.Cve) string
• func FormatRemediation(remediation []string)
• func QueryCves(sb *types.Sbom, cve string, workspace string, apiKey string) (*[]types.Cve, error)
• func Tags(image *Image) []string
• type CveResult
• type Image
• type ImageQueryResult
• type IndexImage
• type IndexManifestList
• type ManifestList
• type QueryResult
• type Report
• type Repository
  • func ForRepositoryInDb(repo string, workspace string, apiKey string) (*Repository, error)
• type RepositoryQueryResult

Functions

func CheckAuth

func CheckAuth(workspace string, apiKey string) (bool, error)

func Detect

func Detect(img *v1.Image, excludeSelf bool, workspace string, apiKey string) (*[]Image, int, error)

func ForBaseImageInDb

func ForBaseImageInDb(digest digest.Digest, workspace string, apiKey string) (*[]Image, error)

ForBaseImageInDb returns images with matching digest in :docker.image/blob-digest or :docker.image/diff-chain-id

func ForBaseImageInIndex

func ForBaseImageInIndex(digest digest.Digest, workspace string, apiKey string) (*[]Image, error)

func ForBaseImageWithoutCve

func ForBaseImageWithoutCve(cve string, name string, img *v1.Image, workspace string, apiKey string) (*[]Image, error)

func FormatCve

func FormatCve(sb *types.Sbom, c *types.Cve)

func FormatImage

func FormatImage(image *Image) string

func FormatPackageRemediation

func FormatPackageRemediation(p types.Package, c types.Cve) string

func FormatRemediation

func FormatRemediation(remediation []string)

func QueryCves

func QueryCves(sb *types.Sbom, cve string, workspace string, apiKey string) (*[]types.Cve, error)

func Tags

func Tags(image *Image) []string

Types

type CveResult

type CveResult struct {
	Cves []types.Cve `edn:"cves"`
}

type Image

type Image struct {
	TeamId    string    `edn:"atomist/team-id"`
	Digest    string    `edn:"docker.image/digest"`
	CreatedAt time.Time `edn:"docker.image/created-at"`
	Tags      []string  `edn:"docker.image/tags"`
	Tag       []struct {
		Name string `edn:"docker.tag/name"`
	} `edn:"docker.image/tag"`
	ManifestList []ManifestList `edn:"docker.image/manifest-list"`
	Repository   Repository     `edn:"docker.image/repository"`
	File         struct {
		Path string `edn:"git.file/path"`
	} `edn:"docker.image/file"`
	Commit struct {
		Sha  string `edn:"git.commit/sha"`
		Repo struct {
			Name string `edn:"git.repo/name"`
			Org  struct {
				Name string `edn:"git.org/name"`
			} `edn:"git.repo/org"`
		} `edn:"git.commit/repo"`
	} `edn:"docker.image/commit"`
	Report []Report `edn:"vulnerability.report/report"`
}

type ImageQueryResult

type ImageQueryResult struct {
	Query struct {
		Data [][]Image `edn:"data"`
	} `edn:"query"`
}

type IndexImage

type IndexImage struct {
	Digest    string    `json:"digest"`
	CreatedAt time.Time `json:"createdAt"`
	Platform  struct {
		Os      string `json:"os"`
		Arch    string `json:"arch"`
		Variant string `json:"variant"`
	} `json:"platform"`
	Layers []struct {
		Digest       string    `json:"digest"`
		Size         int       `json:"size"`
		LastModified time.Time `json:"lastModified"`
	} `json:"layers"`
	DigestChainId string `json:"digestChainId"`
	DiffIdChainId string `json:"diffIdChainId"`
}

type IndexManifestList

type IndexManifestList struct {
	Name   string       `json:"name"`
	Tags   []string     `json:"tags"`
	Digest string       `json:"digest"`
	Images []IndexImage `json:"images"`
}

type ManifestList

type ManifestList struct {
	Digest string `edn:"docker.manifest-list/digest"`
	Tags   []struct {
		Name string `edn:"docker.tag/name"`
	} `edn:"docker.manifest-list/tag"`
}

type QueryResult

type QueryResult struct {
	Query struct {
		Data []CveResult `edn:"data"`
	} `edn:"query"`
}

type Report

type Report struct {
	Total       int64 `edn:"vulnerability.report/total"`
	Critical    int64 `edn:"vulnerability.report/critical"`
	High        int64 `edn:"vulnerability.report/high"`
	Medium      int64 `edn:"vulnerability.report/medium"`
	Low         int64 `edn:"vulnerability.report/low"`
	Unspecified int64 `edn:"vulnerability.report/unspecified"`
}

type Repository

type Repository struct {
	Badge         string   `edn:"docker.repository/badge"`
	Host          string   `edn:"docker.repository/host"`
	Name          string   `edn:"docker.repository/name"`
	SupportedTags []string `edn:"docker.repository/supported-tags"`
}

func ForRepositoryInDb

func ForRepositoryInDb(repo string, workspace string, apiKey string) (*Repository, error)

type RepositoryQueryResult

type RepositoryQueryResult struct {
	Query struct {
		Data [][]Repository `edn:"data"`
	} `edn:"query"`
}