# liankee/cldroid architecture

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

- Interactive diagram: https://gitdiagram.com/liankee/cldroid
- Repository: https://github.com/liankee/cldroid

## Overview

##### Project type and purpose
- This is a Java‐based static analysis tool (“CLDroid”) for Android apps, built on top of the Soot framework.
- It is a command-line application that takes an APK as input, parses its manifest/components, generates program representations (call graph, CFG), performs multi‐stage dataflow analyses (forward/backward), applies security “sinks” definitions, and emits threat reports.

##### File structure
- Top‐level:
- lib/ – third‐party JARs (soot, infoflow, trove4j)
- sinks/ – definitions of sensitive APIs or data‐flow “sinks”
- pom.xml – Maven build descriptor
- src/main/java/… – Java packages:
– analyze/ – entry points (Main.java, AnalyzeService.java, database & NIO analyzers)
– cfg/ – control‐flow graph factory & path utilities
– cg/ – call‐graph utilities
– component/ – Android manifest resolution & fragment creation
– constant/ – configuration: entry points, IPC points, file/db semantics
– dataflow/ – core data‐flow engine, detectors, rules, taint wrapper
– timeout/ – task scheduling for timeouts
– util/ – helper modules (Soot initialisation, logging, directory traversal)

##### README for additional insights
- Describes a three-step pipeline:
1. External data pools (shared prefs, databases) via exported components.
2. Track data‐flows of items across those pools.
3. Learn app‐specific semantics and assess risk w.r.t. data loading & consuming.
- References Soot‐based implementation and a FSE 2024 paper.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Layer 1: CLI & Orchestrator"
        Main["Main.java"]:::cli
        MainAnalyze["MainAnalyze.java"]:::cli
        AnalyzeService["AnalyzeService"]:::cli
    end

    subgraph "Layer 2: APK Parsing & IR"
        APK["APK Input"]:::external
        ResolveManifest["ResolveManifest"]:::parser
        FragmentCreator["FragementCreater"]:::parser
        EntryPointAnalyze["EntryPointAnalyze"]:::parser
        SootInit["SootInit"]:::util
        CallGraphUtils["CallGraphUtils"]:::cg
        CfgFactory["CfgFactory"]:::cfg
        PathNode["Path"]:::cfg
    end

    subgraph "Layer 3: Analysis Engine"
        AbstractDataFlow["AbstractDataFlow"]:::engine
        ForwardDataFlow["ForwardDataFlow"]:::engine
        BackwardDataFlow["BackwardDataFlow"]:::engine
        DataFlowEngine["DataFlowEngine"]:::engine
        EventQueue["EventQueue"]:::engine
        EventNode["Event"]:::engine
        subgraph "Detectors"
            FileUseDetector["FileUseDetector"]:::detector
            DatabaseUseDetector["DatabaseUseDetector"]:::detector
            ExportedFileChecker["ExportedFileChecker"]:::detector
            StrawDetector["StrawDetector"]:::detector
            ExportedConfigFileDetector["ExportedConfigFileDetector"]:::detector
            FileLoaderDetector["FileLoaderDetector"]:::detector
        end
        RuleChecker["RuleChecker"]:::checker
        SensitiveActionChecker["SensitiveActionChecker"]:::checker
        CF_Sink["CF_SINK_INFO.txt"]:::config
        DF_Sink["DF_SINK_INFO.txt"]:::config
    end

    subgraph "Layer 4: Reporting & Persistence"
        AnalyzeDatabase["AnalyzeDatabase"]:::report
        AnalyzeNIO["AnalyzeNIO"]:::report
        FileUseAnalyze["FileUseAnalyze"]:::report
    end

    subgraph "Helpers"
        TimeOutTask["TimeOutTask"]:::timeout
    end

    subgraph "Third-Party Libs"
        libs["lib/"]:::thirdparty
    end

    APK -->|input| AnalyzeService
    Main -->|invokes| AnalyzeService
    MainAnalyze -->|invokes| AnalyzeService
    AnalyzeService -->|init| SootInit
    AnalyzeService -->|parse| ResolveManifest
    ResolveManifest -->|create fragments| FragmentCreator
    FragmentCreator -->|analyze entry| EntryPointAnalyze
    SootInit -->|setup| CallGraphUtils
    CallGraphUtils -->|generate| CfgFactory
    CfgFactory -->|build| PathNode
    CallGraphUtils -->|provision CG| DataFlowEngine
    PathNode -->|provision CFG| DataFlowEngine
    DataFlowEngine -->|uses| AbstractDataFlow
    DataFlowEngine -->|uses| ForwardDataFlow
    DataFlowEngine -->|uses| BackwardDataFlow
    DataFlowEngine -->|manages| EventQueue
    EventQueue -->|dispatch| EventNode
    EventNode -.->|triggers| FileUseDetector
    EventNode -.->|triggers| DatabaseUseDetector
    EventNode -.->|triggers| ExportedFileChecker
    EventNode -.->|triggers| StrawDetector
    EventNode -.->|triggers| ExportedConfigFileDetector
    EventNode -.->|triggers| FileLoaderDetector
    FileUseDetector -->|reports| RuleChecker
    DatabaseUseDetector -->|reports| RuleChecker
    ExportedFileChecker -->|reports| RuleChecker
    StrawDetector -->|reports| RuleChecker
    ExportedConfigFileDetector -->|reports| RuleChecker
    FileLoaderDetector -->|reports| RuleChecker
    RuleChecker -->|checks sinks| SensitiveActionChecker
    SensitiveActionChecker -->|reads| CF_Sink
    SensitiveActionChecker -->|reads| DF_Sink
    RuleChecker -->|outputs| AnalyzeDatabase
    RuleChecker -->|outputs| AnalyzeNIO
    RuleChecker -->|outputs| FileUseAnalyze
    AnalyzeService -->|monitors| TimeOutTask
    libs -->|used by| SootInit
    libs -->|used by| CallGraphUtils

    click Main "https://github.com/liankee/cldroid/blob/main/src/main/java/analyze/Main.java"
    click MainAnalyze "https://github.com/liankee/cldroid/blob/main/src/main/java/analyze/MainAnalyze.java"
    click AnalyzeService "https://github.com/liankee/cldroid/blob/main/src/main/java/analyze/AnalyzeService.java"
    click ResolveManifest "https://github.com/liankee/cldroid/blob/main/src/main/java/component/ResolveManifest.java"
    click FragmentCreator "https://github.com/liankee/cldroid/blob/main/src/main/java/component/FragementCreater.java"
    click EntryPointAnalyze "https://github.com/liankee/cldroid/blob/main/src/main/java/component/EntryPointAnalyze.java"
    click SootInit "https://github.com/liankee/cldroid/blob/main/src/main/java/util/SootInit.java"
    click CallGraphUtils "https://github.com/liankee/cldroid/blob/main/src/main/java/cg/CallGraphUtils.java"
    click CfgFactory "https://github.com/liankee/cldroid/blob/main/src/main/java/cfg/CfgFactory.java"
    click PathNode "https://github.com/liankee/cldroid/blob/main/src/main/java/cfg/Path.java"
    click AbstractDataFlow "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/AbstractDataFlow.java"
    click ForwardDataFlow "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/ForwardDataFlow.java"
    click BackwardDataFlow "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/BackwardDataFlow.java"
    click DataFlowEngine "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/DataFlowEngine.java"
    click EventQueue "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/EventQueue.java"
    click EventNode "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/Event.java"
    click FileUseDetector "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/FileUseDetector.java"
    click DatabaseUseDetector "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/DatabaseUseDetector.java"
    click ExportedFileChecker "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/ExportedFileChecker.java"
    click StrawDetector "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/StrawDetector.java"
    click ExportedConfigFileDetector "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/ExportedConfigFileDetector.java"
    click FileLoaderDetector "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/FileLoaderDetector.java"
    click RuleChecker "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/RuleChecker.java"
    click SensitiveActionChecker "https://github.com/liankee/cldroid/blob/main/src/main/java/dataflow/SensitiveActionChecker.java"
    click CF_Sink "https://github.com/liankee/cldroid/blob/main/sinks/CF_SINK_INFO.txt"
    click DF_Sink "https://github.com/liankee/cldroid/blob/main/sinks/DF_SINK_INFO.txt"
    click AnalyzeDatabase "https://github.com/liankee/cldroid/blob/main/src/main/java/analyze/AnalyzeDatabase.java"
    click AnalyzeNIO "https://github.com/liankee/cldroid/blob/main/src/main/java/analyze/AnalyzeNIO.java"
    click FileUseAnalyze "https://github.com/liankee/cldroid/blob/main/src/main/java/analyze/FileUseAnalyze.java"
    click TimeOutTask "https://github.com/liankee/cldroid/blob/main/src/main/java/timeout/TimeOutTask.java"

    classDef cli fill:#f9f,stroke:#333,stroke-width:1px;
    classDef parser fill:#ccf,stroke:#333,stroke-width:1px;
    classDef util fill:#cfc,stroke:#333,stroke-width:1px;
    classDef cg fill:#fcf,stroke:#333,stroke-width:1px;
    classDef cfg fill:#cff,stroke:#333,stroke-width:1px;
    classDef engine fill:#fee,stroke:#333,stroke-width:1px;
    classDef detector fill:#efe,stroke:#333,stroke-width:1px;
    classDef checker fill:#eef,stroke:#333,stroke-width:1px;
    classDef config fill:#ffe,stroke:#333,stroke-width:1px;
    classDef report fill:#eef,stroke:#333,stroke-width:1px;
    classDef timeout fill:#fdd,stroke:#333,stroke-width:1px;
    classDef thirdparty fill:#ddd,stroke:#333,stroke-width:1px;
    classDef external fill:#ddd,stroke:#333,stroke-width:1px;
```
