v1alpha1

type Artifact struct {
	// Repository is the name of the repository in the Artifact registry.
	// +optional
	Repository string `json:"repository"`

	// Digest is a unique and immutable identifier of an Artifact.
	// +optional
	Digest string `json:"digest,omitempty"`

	// Tag is a mutable, human-readable string used to identify an Artifact.
	// +optional
	Tag string `json:"tag,omitempty"`

	// MimeType represents a type and format of an Artifact.
	// +optional
	MimeType string `json:"mimeType,omitempty"`
}

type BOM struct {
	BOMFormat   string `json:"bomFormat"`
	SpecVersion string `json:"specVersion"`

	SerialNumber string        `json:"serialNumber,omitempty"`
	Version      int           `json:"version,omitempty"`
	Metadata     *Metadata     `json:"metadata,omitempty"`
	Components   []*Component  `json:"components,omitempty"`
	Dependencies *[]Dependency `json:"dependencies,omitempty"`
}

type Check struct {
	ID          string   `json:"checkID"`
	Title       string   `json:"title,omitempty"`
	Description string   `json:"description,omitempty"`
	Severity    Severity `json:"severity"`
	Category    string   `json:"category,omitempty"`

	Messages []string `json:"messages,omitempty"`

	// Remediation provides description or links to external resources to remediate failing check.
	// +optional
	Remediation string `json:"remediation,omitempty"`

	Success bool `json:"success"`

	// Scope indicates the section of config that was audited.
	// +optional
	Scope *CheckScope `json:"scope,omitempty"`
}

type CheckScope struct {

	// Type indicates type of this scope, e.g. Container, ConfigMapKey or JSONPath.
	Type string `json:"type"`

	// Value indicates value of this scope that depends on Type, e.g. container name, ConfigMap key or JSONPath expression
	Value string `json:"value"`
}

type ClusterComplianceReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ReportSpec   `json:"spec,omitempty"`
	Status            ReportStatus `json:"status,omitempty"`
}

type ClusterComplianceReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []ClusterComplianceReport `json:"items"`
}

type ClusterConfigAuditReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Report ConfigAuditReportData `json:"report"`
}

type ClusterConfigAuditReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ClusterConfigAuditReport `json:"items"`
}

type ClusterInfraAssessmentReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Report InfraAssessmentReportData `json:"report"`
}

type ClusterInfraAssessmentReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ClusterInfraAssessmentReport `json:"items"`
}

type ClusterRbacAssessmentReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Report RbacAssessmentReportData `json:"report"`
}

type ClusterRbacAssessmentReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ClusterRbacAssessmentReport `json:"items"`
}

type ClusterSbomReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Report is the actual sbom report data.
	Report SbomReportData `json:"report"`
}

type ClusterSbomReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	// SbomReport is the spec for a sbom record.
	Items []ClusterSbomReport `json:"items"`
}

type ClusterVulnerabilityReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Report is the actual vulnerability report data.
	Report VulnerabilityReportData `json:"report"`
}

type ClusterVulnerabilityReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	// ClusterVulnerability is the spec for a cluster vulnerability record.
	Items []ClusterVulnerabilityReport `json:"items"`
}

type Complaince struct {
	ID               string   `json:"id"`
	Title            string   `json:"title"`
	Description      string   `json:"description"`
	Version          string   `json:"version"`
	RelatedResources []string `json:"relatedResources"`
	// Control represent the cps controls data and mapping checks
	Controls []Control `json:"controls"`
}

type ComplianceCheck struct {
	ID          string   `json:"checkID"`
	Target      string   `json:"target,omitempty"`
	Title       string   `json:"title,omitempty"`
	Description string   `json:"description,omitempty"`
	Severity    Severity `json:"severity"`
	Category    string   `json:"category,omitempty"`

	Messages []string `json:"messages,omitempty"`

	// Remediation provides description or links to external resources to remediate failing check.
	// +optional
	Remediation string `json:"remediation,omitempty"`

	Success bool `json:"success"`
}

