policy

Documentation

Overview

Package policy implements cluster policy rules and policy evaluation features

Index

• type CloneFn
• type GKEPolicyAgent
  • func (pa *GKEPolicyAgent) Compile(files []*PolicyFile) error
  • func (pa *GKEPolicyAgent) Evaluate(input interface{}, packageBase string) (*PolicyEvaluationResult, error)
  • func (pa *GKEPolicyAgent) GetPolicies() []*Policy
  • func (pa *GKEPolicyAgent) ParseCompiled() []error
  • func (pa *GKEPolicyAgent) WithFiles(files []*PolicyFile, excludes cfg.ConfigPolicyExclusions) error
• type GitClient
• type GitPolicyFile
• type GitPolicySource
  • func (src GitPolicySource) GetPolicyFiles() ([]*PolicyFile, error)
  • func (src GitPolicySource) String() string
• type GitTree
• type GitTreeWalker
• type LocalPolicySource
  • func (src LocalPolicySource) GetPolicyFiles() ([]*PolicyFile, error)
  • func (src LocalPolicySource) String() string
• type Policy
  • func NewPolicyFromEvalResult(result *RegoEvaluationResult, errors []error) *Policy
  • func (p Policy) MetadataErrors() []string
• type PolicyAgent
  • func NewPolicyAgent(ctx context.Context) PolicyAgent
• type PolicyEvaluationResult
• type PolicyFile
• type PolicySource
  • func NewGitPolicySource(repoURL string, repoBrach string, policyDir string) PolicySource
  • func NewLocalPolicySource(rootDirectory string) PolicySource
• type ReadFn
• type RegoEvaluationResult
• type WalkFn

Types

type CloneFn

type CloneFn func(s storage.Storer, worktree billy.Filesystem, o *git.CloneOptions) (*git.Repository, error)

type GKEPolicyAgent

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

func (*GKEPolicyAgent) Compile

func (pa *GKEPolicyAgent) Compile(files []*PolicyFile) error

func (*GKEPolicyAgent) Evaluate

func (pa *GKEPolicyAgent) Evaluate(input interface{}, packageBase string) (*PolicyEvaluationResult, error)

func (*GKEPolicyAgent) GetPolicies

func (pa *GKEPolicyAgent) GetPolicies() []*Policy

func (*GKEPolicyAgent) ParseCompiled

func (pa *GKEPolicyAgent) ParseCompiled() []error

func (*GKEPolicyAgent) WithFiles

func (pa *GKEPolicyAgent) WithFiles(files []*PolicyFile, excludes cfg.ConfigPolicyExclusions) error

type GitClient

type GitClient interface {
	Clone(s storage.Storer, worktree billy.Filesystem, o *git.CloneOptions) (*git.Repository, error)
}

type GitPolicyFile

type GitPolicyFile struct {
	Hash string
	*PolicyFile
}

type GitPolicySource

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

func (GitPolicySource) GetPolicyFiles

func (src GitPolicySource) GetPolicyFiles() ([]*PolicyFile, error)

func (GitPolicySource) String

func (src GitPolicySource) String() string

type GitTree

type GitTree interface {
	TreeEntryFile(e *object.TreeEntry) (*object.File, error)
}

type GitTreeWalker

type GitTreeWalker interface {
	Next() (name string, entry object.TreeEntry, err error)
	Close()
}

type LocalPolicySource

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

func (LocalPolicySource) GetPolicyFiles

func (src LocalPolicySource) GetPolicyFiles() ([]*PolicyFile, error)

func (LocalPolicySource) String

func (src LocalPolicySource) String() string

type Policy

type Policy struct {
	Name             string
	File             string
	Title            string
	Description      string
	Group            string
	Severity         string
	Category         string
	Valid            bool
	Violations       []string
	ProcessingErrors []error
	CisVersion       string
	CisID            string
	ExternalURI      string
	Recommendation   string
}

func NewPolicyFromEvalResult

func NewPolicyFromEvalResult(result *RegoEvaluationResult, errors []error) *Policy

func (Policy) MetadataErrors

func (p Policy) MetadataErrors() []string

type PolicyAgent

type PolicyAgent interface {
	Compile(files []*PolicyFile) error
	WithFiles(files []*PolicyFile, excludes cfg.ConfigPolicyExclusions) error
	Evaluate(input interface{}, packageBase string) (*PolicyEvaluationResult, error)
	GetPolicies() []*Policy
}

func NewPolicyAgent

func NewPolicyAgent(ctx context.Context) PolicyAgent

type PolicyEvaluationResult

type PolicyEvaluationResult struct {
	ClusterID string
	Policies  []*Policy
}

type PolicyFile

type PolicyFile struct {
	Name     string
	FullName string
	Content  string
}

type PolicySource

type PolicySource interface {
	GetPolicyFiles() ([]*PolicyFile, error)
	String() string
}

func NewGitPolicySource

func NewGitPolicySource(repoURL string, repoBrach string, policyDir string) PolicySource

func NewLocalPolicySource

func NewLocalPolicySource(rootDirectory string) PolicySource

type ReadFn

type ReadFn func(name string) ([]byte, error)

type RegoEvaluationResult

type RegoEvaluationResult struct {
	Name       string
	Valid      bool
	Violations []string
}

type WalkFn

type WalkFn func(root string, fn filepath.WalkFunc) error