forked from osmocom/wireshark
![Gerald Combs](/assets/img/avatar_default.png)
Convert links, source code blocks, and admonitions. Change-Id: I50c8daa19a115c23f7501b91dbfd904779a609c9 Reviewed-on: https://code.wireshark.org/review/25720 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
986 lines
38 KiB
C
986 lines
38 KiB
C
/*
|
|
* wslua_tree.c
|
|
*
|
|
* Wireshark's interface to the Lua Programming Language
|
|
*
|
|
* (c) 2006, Luis E. Garcia Ontanon <luis@ontanon.org>
|
|
* (c) 2008, Balint Reczey <balint.reczey@ericsson.com>
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
/* WSLUA_MODULE Tree Adding information to the dissection tree */
|
|
|
|
#include "wslua.h"
|
|
#include <epan/exceptions.h>
|
|
#include <epan/show_exception.h>
|
|
|
|
static gint wslua_ett = -1;
|
|
|
|
static GPtrArray* outstanding_TreeItem = NULL;
|
|
|
|
|
|
/* pushing a TreeItem with a NULL item or subtree is completely valid for this function */
|
|
TreeItem push_TreeItem(lua_State *L, proto_tree *tree, proto_item *item) {
|
|
TreeItem ti = (struct _wslua_treeitem *)g_malloc(sizeof(struct _wslua_treeitem));
|
|
|
|
ti->tree = tree;
|
|
ti->item = item;
|
|
ti->expired = FALSE;
|
|
|
|
g_ptr_array_add(outstanding_TreeItem, ti);
|
|
|
|
return *(pushTreeItem(L,ti));
|
|
}
|
|
|
|
/* creates the TreeItem but does NOT push it into Lua */
|
|
TreeItem create_TreeItem(proto_tree* tree, proto_item* item)
|
|
{
|
|
TreeItem tree_item = (TreeItem)g_malloc(sizeof(struct _wslua_treeitem));
|
|
tree_item->tree = tree;
|
|
tree_item->item = item;
|
|
tree_item->expired = FALSE;
|
|
|
|
return tree_item;
|
|
}
|
|
|
|
CLEAR_OUTSTANDING(TreeItem, expired, TRUE)
|
|
|
|
WSLUA_CLASS_DEFINE(TreeItem,FAIL_ON_NULL_OR_EXPIRED("TreeItem"));
|
|
/* ++TreeItem++s represent information in the packet-details pane of
|
|
Wireshark, and the packet details view of Tshark. A `TreeItem` represents
|
|
a node in the tree, which might also be a subtree and have a list of
|
|
children. The children of a subtree have zero or more siblings: other children
|
|
of the same `TreeItem` subtree.
|
|
|
|
During dissection, heuristic-dissection, and post-dissection, a root
|
|
+TreeItem+ is passed to dissectors as the third argument of the function
|
|
callback (e.g., `myproto.dissector(tvbuf,pktinfo,root)`).
|
|
|
|
In some cases the tree is not truly added to, in order to improve performance.
|
|
For example for packets not currently displayed/selected in Wireshark's visible
|
|
window pane, or if Tshark isn't invoked with the `-V` switch. However the
|
|
"add" type `TreeItem` functions can still be called, and still return `TreeItem`
|
|
objects - but the info isn't really added to the tree. Therefore you do not
|
|
typically need to worry about whether there's a real tree or not. If, for some
|
|
reason, you need to know it, you can use the `tree.visible` attribute getter
|
|
to retrieve the state.
|
|
*/
|
|
|
|
/* the following is used by TreeItem_add_packet_field() - this can THROW errors */
|
|
static proto_item *
|
|
try_add_packet_field(lua_State *L, TreeItem tree_item, TvbRange tvbr, const int hfid,
|
|
const ftenum_t type, const guint encoding, gint *ret_err)
|
|
{
|
|
gint err = 0;
|
|
proto_item* item = NULL;
|
|
gint endoff = 0;
|
|
|
|
switch(type) {
|
|
/* these all generate ByteArrays */
|
|
case FT_BYTES:
|
|
case FT_UINT_BYTES:
|
|
case FT_OID:
|
|
case FT_REL_OID:
|
|
case FT_SYSTEM_ID:
|
|
{
|
|
/* GByteArray and its data will be g_free'd by Lua */
|
|
GByteArray *gba = g_byte_array_new();
|
|
item = proto_tree_add_bytes_item(tree_item->tree, hfid, tvbr->tvb->ws_tvb,
|
|
tvbr->offset, tvbr->len, encoding,
|
|
gba, &endoff, &err);
|
|
if (err == 0) {
|
|
pushByteArray(L, gba);
|
|
lua_pushinteger(L, endoff);
|
|
}
|
|
}
|
|
break;
|
|
|
|
case FT_ABSOLUTE_TIME:
|
|
case FT_RELATIVE_TIME:
|
|
{
|
|
/* nstime_t will be g_free'd by Lua */
|
|
nstime_t *nstime = (nstime_t *) g_malloc0(sizeof(nstime_t));
|
|
item = proto_tree_add_time_item(tree_item->tree, hfid, tvbr->tvb->ws_tvb,
|
|
tvbr->offset, tvbr->len, encoding,
|
|
nstime, &endoff, &err);
|
|
if (err == 0) {
|
|
pushNSTime(L,nstime);
|
|
lua_pushinteger(L, endoff);
|
|
}
|
|
}
|
|
break;
|
|
|
|
/* XXX: what about these? */
|
|
case FT_NONE:
|
|
case FT_PROTOCOL:
|
|
/* anything else just needs to be done the old fashioned way */
|
|
default:
|
|
item = proto_tree_add_item(tree_item->tree, hfid, tvbr->tvb->ws_tvb, tvbr->offset, tvbr->len, encoding);
|
|
lua_pushnil(L);
|
|
lua_pushnil(L);
|
|
break;
|
|
}
|
|
|
|
if (ret_err) *ret_err = err;
|
|
|
|
return item;
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_add_packet_field(lua_State *L) {
|
|
/*
|
|
Adds a new child tree for the given `ProtoField` object to this tree item,
|
|
returning the new child `TreeItem`.
|
|
|
|
Unlike `TreeItem:add()` and `TreeItem:add_le()`, the `ProtoField` argument
|
|
is not optional, and cannot be a `Proto` object. Instead, this function always
|
|
uses the `ProtoField` to determine the type of field to extract from the
|
|
passed-in `TvbRange`, highlighting the relevant bytes in the Packet Bytes pane
|
|
of the GUI (if there is a GUI), etc. If no `TvbRange` is given, no bytes are
|
|
highlighted and the field's value cannot be determined; the `ProtoField` must
|
|
have been defined/created not to have a length in such a case, or an error will
|
|
occur. For backwards-compatibility reasons the `encoding` argument, however,
|
|
must still be given.
|
|
|
|
Unlike `TreeItem:add()` and `TreeItem:add_le()`, this function performs both
|
|
big-endian and little-endian decoding, by setting the `encoding` argument to
|
|
be `ENC_BIG_ENDIAN` or `ENC_LITTLE_ENDIAN`.
|
|
|
|
The signature of this function:
|
|
|
|
[source,lua]
|
|
----
|
|
tree_item:add_packet_field(proto_field [,tvbrange], encoding, ...)
|
|
----
|
|
|
|
In Wireshark version 1.11.3, this function was changed to return more than
|
|
just the new child `TreeItem`. The child is the first return value, so that
|
|
function chaining will still work as before; but it now also returns the value
|
|
of the extracted field (i.e., a number, `UInt64`, `Address`, etc.). If the
|
|
value could not be extracted from the `TvbRange`, the child `TreeItem` is still
|
|
returned, but the second returned value is `nil`.
|
|
|
|
Another new feature added to this function in Wireshark version 1.11.3 is the
|
|
ability to extract native number `ProtoField`s from string encoding in the
|
|
`TvbRange`, for ASCII-based and similar string encodings. For example, a
|
|
`ProtoField` of as `ftypes.UINT32` type can be extracted from a `TvbRange`
|
|
containing the ASCII string "123", and it will correctly decode the ASCII to
|
|
the number `123`, both in the tree as well as for the second return value of
|
|
this function. To do so, you must set the `encoding` argument of this function
|
|
to the appropriate string `ENC_*` value, bitwise-or'd with the `ENC_STRING`
|
|
value (see `init.lua`). `ENC_STRING` is guaranteed to be a unique bit flag, and
|
|
thus it can added instead of bitwise-or'ed as well. Only single-byte ASCII digit
|
|
string encoding types can be used for this, such as `ENC_ASCII` and `ENC_UTF_8`.
|
|
|
|
For example, assuming the `Tvb` named "`tvb`" contains the string "123":
|
|
|
|
[source,lua]
|
|
----
|
|
-- this is done earlier in the script
|
|
local myfield = ProtoField.new("Transaction ID", "myproto.trans_id", ftypes.UINT16)
|
|
|
|
-- this is done inside a dissector, post-dissector, or heuristic function
|
|
-- child will be the created child tree, and value will be the number 123 or nil on failure
|
|
local child, value = tree:add_packet_field(myfield, tvb:range(0,3), ENC_UTF_8 + ENC_STRING)
|
|
----
|
|
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_add_packet_field_PROTOFIELD 2 /* The ProtoField field object to add to the tree. */
|
|
#define WSLUA_OPTARG_TreeItem_add_packet_field_TVBRANGE 3 /* The `TvbRange` of bytes in the packet this tree item covers/represents. */
|
|
#define WSLUA_ARG_TreeItem_add_packet_field_ENCODING 4 /* The field's encoding in the `TvbRange`. */
|
|
#define WSLUA_OPTARG_TreeItem_add_packet_field_LABEL 5 /* One or more strings to append to the created `TreeItem`. */
|
|
volatile TvbRange tvbr;
|
|
ProtoField field;
|
|
int hfid;
|
|
volatile int ett;
|
|
ftenum_t type;
|
|
TreeItem tree_item = shiftTreeItem(L,1);
|
|
guint encoding;
|
|
proto_item* item = NULL;
|
|
volatile int nargs;
|
|
volatile gint err = 0;
|
|
const char *volatile error = NULL;
|
|
|
|
if (!tree_item) {
|
|
return luaL_error(L,"not a TreeItem!");
|
|
}
|
|
if (tree_item->expired) {
|
|
luaL_error(L,"expired TreeItem");
|
|
return 0;
|
|
}
|
|
|
|
if (! ( field = shiftProtoField(L,1) ) ) {
|
|
luaL_error(L,"TreeField:add_packet_field not passed a ProtoField");
|
|
return 0;
|
|
}
|
|
hfid = field->hfid;
|
|
type = field->type;
|
|
ett = field->ett;
|
|
|
|
tvbr = shiftTvbRange(L,1);
|
|
if (!tvbr) {
|
|
/* No TvbRange specified */
|
|
tvbr = wmem_new(wmem_packet_scope(), struct _wslua_tvbrange);
|
|
tvbr->tvb = wmem_new(wmem_packet_scope(), struct _wslua_tvb);
|
|
tvbr->tvb->ws_tvb = lua_tvb;
|
|
tvbr->offset = 0;
|
|
tvbr->len = 0;
|
|
}
|
|
|
|
encoding = wslua_checkguint(L,1);
|
|
lua_remove(L,1);
|
|
|
|
/* get the number of additional args before we add more to the stack */
|
|
nargs = lua_gettop(L);
|
|
|
|
/* XXX: why is this being done? If the length was -1, FT_STRINGZ figures out
|
|
* the right length in tvb_get_stringz_enc(); if it was 0, it should remain zero;
|
|
* if it was greater than zero, then it's the length the caller wanted.
|
|
*/
|
|
if (type == FT_STRINGZ) {
|
|
switch (encoding & ENC_CHARENCODING_MASK) {
|
|
|
|
case ENC_UTF_16:
|
|
case ENC_UCS_2:
|
|
tvbr->len = tvb_unicode_strsize (tvbr->tvb->ws_tvb, tvbr->offset);
|
|
break;
|
|
|
|
default:
|
|
if (tvb_find_guint8 (tvbr->tvb->ws_tvb, tvbr->offset, -1, 0) == -1) {
|
|
luaL_error(L,"out of bounds");
|
|
return 0;
|
|
}
|
|
tvbr->len = tvb_strsize (tvbr->tvb->ws_tvb, tvbr->offset);
|
|
break;
|
|
}
|
|
}
|
|
|
|
TRY {
|
|
gint errx = 0;
|
|
item = try_add_packet_field(L, tree_item, tvbr, hfid, type, encoding, &errx);
|
|
err = errx;
|
|
} CATCH_ALL {
|
|
show_exception(tvbr->tvb->ws_tvb, lua_pinfo, tree_item->tree, EXCEPT_CODE, GET_MESSAGE);
|
|
error = "Lua programming error";
|
|
} ENDTRY;
|
|
|
|
if (error) { WSLUA_ERROR(TreeItem_add_packet_field,error); }
|
|
|
|
if (err != 0) {
|
|
lua_pushnil(L);
|
|
lua_pushnil(L);
|
|
}
|
|
|
|
while(nargs) {
|
|
const gchar* s;
|
|
s = lua_tostring(L,1);
|
|
if (s) proto_item_append_text(item, " %s", s);
|
|
lua_remove(L,1);
|
|
nargs--;
|
|
}
|
|
|
|
push_TreeItem(L, proto_item_add_subtree(item,ett > 0 ? ett : wslua_ett), item);
|
|
|
|
/* move the tree object before the field value */
|
|
lua_insert(L, 1);
|
|
|
|
WSLUA_RETURN(3); /* The new child `TreeItem`, the field's extracted value or nil, and offset or nil. */
|
|
}
|
|
|
|
static int TreeItem_add_item_any(lua_State *L, gboolean little_endian) {
|
|
TvbRange tvbr;
|
|
Proto proto;
|
|
ProtoField field;
|
|
int hfid = -1;
|
|
int ett = -1;
|
|
ftenum_t type = FT_NONE;
|
|
TreeItem tree_item = shiftTreeItem(L,1);
|
|
proto_item* item = NULL;
|
|
|
|
if (!tree_item) {
|
|
return luaL_error(L,"not a TreeItem!");
|
|
}
|
|
if (tree_item->expired) {
|
|
luaL_error(L,"expired TreeItem");
|
|
return 0;
|
|
}
|
|
|
|
if (! ( field = shiftProtoField(L,1) ) ) {
|
|
if (( proto = shiftProto(L,1) )) {
|
|
hfid = proto->hfid;
|
|
type = FT_PROTOCOL;
|
|
ett = proto->ett;
|
|
} else if (lua_isnil(L, 1)) {
|
|
return luaL_error(L, "first argument to TreeItem:add is nil!");
|
|
}
|
|
} else {
|
|
hfid = field->hfid;
|
|
type = field->type;
|
|
ett = field->ett;
|
|
}
|
|
|
|
tvbr = shiftTvbRange(L,1);
|
|
|
|
if (!tvbr) {
|
|
tvbr = wmem_new(wmem_packet_scope(), struct _wslua_tvbrange);
|
|
tvbr->tvb = wmem_new(wmem_packet_scope(), struct _wslua_tvb);
|
|
tvbr->tvb->ws_tvb = lua_tvb;
|
|
tvbr->offset = 0;
|
|
tvbr->len = 0;
|
|
}
|
|
|
|
if (hfid > 0 ) {
|
|
/* hfid is > 0 when the first arg was a ProtoField or Proto */
|
|
|
|
if (type == FT_STRINGZ) {
|
|
if (tvb_find_guint8 (tvbr->tvb->ws_tvb, tvbr->offset, -1, 0) == -1) {
|
|
luaL_error(L,"out of bounds");
|
|
return 0;
|
|
}
|
|
tvbr->len = tvb_strsize (tvbr->tvb->ws_tvb, tvbr->offset);
|
|
}
|
|
|
|
if (lua_gettop(L)) {
|
|
/* if we got here, the (L,1) index is the value to add, instead of decoding from the Tvb */
|
|
|
|
switch(type) {
|
|
case FT_PROTOCOL:
|
|
item = proto_tree_add_item(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,ENC_NA);
|
|
lua_pushnumber(L,0);
|
|
lua_insert(L,1);
|
|
break;
|
|
case FT_BOOLEAN:
|
|
{
|
|
/* this needs to use checkinteger so that it can accept a Lua boolean and coerce it to an int */
|
|
guint32 val = (guint32) (wslua_tointeger(L,1));
|
|
item = proto_tree_add_boolean(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,val);
|
|
}
|
|
break;
|
|
case FT_UINT8:
|
|
case FT_UINT16:
|
|
case FT_UINT24:
|
|
case FT_UINT32:
|
|
case FT_FRAMENUM:
|
|
item = proto_tree_add_uint(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,wslua_checkguint32(L,1));
|
|
break;
|
|
case FT_INT8:
|
|
case FT_INT16:
|
|
case FT_INT24:
|
|
case FT_INT32:
|
|
item = proto_tree_add_int(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,wslua_checkguint32(L,1));
|
|
break;
|
|
case FT_FLOAT:
|
|
item = proto_tree_add_float(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,(float)luaL_checknumber(L,1));
|
|
break;
|
|
case FT_DOUBLE:
|
|
item = proto_tree_add_double(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,(double)luaL_checknumber(L,1));
|
|
break;
|
|
case FT_ABSOLUTE_TIME:
|
|
case FT_RELATIVE_TIME:
|
|
item = proto_tree_add_time(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,checkNSTime(L,1));
|
|
break;
|
|
case FT_STRING:
|
|
case FT_STRINGZ:
|
|
item = proto_tree_add_string(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,luaL_checkstring(L,1));
|
|
break;
|
|
case FT_BYTES:
|
|
item = proto_tree_add_bytes(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len, (const guint8*) luaL_checkstring(L,1));
|
|
break;
|
|
case FT_UINT64:
|
|
item = proto_tree_add_uint64(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,checkUInt64(L,1));
|
|
break;
|
|
case FT_INT64:
|
|
item = proto_tree_add_int64(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,checkInt64(L,1));
|
|
break;
|
|
case FT_IPv4:
|
|
{
|
|
Address addr = checkAddress(L,1);
|
|
guint32 addr_value;
|
|
|
|
if (addr->type != AT_IPv4) {
|
|
luaL_error(L, "Expected IPv4 address for FT_IPv4 field");
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* The address is not guaranteed to be aligned on a
|
|
* 32-bit boundary, so we can't safely dereference
|
|
* the pointer as if it were so aligned.
|
|
*/
|
|
memcpy(&addr_value, addr->data, sizeof addr_value);
|
|
item = proto_tree_add_ipv4(tree_item->tree,hfid,tvbr->tvb->ws_tvb,tvbr->offset,tvbr->len,addr_value);
|
|
}
|
|
break;
|
|
case FT_IPv6:
|
|
{
|
|
Address addr = checkAddress(L,1);
|
|
if (addr->type != AT_IPv6) {
|
|
luaL_error(L, "Expected IPv6 address for FT_IPv6 field");
|
|
return 0;
|
|
}
|
|
|
|
item = proto_tree_add_ipv6(tree_item->tree, hfid, tvbr->tvb->ws_tvb, tvbr->offset, tvbr->len, (const ws_in6_addr *)addr->data);
|
|
}
|
|
break;
|
|
case FT_ETHER:
|
|
{
|
|
Address addr = checkAddress(L,1);
|
|
if (addr->type != AT_ETHER) {
|
|
luaL_error(L, "Expected MAC address for FT_ETHER field");
|
|
return 0;
|
|
}
|
|
|
|
item = proto_tree_add_ether(tree_item->tree, hfid, tvbr->tvb->ws_tvb, tvbr->offset, tvbr->len, (const guint8 *)addr->data);
|
|
}
|
|
break;
|
|
case FT_UINT_BYTES:
|
|
case FT_IPXNET:
|
|
case FT_GUID:
|
|
case FT_OID:
|
|
case FT_REL_OID:
|
|
case FT_SYSTEM_ID:
|
|
case FT_VINES:
|
|
case FT_FCWWN:
|
|
default:
|
|
luaL_error(L,"FT_ not yet supported");
|
|
return 0;
|
|
}
|
|
|
|
lua_remove(L,1);
|
|
|
|
} else {
|
|
if (type == FT_FRAMENUM) {
|
|
luaL_error(L, "ProtoField FRAMENUM cannot fetch value from Tvb");
|
|
return 0;
|
|
}
|
|
/* the Lua stack is empty - no value was given - so decode the value from the tvb */
|
|
item = proto_tree_add_item(tree_item->tree, hfid, tvbr->tvb->ws_tvb, tvbr->offset, tvbr->len, little_endian ? ENC_LITTLE_ENDIAN : ENC_BIG_ENDIAN);
|
|
}
|
|
|
|
if ( lua_gettop(L) ) {
|
|
/* if there was a value, it was removed earlier, so what's left is the display string to set */
|
|
const gchar* s = lua_tostring(L,1);
|
|
if (s) proto_item_set_text(item,"%s",s);
|
|
lua_remove(L,1);
|
|
}
|
|
|
|
} else {
|
|
/* no ProtoField or Proto was given */
|
|
if (lua_gettop(L)) {
|
|
const gchar* s = lua_tostring(L,1);
|
|
const int hf = get_hf_wslua_text();
|
|
if (hf > -1) {
|
|
/* use proto_tree_add_none_format() instead? */
|
|
item = proto_tree_add_item(tree_item->tree, hf, tvbr->tvb->ws_tvb, tvbr->offset, tvbr->len, ENC_NA);
|
|
proto_item_set_text(item, "%s", s);
|
|
} else {
|
|
luaL_error(L,"Internal error: hf_wslua_text not registered");
|
|
}
|
|
lua_remove(L,1);
|
|
} else {
|
|
luaL_error(L,"Tree item ProtoField/Protocol handle is invalid (ProtoField/Proto not registered?)");
|
|
}
|
|
}
|
|
|
|
while(lua_gettop(L)) {
|
|
/* keep appending more text */
|
|
const gchar* s = lua_tostring(L,1);
|
|
if (s) proto_item_append_text(item, " %s", s);
|
|
lua_remove(L,1);
|
|
}
|
|
|
|
push_TreeItem(L, proto_item_add_subtree(item,ett > 0 ? ett : wslua_ett), item);
|
|
|
|
return 1;
|
|
}
|
|
|
|
|
|
WSLUA_METHOD TreeItem_add(lua_State *L) {
|
|
/*
|
|
Adds a child item to this tree item, returning the new child `TreeItem`.
|
|
|
|
If the `ProtoField` represents a numeric value (int, uint or float), then it's treated as a Big Endian (network order) value.
|
|
|
|
This function has a complicated form: 'treeitem:add([protofield,] [tvbrange,] [[value], label]])', such that if the first
|
|
argument is a `ProtoField` or a `Proto`, the second argument is a `TvbRange`, and a third argument is given, it's a value;
|
|
but if the second argument is a non-`TvbRange`, then it's the value (as opposed to filling that argument with 'nil',
|
|
which is invalid for this function). If the first argument is a non-`ProtoField` and a non-`Proto` then this argument can
|
|
be either a `TvbRange` or a label, and the value is not in use.
|
|
*/
|
|
#define WSLUA_OPTARG_TreeItem_add_PROTOFIELD 2 /* The ProtoField field or Proto protocol object to add to the tree. */
|
|
#define WSLUA_OPTARG_TreeItem_add_TVBRANGE 3 /* The TvbRange of bytes in the packet this tree item covers/represents. */
|
|
#define WSLUA_OPTARG_TreeItem_add_VALUE 4 /* The field's value, instead of the ProtoField/Proto one. */
|
|
#define WSLUA_OPTARG_TreeItem_add_LABEL 5 /* One or more strings to use for the tree item label, instead of the ProtoField/Proto one. */
|
|
WSLUA_RETURN(TreeItem_add_item_any(L,FALSE)); /* The new child TreeItem. */
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_add_le(lua_State *L) {
|
|
/*
|
|
Adds a child item to this tree item, returning the new child `TreeItem`.
|
|
|
|
If the `ProtoField` represents a numeric value (int, uint or float), then it's treated as a Little Endian value.
|
|
|
|
This function has a complicated form: 'treeitem:add_le([protofield,] [tvbrange,] [[value], label]])', such that if the first
|
|
argument is a `ProtoField` or a `Proto`, the second argument is a `TvbRange`, and a third argument is given, it's a value;
|
|
but if the second argument is a non-`TvbRange`, then it's the value (as opposed to filling that argument with 'nil',
|
|
which is invalid for this function). If the first argument is a non-`ProtoField` and a non-`Proto` then this argument can
|
|
be either a `TvbRange` or a label, and the value is not in use.
|
|
*/
|
|
#define WSLUA_OPTARG_TreeItem_add_le_PROTOFIELD 2 /* The ProtoField field or Proto protocol object to add to the tree. */
|
|
#define WSLUA_OPTARG_TreeItem_add_le_TVBRANGE 3 /* The TvbRange of bytes in the packet this tree item covers/represents. */
|
|
#define WSLUA_OPTARG_TreeItem_add_le_VALUE 4 /* The field's value, instead of the ProtoField/Proto one. */
|
|
#define WSLUA_OPTARG_TreeItem_add_le_LABEL 5 /* One or more strings to use for the tree item label, instead of the ProtoField/Proto one. */
|
|
WSLUA_RETURN(TreeItem_add_item_any(L,TRUE)); /* The new child TreeItem. */
|
|
}
|
|
|
|
/* WSLUA_ATTRIBUTE TreeItem_text RW Set/get the `TreeItem`'s display string (string).
|
|
|
|
For the getter, if the TreeItem has no display string, then nil is returned.
|
|
|
|
@since 1.99.3
|
|
*/
|
|
static int TreeItem_get_text(lua_State* L) {
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
gchar label_str[ITEM_LABEL_LENGTH+1];
|
|
gchar *label_ptr;
|
|
|
|
if (ti->item) {
|
|
field_info *fi = PITEM_FINFO(ti->item);
|
|
|
|
if (!fi->rep) {
|
|
label_ptr = label_str;
|
|
proto_item_fill_label(fi, label_str);
|
|
} else
|
|
label_ptr = fi->rep->representation;
|
|
|
|
if (label_ptr) {
|
|
lua_pushstring(L, label_ptr);
|
|
} else {
|
|
lua_pushnil(L);
|
|
}
|
|
} else {
|
|
lua_pushnil(L);
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
/* the following is used as both a method and attribute */
|
|
WSLUA_METHOD TreeItem_set_text(lua_State *L) {
|
|
/* Sets the text of the label.
|
|
|
|
This used to return nothing, but as of 1.11.3 it returns the same tree item to allow chained calls.
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_set_text_TEXT 2 /* The text to be used. */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
const gchar* s = luaL_checkstring(L,WSLUA_ARG_TreeItem_set_text_TEXT);
|
|
|
|
proto_item_set_text(ti->item,"%s",s);
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_append_text(lua_State *L) {
|
|
/* Appends text to the label.
|
|
|
|
This used to return nothing, but as of 1.11.3 it returns the same tree item to allow chained calls.
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_append_text_TEXT 2 /* The text to be appended. */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
const gchar* s = luaL_checkstring(L,WSLUA_ARG_TreeItem_append_text_TEXT);
|
|
|
|
proto_item_append_text(ti->item,"%s",s);
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_prepend_text(lua_State *L) {
|
|
/* Prepends text to the label.
|
|
|
|
This used to return nothing, but as of 1.11.3 it returns the same tree item to allow chained calls.
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_prepend_text_TEXT 2 /* The text to be prepended. */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
const gchar* s = luaL_checkstring(L,WSLUA_ARG_TreeItem_prepend_text_TEXT);
|
|
|
|
proto_item_prepend_text(ti->item,"%s",s);
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_add_expert_info(lua_State *L) {
|
|
/* Sets the expert flags of the item and adds expert info to the packet.
|
|
|
|
This function does *not* create a truly filterable expert info for a protocol.
|
|
Instead you should use `TreeItem.add_proto_expert_info()`.
|
|
|
|
Note: This function is provided for backwards compatibility only, and should not
|
|
be used in new Lua code. It may be removed in the future. You should only
|
|
use `TreeItem.add_proto_expert_info()`.
|
|
*/
|
|
#define WSLUA_OPTARG_TreeItem_add_expert_info_GROUP 2 /* One of `PI_CHECKSUM`, `PI_SEQUENCE`,
|
|
`PI_RESPONSE_CODE`, `PI_REQUEST_CODE`,
|
|
`PI_UNDECODED`, `PI_REASSEMBLE`,
|
|
`PI_MALFORMED` or `PI_DEBUG`. */
|
|
#define WSLUA_OPTARG_TreeItem_add_expert_info_SEVERITY 3 /* One of `PI_CHAT`, `PI_NOTE`,
|
|
`PI_WARN`, or `PI_ERROR`. */
|
|
#define WSLUA_OPTARG_TreeItem_add_expert_info_TEXT 4 /* The text for the expert info display. */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
int group = (int)luaL_optinteger(L,WSLUA_OPTARG_TreeItem_add_expert_info_GROUP,PI_DEBUG);
|
|
int severity = (int)luaL_optinteger(L,WSLUA_OPTARG_TreeItem_add_expert_info_SEVERITY,PI_CHAT);
|
|
expert_field* ei_info = wslua_get_expert_field(group, severity);
|
|
const gchar* str;
|
|
|
|
if (lua_gettop(L) >= WSLUA_OPTARG_TreeItem_add_expert_info_TEXT) {
|
|
str = wslua_checkstring_only(L, WSLUA_OPTARG_TreeItem_add_expert_info_TEXT);
|
|
expert_add_info_format(lua_pinfo, ti->item, ei_info, "%s", str);
|
|
} else {
|
|
expert_add_info(lua_pinfo, ti->item, ei_info);
|
|
}
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_add_proto_expert_info(lua_State *L) {
|
|
/* Sets the expert flags of the tree item and adds expert info to the packet.
|
|
|
|
@since 1.11.3
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_add_proto_expert_info_EXPERT 2 /* The `ProtoExpert` object to add to the tree. */
|
|
#define WSLUA_OPTARG_TreeItem_add_proto_expert_info_TEXT 3 /* Text for the expert info display
|
|
(default is to use the registered
|
|
text). */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
ProtoExpert expert = checkProtoExpert(L,WSLUA_ARG_TreeItem_add_proto_expert_info_EXPERT);
|
|
const gchar* str;
|
|
|
|
if (expert->ids.ei == EI_INIT_EI || expert->ids.hf == EI_INIT_HF) {
|
|
luaL_error(L, "ProtoExpert is not registered");
|
|
return 0;
|
|
}
|
|
|
|
if (lua_gettop(L) >= WSLUA_OPTARG_TreeItem_add_proto_expert_info_TEXT) {
|
|
str = wslua_checkstring_only(L, WSLUA_OPTARG_TreeItem_add_proto_expert_info_TEXT);
|
|
expert_add_info_format(lua_pinfo, ti->item, &expert->ids, "%s", str);
|
|
} else {
|
|
expert_add_info(lua_pinfo, ti->item, &expert->ids);
|
|
}
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_add_tvb_expert_info(lua_State *L) {
|
|
/* Sets the expert flags of the tree item and adds expert info to the packet
|
|
associated with the `Tvb` or `TvbRange` bytes in the packet.
|
|
|
|
@since 1.11.3
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_add_tvb_expert_info_EXPERT 2 /* The `ProtoExpert` object to add to the tree. */
|
|
#define WSLUA_ARG_TreeItem_add_tvb_expert_info_TVB 3 /* The `Tvb` or `TvbRange` object bytes to associate
|
|
the expert info with. */
|
|
#define WSLUA_OPTARG_TreeItem_add_tvb_expert_info_TEXT 4 /* Text for the expert info display
|
|
(default is to use the registered
|
|
text). */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
ProtoExpert expert = checkProtoExpert(L,WSLUA_ARG_TreeItem_add_proto_expert_info_EXPERT);
|
|
TvbRange tvbr;
|
|
const gchar* str;
|
|
|
|
if (expert->ids.ei == EI_INIT_EI || expert->ids.hf == EI_INIT_HF) {
|
|
luaL_error(L, "ProtoExpert is not registered");
|
|
return 0;
|
|
}
|
|
|
|
tvbr = shiftTvbRange(L,WSLUA_ARG_TreeItem_add_tvb_expert_info_TVB);
|
|
|
|
if (!tvbr) {
|
|
tvbr = wmem_new(wmem_packet_scope(), struct _wslua_tvbrange);
|
|
tvbr->tvb = shiftTvb(L,WSLUA_ARG_TreeItem_add_tvb_expert_info_TVB);
|
|
if (!tvbr->tvb) {
|
|
tvbr->tvb = wmem_new(wmem_packet_scope(), struct _wslua_tvb);
|
|
}
|
|
tvbr->tvb->ws_tvb = lua_tvb;
|
|
tvbr->offset = 0;
|
|
tvbr->len = 0;
|
|
}
|
|
|
|
if (lua_gettop(L) >= WSLUA_OPTARG_TreeItem_add_proto_expert_info_TEXT) {
|
|
str = wslua_checkstring_only(L, WSLUA_OPTARG_TreeItem_add_proto_expert_info_TEXT);
|
|
proto_tree_add_expert_format(ti->tree, lua_pinfo, &expert->ids,
|
|
tvbr->tvb->ws_tvb, tvbr->offset, tvbr->len,
|
|
"%s", str);
|
|
} else {
|
|
proto_tree_add_expert(ti->tree, lua_pinfo, &expert->ids,
|
|
tvbr->tvb->ws_tvb, tvbr->offset, tvbr->len);
|
|
}
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
|
|
/* WSLUA_ATTRIBUTE TreeItem_visible RO Get the `TreeItem`'s subtree visibility status (boolean).
|
|
|
|
@since 1.99.8
|
|
*/
|
|
static int TreeItem_get_visible(lua_State* L) {
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
|
|
if (ti->tree) {
|
|
lua_pushboolean(L, PTREE_DATA(ti->tree)->visible);
|
|
}
|
|
else {
|
|
lua_pushboolean(L, FALSE);
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
|
|
/* WSLUA_ATTRIBUTE TreeItem_generated RW Set/get the `TreeItem`'s generated state (boolean).
|
|
|
|
@since 1.99.8
|
|
*/
|
|
static int TreeItem_get_generated(lua_State* L) {
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
|
|
lua_pushboolean(L, PROTO_ITEM_IS_GENERATED(ti->item));
|
|
|
|
return 1;
|
|
}
|
|
|
|
/* the following is used as both a method and attribute. As a method it defaults
|
|
to setting the value, because that's what it used to do before. */
|
|
WSLUA_METHOD TreeItem_set_generated(lua_State *L) {
|
|
/* Marks the `TreeItem` as a generated field (with data inferred but not contained in the packet).
|
|
|
|
This used to return nothing, but as of 1.11.3 it returns the same tree item to allow chained calls.
|
|
*/
|
|
#define WSLUA_OPTARG_TreeItem_set_generated_BOOL 2 /* A Lua boolean, which if `true` sets the `TreeItem`
|
|
generated flag, else clears it (default=true) */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
gboolean set = wslua_optbool(L, WSLUA_OPTARG_TreeItem_set_generated_BOOL, TRUE);
|
|
|
|
if (set) {
|
|
PROTO_ITEM_SET_GENERATED(ti->item);
|
|
} else {
|
|
if (ti->item)
|
|
FI_RESET_FLAG(PITEM_FINFO(ti->item), FI_GENERATED);
|
|
}
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
/* WSLUA_ATTRIBUTE TreeItem_hidden RW Set/get `TreeItem`'s hidden state (boolean).
|
|
|
|
@since 1.99.8
|
|
*/
|
|
static int TreeItem_get_hidden(lua_State* L) {
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
|
|
lua_pushboolean(L, PROTO_ITEM_IS_HIDDEN(ti->item));
|
|
|
|
return 1;
|
|
}
|
|
|
|
/* the following is used as both a method and attribute. As a method it defaults
|
|
to setting the value, because that's what it used to do before. */
|
|
WSLUA_METHOD TreeItem_set_hidden(lua_State *L) {
|
|
/* Marks the `TreeItem` as a hidden field (neither displayed nor used in filters).
|
|
|
|
This used to return nothing, but as of 1.11.3 it returns the same tree item to allow chained calls.
|
|
*/
|
|
#define WSLUA_OPTARG_TreeItem_set_hidden_BOOL 2 /* A Lua boolean, which if `true` sets the `TreeItem`
|
|
hidden flag, else clears it (default=true) */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
gboolean set = wslua_optbool(L, WSLUA_OPTARG_TreeItem_set_hidden_BOOL, TRUE);
|
|
|
|
if (set) {
|
|
PROTO_ITEM_SET_HIDDEN(ti->item);
|
|
} else {
|
|
PROTO_ITEM_SET_VISIBLE(ti->item);
|
|
}
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
/* WSLUA_ATTRIBUTE TreeItem_len RW Set/get `TreeItem`'s length inside tvb, after it has already been created.
|
|
|
|
@since 1.99.8
|
|
*/
|
|
static int TreeItem_get_len(lua_State* L) {
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
int len = 0;
|
|
|
|
/* XXX - this is *NOT* guaranteed to return a correct value! */
|
|
len = proto_item_get_len(ti->item);
|
|
|
|
lua_pushinteger(L, len > 0 ? len : 0);
|
|
|
|
return 1;
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_set_len(lua_State *L) {
|
|
/* Set `TreeItem`'s length inside tvb, after it has already been created.
|
|
|
|
This used to return nothing, but as of 1.11.3 it returns the same tree item to allow chained calls.
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_set_len_LEN 2 /* The length to be used. */
|
|
TreeItem ti = checkTreeItem(L,1);
|
|
gint len = (int)luaL_checkinteger(L,WSLUA_ARG_TreeItem_set_len_LEN);
|
|
|
|
proto_item_set_len(ti->item, len);
|
|
|
|
/* copy the TreeItem userdata so we give it back */
|
|
lua_pushvalue(L, 1);
|
|
|
|
WSLUA_RETURN(1); /* The same TreeItem. */
|
|
}
|
|
|
|
WSLUA_METHOD TreeItem_referenced(lua_State *L) {
|
|
/* Checks if a ProtoField or Dissector is referenced by a filter/tap/UI.
|
|
|
|
If this function returns FALSE, it means that the field (or dissector) does not need to be dissected
|
|
and can be safely skipped. By skipping a field rather than dissecting it, the dissector will
|
|
usually run faster since Wireshark will not do extra dissection work when it doesn't need the field.
|
|
|
|
You can use this in conjunction with the TreeItem.visible attribute. This function will always return
|
|
TRUE when the TreeItem is visible. When it is not visible and the field is not referenced, you can
|
|
speed up the dissection by not dissecting the field as it is not needed for display or filtering.
|
|
|
|
This function takes one parameter that can be a ProtoField or a Dissector. The Dissector form is
|
|
usefull when you need to decide whether to call a sub-dissector.
|
|
|
|
@since 2.4.0
|
|
*/
|
|
#define WSLUA_ARG_TreeItem_referenced_PROTOFIELD 2 /* The ProtoField or Dissector to check if referenced. */
|
|
TreeItem ti = checkTreeItem(L, 1);
|
|
if (!ti) return 0;
|
|
ProtoField f = shiftProtoField(L, WSLUA_ARG_TreeItem_referenced_PROTOFIELD);
|
|
if (f) {
|
|
lua_pushboolean(L, proto_field_is_referenced(ti->tree, f->hfid));
|
|
}
|
|
else {
|
|
Dissector d = checkDissector(L, WSLUA_ARG_TreeItem_referenced_PROTOFIELD);
|
|
if (!d) return 0;
|
|
lua_pushboolean(L, proto_field_is_referenced(ti->tree, dissector_handle_get_protocol_index(d)));
|
|
}
|
|
WSLUA_RETURN(1); /* A boolean indicating if the ProtoField/Dissector is referenced */
|
|
}
|
|
|
|
WSLUA_METAMETHOD TreeItem__tostring(lua_State* L) {
|
|
/* Returns string debug information about the `TreeItem`.
|
|
|
|
@since 1.99.8
|
|
*/
|
|
TreeItem ti = toTreeItem(L,1);
|
|
|
|
if (ti) {
|
|
lua_pushfstring(L,
|
|
"TreeItem: expired=%s, has item=%s, has subtree=%s, they are %sthe same",
|
|
ti->expired ? "true" : "false",
|
|
ti->item ? "true" : "false",
|
|
ti->tree ? "true" : "false",
|
|
(ti->tree == ti->item) ? "" : "not ");
|
|
}
|
|
else {
|
|
lua_pushstring(L, "No TreeItem object!");
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
/* Gets registered as metamethod automatically by WSLUA_REGISTER_CLASS/META */
|
|
static int TreeItem__gc(lua_State* L) {
|
|
TreeItem ti = toTreeItem(L,1);
|
|
if (!ti) return 0;
|
|
if (!ti->expired)
|
|
ti->expired = TRUE;
|
|
else
|
|
g_free(ti);
|
|
return 0;
|
|
}
|
|
|
|
WSLUA_ATTRIBUTES TreeItem_attributes[] = {
|
|
WSLUA_ATTRIBUTE_RWREG(TreeItem,generated),
|
|
WSLUA_ATTRIBUTE_RWREG(TreeItem,hidden),
|
|
WSLUA_ATTRIBUTE_RWREG(TreeItem,len),
|
|
WSLUA_ATTRIBUTE_RWREG(TreeItem,text),
|
|
WSLUA_ATTRIBUTE_ROREG(TreeItem,visible),
|
|
{ NULL, NULL, NULL }
|
|
};
|
|
|
|
WSLUA_METHODS TreeItem_methods[] = {
|
|
WSLUA_CLASS_FNREG(TreeItem,add_packet_field),
|
|
WSLUA_CLASS_FNREG(TreeItem,add),
|
|
WSLUA_CLASS_FNREG(TreeItem,add_le),
|
|
WSLUA_CLASS_FNREG(TreeItem,set_text),
|
|
WSLUA_CLASS_FNREG(TreeItem,append_text),
|
|
WSLUA_CLASS_FNREG(TreeItem,prepend_text),
|
|
WSLUA_CLASS_FNREG(TreeItem,add_expert_info),
|
|
WSLUA_CLASS_FNREG(TreeItem,add_proto_expert_info),
|
|
WSLUA_CLASS_FNREG(TreeItem,add_tvb_expert_info),
|
|
WSLUA_CLASS_FNREG(TreeItem,set_generated),
|
|
WSLUA_CLASS_FNREG(TreeItem,set_hidden),
|
|
WSLUA_CLASS_FNREG(TreeItem,set_len),
|
|
WSLUA_CLASS_FNREG(TreeItem,referenced),
|
|
{ NULL, NULL }
|
|
};
|
|
|
|
WSLUA_META TreeItem_meta[] = {
|
|
WSLUA_CLASS_MTREG(TreeItem,tostring),
|
|
{ NULL, NULL }
|
|
};
|
|
|
|
int TreeItem_register(lua_State *L) {
|
|
gint* etts[] = { &wslua_ett };
|
|
wslua_ett = -1; /* Reset to support reload Lua plugins */
|
|
WSLUA_REGISTER_CLASS(TreeItem);
|
|
WSLUA_REGISTER_ATTRIBUTES(TreeItem);
|
|
outstanding_TreeItem = g_ptr_array_new();
|
|
proto_register_subtree_array(etts,1);
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* Editor modelines - http://www.wireshark.org/tools/modelines.html
|
|
*
|
|
* Local variables:
|
|
* c-basic-offset: 4
|
|
* tab-width: 8
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
*
|
|
* vi: set shiftwidth=4 tabstop=8 expandtab:
|
|
* :indentSize=4:tabSize=8:noTabs=true:
|
|
*/
|