validation

Documentation

Index

• type Configuration
  • func NewConfiguration(meta metav1.ObjectMeta, imageReference string, ...) *Configuration
• type Mode
• type PolicySelector
• type ResourceSelector
• type ResourceSelectorType
• type Result
  • func Reduce(results []Result, messagePrefix string) Result
• type Validator
  • func New(configuration Configuration, imageBackend anchore.ImageBackend, ...) (Validator, error)

Types

type Configuration

type Configuration struct {
	Mode            Mode
	PolicyReference anchore.PolicyReference
}

func NewConfiguration

func NewConfiguration(
	meta metav1.ObjectMeta,
	imageReference string,
	policySelectors []PolicySelector,
	clientset kubernetes.Clientset,
) *Configuration

type Mode

type Mode string

const (
	PolicyGateMode   Mode = "policy"
	AnalysisGateMode Mode = "analysis"
	BreakGlassMode   Mode = "breakglass"
)

type PolicySelector

type PolicySelector struct {
	ResourceSelector ResourceSelector `mapstructure:"Selector"`
	Mode             Mode
	PolicyReference  anchore.PolicyReference
}

type ResourceSelector

type ResourceSelector struct {
	Type ResourceSelectorType `mapstructure:"ResourceType"` // The resource to do selection on,
	// supported: pod, namespace
	SelectorKeyRegex   string // The regex to select a matching key
	SelectorValueRegex string // The regex to apply to the label/annotation of the specified resource type
}

type ResourceSelectorType

type ResourceSelectorType string

const (
	GeneralResourceSelectorType   ResourceSelectorType = "resource"
	NamespaceResourceSelectorType ResourceSelectorType = "namespace"
	ImageResourceSelectorType     ResourceSelectorType = "image"
)

type Result

type Result struct {
	Mode        Mode
	IsValid     bool
	Message     string
	ImageDigest string
}

Result is a data structure that describes the evaluation result for a validation operation.

func Reduce

func Reduce(results []Result, messagePrefix string) Result

Reduce takes an arbitrary number of Results as input and reduces them to a single Result. This Result's Message aggregates the input Results' Messages, prefixed with the given messagePrefix. If only a single Result is passed in, the Result is returned as-is (and the messagePrefix is not used).

type Validator

type Validator func() Result

Validator is a function that can be executed to produce a validation Result.

func New

func New(configuration Configuration, imageBackend anchore.ImageBackend, user anchore.Credential,
	imageReference string) (Validator, error)

New returns a validator function with its internal state fully configured. If a validator function cannot be created, New returns an error.