Rithvickkr
commited on
Commit
·
0c9db1d
1
Parent(s):
8a11841
Initial deployment with app, requirements, license, and README fix
Browse files
README.md
CHANGED
@@ -1,90 +1,14 @@
|
|
1 |
-
|
2 |
-
title:
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
|
13 |
-
|
14 |
-
|
15 |
-
🌟 Features
|
16 |
-
|
17 |
-
Chatbot Interface: Interact with an AI "Security Analyst" to analyze suspicious logs or alerts.
|
18 |
-
Threat Analysis: Uses DSATP’s mock threat detection (currently sentiment-based, soon LLM-driven) to assess risks.
|
19 |
-
JSON Outputs: Displays threat severity scores and remediation suggestions in a structured format.
|
20 |
-
MCP Compatibility: Exposes DSATP functions as MCP tools for agentic LLM integration.
|
21 |
-
Planned Enhancements (in progress):
|
22 |
-
File upload for log parsing and YARA-based malware scanning.
|
23 |
-
Network topology graph visualizing DSATP’s peer-to-peer swarm.
|
24 |
-
Real-time threat severity charts.
|
25 |
-
Dark-themed, high-tech cybersecurity UI.
|
26 |
-
|
27 |
-
|
28 |
-
|
29 |
-
🛠️ Setup
|
30 |
-
Prerequisites
|
31 |
-
|
32 |
-
Python 3.10+
|
33 |
-
Git
|
34 |
-
Hugging Face account (for Spaces deployment)
|
35 |
-
|
36 |
-
Local Installation
|
37 |
-
|
38 |
-
Clone the repository:git clone https://huggingface.co/spaces/YOUR_USERNAME/ai-cybersecurity-agent
|
39 |
-
cd ai-cybersecurity-agent
|
40 |
-
|
41 |
-
|
42 |
-
Create and activate a virtual environment:python -m venv venv
|
43 |
-
source venv/bin/activate # On Windows: venv\Scripts\activate
|
44 |
-
|
45 |
-
|
46 |
-
Install dependencies:pip install -r requirements.txt
|
47 |
-
|
48 |
-
|
49 |
-
Run the app:python app.py
|
50 |
-
|
51 |
-
|
52 |
-
Open http://localhost:7860 in your browser to test the app.
|
53 |
-
|
54 |
-
Hugging Face Spaces
|
55 |
-
The app is deployed on Hugging Face Spaces at: YOUR_SPACE_URL (update with your Space URL after deployment). Simply visit the URL to interact with the chatbot and test threat detection.
|
56 |
-
📖 Usage
|
57 |
-
|
58 |
-
Open the Gradio app (locally or on Hugging Face Spaces).
|
59 |
-
Enter a log message or alert in the textbox (e.g., “Critical error: Unauthorized access detected in server logs. System compromised!”).
|
60 |
-
Click Analyze to receive a threat analysis from the Security Analyst.
|
61 |
-
View the conversation in the chatbot and detailed results in the JSON output.
|
62 |
-
|
63 |
-
Example Inputs:
|
64 |
-
|
65 |
-
Positive: The system is running smoothly with no errors detected. All services are operational.
|
66 |
-
Negative: Critical error: Unauthorized access detected in server logs. System compromised!
|
67 |
-
Neutral: System log entry: User logged in at 14:30. No further details available.
|
68 |
-
|
69 |
-
🔐 License
|
70 |
-
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
|
71 |
-
🤝 Contributing
|
72 |
-
We welcome contributions! Please:
|
73 |
-
|
74 |
-
Fork the repository.
|
75 |
-
Create a feature branch (git checkout -b feature-name).
|
76 |
-
Commit changes (git commit -m 'Add feature').
|
77 |
-
Push to the branch (git push origin feature-name).
|
78 |
-
Open a Pull Request.
|
79 |
-
|
80 |
-
For issues or suggestions, open an issue on the Space repository.
|
81 |
-
🙌 Acknowledgments
|
82 |
-
|
83 |
-
DSATP for the open-source cybersecurity framework.
|
84 |
-
Hugging Face for hosting and Gradio for the intuitive UI framework.
|
85 |
-
The Gradio/Hugging Face Hackathon for inspiring this project.
|
86 |
-
|
87 |
-
📬 Contact
|
88 |
-
For questions or feedback, reach out via the Hugging Face Space or open an issue.
|
89 |
-
|
90 |
-
Happy hacking, and stay secure! 🔒
|
|
|
1 |
+
---
|
2 |
+
title: Ai Cybersecurity Agent
|
3 |
+
emoji: 👀
|
4 |
+
colorFrom: green
|
5 |
+
colorTo: gray
|
6 |
+
sdk: gradio
|
7 |
+
sdk_version: 5.32.1
|
8 |
+
app_file: app.py
|
9 |
+
pinned: false
|
10 |
+
license: apache-2.0
|
11 |
+
short_description: AI Cybersecurity Agent is an intelligent threat detection ch
|
12 |
+
---
|
13 |
+
|
14 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|