IVRE 项目安装与使用教程

1. 项目目录结构及介绍

IVRE 项目的目录结构如下：

ivre/
├── bin/
├── data/
├── doc/
├── docker/
├── ivre/
├── patches/
├── pkg/
├── tests/
├── web/
├── zeek/
├── .gitattributes
├── .gitignore
├── CONTRIBUTORS.md
├── LICENSE
├── README.md
├── requirements-all.txt
├── requirements-doc.txt
├── requirements-elastic.txt
├── requirements-linting.txt
├── requirements-maxmind.txt
├── requirements-mongo.txt
├── requirements-mongosrv.txt
├── requirements-postgres.txt
├── requirements-sqlite.txt
├── requirements-tinydb.txt
├── requirements.txt
├── setup.cfg
└── setup.py

目录介绍

• bin/: 包含项目的可执行脚本和工具。
• data/: 存放项目的数据文件。
• doc/: 包含项目的文档文件，通常是 Markdown 或 reStructuredText 格式。
• docker/: 包含 Docker 相关的配置文件和脚本。
• ivre/: 项目的主要代码库，包含 Python 模块和子模块。
• patches/: 存放项目的补丁文件。
• pkg/: 存放打包相关的文件。
• tests/: 包含项目的测试代码和测试数据。
• web/: 包含 Web 界面的相关文件，如 HTML、CSS、JavaScript 等。
• zeek/: 包含与 Zeek (Bro) 相关的配置和脚本。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTORS.md: 贡献者列表。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• requirements-*.txt: 各种依赖文件，用于不同环境下的依赖管理。
• setup.cfg: Python 项目配置文件。
• setup.py: Python 项目安装脚本。

2. 项目启动文件介绍

IVRE 项目的启动文件主要集中在 bin/ 目录下。以下是一些关键的启动文件：

• bin/ivre: 这是 IVRE 的主启动脚本，用于启动 IVRE 的各种功能和服务。
• bin/ivre-db: 用于管理 IVRE 数据库的脚本，包括初始化、更新和清理数据库。
• bin/ivre-runscans: 用于运行网络扫描任务的脚本。
• bin/ivre-web: 用于启动 IVRE 的 Web 界面的脚本。

启动示例

# 启动 IVRE Web 界面
bin/ivre-web start

# 运行网络扫描任务
bin/ivre-runscans --targets 192.168.1.0/24

3. 项目的配置文件介绍

IVRE 项目的配置文件主要集中在 ivre/ 目录下，以下是一些关键的配置文件：

• ivre/config.py: 这是 IVRE 的主配置文件，包含了项目的全局配置选项，如数据库连接、扫描配置、Web 界面配置等。
• ivre/web/config.py: 这是 Web 界面的配置文件，包含了 Web 服务器的配置选项，如端口、日志级别等。
• ivre/nmap/config.py: 这是 Nmap 扫描工具的配置文件，包含了 Nmap 扫描的参数和选项。

配置示例

# ivre/config.py
DATABASE_URI = "mongodb://localhost:27017/ivre"
SCAN_THREADS = 10
WEB_PORT = 8080

通过这些配置文件，用户可以自定义 IVRE 的行为和功能，以适应不同的网络环境和需求。