PyStun 技术文档

1. 安装指南

1.1 使用 pip 安装

要安装最新版本的 PyStun，可以使用以下命令：

$ pip install pystun

1.2 手动安装

你也可以下载或克隆源代码并手动安装：

$ cd /path/to/pystun/src
$ python setup.py install

1.3 开发模式安装

如果你正在开发 PyStun，建议使用 develop 命令：

$ python setup.py develop

这将在你的 site-packages 目录中创建一个指向源代码的链接，以便任何更改都可以立即用于测试。

2. 项目的使用说明

2.1 命令行使用

从命令行运行 PyStun：

$ pystun

输出示例：

NAT Type: Full Cone
External IP: <your-ip-here>
External Port: 54320

你可以通过 --help 选项查看更多选项：

$ pystun --help

2.2 Python 代码中使用

在 Python 代码中使用 PyStun：

import stun

nat_type, external_ip, external_port = stun.get_ip_info()

这将遍历内部列表中的 STUN 服务器，直到找到响应。如果没有找到响应，nat_type 将为 "Blocked"，external_ip 和 external_port 将为 None。

2.3 指定 STUN 服务器

你可以指定特定的 STUN 服务器：

nat_type, external_ip, external_port = stun.get_ip_info(stun_host='stun.ekiga.net')

2.4 指定 STUN 服务器端口

你也可以指定特定的 STUN 服务器端口：

nat_type, external_ip, external_port = stun.get_ip_info(stun_port=3478)

2.5 指定客户端接口和端口

你可以指定客户端接口和端口，尽管这不是必需的：

sip = "0.0.0.0"  # 接口监听地址（所有）
port = 54320     # 监听端口
nat_type, external_ip, external_port = stun.get_ip_info(sip, port)

3. 项目API使用文档

3.1 stun.get_ip_info()

• 功能: 获取 NAT 类型、外部 IP 和外部端口。
• 参数:
  • stun_host: 可选，指定 STUN 服务器的主机名。
  • stun_port: 可选，指定 STUN 服务器的端口。
  • source_ip: 可选，指定客户端的网络接口。
  • source_port: 可选，指定客户端的监听端口。
• 返回值:
  • nat_type: NAT 类型。
  • external_ip: 外部 IP 地址。
  • external_port: 外部端口。

3.2 命令行参数

• -h, --help: 显示帮助信息。
• -d, --debug: 启用调试日志记录。
• -H STUN_HOST, --host STUN_HOST: 指定 STUN 服务器主机。
• -P STUN_PORT, --host-port STUN_PORT: 指定 STUN 服务器端口。
• -i SOURCE_IP, --interface SOURCE_IP: 指定客户端网络接口。
• -p SOURCE_PORT, --port SOURCE_PORT: 指定客户端监听端口。
• --version: 显示程序版本号。

4. 项目安装方式

4.1 使用 pip 安装

$ pip install pystun

4.2 手动安装

$ cd /path/to/pystun/src
$ python setup.py install

4.3 开发模式安装

$ python setup.py develop

通过以上步骤，你可以成功安装并使用 PyStun 项目。