v2

Documentation

Index

• Variables
• type ControlSummary
• type FrameworkSummary
• type PostureReport
  • func GetPostureReportMockPassedSingleResource() *PostureReport
  • func (pr *PostureReport) ToBytes() ([]byte, error)
  • func (pr *PostureReport) ToString() string
• type Resource
  • func GetResourcesListMock() []Resource
• type ResourceAssociatedControl
• type ResourceAssociatedRule
• type Result
• type SummaryDetails

Variables

var PostureReportMockPassedSingleResource = `` /* 6734-byte string literal not displayed */

var ResourcesListMock = `` /* 69799-byte string literal not displayed */

Types

type ControlSummary

type ControlSummary struct {
	Score            float32 `json:"score"`
	PassedResources  int     `json:"passedResources"`
	FailedResources  int     `json:"failedResources"`
	WarningResources int     `json:"warningResources"`
	SkippedResources int     `json:"skippedResources"`
	Status           string  `json:"status"`
}

FrameworkSummary summary of scanning from a single control perspective

type FrameworkSummary

type FrameworkSummary struct {
	Score    float32                   `json:"score"`              // framework score
	Name     string                    `json:"name"`               // framework name
	Version  string                    `json:"version"`            // framework version
	Controls map[string]ControlSummary `json:"controls,omitempty"` // mapping of control - map[<control ID>]<control summary>
}

FrameworkSummary summary of scanning from a single framework perspective

type PostureReport

type PostureReport struct {
	CustomerGUID         string         `json:"customerGUID"`
	ClusterName          string         `json:"clusterName"`
	ClusterAPIServerInfo *version.Info  `json:"clusterAPIServerInfo"`
	ClusterCloudProvider string         `json:"clusterCloudProvider"`
	ReportID             string         `json:"reportID"`
	JobID                string         `json:"jobID"`
	ReportGenerationTime time.Time      `json:"generationTime"`
	SummaryDetails       SummaryDetails `json:"summaryDetails,omitempty"` // Developing
	Results              []Result       `json:"results,omitempty"`        // Developing
	Resources            []Resource     `json:"resource,omitempty"`
}

PostureReport posture scanning report structure

func GetPostureReportMockPassedSingleResource

func GetPostureReportMockPassedSingleResource() *PostureReport

func (*PostureReport) ToBytes

func (pr *PostureReport) ToBytes() ([]byte, error)

func (*PostureReport) ToString

func (pr *PostureReport) ToString() string

type Resource

type Resource struct {
	ResourceID string         `json:"resourceID"`
	Object     interface{}    `json:"object"`
	IMetadata  ik8s.IMetadata `json:"-"`
}

Resource single resource representation from resource inventory

func GetResourcesListMock

func GetResourcesListMock() []Resource

type ResourceAssociatedControl

type ResourceAssociatedControl struct {
	ControlID               string
	ResourceAssociatedRules []ResourceAssociatedRule
}

ResourceAssociatedControl control that is associated to a resource

type ResourceAssociatedRule

type ResourceAssociatedRule struct {
	RuleName    string                            `json:"ruleName"`
	FailedPaths []string                          `json:"failedPaths"`
	Status      string                            // "failed/passed/warning  ?skipped?"
	Exception   *armotypes.PostureExceptionPolicy `json:"exception,omitempty"`
}

ResourceAssociatedRule failed rule that is associated to a resource

type Result

type Result struct {
	ResourceID         string
	AssociatedControls []ResourceAssociatedControl
}

Result - resource result resourceID and the controls that where tested against the resource

type SummaryDetails

type SummaryDetails struct {
	Frameworks []FrameworkSummary        `json:"frameworks"`         // list of framework summary
	Controls   map[string]ControlSummary `json:"controls,omitempty"` // mapping of control - map[<control ID>]<control summary>
}

SummaryDetails detailed summary of the scanning. will contain versions, counters, etc.