AI2PentestTool - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #go #machine-learning #docker #windows #kubernetes #vue #security #pytorch #open-source

AI2PentestTool

(★ 118)

Use AI to install penetration testing tool suites in one click.

File Explorer

Download Latest Version (.zip)

.gitignore
ai_agent.py
config.py
LICENSE
main.py
README.md
requirements.txt
tool_installer.py

# Installation Guide

1. Get the code

git clone https://github.com/penligent/AI2PentestTool

Downloads the entire project code from GitHub to your computer.

cd AI2PentestTool

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Penligent.ai - AI2PentestTool

200+ Seamless Integrations with Leading Security & Pentesting Tools

Our AI pentesting platform, powered by Peligent.ai, delivers over 200+ tool integrations to streamline your entire security testing workflow. With built-in support for the most trusted AI pentest tools, you can run reconnaissance, vulnerability scanning, and exploitation directly—without leaving our unified console.

Whether you’re a security engineer, penetration tester, or red team operator, our AI pentesting automation allows you to launch, control, and manage industry-standard tools with ease.

# AI2PentestTool
Use AI to install penetration testing tool suites in one click.

# 🚀 AI Penetration Testing Tool Auto Installer

An intelligent penetration testing tool automatic installation system based on true Agent paradigm, supporting AI intelligent installation, retry mechanisms, error recovery, and complete logging.

## 📋 Project Introduction

This is a professional penetration testing tool automatic installer designed with AI Agent architecture that can intelligently analyze system environments, automatically generate installation plans, and perform intelligent recovery when encountering errors. The system runs entirely based on built-in configurations and works stably and reliably whether AI service support is available or not.

## ✨ Core Features

### 🤖 AI Intelligent Installation
- **Large Model Driven**: Integrated with OpenAI GPT-4 to generate personalized installation plans
- **Intelligent Retry**: Automatically retry 3 times with 2-second intervals when AI queries fail
- **Automatic Downgrade**: Automatically use built-in predefined plans when AI service is unavailable
- **Error Analysis**: AI analyzes installation errors and provides targeted solutions

### 🛡️ Robust Error Handling
- **Network Error Recovery**: Automatic handling of SSL connection failures, DNS resolution errors, etc.
- **Multi-layer Backup Plans**: AI plan → Predefined plan → Backup commands → Manual guidance
- **User Interaction**: Ask users whether to skip or retry when failures occur
- **Complete Recording**: All operations and errors are recorded in log files

### 🎯 Flexible Installation Modes
- **Single Tool Installation**: Install a specified single tool
- **Batch Installation**: One-click installation of 15 core penetration testing tools
- **Custom Installation**: Batch installation by reading tool list from file
- **Tool Management**: View supported tools and installed tools

### 🌍 Cross-platform Support
- **macOS**: Using Homebrew package manager
- **Linux**: Using APT package manager (Ubuntu/Debian)
- **Windows**: Providing download links and installation guidance

## 🔧 Supported Tools (15 tools)

### 🌐 Network Scanning
- **nmap**: Network discovery and security audit tool
- **masscan**: Fast port scanner

### 🔍 Information Gathering
- **dig**: DNS query tool
- **whois**: Domain information query tool
- **amass**: Subdomain enumeration tool
- **theHarvester**: Email and domain collection tool

### 🌐 Web Application Testing
- **gobuster**: Directory/file brute-force tool
- **sqlmap**: Automated SQL injection tool
- **dirsearch**: Web path scanner
- **wfuzz**: Web application fuzzing tool
- **nikto**: Web server scanner

### 🖥️ Network Tools
- **curl**: HTTP client tool
- **netcat**: Network toolkit
- **traceroute**: Route tracing tool

### 🔐 SSL/TLS Testing
- **sslyze**: SSL/TLS configuration analysis tool

## 🚀 Quick Start

