Carl Javier
Centre for Advanced Internet Architectures,
Swinburne University of Technology,
Melbourne, Australia
CRICOS number 00111D

22nd December, 2009


----------------------------------------------
OVERVIEW
----------------------------------------------

This is the README for the per-prefix-mrai and path-damping patch for
pcapy version 0.10.5, contained in the file pcapy-patch

The files in the archive are:

	pcapy-patchset-v1.patch
	README

This patche provides an implementation of a new pcap header method pcap object
added to pcapy [1]. One may wish to create custom pcap files with custom packed
packets. This is used in a packet generator developed at CAIA from the BITSS
project (http://caia.swin.edu.au/bitss).

-----------------------
LICENCE
-----------------------

This patch is released under the GPL Version 2.

-----------------------
PATCHING & INSTALLING
-----------------------

  pcapy and patches
  - Download pcapy 0.10.5 from http://oss.coresecurity.com/projects/pcapy.html
    and extract:

    tar -xzvf pcapy-0.10.5.tgz

  - Download pcapy-patch from http://www.caia.swin.edu.au/bitss/tools.html.
    and copy patchset to pcapy folder:

    cp pcapy-patchset-v1.patch pcapy-0.10.5/

  - Patch pcapy:

    cd pcapy-0.10.5/
    patch -p1 < pcapy-patchset.patch

  - Install pcapy (as root):

    python setup.py install

-----------------------
USAGE
-----------------------

The following is a snippet from Game Packet Generator 0.2 found at
http://caia.swin.edu.au/bitss/output.html

------
import pcapy

pktcapture = pcapy.open_live('eth0',100,0,10)
dumpfile = pktcapture.dump_open('filename.dmp')

#network packet created
e = creategamepacket(IPdest,IPsrc,port,pktsize)

#create new custom pcap header filename
#newhdr(unixtime_seconds,microseconds, capture length(bytes), actual length)
new_header
= pktcapture.newhdr(epoch_seconds,int(epoch_useconds*1000000),e.len,e.len)

#write artificial packet with custom pcap header to file
dumpfile.dump(new_header,str(e))

----------------------------------------------
KNOWN LIMITATIONS
----------------------------------------------

- The implementation has not been tested under the following conditions: 
  - FreeBSD 8 and Linux Ubuntu 9.10
  - Python 2.6


----------------------------------------------
RELATED READING
----------------------------------------------

This software was developed as part of the Broadband Internet Simulation &
Synthesis (BITSS) research project at Swinburne University's Centre for Advanced
Internet Architectures.

More information on the project is available at:

        http://caia.swin.edu.au/bitss/

The documents directly related to this patche are:

[1] pcapy documentation

        http://oss.coresecurity.com/pcapy/doc/pt01.html


----------------------------------------------
ACKNOWLEDGEMENTS
----------------------------------------------

This project has been made possible in part by
a grant from the Agilent Technologies Foundations (USA).