# ni/meta-security architecture

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

- Interactive diagram: https://gitdiagram.com/ni/meta-security
- Repository: https://github.com/ni/meta-security

## Overview

##### Project type and purpose
- This is not a conventional client-server or web app, but an open-source Yocto Project layer called “meta-security.”
- Its purpose is to supply BitBake metadata (classes, bbappend patches, recipes, configuration) that hardens and secures Linux images built with the Yocto build system.
- It provides multiple sub-layers (meta-hardening, meta-integrity, meta-parsec, meta-tpm), dynamic-layer support (meta-perl, meta-python, networking-layer), and KAS build definitions for QEMU targets.

##### File structure
- Top–level directories:
- classes/         – custom BitBake classes (.bbclass) for security features
- conf/            – layer.conf, distro include files
- recipes-*/       – grouped by functionality (IDS, scanners, core images, kernel patches, etc.)
- dynamic-layers/  – optional meta-perl, meta-python, networking layer fragments
- meta-hardening/, meta-integrity/, meta-parsec/, meta-tpm/
– focused sub-layers, each with their own conf, classes, recipes, OEQA tests
- kas/             – KAS YAML definitions orchestrating multi-layer builds for various QEMU targets
- lib/oeqa        – OEQA (integration) test cases for each security domain
- scripts/         – CI helper scripts
- wic/             – WIC kickstart templates for generating images with dm-verity, systemd-boot

- Patterns:
- “.bbappend” files modify core recipes (e.g. linux-yocto) when DISTRO_FEATURES includes “security”
- Classes encapsulate common hardening logic (e.g. aide-base.bbclass, dm-verity-img.bbclass)
- KAS files reference this layer plus its dependencies to drive reproducible containerized builds.

##### README for additional insights
- The layer must be added to BBLAYERS in bblayers.conf.
- A warning is emitted if DISTRO_FEATURES lacks “security.”
- Optional dynamic layers are activated by adding meta-oe, meta-perl, meta-python to BBLAYERS.
- Dependencies: openembedded-core, meta-openembedded/meta-oe, plus optional meta-perl/meta-python.

##### Detail
- “DISTRO_FEATURES:append = security” as a config toggle
- Warning/skip-sanity mechanism
- Call out KAS YAML as orchestrator definitions

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build System Layer
    BBLAYERS["BBLAYERS in bblayers.conf"]:::config
    BitBake["BitBake Engine"]:::buildSystem
    CoreYocto["OpenEmbedded Core"]:::buildSystem

    %% meta-security Layer
    subgraph "meta-security Layer"
        direction TB
        Conf["conf/layer.conf + distro includes"]:::metadata
        Classes["classes/"]:::metadata
        RecipesCoreImages["recipes-core/images/"]:::metadata
        DynamicLayers["dynamic-layers"]:::optional
        subgraph "dynamic-layers"
            direction TB
            DL_Perl["meta-perl"]:::optional
            DL_Python["meta-python"]:::optional
            DL_Net["networking-layer"]:::optional
        end
        SubLayers["sub-layers"]:::sublayer
        subgraph "sub-layers"
            direction TB
            HL["meta-hardening"]:::sublayer
            IL["meta-integrity"]:::sublayer
            PL["meta-parsec"]:::sublayer
            TL["meta-tpm"]:::sublayer
        end
        KAS["kas/"]:::metadata
        OEQA["lib/oeqa"]:::test
    end

    %% External Tools and Repo
    Git["Git Repository"]:::external
    QEMU["QEMU Emulation"]:::external
    WIC["wic/"]:::external
    Scripts["scripts/"]:::external

    %% Connections
    Git -->|cloned| BBLAYERS
    BBLAYERS -->|includes| BitBake
    BitBake -->|loads| CoreYocto
    BitBake -->|discovers| Conf
    BitBake -->|merges metadata| Classes
    BitBake -->|merges metadata| RecipesCoreImages
    Conf -->|configures| Classes
    DynamicLayers -.-> BitBake
    DL_Perl --> DynamicLayers
    DL_Python --> DynamicLayers
    DL_Net --> DynamicLayers
    SubLayers -.-> BitBake
    HL --> SubLayers
    IL --> SubLayers
    PL --> SubLayers
    TL --> SubLayers
    KAS -->|orchestrates build| BitBake
    RecipesCoreImages -->|generate images| WIC
    WIC -->|uses templates| WIC
    OEQA -->|runs tests on| QEMU
    Scripts -->|CI helpers| BitBake

    %% Click Events
    click Conf "https://github.com/ni/meta-security/blob/nilrt/master/scarthgap/conf/layer.conf"
    click Classes "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/classes/"
    click RecipesCoreImages "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/recipes-core/images/"
    click DL_Perl "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/dynamic-layers/meta-perl/"
    click DL_Python "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/dynamic-layers/meta-python/"
    click DL_Net "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/dynamic-layers/networking-layer/"
    click HL "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/meta-hardening/"
    click IL "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/meta-integrity/"
    click PL "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/meta-parsec/"
    click TL "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/meta-tpm/"
    click KAS "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/kas/"
    click OEQA "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/lib/oeqa/"
    click WIC "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/wic/"
    click Scripts "https://github.com/ni/meta-security/tree/nilrt/master/scarthgap/scripts/"

    %% Styles
    classDef buildSystem fill:#ADD8E6,stroke:#000;
    classDef metadata fill:#90EE90,stroke:#000;
    classDef optional fill:#FFA500,stroke:#000;
    classDef sublayer fill:#DDA0DD,stroke:#000;
    classDef external fill:#F0E68C,stroke:#000;
    classDef test stroke-dasharray: 5 5,color:#800080;
```
