Repository navigation
docs(reference): write the reference pages from the alpha - #35
Conversation
|
Commit 89e398b 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 3a1ae8d for CryptOS-PKI/cryptos-node#286: the ACME and EST blocks now travel in MachineConfig, so machine-config-enrollment and machine-config describe switching them on and off, the reboot and maintenance-window callout, the write-only secrets, the Root refusal and the new error messages. It depends on CryptOS-PKI/cryptos-node#286 and should merge with it. |
Replace the machine config, audit log, Root certificate profile and glossary stubs with pages written from the code on main. The machine config schema is split into three pages (overview, pki, ACME and EST) to keep each one readable, with sidebar entries for the two new pages. Refs #20 Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
Drop the Planned callouts and the Planned and Root Mode glossary entries, and say plainly what isn't available without promising it. The Fleet Manager audit table now lists the step-up approval kinds and fields the manager records. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
machine-config-pki and machine-config said the TPM path holds ECDSA P-384 keys only and quoted the old refusal. With CryptOS-PKI/cryptos-node#282 an RSA-3072 or RSA-4096 CA key is created in the TPM when the TPM implements that size, and key creation fails with FailedPrecondition, never falling back, when it does not. The callouts now say that. Depends on CryptOS-PKI/cryptos-node#282 and should merge with it. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
The enrolment page and the machine-config apply section now say the blocks travel in MachineConfig: switching a protocol is a reboot-required change best done in a maintenance window, the secrets are write-only, and a Root refuses both blocks. Adds the two new refusal messages to each error table. Depends on CryptOS-PKI/cryptos-node#286. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
3a1ae8d to
ca1bdb5
Compare
|
Closing summary: writes the Reference pages (machine config, the new machine-config PKI and enrollment pages with their sidebar entries, the audit log, the Root certificate profile and the glossary), with every field, value, error string and command taken from cryptos, api and manager on main. 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
Writes the Reference pages that were still stubs, for an operator who has never seen CryptOS. Every field, value, error string and command is taken from
cryptos,apiandmanageronmain.machine-config: the document header,metadata,role,network,bootstrap,install,state_keyandmanagement, with types, defaults, every validation rule and its exact error, plus how an apply works (live versus reboot, and what theMachineConfigmessage can't carry).machine-config-pki(new): the CA key, subject and lifetime,parent, revocation, Root leaf issuance, and certificate profiles.machine-config-enrollment(new): thepki.acmeandpki.estblocks, with key and digest commands in Linux / macOS and Windows (PowerShell) tabs.root-cert-profile: every field and extension the ceremony's self-signed Root carries, what it leaves out and why, and how to check a Root withcryptosctland openssl. The sample output comes from a Root built by the real signing code.audit-log: the node's line format, fields,detailskeys, chain and signature rules, the signing key, what isn't possible yet, and the Fleet Manager's own audit record.glossary: plain definitions for the terms the site uses, with planned features marked.The schema didn't fit one page, so
machine-configis split into three, with the two new pages added to the sidebar right after it. Titles, emoji and the existing sidebar positions are unchanged. Thecryptosctlandgrpc-apipages are left alone; this PR only links to them.Closes #20
Verification
How this was verified
npm run buildandnpm run typecheckon this branch: success, with no broken link or anchor warnings.config.Parse) and pass. The unknown-field error, theextra_extensionsbyte-list format and the revocation resolver warning are the real parser output.openssl x509 -texton certificates made by the node'sSelfSignRootwith ECDSA P-384 and RSA-3072 keys.RandomNumberGenerator,ConvertandGet-FileHash, which exist in PowerShell 5.1 and 7.