engine

Documentation

Index

• func DefaultDetectorTypesImplementing[T any]() map[detectorspb.DetectorType]struct{}
• func DefaultDetectors() []detectors.Detector
• func FragmentFirstLine(chunk *sources.Chunk) (int64, *int64)
• func FragmentLineOffset(chunk *sources.Chunk, result *detectors.Result) int64
• func SetResultLineNumber(chunk *sources.Chunk, result *detectors.Result, fragStart int64, mdLine *int64)
• func SupportsLineNumbers(sourceType sourcespb.SourceType) bool
• type Engine
  • func Start(ctx context.Context, options ...EngineOption) *Engine
  • func (e *Engine) BytesScanned() uint64
  • func (e *Engine) ChunksChan() chan *sources.Chunk
  • func (e *Engine) ChunksScanned() uint64
  • func (e *Engine) DetectorAvgTime() map[string][]time.Duration
  • func (e *Engine) Finish(ctx context.Context, logFunc func(error, string, ...any))
  • func (e *Engine) ResultsChan() chan detectors.ResultWithMetadata
  • func (e *Engine) ScanCircleCI(ctx context.Context, token string) error
  • func (e *Engine) ScanDocker(ctx context.Context, conn *anypb.Any) error
  • func (e *Engine) ScanFileSystem(ctx context.Context, c sources.FilesystemConfig) error
  • func (e *Engine) ScanGCS(ctx context.Context, c sources.GCSConfig) error
  • func (e *Engine) ScanGit(ctx context.Context, c sources.GitConfig) error
  • func (e *Engine) ScanGitHub(ctx context.Context, c sources.GithubConfig) error
  • func (e *Engine) ScanGitLab(ctx context.Context, c sources.GitlabConfig) error
  • func (e *Engine) ScanS3(ctx context.Context, c sources.S3Config) error
  • func (e *Engine) ScanSyslog(ctx context.Context, c sources.SyslogConfig) error
• type EngineOption
  • func WithConcurrency(concurrency int) EngineOption
  • func WithDecoders(decoders ...decoders.Decoder) EngineOption
  • func WithDetectors(verify bool, d ...detectors.Detector) EngineOption
  • func WithFilterDetectors(filterFunc func(detectors.Detector) bool) EngineOption
  • func WithFilterUnverified(filter bool) EngineOption

Functions

func DefaultDetectorTypesImplementing

func DefaultDetectorTypesImplementing[T any]() map[detectorspb.DetectorType]struct{}

func DefaultDetectors

func DefaultDetectors() []detectors.Detector

func FragmentFirstLine

func FragmentFirstLine(chunk *sources.Chunk) (int64, *int64)

FragmentFirstLine returns the first line number of a fragment along with a pointer to the value to update in the chunk metadata.

func FragmentLineOffset

func FragmentLineOffset(chunk *sources.Chunk, result *detectors.Result) int64

FragmentLineOffset sets the line number for a provided source chunk with a given detector result.

func SetResultLineNumber

func SetResultLineNumber(chunk *sources.Chunk, result *detectors.Result, fragStart int64, mdLine *int64)

SetResultLineNumber sets the line number in the provided result.

func SupportsLineNumbers

func SupportsLineNumbers(sourceType sourcespb.SourceType) bool

SupportsLineNumbers determines if a line number can be found for a source type.

Types

type Engine

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

func Start

func Start(ctx context.Context, options ...EngineOption) *Engine

func (*Engine) BytesScanned

func (e *Engine) BytesScanned() uint64

func (*Engine) ChunksChan

func (e *Engine) ChunksChan() chan *sources.Chunk

func (*Engine) ChunksScanned

func (e *Engine) ChunksScanned() uint64

func (*Engine) DetectorAvgTime

func (e *Engine) DetectorAvgTime() map[string][]time.Duration

func (*Engine) Finish

func (e *Engine) Finish(ctx context.Context, logFunc func(error, string, ...any))

Finish waits for running sources to complete and workers to finish scanning chunks before closing their respective channels. Once Finish is called, no more sources may be scanned by the engine.

func (*Engine) ResultsChan

func (e *Engine) ResultsChan() chan detectors.ResultWithMetadata

func (*Engine) ScanCircleCI

func (e *Engine) ScanCircleCI(ctx context.Context, token string) error

ScanCircleCI scans CircleCI logs.

func (*Engine) ScanDocker

func (e *Engine) ScanDocker(ctx context.Context, conn *anypb.Any) error

ScanDocker scans a given docker connection.

func (*Engine) ScanFileSystem

func (e *Engine) ScanFileSystem(ctx context.Context, c sources.FilesystemConfig) error

ScanFileSystem scans a given file system.

func (*Engine) ScanGCS

func (e *Engine) ScanGCS(ctx context.Context, c sources.GCSConfig) error

ScanGCS with the provided options.

func (*Engine) ScanGit

func (e *Engine) ScanGit(ctx context.Context, c sources.GitConfig) error

ScanGit scans any git source.

func (*Engine) ScanGitHub

func (e *Engine) ScanGitHub(ctx context.Context, c sources.GithubConfig) error

ScanGitHub scans Github with the provided options.

func (*Engine) ScanGitLab

func (e *Engine) ScanGitLab(ctx context.Context, c sources.GitlabConfig) error

ScanGitLab scans GitLab with the provided configuration.

func (*Engine) ScanS3

func (e *Engine) ScanS3(ctx context.Context, c sources.S3Config) error

ScanS3 scans S3 buckets.

func (*Engine) ScanSyslog

func (e *Engine) ScanSyslog(ctx context.Context, c sources.SyslogConfig) error

ScanSyslog is a source that scans syslog files.

type EngineOption

type EngineOption func(*Engine)

func WithConcurrency

func WithConcurrency(concurrency int) EngineOption

func WithDecoders

func WithDecoders(decoders ...decoders.Decoder) EngineOption

func WithDetectors

func WithDetectors(verify bool, d ...detectors.Detector) EngineOption

func WithFilterDetectors

func WithFilterDetectors(filterFunc func(detectors.Detector) bool) EngineOption

WithFilterDetectors applies a filter to the configured list of detectors. If the filterFunc returns true, the detector will be included for scanning. This option applies to the existing list of detectors configured, so the order this option appears matters. All filtering happens before scanning.

func WithFilterUnverified

func WithFilterUnverified(filter bool) EngineOption

WithFilterUnverified sets the filterUnverified flag on the engine. If set to true, the engine will only return the first unverified result for a chunk for a detector.