Skip to content

docs(security): say that CA keys stay in the TPM and a network HSM is out of scope - #49

Merged
Bugs5382 merged 1 commit into
mainfrom
docs/42-ca-keys-tpm-no-hsm
Nov 14, 2026
Merged

Bugs5382 merged 1 commit into
mainfrom
docs/42-ca-keys-tpm-no-hsm

Conversation

@Bugs5382

Copy link
Copy Markdown
Contributor

What and why

The docs implied but never said that CryptOS keeps CA keys in the node's TPM and has no network HSM or PKCS#11 support. This adds a section, "A network HSM is out of scope", to the TPM concept page: what is out of scope and why, what kms mode does (it wraps only the state key; the CA key stays in software and stays exportable), and a caution so kms isn't read as HSM support. The Trust Center control KEY-6 moves from planned to not planned, with that section as its public source, and the register test counts and tracked-issue list are updated to match (10 planned, 5 not planned).

Needs the owner's read on the reason wording: it states the design reason (the key is made and signs in the node's TPM; an HSM adds a second custodian and a third-party PKCS#11 module on the signing path).

Closes #42

Verification

  • Lint clean
  • Tests pass
  • Build succeeds
  • Documentation updated (if behavior or API changed)

How this was verified

npm ci, npx eslint apps/site/app/content/trust (exit 0), npm test -w @cryptos-pki/site (47 pass, 0 fail), npm run build -w @cryptos-pki/docs (exit 0). The kms and export behaviour is as the page already documents it; no new claim about code beyond that.

Merge note: the two draft PRs #36 and #37 are still open and are blocked on a real Proxmox run, so this is a second open PR in this repo.

… out of scope

Closes #42

Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
@Bugs5382 Bugs5382 added this to the vNext milestone Nov 14, 2026
@Bugs5382 Bugs5382 added the documentation Documentation only (docs). label Nov 14, 2026
@Bugs5382 Bugs5382 self-assigned this Nov 14, 2026
@Bugs5382

Copy link
Copy Markdown
Contributor Author

Merging on the owner's approval. CI is green and the branch is clean.

@Bugs5382
Bugs5382 merged commit aec3f62 into main Nov 14, 2026
9 checks passed
@Bugs5382
Bugs5382 deleted the docs/42-ca-keys-tpm-no-hsm branch November 14, 2026 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation only (docs).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(security): say that CA keys stay in the TPM and a network HSM is out of scope

1 participant