oscal

package

v0.3.4 Latest Latest Go to latest Published: Nov 30, 2020 License: CC0-1.0 Imports: 16 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gocomply/oscalkit

Links

Open Source Insights

Documentation ¶

Index ¶

type OSCAL
- func New(r io.Reader) (*OSCAL, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type OSCAL ¶

type OSCAL struct {
	XMLName xml.Name         `json:"-" yaml:"-"`
	Catalog *catalog.Catalog `json:"catalog,omitempty" yaml:"catalog,omitempty"`
	// Declarations *Declarations `json:"declarations,omitempty" yaml:"declarations,omitempty"`
	Profile                         *profile.Profile `json:"profile,omitempty" yaml:"profile,omitempty"`
	*ssp.SystemSecurityPlan         `xml:"system-security-plan" json:"system-security-plan"`
	*poam.PlanOfActionAndMilestones `xml:"plan-of-action-and-milestones"`
	*sap.AssessmentPlan             `xml:"assessment-plan"`
	*sar.AssessmentResults          `xml:"assessment-results"`
	Component                       *component_definition.ComponentDefinition
	// contains filtered or unexported fields
}

OSCAL contains specific OSCAL components

func New ¶

func New(r io.Reader) (*OSCAL, error)

New returns a concrete OSCAL type from a reader

func (*OSCAL) DocumentType ¶

func (o *OSCAL) DocumentType() constants.DocumentType

func (*OSCAL) JSON ¶

func (o *OSCAL) JSON(w io.Writer, prettify bool) error

JSON writes the OSCAL object as JSON to the given writer

func (*OSCAL) MarshalXML ¶

func (o *OSCAL) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML marshals either a catalog or a profile

func (*OSCAL) Write ¶

func (o *OSCAL) Write(w io.Writer, format constants.DocumentFormat, prettify bool) error

Write marshals OSCAL object as xml, json, or yaml

func (*OSCAL) XML ¶

func (o *OSCAL) XML(w io.Writer, prettify bool) error

XML writes the OSCAL object as XML to the given writer

func (*OSCAL) YAML ¶

func (o *OSCAL) YAML(w io.Writer) error

YAML writes the OSCAL object as YAML to the given writer

Source Files ¶

View all Source files

oscal.go

Directories ¶

Path	Synopsis
assessment_common Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
assessment_plan Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
assessment_results Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
catalog Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
component_definition Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
implementation
nominal_catalog Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
plan_of_action_and_milestones Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
profile Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
system_security_plan Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
validation_common_root Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.
validation_root Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.	Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.

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