/DetectIQ

Primary LanguagePythonGNU Lesser General Public License v2.1LGPL-2.1

DetectIQ

DetectIQ is an AI-powered security rule management platform that helps create, analyze, and optimize detection rules across multiple security platforms. It can be used with the provided UI, or just with Python scripts using the self contained detectiq/core module. See examples in the examples directory for more information. Python 3.9+ License: LGPL v2.1 Status: Alpha

⚠️ IMPORTANT DISCLAIMER

This project is currently a Proof of Concept and is under active development:

  • Features are incomplete and actively being developed
  • Bugs and breaking changes are expected
  • Project structure and APIs may change significantly
  • Documentation may be outdated or incomplete
  • Not recommended for production use at this time
  • Security features are still being implemented

We welcome all feedback and contributions, but please use at your own risk!

Quickstart

To get started, run the commands below. For more information, refer to the docs!

Step 1. Clone the repository.

git clone https://github.com/slincoln-aiq/DetectIQ.git

Step 2. Set your environment variables (using .env.example as a template).

cp .env.example .env

Step 3. Run the provided start.sh script and pass install as an argument.

bash start.sh install

Step 4. Run the provided start.sh script and pass run as an argument.

bash start.sh run

Step 5. Use your favorite browser to navigate to http://localhost:3000.

Current Features

AI-Powered Detection

  • Create and optimize detection rules using OpenAI's LLM models
  • Intelligent rule suggestions based on context and best practices
  • Automated rule validation and testing
  • Upload malware samples and PCAP files for static analysis, automatically adding context for YARA and Snort rule creation
  • LLM Rule creation analysis and detection logic returned in the rule creation response

Rule Repository Integration

  • Enhanced by community-tested repositories:
    • SigmaHQ Core Ruleset
    • YARA-Forge Rules
    • Snort3 Community Ruleset
  • Automatically check and update repositories with rule changes
  • Vectorize rules for efficient similarity comparison for more context-aware rule creation engine

Static Analysis Integration

  • Automated file analysis for YARA rules
  • PCAP analysis for Snort rule creation
  • Implicit log analysis for Sigma rule optimization (Explicit Analysis Coming Soon)

Multi-Platform Integration

  • Automatic Sigma rule translation to various SIEM queries using pySigma and SigmAIQ wrapper
  • Seamlessly create Splunk Enterprise Security correlation rules from Sigma rules

Road Map

  • Custom/local LLM models, embeddings, and vector stores
  • More integrations with SIEMs such as Elastic and Microsoft XDR
  • Explicit log analysis for Sigma rule optimization
  • Rule testing and validation
  • Rule searching, e.g. "Do I have a rule in place that can detect this?"
  • Deployment tracking and workflow automation
  • Rule management UI Enhancements
  • Authentication and Authorization
  • Project refactoring for production readiness
  • Chatbot (langchain agents) UI with memory
  • Docker containerization and deployment
  • Rule management without OpenAI requirements
  • More non-webapp examples

Screenshots

Rule Dashboard with Splunk Deployment Option

Rule Dashboard with Splunk Deployment Option Rule Dashboard with Splunk Deployment Option

Sigma Rule Creation

Sigma Rule Creation from threat report snippet Sigma Rule Creation Sigma Rule Creation

YARA Rule Creation

YARA Rule Creation using file analysis from uploaded mimikatz.exe sample YARA Rule Creation YARA Rule Creation

Settings Page

Settings Page Settings Page

About Page

About Page About Page

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

License

This project uses multiple licenses:

  • Core Project: LGPL v2.1
  • Sigma Rules: Detection Rule License (DRL)
  • YARA Rules: YARAForge License
  • Snort Rules: GPL with VRT License

Support & Community

Acknowledgments

  • SigmaHQ Community
  • YARA-Forge Contributors
  • Snort Community
  • OpenAI for GPT-4o Integration