框架感知的静态代码分析工具,用于自动化源代码审查,支持平台特定规则、污点分析、工作量估算和抑制基线。
Author:
- Debasis Mohanty ([email protected])
- Twitter / X: @coffeensecurity
- www.coffeeandsecurity.com
Daksh SCRA(Source Code Review Assist,源代码审查辅助工具)旨在提升源代码审查流程的效率,为代码审查人员提供结构良好、条理清晰的方法。
Daksh SCRA 不会不加区分地将所有内容都标记为潜在问题,而是倡导审慎分析,敦促对潜在问题进行排查与确认。这种方法减少了将所有潜在隐患都标记为缺陷的忙乱,减少了因误报而造成的困惑与时间浪费。
Daksh SCRA 最初在 Black Hat USA 2022(8 月 6 日至 9 日)的源代码审查培训课程中推出,当时仅向特定受众低调展示。其正式的公开亮相是在拉斯维加斯举行的 Black Hat USA 2023 上。
DakshSCRA 汇集了用于人工源代码审查的独特能力,涵盖文件路径关注区域、工作量估算、软件侦察、上下文规则以及跨文件分析。
| 特性 | 标签 | 重要性 |
|---|---|---|
| 文件路径关注区域 | 世界首创* | 除代码外,还会扫描文件和目录名称本身,以标记审查人员经常遗漏的可疑路径,如备份文件、调试端点、配置转储和凭据文件。 |
| 科学的工作量估算 | 世界首创* | 根据代码库规模和项目信号,对人工审查工作量给出量化估算。可配置的假设使项目规划明确且可重复。 |
| 软件侦察 | 世界第二* | 在扫描之前,从文件内容和项目结构中检测语言、框架和基础设施。将技术清单与自动规则选择、语义分析和审查规划关联起来。 |
| 高级语义与跨文件分析 | 发布时最先进的开源方案* | 使用专门构建的分析,在受支持的文件边界之间追踪用户控制的数据从源到汇的流动。高级分析于 2026 年 3 月随原始 RDL 一同发布;RDL v2 将语义规则评估扩展到跨文件。 |
| 特性 / 里程碑 | 日期 | 版本 | 证据 / 范围 |
|---|---|---|---|
| 初始测试版与文件路径规则 | 2022 年 10 月 22 日 | v0.1-beta | 初始版本;保留的源代码包含专门的文件路径规则清单。 |
| 软件侦察(公开发布介绍) | 2023 年 7 月 9 日 | v0.3-beta | 发布说明介绍了侦察功能;更早的仓库代码是独立的实现证据。 |
| 人工审查工作量估算(实现) | 2023 年 7 月 29 日 | 实现提交 | 添加了专门的估算模块;并非后续修复版本的日期。 |
| 原始 RDL 与文件间高级分析 | 2026 年 3 月 2 日 | v0.31-beta | 条件规则逻辑与独立的跨文件分析一同发布。版本显示日期为 3 月 2 日;发布时间戳为 2026 年 3 月 1 日 18:39 UTC。 |
日期标识的是仓库或版本里程碑。
DakshSCRA 在 Black Hat USA 2022 培训期间推出,并在 Black Hat USA 2023 上公开亮相。这些日期描述的是项目的推出时间,而非当前的所有功能。
持续增强正在进行中。多个新功能和改进已计划在即将发布的版本中推出。
欢迎为更新或添加新规则以及未来发展做出贡献。
如果您发现任何错误,请报告至 [email protected]。
详细文档:https://dakshlabs.com/#docs
运行 Daksh SCRA 有两种方式——选择适合您工作流程的那一种:
| 最适合 | 跳转到 | |
|---|---|---|
| 🌐 Web UI (Docker) | 最简单的入门方式——一条命令、一个浏览器仪表板、实时扫描进度以及报告/产物浏览器。推荐大多数用户使用。 | Web UI (Docker) |
| 💻 CLI (Python) | 脚本编写、CI 流水线,或在不使用 Docker 的情况下运行扫描。 | CLI 设置 |
两种方式运行完全相同的扫描引擎——Web UI 是同一 CLI 之上的浏览器前端,因此无论哪种方式结果都相同。
运行 Daksh SCRA 最快的方式是通过其基于浏览器的 Web UI,使用主机感知的 Docker 启动辅助脚本启动。它为您提供扫描启动器、实时控制台输出以及可浏览的历史报告。启动辅助脚本需要 Python 3(仅标准库);应用程序及其依赖项在 Docker 中运行。
Docker 设置将 Web UI 和 CLI 作为由同一镜像构建的独立服务运行,因此您可以从同一容器中使用其中任意一个(或两者)。
从 GitHub 下载 Daksh SCRA 后,请先解压 ZIP 归档文件。
在包含 docker-compose.yml 和 dakshscra.py 的解压项目文件夹内打开终端(Windows 上为 PowerShell 或命令提示符)。
请从该文件夹运行以下所有启动和 Docker Compose 命令。
如果您的终端在其他位置打开,请先切换到解压后的文件夹:
cd "path/to/extracted/DakshSCRA-folder"
将示例路径替换为你实际的下载位置和文件夹名称。
如果你改为克隆了仓库,请在其父文件夹中运行 cd DakshSCRA。
启动辅助脚本会识别 Windows、WSL、Linux 和 macOS,然后在启动容器之前以只读方式挂载 主机根目录、可用的 Windows 驱动器以及常见文件夹。请在运行 Docker 的计算机上运行它。
Linux、macOS 或 WSL(前台运行):
python3 tools/start_webui.py
Windows PowerShell 或命令提示符(前台):
py tools/start_webui.py
要以分离(后台)模式运行,请添加 --detach。启动命令返回后,容器会继续运行,你的终端仍可继续使用。
Linux、macOS 或 WSL(分离模式):
python3 tools/start_webui.py --detach
Windows PowerShell 或命令提示符(分离模式):
py tools/start_webui.py --detach
使用 --dry-run 可在不启动容器的情况下检查检测到的路径。
现有的 .env 路径覆盖设置会被遵循。重新创建容器时,账户、扫描结果和运行时
卷都会被保留。
Docker Desktop 可能需要授予共享所选主机路径的权限。如果它 拒绝某个挂载,请在 Docker Desktop 中允许该位置,然后重新运行该辅助脚本。 远程浏览器看到的是 Docker 主机 的文件夹,而不是它自己计算机的驱动器。 自动检测需要本地 Docker 引擎;使用远程 Docker 上下文时,请在引擎 主机上运行该辅助脚本。
对于手动配置的挂载,docker compose up --build -d api web 仍然
可用。其基线会将仓库挂载到 /scan-targets,并将
${DAKSH_HOST_MOUNT:-/} 挂载到 /host/root。请使用该辅助脚本进行 Windows 驱动器发现
和常用文件夹快捷方式;普通 Compose 无法检测客户端操作系统。
然后打开 http://localhost:3030。
要使用其他端口:
DAKSH_PORT=9090 python3 tools/start_webui.py
使用以下命令停止该堆栈:
docker compose down
使用仓库文件夹中独立的清理辅助脚本。它们默认只进行预览:
此操作会删除 Daksh 容器、服务镜像、网络和卷,包括已保存的账户、扫描历史以及存储在运行时卷中的产物。请先备份任何你想保留的内容。
python3 tools/clean_project_docker.py
python3 tools/purge_all_docker.py
添加 --execute 以执行删除,然后输入所要求的确认信息。第一个辅助脚本会移除本项目的容器、网络、服务镜像和卷,同时保留共享的构建缓存。第二个辅助脚本会强制移除所选 Docker 引擎上所有项目的容器,并清理镜像、网络、命名卷/匿名卷以及默认构建器缓存。它可能会影响远程引擎。两者都不会删除绑定挂载的主机文件,也不会卸载 Docker。Windows 用户可以将 python3 替换为 py。有关自定义项目名称、排除项和删除详情,请参阅清理范围与命令。
使用以下命令检查剩余的 Docker 磁盘占用:
docker system df
要仅释放未使用的构建缓存,同时保留已保存的 Daksh 数据,只需运行 docker builder prune --all --force。绑定挂载的主机文件夹中的文件(包括仓库和扫描目标)仍保留在磁盘上。准备好后,使用 python3 tools/start_webui.py --detach 重新启动。
Web UI 需要一个账户。
首次登录
启动门户(python3 tools/start_webui.py --detach)并打开 http://localhost:3030。
登录页面会检测到首次设置。它会预填用户名 admin 和初始密码,并显示首次设置提示。
| 设置 | 值 |
|---|---|
| 用户名 | admin(或来自 .env 的 DAKSH_ADMIN_USERNAME) |
| 初始密码 | Daksh@ChangeMe1(或来自 .env 的 DAKSH_ADMIN_PASSWORD) |
点击 登录。会出现一个全屏的 更改密码 步骤,且无法跳过。输入初始密码作为当前密码,选择一个新密码(至少 8 个字符,且与当前密码不同),并可选择更改用户名。
保存后,你会被带到仪表板。此后登录页面不再预填任何内容;请使用你自己的凭据登录。
初始密码仅在数据库中没有账户时使用,一旦更改便不再有效。在此之前,任何能访问门户的人都可以用它登录,因此如果门户可被他人访问,请在首次启动前在 .env 中设置 DAKSH_ADMIN_PASSWORD。管理员账户可以通过 POST /api/v1/auth/users API 端点创建更多账户(目前尚无专用 UI)。新建和重置的账户在首次登录时也必须更改其分配的密码。有关身份验证相关设置的完整列表(会话生命周期、Cookie 安全性、CORS),请参阅 .env.example。
在底层,CLI 仍然是事实来源——它执行所有扫描并生成每个 HTML / PDF / JSON 输出。Web UI 一次运行一个活动作业,并将每个已完成作业的输出快照到 runtime/webui/jobs/<job-id>/artifacts/,以便过去的报告保持可访问。
你也不需要本地 Python 环境来使用 CLI——它作为独立的 Compose 服务提供,基于同一镜像构建:
docker compose run --rm cli -h
docker compose run --rm cli -r auto -t /scan-targets/path/to/source
reports/ 和 runtime/ 卷关键挂载点:
| 挂载 | 容器内路径 |
|---|---|
| 项目源码 | /app |
默认扫描根目录(仓库,或 DAKSH_SCAN_ROOT) | /scan-targets |
| 主机文件系统(Windows 上的系统盘) | /host/root |
| 其他 Windows/WSL 驱动器 | /host/drives/<letter> |
| 当前用户主目录 | /host/user |
| 常见主机文件夹 | /host/locations/<name> |
可选的 DAKSH_HOST_SOURCE | /host/source |
将 .env.example 复制为 .env,以进行可选的路径和身份验证覆盖。
DAKSH_BROWSE_ROOTS 是一个以逗号分隔的容器路径允许列表;
保持未设置状态以自动发现已挂载的位置。切换到该辅助工具时,应移除或更新过时的 /host/c、/host/d
或 /mnt 允许列表。
主机文件夹为只读;报告和运行时数据在其现有应用程序位置中保持可写。挂载另一个驱动器后,使用该辅助工具重启。无需 Docker socket 或特权容器。
更倾向于直接用 Python 运行 Daksh SCRA?以下是在本地进行设置的方法。
requirements.txt 中列出的所有库git clone https://github.com/coffeeandsecurity/DakshSCRA.git
或从 https://github.com/coffeeandsecurity/DakshSCRA 下载最新的 zip 包并解压。
💡 虚拟环境可以在任意目录中创建——无需位于 DakshSCRA 文件夹内。
选项 A:一步式设置(推荐)
python setup_env.py
此脚本会创建虚拟环境、安装所有依赖项,并安装 Playwright 的 Chromium 浏览器(PDF 导出所需)。
选项 B:手动设置
Windows:
python -m venv daksh-env
.\daksh-env\Scripts\activate
macOS / Linux:
python3 -m venv daksh-env
source daksh-env/bin/activate
然后安装依赖:
cd path/to/DakshSCRA
pip install -r requirements.txt
playwright install chromium
在虚拟环境中使用 python,在虚拟环境外使用 python3。