CN110266702A - 基于XML的Wireshark用协议解析方法 - Google Patents

Abstract

本发明公开了一种基于XML的Wireshark用协议解析方法，包括：根据ICD中描述的数据报文协议的需求，将数据报文协议的内容用XML的树形结构描述出来，形成XML文档；XML协议引擎自动解析XML文档，生成对应的协议解析树，并保存于内存中；Wireshark在处理数据报文时，自动调用内存中的协议解析树，生成对应的解析结果。能快速、方便地实现Wireshark协议解析。

Description

基于XML的Wireshark用协议解析方法

技术领域

本发明涉及基于XML的Wireshark用协议解析方法。

背景技术

在当前的软件系统中，基于网络的通信非常普遍，由于通信错误导致的问题也是层出不穷，因此对于开发人员和运营人员来说，通信过程中的协议分析工具就非常的重要。Wireshark是一种广泛应用的数据报文分析工具，为了在Wireshark中解析自定义的通信协议，经常需要编写相应的LUA脚本，然而这需要一定的编程基础，对于非编程人员或者不熟悉Lua脚本的人员来说有比较高的门槛，同时对于复杂的协议来说，编写和调试脚本也非常耗时。实际工作中测试工程师和现场工程师经常需要查看子系统之间的数据报文。如何更方便和快速实现Wireshark协议解析。

发明内容

本发明的目的在于提供基于XML的Wireshark用协议解析方法，能快速、方便地实现Wireshark协议解析。

实现上述目的的技术方案是：

一种基于XML的Wireshark用协议解析方法，包括：

根据ICD中描述的数据报文协议的需求，采用XML的树形结构描述数据报文协议的内容，并形成XML文档；

XML协议引擎自动解析所述XML文档，生成对应的协议解析树，并保存于内存中；

Wireshark在处理数据报文时，自动调用内存中的所述协议解析树，生成对应的解析结果。

优选的，根据权利要求1所述的基于XML的Wireshark用协议解析方法，其特征在于，所述的XML协议引擎自动解析XML文档，包括：

读取XML文档；

XML协议引擎从顶层元素开始依次解析XML文档的各元素：

判断当前元素是否为简单类型，若是，该元素解析完成；若否，继续判断：

若当前元素是xs:sequence类型，在当前元素中生成子元素数组，并依次解析数组中的各子元素；xs:sequence代表定义在其中的元素集合在数据报文中依次出现；

若当前元素是xs:choice类型，在当前元素中根据xs:choice元素中selected Id生成以selected Id为索引的键值对，并依次解析键值对中的各元素；xs:choice代表定义在其中的元素集合中只有一个元素出现在数据报文中；selected Id表示出现在xs:choice元素集合之中的当前元素的ID。

优选的，所述的Wireshark处理数据报文，包括：

使用DFS遍历算法，从根节点开始遍历各元素；

如果当前元素是简单类型，直接从当前的数据流中取出对应的长度，算出这个元素的值，并保存起来；

如果当前元素是复杂类型，执行：

若当前元素是xs:sequence类型，继续依次遍历当前的元素数组；

xs:sequence代表定义在其中的元素集合在数据报文中依次出现；

若当前元素是xs:choice类型，先根据selector的定义取出对应的接下来要选择元素的ID，然后再从xs:choice元素集合中找出符合的元素开始解析；xs:choice代表定义在其中的元素集合中只有一个元素出现在数据报文中；selector表示接下来要选择元素的id；

当所有的元素都已经遍历结束，并且数据报文也结束时，那么则遍历成功，否则遍历失败。

优选的，预先定义XML协议引擎：

XML标签设计：

xs:element，用于表示数据报文中的元素；

xs:complexType，用于定义多个xs:element，自定义的复杂类型；

xs:simpleType,用于定义枚举类型，自定义的简单类型；

xs:sequence，代表定义在其中的元素集合在数据报文中依次出现；

xs:choice，代表定义在其中的元素集合中只有一个元素出现在数据报文中；

xs:restriction，用于定义枚举值的集合；

xs:enumeration，单个的枚举值定义；

XML属性设计：

Name，用于指定标签的名字；

type，用于指定元素的类型；

unit，用于指定元素的单位；

length，用于指定元素的长度，手动设定或根据数据报文动态获取，需要动态获取时语法：length＝”return${element name}”,表示当前元素长度由其他元素的值决定；

