PentestGPT下载 - PentestGPT源代码下载

PentestGPT

Python

v0.14.0

下载

渗透测试GPT

一款支持 GPT 的渗透测试工具。
探索文档 »

设计细节·查看演示·报告错误或请求功能

一般更新

[2024年10月25日更新]我们正在完成PentestGPT的重构，即将发布v1.0！
[更新于12/08/2024] PentestGPT的研究论文发表于USENIX Security 2024
[更新于 25/03/2024] 我们正在开发 PentestGPT 的下一版本，包括在线搜索、RAG 和更强大的提示。敬请关注！
[更新于 17/11/2023] PentestGPT 的 GPT 已发布！检查这个：https://chat.openai.com/g/g-4MHbTepWO-pentestgpt
[更新于 07/11/2023] GPT-4-turbo 已推出！将默认 API 使用情况更新为 GPT-4-turbo。
可用视频：
- 最新的安装视频在这里。
- 用于类 OSCP 机器的 PentestGPT：HTB-Jarvis 。这只是第一部分，剩下的有时间我会完成。
- HTB-Lame 上的 PentestGPT 。这是一台简单的机器，但它向您展示了 PentestGPT 如何跳过兔子洞并解决其他潜在漏洞。
我们正在 HackTheBox 上测试 PentestGPT 。您可以点击此链接。更多细节将很快发布。
欢迎加入 Discord 频道以获取更多更新并分享您的想法！

快速入门

如有必要，创建虚拟环境。（ virtualenv -p python3 venv ， source venv/bin/activate ）
使用pip3 install git+https://github.com/GreyDGL/PentestGPT安装项目
确保您已将付款方式链接到您的 OpenAI 帐户。使用export OPENAI_API_KEY='<your key here>'导出您的API密钥，如果需要，使用export OPENAI_BASEURL='https://api.xxxx.xxx/v1'导出API基础。
使用pentestgpt-connection测试连接
对于 Kali 用户：使用tmux作为终端环境。您只需在本机终端中运行tmux即可做到这一点。
开始： pentestgpt --logging

入门

PentestGPT是一款由ChatGPT授权的渗透测试工具。
它旨在自动化渗透测试过程。它构建在ChatGPT之上，以交互方式运行，指导渗透测试人员进行整体进度和具体操作。
PentestGPT能够解决简单到中等的 HackTheBox 机器以及其他 CTF 挑战。您可以在resources中查看此示例，我们使用它来解决 HackTheBox 挑战模板（网络挑战）。
此处提供了目标 VulnHub 机器 (Hackable II) 上PentestGPT的示例测试过程。
示例使用视频如下：（或在此处提供：演示）

常见问题

问：什么是 PentestGPT？
- 答：PentestGPT 是一款由大型语言模型（LLM）支持的渗透测试工具。它旨在自动化渗透测试过程。它建立在ChatGPT API之上，以交互模式运行，指导渗透测试人员进行整体进度和具体操作。
问：使用 PentestGPT 需要付费吗？
- 答：是的，以便达到最佳性能。一般来说，您可以使用任何您想要的LLM，但建议您使用GPT-4 API，为此您必须将付款方式链接到OpenAI。
问：为什么选择 GPT-4？
- A ：经过实证评估，我们发现GPT-4在渗透测试推理方面比GPT-3.5和其他LLM表现更好。事实上，GPT-3.5 导致简单任务的测试失败。
问：为什么不直接使用 GPT-4？
- 答：我们发现，随着测试的深入，GPT-4 会出现上下文丢失的问题。在此过程中保持“测试状态意识”至关重要。您可以查看 PentestGPT Arxiv 论文了解详细信息。
问：我可以使用本地 GPT 模型吗？
- 答：是的。我们通过自定义解析器支持本地法学硕士。看看这里的例子。

安装

PentestGPT 在Python 3.10下进行测试。其他 Python3 版本应该可以工作，但未经测试。

使用 pip 安装

PentestGPT依靠OpenAI API实现高质量推理。您可以参考这里的安装视频。

pip3 install git+https://github.com/GreyDGL/PentestGPT安装最新版本
- 您还可以将项目克隆到本地环境并安装以更好地定制和开发
  - git clone https://github.com/GreyDGL/PentestGPT
  - cd PentestGPT
  - pip3 install -e .
使用 OpenAI API
- 确保您已将付款方式链接到您的 OpenAI 帐户。
- 使用export OPENAI_API_KEY='<your key here>'导出您的 API 密钥
- 如果需要，可以使用export OPENAI_BASEURL='https://api.xxxx.xxx/v1'导出 API 库。
- 使用pentestgpt-connection测试连接

要验证连接是否配置正确，您可以运行pentestgpt-connection 。一段时间后，您应该会看到一些与 ChatGPT 的示例对话。

下面是示例输出

 You're testing the connection for PentestGPT v 0.11.0
