# openbmc/phosphor-certificate-manager architecture

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

- Interactive diagram: https://gitdiagram.com/openbmc/phosphor-certificate-manager
- Repository: https://github.com/openbmc/phosphor-certificate-manager

## Overview

##### Main Components
- Core Binary (phosphor-certificate-manager): Represent this as the central execution unit that accepts command-line options (e.g., --type, --endpoint, --path, --unit).
- Certificate Management Modules:
– Include supporting utilities in their own nodes (e.g., argument.cpp/hpp for CLI parsing, csr.cpp/hpp for Certificate Signing Requests, and x509_utils for certificate-related functions).
- Systemd Integration & Deployment: Include systemd unit/service components along with configuration snippets (as seen in the dist directory) that trigger actions like reloading bmcweb.
- External Dependencies/Submodules: Add components for the subprojects (e.g., cli11 for CLI parsing, phosphor-dbus-interfaces for D-Bus specifications, phosphor-logging, sdbusplus, sdeventplus). These are vital libraries integrated into the core functionality.

##### Architectural Patterns and Design Principles
- Modularity: Emphasize that the application is split into distinct modules (argument processing, certificate logic, D-Bus interfacing, system integration).
- Separation of Concerns: Show that the tool separates certificate handling logic from its infrastructure concerns (e.g., CLI parsing vs. D-Bus communication).
- Extensibility: Include a note that the use of subprojects and external libraries supports a plug-and-play style for various capabilities (as seen in the wrap files within the subprojects directory).

## Diagram (Mermaid)

```mermaid
flowchart TD
    A1("User CLI Input"):::cli
    B1("CLI Argument Parser"):::cli
    C1("Main Application (phosphor-certificate-manager)"):::core
    D1("Server/Client Certificate Manager"):::cert
    E1("Authority Certificate Manager"):::cert
    F1("CSR Handler"):::certSupport
    G1("Certificate Utilities"):::certSupport
    H1("D-Bus Interface"):::dbus
    I1("External BMC Component (bmcweb)"):::externalInt
    J1("Systemd Deployment"):::deployment
    K1("External Dependencies"):::externalDep

    %% Flow connections
    A1 --> B1
    B1 --> C1
    C1 --> D1
    C1 --> E1
    D1 --> F1
    D1 --> G1
    D1 --> H1
    E1 --> H1
    H1 --> I1
    D1 --> J1
    E1 --> J1
    C1 --> K1

    %% Click Events
    click C1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/bmc-vmi-ca/mainapp.cpp"
    click C1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/mainapp.cpp"
    click B1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/argument.cpp"
    click D1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/certs_manager.cpp"
    click D1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/certificate.cpp"
    click E1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/bmc-vmi-ca/ca_certs_manager.cpp"
    click E1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/bmc-vmi-ca/ca_cert_entry.cpp"
    click F1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/csr.cpp"
    click G1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/x509_utils.cpp"
    click H1 "https://github.com/openbmc/phosphor-certificate-manager/tree/master/dist/busconfig"
    click J1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/dist/bmc-vmi-ca-manager.service"
    click J1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/dist/phosphor-certificate-manager@.service"
    click K1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/subprojects/cli11.wrap"
    click K1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/subprojects/phosphor-dbus-interfaces.wrap"
    click K1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/subprojects/phosphor-logging.wrap"
    click K1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/subprojects/sdbusplus.wrap"
    click K1 "https://github.com/openbmc/phosphor-certificate-manager/blob/master/subprojects/sdeventplus.wrap"

    %% Class Definitions for coloring
    classDef cli fill:#f9f,stroke:#333,stroke-width:2px;
    classDef core fill:#ccf,stroke:#333,stroke-width:2px;
    classDef cert fill:#cfc,stroke:#333,stroke-width:2px;
    classDef certSupport fill:#efe,stroke:#333,stroke-width:2px;
    classDef dbus fill:#ffc,stroke:#333,stroke-width:2px;
    classDef deployment fill:#fcf,stroke:#333,stroke-width:2px;
    classDef externalDep fill:#cff,stroke:#333,stroke-width:2px;
    classDef externalInt fill:#fdd,stroke:#333,stroke-width:2px;
```
