Skip to main content

An AI-powered pentesting tool

Project description

pentest-ai - AI-Powered Pentesting Assistant

pentest-ai is a Python utility that leverages AI to assist with penetration testing tasks. Created by AKM Korishee Apurbo, it interactively guides users in building and executing pentesting commands on Kali Linux, featuring a vibrant CLI powered by Groq.

Features

  • AI-Driven Guidance: Interactively builds pentesting commands step-by-step using Groq’s AI.
  • Tool Support: Works with tools like nmap, sqlmap, hashid, hashcat, and more.
  • Interactive Execution: Executes commands in a new terminal window (e.g., xterm).
  • Colorful Interface: Uses colorama and pyfiglet for a fun, animated experience with emojis 🌟.
  • API Key Management: Set and store your Groq API key with a single command.

Installation

To install pentest-ai, use the following command:

pip install pentest-ai

Requirements

  • Python 3.7+
  • Dependencies: groq, colorama, pyfiglet (installed automatically)
  • Groq API key (get one from Groq)
  • Pentesting tools (e.g., nmap, sqlmap) installed on your system
  • Terminal emulator like xterm

Usage

1. Set Your Groq API Key

Before using the tool, set your API key:

pentest-ai --api "your_groq_api_key"

This saves the key to ~/.pentest_ai_config.json.

2. Start the Pentesting Assistant

Run the tool to start the interactive assistant:

pentest-ai

It will display a colorful logo and prompt you for input:

[Animated "PenTest AI" logo]
AI Pentesting Chatbot 🎉 Powered by AKM Korishee Apurbo 🚀
Welcome to PenTest AI! 🎉 Type 'exit' to quit. 🚪
You 👤:

3. Interact with the Assistant

Type commands or questions (e.g., "scan a network", "identify a hash") to build and execute pentesting tasks.

Example Commands

  • Set the API key:

    pentest-ai --api "gsk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    
  • Start the tool:

    pentest-ai
    
  • Scan a network (interactive):

    pentest-ai
    You 👤: scan a network
    [Follow prompts to specify network]
    
  • Identify a hash (interactive):

    pentest-ai
    You 👤: identify a hash
    [Follow prompts to provide hash]
    

Example Output

Scanning a Network

You 👤: scan a network
Korishee 🤖: COMMAND: nmap -sP <network>
Explanation 📝: This uses nmap to ping scan a network and find live hosts.
Korishee asks ❓: What network would you like to scan (e.g., 192.168.1.0/24)? 🌐
You 👤: 192.168.1.0/24
Korishee 🤖: COMMAND: nmap -sP 192.168.1.0/24
Command executed in a new terminal window! 🎉

Identifying a Hash

You 👤: identify a hash
Korishee 🤖: COMMAND: hashid <hash>
Explanation 📝: This uses hashid to identify the type of a hash.
Korishee asks ❓: Please provide the hash you want to identify! 🔍
You 👤: 5f4dcc3b5aa765d61d8327deb882cf99
Korishee 🤖: COMMAND: hashid 5f4dcc3b5aa765d61d8327deb882cf99
Command executed in a new terminal window! 🎉

Setting API Key

pentest-ai --api "gsk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
API key saved to ~/.pentest_ai_config.json! 🎉

Options

  • --api <key>: Set and save your Groq API key for the tool to use.

License

This project is open-source and available under the MIT License.


pentest-ai is designed to make pentesting fun and efficient. Whether you’re scanning networks or cracking hashes, Korishee is your AI sidekick! 🌟 Questions? Reach out at bandinvisible8@gmail.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pentest_ai-0.1.2.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pentest_ai-0.1.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file pentest_ai-0.1.2.tar.gz.

File metadata

  • Download URL: pentest_ai-0.1.2.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pentest_ai-0.1.2.tar.gz
Algorithm Hash digest
SHA256 11a5c1466b7b23395c7304da7dc39bb37a02baf55063f594e34bb12d0943d2a6
MD5 e28c020172674a9e4ea6d0f7858ce3cd
BLAKE2b-256 887eff12395b572fb9a58abc5de935d3d298ddac5c2535676d0e634864b1ac58

See more details on using hashes here.

File details

Details for the file pentest_ai-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pentest_ai-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pentest_ai-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5284be9a84747cf6c53c9e7f08b7f04e7e6a5597b4f5d28f4082a3187fc55440
MD5 46a69182ddbb0690194fd6ed1ab007f7
BLAKE2b-256 37cdcad64191f721fc9c329ab2bb32e56a1318cad644f855e7e9a5b1d85c3b03

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page