Repository navigation
Expand file tree
/
Copy pathdeploy.sh
More file actions
executable file
·1251 lines (1170 loc) · 46.1 KB
/
Copy pathdeploy.sh
File metadata and controls
executable file
·1251 lines (1170 loc) · 46.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Part of PyBLE (https://pyble.dev) — see /LICENSE.
set -Eeuo pipefail
if [[ $# -ne 1 ]]; then
printf 'Usage: %s <ssh-target>\n' "$0" >&2
printf 'Example: %s root@vps.example\n' "$0" >&2
exit 64
fi
readonly deploy_target=$1
readonly script_directory=$(
cd -- "$(dirname -- "${BASH_SOURCE[0]}")"
pwd
)
readonly web_directory=$(
cd -- "${script_directory}/../.."
pwd
)
readonly repository_root=$(git -C "${web_directory}" rev-parse --show-toplevel)
staged_firmware_root=
firmware_evidence_root=
upload_evidence_root=
firmware_version=
firmware_deployment=
firmware_tag=
firmware_provenance_commit=
firmware_release_json_path=
local_firmware_tag_object_before_build=
local_firmware_tag_object_after_build=
local_firmware_tag_object_before_upload=
staged_validation_flag=--verify-staged
cleanup_firmware_evidence() {
if [[ -n "${firmware_evidence_root}" && -d "${firmware_evidence_root}" ]]; then
chmod -R u+w -- "${firmware_evidence_root}" 2>/dev/null || true
rm -rf -- "${firmware_evidence_root}"
fi
firmware_evidence_root=
}
cleanup_upload_evidence() {
if [[ -n "${upload_evidence_root}" && -d "${upload_evidence_root}" ]]; then
chmod -R u+w -- "${upload_evidence_root}" 2>/dev/null || true
rm -rf -- "${upload_evidence_root}"
fi
upload_evidence_root=
}
cleanup_deployment_evidence() {
cleanup_firmware_evidence
cleanup_upload_evidence
}
trap cleanup_deployment_evidence EXIT
if [[ -n $(find "${web_directory}" \
-mindepth 1 \
-maxdepth 1 \
-name '.env*' \
-print \
-quit) ]]; then
printf 'Refusing deployment: tools/web/.env* nodes can inject unreviewed Next build inputs.\n' >&2
exit 65
fi
if [[ -n ${PYBLE_FLASH_SELECTION_FILE:-} ]]; then
printf 'Refusing deployment: PYBLE_FLASH_SELECTION_FILE is derived only from verified staging.\n' >&2
exit 65
fi
unset PYBLE_FLASH_SELECTION_FILE
readonly explicitly_disable_public_installer=$(
printf '%s' "${PYBLE_EXPLICITLY_DISABLE_PUBLIC_INSTALLER:-0}"
)
case "${explicitly_disable_public_installer}" in
0|1) ;;
*)
printf 'Refusing deployment: PYBLE_EXPLICITLY_DISABLE_PUBLIC_INSTALLER must be 0 or 1.\n' >&2
exit 65
;;
esac
if [[ "${explicitly_disable_public_installer}" == 1 &&
-n ${PYBLE_FIRMWARE_STAGED_ROOT:-} ]]; then
printf 'Refusing deployment: firmware staging and explicit installer disablement are mutually exclusive.\n' >&2
exit 65
fi
if [[ "${explicitly_disable_public_installer}" == 1 ]]; then
printf 'The public installer is explicitly disabled; production smoke will confirm flash.html is unavailable.\n'
fi
if [[ -n $(git -C "${repository_root}" status --porcelain --untracked-files=all --ignore-submodules=untracked) ]]; then
printf 'Refusing to deploy: the complete source tree has uncommitted changes.\n' >&2
exit 65
fi
readonly commit=$(git -C "${repository_root}" rev-parse HEAD)
verify_firmware_tree_parity() {
local expected_tree=$1
local actual_tree=$2
local parity_label=$3
if ! diff --recursive --brief --no-dereference \
"${expected_tree}" "${actual_tree}" >/dev/null; then
printf 'Refusing deployment: %s differs from trusted firmware staging.\n' \
"${parity_label}" >&2
exit 65
fi
}
require_firmware_release_inputs() {
if [[ -z ${PYBLE_FIRMWARE_LICENSE_EVIDENCE_DIR:-} ]]; then
printf 'Refusing firmware activation: PYBLE_FIRMWARE_LICENSE_EVIDENCE_DIR is required.\n' >&2
exit 65
fi
if [[ -z ${PYBLE_FIRMWARE_LICENSE_BUILD_ROOT:-} ]]; then
printf 'Refusing firmware activation: PYBLE_FIRMWARE_LICENSE_BUILD_ROOT is required.\n' >&2
exit 65
fi
if [[ -z ${PYBLE_FIRMWARE_SOURCE_ROOT:-} ]]; then
printf 'Refusing firmware activation: PYBLE_FIRMWARE_SOURCE_ROOT is required.\n' >&2
exit 65
fi
}
verify_local_firmware_tag() {
local expected_tag_object=${1:-}
local tag_ref="refs/tags/${firmware_tag}"
local tag_object=
local tag_type=
local tag_name=
local peeled_commit=
if ! tag_object=$(
git -C "${repository_root}" show-ref --verify --hash "${tag_ref}"
); then
printf 'Refusing public firmware activation: local annotated tag %s is missing.\n' \
"${firmware_tag}" >&2
return 65
fi
if [[ ! "${tag_object}" =~ ^[0-9a-f]{40}$ ]]; then
printf 'Refusing public firmware activation: local tag object is invalid.\n' >&2
return 65
fi
tag_type=$(git -C "${repository_root}" cat-file -t "${tag_object}")
if [[ "${tag_type}" != "tag" ]]; then
printf 'Refusing public firmware activation: %s must be an annotated tag.\n' \
"${firmware_tag}" >&2
return 65
fi
tag_name=$(
git -C "${repository_root}" for-each-ref \
--format='%(tag)' "${tag_ref}"
)
if [[ "${tag_name}" != "${firmware_tag}" ]]; then
printf 'Refusing public firmware activation: annotated tag name mismatch.\n' >&2
return 65
fi
peeled_commit=$(
git -C "${repository_root}" rev-parse --verify "${tag_object}^{commit}"
)
if [[ "${peeled_commit}" != "${firmware_provenance_commit}" ]]; then
printf 'Refusing public firmware activation: release provenance and annotated tag differ.\n' >&2
return 65
fi
if [[ -n "${expected_tag_object}" &&
"${tag_object}" != "${expected_tag_object}" ]]; then
printf 'Refusing public firmware activation: local annotated tag changed during deployment.\n' >&2
return 65
fi
printf '%s\n' "${tag_object}"
}
if [[ -n ${PYBLE_FIRMWARE_STAGED_ROOT:-} ]]; then
staged_firmware_root=$(
cd -- "${PYBLE_FIRMWARE_STAGED_ROOT}"
pwd -P
)
staged_selection="${staged_firmware_root}/.pyble-firmware-release-selection.json"
test -f "${staged_selection}"
test -d "${staged_firmware_root}/firmware"
firmware_deployment=$(
node -e '
const { readFileSync } = require("node:fs");
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
if (!["public", "candidate", "public-beta"].includes(descriptor.deployment)) {
throw new Error("staged firmware deployment is invalid");
}
process.stdout.write(descriptor.deployment);
' "${staged_selection}"
)
require_firmware_release_inputs
PYBLE_FIRMWARE_STAGED_ROOT="${staged_firmware_root}" \
node "${web_directory}/scripts/stage-firmware-release.js" \
--verify-staged
node -e '
const { readFileSync } = require("node:fs");
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
const qualifiedPublic =
descriptor.deployment === "public" &&
descriptor.hilStatus === "passed" &&
descriptor.accessControlled === false;
const exactPublicBeta =
descriptor.deployment === "public-beta" &&
descriptor.version === "0.4.2" &&
descriptor.hilStatus === "pending" &&
descriptor.accessControlled === false &&
descriptor.releaseJson?.sha256 ===
"5d1b0db8c4b90cccf054cd244530afb3b9112d489aa02f7c5da650e92161acde";
if (!qualifiedPublic && !exactPublicBeta) {
throw new Error("The public VPS accepts only a qualified public release or the exact attested public beta");
}
' "${staged_selection}"
firmware_version=$(
node -e '
const { readFileSync } = require("node:fs");
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
process.stdout.write(descriptor.version);
' "${staged_selection}"
)
firmware_tag="firmware-v${firmware_version}"
staged_release_bundle="${staged_firmware_root}/firmware/v${firmware_version}"
firmware_provenance_commit=$(
node -e '
const { readFileSync } = require("node:fs");
const release = JSON.parse(readFileSync(process.argv[1], "utf8"));
const commit = release?.provenance?.pyble?.commit;
if (typeof commit !== "string" || !/^[0-9a-f]{40}$/.test(commit)) {
throw new Error("release.json provenance.pyble.commit is invalid");
}
process.stdout.write(commit);
' "${staged_release_bundle}/release.json"
)
local_firmware_tag_object_before_build=$(verify_local_firmware_tag)
firmware_evidence_root=$(mktemp -d)
chmod 0700 "${firmware_evidence_root}"
trusted_firmware_snapshot="${firmware_evidence_root}/trusted-staged"
mkdir -m 0700 -- "${trusted_firmware_snapshot}"
cp -a -- "${staged_firmware_root}/." "${trusted_firmware_snapshot}/"
verify_firmware_tree_parity \
"${staged_firmware_root}" \
"${trusted_firmware_snapshot}" \
"trusted local firmware snapshot"
PYBLE_FIRMWARE_STAGED_ROOT="${trusted_firmware_snapshot}" \
node "${web_directory}/scripts/stage-firmware-release.js" \
--verify-staged
staged_firmware_root="${trusted_firmware_snapshot}"
staged_selection="${staged_firmware_root}/.pyble-firmware-release-selection.json"
export PYBLE_FIRMWARE_STAGED_ROOT="${staged_firmware_root}"
export PYBLE_FLASH_SELECTION_FILE="${staged_selection}"
fi
if [[ -z "${staged_firmware_root}" &&
"${explicitly_disable_public_installer}" == 0 ]]; then
preserved_state=$(
ssh -o BatchMode=yes "${deploy_target}" bash -s -- \
/srv/pyble/current \
/srv/pyble/releases \
.pyble-firmware-release-selection.json <<'REMOTE'
set -Eeuo pipefail
readonly current_release=$1
readonly release_root=$2
readonly selection_marker=$3
test -L "${current_release}"
managed_release=$(readlink -f -- "${current_release}")
if [[ "${managed_release}" != "${release_root}/"* ]]; then
printf 'Current release is outside the managed release root.\n' >&2
exit 68
fi
test -d "${managed_release}"
selection="${managed_release}/${selection_marker}"
if [[ ! -e "${selection}" ]]; then
printf 'unavailable\n'
exit 0
fi
if [[ -L "${selection}" || ! -f "${selection}" ]]; then
printf 'Active installer selector is not an ordinary file.\n' >&2
exit 68
fi
selection_digest=$(sha256sum -- "${selection}" | awk '{ print $1 }')
printf 'active\t%s\t%s\n' \
"${managed_release}" \
"${selection_digest}"
REMOTE
)
IFS=$'\t' read -r preserved_mode preserved_release \
preserved_selection_digest preserved_extra <<< "${preserved_state}"
if [[ -n "${preserved_extra:-}" ]]; then
printf 'Refusing deployment: active installer state has an invalid shape.\n' >&2
exit 65
fi
case "${preserved_mode}" in
unavailable)
if [[ -n "${preserved_release:-}${preserved_selection_digest:-}" ]]; then
printf 'Refusing deployment: unavailable installer state has extra data.\n' >&2
exit 65
fi
;;
active)
if [[ ! "${preserved_release}" =~ ^/srv/pyble/releases/[A-Za-z0-9._-]+$ ||
! "${preserved_selection_digest}" =~ ^[0-9a-f]{64}$ ]]; then
printf 'Refusing deployment: active installer state is invalid.\n' >&2
exit 65
fi
firmware_evidence_root=$(mktemp -d)
chmod 0700 "${firmware_evidence_root}"
preserved_staged_root="${firmware_evidence_root}/preserved-staged"
mkdir -m 0700 -- \
"${preserved_staged_root}" \
"${preserved_staged_root}/firmware"
preserved_selection="${preserved_staged_root}/.pyble-firmware-release-selection.json"
ssh -o BatchMode=yes "${deploy_target}" bash -s -- \
"${preserved_release}/.pyble-firmware-release-selection.json" <<'REMOTE' \
> "${preserved_selection}"
set -Eeuo pipefail
readonly selection=$1
test ! -L "${selection}"
test -f "${selection}"
cat -- "${selection}"
REMOTE
downloaded_selection_digest=$(
shasum --algorithm 256 -- "${preserved_selection}" |
awk '{ print $1 }'
)
if [[ "${downloaded_selection_digest}" != \
"${preserved_selection_digest}" ]]; then
printf 'Refusing deployment: active installer selector changed during retrieval.\n' >&2
exit 65
fi
firmware_version=$(
node -e '
const { readFileSync } = require("node:fs");
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
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-]+)*)?$/;
const qualifiedPublic =
descriptor.deployment === "public" &&
descriptor.hilStatus === "passed" &&
descriptor.accessControlled === false;
const exactPublicBeta =
descriptor.deployment === "public-beta" &&
descriptor.version === "0.4.2" &&
descriptor.hilStatus === "pending" &&
descriptor.accessControlled === false &&
descriptor.releaseJson?.sha256 ===
"5d1b0db8c4b90cccf054cd244530afb3b9112d489aa02f7c5da650e92161acde";
if (
(!qualifiedPublic && !exactPublicBeta) ||
typeof descriptor.version !== "string" ||
!semver.test(descriptor.version)
) {
throw new Error("The preserved selector is not an unrestricted qualified public release or the exact public beta");
}
process.stdout.write(descriptor.version);
' "${preserved_selection}"
)
firmware_deployment=$(
node -e '
const { readFileSync } = require("node:fs");
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
process.stdout.write(descriptor.deployment);
' "${preserved_selection}"
)
if [[ "${firmware_deployment}" == public-beta ]]; then
require_firmware_release_inputs
fi
(
cd -- "${preserved_staged_root}/firmware"
ssh -o BatchMode=yes "${deploy_target}" \
tar --create --file=- \
--directory=/srv/pyble/firmware \
"v${firmware_version}" |
tar --extract --file=-
)
ssh -o BatchMode=yes "${deploy_target}" bash -s -- \
/srv/pyble/current \
"${preserved_release}" \
"${preserved_release}/.pyble-firmware-release-selection.json" \
"${preserved_selection_digest}" \
"/srv/pyble/firmware/v${firmware_version}" <<'REMOTE'
set -Eeuo pipefail
readonly current_release=$1
readonly expected_release=$2
readonly selection=$3
readonly expected_selection_digest=$4
readonly firmware_release=$5
test "$(readlink -f -- "${current_release}")" = "${expected_release}"
test ! -L "${selection}"
test -f "${selection}"
actual_selection_digest=$(
sha256sum -- "${selection}" |
awk '{ print $1 }'
)
test "${actual_selection_digest}" = "${expected_selection_digest}"
test ! -L "${firmware_release}"
test -d "${firmware_release}"
(
cd -- "${firmware_release}"
sha256sum --check SHA256SUMS >/dev/null
)
REMOTE
PYBLE_FIRMWARE_STAGED_ROOT="${preserved_staged_root}" \
node "${web_directory}/scripts/stage-firmware-release.js" \
--verify-preserved-staged
staged_firmware_root="${preserved_staged_root}"
staged_selection="${preserved_selection}"
firmware_tag="firmware-v${firmware_version}"
firmware_provenance_commit=$(
node -e '
const { readFileSync } = require("node:fs");
const release = JSON.parse(readFileSync(process.argv[1], "utf8"));
const commit = release?.provenance?.pyble?.commit;
if (typeof commit !== "string" || !/^[0-9a-f]{40}$/.test(commit)) {
throw new Error("release.json provenance.pyble.commit is invalid");
}
process.stdout.write(commit);
' "${staged_firmware_root}/firmware/v${firmware_version}/release.json"
)
local_firmware_tag_object_before_build=$(verify_local_firmware_tag)
trusted_firmware_snapshot="${firmware_evidence_root}/trusted-preserved"
mkdir -m 0700 -- "${trusted_firmware_snapshot}"
cp -a -- "${staged_firmware_root}/." "${trusted_firmware_snapshot}/"
verify_firmware_tree_parity \
"${staged_firmware_root}" \
"${trusted_firmware_snapshot}" \
"trusted preserved firmware snapshot"
PYBLE_FIRMWARE_STAGED_ROOT="${trusted_firmware_snapshot}" \
node "${web_directory}/scripts/stage-firmware-release.js" \
--verify-preserved-staged
staged_firmware_root="${trusted_firmware_snapshot}"
staged_selection="${staged_firmware_root}/.pyble-firmware-release-selection.json"
staged_validation_flag=--verify-preserved-staged
export PYBLE_FIRMWARE_STAGED_ROOT="${staged_firmware_root}"
export PYBLE_FLASH_SELECTION_FILE="${staged_selection}"
;;
*)
printf 'Refusing deployment: current installer state is invalid.\n' >&2
exit 65
;;
esac
fi
if [[ -n "${staged_firmware_root}" ]]; then
firmware_release_json_path=$(
node -e '
const { readFileSync } = require("node:fs");
const descriptor = JSON.parse(readFileSync(process.argv[1], "utf8"));
const path = descriptor?.releaseJson?.path;
if (
typeof path !== "string" ||
path !== `/firmware/v${descriptor.version}/release.json`
) {
throw new Error("selected release.json path is invalid");
}
process.stdout.write(path);
' "${staged_selection}"
)
fi
readonly release_timestamp=$(date -u +%Y%m%dT%H%M%SZ)
readonly release_name="${release_timestamp}-${commit:0:12}"
readonly release_root=/srv/pyble/releases
readonly incoming_release="${release_root}/.${release_name}.incoming"
readonly final_release="${release_root}/${release_name}"
readonly current_release=/srv/pyble/current
readonly firmware_root=/srv/pyble/firmware
readonly firmware_publish_lock=/srv/pyble/.firmware-publish.lock
readonly activation_watchdog_unit="pyble-activation-${release_name}"
readonly activation_confirmation="/srv/pyble/.${release_name}.confirmed"
cd -- "${web_directory}"
if [[ -z "${staged_firmware_root}" ]]; then
rm -rf -- out/firmware
fi
rm -f -- out/.pyble-firmware-release-selection.json
npm ci
NEXT_TELEMETRY_DISABLED=1 npm run check
readonly commit_after_build=$(git -C "${repository_root}" rev-parse HEAD)
if [[ "${commit_after_build}" != "${commit}" ]]; then
printf 'Refusing deployment: source HEAD changed during the website build.\n' >&2
exit 65
fi
if [[ -n $(git -C "${repository_root}" status --porcelain --untracked-files=all --ignore-submodules=untracked) ]]; then
printf 'Refusing deployment: the source tree changed during the website build.\n' >&2
exit 65
fi
test ! -e out/firmware
test ! -e out/.pyble-firmware-release-selection.json
if [[ -n "${staged_firmware_root}" ]]; then
cp -R "${staged_firmware_root}/firmware" out/
PYBLE_FIRMWARE_STAGED_ROOT="${staged_firmware_root}" \
node "${web_directory}/scripts/stage-firmware-release.js" \
"${staged_validation_flag}"
verify_firmware_tree_parity \
"${staged_firmware_root}/firmware" \
"${web_directory}/out/firmware" \
"packaged website firmware"
install -m 0644 \
"${staged_selection}" \
out/.pyble-firmware-release-selection.json
local_firmware_tag_object_after_build=$(
verify_local_firmware_tag "${local_firmware_tag_object_before_build}"
)
fi
for firmware_release in out/firmware/v*; do
if [[ ! -d "${firmware_release}" ]]; then
continue
fi
test -f "${firmware_release}/release.json"
test -f "${firmware_release}/SHA256SUMS"
(
cd -- "${firmware_release}"
shasum --algorithm 256 --check SHA256SUMS
)
done
readonly final_source_commit=$(git -C "${repository_root}" rev-parse HEAD)
if [[ "${final_source_commit}" != "${commit}" ]]; then
printf 'Refusing deployment: source HEAD changed before upload.\n' >&2
exit 65
fi
if [[ -n $(git -C "${repository_root}" status --porcelain --untracked-files=all --ignore-submodules=untracked) ]]; then
printf 'Refusing deployment: the source tree changed before upload.\n' >&2
exit 65
fi
readonly source_commit_marker=.pyble-source-commit
test ! -e "out/${source_commit_marker}"
install -m 0644 /dev/null "out/${source_commit_marker}"
printf '%s\n' "${commit}" > "out/${source_commit_marker}"
if [[ -n "${staged_firmware_root}" ]]; then
PYBLE_FIRMWARE_STAGED_ROOT="${staged_firmware_root}" \
node "${web_directory}/scripts/stage-firmware-release.js" \
"${staged_validation_flag}"
verify_firmware_tree_parity \
"${staged_firmware_root}/firmware" \
"${web_directory}/out/firmware" \
"final packaged website firmware"
local_firmware_tag_object_before_upload=$(
verify_local_firmware_tag "${local_firmware_tag_object_after_build}"
)
fi
upload_evidence_root=$(mktemp -d)
chmod 0700 "${upload_evidence_root}"
readonly upload_snapshot_candidate="${upload_evidence_root}/site"
mkdir -m 0700 -- "${upload_snapshot_candidate}"
cp -a -- out/. "${upload_snapshot_candidate}/"
readonly trusted_upload_snapshot="${upload_snapshot_candidate}"
if ! diff --recursive --brief --no-dereference \
out "${trusted_upload_snapshot}" >/dev/null; then
printf 'Refusing deployment: private upload snapshot differs from final verified output.\n' >&2
exit 65
fi
if [[ -n "${staged_firmware_root}" ]]; then
verify_firmware_tree_parity \
"${staged_firmware_root}/firmware" \
"${trusted_upload_snapshot}/firmware" \
"trusted upload snapshot firmware"
fi
readonly trusted_site_inventory_name=.pyble-site-inventory.sha256
readonly trusted_site_inventory="${trusted_upload_snapshot}/${trusted_site_inventory_name}"
python3 - \
"${trusted_upload_snapshot}" \
"${trusted_site_inventory}" <<'PYTHON'
from __future__ import annotations
import hashlib
from pathlib import Path
import re
import stat
import sys
root = Path(sys.argv[1])
inventory = Path(sys.argv[2])
safe_path = re.compile(r"[A-Za-z0-9._/-]+")
records: list[tuple[str, str]] = []
for candidate in sorted(root.rglob("*"), key=lambda path: path.as_posix()):
metadata = candidate.lstat()
relative = candidate.relative_to(root).as_posix()
if not safe_path.fullmatch(relative):
raise SystemExit(f"unsafe upload snapshot path: {relative!r}")
if stat.S_ISDIR(metadata.st_mode):
continue
if not stat.S_ISREG(metadata.st_mode):
raise SystemExit(f"upload snapshot contains a non-regular node: {relative}")
if candidate == inventory:
raise SystemExit("trusted inventory already exists in upload snapshot")
digest = hashlib.sha256()
with candidate.open("rb") as source:
for chunk in iter(lambda: source.read(1024 * 1024), b""):
digest.update(chunk)
records.append((relative, digest.hexdigest()))
if not records:
raise SystemExit("upload snapshot is empty")
with inventory.open("x", encoding="ascii", newline="\n") as output:
for relative, digest in records:
output.write(f"{digest} ./{relative}\n")
PYTHON
readonly trusted_site_inventory_digest=$(
shasum --algorithm 256 -- "${trusted_site_inventory}" |
awk '{ print $1 }'
)
if [[ ! "${trusted_site_inventory_digest}" =~ ^[0-9a-f]{64}$ ]]; then
printf 'Refusing deployment: trusted site inventory digest is invalid.\n' >&2
exit 65
fi
(
cd -- "${trusted_upload_snapshot}"
shasum --algorithm 256 --check "${trusted_site_inventory_name}" >/dev/null
)
if [[ -n "${staged_firmware_root}" ]]; then
readonly expected_installer_state=active
readonly expected_selection_digest=$(
shasum --algorithm 256 -- \
"${trusted_upload_snapshot}/.pyble-firmware-release-selection.json" |
awk '{ print $1 }'
)
else
readonly expected_installer_state=disabled
readonly expected_selection_digest=none
test ! -e \
"${trusted_upload_snapshot}/.pyble-firmware-release-selection.json"
fi
find "${trusted_upload_snapshot}" -type d -exec chmod 0500 {} +
find "${trusted_upload_snapshot}" -type f -exec chmod 0400 {} +
ssh -o BatchMode=yes "${deploy_target}" \
"install -d -m 0755 '${release_root}' '${firmware_root}' && install -d -m 0755 '${incoming_release}'"
rsync \
--archive \
--delete \
--no-owner \
--no-group \
-- \
"${trusted_upload_snapshot}/" \
"${deploy_target}:${incoming_release}/"
previous_release=$(
ssh -o BatchMode=yes "${deploy_target}" bash -s -- \
"${incoming_release}" \
"${final_release}" \
"${current_release}" \
"${firmware_root}" \
"${firmware_publish_lock}" \
"${release_name}" \
"${activation_watchdog_unit}" \
"${activation_confirmation}" \
"${commit}" \
"${trusted_site_inventory_name}" \
"${trusted_site_inventory_digest}" \
"${expected_installer_state}" \
"${expected_selection_digest}" <<'REMOTE'
set -Eeuo pipefail
readonly incoming_release=$1
readonly final_release=$2
readonly current_release=$3
readonly firmware_root=$4
readonly firmware_publish_lock=$5
readonly release_name=$6
readonly activation_watchdog_unit=$7
readonly activation_confirmation=$8
readonly expected_source_commit=$9
readonly trusted_site_inventory_name=${10}
readonly expected_trusted_site_inventory_digest=${11}
readonly expected_installer_state=${12}
readonly expected_selection_digest=${13}
readonly trusted_site_inventory="${incoming_release}/${trusted_site_inventory_name}"
readonly next_link="${current_release}.next"
readonly release_root=$(dirname -- "${final_release}")
test -L "${current_release}"
previous_release=$(readlink -f -- "${current_release}")
if [[ "${previous_release}" != "${release_root}/"* ]]; then
printf 'Current release is outside the managed release root: %s\n' \
"${previous_release}" >&2
exit 68
fi
test -d "${previous_release}"
activation_started=0
watchdog_armed=0
disarm_activation_watchdog() {
systemctl stop "${activation_watchdog_unit}.timer" >/dev/null 2>&1 || true
systemctl stop "${activation_watchdog_unit}.service" >/dev/null 2>&1 || true
systemctl reset-failed "${activation_watchdog_unit}.service" \
>/dev/null 2>&1 || true
rm -f -- "${activation_confirmation}"
watchdog_armed=0
}
rollback_activation() {
local activation_status=$?
if [[ "${activation_status}" -eq 0 ]]; then
activation_status=70
fi
trap - ERR HUP INT TERM
if [[ "${activation_started}" -eq 1 ]]; then
printf 'Activation failed; restoring %s.\n' "${previous_release}" >&2
local restore_link="${current_release}.restore"
rm -f -- "${restore_link}"
ln -s -- "${previous_release}" "${restore_link}"
mv -Tf -- "${restore_link}" "${current_release}"
if ! systemctl reload nginx; then
printf 'CRITICAL: Nginx reload failed while restoring %s.\n' \
"${previous_release}" >&2
fi
fi
if [[ "${watchdog_armed}" -eq 1 ]]; then
disarm_activation_watchdog
fi
exit "${activation_status}"
}
trap rollback_activation ERR HUP INT TERM
if [[ -n $(find "${incoming_release}" \
-mindepth 1 \
! -type d \
! -type f \
-print \
-quit) ]]; then
printf 'Incoming website contains a non-regular filesystem node.\n' >&2
exit 69
fi
test -f "${trusted_site_inventory}"
actual_trusted_site_inventory_digest=$(
sha256sum "${trusted_site_inventory}" |
awk '{ print $1 }'
)
if [[ "${actual_trusted_site_inventory_digest}" != \
"${expected_trusted_site_inventory_digest}" ]]; then
printf 'Trusted site inventory digest mismatch before activation.\n' >&2
exit 69
fi
remote_inventory_check_root=$(mktemp -d)
cleanup_remote_inventory_check() {
rm -rf -- "${remote_inventory_check_root}"
}
trap cleanup_remote_inventory_check EXIT
readonly actual_site_file_list="${remote_inventory_check_root}/actual"
readonly expected_site_file_list="${remote_inventory_check_root}/expected"
(
cd -- "${incoming_release}"
find . -type f -print |
LC_ALL=C sort > "${actual_site_file_list}"
sed -E 's/^[0-9a-f]{64} //' \
"${trusted_site_inventory_name}" > "${expected_site_file_list}"
printf './%s\n' "${trusted_site_inventory_name}" >> \
"${expected_site_file_list}"
LC_ALL=C sort -o "${expected_site_file_list}" \
"${expected_site_file_list}"
diff --unified "${expected_site_file_list}" "${actual_site_file_list}"
sha256sum --check "${trusted_site_inventory_name}" >/dev/null
)
cleanup_remote_inventory_check
trap - EXIT
chown -R root:root "${incoming_release}"
find "${incoming_release}" -type d -exec chmod 0755 {} +
find "${incoming_release}" -type f -exec chmod 0644 {} +
for required_file in \
index.html \
404.html \
privacy.html \
support.html \
flash.html \
robots.txt \
sitemap.xml \
manifest.webmanifest \
.pyble-source-commit \
WEBSITE_THIRD_PARTY_LICENSES.txt; do
test -f "${incoming_release}/${required_file}"
done
test "$(cat "${incoming_release}/.pyble-source-commit")" = \
"${expected_source_commit}"
if [[ "${expected_installer_state}" == active ]]; then
selection="${incoming_release}/.pyble-firmware-release-selection.json"
test ! -L "${selection}"
test -f "${selection}"
actual_selection_digest=$(
sha256sum -- "${selection}" |
awk '{ print $1 }'
)
test "${actual_selection_digest}" = "${expected_selection_digest}"
elif [[ "${expected_installer_state}" == disabled ]]; then
test "${expected_selection_digest}" = none
test ! -e \
"${incoming_release}/.pyble-firmware-release-selection.json"
else
printf 'Incoming website installer state is invalid.\n' >&2
exit 69
fi
for firmware_release in "${incoming_release}"/firmware/v*; do
if [[ ! -d "${firmware_release}" ]]; then
continue
fi
test -f "${firmware_release}/release.json"
test -f "${firmware_release}/SHA256SUMS"
(
cd -- "${firmware_release}"
sha256sum --check SHA256SUMS >/dev/null
)
done
exec 9>"${firmware_publish_lock}"
flock --exclusive 9
for firmware_release in "${incoming_release}"/firmware/v*; do
if [[ ! -d "${firmware_release}" ]]; then
continue
fi
if [[ -n $(find "${firmware_release}" -type l -print -quit) ]]; then
printf 'Firmware release contains a symbolic link: %s\n' \
"${firmware_release}" >&2
exit 69
fi
firmware_name=$(basename -- "${firmware_release}")
if [[ ! "${firmware_name}" =~ ^v(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-]+)*)?$ ]]; then
printf 'Invalid immutable firmware version directory: %s\n' \
"${firmware_name}" >&2
exit 69
fi
published_firmware_release="${firmware_root}/${firmware_name}"
if [[ -e "${published_firmware_release}" ]]; then
if [[ -L "${published_firmware_release}" || ! -d "${published_firmware_release}" ]]; then
printf 'Immutable firmware path is not an ordinary directory: %s\n' \
"${published_firmware_release}" >&2
exit 69
fi
(
cd -- "${published_firmware_release}"
sha256sum --check SHA256SUMS >/dev/null
)
if ! diff --recursive --brief --no-dereference \
"${firmware_release}" "${published_firmware_release}" >/dev/null; then
printf 'Refusing divergent reuse of immutable firmware %s.\n' \
"${firmware_name}" >&2
exit 69
fi
continue
fi
firmware_publish_incoming="/srv/pyble/.${firmware_name}.${release_name}.incoming"
test ! -e "${firmware_publish_incoming}"
if ! cp -a -- "${firmware_release}" "${firmware_publish_incoming}"; then
rm -rf -- "${firmware_publish_incoming}"
exit 69
fi
if ! diff --recursive --brief --no-dereference \
"${firmware_release}" "${firmware_publish_incoming}" >/dev/null; then
rm -rf -- "${firmware_publish_incoming}"
printf 'Immutable firmware copy changed before publication: %s\n' \
"${firmware_name}" >&2
exit 69
fi
mv -- "${firmware_publish_incoming}" "${published_firmware_release}"
done
test ! -e "${final_release}"
nginx -t
mv -- "${incoming_release}" "${final_release}"
rm -f -- "${next_link}"
ln -s -- "${final_release}" "${next_link}"
# Arm a transport-independent rollback before switching current. The transient
# timer remains live after this SSH process exits and restores the prior release
# unless the caller records successful production smoke and cancels it.
rm -f -- "${activation_confirmation}"
watchdog_armed=1
systemd-run --quiet --collect --expand-environment=no \
--unit="${activation_watchdog_unit}" \
--on-active=15min \
/bin/bash -c '
set -Eeuo pipefail
readonly confirmation=$1
readonly previous_release=$2
readonly expected_release=$3
readonly current_release=$4
for ((guard_attempt = 0; guard_attempt < 60; guard_attempt += 1)); do
if [[ ! -e "${confirmation}" ]]; then
break
fi
sleep 1
done
test -d "${previous_release}"
if [[ ! -L "${current_release}" ]]; then
exit 0
fi
current_target=$(readlink -f -- "${current_release}")
if [[ "${current_target}" != "${expected_release}" ]]; then
exit 0
fi
printf "Activation watchdog restoring %s after missing confirmation.\n" \
"${previous_release}" >&2
readonly restore_link="${current_release}.watchdog-restore"
rm -f -- "${restore_link}"
ln -s -- "${previous_release}" "${restore_link}"
mv -Tf -- "${restore_link}" "${current_release}"
nginx -t
systemctl reload nginx
' pyble-activation-watchdog \
"${activation_confirmation}" \
"${previous_release}" \
"${final_release}" \
"${current_release}"
activation_started=1
mv -Tf -- "${next_link}" "${current_release}"
systemctl reload nginx
printf '%s\n' "${previous_release}"
activation_started=0
trap - ERR HUP INT TERM
REMOTE
)
readonly previous_release
if [[ -n "${staged_firmware_root}" ]]; then
cleanup_firmware_evidence
fi
rollback_release() {
ssh -o BatchMode=yes "${deploy_target}" bash -s -- \
"${previous_release}" \
"${final_release}" \
"${current_release}" \
"${activation_watchdog_unit}" \
"${activation_confirmation}" <<'REMOTE'
set -euo pipefail
readonly previous_release=$1
readonly final_release=$2
readonly current_release=$3
readonly activation_watchdog_unit=$4
readonly activation_confirmation=$5
readonly restore_link="${current_release}.restore"
test -d "${previous_release}"
test -L "${current_release}"
current_target=$(readlink -f -- "${current_release}")
if [[ "${current_target}" != "${final_release}" && "${current_target}" != "${previous_release}" ]]; then
printf 'Refusing rollback over a different current release: %s\n' \
"${current_target}" >&2
exit 71
fi
if [[ "${current_target}" == "${final_release}" ]]; then
rm -f -- "${restore_link}"
ln -s -- "${previous_release}" "${restore_link}"
mv -Tf -- "${restore_link}" "${current_release}"
fi
nginx -t
systemctl reload nginx
systemctl stop "${activation_watchdog_unit}.timer" >/dev/null 2>&1 || true
systemctl stop "${activation_watchdog_unit}.service" >/dev/null 2>&1 || true
systemctl reset-failed "${activation_watchdog_unit}.service" \
>/dev/null 2>&1 || true
rm -f -- "${activation_confirmation}"
REMOTE
}
confirm_activation() {
ssh -o BatchMode=yes "${deploy_target}" bash -s -- \
"${final_release}" \
"${current_release}" \
"${previous_release}" \
"${activation_watchdog_unit}" \
"${activation_confirmation}" <<'REMOTE'
set -Eeuo pipefail
readonly final_release=$1
readonly current_release=$2
readonly previous_release=$3
readonly activation_watchdog_unit=$4
readonly activation_confirmation=$5
readonly activation_confirmation_unit="${activation_watchdog_unit}-confirmation"
# The confirmation transaction is owned by systemd, so loss of this SSH
# transport cannot interrupt watchdog cancellation halfway through.
systemd-run --quiet --wait --collect --expand-environment=no \
--unit="${activation_confirmation_unit}" \
/bin/bash -c '