summary refs log tree commit diff
path: root/pkgs/os-specific/linux/fscryptctl
diff options
context:
space:
mode:
authorMichael Weiss <dev.primeos@gmail.com>2021-02-04 13:34:07 +0100
committerMichael Weiss <dev.primeos@gmail.com>2021-02-04 13:39:00 +0100
commit6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc (patch)
treeb6e087558a7fac755a7c1d3a56df56bd8244913c /pkgs/os-specific/linux/fscryptctl
parent35fcd0461efe42b770da8376cafb09b7f41c7e96 (diff)
downloadnixpkgs-6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc.tar
nixpkgs-6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc.tar.gz
nixpkgs-6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc.tar.bz2
nixpkgs-6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc.tar.lz
nixpkgs-6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc.tar.xz
nixpkgs-6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc.tar.zst
nixpkgs-6f6ce15938107f33b8c5cc1b6e1cdff8d7d78fdc.zip
fscryptctl-experimental: 2017-10-23 -> 0.1.0
Version 0.1.0 is based on the last commit that included support for V1
encryption policies. Version 1.0 is about to be released and will
include a PR which removes V1 policy support and adds V2 policy support.
Source: https://github.com/google/fscryptctl/issues/12#issuecomment-772888154

When version 1.0 is released we'll likely package it as fscryptctl and
mark fscryptctl-experimental as broken (referring to fscryptctl).
Diffstat (limited to 'pkgs/os-specific/linux/fscryptctl')
-rw-r--r--pkgs/os-specific/linux/fscryptctl/default.nix23
1 files changed, 17 insertions, 6 deletions
diff --git a/pkgs/os-specific/linux/fscryptctl/default.nix b/pkgs/os-specific/linux/fscryptctl/default.nix
index 204ce6bf992..ae89cd43f25 100644
--- a/pkgs/os-specific/linux/fscryptctl/default.nix
+++ b/pkgs/os-specific/linux/fscryptctl/default.nix
@@ -3,24 +3,35 @@
 # Don't use this for anything important yet!
 
 stdenv.mkDerivation rec {
-  pname = "fscryptctl-unstable";
-  version = "2017-10-23";
+  pname = "fscryptctl";
+  version = "0.1.0";
 
   goPackagePath = "github.com/google/fscrypt";
 
   src = fetchFromGitHub {
     owner = "google";
     repo = "fscryptctl";
-    rev = "142326810eb19d6794793db6d24d0775a15aa8e5";
+    rev = "v${version}";
     sha256 = "1853hlpklisbqnkb7a921dsf0vp2nr2im26zpmrs592cnpsvk3hb";
   };
 
   makeFlags = [ "DESTDIR=$(out)/bin" ];
 
   meta = with lib; {
-    description = ''
-      A low-level tool that handles raw keys and manages policies for Linux
-      filesystem encryption
+    description = "Small C tool for Linux filesystem encryption";
+    longDescription = ''
+      fscryptctl is a low-level tool written in C that handles raw keys and
+      manages policies for Linux filesystem encryption, specifically the
+      "fscrypt" kernel interface which is supported by the ext4, f2fs, and
+      UBIFS filesystems.
+      fscryptctl is mainly intended for embedded systems which can't use the
+      full-featured fscrypt tool, or for testing or experimenting with the
+      kernel interface to Linux filesystem encryption. fscryptctl does not
+      handle key generation, key stretching, key wrapping, or PAM integration.
+      Most users should use the fscrypt tool instead, which supports these
+      features and generally is much easier to use.
+      As fscryptctl is intended for advanced users, you should read the kernel
+      documentation for filesystem encryption before using fscryptctl.
     '';
     inherit (src.meta) homepage;
     license = licenses.asl20;