NetfilterQueue 项目技术文档

1. 安装指南

在开始使用 NetfilterQueue 之前，请确保您的系统已经安装以下依赖项：

• C 编译器
• Python 开发文件
• Libnetfilter_queue 开发文件及相关依赖

在 Debian 或 Ubuntu 系统上，您可以通过以下命令安装这些依赖项：

apt-get install build-essential python3-dev libnetfilter-queue-dev

从 PyPI 安装

使用 pip 从 PyPI 安装 NetfilterQueue：

pip install NetfilterQueue

从源代码安装

从源代码安装 NetfilterQueue，请按照以下步骤操作：

pip install cython
git clone https://github.com/oremanj/python-netfilterqueue
cd python-netfilterqueue
pip install .

2. 项目的使用说明

NetfilterQueue 模块为用户提供了一个访问由 iptables 规则匹配的包的接口。这些包可以被接受、丢弃、修改、重排或标记。

以下是一个简单的示例脚本，它会在接受每个包之前打印出简短的描述：

from netfilterqueue import NetfilterQueue

def print_and_accept(pkt):
    print(pkt)
    pkt.accept()

nfqueue = NetfilterQueue()
nfqueue.bind(1, print_and_accept)
try:
    nfqueue.run()
except KeyboardInterrupt:
    print('')

nfqueue.unbind()

要使脚本能够处理您的局域网中的包，请在终端中运行以下命令：

iptables -I INPUT -d 192.168.0.0/24 -j NFQUEUE --queue-num 1

3. 项目 API 使用文档

NetfilterQueue 提供了以下 API 供用户使用：

• NetfilterQueue.COPY_NONE, NetfilterQueue.COPY_META, NetfilterQueue.COPY_PACKET：这些常量指定了应该将包的多少内容传递给脚本：无内容、元数据或整个包。

• NetfilterQueue.bind(queue_num, callback, max_len=1024, mode=COPY_PACKET, range=65535, sock_len=...)：创建并绑定队列。

• NetfilterQueue.unbind()：移除队列。

• NetfilterQueue.get_fd()：获取用于接收队列包的套接字的文件描述符。

• NetfilterQueue.run(block=True)：将包发送到回调函数。默认情况下，此方法会阻塞，直到抛出异常（例如通过 Ctrl+C）。设置 block=False 可以在不等待更多消息的情况下处理挂起的消息。

• NetfilterQueue.run_socket(socket)：发送包到回调函数，但使用提供的套接字而不是 recv，以便例如 gevent 可以对其进行 monkeypatch。

更多关于 Packet 对象和 Callback 对象的 API 文档，请参考项目 Wiki 或源代码中的注释。

4. 项目安装方式

NetfilterQueue 支持两种安装方式：

• 从 PyPI 安装：使用 pip 命令直接安装。
• 从源代码安装：首先安装 cython，然后克隆项目仓库，进入目录并执行 pip 安装命令。