common

Documentation

Index

• Constants
• func RemoveTrailingComma(jsonString string) string
• type ImageScanEvent
  • func (r *ImageScanEvent) IsManifest() bool
• type ImageScanExecutionDetail
• type ImageScanHistoryListingResponse
• type ImageScanHistoryResponse
• type ImageScanRenderDto
• type ImageScanRequest
• type ManifestData
• type RegistryType
• type ScanEventResponse
• type SeverityCount
• type SourceSubType
• type SourceType
• type Vulnerabilities

Constants

const (
	AWSAccessKeyId     = "AWS_ACCESS_KEY_ID"
	AWSSecretAccessKey = "AWS_SECRET_ACCESS_KEY"
	AWSRegion          = "AWS_DEFAULT_REGION"
	Username           = "USERNAME"
	Password           = "PASSWORD"
	GCR_FILE_PATH      = "FILE_PATH"
	IMAGE_NAME         = "IMAGE_NAME"
	OUTPUT_FILE_PATH   = "OUTPUT_FILE_PATH"
	EXTRA_ARGS         = "EXTRA_ARGS"
	CA_CERT_FILE_PATH  = "CA_CERT_FILE_PATH"
)

const (
	SHELL_COMMAND = "sh"
	COMMAND_ARGS  = "-c"
)

const (
	CaCertDirectory          = "security/certs"
	RegistryCaCertFilePrefix = "registry-ca-cert-"
)

const (
	INSECURE       = "insecure"
	SECUREWITHCERT = "secure-with-cert"
)

const (
	ScanObjectType_APP   string = "app"
	ScanObjectType_CHART string = "chart"
	ScanObjectType_POD   string = "pod"
)

Functions

func RemoveTrailingComma

func RemoveTrailingComma(jsonString string) string

Types

type ImageScanEvent

type ImageScanEvent struct {
	Image            string                 `json:"image"`
	ImageDigest      string                 `json:"imageDigest"`
	AppId            int                    `json:"appId"`
	EnvId            int                    `json:"envId"`
	PipelineId       int                    `json:"pipelineId"`
	CiArtifactId     int                    `json:"ciArtifactId"`
	UserId           int                    `json:"userId"`
	AccessKey        string                 `json:"accessKey"`
	SecretKey        string                 `json:"secretKey"`
	Token            string                 `json:"token"`
	AwsRegion        string                 `json:"awsRegion"`
	DockerRegistryId string                 `json:"dockerRegistryId"`
	DockerConnection string                 `json:"dockerConnection"`
	DockerCert       string                 `json:"dockerCert"`
	CiProjectDetails []git.CiProjectDetails `json:"ciProjectDetails"`
	SourceType       SourceType             `json:"sourceType"`
	SourceSubType    SourceSubType          `json:"sourceSubType"`
	CiWorkflowId     int                    `json:"ciWorkflowId"`
	CdWorkflowId     int                    `json:"cdWorkflowId"`
	ChartHistoryId   int                    `json:"chartHistoryId"`
	ManifestData     *ManifestData          `json:"manifestData"`
	ReScan           bool                   `json:"reScan"`
}

func (*ImageScanEvent) IsManifest

func (r *ImageScanEvent) IsManifest() bool

type ImageScanExecutionDetail

type ImageScanExecutionDetail struct {
	ImageScanDeployInfoId int                `json:"imageScanDeployInfoId"`
	AppId                 int                `json:"appId,omitempty"`
	EnvId                 int                `json:"envId,omitempty"`
	AppName               string             `json:"appName,omitempty"`
	EnvName               string             `json:"envName,omitempty"`
	ArtifactId            int                `json:"artifactId,omitempty"`
	Image                 string             `json:"image,omitempty"`
	PodName               string             `json:"podName,omitempty"`
	ReplicaSet            string             `json:"replicaSet,omitempty"`
	Vulnerabilities       []*Vulnerabilities `json:"vulnerabilities,omitempty"`
	SeverityCount         *SeverityCount     `json:"severityCount,omitempty"`
	ExecutionTime         time.Time          `json:"executionTime,omitempty"`
}

