policy

Documentation

Index

• Constants
• func RegisterRuleType(ruleType RuleType)
• type Manager
  • func (m *Manager) CreateTarBall(path string) error
  • func (m *Manager) DetectPolicy() error
  • func (m *Manager) LoadRules() error
  • func (m *Manager) PrepareRules(dest string) error
  • func (m *Manager) Register(cmd *cobra.Command)
  • func (m *Manager) RuleCount() (count int)
  • func (m *Manager) TestRules() (TestMetrics, error)
  • func (m *Manager) ValidateRules() (ValidateMetrics, error)
• type PassFail
• type Rule
• type RuleType
  • func GetRuleType(ruleTypeName string) RuleType
• type Target
• type TestMetrics
• type ValidateMetrics

Constants

const (
	Terraform      = Target("terraform")
	TerraformPlan  = Target("terraform-plan")
	Cloudformation = Target("cloudformation")
	Kubernetes     = Target("kubernetes")
	Helm           = Target("helm")
	Docker         = Target("docker")
	Secrets        = Target("secrets")
	None           = Target("")
)

Functions

func RegisterRuleType

func RegisterRuleType(ruleType RuleType)

Types

type Manager

type Manager struct {
	tools.RunOpts
	Dir   string
	Rules map[RuleType][]*Rule
}

func (*Manager) CreateTarBall

func (m *Manager) CreateTarBall(path string) error

func (*Manager) DetectPolicy

func (m *Manager) DetectPolicy() error

Finds and loads rules in a directory. The directory may be any directory in the policies tree. Only rules underneath the directory will be loaded. Policy directories have the following layout:

policies/ policies/<rule-tyoe> policies/<rule-type>/<rule> (must contain metadata.yaml) policies/<rule-type>/<rule>/<target>

<target> is optional depending on <rule-type>.

func (*Manager) LoadRules

func (m *Manager) LoadRules() error

func (*Manager) PrepareRules

func (m *Manager) PrepareRules(dest string) error

func (*Manager) Register

func (m *Manager) Register(cmd *cobra.Command)

func (*Manager) RuleCount

func (m *Manager) RuleCount() (count int)

func (*Manager) TestRules

func (m *Manager) TestRules() (TestMetrics, error)

func (*Manager) ValidateRules

func (m *Manager) ValidateRules() (ValidateMetrics, error)

type PassFail

type PassFail *bool

type Rule

type Rule struct {
	ID       string
	Path     string
	Metadata map[string]interface{}
	Targets  []Target
}

type RuleType

type RuleType interface {
	GetName() string
	GetCode() string
	PrepareRules(m *Manager, rules []*Rule, dest string) error
	ValidateRules(m *Manager, rules []*Rule) error
	GetTestRunner(m *Manager, target Target) tools.Single
	FindRuleResult(findings assessments.Findings, id string) PassFail
}

func GetRuleType

func GetRuleType(ruleTypeName string) RuleType

type Target

type Target string

type TestMetrics

type TestMetrics struct {
	FailureCount int
	TestCount    int
}

type ValidateMetrics

type ValidateMetrics struct {
	Count int
}