file

Documentation

Index

• type ExtractResult
  • func (e *ExtractResult) Hash() string
  • func (e *ExtractResult) String() string
• type FileScanner
  • func NewScanner(opts ...Option) (*FileScanner, error)
  • func (fs *FileScanner) ExtractFromLine(ctx context.Context, fileName string, lineNumber int, line string, ...) ([]ExtractResult, error)
  • func (fs *FileScanner) ExtractFromReader(ctx context.Context, fileName string, rd io.Reader) ([]ExtractResult, error)
• type Option
  • func WithEntropyThresholdMidpoint(entropyThresholdMidpoint int) Option
  • func WithLogisticGrowthRate(logisticGrowthRate float64) Option
  • func WithMinimumProbability(minimumProbability float64) Option
  • func WithPasswordsCompletelyIgnore(useDefault bool, names ...string) Option
  • func WithProbabilityDecreaseMultiplier(probabilityDecreaseMultiplier float64) Option
  • func WithProbabilityIncreaseMultiplier(probabilityIncreaseMultiplier float64) Option
  • func WithUsernamesCompletelyIgnore(useDefault bool, names ...string) Option
  • func WithWordsIncreaseProbability(useDefault bool, names ...string) Option
  • func WithWordsReduceProbability(useDefault bool, names ...string) Option

Types

type ExtractResult

type ExtractResult struct {
	Name          string
	Line          string
	LineNumber    int
	Match         string
	Probability   float64
	Username      string
	Password      string
	FileName      string
	PreviousLines string
}

func (*ExtractResult) Hash

func (e *ExtractResult) Hash() string

func (*ExtractResult) String

func (e *ExtractResult) String() string

type FileScanner

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

func NewScanner

func NewScanner(opts ...Option) (*FileScanner, error)

func (*FileScanner) ExtractFromLine

func (fs *FileScanner) ExtractFromLine(ctx context.Context, fileName string, lineNumber int, line string, previousLines string) ([]ExtractResult, error)

func (*FileScanner) ExtractFromReader

func (fs *FileScanner) ExtractFromReader(ctx context.Context, fileName string, rd io.Reader) ([]ExtractResult, error)

type Option

type Option func(*options) error

func WithEntropyThresholdMidpoint

func WithEntropyThresholdMidpoint(entropyThresholdMidpoint int) Option

func WithLogisticGrowthRate

func WithLogisticGrowthRate(logisticGrowthRate float64) Option

func WithMinimumProbability

func WithMinimumProbability(minimumProbability float64) Option

func WithPasswordsCompletelyIgnore

func WithPasswordsCompletelyIgnore(useDefault bool, names ...string) Option

func WithProbabilityDecreaseMultiplier

func WithProbabilityDecreaseMultiplier(probabilityDecreaseMultiplier float64) Option

func WithProbabilityIncreaseMultiplier

func WithProbabilityIncreaseMultiplier(probabilityIncreaseMultiplier float64) Option

func WithUsernamesCompletelyIgnore

func WithUsernamesCompletelyIgnore(useDefault bool, names ...string) Option

func WithWordsIncreaseProbability

func WithWordsIncreaseProbability(useDefault bool, names ...string) Option

func WithWordsReduceProbability

func WithWordsReduceProbability(useDefault bool, names ...string) Option