Repository Statistics

Target Operating Systems

🎥 Presentation

Look at the cinematic trailor I made for this project!

💡 Test the App Online
You can try out OctaProbe directly in your browser by visiting octaprobe.streamlit.app Note: Limited functionality on the testing version!

❓ What is it?

OctaProbe is a lightweight and efficient vulnerability scanner designed to identify security weaknesses in various systems. Built with Python and leveraging modern frameworks like Streamlit, it provides an intuitive interface for users to perform scans and analyze results. OctaProbe supports multiple operating systems, making it a versatile tool for developers, security analysts, and IT professionals.

🚀 How to Install?

Before proceeding, ensure you have a basic understanding of the command line and that Git is installed on your system. If Git is not installed, follow the official Git installation guide. (Not to be confused with GitHub Desktop!)

1. Install uv package manager:

   • Windows:

     powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

   • Linux:

     wget -qO- https://astral.sh/uv/install.sh | sh

⚠️ Note: Restart your terminal emulator so that uv is reflected on your PATH

2. Clone the repository:

   git clone https://github.com/NONAN23x/Octaprobe.git

3. Navigate inside the repository and run uv to sync dependencies (Only if this is your first time running this app!):

   cd Octaprobe

   uv sync

   Uv Sync is just gonna take 1-2 minutes on average, so please be patient

   
   

   • (Optional) Run setup.py with uv to initialize local llm:

     uv run setup.py

     ⚠️ This helper script is responsible for making sure you have properly installed and setup Ollama and Virus Total API

     • If Ollama is not installed or configured, the script will redirect you to the Ollama Documentation for guidance.
     • If a VirusTotal API key is missing, you will be prompted to provide one during setup.

     To set VirusTotalAPI Key:

     • For Windows Go to Search Bar > Environment Variables > Add new variable VIRUSTOTAL_API_KEY
     • For Linux Open up a terminal, add the following to your .bashrc or .zshrc

       export VIRUSTOTAL_API_KEY="Your API Key Here"

3. Run the application:

   uv run streamlit run app.py

   • When running this for the first time, streamlit asks for your email, if you don't wish to provide it, simply leave it blank and hit enter :)
     
     

🤝 Contributing

We welcome contributions from the community! Before you begin, please take a moment to read the CONTRIBUTING.md and ROADMAP.md files in the repository to understand the project's guidelines and future plans.

Note: While I appreciate your interest in contributing, we are unable to accept new feature contributions until July due to ongoing college evaluations. However, you are encouraged to report bugs and open issues in the meantime!