models

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 28, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package models provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.13.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiResponse 

type ApiResponse struct {
	Message *string `json:"message,omitempty"`
}

ApiResponse An object that is returned in all cases of failures.

type AssetInfo 

type AssetInfo struct {
	Location *string    `json:"location,omitempty"`
	Name     *string    `json:"name,omitempty"`
	Type     *AssetType `json:"type,omitempty"`
}

AssetInfo defines model for AssetInfo.

type AssetType 

type AssetType string

AssetType defines model for AssetType. 

const (
	AWSEC2Instance AssetType = "AWS EC2 Instance"
	AzureInstance  AssetType = "Azure Instance"
)

Defines values for AssetType.

type EndTime 

type EndTime = time.Time

EndTime defines model for endTime.

type ExampleFilter 

type ExampleFilter = string

ExampleFilter defines model for exampleFilter.

type Exploit 

type Exploit struct {
	CveID       *string   `json:"cveID,omitempty"`
	Description *string   `json:"description,omitempty"`
	Name        *string   `json:"name,omitempty"`
	SourceDB    *string   `json:"sourceDB,omitempty"`
	Title       *string   `json:"title,omitempty"`
	Urls        *[]string `json:"urls"`
}

Exploit defines model for Exploit.

type ExploitFindingImpact 

type ExploitFindingImpact struct {
	AffectedAssetsCount *int     `json:"affectedAssetsCount,omitempty"`
	Exploit             *Exploit `json:"exploit,omitempty"`
}

ExploitFindingImpact defines model for ExploitFindingImpact.

type FindingTrend 

type FindingTrend struct {
	Count *int       `json:"count,omitempty"`
	Time  *time.Time `json:"time,omitempty"`
}

FindingTrend Represents the total number of findings at a specific time

type FindingTrends 

type FindingTrends struct {
	FindingType *FindingType    `json:"findingType,omitempty"`
	Trends      *[]FindingTrend `json:"trends,omitempty"`
}

FindingTrends List of the total number of findings per time slot for the specific findingType.

type FindingType 

type FindingType string

FindingType defines model for FindingType. 

const (
	EXPLOIT          FindingType = "EXPLOIT"
	MALWARE          FindingType = "MALWARE"
	MISCONFIGURATION FindingType = "MISCONFIGURATION"
	PACKAGE          FindingType = "PACKAGE"
	ROOTKIT          FindingType = "ROOTKIT"
	SECRET           FindingType = "SECRET"
	VULNERABILITY    FindingType = "VULNERABILITY"
)

Defines values for FindingType.

func GetFindingTypes added in v0.5.0 

func GetFindingTypes() []FindingType

type FindingsCount 

type FindingsCount struct {
	Exploits          *int `json:"exploits,omitempty"`
	Malware           *int `json:"malware,omitempty"`
	Misconfigurations *int `json:"misconfigurations,omitempty"`
	Rootkits          *int `json:"rootkits,omitempty"`
	Secrets           *int `json:"secrets,omitempty"`
	Vulnerabilities   *int `json:"vulnerabilities,omitempty"`
}

FindingsCount total count of each finding type

type FindingsImpact 

type FindingsImpact struct {
	// Exploits Top 5 exploit findings sorted by impacted assets count
	Exploits *[]ExploitFindingImpact `json:"exploits,omitempty"`

	// Malware Top 5 malware findings sorted by impacted assets count
	Malware *[]MalwareFindingImpact `json:"malware,omitempty"`

	// Misconfigurations Top 5 misconfiguration findings sorted by impacted assets count
	Misconfigurations *[]MisconfigurationFindingImpact `json:"misconfigurations,omitempty"`

	// Packages Top 5 package findings sorted by impacted assets count
	Packages *[]PackageFindingImpact `json:"packages,omitempty"`

	// Rootkits Top 5 rootkit findings sorted by impacted assets count
	Rootkits *[]RootkitFindingImpact `json:"rootkits,omitempty"`

	// Secrets Top 5 secret findings sorted by impacted assets count
	Secrets *[]SecretFindingImpact `json:"secrets,omitempty"`

	// Vulnerabilities Top 5 vulnerability findings sorted by impacted assets count
	Vulnerabilities *[]VulnerabilityFindingImpact `json:"vulnerabilities,omitempty"`
}

FindingsImpact defines model for FindingsImpact.

type FindingsTrends 

type FindingsTrends = []FindingTrends

FindingsTrends List of finding trends for all finding types.

type GetDashboardFindingsTrendsParams 

type GetDashboardFindingsTrendsParams struct {
	StartTime StartTime `form:"startTime" json:"startTime"`
	EndTime   EndTime   `form:"endTime" json:"endTime"`
}

