php-vulnerability-hunter 是一个用于检测 PHP 代码中安全漏洞的静态分析工具。以下是使用该工具的基本指南:
一、安装方法
1、通过 Composer 安装(推荐):
composer global require --dev php-vulnerability-hunter/php-vulnerability-hunter
2、通过 Git 克隆:
git clone https://github.com/php-vulnerability-hunter/php-vulnerability-hunter.git
cd php-vulnerability-hunter
composer install
二、基本使用方法
1、扫描单个文件:
php-vulnerability-hunter scan /path/to/your/file.php
2、扫描整个目录:
php-vulnerability-hunter scan /path/to/your/project
3、使用特定规则集扫描:
php-vulnerability-hunter scan --ruleset=security /path/to/project
三、常用选项
--format=<format>
:指定输出格式(text, json, xml 等)--report=<file>
:将报告保存到文件--exclude=<dir>
:排除特定目录--level=<level>
:设置检测级别(low, medium, high)
四、高级功能
1、自定义规则:
可以在 rules/
目录中添加自定义规则
规则使用 YAML 格式定义
2、集成到 CI/CD:
php-vulnerability-hunter scan --format=checkstyle /path/to/project > report.xml
3、忽略特定警告:
在代码中添加 // @php-vulnerability-hunter-ignore 注释可忽略下一行的检测
五、示例输出
[High] SQL Injection vulnerability found in file.php on line 42
[Medium] XSS vulnerability found in template.php on line 15
[Low] Hardcoded password found in config.php on line 7
六、最佳实践
- 在开发过程中定期运行扫描
- 将扫描集成到您的 CI 流程中
- 修复高优先级漏洞后再处理中低优先级问题
- 结合其他安全工具使用以获得更全面的覆盖
如需更详细的信息,请参考项目的官方文档或 php-vulnerability-hunter --help
命令输出。