Skip to content

Nalin7parihar/forensiq

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

45 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ForensIQ πŸ›‘οΈ

ForensIQ Banner

Advanced AI-Powered Cybersecurity Platform for Threat Detection & Analysis

MIT License Python Next.js MITRE ATT&CK FastAPI

πŸš€ Quick Start β€’ πŸ“– Documentation β€’ πŸ› οΈ Features β€’ 🀝 Contributing


🎯 Overview

ForensIQ is a comprehensive, AI-enhanced cybersecurity platform that combines real-time log analysis, MITRE ATT&CK framework integration, and intelligent threat detection into a unified solution. Built for security professionals, incident responders, and SOC teams.

🌟 Why ForensIQ?

  • 🧠 AI-Powered Analysis: Leverages AWS Bedrock Titan embeddings and Google Gemini for intelligent threat detection
  • 🎯 MITRE ATT&CK Integration: Automatic mapping of security events to MITRE ATT&CK techniques
  • ⚑ Real-time Monitoring: Live log extraction from Windows Event Logs with MongoDB storage
  • πŸ–₯️ Modern Web Interface: Next.js-powered dashboard with interactive threat visualization
  • πŸ”§ CLI Tools: Comprehensive command-line interface for automated operations
  • πŸ“Š Advanced Analytics: Vector similarity search using ChromaDB for pattern recognition

πŸ—οΈ Architecture

ForensIQ consists of three main components:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   πŸ–₯️ Client     β”‚    β”‚   πŸš€ Server      β”‚    β”‚  πŸ€– AI Agent   β”‚
β”‚   (Next.js)     │◄──►│   (FastAPI)      │◄──►│   (CLI Tool)    β”‚
β”‚                 β”‚    β”‚                  β”‚    β”‚                 β”‚
β”‚ β€’ Dashboard     β”‚    β”‚ β€’ REST API       β”‚    β”‚ β€’ Log Monitor   β”‚
β”‚ β€’ Threat Viz    β”‚    β”‚ β€’ MITRE Search   β”‚    β”‚ β€’ AI Analysis   β”‚
β”‚ β€’ MITRE Search  β”‚    β”‚ β€’ ChromaDB RAG   β”‚    β”‚ β€’ MongoDB Sync  β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

✨ Features

πŸ” Threat Detection & Analysis

  • Real-time Log Monitoring: Continuous extraction from Windows Security/System Event Logs
  • AI-Powered Classification: Automatic threat severity assessment using Gemini AI
  • MITRE ATT&CK Mapping: Intelligent technique identification and categorization
  • Vector Similarity Search: ChromaDB-powered pattern matching for anomaly detection

πŸ“Š Interactive Dashboard

  • Executive Summary: High-level threat landscape overview
  • Timeline Visualization: Chronological incident tracking
  • MITRE Framework Search: Interactive technique exploration
  • Real-time Alerts: Live threat notification system

πŸ› οΈ CLI & Automation

  • One-time Authentication: Secure credential management with encryption
  • Profile-based Monitoring: Customizable log source configurations
  • Scheduled Analysis: Automated 5-minute interval processing
  • Export Capabilities: JSON/CSV report generation

πŸ” Security & Integration

  • Encrypted Storage: PBKDF2 + Fernet encryption for sensitive data
  • MongoDB Integration: Scalable log storage and retrieval
  • AWS Bedrock: Enterprise-grade AI/ML capabilities
  • RESTful API: Easy integration with existing security tools

πŸš€ Quick Start

Prerequisites

  • Python 3.7+
  • Node.js 18+
  • MongoDB (local or cloud)
  • AWS Account (for Bedrock access)

1️⃣ Clone the Repository

git clone https://github.com/Vaibhav2154/forensiq.git
cd forensiq

2️⃣ Set Up the AI Agent CLI

cd aiagent
pip install -e .

# Register and authenticate
forensiq-cli auth register --username your_username --email your_email
forensiq-cli auth login --username your_username