GetDashboardFindingsTrendsParams defines parameters for GetDashboardFindingsTrends.

type Malware 

type Malware struct {
	MalwareName *string      `json:"malwareName,omitempty"`
	MalwareType *MalwareType `json:"malwareType,omitempty"`

	// Path Path of the file that contains malware
	Path *string `json:"path,omitempty"`
}

Malware defines model for Malware.

type MalwareFindingImpact 

type MalwareFindingImpact struct {
	AffectedAssetsCount *int     `json:"affectedAssetsCount,omitempty"`
	Malware             *Malware `json:"malware,omitempty"`
}

MalwareFindingImpact defines model for MalwareFindingImpact.

type MalwareType 

type MalwareType = string

MalwareType defines model for MalwareType.

type Misconfiguration 

type Misconfiguration struct {
	Message         *string                   `json:"message,omitempty"`
	Remediation     *string                   `json:"remediation,omitempty"`
	ScannedPath     *string                   `json:"scannedPath,omitempty"`
	ScannerName     *string                   `json:"scannerName,omitempty"`
	Severity        *MisconfigurationSeverity `json:"severity,omitempty"`
	TestCategory    *string                   `json:"testCategory,omitempty"`
	TestDescription *string                   `json:"testDescription,omitempty"`
	TestID          *string                   `json:"testID,omitempty"`
}

Misconfiguration defines model for Misconfiguration.

type MisconfigurationFindingImpact 

type MisconfigurationFindingImpact struct {
	AffectedAssetsCount *int              `json:"affectedAssetsCount,omitempty"`
	Misconfiguration    *Misconfiguration `json:"misconfiguration,omitempty"`
}

MisconfigurationFindingImpact defines model for MisconfigurationFindingImpact.

type MisconfigurationSeverity 

type MisconfigurationSeverity string

MisconfigurationSeverity defines model for MisconfigurationSeverity. 

const (
	MisconfigurationHighSeverity   MisconfigurationSeverity = "MisconfigurationHighSeverity"
	MisconfigurationLowSeverity    MisconfigurationSeverity = "MisconfigurationLowSeverity"
	MisconfigurationMediumSeverity MisconfigurationSeverity = "MisconfigurationMediumSeverity"
)

Defines values for MisconfigurationSeverity.

type Package 

type Package struct {
	Name    *string `json:"name,omitempty"`
	Purl    *string `json:"purl,omitempty"`
	Version *string `json:"version,omitempty"`
}

Package defines model for Package.

type PackageFindingImpact 

type PackageFindingImpact struct {
	AffectedAssetsCount *int     `json:"affectedAssetsCount,omitempty"`
	Package             *Package `json:"package,omitempty"`
}

PackageFindingImpact defines model for PackageFindingImpact.

type RegionFindings 

type RegionFindings struct {
	// FindingsCount total count of each finding type
	FindingsCount *FindingsCount `json:"findingsCount,omitempty"`
	RegionName    *string        `json:"regionName,omitempty"`
}

RegionFindings Total findings for a region

type RiskiestAssets 

type RiskiestAssets struct {
	// Exploits Top 5 riskiest assets sorted by exploits count
	Exploits *[]RiskyAsset `json:"exploits,omitempty"`

	// Malware Top 5 riskiest assets sorted by malware count
	Malware *[]RiskyAsset `json:"malware,omitempty"`

	// Misconfigurations Top 5 riskiest assets sorted by misconfigurations count
	Misconfigurations *[]RiskyAsset `json:"misconfigurations,omitempty"`

	// Rootkits Top 5 riskiest assets sorted by rootkits count
	Rootkits *[]RiskyAsset `json:"rootkits,omitempty"`

	// Secrets Top 5 riskiest assets sorted by secrets count
	Secrets *[]RiskyAsset `json:"secrets,omitempty"`

	// Vulnerabilities Top 5 riskiest assets sorted by vulnerabilities
	Vulnerabilities *[]VulnerabilityRiskyAsset `json:"vulnerabilities,omitempty"`
}

RiskiestAssets defines model for RiskiestAssets.

type RiskiestRegions 

type RiskiestRegions struct {
	// Regions List of regions with the findings that was found on them. Regions with no findings will not be reported.
	Regions *[]RegionFindings `json:"regions,omitempty"`
}

RiskiestRegions defines model for RiskiestRegions.

type RiskyAsset 

type RiskyAsset struct {
	AssetInfo *AssetInfo `json:"assetInfo,omitempty"`
	Count     *int       `json:"count,omitempty"`
}

RiskyAsset Total number of findings for an asset

type Rootkit 

type Rootkit struct {
	RootkitName *string      `json:"rootkitName,omitempty"`
	RootkitType *RootkitType `json:"rootkitType,omitempty"`
}

