From 8ef581ad5ba1be9534a3d98c872f3b8308e76869 Mon Sep 17 00:00:00 2001 From: Bugs5382 <12115015+Bugs5382@users.noreply.github.com> Date: Fri, 16 Oct 2026 12:20:02 -0400 Subject: [PATCH] docs(install-deploy): show the sign-a-downloaded-ISO command and its outputs The "Download the unsigned image" section told readers to sign a release asset with cryptosctl image sign but only linked out for the command itself. Every other build path on this page (signed build, unsigned build) shows the actual command and the files it writes, so this one now does too: the --image/--key/--cert invocation and the signed ISO, UKI and .sig it leaves next to the input. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com> --- docs/install-deploy/build-bootable-image.md | 28 ++++++++++++++++----- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/install-deploy/build-bootable-image.md b/docs/install-deploy/build-bootable-image.md index 7215afc..7d73c5e 100644 --- a/docs/install-deploy/build-bootable-image.md +++ b/docs/install-deploy/build-bootable-image.md @@ -114,12 +114,28 @@ the tagged source and diffing the hash is an equally valid check. From there you have two paths: -- **Sign it with your own key**, with `cryptosctl image sign` -- see - [Signing an image with your own key](https://github.com/CryptOS-PKI/cryptos-node/blob/main/docs/image-sign.md) - in the `cryptos-node` repository. It stamps your certificate in as the image's upgrade - anchor and Authenticode-signs it for Secure Boot in one step; a node installed from the - result boots with Secure Boot on and takes signed in-place upgrades from any later image - you sign with the same key. +- **Sign it with your own key**, with `cryptosctl image sign`: + + ```bash + cryptosctl image sign \ + --image cryptos-amd64-vmware-unsigned-.iso \ + --key sb.key --cert sb.crt + ``` + + With no `--out`, this writes three files next to the input: + + | File | What it is | + |---|---| + | `cryptos-amd64-vmware-.iso` | the signed, installable ISO (the input name without `-unsigned`) | + | `cryptos-amd64-vmware-.uki` | the signed UKI beside it | + | `cryptos-amd64-vmware-.uki.sig` | that UKI's detached signature | + + Keep the `.uki` and `.sig`: that pair is what `cryptosctl image stage` sends, so any + later image you sign with the same key upgrades a node installed from this one. It + needs no root, no `xorriso` and no rebuild, and the same command signs a standalone + unsigned UKI, with `.unsigned` dropped from the output name instead. + See [Signing an image with your own key](https://github.com/CryptOS-PKI/cryptos-node/blob/main/docs/image-sign.md) + in the `cryptos-node` repository for the full command reference. - **Build from source** instead (above), with `SB_KEY` and `SB_CERT` set, for the same result without downloading a release asset. See [Secure Boot](./secure-boot.md).