bytematcher

Documentation

Overview

Package bytematcher builds a matching engine from a set of signatures and performs concurrent matching against an input siegreader.Buffer.

Index

• func Add(c core.Matcher, ss core.SignatureSet, priorities priority.List) (core.Matcher, int, error)
• func Load(ls *persist.LoadSaver) core.Matcher
• func Save(c core.Matcher, ls *persist.LoadSaver)
• type Matcher
  • func (b *Matcher) DescribeKeyFrames(i int) []string
  • func (b *Matcher) DescribeTestTree(i int) ([]int, []int, int, int, int, int)
  • func (b *Matcher) Identify(name string, sb *siegreader.Buffer, hints ...core.Hint) (chan core.Result, error)
  • func (b *Matcher) InspectTestTree(i int) []int
  • func (b *Matcher) KeyFramesLen() int
  • func (b *Matcher) String() string
  • func (b *Matcher) TestTreeLen() int
• type SignatureSet

Functions

func Add

func Add(c core.Matcher, ss core.SignatureSet, priorities priority.List) (core.Matcher, int, error)

Add a set of signatures to a bytematcher. The priority list should be of equal length to the signatures, or nil (if no priorities are to be set).

Example:

m, n, err := Add(bm, []frames.Signature{frames.Signature{frames.NewFrame(frames.BOF, patterns.Sequence{'p','d','f'}, 0, 0)}}, nil)

func Load

func Load(ls *persist.LoadSaver) core.Matcher

Load loads a Matcher.

func Save

func Save(c core.Matcher, ls *persist.LoadSaver)

Save persists a Matcher.

Types

type Matcher

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

Matcher matches byte signatures against the siegreader.Buffer.

func (*Matcher) DescribeKeyFrames

func (b *Matcher) DescribeKeyFrames(i int) []string

func (*Matcher) DescribeTestTree

func (b *Matcher) DescribeTestTree(i int) ([]int, []int, int, int, int, int)

func (*Matcher) Identify

func (b *Matcher) Identify(name string, sb *siegreader.Buffer, hints ...core.Hint) (chan core.Result, error)

Identify matches a Matcher's signatures against the input siegreader.Buffer. Results are passed on the returned channel.

Example:

ret := bm.Identify("", buf)
for v := range ret {
  if v.Index() == 0 {
    fmt.Print("Success! It is signature 0!")
  }
}

func (*Matcher) InspectTestTree

func (b *Matcher) InspectTestTree(i int) []int

InspectTestTree reports which signatures are linked to a given index in the test tree. This is used by the -log debug and -log slow options for sf.

func (*Matcher) KeyFramesLen

func (b *Matcher) KeyFramesLen() int

func (*Matcher) String

func (b *Matcher) String() string

String returns information about the Bytematcher including the number of BOF, VAR and EOF sequences, the number of BOF and EOF frames, and the total number of tests.

func (*Matcher) TestTreeLen

func (b *Matcher) TestTreeLen() int

type SignatureSet

type SignatureSet []frames.Signature

SignatureSet for a bytematcher is a slice of frames.Signature.