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 Narrative
  • func (n Narrative) GetKey() string
  • func (n Narrative) GetText() string
• type Satisfies
  • func (s Satisfies) GetControlKey() string
  • func (s Satisfies) GetCoveredBy() common.CoveredByList
  • func (s Satisfies) GetNarratives() []base.Section
  • func (s Satisfies) GetParameters() []base.Section
  • func (s Satisfies) GetStandardKey() 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"`
	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 Narrative

type Narrative string

func (Narrative) GetKey

func (n Narrative) GetKey() string

func (Narrative) GetText

func (n Narrative) GetText() string

type Satisfies

type Satisfies struct {
	ControlKey  string               `yaml:"control_key" json:"control_key"`
	StandardKey string               `yaml:"standard_key" json:"standard_key"`
	Narrative   Narrative            `yaml:"narrative" json:"narrative"`
	CoveredBy   common.CoveredByList `yaml:"covered_by" json:"covered_by"`
}

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) 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