Rootkit defines model for Rootkit.

type RootkitFindingImpact 

type RootkitFindingImpact struct {
	AffectedAssetsCount *int     `json:"affectedAssetsCount,omitempty"`
	Rootkit             *Rootkit `json:"rootkit,omitempty"`
}

RootkitFindingImpact defines model for RootkitFindingImpact.

type RootkitType 

type RootkitType string

RootkitType defines model for RootkitType. 

const (
	APPLICATION RootkitType = "APPLICATION"
	FIRMWARE    RootkitType = "FIRMWARE"
	KERNEL      RootkitType = "KERNEL"
	MEMORY      RootkitType = "MEMORY"
)

Defines values for RootkitType.

type Secret 

type Secret struct {
	EndColumn *int `json:"endColumn,omitempty"`
	EndLine   *int `json:"endLine,omitempty"`

	// FilePath Name of the file containing the secret
	FilePath *string `json:"filePath,omitempty"`

	// Fingerprint Note: this is not unique
	Fingerprint *string `json:"fingerprint,omitempty"`
	StartColumn *int    `json:"startColumn,omitempty"`
	StartLine   *int    `json:"startLine,omitempty"`
}

Secret defines model for Secret.

type SecretFindingImpact 

type SecretFindingImpact struct {
	AffectedAssetsCount *int    `json:"affectedAssetsCount,omitempty"`
	Secret              *Secret `json:"secret,omitempty"`
}

SecretFindingImpact defines model for SecretFindingImpact.

type StartTime 

type StartTime = time.Time

StartTime defines model for startTime.

type UnknownError 

type UnknownError = ApiResponse

UnknownError An object that is returned in all cases of failures.

type VulnerabilitiesFindingImpact 

type VulnerabilitiesFindingImpact = []VulnerabilityFindingImpact

VulnerabilitiesFindingImpact defines model for VulnerabilitiesFindingImpact.

type Vulnerability 

type Vulnerability struct {
	Cvss              *[]VulnerabilityCvss   `json:"cvss"`
	Severity          *VulnerabilitySeverity `json:"severity,omitempty"`
	VulnerabilityName *string                `json:"vulnerabilityName,omitempty"`
}

Vulnerability defines model for Vulnerability.

type VulnerabilityCvss 

type VulnerabilityCvss struct {
	Metrics *VulnerabilityCvssMetrics `json:"metrics,omitempty"`
	Vector  *string                   `json:"vector,omitempty"`
	Version *string                   `json:"version,omitempty"`
}

VulnerabilityCvss defines model for VulnerabilityCvss.

type VulnerabilityCvssMetrics 

type VulnerabilityCvssMetrics struct {
	BaseScore           *float32 `json:"baseScore,omitempty"`
	ExploitabilityScore *float32 `json:"exploitabilityScore,omitempty"`
	ImpactScore         *float32 `json:"impactScore,omitempty"`
}

VulnerabilityCvssMetrics defines model for VulnerabilityCvssMetrics.

type VulnerabilityFindingImpact 

type VulnerabilityFindingImpact struct {
	AffectedAssetsCount *int           `json:"affectedAssetsCount,omitempty"`
	Vulnerability       *Vulnerability `json:"vulnerability,omitempty"`
}

VulnerabilityFindingImpact defines model for VulnerabilityFindingImpact.

type VulnerabilityRiskyAsset 

type VulnerabilityRiskyAsset struct {
	AssetInfo                      *AssetInfo `json:"assetInfo,omitempty"`
	CriticalVulnerabilitiesCount   *int       `json:"criticalVulnerabilitiesCount,omitempty"`
	HighVulnerabilitiesCount       *int       `json:"highVulnerabilitiesCount,omitempty"`
	LowVulnerabilitiesCount        *int       `json:"lowVulnerabilitiesCount,omitempty"`
	MediumVulnerabilitiesCount     *int       `json:"mediumVulnerabilitiesCount,omitempty"`
	NegligibleVulnerabilitiesCount *int       `json:"negligibleVulnerabilitiesCount,omitempty"`
}

VulnerabilityRiskyAsset Total number of vulnerability findings for an asset

type VulnerabilitySeverity 

type VulnerabilitySeverity string

VulnerabilitySeverity defines model for VulnerabilitySeverity. 

const (
	CRITICAL   VulnerabilitySeverity = "CRITICAL"
	HIGH       VulnerabilitySeverity = "HIGH"
	LOW        VulnerabilitySeverity = "LOW"
	MEDIUM     VulnerabilitySeverity = "MEDIUM"
	NEGLIGIBLE VulnerabilitySeverity = "NEGLIGIBLE"
)

Defines values for VulnerabilitySeverity.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.