reporting

Documentation

Index

• func GenerateReport(inputFile string, fileFormat string) error
• func PrintReport(data ReportData, format string) error
• func SplitControlMap(controlMap map[string][]oscalTypes.ControlImplementationSet) (sourceMap map[string]map[string]int, frameworkMap map[string]map[string]int)
• type ComponentDefinitionReportData
  • func ExtractControlIDs(controlMap map[string][]oscalTypes.ControlImplementationSet) *ComponentDefinitionReportData
• type ReportData

Functions

func GenerateReport

func GenerateReport(inputFile string, fileFormat string) error

Runs the logic of report generation

func PrintReport

func PrintReport(data ReportData, format string) error

func SplitControlMap

func SplitControlMap(controlMap map[string][]oscalTypes.ControlImplementationSet) (sourceMap map[string]map[string]int, frameworkMap map[string]map[string]int)

Split the default controlMap into framework and source maps for further processing

Types

type ComponentDefinitionReportData

type ComponentDefinitionReportData struct {
	Title                string         `json:"title" yaml:"title"`
	ControlIDBySource    map[string]int `json:"control ID mapped" yaml:"control ID mapped"`
	ControlIDByFramework map[string]int `json:"controlIDFramework" yaml:"controlIDFramework"`
}

func ExtractControlIDs

func ExtractControlIDs(controlMap map[string][]oscalTypes.ControlImplementationSet) *ComponentDefinitionReportData

Gets the unique Control IDs from each source and framework in the OSCAL Component Definition

type ReportData

type ReportData struct {
	ComponentDefinition *ComponentDefinitionReportData `json:"componentDefinition,omitempty" yaml:"componentDefinition,omitempty"`
}