Documentation
¶
Overview ¶
ENGMODEL-OWNER-UNIT: FU-OSCAL-EXPORTER
ENGMODEL-OWNER-UNIT: FU-OSCAL-EXPORTER
ENGMODEL-OWNER-UNIT: FU-OSCAL-EXPORTER
ENGMODEL-OWNER-UNIT: FU-OSCAL-EXPORTER
ENGMODEL-OWNER-UNIT: FU-OSCAL-EXPORTER
ENGMODEL-OWNER-UNIT: FU-OSCAL-EXPORTER
Index ¶
- Variables
- func GenerateProfile(bundle model.Bundle, options ProfileOptions) (string, error)
- func GenerateProfileFromFile(path string, options ProfileOptions) (string, error)
- type APDocument
- type APOptions
- type APResult
- type ARDocument
- type AROptions
- type ARResult
- type POAMDocument
- type POAMOptions
- type POAMResult
- type ProfileOptions
- type SSPDocument
- type SSPOptions
- type SSPResult
Constants ¶
This section is empty.
Variables ¶
var ErrNoCompliance = errors.New("OSCAL export requires at least one authored compliance mapping")
var ErrNoPOAMItems = errors.New("OSCAL POA&M requires at least one authored POA&M item")
var ErrNoProfiles = errors.New("no OSCAL compliance profiles are authored")
ErrNoProfiles indicates that the model has no compliance profile to publish as an aggregate OSCAL profile.
Functions ¶
func GenerateProfile ¶
func GenerateProfile(bundle model.Bundle, options ProfileOptions) (string, error)
GenerateProfile emits a deterministic OSCAL 1.1.2 aggregate profile so multi-framework SSPs import every framework they implement. TRLC-LINKS: REQ-EMG-013 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
func GenerateProfileFromFile ¶
func GenerateProfileFromFile(path string, options ProfileOptions) (string, error)
GenerateProfileFromFile loads a model and emits one profile importing every authored compliance profile. TRLC-LINKS: REQ-EMG-013 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
Types ¶
type APDocument ¶
type APDocument struct {
AssessmentPlan oscalAssessmentPlan `json:"assessment-plan"`
}
type APResult ¶
type APResult struct {
JSON string
Document APDocument
Diagnostics []validate.Diagnostic
}
func GenerateAssessmentPlan ¶
TRLC-LINKS: REQ-EMG-012, REQ-EMG-013 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FU-VALIDATION-ENGINE
type ARDocument ¶
type ARDocument struct {
AssessmentResults oscalAssessmentResults `json:"assessment-results"`
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
type AROptions ¶
type AROptions struct {
AssessmentPlanHref string
RequirementsPath string
CodeRoot string
ProfileHref string
CatalogHref string
LastModified string
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
type ARResult ¶
type ARResult struct {
JSON string
Document ARDocument
Diagnostics []validate.Diagnostic
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FU-VALIDATION-ENGINE, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED
func GenerateAssessmentResults ¶
func GenerateAssessmentResults(bundle model.Bundle, requirements model.RequirementsDocument, options AROptions) (ARResult, error)
TRLC-LINKS: REQ-EMG-001, REQ-EMG-013, REQ-EMG-035, REQ-EMG-036 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FLOW-MODEL-CHANGE-TO-VERIFIED-ARTIFACTS, FU-THREAT-EXPORTER, FU-VALIDATION-ENGINE, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED
type POAMDocument ¶
type POAMDocument struct {
PlanOfActionAndMilestones oscalPOAMRoot `json:"plan-of-action-and-milestones"`
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
type POAMOptions ¶
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
type POAMResult ¶
type POAMResult struct {
JSON string
Document POAMDocument
Diagnostics []validate.Diagnostic
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FU-VALIDATION-ENGINE, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED
func GeneratePOAM ¶
func GeneratePOAM(bundle model.Bundle, options POAMOptions) (POAMResult, error)
TRLC-LINKS: REQ-EMG-001, REQ-EMG-013, REQ-EMG-035, REQ-EMG-036 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FLOW-MODEL-CHANGE-TO-VERIFIED-ARTIFACTS, FU-THREAT-EXPORTER, FU-VALIDATION-ENGINE, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED
func GeneratePOAMFromFile ¶
func GeneratePOAMFromFile(architecturePath string, options POAMOptions) (POAMResult, error)
TRLC-LINKS: REQ-EMG-001, REQ-EMG-013 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FLOW-MODEL-CHANGE-TO-VERIFIED-ARTIFACTS
type ProfileOptions ¶
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
type SSPDocument ¶
type SSPDocument struct {
SystemSecurityPlan oscalSystemSecurityPlan `json:"system-security-plan"`
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
type SSPOptions ¶
type SSPOptions struct {
ProfileHref string
ImportProfileHref string
CatalogHref string
SystemName string
SystemDescription string
LastModified string
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE
type SSPResult ¶
type SSPResult struct {
JSON string
Document SSPDocument
Diagnostics []validate.Diagnostic
}
ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FU-VALIDATION-ENGINE, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED
func GenerateSSP ¶
func GenerateSSP(bundle model.Bundle, options SSPOptions) (SSPResult, error)
TRLC-LINKS: REQ-EMG-001, REQ-EMG-013, REQ-EMG-035, REQ-EMG-036 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FLOW-MODEL-CHANGE-TO-VERIFIED-ARTIFACTS, FU-VALIDATION-ENGINE, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED
func GenerateSSPFromFile ¶
func GenerateSSPFromFile(architecturePath string, options SSPOptions) (SSPResult, error)
TRLC-LINKS: REQ-EMG-001, REQ-EMG-013 ENGMODEL-LINKS: FU-OSCAL-EXPORTER, CTRL-TRACEABILITY-COVERAGE, FLOW-MODEL-CHANGE-TO-VERIFIED-ARTIFACTS