# sepinf-inc/iped architecture

> Architecture diagram of the GitHub repository sepinf-inc/iped, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sepinf-inc/iped
- Repository: https://github.com/sepinf-inc/iped

## Overview

##### Major Components (Modules)
- Core Engine and Processing Module: This is the heart of IPED used for task scheduling, case processing, multithreaded processing, and overall control. Look at the “iped-engine” module which contains definitions for tasks, data sources, indexing, hash database management, file system decoding (via Sleuthkit integration), and report generation.
- Parsers and File Carvers: These modules (found in “iped-parsers” and “iped-carvers”) handle the file content extraction, recursive container expansion, signature analysis and data carving for different file formats. They include parsers for browsers, messaging apps, compressed archives, databases, and others.
- Application and User Interfaces: The “iped-app” module (with its extensive UI packages for case browsing, timeline visualization, graph analysis, bookmarks, and views) and “iped-viewers” provide the front-end and detailed viewers (hex, image, text, etc.) to let end users analyze the processed forensic data.
- Geo Mapping Subsystem: The “iped-geo” module supplies georeferencing and mapping functionalities using different mapping providers (Google Maps, Bing, OpenStreetMaps) as well as specialized code for handling geospatial data.
- Utility and Shared Components: The “iped-utils” module offers common helper functions (I/O handling, file streams, image utilities, time conversion, etc.) and shared libraries for common tasks.
- API and External Integration: There is also an “iped-api” component that likely exposes functionalities (and the “iped-engine” includes the Web API package) for external command line control and eventual remote access in a distributed scenario.

##### Interactions and Data Flow
- Processing Pipeline: The Core Engine dispatches tasks to the Parsers and Carvers components. For example, container expansion, hash calculation, signature analysis and OCR are invoked sequentially or in parallel.
- Data Indexing and Reporting: The Core Engine passes processed metadata and file content to indexing and reporting modules, and there’s an eventual flow towards building results that are consumed by the UI and external APIs.
- Geo Processing: The geo module receives GPS and location metadata from parsed files and then displays results in the mapping UI components, which are part of the overall analysis interface.
- External Tools Integration: Active support for CLI and external tools (like Tesseract for OCR or deep-learning models for nudity/person recognition) should be shown as external services linked to the respective modules.

##### Architectural Patterns and Design Principles
- Pipeline and Task Scheduler Pattern: In the core engine, tasks are scheduled and executed in parallel or in sequence, showing sequential flows that trigger various processing steps.
- Extensibility: Parsers and carvers have been built in a way that allows new file formats to be rapidly integrated. Mark these components with “Extensible Parser Plugins” to denote a plugin-like design.
- Robust Error Handling and Resumability: There’s support for resuming processing (via restart/continue commands), which is an important design principle in forensic processing.

##### Relevant Technologies
- Java JDK 11 and JavaFX (used by the UI components)
- Maven for project organization and dependency management.
- Sleuthkit Library (for file system decoding)
- External libraries for image/video processing, OCR (Tesseract), deep learning (for nudity detection via keras/tensorflow), and graph analysis.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Global Input
    DigitalEvidence["Digital Evidence"]:::input

    %% Core Processing Engine
    EngineCore["Engine/Core Processing"]:::engine

    %% Parsers & Carvers Subgraph
    subgraph "Parsers & Carvers"
        Parsers["Parsers"]:::parser
        Carvers["Carvers"]:::parser
    end

    %% User Interface & Viewers Subgraph
    subgraph "User Interface & Viewers"
        App["IPED App"]:::ui
        Viewers["IPED Viewers"]:::ui
    end

    %% Other Components
    GeoModule["Geo Module"]:::geo
    APIIntegration["API/External Integration"]:::api
    Utilities["Utilities & Shared Libraries"]:::util

    %% Data Flow
    DigitalEvidence -->|"InputData/EvidenceFiles"| EngineCore
    EngineCore -->|"Dispatch:FileDecoding"| Parsers
    EngineCore -->|"Dispatch:CarvingAnalysis"| Carvers
    Parsers -->|"ProcessedMetadata"| EngineCore
    Carvers -->|"ProcessedMetadata"| EngineCore
    EngineCore -->|"Data&CaseResults"| App
    EngineCore -->|"Data&CaseResults"| Viewers
    EngineCore -->|"Remote/APIAccess"| APIIntegration
    EngineCore -->|"GPS/LocationData"| GeoModule

    %% Utilities Support (dotted lines)
    Utilities --- EngineCore
    Utilities --- Parsers
    Utilities --- Carvers
    Utilities --- App
    Utilities --- Viewers
    Utilities --- APIIntegration
    Utilities --- GeoModule

    %% Styles
    classDef engine fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef parser fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef ui fill:#FFC0CB,stroke:#000,stroke-width:2px;
    classDef geo fill:#FFFF99,stroke:#000,stroke-width:2px;
    classDef util fill:#D3D3D3,stroke:#000,stroke-width:2px;
    classDef api fill:#F08080,stroke:#000,stroke-width:2px;
    classDef input fill:#E6E6FA,stroke:#000,stroke-width:2px;

    %% Click Events
    click EngineCore "https://github.com/sepinf-inc/iped/tree/master/iped-engine"
    click Parsers "https://github.com/sepinf-inc/iped/tree/master/iped-parsers"
    click Carvers "https://github.com/sepinf-inc/iped/tree/master/iped-carvers"
    click App "https://github.com/sepinf-inc/iped/tree/master/iped-app"
    click Viewers "https://github.com/sepinf-inc/iped/tree/master/iped-viewers"
    click GeoModule "https://github.com/sepinf-inc/iped/tree/master/iped-geo"
    click Utilities "https://github.com/sepinf-inc/iped/tree/master/iped-utils"
    click APIIntegration "https://github.com/sepinf-inc/iped/tree/master/iped-api"
```
