public
/
airgap
5
0
Fork 1
Code Issues 10 Pull Requests 4 Packages Projects Releases Wiki Activity
A live buildroot based Linux distribution designed for managing secrets offline.
30 Commits 14 Branches 0 Tags 2.1 GiB
Shell 44.8%
Dockerfile 42.2%
Makefile 13%
Go to file
Lance Vick 5622c52526
1.0.0rc3 		2020-07-22 03:02:02 -07:00
config update package list 2020-07-22 02:45:25 -07:00
release 1.0.0rc3 2020-07-22 03:02:02 -07:00
scripts add proper clean script 2020-07-17 18:02:22 -07:00
.gitignore add release verification and signing 2020-07-19 01:31:10 -07:00
Makefile add release verification and signing 2020-07-19 01:31:10 -07:00
README.md overhaul docs to respect current state of affairs 2020-07-19 02:25:06 -07:00

README.md

AirgapOS

https://gitlab.com/pchq/airgap

About

A live buildroot based distribution designed for managing secrets offline.

Built for those of us that want to be -really- sure our most important secrets are managed in a clean environment with an "air gap" between us and the internet with high integrity on the supply chain of the firmware and OS used.

Uses

  • Generate GPG keychain
  • Store/Restore gpg keychain to security token such as a Yubikey or Nitrokey
  • Signing cryptocurrency transactions
  • Generate/backup BIP39 universal cryptocurrency wallet seed
  • Store/Restore BIP39 seed to a hardware wallet such as a Trezor or Ledger

Features

  • Builds Coreboot-heads firmware for all supported devices for measured boot
  • Determinsitic rom/iso generation for multi-party code->binary verification
  • Small footprint (< 100MB)
  • Immutable and Diskless: runs from initramfs
  • Network support and most drivers removed to minimize exfiltration vectors

Supported Devices

Device TPM Model TPM Version Remote Attestation
Librem13v4 Infineon 9465 1.2 HOTP via Nitrokey
Librem15v4 Infineon 9456 1.2 HOTP via Nitrokey

Requirements

Software

  • docker 18+

Hardware

  • Supported PC already running coreboot-heads
    • Ensure any Wifi/Disk/Bluetooth/Audio devices are removed
  • Supported remote attestation key (Librem Key, Nitrokey, etc)
  • Supported GPG smartcard device (Yubikey, Ledger, Trezor, Librem Key, etc)
  • Blank flash drive
  • Blank SD card

Build

  1. Reproduce existing release, or build fresh if never released:

    make VERSION=1.0.0rc1

  2. Compares hashes of newly built iso/rom files with in-tree hashes.txt

    make VERSION=1.0.0rc1 verify

Install

  1. Place contents of release/$VERSION folder on SD card
  2. Boot machine to Heads -> Options -> Flash/Update BIOS
  3. Flash firmware via "Flash the firmware with new ROM, erase settings"
  4. Insert external Remote attestation key and signing key when prompted
  5. Reboot and verify successful remote attestation
  6. Boot to shell: Options -> Recovery Shell
  7. Mount SD card
  8. Insert chosen GPG Smartcard device
  9. Sign target iso gpg --armor --detach-sign airgap*.iso
  10. Reboot

Usage

  1. Insert remote attestation device
  2. Power on, and verify successful remote attestation
  3. Boot to airgap via: Options -> Boot Options -> USB Boot

Release

  1. Verify then make detached signature of given release build with:

    make VERSION=1.0.0rc1 verify sign

  2. Commit signatures.

Development

Build develop image

make

Boot image in qemu

make vm

Enter shell in build environment

make shell