engine

Documentation

Index

• type EvaluationResult
• type Policy
• type PolicyEngine
• type PolicyViolation
• type RawData
• type ResultFormatError
  • func (e ResultFormatError) Error() string

Types

type EvaluationResult

type EvaluationResult struct {
	Violations []*PolicyViolation `json:"violations"`
	Skipped    bool               `json:"skipped"`
	SkipReason string             `json:"skipReason"`
	Ignore     bool               `json:"ignore"`
	RawData    *RawData           `json:"rawData"`
}

type Policy

type Policy struct {
	// the source code for this policy
	Source []byte `json:"module"`
	// The unique policy name
	Name string `json:"name"`
}

Policy represents a loaded policy in any of the supported engines.

type PolicyEngine

type PolicyEngine interface {
	// Verify verifies an input against a policy
	Verify(ctx context.Context, policy *Policy, input []byte, args map[string]any) (*EvaluationResult, error)
	// MatchesParameters evaluates the matches_parameters rule to determine if evaluation parameters match expected parameters
	MatchesParameters(ctx context.Context, policy *Policy, evaluationParams, expectedParams map[string]string) (bool, error)
	// MatchesEvaluation evaluates the matches_evaluation rule using policy violations and expected parameters
	MatchesEvaluation(ctx context.Context, policy *Policy, violations []string, expectedParams map[string]string) (bool, error)
}

type PolicyViolation

type PolicyViolation struct {
	Subject   string `json:"subject"`
	Violation string `json:"violation"`
}

PolicyViolation represents a policy failure

type RawData

type RawData struct {
	Input  json.RawMessage `json:"input"`
	Output json.RawMessage `json:"output"`
}

type ResultFormatError

type ResultFormatError struct {
	Field string
}

func (ResultFormatError) Error

func (e ResultFormatError) Error() string