Skip to content

user_guide.md

Latest commit

 

History

History
59 lines (42 loc) · 1.15 KB

user_guide.md

File metadata and controls

59 lines (42 loc) · 1.15 KB

Cerberus 用户手册

1. 安装

源码安装

目前 Cerberus 处于开发阶段，建议从源码安装。

# 1. 克隆代码
git clone https://github.com/code-symph/Cerberus.git
cd Cerberus

# 2. 安装依赖 (需要 Poetry)
poetry install

# 3. 编译 C++ 扩展
poetry run pip install -e .

2. 基本使用

启动工具

poetry run cerberus

命令行参数 (计划中)

# 扫描单个 IP
cerberus scan -t 192.168.1.1

# 扫描指定端口
cerberus scan -t 192.168.1.1 -p 80,443,8080

# 加载自定义插件
cerberus scan -t 192.168.1.1 --plugin my_vuln_check

3. 配置文件

Cerberus 会在 ~/.cerberus/config.yaml 查找配置文件。

core:
  threads: 10          # 扫描线程数
  timeout: 2000        # 超时时间 (ms)

logging:
  level: INFO          # 日志级别 (DEBUG, INFO, WARNING, ERROR)
  file: cerberus.log   # 日志文件路径

4. 常见任务

端口扫描

Cerberus 使用高性能 C++ 引擎进行端口扫描。默认扫描 Top 1000 常用端口。

插件扩展

将你的 Python 脚本放入 plugins/ 目录，Cerberus 会在启动时自动加载它们。