wireshark/tools/ftsanity.py

119 lines
3.1 KiB
Python
Executable File

#!/usr/bin/env python
"""
Check the sanity of field definitions in Wireshark.
"""
#
# Gilbert Ramirez <gram [AT] alumni.rice.edu>
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import sys
try:
from optparse import OptionParser
except ImportError:
sys.exit("Need python 2.3.")
try:
import commands
except ImportError:
sys.exit("Need to run on Unix.")
errors = 0
class Proto:
"""Data for a protocol."""
def __init__(self, line):
data = line.split("\t")
assert len(data) == 3
assert data[0] == "P"
self.name = data[1]
self.abbrev = data[2]
class Field:
"""Data for a field."""
def __init__(self, line):
data = line.split("\t")
assert len(data) == 8
assert data[0] == "F"
self.name = data[1]
self.abbrev = data[2]
self.ftype = data[3]
self.parent = data[4]
self.blurb = data[5]
self.base = data[6]
self.bitmask = int(data[7],0)
def gather_data(tshark):
"""Calls tshark and gathers data."""
cmd = "%s -G fields3" % (tshark,)
(status, output) = commands.getstatusoutput(cmd)
if status != 0:
sys.exit("Failed: " + cmd)
lines = output.split("\n")
protos = [Proto(x) for x in lines if x[0] == "P"]
fields = [Field(x) for x in lines if x[0] == "F"]
return protos, fields
def check_fields(fields):
"""Looks for problems in field definitions."""
global errors
for field in fields:
if field.bitmask != 0:
if field.ftype.find("FT_UINT") != 0 and \
field.ftype.find("FT_INT") != 0 and \
field.ftype != "FT_BOOLEAN":
print "%s has a bitmask 0x%x but is type %s" % \
(field.abbrev, field.bitmask, field.ftype)
errors += 1
def run(tshark):
"""Run the tests."""
global errors
protos, fields = gather_data(tshark)
check_fields(fields)
if errors > 0:
sys.exit("%d errors found" % (errors,))
else:
print "Success."
def main():
"""Parse the command-line."""
usage = "%prog tshark"
parser = OptionParser(usage=usage)
(options, args) = parser.parse_args()
if len(args) != 1:
parser.error("Need location of tshark.")
run(args[0])
if __name__ == "__main__":
main()