occurs，表示当前元素连续重复出现的次数，可手动设定或根据数据报文动态获取，需要动态获取时语法：occurs＝”return${element name}”,表示当前元素的连续出现的次数长度由其他元素的值决定；

value，出现在枚举值的定义中，表示枚举的整形数值；

text，出现在枚举值的定义中，表示枚举值的文本值；

selected Id，出现在xs:choice元素集合之中，表示当前元素的ID；

selector，只有在当前元素的类型为xs:choice时才有效，表示接下来要选择元素的id，语法如下：selector＝”return${element name}”，选择器的值由其他元素指定；

supportSplit，表示当前元素是否支持拆包，如果支持拆包那么此元素的值将分拆后出现在多个数据报文中；

packet Id，配合supportSplit使用，仅在当元素支持拆包时被定义，语法：packetId＝”return${tsn name}”，表示当前的packet Id实际来源于哪一包数据；

packetSequence，配合supportSplit使用，仅在当元素支持拆包时被定义，语法：packetSequence＝“return${element name}”，表示当前包是第几个拆包后的子包；

packetNumber，配合supportSplit使用，仅在当元素支持拆包时被定义，语法：packetSequence＝“return${element name}”，表示当前元素一共分拆到几个数据报文中。

本发明的有益效果是：本发明通过将协议内容用XML的树形结构描述出来，利用定义的XML协议引擎自动解析XML文档，生成对应的协议解析树，当Wireshark在处理数据报文时，将自动调用协议解析树，生成对应的解析结果。相比于传统的使用LUA脚本，本发明使用XML来描述数据报文更加的简单和快速。同时，本发明使用人类易于读懂的文本描述数据报文协议，大大简化了后期的维护。

附图说明

图1是本发明的基于XML的Wireshark用协议解析方法的流程图；

图2是本发明中协议解析树第一、二层的结构示意图；

图3是本发明中协议解析树的最终结构示意图；

图4是本发明中XML协议引擎解析XML文档的流程图。

具体实施方式

下面将结合附图对本发明作进一步说明。

网络通信领域中，数据协议的定义一般遵循TLV的格式定义，如下表1：

Type

Length

Value

表1

“T”代表类型(type)，“L”代表长度(length),“V”代表数据(value)。这是最普遍也是最基本的数据包格式定义，下面所有的介绍将以这一基本的通信数据定义为例子。

预先定义XML协议引擎：

XML标签设计：

xs:element，用来表示数据报文中的元素即表示数据报文中的元素。

xs:complexType，用来定义多个xs:element，自定义的复杂类型。

xs:simpleType,可以用来定义枚举类型，自定义的简单类型。

xs:sequence，代表定义在其中的element集合必须在数据报文中依次出现。

xs:choice，代表定义在其中的element集合只有一个会出现在数据报文中。

xs:restriction，用来定义枚举值的集合。

xs:enumeration，单个的枚举值定义。

XML属性设计：

Name，用来指定标签的名字，同一种标签中name会被当做索引用，因此必须唯一。

type，用来指定element的类型；类型值包括xs:integer(整形数据),xs:hex(十六进制数据),xs:string(字符数据)，自定义的简单类型(xs:simpleType)，自定义的复杂类型(xs:complexType)。

unit，用来指定element的单位，分为两种：bit和byte。

length，用来指定element的长度，手动设定或根据数据报文动态获取，需要动态获取时语法：length＝”return${element name}”,表示当前元素长度由其他元素的值决定。

occurs，表示当前元素连续重复出现的次数，可手动设定或根据数据报文动态获取，需要动态获取时语法：occurs＝”return${element name}”,表示当前元素的连续出现的次数长度由其他元素的值决定。

value，出现在枚举值的定义中，表示枚举的整形数值。

text，出现在枚举值的定义中，表示枚举值的文本值。

selected Id，出现在xs:choice元素集合之中，表示当前元素的ID。

selector，只有在当前元素的类型为xs:choice时才有效，表示接下来要选择元素的id，语法如下：selector＝”return${element name}”，选择器的值由其他元素指定。

supportSplit，表示当前元素是否支持拆包，如果支持拆包那么此元素的值将分拆后出现在多个数据报文中。

packet Id，必须配合supportSplit使用，只有当元素支持拆包时才需要定义，语法：packetId＝”return${tsn name}”，表示当前的packet Id实际来源于哪一包数据；一般使用tsn(发送的序列号)，因为tsn相同的包表示拆抱前的同一包数据。

