oscal

Documentation

Index

• type OSCAL
  • func New(r io.Reader) (*OSCAL, error)
  • func (o *OSCAL) DocumentType() constants.DocumentType
  • func (o *OSCAL) JSON(w io.Writer, prettify bool) error
  • func (o *OSCAL) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (o *OSCAL) Write(w io.Writer, format constants.DocumentFormat, prettify bool) error
  • func (o *OSCAL) XML(w io.Writer, prettify bool) error
  • func (o *OSCAL) YAML(w io.Writer) error

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