policy

Documentation

Index

• Constants
• func RegisterRuleType(ruleType RuleType)
• type PassFail
• type Rule
• type RuleType
  • func GetRuleType(ruleTypeName string) RuleType
  • func GetRuleTypes() (res []RuleType)
• type Store
  • func (m *Store) CreateTarBall(path string) error
  • func (m *Store) GetPolicyUploadMetadata() (map[string]string, error)
  • func (m *Store) LoadRules() error
  • func (m *Store) LoadRulesOfType(ruleType RuleType) error
  • func (m *Store) LoadSingleRule(ruleType RuleType, path string) (*Rule, error)
  • func (m *Store) PrepareRules(dest string) error
  • func (m *Store) RuleCount() (count int)
• type Target

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 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(rules []*Rule, dest string) error
	FindRuleResult(findings assessments.Findings, id string) PassFail
}

func GetRuleType

func GetRuleType(ruleTypeName string) RuleType

func GetRuleTypes

func GetRuleTypes() (res []RuleType)

type Store

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

func (*Store) CreateTarBall

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

func (*Store) GetPolicyUploadMetadata

func (m *Store) GetPolicyUploadMetadata() (map[string]string, error)

func (*Store) LoadRules

func (m *Store) LoadRules() error

func (*Store) LoadRulesOfType

func (m *Store) LoadRulesOfType(ruleType RuleType) error

func (*Store) LoadSingleRule

func (m *Store) LoadSingleRule(ruleType RuleType, path string) (*Rule, error)

func (*Store) PrepareRules

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

func (*Store) RuleCount

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

type Target

type Target string