# qrn12580/java-ca architecture

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

- Interactive diagram: https://gitdiagram.com/qrn12580/java-ca
- Repository: https://github.com/qrn12580/java-ca

## Overview

##### Project type and purpose
- This is a single‐service backend application written in Java using Spring Boot.
- Purpose: Provide HTTP endpoints for issuing X.509 certificates signed by a root CA and for returning the root CA certificate. It also offers utility functions for certificate validation and conversion.

##### File structure
- pom.xml: Defines dependencies (Spring Boot, Knife4j/Swagger, JUnit).
- src/main/java/com/bjut/ca
- CaApplication.java – Spring Boot entry point.
- Config/Knife4jConfig.java – Swagger UI configuration.
- server/controller/CA.java – REST controller exposing `/ca` and `/root-ca` endpoints.
- server/impl/CAimpl.java – Core service implementing certificate issuance logic.
- Util/*.java – Helper classes:
– PublicKeyUtil: decode/encode user public keys
– X509CertificateUtil: create and load X.509 certificates
– CertificateValidator: validate certificates against root CA
- ca_keystore.p12 (at project root) and application.yml in resources: Store root CA private key and config.
- src/test: Unit tests for application startup and utilities.

##### README for additional insights
- Endpoints:
- POST /ca: Request userDN and Base64‐encoded userPublicKey → Returns signed CA certificate (Base64).
- GET /root-ca: Returns Base64‐encoded root CA certificate.
- Certificate validation APIs in CertificateValidator.
- Conversion utilities for PublicKey ↔ Base64 string, String ↔ X509Certificate.

##### Detail
- Every package or layer as its own component.
- Data transformation steps (Base64 encoding/decoding).
- Don’t over‐generalize—display each major class or module so stakeholders can see where to locate functionality in code.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Entry Point
    CaApplication["CaApplication"]:::entry
    click CaApplication "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/CaApplication.java"

    %% API Layer
    subgraph "API Layer"
        CAController["CAController"]:::controller
        click CAController "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/server/controller/CA.java"
    end

    %% Service Layer
    subgraph "Service Layer"
        CAService["CAService (CAimpl)"]:::service
        click CAService "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/server/impl/CAimpl.java"
        PublicKeyWrapper["PublicKeyWrapper"]:::service
        click PublicKeyWrapper "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/server/impl/PublicKeyWrapper.java"
    end

    %% Utility Layer
    subgraph "Utility Layer"
        PublicKeyUtil["PublicKeyUtil"]:::util
        click PublicKeyUtil "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/Util/PublicKeyUtil.java"
        X509CertificateUtil["X509CertificateUtil"]:::util
        click X509CertificateUtil "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/Util/X509CertificateUtil.java"
        CertificateValidator["CertificateValidator"]:::util
        click CertificateValidator "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/Util/CertificateValidator.java"
    end

    %% Configuration
    subgraph "Configuration"
        Knife4jConfig["Knife4jConfig"]:::config
        click Knife4jConfig "https://github.com/qrn12580/java-ca/blob/main/src/main/java/com/bjut/ca/Config/Knife4jConfig.java"
        applicationYML["application.yml"]:::config
        click applicationYML "https://github.com/qrn12580/java-ca/blob/main/src/main/resources/application.yml"
    end

    %% External Resources
    subgraph "External Resources"
        Keystore[(ca_keystore.p12)]:::external
        click Keystore "https://github.com/qrn12580/java-ca/blob/main/ca_keystore.p12"
        SwaggerUI["Swagger/Knife4j UI"]:::external
    end

    %% Testing
    subgraph "Test Suite"
        CaTests["CaApplicationTests"]:::test
        click CaTests "https://github.com/qrn12580/java-ca/blob/main/src/test/java/com/bjut/ca/CaApplicationTests.java"
    end

    %% Client
    Client["Client"]:::external

    %% Connections
    Client -->|"POST /ca"| CAController
    CAController -->|"issueCertificate(userPublicKey,userDN)"| CAService
    CAService -->|"wrap in PublicKeyWrapper"| PublicKeyWrapper
    CAService -->|"loadRootKey()"| Keystore
    CAService -->|"createSignedCert() "| X509CertificateUtil
    CAService -->|"encodeCert→Base64"| PublicKeyUtil
    CAController -->|"Base64(CACertificate)"| Client

    Client -->|"GET /root-ca"| CAController
    CAController -->|"getRootCaCert()"| CAService
    CAService -->|"loadRootCert()"| Keystore

    Client -->|"validateCertificate()"| CertificateValidator

    CaApplication --> CAController
    CaApplication --> Knife4jConfig
    CaApplication --> applicationYML
    CaApplication --> CATests
    CaApplication --> PublicKeyUtil
    CaApplication --> X509CertificateUtil

    SwaggerUI --> CAController

    %% Styles
    classDef controller fill:#AED6F1,stroke:#1F618D,color:#1B4F72;
    classDef service fill:#ABEBC6,stroke:#196F3D,color:#145A32;
    classDef util fill:#F9E79F,stroke:#B7950B,color:#7D6608;
    classDef config fill:#F5B7B1,stroke:#943126,color:#641E16;
    classDef external fill:#D5DBDB,stroke:#566573,color:#2C3E50;
    classDef entry fill:#D2B4DE,stroke:#6C3483,color:#4A235A;
    classDef test fill:#A9CCE3,stroke:#21618C,color:#1B4F72;
```
