首页 > 代码库 > 使用lua给wireshark编写uTP的Dissector

使用lua给wireshark编写uTP的Dissector

2024-07-31 02:35:01   220人阅读

 
lonelycastle做uTP的实验，使用wireshark捕包，但是最初没有找到wireshark下的uTP的dissector，每次都需要比对文档，这样做实验理解报文含义，效率非常低。作为程序猿就想写一个uTP的dissector来实现这些工作。说干就干，查了一下发现wireshark可以使用lua来实现dissector，这样就简单过了，不用编写C的dissector了。本身是lua盲，又不了解wireshark的dissector开发，中间遇到了很多问题，还好逻辑比较简单，折腾了一个晚上就搞定了;-)
 
BTW: 后来发现wireshark中已经有了bt-utp这个dissector，但是没有判断PIECE分包。
 
1. 如何定义小于1个字节的field
   >> 查了一下User Guide，发现可以在创建ProtoField的时候，使用mask参数就可以了。
2. 如何取小于1个字节field的值
   >> 这个需要位操作进行处理，具体见参考文献1。主要是bit.band, bit.bor, bit.bxor, bit.rshift, bit.lshift等。注意右移位是bit.rshift，而不是bit.brshift。
3. 如何调用其他Dissector
   >> Dissector.get()获得系统中已经有的dissector；DissectorTable.get()获得系统中已经有的dissector table，再调用get_dissector()获得最终的dissector。
   >> 获得dissector后，就可以直接调用call，call的参数跟dissector function的参数一致。
  1. xx_protocol.dissector = function(buffer,pinfo,tree) 
  2. --定义这个协议的解析函数，最后会将这个函数注册到wireshark用来解析数据的表中。这个函数的三个参数很重要，是wireshark引擎在调用该函数是会传入， 
  3. --buffer就是我们要分析的数据， 
  4. --pinfo记录了前面分析过协议留下的信息，
  5. --tree是用来在详细框中添加我们信息的结构。
4. 如何设置报文信息
   >>直接修改pkt.cols.info，其中pkt是dissector function传入的参数，具体见参考文献4.
5. 如何处理一个应用报文跨多个uTP报文
   >>在BitTorrent中，PIECE报文比较大，会跨多个uTP报文，这个时候需要判断出第一个PIECE报文，进行解析，后面的PIECE报文不需要解析，如果解析就会导致出错。这里是使用一个检查函数，判断每种type下，协议中数据长度是否满足限制来实现的。
 
具体如何运行这里就不多说了，直接在init.lua中最后增加dofile就可以，注意要首先把lua_disable关上，debian用户需要保证root也可以在wireshark中运行lua。调试的时候可以看wireshark的报错信息。
 
