Skip to content

fix terminology within "Keys" mermaid diagram - #41

Merged
overheadhunter merged 3 commits into
mainfrom
feature/security-mermaid-terminology
Oct 23, 2026
Merged

overheadhunter merged 3 commits into
mainfrom
feature/security-mermaid-terminology

Conversation

@overheadhunter

@overheadhunter overheadhunter commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

as suggested in #29 (comment):

The user's private signer key is used to sign the public keys of trusted users.

also changed the shape of the "account key" and "vault recovery key", denoting that they are a potentially long-living "paper key".

flowchart TB
    subgraph keystore["Device keystore — locked/unlocked outside Katta"]
        devkey["Private Device Key<br/>Public Device Key"]
    end

    userkeys["Private User Key<br/>Private Signer Key"]
    accoukey["Account Key"]@{shape: paper-tape}
    membekey["Vault Member Key"]
    recovkey["Private Vault Recovery Key"]@{shape: paper-tape}
    trusted["Public Keys<br/>of trusted users"]@{shape: procs}
    uvf["vault.uvf payload<br/><i>Katta Server and S3 bucket</i>"]

    devkey -- decrypts --> userkeys
    accoukey -- decrypts --> userkeys
    userkeys -- decrypts --> accoukey
    userkeys -- decrypts --> membekey
    userkeys -- decrypts --> recovkey
    userkeys -- signs --> trusted
    membekey -- decrypts --> uvf
    recovkey -- decrypts --> uvf
Loading

Copilot AI balanced review requested due to automatic review settings October 23, 2026 11:02

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The changes are limited to a documentation diagram, with only a minor legend correction remaining.

1 open issue
What changed in this PR

Updates the security architecture’s Keys diagram to clarify signing relationships and visually distinguish key types.

Changes:

  • Corrects the trusted-public-key relationship from “decrypts” to “signs.”
  • Simplifies trusted-key terminology and adds shapes for the Account Key and trusted public keys.
  • Removes the dashed-border styling.
File Description
docs/​architecture/​security.md Updates terminology, relationships, and styling in the Keys diagram.

Review effort: Balanced

Comment thread docs/architecture/security.md
Copilot AI balanced review requested due to automatic review settings October 23, 2026 11:04

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The legend still describes dashed borders that the updated diagram no longer uses.

1 open issue

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 23, 2026 11:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The focused documentation changes match the stated intent, resolve the prior legend feedback, and have no identified blocking issues.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@dkocher dkocher added the security Security-sensitive issue or fix label Oct 23, 2026
@overheadhunter
overheadhunter merged commit 83d1c2b into main Oct 23, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

security Security-sensitive issue or fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants