Skip to content

feat(bcachefs): add declarative clevis unlocking support (TPM2/FIDO2/Tang) #1173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
shift wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat(bcachefs): add declarative clevis unlocking support (TPM2/FIDO2/Tang) #1173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b9a1b8
feat: Add Clevis-based unlocking support for bcachefs filesystems
shift Dec 8, 2025
0c1f2f3
feat: add comprehensive TPM2 unlock test suite
shift Dec 8, 2025
d953e39
fix: simplify test files for flake compatibility
shift Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 163 additions & 0 deletions example/bcachefs-tpm2-edge-cases.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
{
disko.devices = {
disk = {
vdb = {
device = "/dev/vdb";
type = "disk";
content = {
type = "gpt";
partitions = {
vdb1 = {
type = "EF00";
size = "100M";
content = {
type = "filesystem";
format = "vfat";
mountpoint = "/boot";
mountOptions = [ "umask=0077" ];
};
};

vdb2 = {
size = "25%";
content = {
type = "bcachefs";
filesystem = "empty_test";
label = "edge-empty.vdb2";
};
};

vdb3 = {
size = "25%";
content = {
type = "bcachefs";
filesystem = "corrupted_test";
label = "edge-corrupted.vdb3";
};
};

vdb4 = {
size = "25%";
content = {
type = "bcachefs";
filesystem = "missing_test";
label = "edge-missing.vdb4";
};
};

vdb5 = {
size = "25%";
content = {
type = "bcachefs";
filesystem = "multi_test";
label = "edge-multi.vdb5";
};
};
};
};
};

vdc = {
device = "/dev/vdc";
type = "disk";
content = {
type = "gpt";
partitions = {
vdc1 = {
size = "100%";
content = {
type = "bcachefs";
filesystem = "malformed_test";
label = "edge-malformed.vdc1";
};
};
};
};
};

vdd = {
device = "/dev/vdd";
type = "disk";
content = {
type = "gpt";
partitions = {
vdd1 = {
size = "100%";
content = {
type = "bcachefs";
filesystem = "single_device_test";
label = "edge-single.vdd1";
};
};
};
};
};
};

bcachefs_filesystems = {
# Test 1: Empty configuration (unlock enabled but no secret files)
empty_test = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/secret.key";
unlock = {
enable = true;
secretFiles = [ ];
};
};

# Test 2: Corrupted JWE file
corrupted_test = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/secret.key";
unlock = {
enable = true;
secretFiles = [ ./secrets/corrupted.jwe ];
};
};

# Test 3: Missing secret files directory (unlock disabled)
missing_test = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/secret.key";
unlock = {
enable = false;
};
};

# Test 4: Multiple valid keys
multi_test = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/secret.key";
unlock = {
enable = true;
secretFiles = [
./secrets/tpm.jwe
./secrets/fido.jwe
./secrets/tang.jwe
];
extraPackages = [ ];
};
};

# Test 5: Malformed JWE files
malformed_test = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/secret.key";
unlock = {
enable = true;
secretFiles = [ ./secrets/invalid.jwe ];
};
};

# Test 6: Single device configuration
single_device_test = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/secret.key";
unlock = {
enable = true;
secretFiles = [ ./secrets/tpm.jwe ];
};
};
};
};
}
92 changes: 92 additions & 0 deletions example/bcachefs-tpm2-fallback.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
{
disko.devices = {
disk = {
vdb = {
device = "/dev/vdb";
type = "disk";
content = {
type = "gpt";
partitions = {
vdb1 = {
type = "EF00";
size = "100M";
content = {
type = "filesystem";
format = "vfat";
mountpoint = "/boot";
mountOptions = [ "umask=0077" ];
};
};

vdb2 = {
size = "100%";
content = {
type = "bcachefs";
filesystem = "mounted_subvolumes_in_multi";
label = "fallback-test.vdb2";
extraFormatArgs = [
"--discard"
];
};
};
};
};
};

vdc = {
device = "/dev/vdc";
type = "disk";
content = {
type = "gpt";
partitions = {
vdc1 = {
size = "100%";
content = {
type = "bcachefs";
filesystem = "mounted_subvolumes_in_multi";
label = "fallback-test.vdc1";
extraFormatArgs = [
"--discard"
];
};
};
};
};
};
};

bcachefs_filesystems = {
mounted_subvolumes_in_multi = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/fallback-secret.key";
extraFormatArgs = [
"--compression=lz4"
"--background_compression=lz4"
];

# TPM2 unlocking configuration (will fail due to missing TPM2 device)
unlock = {
enable = true;
secretFiles = [
./secrets/tpm.jwe
./secrets/fido.jwe
];
extraPackages = [ ];
};

subvolumes = {
"subvolumes/root" = {
mountpoint = "/";
mountOptions = [ "verbose" ];
};
"subvolumes/home" = {
mountpoint = "/home";
};
"subvolumes/nix" = {
mountpoint = "/nix";
};
};
};
};
};
}
73 changes: 73 additions & 0 deletions example/bcachefs-tpm2-performance.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
disko.devices = {
disk = {
vdb = {
device = "/dev/vdb";
type = "disk";
content = {
type = "gpt";
partitions = {
vdb1 = {
type = "EF00";
size = "100M";
content = {
type = "filesystem";
format = "vfat";
mountpoint = "/boot";
mountOptions = [ "umask=0077" ];
};
};

vdb2 = {
size = "100%";
content = {
type = "bcachefs";
filesystem = "perf_test";
label = "performance-test";
extraFormatArgs = [
"--discard"
"--compression=lz4"
];
};
};
};
};
};
};

bcachefs_filesystems = {
perf_test = {
type = "bcachefs_filesystem";
passwordFile = "/tmp/perf-secret.key";
extraFormatArgs = [
"--compression=lz4"
"--background_compression=lz4"
];

# Performance test configuration with multiple keys
unlock = {
enable = true;
secretFiles = [
./secrets/tpm.jwe
./secrets/fido.jwe
./secrets/tang.jwe
];
extraPackages = [ ];
};

subvolumes = {
"subvolumes/root" = {
mountpoint = "/";
mountOptions = [ "verbose" ];
};
"subvolumes/home" = {
mountpoint = "/home";
};
"subvolumes/nix" = {
mountpoint = "/nix";
};
};
};
};
};
}
Loading
⚡