utilities/ovs-pcap.in

   1 #! @PYTHON3@
   2 #
   3 # Copyright (c) 2010 Nicira, Inc.
   4 #
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at:
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 from __future__ import print_function
  18
  19 import binascii
  20 import getopt
  21 import struct
  22 import sys
  23
  24
  25 class PcapException(Exception):
  26     pass
  27
  28
  29 class PcapReader(object):
  30     def __init__(self, file_name):
  31         self.file = open(file_name, "rb")
  32         header = self.file.read(24)
  33         if len(header) != 24:
  34             raise PcapException("end of file reading pcap header")
  35         magic, version, thiszone, sigfigs, snaplen, network = \
  36             struct.unpack(">6I", header)
  37         if magic == 0xa1b2c3d4 or magic == 0xa1b23c4d:
  38             self.header_format = ">4I"
  39         elif magic == 0xd4c3b2a1 or magic == 0x4d3cb2a1:
  40             self.header_format = "<4I"
  41         else:
  42             raise PcapException("bad magic %u reading pcap file "
  43                         "(expected 0xa1b2c3d4, 0xa1b23c4d, 0x4d3cb2a1 or "
  44                         "0xd4c3b2a1)" % magic)
  45
  46     def read(self):
  47         header = self.file.read(16)
  48         if len(header) == 0:
  49             return None
  50         elif len(header) != 16:
  51             raise PcapException("end of file within pcap record header")
  52
  53         ts_sec, ts_usec, incl_len, orig_len = struct.unpack(self.header_format,
  54                                                             header)
  55         packet = self.file.read(incl_len)
  56         if len(packet) != incl_len:
  57             raise PcapException("end of file reading pcap packet data")
  58         return packet
  59
  60
  61 argv0 = sys.argv[0]
  62
  63
  64 def usage():
  65     print("""\
  66 %(argv0)s: print pcap file packet data as hex
  67 usage: %(argv0)s FILE
  68 where FILE is a PCAP file.
  69
  70 The following options are also available:
  71   -h, --help                  display this help message
  72   -V, --version               display version information\
  73 """ % {'argv0': argv0})
  74     sys.exit(0)
  75
  76
  77 if __name__ == "__main__":
  78     try:
  79         try:
  80             options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
  81                                               ['help', 'version'])
  82         except getopt.GetoptException as geo:
  83             sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
  84             sys.exit(1)
  85
  86         for key, value in options:
  87             if key in ['-h', '--help']:
  88                 usage()
  89             elif key in ['-V', '--version']:
  90                 print("ovs-pcap (Open vSwitch) @VERSION@")
  91             else:
  92                 sys.exit(0)
  93
  94         if len(args) != 1:
  95             sys.stderr.write("%s: exactly 1 non-option argument required "
  96                              "(use --help for help)\n" % argv0)
  97             sys.exit(1)
  98
  99         reader = PcapReader(args[0])
 100         while True:
 101             packet = reader.read()
 102             if packet is None:
 103                 break
 104
 105             print(binascii.hexlify(packet).decode().strip())
 106
 107     except PcapException as e:
 108         sys.stderr.write("%s: %s\n" % (argv0, e))
 109         sys.exit(1)
 110
 111 # Local variables:
 112 # mode: python
 113 # End: