policy

Documentation

Index

• type Engine
  • func Load(policyPaths []string, c compilerOptions) (*Engine, error)
  • func LoadWithData(policyPaths []string, dataPaths []string, capabilities string, strict bool) (*Engine, error)
  • func (e *Engine) Check(ctx context.Context, configs map[string]interface{}, namespace string) ([]output.CheckResult, error)
  • func (e *Engine) CheckCombined(ctx context.Context, configs map[string]interface{}, namespace string) (output.CheckResult, error)
  • func (e *Engine) Compiler() *ast.Compiler
  • func (e *Engine) Documents() map[string]string
  • func (e *Engine) EnableTracing()
  • func (e *Engine) Modules() map[string]*ast.Module
  • func (e *Engine) Namespaces() []string
  • func (e *Engine) Policies() map[string]string
  • func (e *Engine) Runtime() *ast.Term
  • func (e *Engine) ShowBuiltinErrors()
  • func (e *Engine) Store() storage.Store

Types

type Engine

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

Engine represents the policy engine.

func Load

func Load(policyPaths []string, c compilerOptions) (*Engine, error)

Load returns an Engine after loading all of the specified policies.

func LoadWithData

func LoadWithData(policyPaths []string, dataPaths []string, capabilities string, strict bool) (*Engine, error)

LoadWithData returns an Engine after loading all of the specified policies and data paths.

func (*Engine) Check

func (e *Engine) Check(ctx context.Context, configs map[string]interface{}, namespace string) ([]output.CheckResult, error)

Check executes all of the loaded policies against the input and returns the results.

func (*Engine) CheckCombined

func (e *Engine) CheckCombined(ctx context.Context, configs map[string]interface{}, namespace string) (output.CheckResult, error)

CheckCombined combines the input and evaluates the policies against the combined result.

func (*Engine) Compiler

func (e *Engine) Compiler() *ast.Compiler

Compiler returns the compiler from the loaded policies.

func (*Engine) Documents

func (e *Engine) Documents() map[string]string

Documents returns all of the documents loaded into the engine. The result is a map where the key is the filepath of the document and its value is the raw contents of the loaded document.

func (*Engine) EnableTracing

func (e *Engine) EnableTracing()

func (*Engine) Modules

func (e *Engine) Modules() map[string]*ast.Module

Modules returns the modules from the loaded policies.

func (*Engine) Namespaces

func (e *Engine) Namespaces() []string

Namespaces returns all of the namespaces in the engine.

func (*Engine) Policies

func (e *Engine) Policies() map[string]string

Policies returns all of the policies loaded into the engine. The result is a map where the key is the filepath of the policy and its value is the raw contents of the loaded policy.

func (*Engine) Runtime

func (e *Engine) Runtime() *ast.Term

Runtime returns the runtime of the engine.

func (*Engine) ShowBuiltinErrors

func (e *Engine) ShowBuiltinErrors()

func (*Engine) Store

func (e *Engine) Store() storage.Store

Store returns the store from the loaded documents.