vspyx.Dissector

Package Contents

Classes

Dissecting	Dissecting
Engine	Engine
Expression	Expression
Field	Field
FieldDefinition	FieldDefinition
FieldDefinitionFactory	FieldDefinitionFactory
FieldInstance	FieldInstance
Hook	Hook
Message	Message
Module	Module
Protocol	Protocol
ProtocolInstance	ProtocolInstance
State	State
Tag	Tag

class vspyx.Dissector.Dissecting

Bases: vspyx.Core.Object

Dissecting

CurrentBit :vspyx.Core.Numeric

CurrentByte :vspyx.Core.Numeric

CurrentData :vspyx.Core.BytesView

AddHook(self, Hook: Hook) → Any

AddProtocolInstance(self, protocolInstance: ProtocolInstance) → Any

AdvanceCurrentBit(self, amount: vspyx.Core.Numeric) → Any

CheckSpaceLeft(self, more: vspyx.Core.Numeric) → bool

GetFieldEnd(self, tag: Tag) → Any

GetFieldInstance(self, field: Tag) → FieldInstance

static GetFieldRef(inst: FieldInstance) → Field

GetFieldSize(self, tag: Tag) → Any

GetFieldStart(self, tag: Tag) → Any

GetFieldValue(self, tag: Tag) → Any

GetHijackingProtocol(self, hijackLocation: Tag) → Protocol

GetMessageState(self, protocol: Any) → State

GetRangeValue(self, bit_start: int, bit_end: int, is_big_endian: bool) → Any

static GetTagRef(field: Field) → Tag

static GetTagRef(inst: FieldInstance) → Tag

static New(engine: Engine, frame: vspyx.Frames.Frame) → Dissecting

static New(engine: Engine, data: vspyx.Core.BytesView) → Dissecting

RemoveHook(self, Hook: Hook) → Any

SetMessageState(self, protocol: Any, state: State) → Any

class vspyx.Dissector.Engine

Bases: vspyx.Core.ResolverObject

Engine

AddHook(self, Hook: Hook) → Any

DissectFrame(self, frame: vspyx.Frames.Frame) → Message

GetProtocol(self, tag: Tag) → Protocol

RemoveHook(self, Hook: Hook) → bool

class vspyx.Dissector.Expression

Bases: vspyx.Core.Object

Expression

class Token

Token

class OperatorType

Bases: enum.IntEnum

Enum where members are also (and must be) ints

Add = 0

And = 12

Divide = 2

Equal = 5

GreaterThen = 7

GreaterThenEqualTo = 8

LessThen = 9

LessThenEqualTo = 10

Multiply = 3

Not = 13

NotEqual = 6

Or = 11

Power = 4

Subtract = 1

class TokenType

Bases: enum.IntEnum

Enum where members are also (and must be) ints

Operand = 1

Operator = 0

Tokens = 3

Variable = 2

class VariableType

Bases: enum.IntFlag

Support for integer-based Flags

End = 2

Length = 3

Start = 1

Value = 0

Operand :vspyx.Core.Numeric

Operator :Expression.Token.OperatorType

Variable :Tag

GetTokenType(self) → Expression.Token.TokenType

GetVariableType(self) → Expression.Token.VariableType

assign(self, arg0: Expression.Token) → Expression.Token

static GenExpression(numeric: vspyx.Core.Numeric) → Expression

static GenExpression(str: Expression.GenExpression.str) → Expression

class vspyx.Dissector.Field

Bases: vspyx.Core.Object

Field

LongName :str

ShortName :str

Tag :Tag

__eq__(self, rhs: Field) → bool

class vspyx.Dissector.FieldDefinition

Bases: Field

FieldDefinition

class EndianType

Bases: enum.IntEnum

Enum where members are also (and must be) ints

Big = 0

Little = 1

class LoopType

Bases: enum.IntEnum

Enum where members are also (and must be) ints

