Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EvaluationResult ¶ added in v0.96.21
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 ¶
PolicyViolation represents a policy failure
type RawData ¶ added in v1.42.0
type RawData struct {
Input json.RawMessage `json:"input"`
Output json.RawMessage `json:"output"`
}
type ResultFormatError ¶ added in v0.96.21
type ResultFormatError struct {
Field string
}
func (ResultFormatError) Error ¶ added in v0.96.21
func (e ResultFormatError) Error() string
Click to show internal directories.
Click to hide internal directories.