parser

Documentation

Overview

Seclang Parser. Thanks to the go-lua project. The scanner referenced some of the go-lua scanner implementations. https://github.com/Shopify/go-lua

Index

• Constants
• Variables
• func RegisterDir(tk int, name string, f DirectiveFactory)
• func RegisterValue(tk int, regex string)
• type Action
• type Actions
• type BoolArgDirective
  • func (d *BoolArgDirective) Token() int
• type Directive
  • func RuleDirectiveScaner(s *Scanner) (Directive, error)
• type DirectiveDesc
  • func DirectiveFromString(str string) *DirectiveDesc
• type DirectiveFactory
  • func BoolArgDirectiveFactory(tk int) DirectiveFactory
  • func StringArgDirectiveFactory(tk int) DirectiveFactory
  • func TriBoolArgDirectiveFactory(tk int) DirectiveFactory
• type Operator
• type RuleDirective
  • func (d *RuleDirective) Token() int
• type Scanner
  • func NewSecLangScanner(r io.Reader) *Scanner
  • func NewSecLangScannerFromString(s string) *Scanner
  • func (s *Scanner) AllDirective() ([]Directive, error)
  • func (s *Scanner) ReadActions() (*Actions, error)
  • func (s *Scanner) ReadDirective() (Directive, error)
  • func (s *Scanner) ReadOperator() (*Operator, error)
  • func (s *Scanner) ReadString() (string, error)
  • func (s *Scanner) ReadValue(tks ...int) (int, string, error)
  • func (s *Scanner) ReadVariables() ([]*Variable, error)
  • func (s *Scanner) ReadWord() string
  • func (s *Scanner) SkipBlank() error
  • func (s *Scanner) StartsWith(str string) bool
• type StringArgDirective
  • func (d *StringArgDirective) Token() int
• type Trans
• type TriBoolArgDirective
  • func (d *TriBoolArgDirective) Token() int
• type ValueDesc
• type Variable

Constants

const (
	// begin of stream
	BOS = -1
	// end of stream
	EOS = -2
)

const (
	TriBoolTrue  = 1
	TriBoolElse  = 2
	TriBoolFalse = 0
)

const (
	// directives
	TkDirRule = iota + TkStart
	TkDirRuleEng
	TkDirReqBody
	TkDirResBody
	TkValueElse
	TkValueOff
	TkValueOn
	// variables
	TkVarArgs
	TkVarArgsGet
	TkVarArgsGetNames
	TkVarArgsPost
	TkVarArgsPostNames
	TkVarArgsCombinedSize
	TkVarArgsNames
	TkVarQueryString
	TkVarRemoteAddr
	TkVarRequestBasename
	TkVarRequestBody
	TkVarRequestCookies
	TkVarRequestCookiesNames
	TkVarRequestFilename
	TkVarRequestHeaders
	TkVarRequestHeadersNames
	TkVarRequestMethod
	TkVarRequestProtocol
	TkVarRequestUri
	TkVarRequestUriRaw
	TkVarRequestLine
	TkVarReqBodyProcessor
	TkVarResponseBody
	TkVarResponseContentLength
	TkVarResponseContentType
	TkVarResponseHeaders
	TkVarResponseHeadersNames
	TkVarResponseProtocol
	TkVarResponseStatus
	TkVarXML
	TkVarTx
	TkVarFilesNames
	TkVarFiles
	TkVarFilesCombinedSize
	TkVarUniqueId
	TkVarDuration
	TkVarIp
	TkVarGeo
	TkVarMatchedVars
	TkVarMatchedVarsNames
	// operator
	TkOpRx
	TkOpEq
	TkOpGe
	TkOpGt
	TkOpLe
	TkOpLt
	TkOpValidateUrlEncoding
	TkOpValidateUtf8Encoding
	TkOpValidateByteRange
	TkOpPm
	TkOpPmFromFile
	TkOpWithin
	TkOpBeginsWith
	TkOpEndsWith
	TkOpContains
	TkOpStrEq
	TkOpIpMatch
	TkOpGeoLookup
	TkOpRbl
	TkOpDetectXss
	TkOpDetectSqli
	// actions
	TkActionAllow
	TkActionMsg
	TkActionId
	TkActionTag
	TkActionRev
	TkActionSeverity
	TkActionLog
	TkActionNoLog
	TkActionDeny
	TkActionBlock
	TkActionStatus
	TkActionpHase
	TkActionT
	TkActionSkip
	TkActionSkipAfter
	TkActionChain
	TkActionPhase
	TkActionVer
	TkActionLogData
	TkActionSetVar
	TkActionCapture
	TkActionPass
	TkActionCtl
	TkActionAuditLog
	TkActionNoAuditLog
	TkActionExpireVar
	TkActionDrop
	TkActionMultiMatch
	// transform action
	TkTransLowercase
	TkTransUrlDecode
	TkTransUrlDecodeUni
	TkTransNone
	TkTransCompressWhitespace
	TkTransRemoveWhitespace
	TkTransReplaceNulls
	TkTransRemoveNulls
	TkTransLength
	TkTransHtmlEntityDecode
	TkTransSha1
	TkTransHexEncode
	TkTransUtf8toUnicode
	TkTransCmdLine
	TkTransNormalisePath
	TkTransNormalizePath
	TkTransNormalizePathWin
	TkTransReplaceComments
	TkTransRemoveComments
	TkTransBase64Decode
	TkTransJsDecode
	TkTransCssDecode
	TkEND
)

