Repository navigation
docs(use-cases): write the use-cases pages from the alpha - #31
Conversation
|
Commit 720c38e updates the pages that said an RSA CA key can't be held in the TPM. It depends on CryptOS-PKI/cryptos-node#282, which adds TPM-held RSA-3072 and RSA-4096 CA keys and the FailedPrecondition refusal on TPMs without the size. Merge the two together. |
|
Added ec537ec for CryptOS-PKI/cryptos-node#286: the overview, internal-tls, devices-iot and kubernetes pages now say ACME and EST can be switched on in the machine config on an intermediate or issuing node, with a reboot in a maintenance window, and that a Root refuses both. It depends on CryptOS-PKI/cryptos-node#286 and should merge with it. |
|
Added 78ea650: an info callout on the Kubernetes page saying the cert-manager ACME path is tested in CI with kind. It depends on CryptOS-PKI/cryptos-node#294 and should merge after it. |
Replace the six stub pages with real content: the overview, internal TLS and mTLS, Kubernetes workloads, devices and IoT, code signing, and the air-gapped Root. Each page separates what the alpha does today (issue by CSR through cryptosctl or the Fleet Manager, CRL and OCSP, two-tier hierarchies) from what is planned (SCEP, ACME dns-01, WSTEP, timestamps, Root Mode), and says plainly that the ACME and EST servers are built but can't be switched on yet because the wire config has no field for them. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
Remove the Planned callouts, the Planned rows in the protocol table and the tracking links. Where a gap matters (no SCEP, ACME and EST can't be switched on, no timestamps, no Root Mode), say so plainly without promising it. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
air-gapped-root said an RSA CA key can't be held in the TPM. With CryptOS-PKI/cryptos-node#282 it can, at a size the TPM implements; the table and a new caution callout cover the RSA-2048-only TPMs and the FailedPrecondition refusal. Depends on CryptOS-PKI/cryptos-node#282 and should merge with it. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
The overview, internal TLS, devices and Kubernetes pages said neither protocol could be switched on. They now say both run on an intermediate or issuing node once their block is in the machine config, that a switch takes effect at the next reboot and belongs in a maintenance window, and that a Root refuses both. Depends on CryptOS-PKI/cryptos-node#286. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
Add a note to the Kubernetes page that every cryptos pull request touching the ACME code runs cert-manager in a kind cluster against an intermediate, what that test checks, and that the node there runs from the code with software keys rather than from the OS image. Depends on CryptOS-PKI/cryptos-node#294 and should merge after it. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
78ea650 to
2bf4d1a
Compare
|
Closing summary: writes the six Use Cases pages (overview with the enrolment protocol table and the subject-key rule, internal TLS and mTLS, Kubernetes, devices and IoT, code signing and the air-gapped Root), each with a Works today callout for what the alpha does and a Planned callout for what it doesn't. Rebased onto docs/stub-pages (now level with main, including the theme, the VMCA pages and the install pages) with every commit signed off; |
What and why
The six pages under
docs/use-cases/were stubs. This writes them for an operator who has never seen CryptOS, and keeps each one honest about the alpha: aWorks todaycallout for what the code does now and aPlannedcallout for what it doesn't.cryptosctl ca issue-leafor the Fleet Manager, plus CRL and OCSP), a table of every enrolment protocol and its state, and the subject-key rule (ECDSA P-384 or RSA 3072+).ca sign-subordinate.tpmversus software key modes and what each means for backup, revocation with an offline Root, and Root Mode as planned.The protocol states come from the code on
cryptosmain and the open issues CryptOS-PKI/cryptos-node#110, #112, #113 and #185. One thing the pages call out plainly: the ACME and EST servers are in the node code, but theMachineConfigmessage used byconfig apply, the maintenance install and the Fleet Manager has noacmeorestfield, so an apply keeps an existing block but can't add one. There is no supported way to switch either on in this alpha.Titles, emoji and sidebar order are unchanged. No page needed OS tabs: the only commands are
opensslandcryptosctl, and each page that runscryptosctlsays once that it is Linux and macOS only for now (CryptOS-PKI/cryptos-node#275). Links to the VMCA, AD, ACME, EST, profiles and issued-certificates guides point at thecryptosrepo docs rather than repeating them.Part of CryptOS-PKI/cryptos-node#166. Targets the
docs/stub-pagesparent branch.Closes #25
Verification
How this was verified
npm run buildon this branch: success, with no broken-link or broken-anchor warnings.:::callout rendered as an admonition, none left as literal text.cryptosmain (cmd/cryptosctl,internal/config,internal/node/signer.go,internal/ca/profile.go,internal/init), theapiprotos and thewebprotocol page.