3️⃣ Configure Monitoring Profile

# Set up dynamic Windows Event Log monitoring
forensiq-cli profile setup-dynamic --sources security_events,system_events --interval 300

# Or file-based monitoring
forensiq-cli profile setup --log-path "C:\path\to\logs" --interval 300

4️⃣ Start the Backend Server

cd ../server
pip install -r requirements.txt

# Configure environment variables
cp .env.example .env
# Edit .env with your AWS credentials and MongoDB connection

# Start the server
python main.py

5️⃣ Launch the Web Dashboard

cd ../client
npm install
npm run dev

6️⃣ Begin Monitoring

cd ../aiagent

# Start real-time monitoring
forensiq-cli monitor --dynamic

# Or schedule automated analysis
forensiq-cli monitor --schedule

πŸŽ‰ You're ready! Access the dashboard at http://localhost:3000

πŸ“– Documentation

Component Description Link
πŸ€– AI Agent CLI tool usage and automation CLI User Guide
πŸš€ Server API Backend setup and deployment Deployment Guide
🎯 MITRE Integration ATT&CK framework usage MongoDB Retrieval Guide
πŸ“Š Monitoring Real-time log analysis Dynamic Monitoring Guide

πŸ› οΈ Development

Project Structure

forensiq/
β”œβ”€β”€ πŸ€– aiagent/          # CLI tool and AI agent
β”‚   β”œβ”€β”€ cli_tool.py      # Main CLI interface
β”‚   β”œβ”€β”€ ai_agent.py      # AI analysis engine
β”‚   └── mongodb_service.py # Database operations
β”œβ”€β”€ πŸš€ server/           # FastAPI backend
β”‚   β”œβ”€β”€ main.py          # API server
β”‚   β”œβ”€β”€ services/        # AI and database services
β”‚   └── routers/         # API endpoints
β”œβ”€β”€ πŸ–₯️ client/           # Next.js frontend
β”‚   β”œβ”€β”€ app/             # App router pages
β”‚   β”œβ”€β”€ components/      # React components
β”‚   └── hooks/           # Custom hooks
└── πŸ“„ docs/             # Documentation

πŸ§ͺ Running Tests

# Test AI Agent
cd aiagent
python test_complete_functionality.py

# Test MongoDB integration
python test_mongodb.py

# Test server endpoints
cd ../server
python test_aws_bedrock.py
python test_rag.py

πŸ› Debug Mode

Enable detailed logging:

# CLI with verbose output
forensiq-cli monitor --dynamic --verbose

# Server with debug mode
cd server
uvicorn main:app --reload --log-level debug

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

🎯 Areas We Need Help

  • Additional Log Sources: Support for Linux/macOS logs
  • Custom MITRE Techniques: User-defined detection rules
  • ML Model Training: Enhanced threat classification
  • API Integrations: SIEM platform connectors
  • Performance Optimization: Large-scale log processing

πŸ› Reporting Issues

Found a bug? Please open an issue with:

  • Detailed description
  • Steps to reproduce
  • Expected vs actual behavior
  • System environment details

πŸ“Š Roadmap

🎯 Version 1.1 (Q4 2025)

  • Multi-platform log support (Linux/macOS)
  • Custom detection rule engine
  • Advanced ML threat scoring
  • SIEM integration APIs

πŸš€ Version 2.0 (Q1 2026)

  • Distributed analysis cluster
  • Real-time threat intelligence feeds
  • Advanced visualization dashboard
  • Enterprise SSO integration

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

  • MITRE Corporation for the ATT&CK framework
  • AWS Bedrock for AI/ML capabilities
  • Google Gemini for advanced language processing
  • ChromaDB for vector similarity search
  • FastAPI and Next.js communities

πŸ”— Links


⭐ Star this repository if ForensIQ helps secure your environment!

GitHub stars GitHub forks

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •