Table of Contents
- 12.1. Utility Functions
- 12.2. GUI Support
- 12.3. Functions For New Protocols And Dissectors
- 12.4. Obtaining Dissection Data
- 12.5. Obtaining Packet Information
- 12.6. Functions For Handling Packet Data
- 12.7. Adding Information To The Dissection Tree
- 12.8. Post-Dissection Packet Analysis
- 12.9. Saving Capture Files
- 12.10. Wtap Functions For Handling Capture File Types
- 12.11. Custom File Format Reading And Writing
- 12.12. Directory Handling Functions
- 12.13. Handling 64-bit Integers
- 12.14. Binary encode/decode support
- 12.15. Gcrypt symmetric cipher functions
- 12.16. PCRE2 Regular Expressions
- 12.17. Bitwise Operations
This Part of the User Guide describes the Wireshark specific functions in the embedded Lua.
Classes group certain functionality, the following notational conventions are used:
- Class.function() represents a class method (named function) on class Class, taking no arguments.
- Class.function(a) represents a class method taking one argument.
- Class.function(…) represents a class method taking a variable number of arguments.
- class:method() represents an instance method (named method) on an instance of class Class, taking no arguments. Note the lowercase notation in the documentation to clarify an instance.
- class.prop represents a property prop on the instance of class Class.
Trying to access a non-existing property, function or method currently gives an error, but do not rely on it as the behavior may change in the future.
TLS protocol will be started after this fame
Arguments
- tls_handle
- the tls dissector
- pinfo
-
The packet’s
Pinfo.
- app_handle
- The app dissector
TLS protocol is started with this frame
Arguments
- tls_handle
- the tls dissector
- pinfo
-
The packet’s
Pinfo.
- app_handle
- The app dissector
Set a Lua table with meta-data about the plugin, such as version.
The passed-in Lua table entries need to be keyed/indexed by the following:
- "version" with a string value identifying the plugin version (required)
- "description" with a string value describing the plugin (optional)
- "author" with a string value of the author’s name(s) (optional)
- "repository" with a string value of a URL to a repository (optional)
Not all of the above key entries need to be in the table. The 'version' entry is required, however. The others are not currently used for anything, but might be in the future and thus using them might be useful. Table entries keyed by other strings are ignored, and do not cause an error.
local my_info = {
version = "1.0.1",
author = "Jane Doe",
repository = "https://github.com/octocat/Spoon-Knife"
}
set_plugin_info(my_info)
Arguments
- table
- The Lua table of information.
Formats an absolute timestamp into a human readable date.
Arguments
- timestamp
- A timestamp value to convert.
Returns
A string with the formated date
Formats a relative timestamp in a human readable time.
Arguments
- timestamp
- A timestamp value to convert.
Returns
A string with the formated time
Get a preference value.
Arguments
- preference
- The name of the preference.
Returns
The preference value, or nil if not found.
Set a preference value.
Arguments
- preference
- The name of the preference.
- value
- The preference value to set.
Returns
true if changed, false if unchanged or nil if not found.
Reset a preference to default value.
Arguments
- preference
- The name of the preference.
Returns
true if valid preference
Loads a Lua file and executes it as a Lua chunk, similar to the standard dofile but searches additional directories. The search order is the current directory, followed by the user’s personal configuration directory, and finally the global configuration directory.
![[Tip]](images/tip.svg) | The configuration directories are not the plugin directories. |
|---|---|
|
The configuration directories searched are not the global and personal plugin
directories. All Lua files in the plugin directories are loaded at startup;
|
Arguments
- filename
- Name of the file to be run. If the file does not exist in the current directory, the user and system directories are searched.
Loads a Lua file and compiles it into a Lua chunk, similar to the standard loadfile but searches additional directories. The search order is the current directory, followed by the user’s personal configuration directory, and finally the global configuration directory.
-- Assume foo.lua contains definition for foo(a,b). Load the chunk
-- from the file and execute it to add foo(a,b) to the global table.
-- These two lines are effectively the same as dofile('foo.lua').
local loaded_chunk = assert(loadfile('foo.lua'))
loaded_chunk()
-- ok to call foo at this point
foo(1,2)
Arguments
- filename
- Name of the file to be loaded. If the file does not exist in the current directory, the user and system directories are searched.