示例代码如下，BitTorrent的解析调用了wireshark内部已有的bittorrent.tcp dissector：
  1. do
  2.     -- Desc: uTP Protocol lua version
  3.     -- Author: WangYao, ipconfigme@gmail.com
  4.     -- Date: 2011/10/19
  5.     
  6.     -- protol name
  7.     local p_utp = Proto("utp", "Micro Transport Protocol");
  9.     -- protocol fields
  10.     local f_version = ProtoField.uint8("utp.version", "Version", base.DEC,
  11.     {[1]="V1"}, 0x0F)
  12.     local f_type = ProtoField.uint8("utp.type", "Type", base.DEC, 
  13.     {[0]="ST_DATA", [1]="ST_FIN", [2]="ST_STATE", [3]="ST_RESET", [4]="ST_SYN"}, 0xF0)
  14.     local f_next_extension_type = ProtoField.uint8("utp.next_extension_type", "Next Extension Type", base.DEC, 
  15.     {[0]="No Extension", [1]="Selective acks", [2]="Extension bits"})
  16.     local f_extension_len = ProtoField.uint8("utp.extension_len", "Extension Length", base.DEC)
  17.     local f_extension_bitmask = ProtoField.bytes("utp.extension_bitmask", "Extension Bitmask", base.NONE)
  18.     local f_connection_id = ProtoField.uint16("utp.connection_id", "Connection_ID", base.DEC)
  19.     local f_timestamp_microseconds = ProtoField.uint32("utp.timestamp_microseconds", "timestamp_microseconds", base.DEC)
  20.     local f_timestamp_difference_microseconds = ProtoField.uint32("utp.timestamp_difference_microseconds", "timestamp_difference_microseconds", base.DEC)
  21.     local f_wnd_size = ProtoField.uint32("utp.wnd_size", "wnd_size", base.DEC)
  22.     local f_seq_nr = ProtoField.uint16("utp.seq_nr", "seq_nr", base.DEC)
  23.     local f_ack_nr = ProtoField.uint16("utp.ack_nr", "ack_nr", base.DEC)
  24.     p_utp.fields = {f_version, f_type, f_next_extension_type, f_extension_len, f_extension_bitmask, f_connection_id, f_timestamp_microseconds, f_timestamp_difference_microseconds, f_wnd_size, f_seq_nr, f_ack_nr}
  27.     -- other dissector
  28.     local data_dis = Dissector.get("data")
  29.     local bittorrent_dissector = Dissector.get("bittorrent.tcp")
  31.     -- utp dissector, return OFFSET
  32.     local function utp_dissector(buf,pkt,root)
  33.         local buf_len = buf:len()
  34.         local offset = 0
  36.         -- check pack len
  37.         if buf_len < 20 then return 0 end
  39.         -- get fields
  40.         local v_version = buf(offset, 1)
  41.         local v_type = buf(offset, 1)
  42.         offset = offset + 1
  43.         local v_next_extension_type = buf(offset, 1)
  44.         offset = offset + 1
  45.         local v_connection_id = buf(offset, 2)
  46.         offset = offset + 2
  47.         local v_timestamp_microseconds = buf(offset, 4)
  48.         offset = offset + 4
  49.         local v_timestamp_difference_microseconds = buf(offset, 4)
  50.         offset = offset + 4
  51.         local v_wnd_size = buf(offset, 4)
  52.         offset = offset + 4
  53.         local v_seq_nr = buf(offset, 2)
  54.         offset = offset + 2
  55.         local v_ack_nr = buf(offset, 2)
  56.         offset = offset + 2
  58.         -- check uTP
  59.         local i_version = bit.band(v_version:uint(), 0x0F)
  60.         -- local i_type = bit.band(bit.rshift(v_type:uint(), 4), 0x0F)
  61.         local i_type = bit.rshift(bit.band(v_type:uint(), 0xF0), 4)
  62.         if( (i_version~=1) or (i_type~=0 and i_type~=1 and i_type~=2 and i_type~=3 and i_type~=4))
  63.             then return 0 end
  65.         local subtree = root:add(p_utp, buf(),"Micro Transport Protocol")
  66.         -- just add header
  67.         subtree:add(buf(0,0),"uTP Header: ") 
  68.         subtree:add(f_version, v_version)
  69.         subtree:add(f_type, v_type)
  70.         subtree:add(f_next_extension_type, v_next_extension_type)
  71.         subtree:add(f_connection_id, v_connection_id)
  72.         subtree:add(f_timestamp_microseconds, v_timestamp_microseconds)
  73.         subtree:add(f_timestamp_difference_microseconds, v_timestamp_difference_microseconds)
  74.         subtree:add(f_wnd_size, v_wnd_size)
  75.         subtree:add(f_seq_nr, v_seq_nr)
  76.         subtree:add(f_ack_nr, v_ack_nr)
  78.         -- add pkt info
  79.         pkt.cols.protocol = "uTP"
  80.         if(i_type==0) then
  81.             pkt.cols.info = "uTP ST_DATA"
  82.         elseif(i_type==1) then
  83.             pkt.cols.info = "uTP ST_FIN"
  84.         elseif(i_type==2) then
  85.             pkt.cols.info = "uTP ST_STATE"
  86.         elseif(i_type==3) then
  87.             pkt.cols.info = "uTP ST_RESET"
  88.         elseif(i_type==4) then
  89.             pkt.cols.info = "uTP ST_SYN"
  90.         else
  91.             pkt.cols.info = "uTP UNKNOW"
  92.         end
  94.         while(v_next_extension_type:uint()~=0) do
  95.             -- add extension tree
  96.             local extendtree = subtree:add(p_utp, buf(offset, buf_len-offset):tvb(),"Extension")
  97.             if(v_next_extension_type:uint()==0) then
  98.                 extendtree:append_text(": NO Extension")
  99.             elseif(v_next_extension_type:uint()==1) then
  100.                 extendtree:append_text(": Selective acks")
  101.             elseif(v_next_extension_type:uint()==2) then
  102.                 extendtree:append_text(": Extension bits")
  103.             end
  105.             v_next_extension_type = buf(offset, 1)
  106.             offset = offset + 1
  107.             extendtree:add(f_next_extension_type, v_next_extension_type)
  108.             local v_extension_len = buf(offset, 1)
  109.             offset = offset + 1
  110.             extendtree:add(f_extension_len, v_extension_len)
  111.             local i_extension_len = v_extension_len:int()
  112.             local v_extension_bitmask = buf(offset, i_extension_len)
  113.             offset = offset + i_extension_len
  114.             extendtree:add(f_extension_bitmask, v_extension_bitmask)
  115.         end
  117.         return offset 
  118.     end
  120.     -- check packet is bittorrent? header legal
  121.     local function check_bittorrent(buf)
  122.         local len = buf:len()
  123.         local pack_len = buf(0,4)
  124.         local pack_type
  126.         if(len<4) then
  127.             return false
  128.         elseif(buf(0,1):uint()==19 and len==68) then --handshake
  129.             return true
  130.         elseif(len==4) then --keepalive
  131.             if(pack_len:uint()==0) then return true
  132.             else return false
  133.             end
  134.         else
  135.             pack_type = buf(4,1)
  136.             --choke, unchoke, interested, not interested, have all, have none
  137.             if(pack_type:uint()==0 or pack_type:uint()==1 or pack_type:uint()==2 or pack_type:uint()==3 or pack_type:uint()==0x0E or pack_type:uint()==0x0F) then
  138.                 if(pack_len:uint()==1) then return true
  139.                 else return false
  140.                 end
  141.             --request, cancel, reject
  142.             elseif(pack_type:uint()==6 or pack_type:uint()==8 or pack_type:uint()==0x10) then
  143.                 if(pack_len:uint()==13) then return true
  144.                 else return false
  145.                 end
  146.             --port
  147.             elseif(pack_type:uint()==9) then
  148.                 if(pack_len:uint()==3) then return true
  149.                 else return false
  150.                 end
  151.             --have, suggest, allowed fast
  152.             elseif(pack_type:uint()==4 or pack_type:uint()==0x0D or pack_type:uint()==0x11) then
  153.                 if(pack_len:uint()==5) then return true
  154.                 else return false
  155.                 end
  156.             --bitfield, extend
  157.             elseif(pack_type:uint()==5 or pack_type:uint()==0x14) then
  158.                 if(pack_len:uint()<1024) then return true
  159.                 else return false
  160.                 end
  161.             --piece, max than 16K
  162.             elseif(pack_type:uint()==7) then
  163.                 if(pack_len:uint()>=16384) then return true
  164.                 else return false
  165.                 end
  166.             else
  167.                 return false
  168.             end
  169.         end
  171.         return false
  172.     end
  174.     -- protocol dissector, include bittorrent
  175.     function p_utp.dissector(buf,pkt,root) 
  176.         local len = buf:len()
  177.         local offset = utp_dissector(buf, pkt, root)
  178.         if len>offset and offset>0 then
  179.             -- call bittorrent dissector
  180.             -- pass split PIECE pack
  181.             if check_bittorrent(buf(offset, len-offset)) then
  182.                 bittorrent_dissector:call(buf(offset, len-offset):tvb(), pkt, root)
  183.             else
  184.                 data_dis:call(buf(offset,len-offset):tvb(), pkt, root)
  185.             end
  186.         elseif offset==0 then
  187.             -- call data dissector
  188.             data_dis:call(buf,pkt,root)
  189.         end
  190.     end
  192.     -- add to DissectorTable
  193.     local udp_table = DissectorTable.get("udp.port")
  194.     -- udp_table:add(4135, p_utp) 
  195.     udp_table:add(10000, p_utp) 
  196. end
 
 
参考
http://www.wowwiki.com/Lua_functions
http://bittorrent.org/beps/bep_0000.html
http://wiki.wireshark.org/Lua/Dissectors
http://sharkfest.wireshark.org/sharkfest.09/DT06_Bjorlykke_Lua%20Scripting%20in%20Wireshark.pdf
http://lua-bitstring.googlecode.com/svn-history/r62/wiki/ExplainFastDissect.wiki
http://www.wireshark.org/download/docs/user-guide-a4.pdf
 

使用lua给wireshark编写uTP的Dissector


联系
我们