This wiki has been migrated to https://gitlab.com/wireshark/wireshark/-/wikis/home and is now deprecated. Please use that site instead.
Differences between revisions 20 and 21
Revision 20 as of 2006-02-08 16:31:16
Size: 5634
Editor: LuisOntanon
Comment:
Revision 21 as of 2006-02-08 17:55:40
Size: 5635
Editor: LuisOntanon
Comment: fix the table
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
 ||attachment:lua_logo.gif||Lua is a powerful light-weight programming language designed for extending applications. Lua is designed and implemented by a [http://www.lua.org/authors.html team] at [http://www.puc-rio.br/ PUC-Rio], the Pontifical Catholic University of Rio de Janeiro in Brazil. Lua was born and raised at [http://www.tecgraf.puc-rio.br/ Tecgraf], the Computer Graphics Technology Group of PUC-Rio, and is now housed at [http://www.lua.org Lua.org]. Both Tecgraf and Lua.org are laboratories of the [http://www.inf.puc-rio.br/ Department of Computer Science].  ||attachment:lua_logo.gif||Lua is a powerful light-weight programming language designed for extending applications. Lua is designed and implemented by a [http://www.lua.org/authors.html team] at [http://www.puc-rio.br/ PUC-Rio], the Pontifical Catholic University of Rio de Janeiro in Brazil. Lua was born and raised at [http://www.tecgraf.puc-rio.br/ Tecgraf], the Computer Graphics Technology Group of PUC-Rio, and is now housed at [http://www.lua.org Lua.org]. Both Tecgraf and Lua.org are laboratories of the [http://www.inf.puc-rio.br/ Department of Computer Science]. ||
 
Lua's been added to ethereal as a language for prototyping and scripting.
Line 6: Line 8:
Lua's been added to ethereal as a language for prototyping and scripting.||
 

Lua

Lua's been added to ethereal as a language for prototyping and scripting.

For more information about Lua refer to [http://www.lua.org Lua's main site], there you can find its [http://www.lua.org/manual/5.0/manual.html Reference Manual] and a [http://www.lua.org/pilhttp://www.lua.org/pil book] that describes the language. There is also [http://lua-users.org/wiki/ The lua-users wiki].

beware the GPL

Ethereal is released under [http://www.gnu.org/licenses/gpl.html GPL] so every derivative work based on ethereal must be released under the terms of the GPL.

/!\ Even if the code you write in Lua does not need to be GPL'ed. The code written in Lua that uses bindings to ethereal must be distributed under the GPL terms. see http://www.gnu.org/licenses/gpl-faq.html#TOCIfInterpreterIsGPL for more info /!\

There is at least one ethereal author that will not allow to distribute derivative work under different terms. To distribute Lua code that uses ethereal's bindings under different terms would be a clear violation of the GPL.

If it isn't clear to you what the GPL is and how it works please consult your laywer.

Lua in Ethereal

Lua can be used to write [:Lua/Dissectors: dissectors], post-dissectors and [:Lua/Taps: taps].

Although it's possible to write [:Lua/Dissectors: dissectors] in Lua, ethereal dissectors are written in C, as C is several times faster than Lua. Lua is ok for prototyping dissectors, during Reverse Engineering you can use your time for finding out how things work instead of compiling and debugging your C dissector.

Post-dissectors are dissectors meant to run after every other dissector has run. They can add items the dissection tree so they can be used to create your own extensions to the filtering mechanism.

[:Lua/Taps: Taps] are used to collect information after the packet has been dissected.

Getting Started

Lua is an optional module in ethereal 0.10.15(???) so it won't be installed by default. If you want to use it make sure you install it.

To check if it is installed go to Help->About Ethereal go to the Plugins tab and look for it.

attachment:about.png

To test if it works write a simple Lua script like:

-- hello.lua
-- Lua's implementation of D. Ritchie's hello world program.

    print("hello world!")

run tethereal -X lua_script:test.lua from the command prompt and tou should see something like:

$ tethereal -X lua_script:hello.lua
hello world!
Capturing on en0
1   0.000000 111.123.234.55 -> 111.123.234.255 NBNS Name query NB XXX.COM<00>

if you can read "hello world!" in the first line after you run tethereal Lua is up and runing.

Classes

  • [:Lua/Tap: Tap]
  • [:Lua/Field: Field] a handy tool to get fileds from the tree
  • [:Lua/Proto: Proto] represents a protocol
  • [:Lua/ProtoField: ProtoField] the fields of a protocol

  • [:Lua/ProtoFieldArray: ProtoFieldArray]

  • [:Lua/Dissector: Dissector] utility class to handle dissectors
  • [:Lua/Dissector: DissectorTable] utility class to handle dissectors

  • [:Lua/Pinfo: Pinfo] current packet information
  • [:Lua/ProtoTree: ProtoTree]

  • [:Lua/ProtoTree: ProtoItem]

  • [:Lua/SubTree: SubTree] subtrees

  • [:Lua/Tvb: Tvb] access to the packet's actual bytes
  • [:Lua/ByteArray: ByteArray] utility class to manage an array of bytes

  • [:Lua/Gui: TextWindow] class that manages text-only windows.

Examples

  • Examples of generic Lua code can be found in [http://lua-users.org/wiki/SampleCode The Sample Code] page of Lua-Users wiki.

  • [:Lua/Examples/Tap: tap example]
  • [:Lua/Examples/Dissector: dissector example]
  • [:Lua/Examples/PostDissector: post-dissector example]

Discussion

This page is a good start. However, some things remain unclear:

  • How to install/use lua?
  • What's the difference between a post-dissector and a tap

That's what it is, a start... I think it's soon to complete as things are changing as I go ahead.

  • So far it works only on *NIX as I'm still bringing it up. If you want the lua plugin installed configure --with-lua=<lua_directory> to get it to work for windows I'll need help.

  • I do not have yet a clear idea on how Lua will be invoked from ethereal.
    • So far as a temporary solution:
      • it either looks for ~/.ethereal/init.lua and loads that script
      • or looks for a file pointed by the environment variable ETHEREAL_LUA_INIT.
    • It will change as soon as I (or someone else, proposals are welcome) come out with a good way to do it.
  • Tap vs. Postdissector
    • a post dissector is it's like a normal dissector called every time a tree needs to be generated for a frame it just gets called at last.
    • a tap is run once after the first dissection of a packet and it has no access to the tree, it cannot add fields (a postdissector can but it will be called every time a tree needs to be generated).
      • -- Luis E. G. O.

Lua (last edited 2020-03-31 15:55:54 by GeraldCombs)