core

type AgentInfo struct {
	BuildCommit    string            // Debug information about the agent executable
	BuildTimestamp string            // Debug information about the agent executable
	ApiVersion     scanUtils.Version // API version compiled into the binaries, allowing the broker to reject outdated incompatible agents
	Name           string            // Instance name of the scan agent. There may be multiple scan agents running on the same system (e.g. to target different scan scopes).
	Host           string            // Host used during scanning. Logged by the broker. Decided by scan agent, because only it knows the IP address of it's scanning interface.
	Ip             string            // Ip address used during scanning. Logged by the broker. Decided by scan agent, because only it knows the IP address of it's scanning interface.
	Shared         bool              // Whether the agent is serving multiple scan scopes
	Limits         bool              // Whether the agent has dedicated limits configured in the config
}

type ArgsGetScanTask struct {
	AgentInfo                    // Identifying scan agent information to distinguish scan agent instances for informational purposes
	ScopeSecret string           // Scan scope secret to authenticate/associate this scan result to
	ModuleData  []ModuleData     // List of already running modules/tasks on the agent
	SystemData  utils.SystemData // Some system information, like CPU load,...
}

type ArgsSaveScanResult struct {
	AgentInfo               // Identifying scan agent information to distinguish scan agent instances for informational purposes
	ScopeSecret string      // Scan scope secret to authenticate/associate this scan result to
	Id          uint64      // Id is passed back to allow the broker associating this result set with the original request. The Id might be either the t_discovery entry ID from the scope db or the t_sub_input entry ID from the brokerdb.
	Result      interface{} // Generic interface that holds structure for different scan results
}

type Broker struct{}

type ModuleData struct {
	Label          string // Name of the respective module, as used by the scan module itself
	MaxInstances   int    // Maximum total amount of instances the agent wants to handle, as configured in its config
	TotalInstances int    // Total amount of instances currently running on the scan agent, across all scan scopes
	ScopeInstances int    // Amount of instances currently running on the scan agent, in the current scan scope
}

type ReplyGetScanTask struct {
	ScanTasks []ScanTask
}

type ScanTask struct {
	Secret         string // Scope secret identifying the scan scope this scan tasks belongs to
	Label          string // Name of the respective module to use these arguments with
	Id             uint64 // PK from the source table (might be a t_discovery ID (scope db) or a sub scan target ID (broker db)
	Target         string
	Protocol       string
	Port           int
	OtherNames     []string
	Service        string
	ServiceProduct string
	ScanSettings   managerdb.T_scan_setting // Current scan settings taken from the scan scope
}