rules

Documentation

Overview

Rules Engine

Index

• type Rule
• type RuleSet
• type RulesEngine
  • func NewRulesEngine(ruleFiles map[string]string) (*RulesEngine, error)
  • func (e *RulesEngine) EvaluateRules(category string, obj runtime.Object) []types.Finding

Types

type Rule

type Rule struct {
	Name        string            `yaml:"name"`
	Description string            `yaml:"description"`
	Category    string            `yaml:"category"`
	Severity    string            `yaml:"severity"`
	Condition   string            `yaml:"condition"`
	Suggestion  string            `yaml:"suggestion"`
	Metadata    map[string]string `yaml:"metadata,omitempty"`
}

type RuleSet

type RuleSet struct {
	Rules []Rule `yaml:"rules"`
}

type RulesEngine

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

RulesEngine handles loading and evaluating security rules

func NewRulesEngine

func NewRulesEngine(ruleFiles map[string]string) (*RulesEngine, error)

NewRulesEngine creates a new rules engine instance

func (*RulesEngine) EvaluateRules

func (e *RulesEngine) EvaluateRules(category string, obj runtime.Object) []types.Finding

EvaluateRules evaluates all rules for a given category against a Kubernetes object