packetSequence，必须配合supportSplit使用，只有当元素支持拆包时才需要定义，语法：packetSequence＝“return${element name}”，表示当前包是第几个拆包后的子包。

packetNumber，必须配合supportSplit使用，只有当元素支持拆包时才需要定义，语法：packetSequence＝“return${element name}”，表示当前元素一共分拆到几个数据报文中。

如此的语法设计可以满足绝大部分的使用场景。

请参阅图1，本发明的基于XML(可扩展标记语言)的Wireshark用协议解析方法，包括下列步骤：

步骤S1，根据ICD(通信接口数据描述文档)中描述的数据报文协议的需求，将数据报文协议的内容用XML的树形结构描述出来，形成XML文档。

步骤S2，XML协议引擎自动解析XML文档，生成对应的协议解析树，并保存于内存中。具体地，XML协议引擎自动解析XML文档，如图4所示，包括下列步骤：

1)读取XML文档；

2)XML协议引擎从顶层元素开始依次解析XML文档的各元素：

判断当前元素是否为简单类型，若是，该元素解析完成；若否，继续判断：

若当前元素是xs:sequence类型，在当前元素中生成子元素数组，并依次解析数组中的各子元素；

若当前元素是xs:choice类型，在当前元素中根据xs:choice元素中selected Id生成map数据(以selected Id为索引的键值对)，并依次解析map中的各元素。

步骤S3，Wireshark在处理数据报文时，自动调用内存中的协议解析树，生成对应的解析结果。

具体地，以下举例说明：

以轨道交通领域的轨旁系统和中央控制系统的之间的数据报文举例，一个简化后的数据定义如下表2：

表3

这个数据定义包括了数据报文头，数据报文内容是所有轨道状态的集合以及一个CRC(差错校验码)的校验码作为报文的结尾。

然后，进行XML文本描述：假设编码类型为big endian，传输层使用UDP，则我们可以使用如下的XML来描述这个数据报文：

XML文件以树的形式描述数据报文中的每个field，其中最顶层的元素<xs:element name＝’mcu2ccu’TransportLayer＝”UDP”encoding＝”Big”>。

定义了报文的名字是mcu2ccu，报文的传输层协议为UDP，编码格式是BigEndian，报文的内容由三个子元素(element)组成，即“message header”，“Track StatusSummary”，“CRC”。XML引擎将从顶层元素依次解析xml定义，解析完顶层element后xml引擎的内部数据结构如图2所示。

此时树的第二层有三个元素，分别是MessageHeader,Track Status Summary,CRC,其中CRC是一个基本类型：xs:hex，其他两个元素均是复杂类型，那么算法将会继续解析，直到所有的叶子节点均为简单类型为止，需要注意的是，由于mcu2ccu节点包含的元素均在xs:sequnce标签中，因此mcu2ccu的子节点在数据报文中出现在顺序一定是从左往右依次出现，最终的解析结果如图3所示。图3中，interface type表示接口类型；interfaceversion表示接口版本；telegram type表示报文类型；receiver class表示接收者类型；receiver id表示接收者id；transmit class表示发送者类型；transmit id表示发送者id；rsn表示接收到的序列号；tsn表示发送的序列号；data length表示数据长度；Number oftrack表示轨道数量；Track status fame包含三个子节点定义；Track id表示轨道id；Tsrstatus表示TSR(轨道限速)的状态；Unsed bits表示字节补全。

至此引擎就获得了静态的数据报文格式定义，即：协议解析树。

在完成了数据报文的XML文件的静态分析之后，我们得到了一个静态的数据报文树形结构，包含了每个节点(元素)的长度，类型，单位，以及各节点之间的顺序，下面介绍如何把Wireshark捕获到的网络数据报文解析出来，包括下列步骤：

1)使用DFS(深度优先搜索)遍历算法，从根节点开始遍历各元素。

2)如果当前元素是简单类型，直接从当前的数据流中取出对应的长度，算出这个元素的值，并保存起来。

3)如果当前元素是复杂类型，执行：

若当前元素是xs:sequence类型，继续依次遍历当前的元素数组。

若当前元素是xs:choice类型，先根据selector的定义取出对应的接下来要选择元素的ID，然后再从xs:choice元素集合中找出符合的元素开始解析。

当所有的元素都已经遍历结束，并且数据报文也正好结束时，那么则遍历成功，否则遍历失败。

以上实施例仅供说明本发明之用，而非对本发明的限制，有关技术领域的技术人员，在不脱离本发明的精神和范围的情况下，还可以作出各种变换或变型，因此所有等同的技术方案也应该属于本发明的范畴，应由各权利要求所限定。

