Initial public import of the proven Bash installer (installer/) and the production Rust workspace (installer-rs/). The reference ISO, build output and local agent transcripts are gitignored. Verified: installer/tests/run_tests.sh and cargo test --workspace both pass.
63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# Disposable UEFI VM harness
|
|
|
|
Proves that the installer produces a bootable encrypted system without ever
|
|
touching a physical disk. The target is always a qcow2 file.
|
|
|
|
## Files
|
|
|
|
- `run-vm.sh` interactive QEMU launcher (manual testing).
|
|
- `install.sh` guest-side, non-interactive installation (run in the VM).
|
|
- `serial-driver.py` host-side pexpect driver (`install` and `boot` modes).
|
|
- `test.conf.example` installer configuration used by the driver.
|
|
|
|
## Host prerequisites
|
|
|
|
- `qemu-system-x86_64`, `qemu-img`, OVMF firmware, Python `pexpect`.
|
|
- The reference Gentoo ISO.
|
|
|
|
## Procedure
|
|
|
|
Serve the installer, the stage3 and the config to the guest:
|
|
|
|
```sh
|
|
cd /path/to/serve
|
|
tar czf installer.tar.gz -C /path/to/phoebus_os installer
|
|
cp installer/tests/vm/install.sh .
|
|
cp installer/tests/vm/test.conf.example test.conf # edit TARGET_DISK etc.
|
|
sha256sum stage3.tar.xz # set STAGE3_SHA256
|
|
python3 -m http.server 8000 --bind 127.0.0.1
|
|
```
|
|
|
|
Run the installation (driver boots the ISO kernel/initrd directly and drives
|
|
the serial console):
|
|
|
|
```sh
|
|
QEMU_BIN=/path/to/qemu-system-x86_64 \
|
|
QEMU_LIBDIR=/path/to/qemu/libs \
|
|
QEMU_DATADIR=/path/to/qemu/share \
|
|
OVMF_CODE=/path/to/OVMF_CODE_4M.fd \
|
|
OVMF_VARS=/path/to/OVMF_VARS.fd \
|
|
DISK=/tmp/phoebus/target.qcow2 \
|
|
ISO=/path/to/livegui-amd64.iso \
|
|
KERNEL=/tmp/live/boot/gentoo INITRD=/tmp/live/boot/gentoo.igz \
|
|
INSTALL_URL=http://10.0.2.2:8000/install.sh \
|
|
python3 installer/tests/vm/serial-driver.py install
|
|
```
|
|
|
|
Then boot the disk alone (ISO detached) and verify:
|
|
|
|
```sh
|
|
DISK=/tmp/phoebus/target.qcow2 OVMF_CODE=... OVMF_VARS=... \
|
|
python3 installer/tests/vm/serial-driver.py boot
|
|
```
|
|
|
|
To patch a console into an existing entry for observation, the BLS entry in
|
|
`/efi/loader/entries/*.conf` takes an `options` line; the installer can also
|
|
embed a console via `KERNEL_CONSOLE` (`GENTOO_KERNEL_CONSOLE` equivalent).
|
|
|
|
## Safety
|
|
|
|
- `DISK` must be a qcow2 image; never point it at `/dev/*`.
|
|
- The installer itself classifies the ISO's device as protected.
|
|
- Secrets are passed through 0600 files and are checked for leakage in the
|
|
installer log by `install.sh`.
|