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的範例測試流程。
範例使用影片如下：（或在此處提供：演示）

常見問題

Q ：什麼是 PentestGPT？
- 答：PentestGPT 是一款由大型語言模型（LLM）支援的滲透測試工具。它旨在自動化滲透測試過程。它建立在ChatGPT API之上，以互動模式運行，指導滲透測試人員進行整體進度和具體操作。
Q ：使用 PentestGPT 需要付費嗎？
- 答：是的，以便達到最佳性能。一般來說，您可以使用任何您想要的LLM，但建議您使用GPT-4 API，為此您必須將付款方式連結到OpenAI。
Q ：為什麼選擇 GPT-4？
- A ：經過實證評估，我們發現GPT-4在滲透測試推理方面比GPT-3.5和其他LLM表現更好。事實上，GPT-3.5 導致簡單任務的測試失敗。
Q ：為什麼不直接使用 GPT-4？
- 答：我們發現，隨著測試的深入，GPT-4 會出現上下文遺失的問題。在此過程中保持「測試狀態意識」至關重要。您可以查看 PentestGPT Arxiv 論文以了解詳細資訊。
Q ：我可以使用本地 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
}