Claims (4)

1.一种基于XML的Wireshark用协议解析方法，其特征在于，包括：

根据ICD中描述的数据报文协议的需求，采用XML的树形结构描述数据报文协议的内容，并形成XML文档；

XML协议引擎自动解析所述XML文档，生成对应的协议解析树，并保存于内存中；

Wireshark在处理数据报文时，自动调用内存中的所述协议解析树，生成对应的解析结果。

2.根据权利要求1所述的基于XML的Wireshark用协议解析方法，其特征在于，所述的XML协议引擎自动解析XML文档，包括：

读取XML文档；

XML协议引擎从顶层元素开始依次解析XML文档的各元素：

判断当前元素是否为简单类型，若是，该元素解析完成；若否，继续判断：

若当前元素是xs:sequence类型，在当前元素中生成子元素数组，并依次解析数组中的各子元素；xs:sequence代表定义在其中的元素集合在数据报文中依次出现；

若当前元素是xs:choice类型，在当前元素中根据xs:choice元素中selected Id生成以selected Id为索引的键值对，并依次解析键值对中的各元素；xs:choice代表定义在其中的元素集合中只有一个元素出现在数据报文中；selected Id表示出现在xs:choice元素集合之中的当前元素的ID。

3.根据权利要求1或2所述的基于XML的Wireshark用协议解析方法，其特征在于，所述的Wireshark处理数据报文，包括：

使用DFS遍历算法，从根节点开始遍历各元素；

如果当前元素是简单类型，直接从当前的数据流中取出对应的长度，算出这个元素的值，并保存起来；

如果当前元素是复杂类型，执行：

若当前元素是xs:sequence类型，继续依次遍历当前的元素数组；

xs:sequence代表定义在其中的元素集合在数据报文中依次出现；

若当前元素是xs:choice类型，先根据selector的定义取出对应的接下来要选择元素的ID，然后再从xs:choice元素集合中找出符合的元素开始解析；xs:choice代表定义在其中的元素集合中只有一个元素出现在数据报文中；selector表示接下来要选择元素的id；

当所有的元素都已经遍历结束，并且数据报文也结束时，那么则遍历成功，否则遍历失败。

4.根据权利要求1所述的基于XML的Wireshark用协议解析方法，其特征在于，预先定义XML协议引擎：

XML标签设计：

xs:element，用于表示数据报文中的元素；

xs:complexType，用于定义多个xs:element，自定义的复杂类型；

xs:simpleType,用于定义枚举类型，自定义的简单类型；

xs:sequence，代表定义在其中的元素集合在数据报文中依次出现；

xs:choice，代表定义在其中的元素集合中只有一个元素出现在数据报文中；

xs:restriction，用于定义枚举值的集合；

xs:enumeration，单个的枚举值定义；

XML属性设计：

Name，用于指定标签的名字；

type，用于指定元素的类型；

unit，用于指定元素的单位；

length，用于指定元素的长度，手动设定或根据数据报文动态获取，需要动态获取时语法：length＝”return${element name}”,表示当前元素长度由其他元素的值决定；

occurs，表示当前元素连续重复出现的次数，可手动设定或根据数据报文动态获取，需要动态获取时语法：occurs＝”return${element name}”,表示当前元素的连续出现的次数长度由其他元素的值决定；

value，出现在枚举值的定义中，表示枚举的整形数值；

text，出现在枚举值的定义中，表示枚举值的文本值；

selected Id，出现在xs:choice元素集合之中，表示当前元素的ID；

selector，只有在当前元素的类型为xs:choice时才有效，表示接下来要选择元素的id，语法如下：selector＝”return${element name}”，选择器的值由其他元素指定；

supportSplit，表示当前元素是否支持拆包，如果支持拆包那么此元素的值将分拆后出现在多个数据报文中；

packet Id，配合supportSplit使用，仅在当元素支持拆包时被定义，语法：packetId＝”return${tsn name}”，表示当前的packet Id实际来源于哪一包数据；

packetSequence，配合supportSplit使用，仅在当元素支持拆包时被定义，语法：packetSequence＝“return${element name}”，表示当前包是第几个拆包后的子包；

packetNumber，配合supportSplit使用，仅在当元素支持拆包时被定义，语法：packetSequence＝“return${element name}”，表示当前元素一共分拆到几个数据报文中。