policy

Documentation

Index

• Constants
• func DetectPolicy(dir string) (m *Manager, ruleType RuleType, rule *Rule, target Target, err error)
• type Manager
  • func NewManager(dir string) *Manager
  • func (m *Manager) CreateTarBall(path string) error
  • func (m *Manager) LoadAllRules() error
  • func (m *Manager) LoadRule(ruleType RuleType, path string) (*Rule, error)
  • func (m *Manager) LoadRules(ruleType RuleType) error
  • func (m *Manager) PrepareRules(dest string, ruleType RuleType, target Target) error
  • func (m *Manager) TestRule(rule *Rule) error
  • func (m *Manager) TestRuleTarget(rule *Rule, target Target) error
  • func (m *Manager) TestRuleType(ruleType RuleType) error
  • func (m *Manager) TestRules() error
  • func (m *Manager) ValidateRules() error
• type PassFail
• type Rule
• type RuleType
• type Target
• type TestRunner

Constants

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

Functions

func DetectPolicy

func DetectPolicy(dir string) (m *Manager, ruleType RuleType, rule *Rule, target Target, err error)

Types

type Manager

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

func NewManager

func NewManager(dir string) *Manager

func (*Manager) CreateTarBall

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

func (*Manager) LoadAllRules

func (m *Manager) LoadAllRules() error

func (*Manager) LoadRule

func (m *Manager) LoadRule(ruleType RuleType, path string) (*Rule, error)

func (*Manager) LoadRules

func (m *Manager) LoadRules(ruleType RuleType) error

func (*Manager) PrepareRules

func (m *Manager) PrepareRules(dest string, ruleType RuleType, target Target) error

func (*Manager) TestRule

func (m *Manager) TestRule(rule *Rule) error

func (*Manager) TestRuleTarget

func (m *Manager) TestRuleTarget(rule *Rule, target Target) error

func (*Manager) TestRuleType

func (m *Manager) TestRuleType(ruleType RuleType) error

func (*Manager) TestRules

func (m *Manager) TestRules() error

func (*Manager) ValidateRules

func (m *Manager) ValidateRules() error

type PassFail

type PassFail *bool

type Rule

type Rule struct {
	Type     RuleType
	ID       string
	Path     string
	Metadata map[string]interface{}
	Targets  []Target
	Error    error
}

type RuleType

type RuleType interface {
	GetCode() string
	Prepare(rule *Rule, target Target, dest string) error
	Validate(rule *Rule) error
	GetTestRunner(target Target) tools.Single
	FindRuleResult(findings assessments.Findings, id string) PassFail
}

var CheckovYAML RuleType = checkovYAMLType("checkov")

type Target

type Target string

type TestRunner

type TestRunner interface {
	tools.Interface
}