oscal

Documentation

Index

• Constants
• func BackMatterToMap(backMatter oscalTypes_1_1_2.BackMatter) (resourceMap map[string]string)
• func ComponentFromCatalog(source string, catalog *oscalTypes_1_1_2.Catalog, componentTitle string, ...) (*oscalTypes_1_1_2.ComponentDefinition, error)
• func ControlImplementationstToRequirementsMap(controlImplementations *[]oscalTypes_1_1_2.ControlImplementationSet) (requirementMap map[string]Requirement)
• func ControlToImplementedRequirement(control *oscalTypes_1_1_2.Control, targetRemarks []string) (...)
• func CreateObservation(method string, relevantEvidence *[]oscalTypes_1_1_2.RelevantEvidence, ...) oscalTypes_1_1_2.Observation
• func CreateResult(findingMap map[string]oscalTypes_1_1_2.Finding, ...) (oscalTypes_1_1_2.Result, error)
• func EvaluateResults(thresholdResult *oscalTypes_1_1_2.Result, newResult *oscalTypes_1_1_2.Result) (bool, map[string]result.ResultComparisonMap, error)
• func FilterControlImplementations(componentDefinition *oscalTypes_1_1_2.ComponentDefinition) (controlMap map[string][]oscalTypes_1_1_2.ControlImplementationSet)
• func FilterResults(resultMap map[string]*oscalTypes_1_1_2.AssessmentResults) map[string]EvalResult
• func GenerateAssessmentResults(results []oscalTypes_1_1_2.Result) (*oscalTypes_1_1_2.AssessmentResults, error)
• func GetOscalModel(model *oscalTypes_1_1_2.OscalModels) (modelType string, err error)
• func GetProp(name string, namespace string, props *[]oscalTypes_1_1_2.Property) (bool, string)
• func MakeAssessmentResultsDeterministic(assessment *oscalTypes_1_1_2.AssessmentResults)
• func MakeComponentDeterminstic(component *oscalTypes_1_1_2.ComponentDefinition)
• func MergeAssessmentResults(original *oscalTypes_1_1_2.AssessmentResults, ...) (*oscalTypes_1_1_2.AssessmentResults, error)
• func MergeComponentDefinitions(original *oscalTypes_1_1_2.ComponentDefinition, ...) (*oscalTypes_1_1_2.ComponentDefinition, error)
• func MergeOscalModels(existingModel *oscalTypes_1_1_2.OscalModels, ...) (*oscalTypes_1_1_2.OscalModels, error)
• func NewAssessmentResults(data []byte) (*oscalTypes_1_1_2.AssessmentResults, error)
• func NewCatalog(data []byte) (catalog *oscalTypes_1_1_2.Catalog, err error)
• func NewOscalComponentDefinition(data []byte) (componentDefinition *oscalTypes_1_1_2.ComponentDefinition, err error)
• func NewOscalModel(data []byte) (*oscalTypes_1_1_2.OscalModels, error)
• func UpdateProps(name string, namespace string, value string, ...)
• func WriteOscalModel(filePath string, model *oscalTypes_1_1_2.OscalModels) error
• type EvalResult
• type Requirement

Constants

const OSCAL_VERSION = "1.1.2"

Functions

func BackMatterToMap

func BackMatterToMap(backMatter oscalTypes_1_1_2.BackMatter) (resourceMap map[string]string)

Returns a map of the uuid - description of the back-matter resources

func ComponentFromCatalog

func ComponentFromCatalog(source string, catalog *oscalTypes_1_1_2.Catalog, componentTitle string, targetControls []string, targetRemarks []string) (*oscalTypes_1_1_2.ComponentDefinition, error)

Creates a component-definition from a catalog and identified (or all) controls. Allows for specification of what the content of the remarks section should contain.

func ControlImplementationstToRequirementsMap

func ControlImplementationstToRequirementsMap(controlImplementations *[]oscalTypes_1_1_2.ControlImplementationSet) (requirementMap map[string]Requirement)

func ControlToImplementedRequirement

func ControlToImplementedRequirement(control *oscalTypes_1_1_2.Control, targetRemarks []string) (implementedRequirement oscalTypes_1_1_2.ImplementedRequirementControlImplementation, err error)

Consume a control - Identify statements - iterate through parts in order to create a description

func CreateObservation

