Skip to content
NAILS on GitHub
These docs describe NAILS 0.3, published so far as the release candidate v0.3.0-rc.3. They do not apply to v0.2.0, the latest stable release. Download and verify NAILS 0.3

NAILS documentation

NAILS is a command-line tool that runs a hidden session on an ordinary-looking Linux system, called the decoy. It soft-reboots the machine into one OverlayFS overlay over the whole decoy root, with the session’s changes written to an encrypted hidden volume you provide, and soft-reboots back to the plain decoy when you are done. Nothing that starts the hidden session is installed on the decoy.

  • The decoy is the installed system. It should stay mundane and plausible.
  • The hidden session is the same system started again on an overlay whose writable layer lives on a hidden volume. You unlock and mount that volume yourself, for example a VeraCrypt hidden volume or a LUKS2 volume.

Only one of them runs at a time. Switching from one to the other logs you out.

NAILS encrypts nothing itself. The hidden volume, and whether its existence can be denied, come from the storage backend you choose, and NAILS adds nothing to the backend’s own claim. The FAQ gives short answers to common questions, and the comparison page shows how NAILS differs from VeraCrypt, Tails and other tools.

Every instruction in these docs belongs to one of three places. Keeping them apart is what keeps the decoy clean.

PlaceWhat happens there
A live system or another machineCreating the hidden volume, and downloading, verifying and copying the release onto it. The decoy never sees this work. Tails is one such live system. It cannot create a VeraCrypt volume, so make that with VeraCrypt on another computer, and First install from Tails shows the rest.
The decoyUnlocking and mounting the hidden volume, nails init once, nails check and nails activate, and when needed nails recover or nails reset-upper. A forensic examiner images this system, so type as little as possible here.
The hidden sessionEverything between activation and the way back. Its changes land on the hidden volume.

These pages are a shorter guide, in task order, drawn from the documentation in the NAILS repository. Each page links to its full version. Where the two differ, the repository is authoritative.