type ComplianceReport struct {
	ID               string                `json:"id,omitempty"`
	Title            string                `json:"title,omitempty"`
	Description      string                `json:"description,omitempty"`
	Version          string                `json:"version,omitempty"`
	RelatedResources []string              `json:"relatedVersion,omitempty"`
	Results          []*ControlCheckResult `json:"results,omitempty"`
}

type ComplianceSummary struct {
	FailCount int `json:"failCount,omitempty"`
	PassCount int `json:"passCount,omitempty"`
}

type Component struct {
	BOMRef     string               `json:"bom-ref,omitempty"`
	Type       string               `json:"type,omitempty"`
	Name       string               `json:"name,omitempty"`
	Group      string               `json:"group,omitempty"`
	Version    string               `json:"version,omitempty"`
	PackageURL string               `json:"purl,omitempty"`
	Supplier   OrganizationalEntity `json:"supplier,omitempty"`
	Hashes     []Hash               `json:"hashes,omitempty"`
	Licenses   []LicenseChoice      `json:"licenses,omitempty"`
	Properties []Property           `json:"properties,omitempty"`
}

type ConfigAuditReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Report ConfigAuditReportData `json:"report"`
}

type ConfigAuditReportData struct {
	// +optional
	UpdateTimestamp metav1.Time `json:"updateTimestamp"`
	// +optional
	Scanner Scanner `json:"scanner"`
	// +optional
	Summary ConfigAuditSummary `json:"summary"`

	// Checks provides results of conducting audit steps.
	Checks []Check `json:"checks"`
}

type ConfigAuditReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ConfigAuditReport `json:"items"`
}

type ConfigAuditSummary struct {

	// CriticalCount is the number of failed checks with critical severity.
	CriticalCount int `json:"criticalCount"`

	// HighCount is the number of failed checks with high severity.
	HighCount int `json:"highCount"`

	// MediumCount is the number of failed checks with medium severity.
	MediumCount int `json:"mediumCount"`

	// LowCount is the number of failed check with low severity.
	LowCount int `json:"lowCount"`
}

type Control struct {
	// id define the control check id
	ID          string      `json:"id"`
	Name        string      `json:"name"`
	Description string      `json:"description,omitempty"`
	Checks      []SpecCheck `json:"checks,omitempty"`
	// define the severity of the control
	// +kubebuilder:validation:Enum={CRITICAL,HIGH,MEDIUM,LOW,UNKNOWN}
	Severity Severity `json:"severity"`
	// define the default value for check status in case resource not found
	// +kubebuilder:validation:Enum={PASS,WARN,FAIL}
	DefaultStatus ControlStatus `json:"defaultStatus,omitempty"`
}

type ControlCheckResult struct {
	ID            string                    `json:"id,omitempty"`
	Name          string                    `json:"name,omitempty"`
	Description   string                    `json:"description,omitempty"`
	DefaultStatus defsecTypes.ControlStatus `json:"status,omitempty"`
	Severity      string                    `json:"severity,omitempty"`
	Checks        []ComplianceCheck         `json:"checks"`
}

type ControlCheckSummary struct {
	ID        string `json:"id,omitempty"`
	Name      string `json:"name,omitempty"`
	Severity  string `json:"severity,omitempty"`
	TotalFail *int   `json:"totalFail,omitempty"`
}

type ControlStatus string

type Dependency struct {
	Ref          string    `json:"ref,omitempty"`
	Dependencies *[]string `json:"dependsOn,omitempty"`
}

type ExposedSecret struct {
	// Target is where the exposed secret was found.
	Target string `json:"target"`

	// RuleID is rule the identifier.
	RuleID string `json:"ruleID"`

	Title    string `json:"title"`
	Category string `json:"category"`
	// +kubebuilder:validation:Enum={CRITICAL,HIGH,MEDIUM,LOW}
	Severity Severity `json:"severity"`
	// Match where the exposed rule matched.
	Match string `json:"match"`
}

type ExposedSecretReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Report is the actual exposed secret report data.
	Report ExposedSecretReportData `json:"report"`
}

