How barkahss/ominis-osint works
Main Components
• Core Script / Entry Point: The primary executable is “ominis.py” (with “ominis.sh” as a helper for convenience). This serves as the user interface (CLI) that triggers the tool’s operations.
• Modular Logic in “src” Directory:
• config.py: Manages configuration data (e.g., SerpAPI keys and other settings).
• proxy_handler.py: Handles proxy validation and now uses aiohttp for asynchronous web requests.
• serp_search.py: Facilitates Google search operations and integrates with SerpAPI.
• tools_handler.py and usr.py: Orchestrate various OSINT search tasks like username searches over a list of URLs.
• utils.py: Provides commons utilities that support operations across modules.
• Auxiliary Files (social_platforms.json and urls.txt): Supply configuration data such as target social platforms and a list of search URLs.
• Resources:
• img assets and video files (in src/img) illustrate user interface design but might be less critical from an architectural perspective.
• Infrastructure & Automation:
• Dockerfile: Indicates containerization for deployment.
• Multiple GitHub Actions workflows (defined under .github/workflows) that automate tasks like web search, username search, and the overall “Ominis Search” process.
• Installation Scripts:
• The inclusion of install.bat, install.sh, installer.nsi, setup.iss, and setup.py shows support for different operating systems and installation mechanisms.
Relationships and Data Flow
• The primary executable (ominis.py) receives user invocation and coordinates the entire workflow.
• It loads configurations from src/config.py and reads input URLs from src/urls.txt.
• The tool then passes data to specialized modules:
• serp_search.py for processing search queries and handling API requests.
• proxy_handler.py to verify and use proxies for executing requests securely.
• usr.py and tools_handler.py to handle username searches across a predefined set of websites (as configured in social_platforms.json).
• The modules use asynchronous calls (via aiohttp) and optimized threading to perform concurrent tasks.
• Processed results are collated and eventually output (detailed results, HTTP status codes) back to the user.
Architectural Patterns & Design Principles
• Modular Design: Although it is a single application, the clear subdivision in the “src” folder emphasizes separation of concerns.
• Asynchronous & Concurrent Execution: The use of aiohttp and threading optimization is significant—this should be depicted to show non-blocking IO and parallel searches.
• External Integration: Represent integration with external services like Google Search and SerpAPI, illustrating the exchange of data between the internal modules and these external endpoints.
Final Checklist
• Clear labels for each component (e.g., “Core Engine”, “Proxy Module”, “SerpAPI Integration”).
• That any dependencies (like asynchronous operations with aiohttp) are noted next to the corresponding module.
• Annotations that mention the asynchronous/threaded design and container/CI integration aspects.