# kevlar-kt/kevlar architecture

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

- Interactive diagram: https://gitdiagram.com/kevlar-kt/kevlar
- Repository: https://github.com/kevlar-kt/kevlar

## Overview

##### Project Type and Purpose
- Kevlar is a multi-module Kotlin/Android library (security toolkit) providing three core packages—antipiracy, rooting, and integrity—plus a DSL module for configuration, a showcase Android app, documentation, and publishing/build scripts.
- Its purpose is to let Android apps declaratively configure and request “attestations” of the device’s security environment (app-wise, user-wise, system-wise).

##### File Structure Analysis
- Top-level modules:
- antipiracy/, rooting/ and integrity/: Android library modules; each implements an “Attestator” entrypoint, detection strategies, data models, and DSL integration.
- dsl/: a pure-Kotlin module furnishing the DSL builders and settings classes shared by all packages.
- /: sample Android app demonstrating runtime consumption of the libraries.
- docs/, mkdocs.yml: static site content for the project website.
- buildSrc/, scripts/: centralized Gradle plugin code and reusable build/publishing scripts.
- CI metadata under .github/workflows/, shell scripts for local assemble & publishing.
- Patterns:
- Multi-module Gradle project for modular separation of concerns.
- Declarative DSL layer → Settings → Attestator → Detection/Vector pipelines → AttestationResult.
- CI/CD builds artifacts (AARs) and publishes to Maven Central and GitHub Pages.

##### Key README Insights
- Explanation of security environment subdivisions and flexibility via DSL configuration.
- Usage guidelines and published artifacts for each package.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Environment
    Dev[/"Developer Environment"/]:::infra
    click Dev "https://github.com/kevlar-kt/kevlar/blob/master/.gitignore"

    %% CI/CD & Publishing
    subgraph "CI/CD & Publishing"
        direction TB
        GitHubActions["GitHub Actions"]:::ci
        click GitHubActions "https://github.com/kevlar-kt/kevlar/blob/master/.github/workflows/push-tests.yaml"
        BuildScripts[/"Build Logic & Publishing Scripts"/]:::infra
        click BuildScripts "https://github.com/kevlar-kt/kevlar/tree/master/scripts/commons/"
        click BuildScripts "https://github.com/kevlar-kt/kevlar/blob/master/assemble_and_publish_all.sh"
    end

    %% Build System
    BuildSystem[/"Gradle Build System"/]:::infra
    click BuildSystem "https://github.com/kevlar-kt/kevlar/blob/master/build.gradle"

    %% Modules
    subgraph "Library Modules"
        direction TB
        DSL["dsl module"]:::module
        click DSL "https://github.com/kevlar-kt/kevlar/blob/master/dsl/src/main/kotlin/com/kevlar/dsl/Attestator.kt"
        subgraph "Security Packages"
            direction TB
            AP["Antipiracy"]:::module
            click AP "https://github.com/kevlar-kt/kevlar/blob/master/antipiracy/src/main/kotlin/com/kevlar/antipiracy/KevlarAntipiracy.kt"
            RT["Rooting"]:::module
            click RT "https://github.com/kevlar-kt/kevlar/blob/master/rooting/src/main/kotlin/com/kevlar/rooting/KevlarRooting.kt"
            IN["Integrity"]:::module
            click IN "https://github.com/kevlar-kt/kevlar/blob/master/integrity/src/main/kotlin/com/kevlar/integrity/KevlarIntegrity.kt"
        end
    end

    %% Documentation
    Documentation[/"Documentation (MkDocs)"/]:::infra
    click Documentation "https://github.com/kevlar-kt/kevlar/blob/master/mkdocs.yml"

    %% Artifact Repositories
    MavenCentral[(Maven Central)]:::artifact
    GitHubPages[(GitHub Pages)]:::artifact

    %% Consumers
    subgraph "Consumers"
        direction TB
        Showcase["Showcase Android App"]:::consumer
        click Showcase "https://github.com/kevlar-kt/kevlar/blob/master/showcase/src/main/kotlin/com/kevlar/showcase/App.kt"
        ExternalApps["External Apps"]:::consumer
    end

    %% Runtime Flow
    subgraph "Runtime Attestation Flow"
        direction TB
        AppCall["App → Kevlar Entrypoint"]:::consumer
        DSLFlow["DSL builds ScanConfiguration"]:::module
        Attestator["Attestator triggers detection"]:::module
        Detection["Detection Vectors Execution"]:::module
        Result["AttestationResult"]:::module
    end

    %% Connections
    Dev -->|commits| GitHubActions
    GitHubActions --> BuildSystem
    GitHubActions --> BuildScripts
    BuildSystem --> DSL
    BuildSystem --> AP
    BuildSystem --> RT
    BuildSystem --> IN
    BuildSystem --> MavenCentral
    GitHubActions --> Documentation
    Documentation --> GitHubPages
    MavenCentral --> Showcase
    MavenCentral --> ExternalApps

    %% Runtime connections
    Showcase --> AppCall
    AppCall --> DSLFlow
    DSLFlow --> Attestator
    Attestator --> Detection
    Detection --> Result
    Result -->|"returns result"| Showcase

    %% Styles
    classDef module fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef consumer fill:#d4edda,stroke:#333,stroke-width:1px
    classDef ci fill:#fff3cd,stroke:#333,stroke-width:1px
    classDef infra fill:#e2e3e5,stroke:#333,stroke-width:1px
    classDef artifact fill:#f8d7da,stroke:#333,stroke-width:1px
```
