zfs-unlock 0.4.1

Unlock encrypted OpenZFS datasets over a restricted SSH receiver

ZFS Unlock

Unlock encrypted OpenZFS datasets over SSH, through a restricted NAS-side receiver, with passphrases kept on a separate trusted machine.

Why?

This is the NixOS/OpenZFS counterpart to truenas-unlock.

ZFS native encryption is useful, but:

1. Storing keys on the NAS defeats the purpose—if it's stolen, the thief has both the encrypted data and the keys
2. Manual unlocking is tedious—after every reboot, you need to manually decrypt each dataset

This tool solves both problems with the same "poor-man's second-factor" setup as truenas-unlock:

1. Run zfs-unlock on a separate device (Raspberry Pi, home server, etc.)
2. Store encryption passphrases only on that device
3. Datasets auto-unlock when both devices are on the network
4. If the NAS is stolen, data remains encrypted and inaccessible

Unlike a plain root SSH key, the NAS-side path is intentionally narrow:

• a dedicated zfs-unlock SSH user
• an SSH key restricted with restrict, from=..., and command=...
• sudo permission only for a root-owned receiver wrapper
• a NAS-side dataset allowlist
• a receiver parser that only accepts status, unlock, and lock

Think of it as a hardware security key for your storage—hidden somewhere in your house, it automatically unlocks your datasets whenever your NAS boots. No manual intervention required.

Table of Contents

• Install
• Setup
• Usage
• CLI
• Running as a Service
• Development
• Credits
• License

Install

# With uv (recommended)
uv tool install zfs-unlock

# With pip
pip install zfs-unlock

Setup

Generate a dedicated SSH key on the off-box unlock device:

zfs-unlock keygen --identity-file ~/.ssh/zfs-unlock-nas --comment pi4-zfs-unlock

Add the printed public key to the NAS-side authorizedKeys list below, then create ~/.config/zfs-unlock/config.yaml on the off-box unlock device:

host: nas.local
user: zfs-unlock
identity_file: ~/.ssh/zfs-unlock-nas
# command_timeout: 30

# secrets: auto  # auto (default) | files | inline

datasets:
  tank/syncthing: ~/.secrets/syncthing-key
  tank/photos: my-literal-passphrase

The secrets mode controls how values are interpreted:

• auto (default): if file exists, read from it; otherwise use as literal
• files: always treat values as file paths
• inline: always treat values as literal secrets

On the NAS, enable the forced-command receiver. With flakes, add zfs-unlock as an input and include its NixOS module in the NAS module list:

{
  inputs.zfs-unlock.url = "github:basnijholt/zfs-unlock";

  outputs = { nixpkgs, zfs-unlock, ... }: {
    nixosConfigurations.nas = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        zfs-unlock.nixosModules.receiver
        ./hosts/nas/default.nix
      ];
    };
  };
}

Then configure only the receiver policy on the NAS:

{
  services.zfsUnlock.receiver = {
    enable = true;
    allowedFrom = [ "192.168.1.50" ];
    authorizedKeys = [
      "ssh-ed25519 AAAA... unlock-device"
    ];
    datasets = [
      "tank/syncthing"
      "tank/photos"
    ];
  };
}

The module creates the zfs-unlock SSH user, forced command, sudo rule, receiver wrapper, login shell, and /etc/zfs-unlock/allowed-datasets. The receiver still checks each requested dataset against that allowlist.

On a NixOS unlock device, include the client module and enable the daemon:

{
  imports = [
    zfs-unlock.nixosModules.client
  ];

  services.zfsUnlock.client = {
    enable = true;
    user = "alice";
    group = "users";
  };
}

The client module creates a zfs-unlock.service system service, runs the packaged zfs-unlock executable, installs that CLI into the system profile, adds OpenSSH to the service PATH, and sets HOME/XDG_CONFIG_HOME so the normal user config is found.

After rebuilding the NAS, verify the client and receiver path:

zfs-unlock doctor

Usage

# Run once
zfs-unlock

# Run as daemon
# (Checks every 1s if NAS is unreachable, otherwise every 30s)
zfs-unlock --daemon

# Custom interval (for the "relaxed" state)
zfs-unlock --daemon --interval 60

# Dry run
zfs-unlock --dry-run

# Check config, key, network, and receiver status
zfs-unlock doctor

# Show configured dataset status
zfs-unlock status

# Lock a dataset after its services have stopped using it
zfs-unlock lock -D tank/photos

# Force recursive unmount before unloading the key
zfs-unlock lock --force -D tank/photos

zfs-unlock lock can fail with Key unload error: '<dataset>' is busy when a service still has files open on that dataset. Stop the service first, or use --force when you intentionally want to unmount the dataset and disrupt those processes.

CLI

zfs-unlock --help

 Usage: zfs-unlock [OPTIONS] COMMAND [ARGS]...

 Unlock OpenZFS datasets over a restricted SSH receiver

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config    -c      PATH     Config file path                                │
│ --dry-run   -n               Show what would be done                         │
│ --daemon    -d               Run continuously                                │
│ --interval  -i      INTEGER  Seconds between checks (1s if unreachable)      │
│                              [default: 30]                                   │
│ --dataset   -D      TEXT     Filter by dataset path                          │
│ --version   -v               Show version and exit                           │
│ --help      -h               Show this message and exit.                     │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ keygen    Generate a dedicated SSH key for zfs-unlock.                       │
│ doctor    Check client config, SSH key, host reachability, and receiver      │
│           status.                                                            │
│ lock      Lock configured datasets.                                          │
│ status    Show lock status of configured datasets.                           │
│ receiver  Run the restricted NAS-side receiver.                              │
│ service   Manage system service                                              │
╰──────────────────────────────────────────────────────────────────────────────╯

Running as a Service

On NixOS, prefer the services.zfsUnlock.client module shown above. The portable CLI installer requires uv and auto-detects Linux (systemd) or macOS (launchd):

# Install and start
zfs-unlock service install

# Check status
zfs-unlock service status

# View logs (follows by default)
zfs-unlock service logs

# Uninstall
zfs-unlock service uninstall

Development

# Clone and install
git clone https://github.com/basnijholt/zfs-unlock
cd zfs-unlock
uv sync --dev

# Run tests
uv run pytest

# Run lints
uv run ruff check .
uv run mypy zfs_unlock.py

Credits

Based on truenas-unlock.

License

MIT