component

Documentation

Index

• type Component
  • func (c Component) GetAllSatisfies() []common.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) GetControlOrigin() string
  • func (s Satisfies) GetControlOrigins() []string
  • func (s Satisfies) GetCoveredBy() common.CoveredByList
  • func (s Satisfies) GetImplementationStatus() string
  • func (s Satisfies) GetImplementationStatuses() []string
  • func (s Satisfies) GetNarratives() []common.Section
  • func (s Satisfies) GetParameters() []common.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() []common.Satisfies

GetAllSatisfies gets all the Satisfies objects for the component.

func (Component) GetKey

func (c Component) GetKey() string

GetKey returns the key for the component (may not be unique). Useful for creating directories.

func (Component) GetName

func (c Component) GetName() string

GetName returns the name of the component

func (Component) GetReferences

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

GetReferences get all the references.

func (Component) GetResponsibleRole

func (c Component) GetResponsibleRole() string

GetResponsibleRole gets the responsible party / role for the component.

func (Component) GetVerifications

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

GetVerifications get all the verifications.

func (Component) GetVersion

func (c Component) GetVersion() semver.Version

GetVersion returns the version

func (*Component) SetKey

func (c *Component) SetKey(key string)

SetKey sets the key for the component. Useful for overriding.

func (*Component) SetVersion

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

SetVersion sets the version for the component.

type Narrative

type Narrative string

Narrative is the representation of the general documentation for a particular standard and control for the component.

func (Narrative) GetKey

func (n Narrative) GetKey() string

GetKey returns a unique key (empty string for this version)

func (Narrative) GetText

func (n Narrative) GetText() string

GetText returns the text for the section

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"`
	ImplementationStatus string               `yaml:"implementation_status" json:"implementation_status"`
}

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

GetControlKey returns the control

func (Satisfies) GetControlOrigin

func (s Satisfies) GetControlOrigin() string

GetControlOrigin returns the control origin (empty string for this version)

func (Satisfies) GetControlOrigins

func (s Satisfies) GetControlOrigins() []string

GetControlOrigins returns all the control origins (empty slice for this version)

func (Satisfies) GetCoveredBy

func (s Satisfies) GetCoveredBy() common.CoveredByList

GetCoveredBy gets the list of all the CoveredBy

func (Satisfies) GetImplementationStatus

func (s Satisfies) GetImplementationStatus() string

GetImplementationStatus returns the implementation status

func (Satisfies) GetImplementationStatuses

func (s Satisfies) GetImplementationStatuses() []string

GetImplementationStatuses returns all implementation statuses (just the only one for this version)

func (Satisfies) GetNarratives

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

GetNarratives gets all the general documentation for this particular standard and control

func (Satisfies) GetParameters

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

GetParameters gets all the parameters for this particular standard and control

func (Satisfies) GetStandardKey

func (s Satisfies) GetStandardKey() string

GetStandardKey returns the standard