profile

Documentation

Overview

Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.

Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT. Multiplexers are indirect models needed for serialization/deserialization as json and xml files differ materially in their structure.

Index

• type Add
• type All
• type Alter
• type Annotation
• type AsIs
  • func (a *AsIs) UnmarshalJSON(b []byte) error
• type BackMatter
• type Call
• type Combine
• type Constraint
• type Custom
• type Exclude
• type Group
• type Guideline
• type Import
  • func (i *Import) IsDocumentFragment() bool
  • func (i *Import) IsHttpResource() bool
  • func (i *Import) ValidateHref() error
• type Include
• type Label
• type Link
• type Match
• type Merge
• type Metadata
• type Modify
• type Param
• type Part
• type Profile
  • func (p *Profile) GetDocumentFragment(uri string) (*validation_root.Resource, error)
• type Prop
• type Remove
• type Select
• type SetParameter
• type SetParameterMultiplexer
  • func (mplex *SetParameterMultiplexer) MarshalJSON() ([]byte, error)
  • func (mplex *SetParameterMultiplexer) UnmarshalJSON(b []byte) error
• type Title
• type Usage
• type Value

Types

type Add

type Add struct {

	// Where to add the new content with respect to the targeted element (beside it or inside it)
	Position string `xml:"position,attr,omitempty" json:"position,omitempty"`
	// Target location of the addition.
	IdRef string `xml:"id-ref,attr,omitempty" json:"id-ref,omitempty"`

	// A title for display and navigation
	Title *Title `xml:"title,omitempty" json:"title,omitempty"`
	// Parameters provide a mechanism for the dynamic assignment of value(s) in a control.
	Parameters []Param `xml:"param,omitempty" json:"parameters,omitempty"`
	// A value with a name, attributed to the containing control, part, or group.
	Properties []Prop `xml:"prop,omitempty" json:"properties,omitempty"`
	// A name/value pair with optional explanatory remarks.
	Annotations []Annotation `xml:"annotation,omitempty" json:"annotations,omitempty"`
	// A reference to a local or remote resource
	Links []Link `xml:"link,omitempty" json:"links,omitempty"`
	// A partition or component of a control or part
	Parts []Part `xml:"part,omitempty" json:"parts,omitempty"`
}

Specifies contents to be added into controls, in resolution

type All

type All struct {
	// When a control is included, whether its child (dependent) controls are also included.
	WithChildControls string `xml:"with-child-controls,attr,omitempty" json:"with-child-controls,omitempty"`
}

Include all controls from the imported resource (catalog)

type Alter

type Alter struct {

	// Value of the 'id' flag on a target control
	ControlId string `xml:"control-id,attr,omitempty" json:"control-id,omitempty"`

	// Specifies elements to be removed from a control, in resolution
	Removals []Remove `xml:"remove,omitempty" json:"removals,omitempty"`
	// Specifies contents to be added into controls, in resolution
	Additions []Add `xml:"add,omitempty" json:"additions,omitempty"`
}

An Alter element specifies changes to be made to an included control when a profile is resolved.

type Annotation

type Annotation = validation_root.Annotation

type AsIs

type AsIs string

func (*AsIs) UnmarshalJSON

func (a *AsIs) UnmarshalJSON(b []byte) error

type BackMatter

type BackMatter = validation_root.BackMatter

type Call

type Call struct {
	// Value of the 'id' flag on a target control
	ControlId string `xml:"control-id,attr,omitempty" json:"control-id,omitempty"`

	// When a control is included, whether its child (dependent) controls are also included.
	WithChildControls string `xml:"with-child-controls,attr,omitempty" json:"with-child-controls,omitempty"`
}

Call a control by its ID

type Combine

type Combine struct {
	// How clashing controls should be handled
	Method string `xml:"method,attr,omitempty" json:"method,omitempty"`
}

A Combine element defines whether and how to combine multiple (competing)

versions of the same control

type Constraint

type Constraint = nominal_catalog.Constraint

type Custom

type Custom struct {

	// As in catalogs, a group of (selected) controls or of groups of controls
	Groups []Group `xml:"group,omitempty" json:"groups,omitempty"`
	// Call a control by its ID
	IdSelectors []Call `xml:"call,omitempty" json:"id-selectors,omitempty"`
	// Select controls by (regular expression) match on ID
	PatternSelectors []Match `xml:"match,omitempty" json:"pattern-selectors,omitempty"`
}

A Custom element frames a structure for embedding represented controls in resolution.

