image

Documentation

Overview

Package image provides utilities to work with container images.

Index

• Constants
• func GetImageDigestFromRef(ctx context.Context, imageRef, platform string, cache store.RefCacher) (*interfaces.EntityRef, error)
• type Parser
  • func New() *Parser
  • func (_ *Parser) ConvertToEntityRef(reference string) (*interfaces.EntityRef, error)
  • func (p *Parser) GetRegex() string
  • func (p *Parser) Replace(ctx context.Context, matchedLine string, _ interfaces.REST, cfg config.Config) (*interfaces.EntityRef, error)
  • func (p *Parser) SetCache(cache store.RefCacher)
  • func (p *Parser) SetRegex(regex string)

Constants

const (
	// ContainerImageRegex is regular expression pattern to match container image usage in YAML
	// nolint:lll
	ContainerImageRegex = `image\s*:\s*["']?([^\s"']+/[^\s"']+|[^\s"']+)(:[^\s"']+)?(@[^\s"']+)?["']?|FROM\s+([^\s]+(/[^\s]+)?(:[^\s]+)?(@[^\s]+)?)`

	// ReferenceType is the type of the reference
	ReferenceType = "container"
)

Functions

func GetImageDigestFromRef

func GetImageDigestFromRef(ctx context.Context, imageRef, platform string, cache store.RefCacher) (*interfaces.EntityRef, error)

GetImageDigestFromRef returns the digest of a container image reference from a name.Reference.

Types

type Parser

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

Parser is a struct to replace container image references with digests

func New

func New() *Parser

New creates a new Parser

func (*Parser) ConvertToEntityRef

func (_ *Parser) ConvertToEntityRef(reference string) (*interfaces.EntityRef, error)

ConvertToEntityRef converts a container image reference to an EntityRef

func (*Parser) GetRegex

func (p *Parser) GetRegex() string

GetRegex returns the regular expression pattern to match container image usage

func (*Parser) Replace

func (p *Parser) Replace(
	ctx context.Context,
	matchedLine string,
	_ interfaces.REST,
	cfg config.Config,
) (*interfaces.EntityRef, error)

Replace replaces the container image reference with the digest

func (*Parser) SetCache

func (p *Parser) SetCache(cache store.RefCacher)

SetCache sets the cache to store the image references

func (*Parser) SetRegex

func (p *Parser) SetRegex(regex string)

SetRegex sets the regular expression pattern to match container image usage