### 1. Environment Setup
```bash
# Clone project
git clone https://github.com/penligent/AI2PentestTool.git
mkdir tools-new
cd tools-new

# Install Python dependencies
pip install -r requirements.txt

# Set OpenAI API key (optional, will use predefined installation plan if not set)
export OPENAI_API_KEY="your-api-key-here"
```

### 2. Basic Usage

#### View supported tools
```bash
python main.py show-tools
```

#### Install single tool
```bash
python main.py install nmap
```

#### Batch install all tools
```bash
python main.py install-default
```

#### Install tools from file
```bash
# Create tool list file
echo -e "nmap\ncurl\nsqlmap" > my_tools.txt

# Install from file
python main.py install-file my_tools.txt
```

#### View installed tools
```bash
python main.py list
```

## 📁 Project Structure

```
tools-new/
├── ai_agent.py         # AI agent and retry mechanisms
├── config.py           # Configuration management and tool information definition
├── main.py             # Command line entry program
├── tool_installer.py   # Installation logic and error handling
├── requirements.txt    # Python dependency package list
├── logs/               # Installation logs (automatically created)
└── tools_config.json   # Installed tools configuration (automatically generated)
```

## 🔧 Configuration System

### Core Configuration File (config.py)
All tool configurations in the project are centralized in the `TOOLS_INFO` dictionary in the `config.py` file, including:

```python
TOOLS_INFO = {
    "nmap": {
        "name": "nmap",
        "description": "Network discovery and security audit tool",
        "macos": "brew install nmap",
        "linux": "apt update && apt install -y nmap", 
        "windows": "https://nmap.org/download.html",
        "verify_command": "nmap --version",
        "category": "Network Scanning"
    },
    # ... other 14 tool configurations
}
```

### Custom Installation Plans
You can modify the `config.py` file to:
- **Add New Tools**: Add new tool definitions in `TOOLS_INFO`
- **Modify Installation Commands**: Update installation methods for existing tools
- **Adjust Tool Categories**: Modify tool category classifications
- **Update Verification Commands**: Customize post-installation verification methods

#### Example of Adding New Tool
```python
"your_tool": {
    "name": "your_tool", 
    "description": "Tool description",
    "macos": "brew install your_tool",
    "linux": "apt install -y your_tool",
    "windows": "https://download-link.com",
    "verify_command": "your_tool --version",
    "category": "Tool Category"
}
```

## 🔄 Workflow

### AI Mode (Recommended)
```
Set API Key → AI Analyze Environment → Generate Installation Plan → Execute Commands → Verify Installation → Record Results
```

### Offline Mode (No API Key)
```
System Detection → Use Predefined Plan → Execute Commands → Verify Installation → Record Results
```

### Error Handling Process
```
Installation Failed → Error Analysis → Try Backup Plan → User Choice → Continue/Skip
```

## 🚨 Error Handling Mechanisms

### Network Errors
- **SSL Connection Failure**: Automatically try HTTP sources or mirror sites
- **DNS Resolution Failure**: Use backup DNS or direct IP access
- **Connection Timeout**: Increase timeout and retry

### Installation Errors
- **Package Manager Lock**: Wait for lock release and retry
- **Dependency Conflicts**: Provide virtual environment isolation solutions
- **Insufficient Permissions**: Intelligently prompt to use sudo privileges

### AI Service Errors
- **API Call Limits**: Automatically retry 3 times with increasing intervals
- **Network Connection Issues**: Downgrade to predefined installation plans
- **Response Format Errors**: Try parsing or use backup plans

## 📊 Logging System

### Log File Management
- **Location**: `./logs/` directory (under current working directory)
- **Naming**: `installation_YYYYMMDD_HHMMSS.log`
- **Content**: Detailed installation process, error information, user operation records

### Log Levels
- **INFO**: Normal installation process and status information
- **WARNING**: Potential issues and warning prompts
- **ERROR**: Installation errors and exception conditions

