## https://sploitus.com/exploit?id=47869B8D-2FB4-58A6-A323-867B1ABCA5E7
# Obsidian Framework ๐ก๏ธ
**An advanced, template-driven security framework built in Python.**
---
๐ Table of Contents
About The Project
Key Features
Installation
Getting Started
Usage Examples
Contributing
License
---
## ๐ About The Project
**Obsidian** is a powerful and flexible security framework designed for penetration testers and cybersecurity professionals. It automates and simplifies various stages of security assessments, from reconnaissance to vulnerability scanning, using a powerful template-driven engine inspired by tools like Nuclei.
---
## โจ Key Features
- **๐ Template-Driven Scanning:** Use simple YAML-based templates to run complex security checks.
- **๐ Comprehensive Reconnaissance:** Automate discovery of subdomains, open ports, and web technologies.
- **๐ก๏ธ Vulnerability Scanning:** Detect common vulnerabilities like XSS, SQLi, and misconfigurations.
- **๐งฉ Modular & Extensible:** Easily add new modules and templates for custom security tasks.
- **๐ค Security Automation:** Chain different modules together to create powerful automation workflows.
- **๐ Flexible Output:** Generate reports in various formats (JSON, TXT, etc.).
---
## โ๏ธ Installation
To get a local copy up and running, follow these simple steps.
### Prerequisites
- Python 3.9 or higher
- pip
### Steps
1. **Clone the repository:**
```sh
git clone https://github.com/F9-0/Obsidian-Framework.git
cd Obsidian-Framework
```
2. **Create and activate a virtual environment (Recommended):**
```sh
# For Windows
python -m venv venv
.\venv\Scripts\activate
# For macOS/Linux
python3 -m venv venv
source venv/bin/activate
```
3. **Install the required dependencies:**
```sh
pip install -r requirements.txt
```
---
## ๐ Getting Started
Here's a basic example of how to run a simple port scan on a target.
```sh
python obsidian.py --target example.com --template port-scan.yaml
```
---
## ๐ Usage Examples
**Example 1: Run all reconnaissance templates against a target.**
```sh
python obsidian.py -t example.com -d templates/recon/
```
**Example 2: Scan a list of URLs for common vulnerabilities.**
```sh
python obsidian.py -l urls.txt -t templates/vulnerabilities/cves/
```
---
## ๐ค Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
---
## ๐ License
Distributed under the MIT License. See `LICENSE` file for more information.