EPScan 开源项目使用教程

EPScan 开源项目使用教程

1. 项目的目录结构及介绍

EPScan 项目的目录结构如下：

EPScan/
├── README.md
├── bin/
│   ├── EPScan
│   └── EPScan.exe
├── config/
│   └── config.yaml
├── docs/
│   └── ...
├── src/
│   └── ...
└── tests/
    └── ...

• README.md: 项目介绍文件，包含项目的基本信息和使用说明。
• bin/: 存放可执行文件的目录，包括 EPScan 和 EPScan.exe。
• config/: 配置文件目录，包含 config.yaml 文件。
• docs/: 文档目录，包含项目的详细文档。
• src/: 源代码目录，包含项目的所有源代码文件。
• tests/: 测试目录，包含项目的测试代码。

2. 项目的启动文件介绍

EPScan 项目的启动文件位于 bin/ 目录下，包括 EPScan 和 EPScan.exe。这两个文件是项目的可执行文件，用于启动 EPScan 工具。

• EPScan: 适用于 Unix 系统的可执行文件。
• EPScan.exe: 适用于 Windows 系统的可执行文件。

使用方法：

# 在 Unix 系统上
./bin/EPScan

# 在 Windows 系统上
bin\EPScan.exe

3. 项目的配置文件介绍

EPScan 项目的配置文件位于 config/ 目录下，名为 config.yaml。该文件包含了 EPScan 工具的所有配置选项。

配置文件的主要内容包括：

# 基本配置
basic:
  log_level: info
  output_format: json

# 扫描配置
scan:
  targets:
    - 192.168.1.0/24
    - example.com
  ports:
    - 80
    - 443
    - 8080

# 高级配置
advanced:
  concurrency: 10
  timeout: 10s

• basic: 基本配置，包括日志级别和输出格式。
• scan: 扫描配置，包括目标地址和端口。
• advanced: 高级配置，包括并发数和超时时间。

通过修改 config.yaml 文件，可以自定义 EPScan 工具的运行参数。