manager

Documentation

Index

• type M
  • func (m *M) DetectPolicy(dir string) error
  • func (m *M) Register(cmd *cobra.Command)
  • func (m *M) RegisterDownload(cmd *cobra.Command)
  • func (m *M) RegisterUpload(cmd *cobra.Command)
  • func (m *M) TestPolicies() (TestMetrics, error)
  • func (m *M) ValidatePolicies() ValidateResult
• type PassFail
• type PolicyTestMetrics
• type PolicyType
• type TestMetrics
• type ValidateResult
  • func (vr *ValidateResult) AppendError(err error)

Types

type M

type M struct {
	tools.RunOpts
	policy.Store
}

func (*M) DetectPolicy

func (m *M) DetectPolicy(dir string) error

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

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

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

func (*M) Register

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

func (*M) RegisterDownload

func (m *M) RegisterDownload(cmd *cobra.Command)

func (*M) RegisterUpload

func (m *M) RegisterUpload(cmd *cobra.Command)

func (*M) TestPolicies

func (m *M) TestPolicies() (TestMetrics, error)

func (*M) ValidatePolicies

func (m *M) ValidatePolicies() ValidateResult

type PassFail

type PassFail *bool

type PolicyTestMetrics

type PolicyTestMetrics struct {
	Path     string        `json:"path"`
	Target   policy.Target `json:"target"`
	TestPath string        `json:"test_path"`
	TestType string        `json:"test_type"`
	Success  bool          `json:"success"`
}

type PolicyType

type PolicyType interface {
	policy.PolicyType
	ValidatePolicies(runOpts tools.RunOpts, policies []*policy.Policy) ValidateResult
	GetTestRunner(runOpts tools.RunOpts, target policy.Target) tools.Single
	// Find a test result.  This must be tool-specific because the
	// findings have not been normalized.
	FindPolicyResult(findings assessments.Findings, id string) []PassFail
}

type TestMetrics

type TestMetrics struct {
	Policies []PolicyTestMetrics `json:"policies,omitempty"`
	Passed   int                 `json:"passed"`
	Failed   int                 `json:"failed"`
}

type ValidateResult

type ValidateResult struct {
	Errors  error `json:"-"`
	Valid   int   `json:"valid"`
	Invalid int   `json:"invalid"`
}

func (*ValidateResult) AppendError

func (vr *ValidateResult) AppendError(err error)