1#!/usr/bin/env python3 2# 3# Copyright (c) 2019, The OpenThread Authors. 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions are met: 8# 1. Redistributions of source code must retain the above copyright 9# notice, this list of conditions and the following disclaimer. 10# 2. Redistributions in binary form must reproduce the above copyright 11# notice, this list of conditions and the following disclaimer in the 12# documentation and/or other materials provided with the distribution. 13# 3. Neither the name of the copyright holder nor the 14# names of its contributors may be used to endorse or promote products 15# derived from this software without specific prior written permission. 16# 17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 18# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 21# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27# POSSIBILITY OF SUCH DAMAGE. 28# 29from pyshark.packet.packet import Packet as RawPacket 30 31from pktverify.layer_fields import get_layer_field, check_layer_field_exists 32 33 34class LayerFieldsContainer(object): 35 """ 36 Represents a layer field container. 37 """ 38 39 def __init__(self, packet: RawPacket, path: str): 40 assert isinstance(packet, RawPacket) 41 assert isinstance(path, str) 42 43 self._packet = packet 44 self._path = path 45 46 def __getattr__(self, name): 47 subpath = self._path + '.' + name 48 v = get_layer_field(self._packet, subpath) 49 setattr(self, name, v) 50 return v 51 52 def has(self, subpath): 53 """ 54 Returns if the layer field container has a sub layer field or container. 55 56 :param subpath: The sub path to the layer field or container. 57 """ 58 subpath = self._path + '.' + subpath 59 return check_layer_field_exists(self._packet, subpath) is not None 60 61 def __getitem__(self, item): 62 return getattr(self, item) 63 64 @property 65 def full_path(self): 66 """ 67 Returns the full path to this layer field container. 68 """ 69 return self._path 70 71 @property 72 def field_path(self): 73 """ 74 Returns the field that references to this layer field container. 75 """ 76 secs = self._path.split('.') 77 assert len(secs) >= 2 78 return '.'.join(secs[1:]) 79 80 def __bool__(self): 81 """ 82 Returns if this layer field container exists in the packet. 83 """ 84 return check_layer_field_exists(self._packet, self._path) 85