type ImageScanHistoryListingResponse

type ImageScanHistoryListingResponse struct {
	Offset                   int                         `json:"offset"`
	Size                     int                         `json:"size"`
	ImageScanHistoryResponse []*ImageScanHistoryResponse `json:"scanList"`
}

type ImageScanHistoryResponse

type ImageScanHistoryResponse struct {
	ImageScanDeployInfoId int            `json:"imageScanDeployInfoId"`
	AppId                 int            `json:"appId"`
	EnvId                 int            `json:"envId"`
	Name                  string         `json:"name"`
	Type                  string         `json:"type"`
	Environment           string         `json:"environment"`
	LastChecked           time.Time      `json:"lastChecked"`
	Image                 string         `json:"image,omitempty"`
	SeverityCount         *SeverityCount `json:"severityCount,omitempty"`
}

type ImageScanRenderDto

type ImageScanRenderDto struct {
	RegistryType       RegistryType `json:"-"`
	AWSAccessKeyId     string       `json:"awsAccessKeyId,omitempty" `
	AWSSecretAccessKey string       `json:"awsSecretAccessKey,omitempty"`
	AWSRegion          string       `json:"awsRegion"`
	Username           string       `json:"username,omitempty"`
	Password           string       `json:"password,omitempty"`
	Image              string       `json:"image"`
	OutputFilePath     string       `json:"-"`
	CaCertFilePath     string       `json:"-"`
	DockerConnection   string       `json:"-"`
}

type ImageScanRequest

type ImageScanRequest struct {
	ScanExecutionId       int    `json:"ScanExecutionId"`
	ImageScanDeployInfoId int    `json:"imageScanDeployInfo"`
	AppId                 int    `json:"appId"`
	EnvId                 int    `json:"envId"`
	ArtifactId            int    `json:"artifactId"`
	CVEName               string `json:"CveName"`
	Image                 string `json:"image"`
	ViewFor               int    `json:"viewFor"`
	Offset                int    `json:"offset"`
	Size                  int    `json:"size"`
	PipelineId            int    `json:"pipelineId"`
	PipelineType          string `json:"pipelineType"`
}

type ManifestData

type ManifestData struct {
	ChartData  []byte `json:"chartData"`
	ValuesYaml []byte `json:"valuesYaml"`
}

type RegistryType

type RegistryType string

type ScanEventResponse

type ScanEventResponse struct {
	RequestData         *ImageScanEvent            `json:"requestData"`
	ResponseDataClairV4 []*claircore.Vulnerability `json:"responseDataClairV4"`
	ResponseDataClairV2 []*clair.Vulnerability     `json:"ResponseDataClairV2"`
	CodeScanRes         interface{}                `json:"codeScanResponse"`
}

type SeverityCount

type SeverityCount struct {
	High     int `json:"high"`
	Moderate int `json:"moderate"`
	Low      int `json:"low"`
}

type SourceSubType

type SourceSubType int

const (
	SourceSubTypeCi       SourceSubType = 1 // relevant for ci code(2,1) or ci built image(1,1)
	SourceSubTypeManifest SourceSubType = 2 // relevant for devtron app deployment manifest/helm app manifest(2,2) or images retrieved from manifest(1,2))
)

type SourceType

type SourceType int

multiple history rows for one source event

const (
	SourceTypeImage SourceType = 1
	SourceTypeCode  SourceType = 2
	SourceTypeSbom  SourceType = 3 // can be used in future for direct sbom scanning
)

type Vulnerabilities

type Vulnerabilities struct {
	CVEName    string `json:"cveName"`
	Severity   string `json:"severity"`
	Package    string `json:"package"`
	CVersion   string `json:"currentVersion"`
	FVersion   string `json:"fixedVersion"`
	Permission string `json:"permission"`
}