How manisso/fsociety works
Project type and purpose
• This is a CLI-based penetration-testing framework aggregator (“Fsociety Hacking Tools Pack”) written in Python 2.7.
• It provides a unified menu (fsociety.py) to launch dozens of third-party security tools (nmap, sqlmap, Reaver, etc.).
• It can be installed via install.sh, packaged as a Snap, or run inside Docker (Dockerfile + docker-compose.yml).
File structure
• Top-level scripts
• fsociety.py – the main menu/CLI entry point
• fsociety.cfg – configuration file (settings, tool paths)
• install.sh / update.sh / uninstall – installation lifecycle scripts
• Containerization/packaging
• Dockerfile + docker-compose.yml – build and run inside a container
• snap/snapcraft.yaml – Snap package metadata
• Documentation
• docs/ – static site (HTML/CSS/fonts) for project docs
• CI and contribution
• CODE_OF_CONDUCT.md, CONTRIBUTING.md, ISSUE_TEMPLATE.md
• LICENSE, .gitignore
README for additional insights
• Lists categories of tools (Information-Gathering, Password Attacks, Wireless, Exploitation, etc.)
• Describes install options (native, Termux, Docker, Snap)
• No internal database or web API – strictly a CLI wrapper for external binaries
Main components
a. User Interface Layer
• Terminal / Shell
• fsociety.py (CLI menu & input parser)
b. Configuration Layer
• fsociety.cfg (loads settings: tool paths, flags)
• Environment variables (optional overrides)
c. Dispatcher / Core Logic
• Menu engine (select category → tool module)
• Tool wrappers (Python modules or inline calls that invoke external commands)
d. External Tools Layer
• Third-party executables: nmap, sqlmap, reaver, etc.
• System dependencies (Python 2.7 runtime)
e. Packaging & Deployment
• Native installer (install.sh script)
• Docker container (Dockerfile → image, docker-compose.yml)
• Snap package (snapcraft.yaml)
f. Documentation Site (auxiliary)
• docs/index.html + static assets
Relationships and interactions
• User → (enters commands) → fsociety.py
• fsociety.py → (reads) → fsociety.cfg
• fsociety.py → (invokes) → dispatcher/core logic
• Dispatcher → (spawns) → tool wrappers (Python subprocess)
• Tool wrappers → (executes) → external tool binaries → (returns) → stdout/stderr
• fsociety.py → (formats & displays) → results in terminal
• Installer scripts → (copy files, set permissions, configure environment) → Local host
• Dockerfile → (builds) → Container image embedding code + Python runtime
• Snapcraft.yaml → (packages) → Snap
Architectural patterns and design principles
• Modular design: CLI core separated from tool wrappers
• Adapter/Facade pattern: each external tool accessed via a uniform interface
• Single responsibility: installer scripts handle installation, Dockerfile handles containerization, Snapcraft handles packaging
• Configuration-driven: fsociety.cfg abstracts tool paths & flags
• Clear, textual labels (fsociety.py, fsociety.cfg, install.sh, Dockerfile, snapcraft.yaml)
• Arrowheads on each connector to denote invocation or data flow
• Notes on runtime environment (Python 2.7 interpreter, OS support: Linux, macOS, Windows, Android/Termux)
Detail without over-splitting
• Every deployment path (native, Docker, Snap)
• Installer scripts as orchestrators that invoke filesystem changes and dependencies