type Exclude

type Exclude struct {

	// Call a control by its ID
	IdSelectors []Call `xml:"call,omitempty" json:"id-selectors,omitempty"`
	// Select controls by (regular expression) match on ID
	PatternSelectors []Match `xml:"match,omitempty" json:"pattern-selectors,omitempty"`
}

Which controls to exclude from the resource (source catalog) being

imported

type Group

type Group struct {

	// Unique identifier of the containing object
	Id string `xml:"id,attr,omitempty" json:"id,omitempty"`
	// Indicating the type or classification of the containing object
	Class string `xml:"class,attr,omitempty" json:"class,omitempty"`

	// A title for display and navigation
	Title *Title `xml:"title,omitempty" json:"title,omitempty"`
	// Parameters provide a mechanism for the dynamic assignment of value(s) in a control.
	Parameters []Param `xml:"param,omitempty" json:"parameters,omitempty"`
	// A value with a name, attributed to the containing control, part, or group.
	Properties []Prop `xml:"prop,omitempty" json:"properties,omitempty"`
	// A partition or component of a control or part
	Parts []Part `xml:"part,omitempty" json:"parts,omitempty"`
	// As in catalogs, a group of (selected) controls or of groups of controls
	Groups []Group `xml:"group,omitempty" json:"groups,omitempty"`
	// Call a control by its ID
	IdSelectors []Call `xml:"call,omitempty" json:"id-selectors,omitempty"`
	// Select controls by (regular expression) match on ID
	PatternSelectors []Match `xml:"match,omitempty" json:"pattern-selectors,omitempty"`
}

As in catalogs, a group of (selected) controls or of groups of controls

type Guideline

type Guideline = nominal_catalog.Guideline

type Import

type Import struct {

	// A link to a document or document fragment (actual, nominal or projected)
	Href string `xml:"href,attr,omitempty" json:"href,omitempty"`

	// Specifies which controls to include from the resource (source catalog) being
	//           imported
	Include *Include `xml:"include,omitempty" json:"include,omitempty"`
	// Which controls to exclude from the resource (source catalog) being
	//           imported
	Exclude *Exclude `xml:"exclude,omitempty" json:"exclude,omitempty"`
}

An Import element designates a catalog, profile, or other resource to be

included (referenced and potentially modified) by this profile.

func (*Import) IsDocumentFragment

func (i *Import) IsDocumentFragment() bool

func (*Import) IsHttpResource

func (i *Import) IsHttpResource() bool

IsHttpResource returns true if import refers to http resource

func (*Import) ValidateHref

func (i *Import) ValidateHref() error

Validates that profile import contains valid href

type Include

type Include struct {

	// Include all controls from the imported resource (catalog)
	All *All `xml:"all,omitempty" json:"all,omitempty"`
	// Call a control by its ID
	IdSelectors []Call `xml:"call,omitempty" json:"id-selectors,omitempty"`
	// Select controls by (regular expression) match on ID
	PatternSelectors []Match `xml:"match,omitempty" json:"pattern-selectors,omitempty"`
}

Specifies which controls to include from the resource (source catalog) being

imported

type Label

type Label = nominal_catalog.Label

type Link

type Link = validation_root.Link

type Match

type Match struct {
	// A regular expression matching the IDs of one or more controls to be selected
	Pattern string `xml:"pattern,attr,omitempty" json:"pattern,omitempty"`

	// A designation of how a selection of controls in a profile is to be ordered.
	Order string `xml:"order,attr,omitempty" json:"order,omitempty"`

	// When a control is included, whether its child (dependent) controls are also included.
	WithChildControls string `xml:"with-child-controls,attr,omitempty" json:"with-child-controls,omitempty"`
}

Select controls by (regular expression) match on ID

type Merge

type Merge struct {

	// A Combine element defines whether and how to combine multiple (competing)
	//         versions of the same control
	Combine *Combine `xml:"combine,omitempty" json:"combine,omitempty"`
	// An As-is element indicates that the controls should be structured in resolution as they are
	//         structured in their source catalogs. It does not contain any elements or attributes.
	AsIs AsIs `xml:"as-is,omitempty" json:"as-is,omitempty"`
	// A Custom element frames a structure for embedding represented controls in resolution.
	Custom *Custom `xml:"custom,omitempty" json:"custom,omitempty"`
}

A Merge element merges controls in resolution.

type Metadata

type Metadata = validation_root.Metadata

type Modify