type ExposedSecretReportData struct {
	// UpdateTimestamp is a timestamp representing the server time in UTC when this report was updated.
	// +kubebuilder:validation:Type=string
	// +kubebuilder:validation:Format=date-time
	UpdateTimestamp metav1.Time `json:"updateTimestamp"`

	// Scanner is the scanner that generated this report.
	Scanner Scanner `json:"scanner"`

	// Registry is the registry the Artifact was pulled from.
	// +optional
	Registry Registry `json:"registry"`

	// Artifact represents a standalone, executable package of software that includes everything needed to
	// run an application.
	Artifact Artifact `json:"artifact"`

	// Summary is the exposed secrets counts grouped by Severity.
	Summary ExposedSecretSummary `json:"summary"`

	// Exposed secrets is a list of passwords, api keys, tokens and others items found in the Artifact.
	Secrets []ExposedSecret `json:"secrets"`
}

type ExposedSecretReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ExposedSecretReport `json:"items"`
}

type ExposedSecretSummary struct {
	// CriticalCount is the number of exposed secrets with Critical Severity.
	// +kubebuilder:validation:Minimum=0
	CriticalCount int `json:"criticalCount"`

	// HighCount is the number of exposed secrets with High Severity.
	// +kubebuilder:validation:Minimum=0
	HighCount int `json:"highCount"`

	// MediumCount is the number of exposed secrets with Medium Severity.
	// +kubebuilder:validation:Minimum=0
	MediumCount int `json:"mediumCount"`

	// LowCount is the number of exposed secrets with Low Severity.
	// +kubebuilder:validation:Minimum=0
	LowCount int `json:"lowCount"`
}

type Hash struct {
	Algorithm string `json:"alg,omitempty"`
	Value     string `json:"content,omitempty"`
}

type InfraAssessmentReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Report InfraAssessmentReportData `json:"report"`
}

type InfraAssessmentReportData struct {
	Scanner Scanner                `json:"scanner"`
	Summary InfraAssessmentSummary `json:"summary"`

	// Checks provides results of conducting audit steps.
	Checks []Check `json:"checks"`
}

type InfraAssessmentReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []InfraAssessmentReport `json:"items"`
}

type InfraAssessmentSummary struct {

	// CriticalCount is the number of failed checks with critical severity.
	CriticalCount int `json:"criticalCount"`

	// HighCount is the number of failed checks with high severity.
	HighCount int `json:"highCount"`

	// MediumCount is the number of failed checks with medium severity.
	MediumCount int `json:"mediumCount"`

	// LowCount is the number of failed check with low severity.
	LowCount int `json:"lowCount"`
}

type License struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	URL  string `json:"url,omitempty"`
}

type LicenseChoice struct {
	License    License `json:"license,omitempty"`
	Expression string  `json:"expression,omitempty"`
}

type Metadata struct {
	Timestamp string     `json:"timestamp,omitempty"`
	Tools     Tools      `json:"tools,omitempty"`
	Component *Component `json:"component,omitempty"`
}

type OS struct {
	// Eosl is true if OS version has reached end of service life
	// +optional
	Eosl bool `json:"eosl,omitempty"`

	// Operating System Family
	// +optional
	Family ostype.OSType `json:"family"`

	// Name or version of the OS
	// +optional
	Name string `json:"name,omitempty"`
}

type OrganizationalContact struct {
	Name  string `json:"name,omitempty"`
	Email string `json:"email,omitempty"`
	Phone string `json:"phone,omitempty"`
}

type OrganizationalEntity struct {
	Name    string                   `json:"name,omitempty"`
	URL     *[]string                `json:"url,omitempty"`
	Contact *[]OrganizationalContact `json:"contact,omitempty"`
}

type Property struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

type RbacAssessmentReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Report RbacAssessmentReportData `json:"report"`
}

type RbacAssessmentReportData struct {
	Scanner Scanner               `json:"scanner"`
	Summary RbacAssessmentSummary `json:"summary"`

	// Checks provides results of conducting audit steps.
	Checks []Check `json:"checks"`
}

type RbacAssessmentReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []RbacAssessmentReport `json:"items"`
}