func CreateObservation(method string, relevantEvidence *[]oscalTypes_1_1_2.RelevantEvidence, descriptionPattern string, descriptionArgs ...any) oscalTypes_1_1_2.Observation

Helper function to create observation

func CreateResult

func CreateResult(findingMap map[string]oscalTypes_1_1_2.Finding, observations []oscalTypes_1_1_2.Observation) (oscalTypes_1_1_2.Result, error)

Creates a result from findings and observations

func EvaluateResults

func EvaluateResults(thresholdResult *oscalTypes_1_1_2.Result, newResult *oscalTypes_1_1_2.Result) (bool, map[string]result.ResultComparisonMap, error)

func FilterControlImplementations

func FilterControlImplementations(componentDefinition *oscalTypes_1_1_2.ComponentDefinition) (controlMap map[string][]oscalTypes_1_1_2.ControlImplementationSet)

func FilterResults

func FilterResults(resultMap map[string]*oscalTypes_1_1_2.AssessmentResults) map[string]EvalResult

filterResults consumes many assessment-results objects and builds out a map of EvalResults filtered by target this function looks at the target prop as the key in the map

func GenerateAssessmentResults

func GenerateAssessmentResults(results []oscalTypes_1_1_2.Result) (*oscalTypes_1_1_2.AssessmentResults, error)

func GetOscalModel

func GetOscalModel(model *oscalTypes_1_1_2.OscalModels) (modelType string, err error)

func GetProp

func GetProp(name string, namespace string, props *[]oscalTypes_1_1_2.Property) (bool, string)

func MakeAssessmentResultsDeterministic

func MakeAssessmentResultsDeterministic(assessment *oscalTypes_1_1_2.AssessmentResults)

func MakeComponentDeterminstic

func MakeComponentDeterminstic(component *oscalTypes_1_1_2.ComponentDefinition)

func MergeAssessmentResults

func MergeAssessmentResults(original *oscalTypes_1_1_2.AssessmentResults, latest *oscalTypes_1_1_2.AssessmentResults) (*oscalTypes_1_1_2.AssessmentResults, error)

func MergeComponentDefinitions

func MergeComponentDefinitions(original *oscalTypes_1_1_2.ComponentDefinition, latest *oscalTypes_1_1_2.ComponentDefinition) (*oscalTypes_1_1_2.ComponentDefinition, error)

This function should perform a merge of two component-definitions where maintaining the original component-definition is the primary concern.

func MergeOscalModels

func MergeOscalModels(existingModel *oscalTypes_1_1_2.OscalModels, newModel *oscalTypes_1_1_2.OscalModels, modelType string) (*oscalTypes_1_1_2.OscalModels, error)

func NewAssessmentResults

func NewAssessmentResults(data []byte) (*oscalTypes_1_1_2.AssessmentResults, error)

NewAssessmentResults creates a new assessment results object from the given data.

func NewCatalog

func NewCatalog(data []byte) (catalog *oscalTypes_1_1_2.Catalog, err error)

NewCatalog creates a new catalog object from the given data.

func NewOscalComponentDefinition

func NewOscalComponentDefinition(data []byte) (componentDefinition *oscalTypes_1_1_2.ComponentDefinition, err error)

NewOscalComponentDefinition consumes a byte array and returns a new single OscalComponentDefinitionModel object Standard use is to read a file from the filesystem and pass the []byte to this function

func NewOscalModel

func NewOscalModel(data []byte) (*oscalTypes_1_1_2.OscalModels, error)

func UpdateProps

func UpdateProps(name string, namespace string, value string, props *[]oscalTypes_1_1_2.Property)

UpdateProps updates a property in a slice of properties or adds if not exists

func WriteOscalModel

func WriteOscalModel(filePath string, model *oscalTypes_1_1_2.OscalModels) error

WriteOscalModel takes a path and writes content to a file while performing checks for existing content supports both json and yaml

Types

type EvalResult

type EvalResult struct {
	Threshold *oscalTypes_1_1_2.Result
	Results   []*oscalTypes_1_1_2.Result
	Latest    *oscalTypes_1_1_2.Result
}

type Requirement

type Requirement struct {
	ImplementedRequirement *oscalTypes_1_1_2.ImplementedRequirementControlImplementation
	ControlImplementation  *oscalTypes_1_1_2.ControlImplementationSet
}