Skip to content

docs: Visualize certificate lifecycle and security boundaries #1

Closed

Description

@alsd4git

Goal

Help homelab operators understand the mTLS lifecycle and the project's handling of sensitive materials before deploying it.

Scope

  • Add a simple self-contained SVG/Mermaid diagram showing Smallstep CA, issuing/renewing certificates, packaging PKCS#12, sharing the bundle, and client/service verification.
  • Explicitly distinguish CA private state, client private keys, plaintext password log, public certificates, short-lived HTTP download and secure delivery assumptions.
  • Show revocation as effective only when the relying service checks CRL/OCSP; do not imply it automatically blocks clients everywhere.
  • Use terminology and commands that match the implementation; link to the security model and docs/nginx-proxy-manager.md.
  • Provide equivalent short text/alt description for readers unable to view the diagram.

Acceptance criteria

  • A reader can identify which artifacts are secret, where they reside and which transfers must be trusted.
  • The lifecycle accurately reflects implemented behavior, without suggesting unsupported security guarantees.
  • Diagram renders on GitHub and remains legible on mobile.

Priority: P2 — explanatory documentation, no changes to cryptographic behavior.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions