README

============================================
 UMPA - Umit's Manipulations of Packets Art
============================================

Copyright (C) 2008-2010 Adriano Monteiro Marques <py.adriano at gmail dot com>

Authors: Bartosz SKOWRON <getxsick at gmail dot com>

All rights reserved, see COPYING for details.

This library is free software; you can redistribute it and/or modify 
it under the terms of the GNU Lesser General Public License as published 
by the Free Software Foundation; either version 2.1 of the License, or 
(at your option) any later version.

This library is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
License for more details.

You should have received a copy of the GNU Lesser General Public License 
along with this library; if not, write to the Free Software Foundation, 
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 


Introduction
============

UMPA is a packet generation and manipulation library. It aims to provide
an easy-to-use system to manipulate packets on every layer of the OSI model.
UMPA supports many sophisticated features, including:

  * auto-generating packets - defaults are provided for most fields
  * high-level editing of header fields - no knowledge of bit-level
    representation needed
  * auto-filling - checksum/length fields are generated automatically
  * interaction system - reacting and responding to network events
  * sniffing and sending packets - easy communication with the real world 

The goal of the project is to get a powerful, easy to use and intelligent
packet manipulation tool suitable both for beginners and experienced users.
UMPA has a wide range of uses, including network diagnostics, auditing,
stress testing and network stack debugging. 


Documentation
=============

On the Web: http://www.umpa.umitproject.org

This page also points to support resources and informations about UMPA
development status and plans.

Local:

See docs/*                    from the sources package tarball
See /usr/share/doc/umpa       if you have already installed the library


Dependencies
============

  * [1] Python programming language
  * [2] libpcap (for sniffing)
  * [3] libpcap's python wrapper (see INSTALL for details)


Acknowledgements
================

I would like to thank for a several people, who help and support me with the
library, sending patches, testing it and giving ideas:

  * Adriano Monteiro Marques
  * Francesco Piccinno
  * Luís António Bastião Silva
  * Guilherme Henrique Polo Gonçalves
  * João Paulo de Souza Medeiros


Authors
=======

  * Bartosz SKOWRON <getxsick at gmail dot com>


References
==========

  * [0] UMPA website - http://umpa.umitproject.org/
  * [1] Umit Project - http://www.umitproject.org/
  * [2] Python official website - http://www.python.org/