-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated Readme Updated Readme (added compressed demo video) Updated Readme (added compressed demo videos) Updated Readme (removed 1 compressed demo videos) Updated Readme (added 1 compressed demo videos) Updated Readme (added split compressed demo videos) Updated Readme (added chatbot screenshots and setup instructions) Updated Readme (added chatbot screenshots) renamed folder Renamed the readme file Updated Demo Videos and Screenshots Deleted Video and image files
- Loading branch information
1 parent
b5237fb
commit e044488
Showing
2 changed files
with
179 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| <h1 align="center"> | ||
| <a href="https://github.com/CommunityOfCoders/Inheritance2k24/tree/main"> | ||
| COC Inheritance 2024 | ||
| </a> | ||
| </h1> | ||
| <div align="center"> | ||
|
|
||
| # Cybersecurity IDS Project with Suricata and Wazuh | ||
| </div> | ||
| <!-- <hr> --> | ||
|
|
||
| <div align="center"> | ||
| A cybersecurity solution that integrates Suricata IDS with Wazuh for real-time monitoring and a chatbot for user assistance. | ||
| </div> | ||
| <hr> | ||
|
|
||
| <details> | ||
| <summary>Table of Contents</summary> | ||
|
|
||
| - [Description](#description) | ||
| - [Links](#links) | ||
| - [Tech Stack](#tech-stack) | ||
| - [Progress](#progress) | ||
| - [Future Scope](#future-scope) | ||
| - [Applications](#applications) | ||
| - [Project Setup](#project-setup) | ||
| - [Usage](#usage) | ||
| - [Team Members](#team-members) | ||
| - [Mentors](#mentors) | ||
| - [Screenshots](#screenshots) | ||
|
|
||
| </details> | ||
|
|
||
| ## 📝Description | ||
|
|
||
| This project integrates Suricata, a high-performance Network IDS (Intrusion Detection System), with Wazuh, a security monitoring platform. The goal is to detect cyber threats in real-time and provide a graphical user interface (GUI) for easier monitoring and alerts. | ||
|
|
||
| Additionally, a chatbot is built to assist users with cybersecurity-related queries. The chatbot uses NLP to understand and respond to questions about cybersecurity best practices, threat detection, and incident handling. | ||
|
|
||
| ## 🔗Links | ||
|
|
||
| - [GitHub Repository](https://github.com/Ishaan0132/Inheritance) | ||
|
|
||
| ### Demo Videos: | ||
|
|
||
| #### Wazuh Monitoring Recording: | ||
|
|
||
| <video controls src="https://github.com/user-attachments/assets/59765ab6-f5d5-4a52-b6e4-76f77b220828" title="Wazuh Monitoring Demo 1 "></video> | ||
|
|
||
| <video controls src="https://github.com/user-attachments/assets/feb86304-fa73-4e87-9fa8-a11858b4d53e" title="Wazuh Monitoring Demo 2 "></video> | ||
|
|
||
| --- | ||
|
|
||
| **Wazuh Monitoring:** | ||
| This video demonstrates how Wazuh is used for real-time security monitoring and log analysis: | ||
|
|
||
| - It shows how Wazuh collects and analyzes security event logs, including alerts from Suricata IDS. | ||
| - Watch as security incidents are detected and categorized, making it easier to respond to potential threats. | ||
| - The video also highlights how Wazuh provides a user-friendly interface to manage security alerts and track system vulnerabilities. | ||
|
|
||
| --- | ||
|
|
||
| #### Chatbot for User Assistance: | ||
|
|
||
|  | ||
|
|
||
| --- | ||
|
|
||
| ### Chatbot for User Assistance: | ||
| Below is a demonstration of how the chatbot assists users with cybersecurity-related questions in real-time: | ||
|
|
||
| - The chatbot is designed to provide immediate assistance to users by explaining cybersecurity concepts and guiding them through incident response steps based on alerts from Suricata and Wazuh. | ||
| - It helps users interpret Suricata network alerts, like malware or brute-force attacks, and provides real-time responses to questions like "What should I do if my account is compromised?" | ||
| - The chatbot also integrates with Wazuh for providing insights into security events, allowing users to easily understand security logs and take action based on them. | ||
|
|
||
| You can watch the demo video above for a more detailed walkthrough of how the chatbot functions. | ||
|
|
||
| - [Drive Link to the Screenshots ](https://drive.google.com/drive/folders/1rOsX-uGSoFeKzJ0dtLQraqQ6XcWgigs1) | ||
|
|
||
| <!-- - [Hosted Website Link](#) *(If deployed, link to the hosted site)* | ||
| - [Hosted Backend Link](#) *(Link to the hosted backend API here)* --> | ||
|
|
||
| ## 🤖Tech-Stack | ||
| <!-- | ||
| Mention all languages/libraries/frameworks used in your project **domain-wise**. You can use icons too - find them [here](https://github.com/get-icon/geticon) --> | ||
|
|
||
| #### Front-end | ||
| - Wazuh (Security Monitoring) | ||
|
|
||
| #### Back-end | ||
| - Suricata (IDS Integration) | ||
|
|
||
|
|
||
| #### NLP (Chatbot) | ||
| - Machine Learning (ML) | ||
|
|
||
|
|
||
| ## 📈Progress | ||
|
|
||
| ### Fully Implemented Features: | ||
| - Installation of Suricata IDS for detecting network threats. | ||
| - Wazuh integration with Suricata IDS to provide a graphical user interface for monitoring Suricata alerts. | ||
| - A chatbot that answers cybersecurity-related questions and assists users in real-time. | ||
|
|
||
| ### Partially Implemented Features: | ||
| - **Future features could include:** | ||
| - Advanced machine learning-based threat detection models. | ||
| - Integration with more security tools for enhanced monitoring. | ||
|
|
||
| ## 🔮Future Scope | ||
|
|
||
| - Expand the chatbot functionality to support more complex queries related to threat mitigation and security incident handling. | ||
| - IP/URL reputation check | ||
| - Incorporate additional security tools for a more comprehensive monitoring solution. | ||
| - Improve threat detection accuracy using AI/ML models for anomaly detection. | ||
|
|
||
| ## 💸Applications | ||
|
|
||
| - **Network Security:** Helps in real-time detection of intrusions on a network. | ||
| - **User Assistance:** The chatbot provides quick answers to common cybersecurity questions, helping non-expert users. | ||
| - **Security Monitoring:** Wazuh integration allows security analysts to easily monitor the security posture of the system. | ||
|
|
||
| ## 🛠 Project Setup | ||
|
|
||
| The setup instructions for this project are currently being finalized. Please check back soon for a step-by-step guide to get started. | ||
| Thank you for your patience! | ||
| <!-- ```bash | ||
| git clone <url> | ||
| ``` | ||
| 2.Enter the client directory. Install all the required dependencies. | ||
| ```bash | ||
| cd frontend | ||
| npm install | ||
| npm start | ||
| ``` | ||
| 3.To start the backend server:4 | ||
| ```bash | ||
| cd backend | ||
| npm install | ||
| npm start | ||
| ``` --> | ||
|
|
||
| ## 👨💻Team Members | ||
|
|
||
| Add names of your team members with their emails and links to their GitHub accounts | ||
|
|
||
| - [Ayaansh Churi ](https://github.com/AyaanshC) | ||
| - [Ishaan Shaikh ](https://github.com/Ishaan0132) | ||
| - [Kaustubh Sonawne ](https://github.com/Kaustubh6077) | ||
| - [Abhay Varnekar ](https://github.com/Abhay-Varnekar) | ||
|
|
||
| ## 👨🏫Mentors | ||
|
|
||
| Add names of your mentors with their emails and links to their GitHub accounts | ||
|
|
||
| - [Warren Jacinto ](https://github.com/DeadSpheroid) | ||
| - [Yuvraj Karmarkar](https://github.com/Monster230504) | ||
| - [Ishayu Potey](https://github.com/ISH2YU) | ||
|
|
||
| ## 📱Screenshots | ||
|
|
||
| ### Wazuh Dashboard: | ||
|  | ||
|
|
||
| ### Wazuh Overview: | ||
|  | ||
|
|
||
| ### Wazuh Security Logs: | ||
|  | ||
|
|
||
| ### Chatbot Prompt: | ||
|  | ||
|
|
||
| ### Chatbot Prompt: | ||
|  | ||
|
|
||
| ### Chatbot Prompt: | ||
|  |