types

Documentation

Index

• type AttachedCapability
• type Capability
  • func (capability *Capability) PayloadError(message string)
• type ChangedFile
• type ClientOptions
• type ContainerReport
• type Report
• type TargetContainer

Types

type AttachedCapability

type AttachedCapability struct {
	Capability
	Harvest func(*AttachedCapability, string, []string) `json:"-"`
}

AttachedCapability embedded type adds a Harvest function field. This function is responsible for populating the Payload field.

type Capability

type Capability struct {
	Schema      string                 `json:"$schema"`
	Title       string                 `json:"title"`
	Name        string                 `json:"-"`
	Description string                 `json:"-"`
	Type        string                 `json:"type"`
	HarvestID   string                 `json:"harvestid"`
	Payload     map[string]interface{} `json:"payload,omitempty"`
	SupportedOS map[string]int         `json:"-"`
}

Capability map of harvested capability data

func (*Capability) PayloadError

func (capability *Capability) PayloadError(message string)

PayloadError records an error message in a capability.Payload

type ChangedFile

type ChangedFile struct {
	Kind uint8  `json:"kind"`
	Path string `json:"path"`
}

ChangedFile represents a file in a container that has been changed from that originally provided in the containers image, where Path is the file which has changed and Kind is the type of change. This is based on Dockers container.ContainerChangeResponseItem

type ClientOptions

type ClientOptions struct {
	KeepHarvesters bool
	ConsumerURL    string
	Timeout        int
}

ClientOptions contains options passed to the command line

type ContainerReport

type ContainerReport struct {
	Schema               string                `json:"$schema"`
	Generated            string                `json:"generated"`
	ContainerReportID    string                `json:"container_report_id"`
	ContainerID          string                `json:"container_id"`
	HarvesterContainerID string                `json:"-"`
	ContainerName        string                `json:"container_name"`
	Capabilities         map[string]Capability `json:"capabilities"`
}

ContainerReport contains the gathered capabilities from a single container

type Report

type Report struct {
	Schema        string                     `json:"$schema"`
	Generated     string                     `json:"generated"`
	Owner         string                     `json:"owner"`
	Group         []string                   `json:"group"`
	ClientVersion version.ClientVersion      `json:"client_version"`
	ReportID      string                     `json:"reportid"`
	Containers    map[string]ContainerReport `json:"containers"`
}

Report Lumogon metadata report includes details of the client performing the capture and a map of all harvested containers and their capability data

type TargetContainer

type TargetContainer struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	OSID string `json:"os_id"`
}

TargetContainer contains the information needed to address a specific container whose data will be gathered