rego

Documentation

Index

• func OptionWithDataDirs(dirs ...string) func(s *Scanner)
• func OptionWithDebug(debugWriter io.Writer) func(s *Scanner)
• func OptionWithPolicyNamespaces(includeDefaults bool, namespaces ...string) func(s *Scanner)
• func OptionWithTrace(w io.Writer) func(s *Scanner)
• type DynamicMetadata
• type Input
• type InputOptions
• type MetadataRetriever
  • func NewMetadataRetriever(compiler *ast.Compiler) *MetadataRetriever
  • func (m *MetadataRetriever) RetrieveMetadata(ctx context.Context, module *ast.Module) (*StaticMetadata, error)
• type Option
• type Scanner
  • func NewScanner(options ...Option) *Scanner
  • func (s *Scanner) LoadPolicies(loadEmbedded bool, srcFS fs.FS, paths []string, readers []io.Reader) error
  • func (s *Scanner) ScanInput(ctx context.Context, inputs ...Input) (scan.Results, error)
• type Selector
• type StaticMetadata
  • func (m StaticMetadata) ToRule() scan.Rule

Functions

func OptionWithDataDirs

func OptionWithDataDirs(dirs ...string) func(s *Scanner)

func OptionWithDebug

func OptionWithDebug(debugWriter io.Writer) func(s *Scanner)

OptionWithDebug - pass the scanner an io.Writer to log debug messages to

func OptionWithPolicyNamespaces

func OptionWithPolicyNamespaces(includeDefaults bool, namespaces ...string) func(s *Scanner)

func OptionWithTrace

func OptionWithTrace(w io.Writer) func(s *Scanner)

OptionWithTrace - specify an io.Writer for rego tracing

Types

type DynamicMetadata

type DynamicMetadata struct {
	Warning   bool
	Filepath  string
	Message   string
	StartLine int
	EndLine   int
}

type Input

type Input struct {
	Path     string       `json:"path"`
	Contents interface{}  `json:"contents"`
	Type     types.Source `json:"type"`
}

type InputOptions

type InputOptions struct {
	Combined  bool
	Selectors []Selector
}

type MetadataRetriever

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

func NewMetadataRetriever

func NewMetadataRetriever(compiler *ast.Compiler) *MetadataRetriever

func (*MetadataRetriever) RetrieveMetadata

func (m *MetadataRetriever) RetrieveMetadata(ctx context.Context, module *ast.Module) (*StaticMetadata, error)

type Option

type Option func(s *Scanner)

type Scanner

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

func NewScanner

func NewScanner(options ...Option) *Scanner

func (*Scanner) LoadPolicies

func (s *Scanner) LoadPolicies(loadEmbedded bool, srcFS fs.FS, paths []string, readers []io.Reader) error

func (*Scanner) ScanInput

func (s *Scanner) ScanInput(ctx context.Context, inputs ...Input) (scan.Results, error)

type Selector

type Selector struct {
	Type string
}

type StaticMetadata

type StaticMetadata struct {
	ID                 string
	AVDID              string
	Type               string
	Title              string
	ShortCode          string
	Description        string
	Severity           string
	RecommendedActions string
	PrimaryURL         string
	References         []string
	InputOptions       InputOptions
	Package            string
}

func (StaticMetadata) ToRule

func (m StaticMetadata) ToRule() scan.Rule