scanner

Documentation

Index

• func NewMalysisMalwareEnricher(cc *grpc.ClientConn, config MalysisMalwareEnricherConfig) (*malysisMalwareEnricher, error)
• func NewPackageManifestScanner(config Config, readers []readers.PackageManifestReader, ...) *packageManifestScanner
• type Config
• type InsightsBasedPackageMetaEnricherConfig
• type MalysisMalwareEnricherConfig
  • func DefaultMalysisMalwareEnricherConfig() MalysisMalwareEnricherConfig
• type PackageDependencyCallbackFn
• type PackageMetaEnricher
  • func NewInsightBasedPackageEnricher(config InsightsBasedPackageMetaEnricherConfig) (PackageMetaEnricher, error)
  • func NewInsightBasedPackageEnricherV2(cc *grpc.ClientConn) (PackageMetaEnricher, error)
• type ScannerCallbackErrArgFn
• type ScannerCallbackNoArgFn
• type ScannerCallbackOnManifestFn
• type ScannerCallbackOnPackageFn
• type ScannerCallbacks

Functions

func NewMalysisMalwareEnricher

func NewMalysisMalwareEnricher(cc *grpc.ClientConn,
	config MalysisMalwareEnricherConfig) (*malysisMalwareEnricher, error)

func NewPackageManifestScanner

func NewPackageManifestScanner(config Config,
	readers []readers.PackageManifestReader,
	enrichers []PackageMetaEnricher,
	analyzers []analyzer.Analyzer,
	reporters []reporter.Reporter) *packageManifestScanner

Types

type Config

type Config struct {
	ExcludePatterns    []string
	ConcurrentAnalyzer int
	TransitiveAnalysis bool
	TransitiveDepth    int
	Experimental       bool
}

type InsightsBasedPackageMetaEnricherConfig

type InsightsBasedPackageMetaEnricherConfig struct {
	ApiUrl     string
	ApiAuthKey string
}

type MalysisMalwareEnricherConfig

type MalysisMalwareEnricherConfig struct {
	// Timeout for the enricher starting from the time of initialization.
	// This includes the time taken to submit the package for analysis and
	// waiting for the analysis to complete.
	Timeout time.Duration

	// Timeout for the gRPC operation to the Malysis service. This timeout
	// is for a single gRPC operation.
	GrpcOperationTimeout time.Duration

	// Number of workers to poll the analysis results
	QueryWorkerCount int

	// Maximum number of retries for querying the analysis results for a given
	// analysis identifier.
	MaxQueryRetries int
}

func DefaultMalysisMalwareEnricherConfig

func DefaultMalysisMalwareEnricherConfig() MalysisMalwareEnricherConfig

type PackageDependencyCallbackFn

type PackageDependencyCallbackFn func(pkg *models.Package) error

Callback to receive a discovery package dependency

type PackageMetaEnricher

type PackageMetaEnricher interface {
	// Name of the enricher
	Name() string

	// Enrich the package with meta information
	Enrich(pkg *models.Package, cb PackageDependencyCallbackFn) error

	// Wait for all the enrichments to complete
	Wait() error
}

Enrich meta information associated with the package

func NewInsightBasedPackageEnricher

func NewInsightBasedPackageEnricher(config InsightsBasedPackageMetaEnricherConfig) (PackageMetaEnricher, error)

func NewInsightBasedPackageEnricherV2

func NewInsightBasedPackageEnricherV2(cc *grpc.ClientConn) (PackageMetaEnricher, error)

NewInsightBasedPackageEnricherV2 creates a new instance of the enricher using Insights API v2. It requires a pre-configured gRPC client connection.

type ScannerCallbackErrArgFn

type ScannerCallbackErrArgFn func(error)

type ScannerCallbackNoArgFn

type ScannerCallbackNoArgFn func()

type ScannerCallbackOnManifestFn

type ScannerCallbackOnManifestFn func(manifest *models.PackageManifest)

type ScannerCallbackOnPackageFn

type ScannerCallbackOnPackageFn func(pkg *models.Package)

type ScannerCallbacks

type ScannerCallbacks struct {
	OnStartEnumerateManifest ScannerCallbackNoArgFn      // Manifest enumeration is starting
	OnEnumerateManifest      ScannerCallbackOnManifestFn // A manifest is read by reader
	OnStart                  ScannerCallbackNoArgFn      // Manifest scan phase is starting
	OnStartManifest          ScannerCallbackOnManifestFn // A manifest is starting to be scanned
	OnStartPackage           ScannerCallbackOnPackageFn  // A package analysis is starting
	OnAddTransitivePackage   ScannerCallbackOnPackageFn  // A transitive dependency is discovered
	OnDonePackage            ScannerCallbackOnPackageFn  // A package analysis is finished
	OnDoneManifest           ScannerCallbackOnManifestFn // A manifest analysis is finished
	BeforeFinish             ScannerCallbackNoArgFn      // Scan is about to finish
	OnStop                   ScannerCallbackErrArgFn     // Scan is finished
}