1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
|
"""pcap Next Generation file format"""
# Spec: https://pcapng.github.io/pcapng/
# pylint: disable=no-member
# pylint: disable=attribute-defined-outside-init
from __future__ import print_function
from __future__ import absolute_import
from struct import pack as struct_pack, unpack as struct_unpack
from time import time
import sys
from . import dpkt
from .compat import BytesIO
BYTE_ORDER_MAGIC = 0x1A2B3C4D
BYTE_ORDER_MAGIC_LE = 0x4D3C2B1A
PCAPNG_VERSION_MAJOR = 1
PCAPNG_VERSION_MINOR = 0
# Block types
PCAPNG_BT_IDB = 0x00000001 # Interface Description Block
PCAPNG_BT_PB = 0x00000002 # Packet Block (deprecated)
PCAPNG_BT_SPB = 0x00000003 # Simple Packet Block
PCAPNG_BT_EPB = 0x00000006 # Enhanced Packet Block
PCAPNG_BT_SHB = 0x0A0D0D0A # Section Header Block
# Options
PCAPNG_OPT_ENDOFOPT = 0 # end of options
PCAPNG_OPT_COMMENT = 1 # comment
# SHB options
PCAPNG_OPT_SHB_HARDWARE = 2 # description of the hardware
PCAPNG_OPT_SHB_OS = 3 # name of the operating system
PCAPNG_OPT_SHB_USERAPPL = 4 # name of the application
# IDB options
PCAPNG_OPT_IF_NAME = 2 # interface name
PCAPNG_OPT_IF_DESCRIPTION = 3 # interface description
PCAPNG_OPT_IF_IPV4ADDR = 4 # IPv4 network address and netmask for the interface
PCAPNG_OPT_IF_IPV6ADDR = 5 # IPv6 network address and prefix length for the interface
PCAPNG_OPT_IF_MACADDR = 6 # interface hardware MAC address
PCAPNG_OPT_IF_EUIADDR = 7 # interface hardware EUI address
PCAPNG_OPT_IF_SPEED = 8 # interface speed in bits/s
PCAPNG_OPT_IF_TSRESOL = 9 # timestamp resolution
PCAPNG_OPT_IF_TZONE = 10 # time zone
PCAPNG_OPT_IF_FILTER = 11 # capture filter
PCAPNG_OPT_IF_OS = 12 # operating system
PCAPNG_OPT_IF_FCSLEN = 13 # length of the Frame Check Sequence in bits
PCAPNG_OPT_IF_TSOFFSET = 14 # offset (in seconds) that must be added to packet timestamp
# <copied from pcap.py>
DLT_NULL = 0
DLT_EN10MB = 1
DLT_EN3MB = 2
DLT_AX25 = 3
DLT_PRONET = 4
DLT_CHAOS = 5
DLT_IEEE802 = 6
DLT_ARCNET = 7
DLT_SLIP = 8
DLT_PPP = 9
DLT_FDDI = 10
DLT_PFSYNC = 18
DLT_IEEE802_11 = 105
DLT_LINUX_SLL = 113
DLT_PFLOG = 117
DLT_IEEE802_11_RADIO = 127
if sys.platform.find('openbsd') != -1:
DLT_LOOP = 12
DLT_RAW = 14
else:
DLT_LOOP = 108
DLT_RAW = 12
dltoff = {DLT_NULL: 4, DLT_EN10MB: 14, DLT_IEEE802: 22, DLT_ARCNET: 6,
DLT_SLIP: 16, DLT_PPP: 4, DLT_FDDI: 21, DLT_PFLOG: 48, DLT_PFSYNC: 4,
DLT_LOOP: 4, DLT_LINUX_SLL: 16}
# </copied from pcap.py>
def _swap32b(i):
"""Swap endianness of an uint32"""
return struct_unpack('<I', struct_pack('>I', i))[0]
def _align32b(i):
"""Return int `i` aligned to the 32-bit boundary"""
r = i % 4
return i if not r else i + 4 - r
def _padded(s):
"""Return bytes `s` padded with zeroes to align to the 32-bit boundary"""
return struct_pack('%ss' % _align32b(len(s)), s)
def _padlen(s):
"""Return size of padding required to align str `s` to the 32-bit boundary"""
return _align32b(len(s)) - len(s)
class _PcapngBlock(dpkt.Packet):
"""Base class for a pcapng block with Options"""
__hdr__ = (
('type', 'I', 0), # block type
('len', 'I', 12), # block total length: total size of this block, in octets
#( body, variable size )
('_len', 'I', 12), # dup of len
)
def unpack_hdr(self, buf):
dpkt.Packet.unpack(self, buf)
def unpack(self, buf):
dpkt.Packet.unpack(self, buf)
if self.len > len(buf):
raise dpkt.NeedData
self._do_unpack_options(buf)
def _do_unpack_options(self, buf, oo=None):
self.opts = []
self.data = ''
oo = oo or self.__hdr_len__ - 4 # options offset
ol = self.len - oo - 4 # length
opts_buf = buf[oo:oo + ol]
while opts_buf:
opt = (PcapngOptionLE(opts_buf) if self.__hdr_fmt__[0] == '<'
else PcapngOption(opts_buf))
self.opts.append(opt)
opts_buf = opts_buf[len(opt):]
if opt.code == PCAPNG_OPT_ENDOFOPT:
break
# duplicate total length field
self._len = struct_unpack(self.__hdr_fmt__[0] + 'I', buf[-4:])[0]
if self._len != self.len:
raise dpkt.UnpackError('length fields do not match')
def _do_pack_options(self):
if not getattr(self, 'opts', None):
return b''
if self.opts[-1].code != PCAPNG_OPT_ENDOFOPT:
raise dpkt.PackError('options must end with opt_endofopt')
return b''.join(bytes(o) for o in self.opts)
def __bytes__(self):
opts_buf = self._do_pack_options()
self.len = self._len = self.__hdr_len__ + len(opts_buf)
hdr_buf = dpkt.Packet.pack_hdr(self)
return hdr_buf[:-4] + opts_buf + hdr_buf[-4:]
def __len__(self):
if not getattr(self, 'opts', None):
return self.__hdr_len__
opts_len = sum(len(o) for o in self.opts)
return self.__hdr_len__ + opts_len
class PcapngBlockLE(_PcapngBlock):
__byte_order__ = '<'
class PcapngOption(dpkt.Packet):
"""A single Option"""
__hdr__ = (
('code', 'H', PCAPNG_OPT_ENDOFOPT),
('len', 'H', 0),
)
def unpack(self, buf):
dpkt.Packet.unpack(self, buf)
self.data = buf[self.__hdr_len__:self.__hdr_len__ + self.len]
# decode comment
if self.code == PCAPNG_OPT_COMMENT:
self.text = self.data.decode('utf-8')
def __bytes__(self):
#return dpkt.Packet.__bytes__(self)
# encode comment
if self.code == PCAPNG_OPT_COMMENT:
text = getattr(self, 'text', self.data)
self.data = text.encode('utf-8') if not isinstance(text, bytes) else text
self.len = len(self.data)
return dpkt.Packet.pack_hdr(self) + _padded(self.data)
def __len__(self):
return self.__hdr_len__ + len(self.data) + _padlen(self.data)
def __repr__(self):
if self.code == PCAPNG_OPT_ENDOFOPT:
return '{0}(opt_endofopt)'.format(self.__class__.__name__)
else:
return dpkt.Packet.__repr__(self)
class PcapngOptionLE(PcapngOption):
__byte_order__ = '<'
class SectionHeaderBlock(_PcapngBlock):
"""Section Header block"""
__hdr__ = (
('type', 'I', PCAPNG_BT_SHB),
('len', 'I', 28),
('bom', 'I', BYTE_ORDER_MAGIC),
('v_major', 'H', PCAPNG_VERSION_MAJOR),
('v_minor', 'H', PCAPNG_VERSION_MINOR),
('sec_len', 'q', -1), # section length, -1 = auto
#( options, variable size )
('_len', 'I', 28)
)
class SectionHeaderBlockLE(SectionHeaderBlock):
__byte_order__ = '<'
class InterfaceDescriptionBlock(_PcapngBlock):
"""Interface Description block"""
__hdr__ = (
('type', 'I', PCAPNG_BT_IDB),
('len', 'I', 20),
('linktype', 'H', DLT_EN10MB),
('_reserved', 'H', 0),
('snaplen', 'I', 1500),
#( options, variable size )
('_len', 'I', 20)
)
class InterfaceDescriptionBlockLE(InterfaceDescriptionBlock):
__byte_order__ = '<'
class EnhancedPacketBlock(_PcapngBlock):
"""Enhanced Packet block"""
__hdr__ = (
('type', 'I', PCAPNG_BT_EPB),
('len', 'I', 64),
('iface_id', 'I', 0),
('ts_high', 'I', 0), # timestamp high
('ts_low', 'I', 0), # timestamp low
('caplen', 'I', 0), # captured len, size of pkt_data
('pkt_len', 'I', 0), # actual packet len
#( pkt_data, variable size )
#( options, variable size )
('_len', 'I', 64)
)
def unpack(self, buf):
dpkt.Packet.unpack(self, buf)
if self.len > len(buf):
raise dpkt.NeedData
# packet data
po = self.__hdr_len__ - 4 # offset of pkt_data
self.pkt_data = buf[po:po + self.caplen]
# skip padding between pkt_data and options
opts_offset = po + _align32b(self.caplen)
self._do_unpack_options(buf, opts_offset)
def __bytes__(self):
pkt_buf = self.pkt_data
self.caplen = self.pkt_len = len(pkt_buf)
opts_buf = self._do_pack_options()
self.len = self._len = self.__hdr_len__ + _align32b(self.caplen) + len(opts_buf)
hdr_buf = dpkt.Packet.pack_hdr(self)
return hdr_buf[:-4] + _padded(pkt_buf) + opts_buf + hdr_buf[-4:]
def __len__(self):
opts_len = sum(len(o) for o in self.opts)
return self.__hdr_len__ + _align32b(self.caplen) + opts_len
class EnhancedPacketBlockLE(EnhancedPacketBlock):
__byte_order__ = '<'
class Writer(object):
"""Simple pcapng dumpfile writer."""
def __init__(self, fileobj, snaplen=1500, linktype=DLT_EN10MB, shb=None, idb=None):
"""
Create a pcapng dumpfile writer for the given fileobj.
shb can be an instance of SectionHeaderBlock(LE)
idb can be an instance of InterfaceDescriptionBlock(LE)
"""
self.__f = fileobj
self.__le = sys.byteorder == 'little'
if shb:
self._validate_block('shb', shb, SectionHeaderBlock)
if idb:
self._validate_block('idb', idb, InterfaceDescriptionBlock)
if self.__le:
shb = shb or SectionHeaderBlockLE()
idb = idb or InterfaceDescriptionBlockLE(snaplen=snaplen, linktype=linktype)
else:
shb = shb or SectionHeaderBlock()
idb = idb or InterfaceDescriptionBlock(snaplen=snaplen, linktype=linktype)
self.__f.write(bytes(shb))
self.__f.write(bytes(idb))
def _validate_block(self, arg_name, blk, expected_cls):
"""Check a user-defined block for correct type and endianness"""
if not isinstance(blk, expected_cls):
raise ValueError('{0}: expecting class {1}'.format(
arg_name, expected_cls.__name__))
if self.__le and blk.__hdr_fmt__[0] == '>':
raise ValueError('{0}: expecting class {1}LE on a little-endian system'.format(
arg_name, expected_cls.__name__))
if not self.__le and blk.__hdr_fmt__[0] == '<':
raise ValueError('{0}: expecting class {1} on a big-endian system'.format(
arg_name, expected_cls.__name__.replace('LE', '')))
def writepkt(self, pkt, ts=None):
"""
Write a single packet with its timestamp.
pkt can be a buffer or an instance of EnhancedPacketBlock(LE)
ts is a Unix timestamp in seconds since Epoch (e.g. 1454725786.99)
"""
if isinstance(pkt, EnhancedPacketBlock):
self._validate_block('pkt', pkt, EnhancedPacketBlock)
if ts is not None: # ts as an argument gets precedence
ts = int(round(ts * 1e6))
elif pkt.ts_high == pkt.ts_low == 0:
ts = int(round(time() * 1e6))
if ts is not None:
pkt.ts_high = ts >> 32
pkt.ts_low = ts & 0xffffffff
self.__f.write(bytes(pkt))
return
# pkt is a buffer - wrap it into an EPB
if ts is None:
ts = time()
ts = int(round(ts * 1e6)) # to int microseconds
s = bytes(pkt)
n = len(s)
kls = EnhancedPacketBlockLE if self.__le else EnhancedPacketBlock
epb = kls(ts_high=ts >> 32, ts_low=ts & 0xffffffff, caplen=n, pkt_len=n, pkt_data=s)
self.__f.write(bytes(epb))
def close(self):
self.__f.close()
class Reader(object):
"""Simple pypcap-compatible pcapng file reader."""
def __init__(self, fileobj):
self.name = getattr(fileobj, 'name', '<{0}>'.format(fileobj.__class__.__name__))
self.__f = fileobj
shb = SectionHeaderBlock()
buf = self.__f.read(shb.__hdr_len__)
if len(buf) < shb.__hdr_len__:
raise ValueError('invalid pcapng header')
# unpack just the header since endianness is not known
shb.unpack_hdr(buf)
if shb.type != PCAPNG_BT_SHB:
raise ValueError('invalid pcapng header: not a SHB')
# determine the correct byte order and reload full SHB
if shb.bom == BYTE_ORDER_MAGIC_LE:
self.__le = True
buf += self.__f.read(_swap32b(shb.len) - shb.__hdr_len__)
shb = SectionHeaderBlockLE(buf)
elif shb.bom == BYTE_ORDER_MAGIC:
self.__le = False
buf += self.__f.read(shb.len - shb.__hdr_len__)
shb = SectionHeaderBlock(buf)
else:
raise ValueError('unknown endianness')
# check if this version is supported
if shb.v_major != PCAPNG_VERSION_MAJOR:
raise ValueError('unknown pcapng version {0}.{1}'.format(shb.v_major, shb.v_minor,))
# look for a mandatory IDB
idb = None
while 1:
buf = self.__f.read(8)
if len(buf) < 8:
break
blk_type, blk_len = struct_unpack('<II' if self.__le else '>II', buf)
buf += self.__f.read(blk_len - 8)
if blk_type == PCAPNG_BT_IDB:
idb = (InterfaceDescriptionBlockLE(buf) if self.__le
else InterfaceDescriptionBlock(buf))
break
# just skip other blocks
if idb is None:
raise ValueError('IDB not found')
# set timestamp resolution and offset
self._divisor = float(1e6) # defaults
self._tsoffset = 0
for opt in idb.opts:
if opt.code == PCAPNG_OPT_IF_TSRESOL:
# if MSB=0, the remaining bits is a neg power of 10 (e.g. 6 means microsecs)
# if MSB=1, the remaining bits is a neg power of 2 (e.g. 10 means 1/1024 of second)
opt_val = struct_unpack('b', opt.data)[0]
pow_num = 2 if opt_val & 0b10000000 else 10
self._divisor = float(pow_num ** (opt_val & 0b01111111))
elif opt.code == PCAPNG_OPT_IF_TSOFFSET:
# 64-bit int that specifies an offset (in seconds) that must be added to the
# timestamp of each packet
self._tsoffset = struct_unpack('<q' if self.__le else '>q', opt.data)[0]
if idb.linktype in dltoff:
self.dloff = dltoff[idb.linktype]
else:
self.dloff = 0
self.idb = idb
self.snaplen = idb.snaplen
self.filter = ''
self.__iter = iter(self)
@property
def fd(self):
return self.__f.fileno()
def fileno(self):
return self.fd
def datalink(self):
return self.idb.linktype
def setfilter(self, value, optimize=1):
return NotImplementedError
def readpkts(self):
return list(self)
def next(self):
return next(self.__iter)
def dispatch(self, cnt, callback, *args):
"""Collect and process packets with a user callback.
Return the number of packets processed, or 0 for a savefile.
Arguments:
cnt -- number of packets to process;
or 0 to process all packets until EOF
callback -- function with (timestamp, pkt, *args) prototype
*args -- optional arguments passed to callback on execution
"""
processed = 0
if cnt > 0:
for _ in range(cnt):
try:
ts, pkt = next(iter(self))
except StopIteration:
break
callback(ts, pkt, *args)
processed += 1
else:
for ts, pkt in self:
callback(ts, pkt, *args)
processed += 1
return processed
def loop(self, callback, *args):
self.dispatch(0, callback, *args)
def __iter__(self):
while 1:
buf = self.__f.read(8)
if len(buf) < 8:
break
blk_type, blk_len = struct_unpack('<II' if self.__le else '>II', buf)
buf += self.__f.read(blk_len - 8)
if blk_type == PCAPNG_BT_EPB:
epb = EnhancedPacketBlockLE(buf) if self.__le else EnhancedPacketBlock(buf)
ts = self._tsoffset + (((epb.ts_high << 32) | epb.ts_low) / self._divisor)
yield (ts, epb.pkt_data)
# just ignore other blocks
#########
# TESTS #
#########
def test_shb():
"""Test SHB with options"""
buf = (
b'\x0a\x0d\x0d\x0a\x58\x00\x00\x00\x4d\x3c\x2b\x1a\x01\x00\x00\x00\xff\xff\xff\xff\xff\xff'
b'\xff\xff\x04\x00\x31\x00\x54\x53\x68\x61\x72\x6b\x20\x31\x2e\x31\x30\x2e\x30\x72\x63\x32'
b'\x20\x28\x53\x56\x4e\x20\x52\x65\x76\x20\x34\x39\x35\x32\x36\x20\x66\x72\x6f\x6d\x20\x2f'
b'\x74\x72\x75\x6e\x6b\x2d\x31\x2e\x31\x30\x29\x00\x00\x00\x00\x00\x00\x00\x58\x00\x00\x00')
opt_buf = b'\x04\x00\x31\x00TShark 1.10.0rc2 (SVN Rev 49526 from /trunk-1.10)\x00\x00\x00'
# block unpacking
shb = SectionHeaderBlockLE(buf)
assert shb.type == PCAPNG_BT_SHB
assert shb.bom == BYTE_ORDER_MAGIC
assert shb.v_major == 1
assert shb.v_minor == 0
assert shb.sec_len == -1
assert shb.data == ''
# options unpacking
assert len(shb.opts) == 2
assert shb.opts[0].code == PCAPNG_OPT_SHB_USERAPPL
assert shb.opts[0].data == b'TShark 1.10.0rc2 (SVN Rev 49526 from /trunk-1.10)'
assert shb.opts[0].len == len(shb.opts[0].data)
assert shb.opts[1].code == PCAPNG_OPT_ENDOFOPT
assert shb.opts[1].len == 0
# option packing
assert str(shb.opts[0]) == str(opt_buf)
assert len(shb.opts[0]) == len(opt_buf)
assert bytes(shb.opts[1]) == b'\x00\x00\x00\x00'
# block packing
assert str(shb) == str(buf)
assert len(shb) == len(buf)
def test_idb():
"""Test IDB with options"""
buf = (
b'\x01\x00\x00\x00\x20\x00\x00\x00\x01\x00\x00\x00\xff\xff\x00\x00\x09\x00\x01\x00\x06\x00'
b'\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00')
# block unpacking
idb = InterfaceDescriptionBlockLE(buf)
assert idb.type == PCAPNG_BT_IDB
assert idb.linktype == DLT_EN10MB
assert idb.snaplen == 0xffff
assert idb.data == ''
# options unpacking
assert len(idb.opts) == 2
assert idb.opts[0].code == PCAPNG_OPT_IF_TSRESOL
assert idb.opts[0].len == 1
assert idb.opts[0].data == b'\x06'
assert idb.opts[1].code == PCAPNG_OPT_ENDOFOPT
assert idb.opts[1].len == 0
# option packing
assert bytes(idb.opts[0]) == b'\x09\x00\x01\x00\x06\x00\x00\x00'
assert len(idb.opts[0]) == 8
assert bytes(idb.opts[1]) == b'\x00\x00\x00\x00'
# block packing
assert str(idb) == str(buf)
assert len(idb) == len(buf)
def test_epb():
"""Test EPB with a non-ascii comment option"""
buf = (
b'\x06\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x73\xe6\x04\x00\xbe\x37\xe2\x19\x4a\x00'
b'\x00\x00\x4a\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x45\x00'
b'\x00\x3c\x5d\xb3\x40\x00\x40\x06\xdf\x06\x7f\x00\x00\x01\x7f\x00\x00\x01\x98\x34\x11\x4e'
b'\x95\xcb\x2d\x3a\x00\x00\x00\x00\xa0\x02\xaa\xaa\xfe\x30\x00\x00\x02\x04\xff\xd7\x04\x02'
b'\x08\x0a\x05\x8f\x70\x89\x00\x00\x00\x00\x01\x03\x03\x07\x00\x00\x01\x00\x0a\x00\xd0\xbf'
b'\xd0\xb0\xd0\xba\xd0\xb5\xd1\x82\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00')
# block unpacking
epb = EnhancedPacketBlockLE(buf)
assert epb.type == PCAPNG_BT_EPB
assert epb.caplen == len(epb.pkt_data)
assert epb.pkt_len == len(epb.pkt_data)
assert epb.caplen == 74
assert epb.ts_high == 321139
assert epb.ts_low == 434255806
assert epb.data == ''
# options unpacking
assert len(epb.opts) == 2
assert epb.opts[0].code == PCAPNG_OPT_COMMENT
assert epb.opts[0].text == u'\u043f\u0430\u043a\u0435\u0442'
assert epb.opts[1].code == PCAPNG_OPT_ENDOFOPT
assert epb.opts[1].len == 0
# option packing
assert bytes(epb.opts[0]) == b'\x01\x00\x0a\x00\xd0\xbf\xd0\xb0\xd0\xba\xd0\xb5\xd1\x82\x00\x00'
assert len(epb.opts[0]) == 16
assert bytes(epb.opts[1]) == b'\x00\x00\x00\x00'
# block packing
assert str(epb) == str(buf)
assert len(epb) == len(buf)
def test_simple_write_read():
"""Test writing a basic pcapng and then reading it"""
fobj = BytesIO()
writer = Writer(fobj, snaplen=0x2000, linktype=DLT_LINUX_SLL)
writer.writepkt(b'foo', ts=1454725786.526401)
fobj.flush()
fobj.seek(0)
reader = Reader(fobj)
assert reader.snaplen == 0x2000
assert reader.datalink() == DLT_LINUX_SLL
ts, buf1 = next(iter(reader))
assert ts == 1454725786.526401
assert buf1 == b'foo'
# test dispatch()
fobj.seek(0)
reader = Reader(fobj)
assert reader.dispatch(1, lambda ts, pkt: None) == 1
assert reader.dispatch(1, lambda ts, pkt: None) == 0
fobj.close()
def test_custom_read_write():
"""Test a full pcapng file with 1 ICMP packet"""
buf = (
b'\x0a\x0d\x0d\x0a\x7c\x00\x00\x00\x4d\x3c\x2b\x1a\x01\x00\x00\x00\xff\xff\xff\xff\xff\xff'
b'\xff\xff\x03\x00\x1e\x00\x36\x34\x2d\x62\x69\x74\x20\x57\x69\x6e\x64\x6f\x77\x73\x20\x38'
b'\x2e\x31\x2c\x20\x62\x75\x69\x6c\x64\x20\x39\x36\x30\x30\x00\x00\x04\x00\x34\x00\x44\x75'
b'\x6d\x70\x63\x61\x70\x20\x31\x2e\x31\x32\x2e\x37\x20\x28\x76\x31\x2e\x31\x32\x2e\x37\x2d'
b'\x30\x2d\x67\x37\x66\x63\x38\x39\x37\x38\x20\x66\x72\x6f\x6d\x20\x6d\x61\x73\x74\x65\x72'
b'\x2d\x31\x2e\x31\x32\x29\x00\x00\x00\x00\x7c\x00\x00\x00\x01\x00\x00\x00\x7c\x00\x00\x00'
b'\x01\x00\x00\x00\x00\x00\x04\x00\x02\x00\x32\x00\x5c\x44\x65\x76\x69\x63\x65\x5c\x4e\x50'
b'\x46\x5f\x7b\x33\x42\x42\x46\x32\x31\x41\x37\x2d\x39\x31\x41\x45\x2d\x34\x44\x44\x42\x2d'
b'\x41\x42\x32\x43\x2d\x43\x37\x38\x32\x39\x39\x39\x43\x32\x32\x44\x35\x7d\x00\x00\x09\x00'
b'\x01\x00\x06\x00\x00\x00\x0c\x00\x1e\x00\x36\x34\x2d\x62\x69\x74\x20\x57\x69\x6e\x64\x6f'
b'\x77\x73\x20\x38\x2e\x31\x2c\x20\x62\x75\x69\x6c\x64\x20\x39\x36\x30\x30\x00\x00\x00\x00'
b'\x00\x00\x7c\x00\x00\x00\x06\x00\x00\x00\x84\x00\x00\x00\x00\x00\x00\x00\x63\x20\x05\x00'
b'\xd6\xc4\xab\x0b\x4a\x00\x00\x00\x4a\x00\x00\x00\x08\x00\x27\x96\xcb\x7c\x52\x54\x00\x12'
b'\x35\x02\x08\x00\x45\x00\x00\x3c\xa4\x40\x00\x00\x1f\x01\x27\xa2\xc0\xa8\x03\x28\x0a\x00'
b'\x02\x0f\x00\x00\x56\xf0\x00\x01\x00\x6d\x41\x42\x43\x44\x45\x46\x47\x48\x49\x4a\x4b\x4c'
b'\x4d\x4e\x4f\x50\x51\x52\x53\x54\x55\x56\x57\x41\x42\x43\x44\x45\x46\x47\x48\x49\x00\x00'
b'\x01\x00\x0f\x00\x64\x70\x6b\x74\x20\x69\x73\x20\x61\x77\x65\x73\x6f\x6d\x65\x00\x00\x00'
b'\x00\x00\x84\x00\x00\x00')
fobj = BytesIO(buf)
# test reading
reader = Reader(fobj)
assert reader.snaplen == 0x40000
assert reader.datalink() == DLT_EN10MB
assert reader.idb.opts[0].data.decode('utf-8') == '\\Device\\NPF_{3BBF21A7-91AE-4DDB-AB2C-C782999C22D5}'
assert reader.idb.opts[2].data.decode('utf-8') == '64-bit Windows 8.1, build 9600'
ts, buf1 = next(iter(reader))
assert ts == 1442984653.2108380
assert len(buf1) == 74
assert buf1.startswith(b'\x08\x00\x27\x96')
assert buf1.endswith(b'FGHI')
fobj.close()
# test pcapng customized writing
shb = SectionHeaderBlockLE(opts=[
PcapngOptionLE(code=3, data=b'64-bit Windows 8.1, build 9600'),
PcapngOptionLE(code=4, data=b'Dumpcap 1.12.7 (v1.12.7-0-g7fc8978 from master-1.12)'),
PcapngOptionLE()
])
idb = InterfaceDescriptionBlockLE(snaplen=0x40000, opts=[
PcapngOptionLE(code=2, data=b'\\Device\\NPF_{3BBF21A7-91AE-4DDB-AB2C-C782999C22D5}'),
PcapngOptionLE(code=9, data=b'\x06'),
PcapngOptionLE(code=12, data=b'64-bit Windows 8.1, build 9600'),
PcapngOptionLE()
])
epb = EnhancedPacketBlockLE(opts=[
PcapngOptionLE(code=1, text=b'dpkt is awesome'),
PcapngOptionLE()
], pkt_data=(
b'\x08\x00\x27\x96\xcb\x7c\x52\x54\x00\x12\x35\x02\x08\x00\x45\x00\x00\x3c\xa4\x40\x00\x00'
b'\x1f\x01\x27\xa2\xc0\xa8\x03\x28\x0a\x00\x02\x0f\x00\x00\x56\xf0\x00\x01\x00\x6d\x41\x42'
b'\x43\x44\x45\x46\x47\x48\x49\x4a\x4b\x4c\x4d\x4e\x4f\x50\x51\x52\x53\x54\x55\x56\x57\x41'
b'\x42\x43\x44\x45\x46\x47\x48\x49'
))
fobj = BytesIO()
writer = Writer(fobj, shb=shb, idb=idb)
writer.writepkt(epb, ts=1442984653.210838)
assert fobj.getvalue() == buf
fobj.close()
# same with timestamps defined inside EPB
epb.ts_high = 335971
epb.ts_low = 195806422
fobj = BytesIO()
writer = Writer(fobj, shb=shb, idb=idb)
writer.writepkt(epb)
assert fobj.getvalue() == buf
fobj.close()
if __name__ == '__main__':
# TODO: big endian unit tests; could not find any examples..
test_shb()
test_idb()
test_epb()
test_simple_write_read()
test_custom_read_write()
repr(PcapngOptionLE())
print('Tests Successful...')
|