compliance

package
v1.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 21, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExplainRollupSummary added in v1.0.8

func ExplainRollupSummary(summary RollupSummary, limit int) []string

Types

type ControlCheck

type ControlCheck struct {
	ID                  string   `json:"id"`
	Title               string   `json:"title"`
	Status              string   `json:"status"`
	MatchedRecords      int      `json:"matched_records"`
	MappedRuleIDs       []string `json:"mapped_rule_ids,omitempty"`
	MissingRecordTypes  []string `json:"missing_record_types,omitempty"`
	MissingFields       []string `json:"missing_fields,omitempty"`
	RequiredRecordTypes []string `json:"required_record_types"`
	RequiredFields      []string `json:"required_fields"`
}

type ControlRollup added in v1.0.8

type ControlRollup struct {
	ControlID     string   `json:"control_id"`
	Title         string   `json:"title"`
	ControlKind   string   `json:"control_kind"`
	Status        string   `json:"status"`
	MappedRuleIDs []string `json:"mapped_rule_ids,omitempty"`
	FindingCount  int      `json:"finding_count"`
}

type FrameworkRollup added in v1.0.8

type FrameworkRollup struct {
	FrameworkID        string          `json:"framework_id"`
	Title              string          `json:"title"`
	Version            string          `json:"version"`
	ControlCount       int             `json:"control_count"`
	CoveredCount       int             `json:"covered_count"`
	CoveragePercent    float64         `json:"coverage_percent"`
	MappedFindingCount int             `json:"mapped_finding_count"`
	Controls           []ControlRollup `json:"controls"`
}

type Input

type Input struct {
	Framework *proof.Framework
	Chain     *proof.Chain
}

type Result

type Result struct {
	FrameworkID  string         `json:"framework_id"`
	Version      string         `json:"version"`
	Title        string         `json:"title"`
	ControlCount int            `json:"control_count"`
	CoveredCount int            `json:"covered_count"`
	Coverage     float64        `json:"coverage_percent"`
	Controls     []ControlCheck `json:"controls"`
	Gaps         []ControlCheck `json:"gaps"`
}

func Evaluate

func Evaluate(in Input) (Result, error)

type RollupSummary added in v1.0.8

type RollupSummary struct {
	Frameworks []FrameworkRollup `json:"frameworks"`
}

func BuildRollupSummary added in v1.0.8

func BuildRollupSummary(findings []model.Finding, chain *proof.Chain) (RollupSummary, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL