# blackorbird/apt_report architecture

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

- Interactive diagram: https://gitdiagram.com/blackorbird/apt_report
- Repository: https://github.com/blackorbird/apt_report

## Overview

##### Project’s Purpose and Type
- Purpose: This repository curates an extensive library of threat intelligence materials—PDFs, XLSX files, source code (e.g., YARA rules, Python scripts), and research reports—for various APT groups. The README even highlights sample entries (e.g., Group123, kimsuky, Lazarus) and provides related links.
- Type: Rather than a runtime application, it is an “intelligence collection system” organized as a file system, grouping threat actor reports by country or campaign, with supporting analysis tools, sample code, and data files. Its “architecture” is the logical organization of directories and subdirectories that encapsulate different threat actor groups and associated content.

##### File Structure
- Top-Level Categories: Notice many directories named after security themes or threat actor groups (e.g., AISecurity, APT-hunting, APT28, APT29, etc.). There are also directories such as “data”, “exploit_report”, “Tools”, and “summary” that store auxiliary materials.
- Grouping and Hierarchy:
– Each threat actor-related directory (for instance, “APT28”, “APT41”, “Lazarus”, etc.) contains reports, YARA signatures, sample scripts, and README files that provide contextual information and further links.
– Some directories include subfolders (like “fn_fuzzy” inside “APT-hunting” or further subdirectories under international strategic reports) which indicate that every threat actor or campaign has its own nested collection.
- Supporting Files: The presence of configuration elements (like README.md files) and analysis tools (Python scripts such as “fn_fuzzy.py”, “zebrocy_decrypt_artifact.py”, etc.) shows that while the repository is static, it contains components to perform preliminary processing or to yield insights.

##### README
- The README at the top level clarifies that the collection was curated by @blackorbird and includes sample APT reports with references. It also supplies external links to trusted threat intel sources.
- This global document sets the stage for the repository’s scope—it is both an archival repository and a reference index for different APT campaigns and groups.

a. Main Components:
– Repository Container (“APT Intelligence Repository”): This is the high-level “system” that holds all subcomponents.
– Group-Based Directories: Each folder named after an APT group or a threat intelligence category (e.g., APT28, APT29, Lazarus, Oceanlotus) serves as a module that encapsulates data for that threat actor.
– Analysis & Tools Modules: Directories or submodules such as “fn_fuzzy” in APT-hunting, “Tools/Builder”, and sample code files represent the analytic and automation side.
– Data & Reports: Folders like “data”, “exploit_report”, and “summary” hold structured data files, spreadsheets, and multi-format reports.
– Reference and Tracking: Files such as “_In the Wild_.xlsx” and various research PDFs offer meta-information and background on threat actors.

b. Establish Relationships and Data Flow:
– Indicate that within each group’s directory, the documentation (e.g., README, PDFs, YARA rules, scripts) feed into a unified analysis process.
– Highlight “external interactions”: For instance, the README’s links and references should be noted as inputs that correlate online threat intel with locally stored documents.

c. Architectural Patterns:
– Hierarchical/Modular Organization: The design follows a clear folder hierarchy; each threat actor’s directory is a self-contained module.
– Documentation Coupled with Artifacts: Every module includes descriptive README files (good documentation practice) coupled with data files and scripts.
– Data Separation: Notice the separation between static reports, analysis scripts, and raw data files—each is in its designated folder.

d. Relevant Technologies and File Types:
– File Formats: PDF, XLSX, MD, Python scripts, YARA rule files.
– Tooling: Although not an application server, the presence of scripts indicates potential use of automation tools and static analysis (e.g., Python-based forensic automation).

## Diagram (Mermaid)

```mermaid
flowchart TD
    APT_INT("APT Intelligence Repository"):::repo

    subgraph "Threat Actor Groups"
        APT28("APT28"):::group
        APT29("APT29"):::group
        Lazarus("Lazarus"):::group
        kimsuky("kimsuky"):::group
    end

    subgraph "Analysis & Tools"
        APT_Hunting("APT-hunting"):::tool
        Fn_Fuzzy("fn_fuzzy"):::tool
        Tools_Builder("Tools/Builder"):::tool
    end

    subgraph "Data & Reports"
        Data_Files("Data Files"):::data
        Exploit_Reports("Exploit Reports"):::data
        Summaries("Summaries & Reports"):::data
    end

    subgraph "Reference Documents"
        Global_Spreadsheet("0day _In the Wild_.xlsx"):::ref
        APT_Operations("APT Groups and Operations.xlsx"):::ref
    end

    APT_INT -->|"contains"| APT28
    APT_INT -->|"contains"| APT29
    APT_INT -->|"contains"| Lazarus
    APT_INT -->|"contains"| kimsuky

    APT_INT -->|"includes"| APT_Hunting
    APT_Hunting -->|"contains"| Fn_Fuzzy
    APT_INT -->|"provides"| Tools_Builder

    APT_INT -->|"stores"| Data_Files
    APT_INT -->|"stores"| Exploit_Reports
    APT_INT -->|"stores"| Summaries

    APT_INT -->|"references"| Global_Spreadsheet
    APT_INT -->|"references"| APT_Operations

    classDef repo fill:#FFEEAD,stroke:#333,stroke-width:2px;
    classDef group fill:#ADD8E6,stroke:#333,stroke-width:2px;
    classDef tool fill:#90EE90,stroke:#333,stroke-width:2px;
    classDef data fill:#FFA07A,stroke:#333,stroke-width:2px;
    classDef ref fill:#D3D3D3,stroke:#333,stroke-width:2px;

    click APT_INT "https://github.com/blackorbird/apt_report/blob/master/README.md"
    click APT28 "https://github.com/blackorbird/apt_report/tree/master//APT28"
    click APT29 "https://github.com/blackorbird/apt_report/tree/master//APT29"
    click Lazarus "https://github.com/blackorbird/apt_report/tree/master//lazarus"
    click kimsuky "https://github.com/blackorbird/apt_report/tree/master//kimsuky"
    click APT_Hunting "https://github.com/blackorbird/apt_report/tree/master//APT-hunting"
    click Fn_Fuzzy "https://github.com/blackorbird/apt_report/tree/master//APT-hunting/fn_fuzzy"
    click Tools_Builder "https://github.com/blackorbird/apt_report/tree/master//Tools/Builder"
    click Data_Files "https://github.com/blackorbird/apt_report/tree/master//data"
    click Exploit_Reports "https://github.com/blackorbird/apt_report/tree/master//exploit_report"
    click Summaries "https://github.com/blackorbird/apt_report/tree/master//summary"
    click Global_Spreadsheet "https://github.com/blackorbird/apt_report/blob/master/0day _In the Wild_.xlsx"
    click APT_Operations "https://github.com/blackorbird/apt_report/blob/master/APT Groups and Operations.xlsx"
```
