ssp

Documentation

Index

• Constants
• type Document
  • func Load(path string) (ssp *Document, err error)
  • func (s *Document) Close() error
  • func (s *Document) Content() string
  • func (s *Document) CopyTo(path string) error
  • func (s *Document) NarrativeTable(control string) (table xml.Node, err error)
  • func (s *Document) NarrativeTables() ([]xml.Node, error)
  • func (s *Document) ParameterTable(control string) (table xml.Node, err error)
  • func (s *Document) ParameterTables() ([]xml.Node, error)
  • func (s *Document) SummaryTables() ([]xml.Node, error)
  • func (s *Document) UpdateContent()

Constants

const SummaryTablesXPath = "//w:tbl[contains(normalize-space(.), 'Control Summary') or contains(normalize-space(.), 'Control Enhancement Summary')]"

SummaryTablesXPath is the pattern used to find summary tables within an SSP's XML.

Types

type Document

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

Document represents a system security plan file and its contents.

func Load

func Load(path string) (ssp *Document, err error)

Load creates a new Document from the provided file path.

func (*Document) Close

func (s *Document) Close() error

Close releases the underlying resources.

func (*Document) Content

func (s *Document) Content() string

Content retrieves the text from within the Word document.

func (*Document) CopyTo

func (s *Document) CopyTo(path string) error

CopyTo copies the contents of this Word document to a new file at the provided path.

func (*Document) NarrativeTable

func (s *Document) NarrativeTable(control string) (table xml.Node, err error)

NarrativeTable returns the narrative table for the specified control or control enhancement.

func (*Document) NarrativeTables

func (s *Document) NarrativeTables() ([]xml.Node, error)

NarrativeTables returns the narrative tables for all controls and the control enhancements.

func (*Document) ParameterTable

func (s *Document) ParameterTable(control string) (table xml.Node, err error)

ParameterTable returns the parameter table for the specified control or control enhancement.

func (*Document) ParameterTables

func (s *Document) ParameterTables() ([]xml.Node, error)

ParameterTables returns the parameter tables for all controls and the control enhancements.

func (*Document) SummaryTables

func (s *Document) SummaryTables() ([]xml.Node, error)

SummaryTables returns the summary tables for the controls and the control enhancements.

func (*Document) UpdateContent

func (s *Document) UpdateContent()

UpdateContent modifies the state of the underlying Word document. Note this is purely for bookkeeping in memory, and does not actually make any changes to the file.