scan

Documentation

Index

• func ExtractImagesFromTar(tarFilePath string) ([]string, error)
• func NewLocalPackageScanner(logger types.Logger, dockerConfigPath, packagePath string) (types.PackageScanner, error)
• func NewRemotePackageScanner(ctx context.Context, logger types.Logger, ...) types.PackageScanner
• type ImageIndex
• type ImageManifest
• type LocalPackageScanner
  • func (lps *LocalPackageScanner) Scan(ctx context.Context) ([]string, error)
  • func (lps *LocalPackageScanner) ScanResultReader(jsonFilePath string) (types.ScanResultReader, error)
• type Scanner
  • func (s *Scanner) Scan(ctx context.Context) ([]string, error)
  • func (s *Scanner) ScanResultReader(jsonFilePath string) (types.ScanResultReader, error)
  • func (s *Scanner) ScanZarfPackage(org, packageName, tag string) ([]string, error)
• type ScannerFactoryImpl
  • func (sf *ScannerFactoryImpl) CreateScanner(ctx context.Context, logger types.Logger, ...) (types.PackageScanner, error)

Functions

func ExtractImagesFromTar

func ExtractImagesFromTar(tarFilePath string) ([]string, error)

ExtractImagesFromTar extracts images from the tar archive and returns names of the container images. Parameters: - tarFilePath: the path to the tar archive to extract the images from. Returns: - []string: the names of the container images. - error: an error if the extraction fails.

func NewLocalPackageScanner

func NewLocalPackageScanner(logger types.Logger, dockerConfigPath, packagePath string) (types.PackageScanner, error)

NewLocalPackageScanner creates a new LocalPackageScanner instance. Parameters: - logger: the logger to use for logging. - dockerConfigPath: the path to the docker configuration file. - packagePath: the path to the zarf package to scan. Returns: - *LocalPackageScanner: the LocalPackageScanner instance. - error: an error if the instance cannot be created.

func NewRemotePackageScanner

func NewRemotePackageScanner(
	ctx context.Context,
	logger types.Logger,
	dockerConfigPath,
	org,
	packageName,
	tag string,
) types.PackageScanner

NewRemotePackageScanner creates a new Scanner for remote packages.

Types

type ImageIndex

type ImageIndex struct {
	MediaType     string          `json:"mediaType"`
	Manifests     []ImageManifest `json:"manifests"`
	SchemaVersion int             `json:"schemaVersion"`
}

ImageIndex represents the structure of the index.json file.

type ImageManifest

type ImageManifest struct {
	Annotations struct {
		BaseName string `json:"org.opencontainers.image.base.name"`
	} `json:"annotations"`
	MediaType string `json:"mediaType"`
	Digest    string `json:"digest"`
	Size      int    `json:"size"`
}

ImageManifest represents the structure of the image manifest in the index.json file.

type LocalPackageScanner

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

LocalPackageScanner is a struct that holds the logger and paths for docker configuration and package.

func (*LocalPackageScanner) Scan

func (lps *LocalPackageScanner) Scan(ctx context.Context) ([]string, error)

Scan scans the package and returns the scan results which are trivy scan results in json format. Parameters: - ctx: the context to use for the scan. Returns: - []string: the scan results which are trivy scan results in json format. - error: an error if the scan fails.

func (*LocalPackageScanner) ScanResultReader

func (lps *LocalPackageScanner) ScanResultReader(jsonFilePath string) (types.ScanResultReader, error)

ScanResultReader reads the scan result from the json file and returns the scan result. Parameters: - jsonFilePath: the path to the json file to read the scan result from. Returns: - types.ScanResultReader: the scan result. - error: an error if the reading fails.

type Scanner

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

Scanner implements the PackageScanner interface for remote packages.

func (*Scanner) Scan

func (s *Scanner) Scan(ctx context.Context) ([]string, error)

Scan scans the remote package and returns the scan results.

func (*Scanner) ScanResultReader

func (s *Scanner) ScanResultReader(jsonFilePath string) (types.ScanResultReader, error)

ScanResultReader creates a new ScanResultReader from a JSON file. This takes a trivy scan result file and returns a ScanResultReader.

Parameters:

• jsonFilePath: The path to the JSON file containing the scan results.

Returns:

• types.ScanResultReader: An instance of ScanResultReader that can be used to access the scan results.
• error: An error if the file cannot be opened or the JSON cannot be decoded.

func (*Scanner) ScanZarfPackage

func (s *Scanner) ScanZarfPackage(org, packageName, tag string) ([]string, error)

ScanZarfPackage scans a Zarf package and returns the scan results.

Parameters:

• org: The organization that owns the package.
• packageName: The name of the package to scan.
• tag: The tag of the package to scan.

Returns:

• []string: A slice of file paths containing the scan results in JSON format.
• error: An error if the scan operation fails.

type ScannerFactoryImpl

type ScannerFactoryImpl struct{}

ScannerFactoryImpl is the implementation of the ScannerFactory interface.

func (*ScannerFactoryImpl) CreateScanner

func (sf *ScannerFactoryImpl) CreateScanner(ctx context.Context, logger types.Logger,
	dockerConfigPath, org, packageName, tag, packagePath string) (types.PackageScanner, error)

CreateScanner creates a new PackageScanner based on the provided options.