X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FPacketVerifier.py;h=bbfdfe86888476e50be73d818d29eec1bbed79c1;hp=45fab6a7c6bc6298d54a360feb410e57dc597919;hb=a912d105f3a1d8fed0b4cf6b18e0ef7789be81bf;hpb=bc4d98a34af3f26a1c9264758186189f15513a7e diff --git a/resources/libraries/python/PacketVerifier.py b/resources/libraries/python/PacketVerifier.py index 45fab6a7c6..bbfdfe8688 100644 --- a/resources/libraries/python/PacketVerifier.py +++ b/resources/libraries/python/PacketVerifier.py @@ -63,13 +63,12 @@ """ +import os import socket import select -import os -import time -from multiprocessing import Queue, Process + from scapy.all import ETH_P_IP, ETH_P_IPV6, ETH_P_ALL, ETH_P_ARP -from scapy.all import Ether, ARP, Packet +from scapy.all import Ether, ARP from scapy.layers.inet6 import IPv6 __all__ = ['RxQueue', 'TxQueue', 'Interface', 'create_gratuitous_arp_request', @@ -77,6 +76,7 @@ __all__ = ['RxQueue', 'TxQueue', 'Interface', 'create_gratuitous_arp_request', # TODO: http://stackoverflow.com/questions/320232/ensuring-subprocesses-are-dead-on-exiting-python-program + class PacketVerifier(object): """Base class for TX and RX queue objects for packet verifier.""" def __init__(self, interface_name): @@ -95,10 +95,10 @@ def extract_one_packet(buf): Takes string as input and looks for first whole packet in it. If it finds one, it returns substring from the buf parameter. - :param buf: string representation of incoming packet buffer. - :type buf: string + :param buf: String representation of incoming packet buffer. + :type buf: str :return: String representation of first packet in buf. - :rtype: string + :rtype: str """ pkt_len = 0 @@ -178,9 +178,9 @@ def packet_reader(interface_name, queue): This function is meant to be run in separate subprocess and is in tight loop reading raw packets from interface passed as parameter. - :param interace_name: Name of interface to read packets from. + :param interface_name: Name of interface to read packets from. :param queue: Queue in which this function will push incoming packets. - :type interface_name: string + :type interface_name: str :type queue: multiprocessing.Queue :return: None """ @@ -199,20 +199,12 @@ class RxQueue(PacketVerifier): function to access them. :param interface_name: Which interface to bind to. - :type interface_name: string + :type interface_name: str """ - def __init__(self, interface_name): PacketVerifier.__init__(self, interface_name) - #self._queue = Queue() - #self._proc = Process(target=packet_reader, args=(interface_name, - # self._queue)) - #self._proc.daemon = True - #self._proc.start() - #time.sleep(2) - - def recv(self, timeout=3, ignore=None): + def recv(self, timeout=3, ignore=None, verbose=True): """Read next received packet. Returns scapy's Ether() object created from next packet in the queue. @@ -220,13 +212,15 @@ class RxQueue(PacketVerifier): arrives in given timeout queue.Empty exception will be risen. :param timeout: How many seconds to wait for next packet. + :param ignore: List of packets that should be ignored. + :param verbose: Used to suppress detailed logging of received packets. :type timeout: int + :type ignore: list + :type verbose: bool :return: Ether() initialized object from packet data. :rtype: scapy.Ether """ - - #pkt = self._queue.get(True, timeout=timeout) (rlist, _, _) = select.select([self._sock], [], [], timeout) if self._sock not in rlist: return None @@ -234,8 +228,9 @@ class RxQueue(PacketVerifier): pkt = self._sock.recv(0x7fff) pkt_pad = auto_pad(pkt) print 'Received packet on {0} of len {1}'.format(self._ifname, len(pkt)) - Ether(pkt).show2() - print + if verbose: + Ether(pkt).show2() + print if ignore is not None: for i, ig_pkt in enumerate(ignore): @@ -246,7 +241,7 @@ class RxQueue(PacketVerifier): # Found the packet in ignore list, get another one # TODO: subtract timeout - time_spent in here ignore.remove(ig_pkt) - return self.recv(timeout, ignore) + return self.recv(timeout, ignore, verbose) return Ether(pkt) @@ -257,43 +252,61 @@ class TxQueue(PacketVerifier): This object is used to send packets over RAW socket on a interface. :param interface_name: Which interface to send packets from. - :type interface_name: string + :type interface_name: str """ def __init__(self, interface_name): PacketVerifier.__init__(self, interface_name) - def send(self, pkt): + def send(self, pkt, verbose=True): """Send packet out of the bound interface. :param pkt: Packet to send. + :param verbose: Used to supress detailed logging of sent packets. :type pkt: string or scapy Packet derivative. + :type verbose: bool """ print 'Sending packet out of {0} of len {1}'.format(self._ifname, len(pkt)) - Ether(str(pkt)).show2() - print + if verbose: + Ether(str(pkt)).show2() + print pkt = auto_pad(str(pkt)) self._sock.send(pkt) class Interface(object): + """Class for network interfaces. Contains methods for sending and receiving + packets.""" def __init__(self, if_name): + """Initialize the interface class. + + :param if_name: Name of the interface. + :type if_name: str + """ self.if_name = if_name self.sent_packets = [] self.rxq = RxQueue(if_name) self.txq = TxQueue(if_name) def send_pkt(self, pkt): + """Send the provided packet out the interface.""" self.sent_packets.append(pkt) self.txq.send(pkt) def recv_pkt(self, timeout=3): + """Read one packet from the interface's receive queue. + + :param timeout: Timeout value in seconds. + :type timeout: int + :return: Ether() initialized object from packet data. + :rtype: scapy.Ether + """ return self.rxq.recv(timeout, self.sent_packets) def create_gratuitous_arp_request(src_mac, src_ip): - """Creates scapy representation of gratuitous ARP request""" + """Creates scapy representation of gratuitous ARP request.""" return (Ether(src=src_mac, dst='ff:ff:ff:ff:ff:ff') / ARP(psrc=src_ip, hwsrc=src_mac, pdst=src_ip))