### Configuration File
- **Location**: `./tools_config.json` (current directory)
- **Content**: Detailed information of installed tools, including path, description, installation time, etc.

## ⚙️ Environment Configuration

### Required Configuration
- **Python 3.7+**: Runtime environment requirement
- **Network Connection**: For downloading tools and AI services

### Optional Configuration
- **OPENAI_API_KEY**: OpenAI API key (improves installation success rate)
- **Package Manager**: Homebrew (macOS) or APT (Linux)

### System Adaptation
```python
# Automatically detect operating system
OS_TYPE = platform.system().lower()  # darwin, linux, windows
OS_VERSION = platform.version()      # System version information
```

## 🛡️ Security Features

### Command Security
- **Pre-validation**: Verify security of all installation commands before execution
- **Permission Check**: Intelligently detect required permissions and prompt users
- **Input Validation**: Strictly validate all user inputs and parameters

### Audit Functions
- **Operation Recording**: Complete recording of all installation operations and commands
- **Error Tracking**: Detailed error stacks and diagnostic information
- **Configuration Backup**: Automatic backup of tool configuration status

## 🔧 Advanced Features

### Batch Operations
```bash
# Create custom tool list
cat > custom_tools.txt << EOF
nmap
sqlmap
gobuster
nikto
EOF

# Batch installation
python main.py install-file custom_tools.txt
```

### Configuration Viewing
```bash
# View all supported tools
python main.py show-tools

# View installed tool status
python main.py list

# View configuration details
python -c "from config import Config; print(Config.TOOLS_INFO)"
```

## 🐛 Troubleshooting

### Common Issues

#### 1. AI Query Failure
```bash
# Check API connection
curl -I https://api.openai.com

# Verify API key
echo $OPENAI_API_KEY

# View detailed logs
tail -f logs/installation_*.log
```

#### 2. Permission Issues
```bash
# Use administrator privileges
sudo python main.py install <tool>

# Or install to user directory
python main.py install <tool>
```

#### 3. Package Manager Issues
```bash
# macOS - Install/update Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Linux - Update package manager
sudo apt update && sudo apt upgrade

# Check package manager status
brew doctor  # macOS
apt list --upgradable  # Linux
```

#### 4. Network Connection Issues
```bash
# Test network connectivity
ping google.com

# Check DNS resolution
nslookup brew.sh

# Use proxy (if needed)
export https_proxy=http://proxy:port
```

## 📈 Project Advantages

- **🎯 Zero Dependencies**: Based on built-in configuration, no external file dependencies
- **🤖 Intelligence**: AI-driven personalized installation plans
- **🛡️ High Reliability**: Multi-layer error handling and backup plans
- **🌍 Cross-platform**: Complete multi-operating system support
- **📊 Observable**: Detailed logging and status tracking
- **🔧 Easy Extension**: Simple configuration files to add new tools

## 💡 Best Practices

1. **First Use**: Recommend setting OpenAI API key for best experience
2. **Network Environment**: Ensure stable network connection, system will automatically handle temporary failures
3. **Permission Management**: Use administrator privileges reasonably according to prompts
4. **Log Monitoring**: Regularly check log files to understand system status
5. **Configuration Backup**: Recommend backing up tools_config.json configuration in important environments

## 📚 Technical Architecture

### Core Components
- **AIAgent**: Responsible for interacting with OpenAI API and retry logic
- **ToolInstaller**: Handle tool installation, verification, and configuration management
- **Config**: Centralized configuration management and tool definition
- **Main Program**: Command line interface and user interaction

### Design Philosophy
- **Agent Paradigm**: True intelligent agent architecture
- **Fault Tolerance First**: Multi-layer backup plans ensure high availability
- **User Friendly**: Clear feedback and interaction design
- **Security First**: Strict validation and permission control

---

🎯 **Start using this powerful AI penetration testing tool auto installer now, let intelligence provide convenience for your security testing work!**