component

Documentation

Index

• type Component
  • func (c Component) GetAllSatisfies() []base.Satisfies
  • func (c Component) GetKey() string
  • func (c Component) GetName() string
  • func (c Component) GetReferences() *common.GeneralReferences
  • func (c Component) GetResponsibleRole() string
  • func (c Component) GetVerifications() *common.VerificationReferences
  • func (c Component) GetVersion() semver.Version
  • func (c *Component) SetKey(key string)
  • func (c *Component) SetVersion(version semver.Version)
• type NarrativeSection
  • func (ns NarrativeSection) GetKey() string
  • func (ns NarrativeSection) GetText() string
• type Satisfies
  • func (s Satisfies) GetControlKey() string
  • func (s Satisfies) GetControlOrigin() string
  • func (s Satisfies) GetCoveredBy() common.CoveredByList
  • func (s Satisfies) GetNarratives() []base.Section
  • func (s Satisfies) GetParameters() []base.Section
  • func (s Satisfies) GetStandardKey() string
• type Section
  • func (s Section) GetKey() string
  • func (s Section) GetText() string

Types

type Component

type Component struct {
	Name            string                        `yaml:"name" json:"name"`
	Key             string                        `yaml:"key" json:"key"`
	References      common.GeneralReferences      `yaml:"references" json:"references"`
	Verifications   common.VerificationReferences `yaml:"verifications" json:"verifications"`
	Satisfies       []Satisfies                   `yaml:"satisfies" json:"satisfies"`
	ResponsibleRole string                        `yaml:"responsible_role" json:"responsible_role"`
	SchemaVersion   semver.Version                `yaml:"-" json:"-"`
}

Component struct is an individual component requiring documentation Schema info: https://github.com/opencontrol/schemas#component-yaml

func (Component) GetAllSatisfies

func (c Component) GetAllSatisfies() []base.Satisfies

func (Component) GetKey

func (c Component) GetKey() string

func (Component) GetName

func (c Component) GetName() string

func (Component) GetReferences

func (c Component) GetReferences() *common.GeneralReferences

func (Component) GetResponsibleRole

func (c Component) GetResponsibleRole() string

func (Component) GetVerifications

func (c Component) GetVerifications() *common.VerificationReferences

func (Component) GetVersion

func (c Component) GetVersion() semver.Version

func (*Component) SetKey

func (c *Component) SetKey(key string)

func (*Component) SetVersion

func (c *Component) SetVersion(version semver.Version)

type NarrativeSection

type NarrativeSection struct {
	Key  string `yaml:"key,omitempty" json:"key,omitempty"`
	Text string `yaml:"text" json:"text"`
}

NarrativeSection contains the key and text for a particular section. NarrativeSection can omit the key.

func (NarrativeSection) GetKey

func (ns NarrativeSection) GetKey() string

func (NarrativeSection) GetText

func (ns NarrativeSection) GetText() string

type Satisfies

type Satisfies struct {
	ControlKey    string               `yaml:"control_key" json:"control_key"`
	StandardKey   string               `yaml:"standard_key" json:"standard_key"`
	Narrative     []NarrativeSection   `yaml:"narrative" json:"narrative"`
	CoveredBy     common.CoveredByList `yaml:"covered_by" json:"covered_by"`
	Parameters    []Section            `yaml:"parameters" json:"parameters"`
	ControlOrigin string               `yaml:"control_origin" json:"control_origin"`
}

Satisfies struct contains data demonstrating why a specific component meets a control This struct is a one-to-one mapping of a `satisfies` item in the component.yaml schema https://github.com/opencontrol/schemas#component-yaml

func (Satisfies) GetControlKey

func (s Satisfies) GetControlKey() string

func (Satisfies) GetControlOrigin

func (s Satisfies) GetControlOrigin() string

func (Satisfies) GetCoveredBy

func (s Satisfies) GetCoveredBy() common.CoveredByList

func (Satisfies) GetNarratives

func (s Satisfies) GetNarratives() []base.Section

func (Satisfies) GetParameters

func (s Satisfies) GetParameters() []base.Section

func (Satisfies) GetStandardKey

func (s Satisfies) GetStandardKey() string

type Section

type Section struct {
	Key  string `yaml:"key" json:"key"`
	Text string `yaml:"text" json:"text"`
}

Section contains the key and text for a particular section. Both are required.

func (Section) GetKey

func (s Section) GetKey() string

func (Section) GetText

func (s Section) GetText() string