Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

engine

package

Go to main page

Versions in this module

v5

v5.2.4

Mar 11, 2026

v5.2.3

Mar 6, 2026

v5.2.2

Feb 20, 2026

v5.2.1

Feb 2, 2026

v5.2.0

Jan 23, 2026

v5.1.1

Jan 23, 2026

Changes in this version

type Engine

+ WithValidation bool

type EngineConfig

+ WithValidation bool

v5.1.0

Jan 23, 2026

v5.0.0

Jan 19, 2026

Changes in this version

+ var ErrFailedToCompileRegexRule = fmt.Errorf("failed to compile regex rule")

+ var ErrNoRulesSelected = fmt.Errorf("no rules were selected")

+ func CheckRulesRequiredFields(rulesToCheck []*ruledefine.Rule) error

+ func GetRulesCommand(engineConfig *EngineConfig) *cobra.Command

+ type DetectorConfig struct

+ AdditionalIgnoreRules []string

+ CustomRegexPatterns []string

+ MaxFindings uint64

+ MaxRuleMatchesPerFragment uint64

+ MaxSecretSize uint64

+ MaxTargetMegabytes int

+ SelectedRules []*ruledefine.Rule

+ type Engine struct

+ Report reporting.IReport

+ ScanConfig resources.ScanConfig

+ func (e *Engine) DetectFile(ctx context.Context, item plugins.ISourceItem, ...) error

+ func (e *Engine) DetectFragment(item plugins.ISourceItem, secretsChannel chan *secrets.Secret, ...) error

+ func (e *Engine) GetCvssScoreWithoutValidationCh() chan *secrets.Secret

+ func (e *Engine) GetDetectorWorkerPool() workerpool.Pool

+ func (e *Engine) GetErrorsCh() chan error

+ func (e *Engine) GetPluginChannels() plugins.PluginChannels

+ func (e *Engine) GetReport() reporting.IReport

+ func (e *Engine) GetSecretsExtrasCh() chan *secrets.Secret

+ func (e *Engine) GetValidationCh() chan *secrets.Secret

+ func (e *Engine) Scan(pluginName string)

+ func (e *Engine) SetPluginChannels(pluginChannels plugins.PluginChannels)

+ func (e *Engine) Shutdown() error

+ func (e *Engine) Wait()

+ type EngineConfig struct

+ AdditionalIgnoreRules []string

+ AllowedValues []string

+ CustomRegexPatterns []string

+ CustomRules []*ruledefine.Rule

+ DetectorWorkerPoolSize int

+ IgnoreList []string

+ IgnoredIds []string

+ MaxFindings uint64

+ MaxRuleMatchesPerFragment uint64

+ MaxSecretSize uint64

+ MaxTargetMegabytes int

+ ScanConfig resources.ScanConfig

+ SelectedList []string

+ SpecialList []string

+ type EngineOption func(*Engine)

+ func WithPluginChannels(pluginChannels plugins.PluginChannels) EngineOption

+ type IEngine interface

+ DetectFile func(ctx context.Context, item plugins.ISourceItem, ...) error

+ DetectFragment func(item plugins.ISourceItem, secretsChannel chan *secrets.Secret, ...) error

+ GetErrorsCh func() chan error

+ GetPluginChannels func() plugins.PluginChannels

+ GetReport func() reporting.IReport

+ Scan func(pluginName string)

+ SetPluginChannels func(pluginChannels plugins.PluginChannels)

+ Shutdown func() error

+ Wait func()

+ func Init(engineConfig *EngineConfig, opts ...EngineOption) (IEngine, error)

+ type IScorer interface

+ AssignScoreAndSeverity func(secret *secrets.Secret)

+ GetKeywords func() map[string]struct{}

+ GetRulesBaseRiskScore func(ruleId string) float64

+ GetRulesToBeApplied func() map[string]config.Rule

Other modules containing this package

github.com/checkmarx/2ms/v3

github.com/checkmarx/2ms/v4