rules

Documentation

Index

• Variables
• func NewRuleFactory(hf mechanisms.MechanismFactory, conf *config.Configuration, ...) (rule.Factory, error)
• func NewRuleSetProcessor(repository rule.Repository, factory rule.Factory) rule.SetProcessor
• type CheckFunc
• type RouteMatcher

Variables

var (
	ErrRequestSchemeMismatch = errors.New("request scheme mismatch")
	ErrRequestMethodMismatch = errors.New("request method mismatch")
	ErrRequestHostMismatch   = errors.New("request host mismatch")
	ErrRequestPathMismatch   = errors.New("request path mismatch")
)

var (
	ErrNoGlobPatternDefined  = errors.New("no glob pattern defined")
	ErrNoRegexPatternDefined = errors.New("no regex pattern defined")
)

var ErrUnsupportedRuleSetVersion = errors.New("unsupported rule set version")

var Module = fx.Options(
	fx.Provide(
		NewRuleFactory,
		newRepository,
		NewRuleSetProcessor,
		newRuleExecutor,
	),
	provider.Module,
)

Module is invoked on app bootstrapping. nolint: gochecknoglobals

Functions

func NewRuleFactory

func NewRuleFactory(
	hf mechanisms.MechanismFactory,
	conf *config.Configuration,
	mode config.OperationMode,
	logger zerolog.Logger,
) (rule.Factory, error)

func NewRuleSetProcessor

func NewRuleSetProcessor(repository rule.Repository, factory rule.Factory) rule.SetProcessor

Types

type CheckFunc

type CheckFunc func() error

type RouteMatcher

type RouteMatcher interface {
	Matches(request *heimdall.Request, keys, values []string) error
}