OSFiler is an educational Open Source Intelligence (OSINT) profiling tool that helps researchers create comprehensive profiles of subjects (people, organizations, etc.) by collecting and linking various data points through a graph-based approach.
Open Source Intelligence (OSINT) is the practice of collecting and analyzing information from publicly available sources. It's a crucial skill in various fields including:
- Cybersecurity research and threat intelligence
- Digital forensics and investigations
- Business intelligence and competitive analysis
- Academic research and journalism
- Law enforcement and security operations
OSFiler is designed to help researchers and investigators organize and visualize OSINT data in a structured, graph-based format, making it easier to identify patterns and connections between different pieces of information.
- 📊 Graph-Based Visualization: Create and visualize connections between different data points using an intuitive graph interface
- 🔍 Comprehensive Node System: Support for various node types including persons, organizations, usernames, emails, phone numbers, and more
- 🔄 Modular Design: Extend functionality with custom modules for different OSINT capabilities
- 💾 Data Persistence: Save and manage investigations in a PostgreSQL database
- 🔒 Secure Access: Authentication system to protect your investigations
- 📱 Modern Interface: Clean, responsive UI built with React and TypeScript
OSFiler consists of multiple components working together:
| Component | Description | Technology |
|---|---|---|
| Frontend | Web-based user interface | React, TypeScript |
| Backend | API and business logic | Python, FastAPI |
| Database | Data storage | PostgreSQL |
| Modules | Extensible OSINT capabilities | Python |
For detailed architecture information, see the Architecture Documentation.
OSFiler can be set up in various environments. For detailed installation instructions, see the Setup Guide.
Prerequisites:
- Node.js (v16+)
- Python (v3.12+)
- PostgreSQL (v13+)
- Setup Guide - Installation and configuration
- Module Development Guide - Creating custom OSINT modules
- API Documentation - API endpoints and usage
- Architecture Documentation - System design and components
OSFiler is designed strictly for educational purposes. The creators and maintainers of OSFiler will not be held liable for any unlawful activities conducted using this tool. Users must take full responsibility for their actions and ensure compliance with all applicable laws and regulations.
OSFiler must not be used for:
- Military, offensive, or adversarial operations
- Cyber warfare, espionage, or intelligence gathering
- Unauthorized data collection or privacy violations
- Harassment, stalking, or intimidation
- Any activities that violate local or international laws
By using OSFiler, you agree to:
- Use the tool responsibly and ethically for educational purposes only
- Respect privacy and obtain necessary authorization before data collection
- Comply with all platform terms of service and legal requirements
- Not engage in any form of unauthorized access or data exfiltration
Violation of these guidelines may result in legal actions, access revocation, and reporting to authorities. You acknowledge full responsibility for your actions while using this tool.
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- OSINT Framework: For providing a structured approach to OSINT research
- Sherlock Project: For inspiration on effective username search across platforms
- vis.js: For the powerful graph visualization capabilities
- All the open-source libraries that made this project possible
OSFiler was created to bring a more convenient, graph-based network approach to OSINT research, making it more accessible and powerful for educational purposes and OSINT enthusiasts.
