v1

README

GCP Adaptor

How we add gcp adaptor

As there can be possiblities of use of multiple registries we check for each adaptor if we have required credentias. For every adaptor having credentials we append the adaptor to the adaptors slice.

Particularly for gcp, we frstly bring the gcpCloudAPI from the connector. We still haven't created a proper function that initiats the gcpCloudAPI with projectId, credentialsPath, credentialsCheck fields. We check for credentialsCheck bool which is set true when we have credentials(to be set when initializing the gcpCloudAPI)

How we fetch vulnerabilities for images

Step 1: Get container analysis client For this we needs credentials of the service account. Out of few approaches here we are using JSON key file for credentials and path to this file should be stored in credentialsPath

Step 2: Do ListOccurrenceRequest For this we need the projectID and the resourceUrl. ProjectID should be provided by the users and resourceUrl is processed imageTag that we get from kubescape resources

Step 3: Get Occurrence iterator We use context and the request from the ListOccurenceRequest to get the iterators

How we convert the response to Vulnerabilities

Response from the iterator has two type of kinds i.e. Discovery and Vulnerabilties and both has differnent struct

How can this adaptor be used by the user

To know about GCR service accounts follow https://cloud.google.com/container-registry/docs/gcr-service-account export variables export KS_GCP_CREDENTIALS_PATH=<path to service account credentials file> export KS_GCP_PROJECT_ID=<your project ID>

Documentation

Index

• type GCPAdaptor
  • func NewGCPAdaptor(GCPCloudAPI *getter.GCPCloudAPI) *GCPAdaptor
  • func (GCPAdaptor *GCPAdaptor) DescribeAdaptor() string
  • func (GCPAdaptor *GCPAdaptor) GetImageVulnerability(imageID *registryvulnerabilities.ContainerImageIdentifier) (*registryvulnerabilities.ContainerImageVulnerabilityReport, error)
  • func (GCPAdaptor *GCPAdaptor) GetImagesInformation(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageInformation, error)
  • func (GCPAdaptor *GCPAdaptor) GetImagesScanStatus(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageScanStatus, error)
  • func (GCPAdaptor *GCPAdaptor) GetImagesVulnerabilities(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageVulnerabilityReport, error)
  • func (GCPAdaptor *GCPAdaptor) Login() error
• type GCPAdaptorMock
  • func NewGCPAdaptorMock() (*GCPAdaptorMock, error)
  • func (GCPAdaptorMock *GCPAdaptorMock) DescribeAdaptor() string
  • func (GCPAdaptorMock *GCPAdaptorMock) GetImageVulnerability(imageID *registryvulnerabilities.ContainerImageIdentifier) (*registryvulnerabilities.ContainerImageVulnerabilityReport, error)
  • func (GCPAdaptorMock *GCPAdaptorMock) GetImagesInformation(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageInformation, error)
  • func (GCPAdaptorMock *GCPAdaptorMock) GetImagesScanStatus(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageScanStatus, error)
  • func (GCPAdaptorMock *GCPAdaptorMock) GetImagesVulnerabilities(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageVulnerabilityReport, error)
  • func (GCPAdaptorMock *GCPAdaptorMock) Login() error
• type Mock
  • func GetMockData() []Mock

Types

type GCPAdaptor

type GCPAdaptor struct {
	GCPCloudAPI *getter.GCPCloudAPI
}

func NewGCPAdaptor

func NewGCPAdaptor(GCPCloudAPI *getter.GCPCloudAPI) *GCPAdaptor

func (*GCPAdaptor) DescribeAdaptor

func (GCPAdaptor *GCPAdaptor) DescribeAdaptor() string

func (*GCPAdaptor) GetImageVulnerability

func (GCPAdaptor *GCPAdaptor) GetImageVulnerability(imageID *registryvulnerabilities.ContainerImageIdentifier) (*registryvulnerabilities.ContainerImageVulnerabilityReport, error)

func (*GCPAdaptor) GetImagesInformation

func (GCPAdaptor *GCPAdaptor) GetImagesInformation(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageInformation, error)

func (*GCPAdaptor) GetImagesScanStatus

func (GCPAdaptor *GCPAdaptor) GetImagesScanStatus(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageScanStatus, error)

func (*GCPAdaptor) GetImagesVulnerabilities

func (GCPAdaptor *GCPAdaptor) GetImagesVulnerabilities(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageVulnerabilityReport, error)

func (*GCPAdaptor) Login

func (GCPAdaptor *GCPAdaptor) Login() error

type GCPAdaptorMock

type GCPAdaptorMock struct {
	// contains filtered or unexported fields
}

func NewGCPAdaptorMock

func NewGCPAdaptorMock() (*GCPAdaptorMock, error)

func (*GCPAdaptorMock) DescribeAdaptor

func (GCPAdaptorMock *GCPAdaptorMock) DescribeAdaptor() string

func (*GCPAdaptorMock) GetImageVulnerability

func (GCPAdaptorMock *GCPAdaptorMock) GetImageVulnerability(imageID *registryvulnerabilities.ContainerImageIdentifier) (*registryvulnerabilities.ContainerImageVulnerabilityReport, error)

func (*GCPAdaptorMock) GetImagesInformation

func (GCPAdaptorMock *GCPAdaptorMock) GetImagesInformation(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageInformation, error)

func (*GCPAdaptorMock) GetImagesScanStatus

func (GCPAdaptorMock *GCPAdaptorMock) GetImagesScanStatus(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageScanStatus, error)

func (*GCPAdaptorMock) GetImagesVulnerabilities

func (GCPAdaptorMock *GCPAdaptorMock) GetImagesVulnerabilities(imageIDs []registryvulnerabilities.ContainerImageIdentifier) ([]registryvulnerabilities.ContainerImageVulnerabilityReport, error)

func (*GCPAdaptorMock) Login

func (GCPAdaptorMock *GCPAdaptorMock) Login() error

type Mock

type Mock struct {
	Name             string
	Notename         string
	CvssScore        float32
	CreatedTime      int64
	UpdatedTime      int64
	Type             string
	ShortDescription string
	AffectedCPEURI   string
	AffectedPackage  string
	FixAvailable     bool
	AffectedVersion  string
	FixedVersion     string
}

func GetMockData

func GetMockData() []Mock