type Modify struct {

	// A parameter setting, to be propagated to points of insertion
	ParameterSettings SetParameterMultiplexer `xml:"set-parameter,omitempty" json:"parameter-settings,omitempty"`
	// An Alter element specifies changes to be made to an included control when a profile is resolved.
	Alterations []Alter `xml:"alter,omitempty" json:"alterations,omitempty"`
}

Set parameters or amend controls in resolution

type Param

type Param = nominal_catalog.Param

type Part

type Part = nominal_catalog.Part

type Profile

type Profile struct {
	XMLName xml.Name `xml:"http://csrc.nist.gov/ns/oscal/1.0 profile" json:"-"`
	// A RFC 4122 version 4 Universally Unique Identifier (UUID) for the containing object.
	Uuid string `xml:"uuid,attr,omitempty" json:"uuid,omitempty"`

	// Provides information about the publication and availability of the containing document.
	Metadata *Metadata `xml:"metadata,omitempty" json:"metadata,omitempty"`
	// An Import element designates a catalog, profile, or other resource to be
	//          included (referenced and potentially modified) by this profile.
	Imports []Import `xml:"import,omitempty" json:"imports,omitempty"`
	// A Merge element merges controls in resolution.
	Merge *Merge `xml:"merge,omitempty" json:"merge,omitempty"`
	// Set parameters or amend controls in resolution
	Modify *Modify `xml:"modify,omitempty" json:"modify,omitempty"`
	// A collection of citations and resource references.
	BackMatter *BackMatter `xml:"back-matter,omitempty" json:"back-matter,omitempty"`
}

Each OSCAL profile is defined by a Profile element

func (*Profile) GetDocumentFragment

func (p *Profile) GetDocumentFragment(uri string) (*validation_root.Resource, error)

type Prop

type Prop = validation_root.Prop

type Remove

type Remove struct {
	// Items to remove, by assigned name
	NameRef string `xml:"name-ref,attr,omitempty" json:"name-ref,omitempty"`

	// Items to remove, by class. A token match.
	ClassRef string `xml:"class-ref,attr,omitempty" json:"class-ref,omitempty"`

	// Items to remove, indicated by their IDs
	IdRef string `xml:"id-ref,attr,omitempty" json:"id-ref,omitempty"`

	// Items to remove, by the name of the item's type, or generic identifier, e.g.  or
	ItemName string `xml:"item-name,attr,omitempty" json:"item-name,omitempty"`
}

Specifies elements to be removed from a control, in resolution

type Select

type Select = nominal_catalog.Select

type SetParameter

type SetParameter struct {

	// Indicates the value of the 'id' flag on a target parameter; i.e. which parameter to set
	ParamId string `xml:"param-id,attr,omitempty" json:"param-id,omitempty"`
	// Indicating the type or classification of the containing object
	Class string `xml:"class,attr,omitempty" json:"class,omitempty"`
	// Another parameter invoking this one
	DependsOn string `xml:"depends-on,attr,omitempty" json:"depends-on,omitempty"`

	// A placeholder for a missing value, in display.
	Label *Label `xml:"label,omitempty" json:"label,omitempty"`
	// Indicates and explains the purpose and use of a parameter
	Descriptions []Usage `xml:"usage,omitempty" json:"descriptions,omitempty"`
	// A formal or informal expression of a constraint or test
	Constraints []Constraint `xml:"constraint,omitempty" json:"constraints,omitempty"`
	// A prose statement that provides a recommendation for the use of a parameter.
	Guidance []Guideline `xml:"guideline,omitempty" json:"guidance,omitempty"`
	// Indicates a permissible value for a parameter or property
	Value *Value `xml:"value,omitempty" json:"value,omitempty"`
	// Presenting a choice among alternatives
	Select *Select `xml:"select,omitempty" json:"select,omitempty"`
	// A reference to a local or remote resource
	Links []Link `xml:"link,omitempty" json:"links,omitempty"`
}

A parameter setting, to be propagated to points of insertion

type SetParameterMultiplexer

type SetParameterMultiplexer []SetParameter

func (*SetParameterMultiplexer) MarshalJSON

func (mplex *SetParameterMultiplexer) MarshalJSON() ([]byte, error)

func (*SetParameterMultiplexer) UnmarshalJSON

func (mplex *SetParameterMultiplexer) UnmarshalJSON(b []byte) error

type Title

type Title = validation_root.Title

type Usage

type Usage = nominal_catalog.Usage

type Value

type Value = nominal_catalog.Value