DoWhileLoop = 3

Fill = 1

ForLoop = 4

Once = 0

WhileLoop = 2

SetEnabled(self, enabled: Expression) → Any

SetEndianType(self, endianType: FieldDefinition.EndianType) → Any

SetLength(self, length: Expression) → Any

SetLongName(self, name: str) → Any

SetLoop(self, loop: Expression) → Any

SetLoopType(self, loopType: FieldDefinition.LoopType) → Any

SetShortName(self, name: str) → Any

SetStart(self, start: Expression) → Any

SetTag(self, tag: str, aliases: List[str]) → Any

class vspyx.Dissector.FieldDefinitionFactory

FieldDefinitionFactory

static GenFixedLengthStringFieldDefinition() → FieldDefinition

static GenFloatFieldDefinition() → FieldDefinition

static GenNullTermStringFieldDefinition() → FieldDefinition

static GenProtocol(fieldDefinition: FieldDefinition) → Protocol

class vspyx.Dissector.FieldInstance

Bases: vspyx.Core.Object

FieldInstance

class FormatTypes

Bases: enum.IntEnum

Enum where members are also (and must be) ints

DECIMAL = 4

DEFAULT = 1

FALSE_TRUE = 16

HEX = 2

HEX_DECIMAL = 6

LONG_FORMAT = 64

NONE = 0

SHORT_FORMAT = 32

SHORT_NAME = 128

TRUE_FALSE = 8

class State

State

Description :str

End :vspyx.Core.Numeric

Name :str

Start :vspyx.Core.Numeric

Children :List[FieldInstance]

DefaultFormat :FieldInstance.FormatTypes

End :Any

Field :Field

Size :Any

SourceMessage :Message

Start :Any

Value :Any

AsString(self) → str

AsString(self, formatBitField: FieldInstance.FormatTypes) → str

GetChild(self, tag: Tag) → FieldInstance

static MACAddressAsString(requestedFormatType: FieldInstance.FormatTypes, inst: FieldInstance) → str

static NumericAsString(formatBitField: FieldInstance.FormatTypes, inst: FieldInstance) → str

class vspyx.Dissector.Hook

Bases: vspyx.Core.Object

Hook

Expression :Expression

HijackLocation :Tag

Protocol :Protocol

class vspyx.Dissector.Message

Bases: vspyx.Core.Object

Message

RootField :FieldInstance

GetFieldEnd(self, tag: Tag) → Any

GetFieldInstance(self, field: Tag) → FieldInstance

GetFieldSize(self, tag: Tag) → Any

GetFieldStart(self, tag: Tag) → Any

GetFieldValue(self, tag: Tag) → Any

static New(arg0: Dissecting) → Message

class vspyx.Dissector.Module

Bases: vspyx.Core.Module

Module

GenHooksFromWDBFile(self, filepath: str) → List[Hook]

GenHooksFromWDBString(self, str: Module.GenHooksFromWDBString.str) → List[Hook]

NewEngine(self) → Engine

class vspyx.Dissector.Protocol

Bases: Field

Protocol

Dissect(self, dissecting: Dissecting) → Any

class vspyx.Dissector.ProtocolInstance

Bases: FieldInstance

ProtocolInstance

GetChildEnd(self, tag: Tag) → Any

GetChildSize(self, tag: Tag) → Any

GetChildStart(self, tag: Tag) → Any

GetChildValue(self, tag: Tag) → Any

class vspyx.Dissector.State

Bases: vspyx.Core.Object

State

class vspyx.Dissector.Tag

Bases: vspyx.Core.Object

Tag

Aliases :List[Tag]

AliasesRef :List[Tag]

KeyHash :int

String :str

ValueHash :int

static New(val: str) → Tag

static New(val: str, aliases: List[str]) → Tag

__eq__(self, rhs: Tag) → bool

__eq__(self, rhs: Tag) → bool

__eq__(self, rhs: Tag) → bool