const (
	PhaseRequestHeaders  = 1
	PhaseRequestBody     = 2
	PhaseResponseHeaders = 3
	PhaseResponseBody    = 4
	PhaseLogging         = 5
)

const TkStart = 128

Variables

var ActionNameMap = map[int]string{}

var Directives map[int]*DirectiveDesc

var ErrEOS = errors.New("EOS")

var OperatorNameMap = map[int]string{}

var SeverityNameMap = map[int]string{}

var TransformationNameMap = map[int]string{}

var Values map[int]*ValueDesc

var VariableNameMap = map[int]string{}

Functions

func RegisterDir

func RegisterDir(tk int, name string, f DirectiveFactory)

func RegisterValue

func RegisterValue(tk int, regex string)

Types

type Action

type Action struct {
	Tk       int
	Argument string
}

type Actions

type Actions struct {
	Id     int
	Phase  int
	Chain  bool
	Trans  []*Trans
	Action []*Action
}

type BoolArgDirective

type BoolArgDirective struct {
	Tk    int
	Value bool
}

func (*BoolArgDirective) Token

func (d *BoolArgDirective) Token() int

type Directive

type Directive interface {
	Token() int
}

func RuleDirectiveScaner

func RuleDirectiveScaner(s *Scanner) (Directive, error)

type DirectiveDesc

type DirectiveDesc struct {
	Token int
	Val   string
	Func  DirectiveFactory
}

func DirectiveFromString

func DirectiveFromString(str string) *DirectiveDesc

type DirectiveFactory

type DirectiveFactory func(*Scanner) (Directive, error)

func BoolArgDirectiveFactory

func BoolArgDirectiveFactory(tk int) DirectiveFactory

func StringArgDirectiveFactory

func StringArgDirectiveFactory(tk int) DirectiveFactory

func TriBoolArgDirectiveFactory

func TriBoolArgDirectiveFactory(tk int) DirectiveFactory

type Operator

type Operator struct {
	Tk       int
	Not      bool
	Argument string
}

type RuleDirective

type RuleDirective struct {
	Variable []*Variable
	Operator *Operator
	Actions  *Actions
}

func (*RuleDirective) Token

func (d *RuleDirective) Token() int

type Scanner

type Scanner struct {
	LineNumber, LastLine int
	// contains filtered or unexported fields
}

func NewSecLangScanner

func NewSecLangScanner(r io.Reader) *Scanner

func NewSecLangScannerFromString

func NewSecLangScannerFromString(s string) *Scanner

func (*Scanner) AllDirective

func (s *Scanner) AllDirective() ([]Directive, error)

func (*Scanner) ReadActions

func (s *Scanner) ReadActions() (*Actions, error)

func (*Scanner) ReadDirective

func (s *Scanner) ReadDirective() (Directive, error)

func (*Scanner) ReadOperator

func (s *Scanner) ReadOperator() (*Operator, error)

func (*Scanner) ReadString

func (s *Scanner) ReadString() (string, error)

func (*Scanner) ReadValue

func (s *Scanner) ReadValue(tks ...int) (int, string, error)

func (*Scanner) ReadVariables

func (s *Scanner) ReadVariables() ([]*Variable, error)

func (*Scanner) ReadWord

func (s *Scanner) ReadWord() string

func (*Scanner) SkipBlank

func (s *Scanner) SkipBlank() error

func (*Scanner) StartsWith

func (s *Scanner) StartsWith(str string) bool

type StringArgDirective

type StringArgDirective struct {
	Tk    int
	Value string
}

func (*StringArgDirective) Token

func (d *StringArgDirective) Token() int

type Trans

type Trans struct {
	Tk int
}

type TriBoolArgDirective

type TriBoolArgDirective struct {
	Tk    int
	Value int // 1: on; 2: DetectionOnly; 0: off
}

func (*TriBoolArgDirective) Token

func (d *TriBoolArgDirective) Token() int

type ValueDesc

type ValueDesc struct {
	Token int
	Regex string
	// contains filtered or unexported fields
}

type Variable

type Variable struct {
	Tk        int
	Index     string
	Count     bool
	Exclusion bool
}