Skip to content

QUICK_START.md

Latest commit

 

History

History
311 lines (221 loc) · 6.29 KB

QUICK_START.md

File metadata and controls

311 lines (221 loc) · 6.29 KB

PluginHunter Quick Start Guide

Get started with PluginHunter in 5 minutes!

Author: LAKSHMIKANTHAN K (letchupkt)
Version: 1.2.1

1. Install (30 seconds)

pip install PluginHunter

2. Verify (10 seconds)

PluginHunter --version

Expected output:

PluginHunter version 1.2.1
Author: LAKSHMIKANTHAN K (letchupkt)

3. First Scan (2 minutes)

Option A: Interactive Menu (Easiest)

PluginHunter

Then:

  1. Select option 1 (Scan WordPress.org Plugin)
  2. Enter plugin slug: hello-dolly
  3. Deep scan? N
  4. Dynamic verification? N
  5. Wait for results

Option B: Command Line (Fastest)

PluginHunter scan --source slug --target hello-dolly

4. View Reports

Reports are saved in your current directory:

ls scan_*.json scan_*.html

Open HTML report in browser:

# Linux
xdg-open scan_hello-dolly_*.html

# macOS
open scan_hello-dolly_*.html

# Windows
start scan_hello-dolly_*.html

5. Next Steps

Scan Your Own Plugin

PluginHunter scan --source local --target /path/to/your/plugin

Enable Deep Scan

PluginHunter scan --source slug --target plugin-name --deep

Set Up Server Mode

PluginHunter
# Select option 7: Server Mode Configuration
# Follow the wizard
# Then select option 8: Start Server Mode

Common Commands

Scan Commands

# WordPress.org plugin
PluginHunter scan --source slug --target plugin-name

# Local directory
PluginHunter scan --source local --target /path/to/plugin

# ZIP file
PluginHunter scan --source zip --target plugin.zip

# GitHub repository
PluginHunter scan --source github --target user/repo

Interactive Menu

PluginHunter

Menu options:

  • 1 - Scan WordPress.org Plugin
  • 2 - Scan Local ZIP File
  • 3 - Scan GitHub Repository
  • 4 - Manage Detection Rules
  • 5 - View Scan History
  • 6 - Configuration Settings
  • 7 - Server Mode Configuration
  • 8 - Start Server Mode
  • 9 - About PluginHunter
  • 0 - Exit

Server Mode

# Configure
PluginHunter
# Select option 7

# Start from menu
PluginHunter
# Select option 8

# Start from command line
PluginHunter server --config server_config.json

Troubleshooting

Command not found

pip install --upgrade PluginHunter
# Restart terminal

Missing dependencies

pip install --upgrade --force-reinstall PluginHunter

Check installation

python3 verify_install.py

Or from menu:

PluginHunter
# Select option 6: Configuration Settings

Example Workflow

Security Researcher

# 1. Install
pip install PluginHunter

# 2. Scan popular plugin
PluginHunter scan --source slug --target contact-form-7 --deep

# 3. Review reports
ls scan_*.html

Plugin Developer

# 1. Install
pip install PluginHunter

# 2. Scan your plugin
PluginHunter scan --source local --target ./my-plugin

# 3. Fix issues
# 4. Scan again

Bug Bounty Hunter

# 1. Install
pip install PluginHunter

# 2. Configure server mode
PluginHunter
# Select option 7, configure Discord/Telegram

# 3. Start continuous scanning
PluginHunter
# Select option 8

# 4. Get notifications when vulnerabilities found

Tips

  1. Use interactive menu for first-time use
  2. Use command line for automation
  3. Enable deep scan for thorough analysis
  4. Check scan history to see past results
  5. Configure server mode for continuous monitoring
  6. Read HTML reports for detailed findings
  7. Use CVE reports for responsible disclosure

Getting Help

Documentation

  • README.md - Complete documentation
  • SERVER_MODE.md - Server mode guide
  • FAQ.md - Frequently asked questions
  • DOCUMENTATION.md - Documentation index

Support

In-App Help

PluginHunter --help
PluginHunter scan --help
PluginHunter server --help

What's Detected?

  • ✅ SQL Injection (SQLi)
  • ✅ Cross-Site Scripting (XSS)
  • ✅ Remote Code Execution (RCE)
  • ✅ Cross-Site Request Forgery (CSRF)
  • ✅ Authentication/Authorization bypass
  • ✅ Server-Side Request Forgery (SSRF)
  • ✅ Insecure File Upload
  • ✅ Insecure Deserialization
  • ✅ Privilege Escalation
  • ✅ IDOR
  • ✅ LFI/RFI

Quick Reference Card

┌─────────────────────────────────────────────────────────┐
│              PluginHunter Quick Reference              │
├─────────────────────────────────────────────────────────┤
│ Install:     pip install PluginHunter                  │
│ Run:         PluginHunter                              │
│ Scan:        PluginHunter scan --source slug \         │
│              --target plugin-name                       │
│ Server:      PluginHunter server \                     │
│              --config server_config.json                │
│ Help:        PluginHunter --help                       │
│ Version:     PluginHunter --version                    │
├─────────────────────────────────────────────────────────┤
│ Reports:     scan_*.json, scan_*.html, scan_*_cve.md    │
│ Config:      server_config.json                         │
│ Logs:        server.log                                 │
└─────────────────────────────────────────────────────────┘

You're ready to start hunting vulnerabilities!

Author: LAKSHMIKANTHAN K (letchupkt)
License: MIT

For complete documentation, see README.md