type RbacAssessmentSummary struct {

	// CriticalCount is the number of failed checks with critical severity.
	CriticalCount int `json:"criticalCount"`

	// HighCount is the number of failed checks with high severity.
	HighCount int `json:"highCount"`

	// MediumCount is the number of failed checks with medium severity.
	MediumCount int `json:"mediumCount"`

	// LowCount is the number of failed check with low severity.
	LowCount int `json:"lowCount"`
}

type Registry struct {
	// Server the FQDN of registry server.
	// +optional
	Server string `json:"server"`
}

type ReportSpec struct {
	// cron define the intervals for report generation
	// +kubebuilder:validation:Pattern=`^(((([\*]{1}){1})|((\*\/){0,1}(([0-9]{1}){1}|(([1-5]{1}){1}([0-9]{1}){1}){1}))) ((([\*]{1}){1})|((\*\/){0,1}(([0-9]{1}){1}|(([1]{1}){1}([0-9]{1}){1}){1}|([2]{1}){1}([0-3]{1}){1}))) ((([\*]{1}){1})|((\*\/){0,1}(([1-9]{1}){1}|(([1-2]{1}){1}([0-9]{1}){1}){1}|([3]{1}){1}([0-1]{1}){1}))) ((([\*]{1}){1})|((\*\/){0,1}(([1-9]{1}){1}|(([1-2]{1}){1}([0-9]{1}){1}){1}|([3]{1}){1}([0-1]{1}){1}))|(jan|feb|mar|apr|may|jun|jul|aug|sep|okt|nov|dec)) ((([\*]{1}){1})|((\*\/){0,1}(([0-7]{1}){1}))|(sun|mon|tue|wed|thu|fri|sat)))$`
	Cron string `json:"cron"`
	// +kubebuilder:validation:Enum={summary,all}
	ReportFormat ReportType `json:"reportType"`
	Complaince   Complaince `json:"compliance"`
}

type ReportStatus struct {
	Summary ComplianceSummary `json:"summary,omitempty"`

	UpdateTimestamp metav1.Time `json:"updateTimestamp"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:XPreserveUnknownFields
	DetailReport *ComplianceReport `json:"detailReport,omitempty"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:XPreserveUnknownFields
	SummaryReport *SummaryReport `json:"summaryReport,omitempty"`
}

type ReportType string

type SbomReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Report is the actual sbom report data.
	Report SbomReportData `json:"report"`
}

type SbomReportData struct {
	// UpdateTimestamp is a timestamp representing the server time in UTC when this report was updated.
	// +kubebuilder:validation:Type=string
	// +kubebuilder:validation:Format=date-time
	UpdateTimestamp metav1.Time `json:"updateTimestamp"`

	// Scanner is the scanner that generated this report.
	Scanner Scanner `json:"scanner"`

	// Registry is the registry the Artifact was pulled from.
	// +optional
	Registry Registry `json:"registry"`

	// Artifact represents a standalone, executable package of software that includes everything needed to
	// run an application.
	Artifact Artifact `json:"artifact"`

	// Summary is a summary of sbom report.
	Summary SbomSummary `json:"summary"`

	// Bom is artifact bill of materials.
	Bom BOM `json:"components"`
}

type SbomReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	// SbomReport is the spec for a sbom record.
	Items []SbomReport `json:"items"`
}

type SbomSummary struct {
	// DependenciesCount is the number of dependencies in bom.
	// +kubebuilder:validation:Minimum=0
	DependenciesCount int `json:"dependenciesCount"`

	// ComponentsCount is the number of components in bom.
	// +kubebuilder:validation:Minimum=0
	ComponentsCount int `json:"componentsCount"`
}

type Scanner struct {
	// Name the name of the scanner.
	Name string `json:"name"`

	// Vendor the name of the vendor providing the scanner.
	Vendor string `json:"vendor"`

	// Version the version of the scanner.
	Version string `json:"version"`
}

type Severity string

type SpecCheck struct {
	// id define the check id as produced by scanner
	ID string `json:"id"`
}

