scap

Documentation

Overview

Package scap implements some internal parsing of the OpenSCAP analysis results.

Index

• type Document
  • func ReadDocument(r io.Reader) (*Document, error)
• type Item
• type Object
• type SystemCharacteristics
  • func SysChar(doc *Document) (*SystemCharacteristics, error)
• type SystemInfo

Types

type Document

type Document struct {
	Type constants.DocumentType `json:"-"`
	*cdf.Benchmark
	*cpe_dict.CpeList
	*oval_def.OvalDefinitions
	*oval_res.OvalResults
	*oval_sc.OvalSystemCharacteristics
	*ds.DataStreamCollection
	*inter.Ocil
}

Document contains all the returned informations of an openscap evaluation.

func ReadDocument

func ReadDocument(r io.Reader) (*Document, error)

ReadDocument takes an io.Reader and return a Document or error if failed.

type Item

type Item struct {
	ID       string            `json:"id"`
	Messages map[string]string `json:"messages"`
}

Item contains the messages of an OVAL Object's fields.

type Object

type Object struct {
	ID    string `json:"id"`
	Items []Item `json:"items,omitempty"`
}

Object contains the informations of a specific OVAL Object.

type SystemCharacteristics

type SystemCharacteristics struct {
	SystemInfo SystemInfo `json:"system_info"`
	Objects    []Object   `json:"objects,omitempty"`
}

SystemCharacteristics contains the internal charasteristics of an OVAL evaluation.

func SysChar

func SysChar(doc *Document) (*SystemCharacteristics, error)

SysChar returns the refined system characteristics from a Document.

type SystemInfo

type SystemInfo struct {
	OsName          string `json:"os_name"`
	OsVersion       string `json:"os_version"`
	Architecture    string `json:"architecture"`
	PrimaryHostName string `json:"primary_host_name"`
}

SystemInfo is an internal field of SystemCharacteristics contains the global system informations.