Skip to content

Commit 3626400

Browse files
committed
[green] Stage and preserve exact firmware beta
Signed-off-by: Viwat Vchirawongkwin <viwat.v@chula.ac.th>
1 parent 4f0d0cd commit 3626400

6 files changed

Lines changed: 207 additions & 59 deletions

File tree

‎tools/web/deploy/vps/deploy.sh‎

Lines changed: 76 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,13 @@ staged_firmware_root=
2424
firmware_evidence_root=
2525
upload_evidence_root=
2626
firmware_version=
27+
firmware_deployment=
2728
firmware_tag=
2829
firmware_provenance_commit=
2930
firmware_release_json_path=
3031
local_firmware_tag_object_before_build=
32+
local_firmware_tag_object_after_build=
33+
local_firmware_tag_object_before_upload=
3134
staged_validation_flag=--verify-staged
3235

3336
cleanup_firmware_evidence() {
@@ -153,30 +156,52 @@ verify_local_firmware_tag() {
153156
}
154157

155158
if [[ -n ${PYBLE_FIRMWARE_STAGED_ROOT:-} ]]; then
156-
if [[ -z ${PYBLE_FIRMWARE_LICENSE_EVIDENCE_DIR:-} ]]; then
157-
printf 'Refusing public firmware activation: PYBLE_FIRMWARE_LICENSE_EVIDENCE_DIR is required.\n' >&2
158-
exit 65
159-
fi
160-
if [[ -z ${PYBLE_FIRMWARE_LICENSE_BUILD_ROOT:-} ]]; then
161-
printf 'Refusing public firmware activation: PYBLE_FIRMWARE_LICENSE_BUILD_ROOT is required.\n' >&2
162-
exit 65
163-
fi
164-
165159
staged_firmware_root=$(
166160
cd -- "${PYBLE_FIRMWARE_STAGED_ROOT}"
167161
pwd -P
168162
)
169163
staged_selection="${staged_firmware_root}/.pyble-firmware-release-selection.json"
170164
test -f "${staged_selection}"
171165
test -d "${staged_firmware_root}/firmware"
166+
firmware_deployment=$(
167+
node -e '
168+
const { readFileSync } = require("node:fs");
169+
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
170+
if (!["public", "candidate", "public-beta"].includes(descriptor.deployment)) {
171+
throw new Error("staged firmware deployment is invalid");
172+
}
173+
process.stdout.write(descriptor.deployment);
174+
' "${staged_selection}"
175+
)
176+
if [[ "${firmware_deployment}" != public-beta ]]; then
177+
if [[ -z ${PYBLE_FIRMWARE_LICENSE_EVIDENCE_DIR:-} ]]; then
178+
printf 'Refusing public firmware activation: PYBLE_FIRMWARE_LICENSE_EVIDENCE_DIR is required.\n' >&2
179+
exit 65
180+
fi
181+
if [[ -z ${PYBLE_FIRMWARE_LICENSE_BUILD_ROOT:-} ]]; then
182+
printf 'Refusing public firmware activation: PYBLE_FIRMWARE_LICENSE_BUILD_ROOT is required.\n' >&2
183+
exit 65
184+
fi
185+
fi
172186
PYBLE_FIRMWARE_STAGED_ROOT="${staged_firmware_root}" \
173187
node "${web_directory}/scripts/stage-firmware-release.js" \
174188
--verify-staged
175189
node -e '
176190
const { readFileSync } = require("node:fs");
177191
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
178-
if (descriptor.deployment !== "public" || descriptor.hilStatus !== "passed") {
179-
throw new Error("The public VPS accepts only an all-HIL-passed public release");
192+
const qualifiedPublic =
193+
descriptor.deployment === "public" &&
194+
descriptor.hilStatus === "passed" &&
195+
descriptor.accessControlled === false;
196+
const exactPublicBeta =
197+
descriptor.deployment === "public-beta" &&
198+
descriptor.version === "0.4.1" &&
199+
descriptor.hilStatus === "pending" &&
200+
descriptor.accessControlled === false &&
201+
descriptor.releaseJson?.sha256 ===
202+
"8b84fbb65a0463d20369e1d86dac566ca7a2039ebc30f9186f55c05421962445";
203+
if (!qualifiedPublic && !exactPublicBeta) {
204+
throw new Error("The public VPS accepts only a qualified public release or the exact attested public beta");
180205
}
181206
' "${staged_selection}"
182207

@@ -200,7 +225,11 @@ if [[ -n ${PYBLE_FIRMWARE_STAGED_ROOT:-} ]]; then
200225
process.stdout.write(commit);
201226
' "${staged_release_bundle}/release.json"
202227
)
203-
local_firmware_tag_object_before_build=$(verify_local_firmware_tag)
228+
if [[ "${firmware_deployment}" == public-beta ]]; then
229+
printf 'The exact public-beta exception does not require an annotated tag; release identity is digest-bound.\n'
230+
else
231+
local_firmware_tag_object_before_build=$(verify_local_firmware_tag)
232+
fi
204233

205234
firmware_evidence_root=$(mktemp -d)
206235
chmod 0700 "${firmware_evidence_root}"
@@ -307,18 +336,34 @@ REMOTE
307336
const { readFileSync } = require("node:fs");
308337
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
309338
const semver = /^(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$/;
339+
const qualifiedPublic =
340+
descriptor.deployment === "public" &&
341+
descriptor.hilStatus === "passed" &&
342+
descriptor.accessControlled === false;
343+
const exactPublicBeta =
344+
descriptor.deployment === "public-beta" &&
345+
descriptor.version === "0.4.1" &&
346+
descriptor.hilStatus === "pending" &&
347+
descriptor.accessControlled === false &&
348+
descriptor.releaseJson?.sha256 ===
349+
"8b84fbb65a0463d20369e1d86dac566ca7a2039ebc30f9186f55c05421962445";
310350
if (
311-
descriptor.deployment !== "public" ||
312-
descriptor.hilStatus !== "passed" ||
313-
descriptor.accessControlled !== false ||
351+
(!qualifiedPublic && !exactPublicBeta) ||
314352
typeof descriptor.version !== "string" ||
315353
!semver.test(descriptor.version)
316354
) {
317-
throw new Error("The preserved selector is not an unrestricted passed public release");
355+
throw new Error("The preserved selector is not an unrestricted qualified public release or the exact public beta");
318356
}
319357
process.stdout.write(descriptor.version);
320358
' "${preserved_selection}"
321359
)
360+
firmware_deployment=$(
361+
node -e '
362+
const { readFileSync } = require("node:fs");
363+
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
364+
process.stdout.write(descriptor.deployment);
365+
' "${preserved_selection}"
366+
)
322367
(
323368
cd -- "${preserved_staged_root}/firmware"
324369
ssh -o BatchMode=yes "${deploy_target}" \
@@ -374,7 +419,11 @@ REMOTE
374419
process.stdout.write(commit);
375420
' "${staged_firmware_root}/firmware/v${firmware_version}/release.json"
376421
)
377-
local_firmware_tag_object_before_build=$(verify_local_firmware_tag)
422+
if [[ "${firmware_deployment}" == public-beta ]]; then
423+
printf 'Preserved public-beta state skips annotated tag validation because its exact release root is digest-bound.\n'
424+
else
425+
local_firmware_tag_object_before_build=$(verify_local_firmware_tag)
426+
fi
378427

379428
trusted_firmware_snapshot="${firmware_evidence_root}/trusted-preserved"
380429
mkdir -m 0700 -- "${trusted_firmware_snapshot}"
@@ -459,9 +508,11 @@ if [[ -n "${staged_firmware_root}" ]]; then
459508
install -m 0644 \
460509
"${staged_selection}" \
461510
out/.pyble-firmware-release-selection.json
462-
readonly local_firmware_tag_object_after_build=$(
463-
verify_local_firmware_tag "${local_firmware_tag_object_before_build}"
464-
)
511+
if [[ "${firmware_deployment}" != public-beta ]]; then
512+
local_firmware_tag_object_after_build=$(
513+
verify_local_firmware_tag "${local_firmware_tag_object_before_build}"
514+
)
515+
fi
465516
fi
466517
for firmware_release in out/firmware/v*; do
467518
if [[ ! -d "${firmware_release}" ]]; then
@@ -497,9 +548,11 @@ if [[ -n "${staged_firmware_root}" ]]; then
497548
"${staged_firmware_root}/firmware" \
498549
"${web_directory}/out/firmware" \
499550
"final packaged website firmware"
500-
readonly local_firmware_tag_object_before_upload=$(
501-
verify_local_firmware_tag "${local_firmware_tag_object_after_build}"
502-
)
551+
if [[ "${firmware_deployment}" != public-beta ]]; then
552+
local_firmware_tag_object_before_upload=$(
553+
verify_local_firmware_tag "${local_firmware_tag_object_after_build}"
554+
)
555+
fi
503556
fi
504557
upload_evidence_root=$(mktemp -d)
505558
chmod 0700 "${upload_evidence_root}"

‎tools/web/scripts/prepare-sites-output.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ import { dirname, join, resolve } from "node:path";
1515
import { fileURLToPath, pathToFileURL } from "node:url";
1616

1717
import {
18+
validateFreshDeploymentBundle,
1819
validateStagedFirmwareRelease,
19-
validateWithCanonicalReleaseTool,
2020
} from "./stage-firmware-release.js";
2121

2222
/** @typedef {{ route?: string, status?: string }} PrerenderRoute */
@@ -142,13 +142,13 @@ async function requirePrerenderedRoutes(manifestPath) {
142142
*
143143
* @param {string} packageRoot
144144
* @param {string | undefined} stagedFirmwareRoot
145-
* @param {(bundleDirectory: string, deployment: "public" | "candidate") => Promise<void>} releaseValidator
145+
* @param {(bundleDirectory: string, deployment: "public" | "candidate" | "public-beta") => Promise<void>} releaseValidator
146146
* @returns {Promise<void>}
147147
*/
148148
export async function prepareSitesOutput(
149149
packageRoot,
150150
stagedFirmwareRoot = process.env.PYBLE_FIRMWARE_STAGED_ROOT,
151-
releaseValidator = validateWithCanonicalReleaseTool,
151+
releaseValidator = validateFreshDeploymentBundle,
152152
) {
153153
const selectionFile = process.env.PYBLE_FLASH_SELECTION_FILE;
154154
if (Boolean(stagedFirmwareRoot) !== Boolean(selectionFile)) {

0 commit comments

Comments
 (0)