type SummaryReport struct {
	ID              string                `json:"id,omitempty"`
	Title           string                `json:"title,omitempty"`
	SummaryControls []ControlCheckSummary `json:"controlCheck,omitempty"`
}

type Tools struct {
	Components []Component `json:"components,omitempty"`
}

type Vulnerability struct {
	// VulnerabilityID the vulnerability identifier.
	VulnerabilityID string `json:"vulnerabilityID"`

	// Resource is a vulnerable package, application, or library.
	Resource string `json:"resource"`

	// InstalledVersion indicates the installed version of the Resource.
	InstalledVersion string `json:"installedVersion"`

	// FixedVersion indicates the version of the Resource in which this vulnerability has been fixed.
	FixedVersion string `json:"fixedVersion"`
	// PublishedDate indicates the date of published CVE.
	PublishedDate string `json:"publishedDate"`
	// LastModifiedDate indicates the last date CVE has been modified.
	LastModifiedDate string `json:"lastModifiedDate"`
	// Severity level of a vulnerability or a configuration audit check.
	// +kubebuilder:validation:Enum={CRITICAL,HIGH,MEDIUM,LOW,UNKNOWN}
	Severity    Severity `json:"severity"`
	Title       string   `json:"title"`
	Description string   `json:"description,omitempty"`
	CVSSSource  string   `json:"cvsssource,omitempty"`
	PrimaryLink string   `json:"primaryLink,omitempty"`
	// +optional
	Links []string `json:"links"`
	Score *float64 `json:"score,omitempty"`
	// +optional
	Target string `json:"target"`
	// +optional
	CVSS types.VendorCVSS `json:"cvss,omitempty"`
	// +optional
	Class       string `json:"class,omitempty"`
	PackageType string `json:"packageType,omitempty"`
	PkgPath     string `json:"packagePath,omitempty"`
}

type VulnerabilityReport struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Report is the actual vulnerability report data.
	Report VulnerabilityReportData `json:"report"`
}

type VulnerabilityReportData struct {
	// UpdateTimestamp is a timestamp representing the server time in UTC when this report was updated.
	// +kubebuilder:validation:Type=string
	// +kubebuilder:validation:Format=date-time
	UpdateTimestamp metav1.Time `json:"updateTimestamp"`

	// Scanner is the scanner that generated this report.
	Scanner Scanner `json:"scanner"`

	// Registry is the registry the Artifact was pulled from.
	// +optional
	Registry Registry `json:"registry"`

	// Artifact represents a standalone, executable package of software that includes everything needed to
	// run an application.
	Artifact Artifact `json:"artifact"`

	// OS information of the artifact
	OS OS `json:"os"`

	// Summary is a summary of Vulnerability counts grouped by Severity.
	Summary VulnerabilitySummary `json:"summary"`

	// Vulnerabilities is a list of operating system (OS) or application software Vulnerability items found in the Artifact.
	Vulnerabilities []Vulnerability `json:"vulnerabilities"`
}

type VulnerabilityReportList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	// Vulnerability is the spec for a vulnerability record.
	Items []VulnerabilityReport `json:"items"`
}

type VulnerabilitySummary struct {
	// CriticalCount is the number of vulnerabilities with Critical Severity.
	// +kubebuilder:validation:Minimum=0
	CriticalCount int `json:"criticalCount"`

	// HighCount is the number of vulnerabilities with High Severity.
	// +kubebuilder:validation:Minimum=0
	HighCount int `json:"highCount"`

	// MediumCount is the number of vulnerabilities with Medium Severity.
	// +kubebuilder:validation:Minimum=0
	MediumCount int `json:"mediumCount"`

	// LowCount is the number of vulnerabilities with Low Severity.
	// +kubebuilder:validation:Minimum=0
	LowCount int `json:"lowCount"`

	// UnknownCount is the number of vulnerabilities with unknown severity.
	// +kubebuilder:validation:Minimum=0
	UnknownCount int `json:"unknownCount"`

	// NoneCount is the number of packages without any vulnerability.
	// +kubebuilder:validation:Minimum=0
	// +optional
	NoneCount int `json:"noneCount"`
}