Skip to content

Stealinglight/Snapshot-Sleuth

Repository files navigation

Snapshot Sleuth

Automated Cloud Forensics and Incident Response Workflow

πŸ“– View Project Portfolio & Technical Case Study

License TypeScript AWS CDK

Overview

Snapshot Sleuth is a comprehensive cloud forensics and incident-response workflow designed to help security teams investigate EBS snapshot-based evidence quickly and consistently. The system orchestrates analysis, runs multiple forensic tools, and publishes evidence and results into durable storage with clear case tracking and notifications.

Key Features

πŸ” Forensic Tool Pipeline

  • YARA - Rule-based detection and pattern matching
  • ClamAV - Malware scanning and virus detection
  • EvidenceMiner - Artifact extraction and classification
  • Log2Timeline - Timeline generation and analysis

πŸ”Œ Pluggable Adapter Layer

  • Case Management - GitHub Issues, Jira, Linear (extensible)
  • Ticketing - GitHub Issues, Jira, Zendesk (extensible)
  • Notifications - Slack, Email, Webhook (extensible)

πŸ“Š Monitoring & Observability

  • CloudWatch dashboards and metrics
  • CloudTrail audit logging
  • Real-time status updates
  • Custom alarms and alerts

🎯 Modern Frontend

  • Case list and detail views
  • Workflow monitoring dashboard
  • Evidence browser with preview
  • Dark mode support
  • Responsive design

Architecture

The project is organized as a TypeScript monorepo using Bun workspaces and Turborepo:

packages/
β”œβ”€β”€ shared/        # Shared types, utilities, and configuration
β”œβ”€β”€ adapters/      # Pluggable adapter layer for integrations
β”œβ”€β”€ cdk/           # AWS CDK infrastructure code
β”œβ”€β”€ lambda-ts/     # TypeScript Lambda functions
β”œβ”€β”€ lambda-py/     # Python Lambda functions (forensic tools)
β”œβ”€β”€ frontend/      # React frontend application
└── demo/          # Demo environment and scenarios

Getting Started

Prerequisites

  • Node.js >= 18.0.0
  • Bun >= 1.0.0
  • AWS CLI configured
  • AWS CDK CLI installed

Installation

# Clone the repository
git clone https://github.com/Stealinglight/Snapshot-Sleuth.git
cd Snapshot-Sleuth

# Install dependencies
bun install

# Build all packages
bun run build

Configuration

Create a configuration file based on your environment:

{
  "environment": "development",
  "projectName": "snapshot-sleuth",
  "aws": {
    "region": "us-east-1",
    "s3BucketPrefix": "snapshot-sleuth"
  },
  "adapters": {
    "caseManagement": {
      "provider": "GITHUB",
      "config": {
        "token": "YOUR_GITHUB_TOKEN",
        "owner": "YOUR_ORG",
        "repo": "YOUR_REPO"
      }
    },
    "notifications": [
      {
        "channel": "SLACK",
        "enabled": true,
        "config": {
          "webhookUrl": "YOUR_SLACK_WEBHOOK"
        }
      }
    ]
  }
}

Deployment

# Deploy CDK stack
cd packages/cdk
bun run cdk deploy

Development

# Start frontend development server
cd packages/frontend
bun run dev

# Watch for changes in shared packages
cd packages/shared
bun run build --watch

Workflow

  1. Snapshot Event - EBS snapshot is shared or identified for investigation
  2. Validation - Snapshot is validated and accessible
  3. Preparation - Snapshot is copied to analysis region if needed
  4. Provisioning - Isolated analysis environment is created
  5. Analysis - Forensic tools run in parallel
  6. Evidence Upload - Results and artifacts uploaded to S3
  7. Notification - Stakeholders notified of completion
  8. Cleanup - Analysis environment cleaned up

Documentation

Demo

The demo package provides one-command deployment with prebuilt scenarios:

  • Malware detection scenario
  • Data exfiltration scenario
  • Privilege escalation scenario
  • Clean baseline scenario

Safety controls include tagging, TTL auto-expiry, and cost estimation/alerts.

Contributing

Contributions are welcome! Please see our Contributing Guide for details.

License

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

Security

For security concerns, please see our Security Policy.

Support

About

An open-source, AWS-native automated EBS snapshot forensics platform that orchestrates end-to-end investigation workflows, runs industry tools, and captures evidence with pluggable case management and notifications.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors