Vulnhuntr 开源项目使用教程

Vulnhuntr 开源项目使用教程

vulnhuntr Zero shot vulnerability discovery using LLMs 项目地址: https://gitcode.com/gh_mirrors/vu/vulnhuntr

1. 项目目录结构及介绍

Vulnhuntr 是一个用于自动检测远程可利用漏洞的开源项目，其目录结构如下：

vulnhuntr/
├── .devcontainer/
├── .dockerignore
├── .env.example
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── poetry.lock
├── pyproject.toml
├── requirements.txt

• .devcontainer/: 包含用于开发环境的 Docker 容器配置。
• .dockerignore: 指定在构建 Docker 镜像时应忽略的文件和目录。
• .env.example: 提供了环境变量设置的示例。
• .gitignore: 指定在 Git 仓库中应忽略的文件和目录。
• Dockerfile: 用于构建 Vulnhuntr 的 Docker 镜像。
• LICENSE: 项目的许可证文件，本项目使用 AGPL-3.0 许可。
• README.md: 项目的说明文档，包含了项目的介绍、使用方法和注意事项。
• poetry.lock: 包含项目依赖的锁定文件，用于确保环境一致性。
• pyproject.toml: 包含项目的元数据和依赖信息。
• requirements.txt: 包含项目依赖的 Python 包列表。

2. 项目的启动文件介绍

Vulnhuntr 的启动文件是 vulnhuntr.py，它负责初始化和运行整个检测流程。以下是启动文件的基本结构：

# vulnhuntr.py

def main():
    # 解析命令行参数
    # 初始化日志系统
    # 加载配置文件
    # 执行漏洞检测逻辑
    # 输出检测结果

if __name__ == "__main__":
    main()

在 main() 函数中，项目会解析用户输入的命令行参数，初始化日志系统，加载配置文件，然后执行漏洞检测逻辑，并将检测结果输出到控制台。

3. 项目的配置文件介绍

Vulnhuntr 的配置文件是 .env.example，在实际使用时需要将其复制为 .env 文件并进行相应的配置。以下是配置文件的基本内容：

# .env

ANTHROPIC_API_KEY=your_anthropic_api_key
OPENAI_API_KEY=your_openai_api_key
OLLAMA_BASE_URL=http://localhost:11434/api/generate
OLLAMA_MODEL=llama3.2

• ANTHROPIC_API_KEY: 用于Anthropic API的密钥。
• OPENAI_API_KEY: 用于OpenAI API的密钥。
• OLLAMA_BASE_URL: Ollama服务的URL。
• OLLAMA_MODEL: Ollama使用的模型名称。

在使用前，需要将示例配置文件中的占位符替换为实际的API密钥和服务URL。

vulnhuntr Zero shot vulnerability discovery using LLMs 项目地址: https://gitcode.com/gh_mirrors/vu/vulnhuntr