universal

Documentation

Index

• func OptionWithDataDirs(dirs []string) func(s *Scanner)
• func OptionWithPolicyDirs(dirs []string) func(s *Scanner)
• func OptionWithPolicyNamespaces(namespaces ...string) func(s *Scanner)
• type Option
  • func OptionWithDebug(w io.Writer) Option
  • func OptionWithTerraformVarsPaths(paths []string) Option
  • func OptionWithTerraformWorkspace(ws string) Option
  • func OptionWithTrace(w io.Writer) Option
• type Scanner
  • func New(opts ...Option) *Scanner
  • func (s *Scanner) ScanFS(ctx context.Context, fs fs.FS, dir string) (scan.Results, error)

Functions

func OptionWithDataDirs

func OptionWithDataDirs(dirs []string) func(s *Scanner)

OptionWithDataDirs - location of rego policy directories - policies are loaded recursively

func OptionWithPolicyDirs

func OptionWithPolicyDirs(dirs []string) func(s *Scanner)

OptionWithPolicyDirs - location of rego policy directories - policies are loaded recursively

func OptionWithPolicyNamespaces

func OptionWithPolicyNamespaces(namespaces ...string) func(s *Scanner)

OptionWithPolicyNamespaces - namespaces which indicate rego policies containing enforced rules

Types

type Option

type Option func(*Scanner)

func OptionWithDebug

func OptionWithDebug(w io.Writer) Option

OptionWithDebug specifies an io.Writer for debug logs - if not set, they are discarded

func OptionWithTerraformVarsPaths

func OptionWithTerraformVarsPaths(paths []string) Option

OptionWithTerraformVarsPaths paths to tfvars files for Terraform

func OptionWithTerraformWorkspace

func OptionWithTerraformWorkspace(ws string) Option

OptionWithTerraformWorkspace specify Terraform workspace

func OptionWithTrace

func OptionWithTrace(w io.Writer) Option

OptionWithTrace specifies an io.Writer for trace logs (mainly rego tracing) - if not set, they are discarded

type Scanner

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

func New

func New(opts ...Option) *Scanner

func (*Scanner) ScanFS

func (s *Scanner) ScanFS(ctx context.Context, fs fs.FS, dir string) (scan.Results, error)