engine

Documentation

Index

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

Types

type EvaluationResult

type EvaluationResult struct {
	Violations []*PolicyViolation
	Skipped    bool
	SkipReason string
}

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)
}

type PolicyViolation

type PolicyViolation struct {
	Subject, Violation string
}

PolicyViolation represents a policy failure

type ResultFormatError

type ResultFormatError struct {
	Field string
}

func (ResultFormatError) Error

func (e ResultFormatError) Error() string