Wireshark Lua API Documentation

Wireshark's Lua API definitions, in Sumneko's language server annotations format (similar to EmmyLua). Might work with EmmyLua.

The current implementation is incomplete and might contain errors. The idea would be to use this as baseline for an automated tool which would generate this file.

How to use

If you are using VSCode, simply download/copy-paste the contents of wireshark_lua_api.lua into your project. The Sumneko language server plugin must be installed (identifier: sumneko.lua).

If you are using something else, I am sorry, I have only tested it with the method described above.

References

• Lua Wireshark API documentation https://wiki.wireshark.org/Lua
• This work is based on the initial effort by https://github.com/roddypratt/router_dissectors
• Documentation format https://github.com/sumneko/lua-language-server/wiki/Annotations

TODO

• Utility Functions
  • Global Functions
• GUI Support
  • ProgDlg
  • TextWindow
  • Global Functions
• Functions For New Protocols And Dissectors
  • Dissector
  • DissectorTable
  • Pref
  • Prefs
  • Proto
  • ProtoExpert
  • ProtoField
  • Global Functions
• Obtaining Dissection Data
  • Field
  • FieldInfo
  • Global Functions
• Obtaining Packet Information
  • Address
  • Column
  • Columns
  • NSTime
  • Pinfo
  • PrivateTable
• Functions For Handling Packet Data
  • ByteArray
  • Tvb
  • TvbRange
• Adding Information To The Dissection Tree
  • TreeItem
• Post-Dissection Packet Analysis
  • Listener
• Saving Capture Files
  • Dumper
  • PseudoHeader
• Wtap Functions For Handling Capture File Types
  • Global Functions
• Custom File Format Reading And Writing
  • CaptureInfo
  • CaptureInfoConst
  • File
  • FileHandler
  • FrameInfo
  • FrameInfoConst
  • Global Functions
• Directory Handling Functions
  • Dir
• Handling 64-bit Integers
  • Int64
  • UInt64
• Binary encode/decode support
  • Struct
• PCRE2 Regular Expressions