build/

v0.1, 12 May 2011 -- Initial release.

Copyright (c) 2011, Kerkhoff Technologies, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright

notice, this list of conditions and the following disclaimer in the

documentation and/or other materials provided with the distribution.

* Neither the name of the Kerkhoff Technologies, Inc. nor the

names of its contributors may be used to endorse or promote products

derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY

DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

CHANGES.txt

LICENSE.txt

README.txt

netfilterqueue.pyx

setup.py

==============

NetfilterQueue

==============

NetfilterQueue provides access to packets matched by an iptables rule in

Linux. Packets so matched can be accepted, dropped, altered, or given a mark.

Libnetfilter_queue (the netfilter library, not this module) is part of the `Netfilter project <http://netfilter.org/projects/libnetfilter_queue/>`_.

Example

=======

Coming soon...

Installation

============

NetfilterQueue is a C extention module that links against libnetfilter_queue. Before installing, ensure you have:

1. A C compiler

2. Python development files

3. Libnetfilter_queue development files and associated dependencies

On Debian or Ubuntu, these files are install with::

sudo apt-get install build-essential python-dev libnetfilter-queue-dev

From PyPI

---------

To install from PyPI by pip::

pip install netfilterqueue

From source

-----------

To install from source::

wget http://pypi.python.org/packages/source/n/netfilterqueue/netfilterqueue-0.1.tar.gz

tar -xvzf netfilterqueue-0.1.tar.gz

cd netfilterqueue-0.1

python setup.py install

Setup will use Cython if it is installed, regenerating the .c source from the .pyx before compiling the .so.

Usage

=====

Coming soon...

Now route packets to the queue::

# iptables -I INPUT -p tcp --dport 80 -j NFQUEUE --queue-num 1

The only special part of the rule is the target. Rules can have any match and

can be added to any table or chain.

Valid queue numbers are integers from 0 to 65,536 inclusive.

Limitations

===========

TODO: fix this up

* compiled to max 2048-byte packets, so won't work on LO?

* full API not implemented: omits set_payload(), interface methods, and what else?