opencontrols

Documentation

Index

• type ControlOrigins
  • func (origins ControlOrigins) GetCheckedOrigins() *set.Set
• type Data
  • func LoadFrom(dirPath string) (data Data, errors []error)
  • func (d *Data) GetControlOrigins(control string) ControlOrigins
  • func (d *Data) GetImplementationStatuses(control string) ImplementationStatuses
  • func (d *Data) GetNarrative(control string, sectionKey string) string
  • func (d *Data) GetParameter(control string, sectionKey string) string
  • func (d *Data) GetResponsibleRoles(control string) string
• type ImplementationStatuses
  • func (statuses ImplementationStatuses) GetCheckedStatuses() *set.Set

Types

type ControlOrigins

type ControlOrigins struct {
	// contains filtered or unexported fields
}

ControlOrigins is a wrapper for the extracted data from the YAML for a particular control.

func (ControlOrigins) GetCheckedOrigins

func (origins ControlOrigins) GetCheckedOrigins() *set.Set

GetCheckedOrigins will return the list of origin keys.

type Data

type Data struct {
	// contains filtered or unexported fields
}

Data contains the OpenControl justification information.

func LoadFrom

func LoadFrom(dirPath string) (data Data, errors []error)

LoadFrom creates a new Data struct from the provided path to an `opencontrols/` directory.

func (*Data) GetControlOrigins

func (d *Data) GetControlOrigins(control string) ControlOrigins

GetControlOrigins returns the control origination information for each component matching the specified control.

func (*Data) GetImplementationStatuses

func (d *Data) GetImplementationStatuses(control string) ImplementationStatuses

GetImplementationStatuses returns the control origination information for each component matching the specified control.

func (*Data) GetNarrative

func (d *Data) GetNarrative(control string, sectionKey string) string

GetNarrative returns the justification text for the specified control. Pass an empty string for `sectionKey` if you are looking for the overall narrative.

func (*Data) GetParameter

func (d *Data) GetParameter(control string, sectionKey string) string

GetParameter returns the justification text for the specified control. Pass an empty string for `sectionKey` if you are looking for the overall narrative.

func (*Data) GetResponsibleRoles

func (d *Data) GetResponsibleRoles(control string) string

GetResponsibleRoles returns the responsible role information for each component matching the specified control.

type ImplementationStatuses

type ImplementationStatuses struct {
	// contains filtered or unexported fields
}

ImplementationStatuses is a wrapper for the extracted data from the YAML for a particular control.

func (ImplementationStatuses) GetCheckedStatuses

func (statuses ImplementationStatuses) GetCheckedStatuses() *set.Set

GetCheckedStatuses will return the list of status keys.