#### Test connection for OpenAI api (GPT-4)
1. You're connected with OpenAI API. You have GPT-4 access. To start PentestGPT, please use <pentestgpt --reasoning_model=gpt-4>

#### Test connection for OpenAI api (GPT-3.5)
2. You're connected with OpenAI API. You have GPT-3.5 access. To start PentestGPT, please use <pentestgpt --reasoning_model=gpt-3.5-turbo-16k>

注意：如果您尚未将付款方式链接到您的 OpenAI 帐户，您将看到错误消息。

ChatGPT cookie 解决方案已弃用且不推荐。您仍然可以通过运行pentestgpt --reasoning_model=gpt-4 --useAPI=False来使用它。

从源代码构建

将存储库克隆到您的本地环境。
确保poetry已安装。如果没有，请参阅诗歌安装指南。

用法

建议您运行：
- （推荐） - pentestgpt --reasoning_model=gpt-4-turbo使用最新的 GPT-4-turbo API。
- pentestgpt --reasoning_model=gpt-4如果您有权访问 GPT-4 API。
- pentestgpt --reasoning_model=gpt-3.5-turbo-16k如果您只能访问 GPT-3.5 API。
首先，运行pentestgpt --args 。
- --help显示帮助信息
- --reasoning_model是您要使用的推理模型。
- --parsing_model是您要使用的解析模型。
- --useAPI是否要使用OpenAI API。默认情况下它设置为True 。
- --log_dir是自定义的日志输出目录。该位置是相对目录。
- --logging定义您是否愿意与我们共享日志。默认情况下它设置为False 。
该工具的工作原理与msfconsole类似。按照指导执行渗透测试。
一般来说，PentestGPT 接收的命令与 chatGPT 类似。有几个基本命令。
1. 命令是：
  - help ：显示帮助信息。
  - next ：输入测试执行结果并进行下一步。
  - more ：让PentestGPT解释当前步骤的更多细节。此外，还将创建一个新的子任务求解器来指导测试人员。
  - todo ：显示待办事项列表。
  - discuss ：与PentestGPT讨论。
  - google ：在谷歌上搜索。该功能仍在开发中。
  - quit ：退出工具并将输出保存为日志文件（请参阅下面的报告部分）。
2. 您可以使用 <SHIFT + 向右箭头> 结束输入（适用于下一行）。
3. 您可以始终使用TAB来自动完成命令。
4. 当您看到下拉选择列表时，您可以使用光标或箭头键来导航该列表。按ENTER选择该项目。同样，使用 <SHIFT + 向右箭头> 确认选择。
  用户可以提交以下信息：
  - tool ：所使用的安全测试工具的输出
  - web ：网页的相关内容
  - 默认：无论你想要什么，该工具都会处理它
  - user-comments : 用户对 PentestGPT 操作的评论
在more发起的子任务处理程序中，用户可以执行 more 命令来调查特定问题：
1. 命令是：
  - help ：显示帮助信息。
  - brainstorm ：让 PentestGPT 就本地任务进行头脑风暴，找出所有可能的解决方案。
  - discuss ：与 PentestGPT 讨论这个本地任务。
  - google ：在谷歌上搜索。该功能仍在开发中。
  - continue ：退出子任务并继续主测试会话。

报告和记录

[更新] 如果您希望我们收集日志来改进工具，请运行pentestgpt --logging 。我们只会收集 LLM 使用情况，而不收集与您的 OpenAI 密钥相关的任何信息。
渗透测试完成后，将在logs文件夹中自动生成报告（如果使用quit命令退出）。
通过运行python3 utils/report_generator.py <log file>可以以人类可读的格式打印报告。还上传了示例报告sample_pentestGPT_log.txt 。

自定义模型端点和本地法学硕士

PentestGPT 现在支持本地 LLM，但提示仅针对 GPT-4 进行了优化。

要使用本地 GPT4ALL 模型，您可以运行pentestgpt --reasoning_model=gpt4all --parsing_model=gpt4all 。
要选择要与 GPT4ALL 一起使用的特定模型，您可以更新pentestgpt/utils/APIs/module_import.py中的module_mapping类。
您还可以按照module_import.py 、 gpt4all.py和chatgpt_api.py的示例为您自己的模型创建 API 支持。

引文

请在以下位置引用我们的论文：

 @inproceedings {299699,
author = {Gelei Deng and Yi Liu and V{'i}ctor Mayoral-Vilches and Peng Liu and Yuekang Li and Yuan Xu and Tianwei Zhang and Yang Liu and Martin Pinzger and Stefan Rass},
title = {{PentestGPT}: Evaluating and Harnessing Large Language Models for Automated Penetration Testing},
booktitle = {33rd USENIX Security Symposium (USENIX Security 24)},
year = {2024},
isbn = {978-1-939133-44-1},
address = {Philadelphia, PA},
pages = {847--864},
url = {https://www.usenix.org/conference/usenixsecurity24/presentation/deng},
publisher = {USENIX Association},
month = aug
}