Blueforce-Linux/config/wireguard/README.md
emirhanmamak-blueforce ef102b9657 feat(field-os): provisioning layer, real ISO build, offline contracts
Adds the Blueforce Field OS provisioning stack on top of the existing fleet
architecture, without rewriting the working systems (installer, diagnostics,
Ansible, WireGuard/SSH/xRDP/RustDesk, Docker policies, monitoring, Docusaurus).

ISO build (the previous builder was a skeleton that produced no medium):
- boot layout is read from the base ISO at build time via
  `xorriso -report_el_torito as_mkisofs` and rebuilt with `-as mkisofs`;
  `-boot_image any replay` cannot work on Ubuntu live ISOs because the GRUB2
  MBR lives in the source image's first 16 sectors and the EFI system partition
  is an appended partition, neither of which is a file in the ISO9660 tree
- preflight now asserts El Torito boot metadata positively: xorriso exits 0 on
  a non-ISO input, which previously let an arbitrary file pass --check
- artifact produced and verified: dist/Blueforce-Field-OS-1.0.0-amd64.iso,
  6 481 917 952 bytes, SHA256 cb0cc56f...d431296, BIOS+UEFI entries preserved,
  /autoinstall.yaml at the media root, casper/minimal.squashfs byte-identical
  to the base
- recorded baseline deviation: the verified medium on the build host is the
  Desktop flavour, so the manifest carries a baseline_deviation block instead
  of hiding it; Server remains one flag away

Offline and identity:
- offline APT contract with concrete package requirements, pin format and an
  audit table; builds fail closed while pins are UNPINNED
- autoinstall keeps interactive-sections: [storage]: the operator confirms the
  target disk, and no automatic wipe is ever performed
- firstboot terminal wizard for the 8-digit dealer id, three-state lifecycle
  (PROVISIONED_OFFLINE -> ENROLLED -> READY) with fail-closed gates, so a
  missing internet link or WireGuard handshake cannot fail provisioning but can
  never produce a false READY

Fleet and migration:
- five read-only Ansible playbooks for Field OS version, provisioning,
  enrollment, remote channels and offline readiness, all wave-scoped with a
  separate production override
- Windows pre-migration inventory and data export extended to the full brief
  scope, read-only, never collecting credentials

Tests: tests/run-all.sh -> 8/8 pass, exit 0. Boot acceptance (UEFI, Legacy
BIOS, Secure Boot), air-gapped install, real enrollment endpoint and Windows
rollback remain LAB work and are listed in IMPLEMENTATION-REPORT.md.
2026-09-16 11:14:42 +03:00

34 lines
1.4 KiB
Markdown

<!-- Purpose: Explain how to turn wg0.conf.example into a live spoke config. -->
<!-- Scope: Hub-spoke layout, peer naming, keepalive, PostUp/PostDown, bring-up. -->
<!-- Safety: No secrets here; every key and address marked <REPLACE> stays out of git. -->
# WireGuard spoke reference
Ref: `docs/08-WIREGUARD-AND-NETWORK.md` (K-05), naming `K-12`.
## Layout
- Hub-spoke: the central server is the hub (`10.8.0.1`), each field device is a spoke.
- Peer name equals the device identity: `bf-<8digits>` (hostname, inventory, monitoring label).
- Each spoke gets one fixed tunnel IP (`10.8.0.x/32`) from inventory.
## Filling the example
1. Copy `wg0.conf.example` to `/etc/wireguard/wg0.conf` (mode `600`).
2. Replace `Address` with the device tunnel IP from inventory.
3. Replace `<REPLACE_DEVICE_PRIVATE_KEY>` with the device private key.
4. Replace `<REPLACE_HUB_PUBLIC_KEY>` and `<REPLACE_HUB_HOST>` with hub values.
5. Keep `PersistentKeepalive = 25` (official reasonable default for NAT peers).
6. Keep `PostUp`/`PostDown`: they scope SSH (22) and RDP (3389) rules to `wg0`.
## Bring-up
```bash
sudo install -m 600 wg0.conf /etc/wireguard/wg0.conf
sudo systemctl enable --now wg-quick@wg0
sudo wg show wg0 latest-handshakes
```
## Notes
- Spokes behind CGNAT must always initiate outward; the hub only listens on `51820/udp`.
- Placeholders marked `<REPLACE>` must never hold real keys in this repo.