generate README from docs

switch to license compatible with all dependencies

.drone.yml

@@ -7,21 +7,28 @@ steps:
    commands:
      -  rustup component add rustfmt
      -  cargo fmt --all -- --check
- - name: test
+ - name: readme
-   image: shimun/fido2luks@sha256:6d0b4017bffbec5fac8f25d383d68671fcc9930efb02e97ce5ea81acf0060ece
+   image: msrd0/cargo-readme@sha256:2b916451e576cda54f1e02703fa092b9d5af95bcf48426a1ef42872a19467fd3
-   environment:
-    DEBIAN_FRONTEND: noninteractive
    commands:
-    - cargo test --locked
+     - cargo readme > ~README.md
+     - cmp -s README.md ~README.md || (printf "README.md need to be updated:\n"; cat ~README.md; exit 1)
+ - name: test
+   image: rust:1.43.0
+   commands:
+    - apt update && apt install -y libkeyutils-dev libclang-dev clang pkg-config  
+    - echo 'deb http://http.us.debian.org/debian unstable main non-free contrib' >> /etc/apt/sources.list.d/unstable.list && apt update && apt install -y libcryptsetup-dev
+    - cargo test
  - name: publish
-   image: shimun/fido2luks@sha256:6d0b4017bffbec5fac8f25d383d68671fcc9930efb02e97ce5ea81acf0060ece
+   image: rust:1.43.0
    environment:
-    DEBIAN_FRONTEND: noninteractive
     CARGO_REGISTRY_TOKEN:
      from_secret: cargo_tkn
    commands:
     - grep -E 'version ?= ?"${DRONE_TAG}"' -i Cargo.toml || (printf "incorrect crate/tag version" && exit 1)
-    - cargo package --all-features --allow-dirty
+    - apt update && apt install -y libkeyutils-dev libclang-dev clang pkg-config  
-    - cargo publish --all-features --allow-dirty
+    - echo 'deb http://http.us.debian.org/debian unstable main non-free contrib' >> /etc/apt/sources.list.d/unstable.list && apt update && apt install -y libcryptsetup-dev
+    - cargo package --all-features
+    - cargo publish --all-features
    when:
     event: tag
+   depends_on: ["fmt", "test", "readme"]

.gitignore

@@ -2,9 +2,3 @@
 **/*.rs.bk
 .idea/
 *.iml
-fido2luks.bash
-fido2luks.elv
-fido2luks.fish
-fido2luks.zsh
-result
-result-*

CHANGELOG.md

@@ -1,11 +0,0 @@
-## 0.3.0
-
-* LUKS2 Tokens are now supported by every subcommand
-* `<credential>` has been converted into the flag `--creds`  
-credentials provided by `--creds` will be supplemented from the LUKS header unless this is disabled by `--disable-token`
-* `fido2luks add-key` will take an `--auto-cred` flag which allows for credentials to be generated and stored without having to use `fido2luks credential`  
-`fido2luks replace-key` will allow for credentials to be removed using the `--remove-cred` flag respectively 
-* Removed `fido2luks open-token` subcommand  
-  `fido2luks open` now fulfills both functions
-* Added `fido2luks open --dry-run` flag, to perform the whole procedure apart from mounting the LUKS volume
-* Added an `--verbose` flag to display additional information like credentials and keyslots used if desired

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fido2luks"
-version = "0.3.1-alpha"
+version = "0.2.9"
 authors = ["shimunn <shimun@shimun.net>"]
 edition = "2018"
 
@@ -11,29 +11,19 @@ repository = "https://github.com/shimunn/fido2luks"
 readme = "README.md"
 keywords = ["luks", "fido2", "u2f"]
 categories = ["command-line-utilities"]
-license = "MPL-2.0"
+license = "MPL 2.0"
 
 [dependencies]
+ctap_hmac = { version="0.4.2", features = ["request_multiple"] }
 hex = "0.3.2"
-ring = "0.16.5"
+ring = "0.13.5"
 failure = "0.1.5"
 rpassword = "4.0.1"
 structopt = "0.3.2"
+libcryptsetup-rs = "0.4.1"
 serde_json = "1.0.51"
-serde_derive = "1.0.116"
+serde_derive = "1.0.106"
-serde = "1.0.116"
+serde = "1.0.106"
-anyhow = "1.0.56"
-ctap-hid-fido2 = "3.4.1"
-libcryptsetup-rs = "0.5.1"
-
-[build-dependencies]
-hex = "0.3.2"
-ring = "0.16.5"
-failure = "0.1.5"
-rpassword = "4.0.1"
-anyhow = "1.0.56"
-libcryptsetup-rs = "0.5.1"
-structopt = "0.3.2"
 
 [profile.release]
 lto = true
@@ -48,9 +38,7 @@ build-depends = "libclang-dev, libcryptsetup-dev"
 extended-description = "Decrypt your LUKS partition using a FIDO2 compatible authenticator"
 assets = [
     ["target/release/fido2luks", "usr/bin/", "755"],
-    ["fido2luks.bash", "usr/share/bash-completion/completions/fido2luks", "644"],
     ["initramfs-tools/keyscript.sh", "/lib/cryptsetup/scripts/fido2luks", "755" ],
     ["initramfs-tools/hook/fido2luks.sh", "etc/initramfs-tools/hooks/", "755" ],
     ["initramfs-tools/fido2luks.conf", "etc/", "644"],
 ]
-conf-files = ["/etc/fido2luks.conf"]

PKGBUILD

@@ -1,37 +0,0 @@
-# Maintainer: shimunn <shimun@shimun.net>
-
-pkgname=fido2luks-git
-pkgver=0.2.16.7e6b33a
-pkgrel=1
-makedepends=('rust' 'cargo' 'cryptsetup' 'clang' 'git')
-depends=('cryptsetup')
-arch=('i686' 'x86_64' 'armv6h' 'armv7h')
-pkgdesc="Decrypt your LUKS partition using a FIDO2 compatible authenticator"
-url="https://github.com/shimunn/fido2luks"
-license=('MPL-2.0')
-source=('git+https://github.com/shimunn/fido2luks')
-sha512sums=('SKIP')
-
-pkgver() {
-    cd fido2luks
-
-    # Use tag version if possible otherwise concat project version and git ref
-    git describe --exact-match --tags HEAD 2>/dev/null ||
-        echo "$(cargo pkgid | cut -d'#' -f2).$(git describe --always)"
-}
-
-build() {
-    cd fido2luks
-    cargo build --release --locked --all-features --target-dir=target
-}
-
-package() {
-    cd fido2luks
-
-    install -Dm 755 target/release/fido2luks -t "${pkgdir}/usr/bin"
-    install -Dm 755 pam_mount/fido2luksmounthelper.sh -t "${pkgdir}/usr/bin"
-    install -Dm 644 initcpio/hooks/fido2luks -t "${pkgdir}/usr/lib/initcpio/hooks"
-    install -Dm 644 initcpio/install/fido2luks -t "${pkgdir}/usr/lib/initcpio/install"
-    install -Dm 644 fido2luks.bash "${pkgdir}/usr/share/bash-completion/completions/fido2luks"
-    install -Dm 644 fido2luks.fish -t "${pkgdir}/usr/share/fish/vendor_completions.d"
-}

README.md

@@ -1,7 +1,109 @@
-# fido2luks [![Crates.io Version](https://img.shields.io/crates/v/fido2luks.svg)](https://crates.io/crates/fido2luks)
+[![Crates.io](https://img.shields.io/crates/v/fido2luks.svg)](https://crates.io/crates/fido2luks)
+# fido2luks
 
-## 0.3.0-alpha
+This will allow you to unlock your luks encrypted disk with an fido2 compatible key
 
-This is just the program itself, all intitrid scripts are mostly taylored to the latest 0.2.x version and will most likely not work with 0.3.0 due to breaking changes in the CLI interface.
+Note: This has only been tested under Fedora 31, [Ubuntu 20.04](initramfs-tools/), [NixOS](https://nixos.org/nixos/manual/#sec-luks-file-systems-fido2) using a Solo Key, Trezor Model T
-I've decided it release the version in this state since I just do not have the time now or in the forseeable future to tewak all scripts since it's quite an tedious tasks which involves rebooting VMs countless times.
+
-If you're interested to adapt or write scripts for an particular distro I'd be more than happy to accept pull requests.
+### Setup
+
+#### Prerequisites
+
+```rust
+dnf install clang cargo cryptsetup-devel -y
+```
+
+#### Device
+
+```rust
+git clone https://github.com/shimunn/fido2luks.git && cd fido2luks
+
+sudo -E cargo install -f --path . --root /usr
+
+cp dracut/96luks-2fa/fido2luks.conf /etc/
+echo FIDO2LUKS_CREDENTIAL_ID=$(fido2luks credential [NAME]) >> /etc/fido2luks.conf
+
+set -a
+. /etc/fido2luks.conf
+
+sudo -E fido2luks -i add-key /dev/disk/by-uuid/<DISK_UUID>
+
+sudo -E fido2luks -i open /dev/disk/by-uuid/<DISK_UUID> luks-<DISK_UUID>
+
+```
+
+#### Dracut
+
+```rust
+cd dracut
+
+sudo make install
+```
+
+#### Grub
+
+Add `rd.luks.2fa=<CREDENTIAL_ID>:<DISK_UUID>` to `GRUB_CMDLINE_LINUX` in /etc/default/grub
+
+Note: This is only required for your root disk, systemd will try to unlock all other LUKS partions using the same key if you added it using `fido2luks add-key`
+
+```rust
+grub2-mkconfig > /boot/grub2/grub.cfg
+```
+
+I'd also recommend to copy the executable onto /boot so that it is accessible in case you have to access your disk from a rescue system
+
+```rust
+mkdir /boot/fido2luks/
+cp /usr/bin/fido2luks /boot/fido2luks/
+cp /etc/fido2luks.conf /boot/fido2luks/
+```
+
+### Test
+
+Just reboot and see if it works, if that's the case you should remove your old less secure password from your LUKS header:
+
+```rust
+cryptsetup luksHeaderBackup /dev/disk/by-uuid/<DISK_UUID> --header-backup-file luks_backup_<DISK_UUID>
+fido2luks -i add-key --exclusive /dev/disk/by-uuid/<DISK_UUID>
+```
+
+### Addtional settings
+
+#### Password less
+
+Remove your previous secret as described in the next section, in case you've already added one.
+
+Open `/etc/fido2luks.conf` and replace `FIDO2LUKS_SALT=Ask` with `FIDO2LUKS_SALT=string:<YOUR_RANDOM_STRING>`
+but be warned that this password will be included to into your initramfs.
+
+Import the new config into env:
+
+```rust
+set -a
+. /etc/fido2luks.conf
+```
+
+Then add the new secret to each device and update dracut afterwards `dracut -f`
+
+### Removal
+
+Remove `rd.luks.2fa` from `GRUB_CMDLINE_LINUX` in /etc/default/grub
+
+```rust
+set -a
+. fido2luks.conf
+sudo -E fido2luks -i replace-key /dev/disk/by-uuid/<DISK_UUID>
+
+sudo rm -rf /usr/lib/dracut/modules.d/96luks-2fa /etc/dracut.conf.d/luks-2fa.conf /etc/fido2luks.conf
+```
+
+## License
+
+Licensed under the Mozilla Public License 2.0, ([LICENSE-MPL](LICENSE) or https://www.mozilla.org/en-US/MPL/2.0/)
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the MPL 2.0
+license, shall be dual licensed as above, without any additional terms or
+conditions.

README.tpl

@@ -0,0 +1,15 @@
+[![Crates.io](https://img.shields.io/crates/v/fido2luks.svg)](https://crates.io/crates/fido2luks)
+# {{crate}}
+
+{{readme}}
+
+## License
+
+Licensed under the Mozilla Public License 2.0, ([LICENSE-MPL](LICENSE) or https://www.mozilla.org/en-US/MPL/2.0/)
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the MPL 2.0
+license, shall be dual licensed as above, without any additional terms or
+conditions.

build.rs

@@ -1,32 +0,0 @@
-#![allow(warnings)]
-#[macro_use]
-extern crate failure;
-
-#[path = "src/cli_args/mod.rs"]
-mod cli_args;
-#[path = "src/error.rs"]
-mod error;
-#[path = "src/util.rs"]
-mod util;
-
-use cli_args::Args;
-use std::env;
-use std::fs;
-use std::path::PathBuf;
-use std::str::FromStr;
-use structopt::clap::Shell;
-use structopt::StructOpt;
-
-fn main() {
-    let env_outdir = env::var_os("OUT_DIR").unwrap();
-    let outdir = PathBuf::from(PathBuf::from(env_outdir).ancestors().nth(3).unwrap());
-    fs::create_dir_all(&outdir).unwrap();
-    // generate completion scripts, zsh does panic for some reason
-    for shell in Shell::variants().iter().filter(|shell| **shell != "zsh") {
-        Args::clap().gen_completions(
-            env!("CARGO_PKG_NAME"),
-            Shell::from_str(shell).unwrap(),
-            &outdir,
-        );
-    }
-}

flake.lock

@@ -1,62 +0,0 @@
-{
-  "nodes": {
-    "naersk": {
-      "inputs": {
-        "nixpkgs": [
-          "nixpkgs"
-        ]
-      },
-      "locked": {
-        "lastModified": 1639947939,
-        "narHash": "sha256-pGsM8haJadVP80GFq4xhnSpNitYNQpaXk4cnA796Cso=",
-        "owner": "nmattia",
-        "repo": "naersk",
-        "rev": "2fc8ce9d3c025d59fee349c1f80be9785049d653",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nmattia",
-        "repo": "naersk",
-        "type": "github"
-      }
-    },
-    "nixpkgs": {
-      "locked": {
-        "lastModified": 1647282937,
-        "narHash": "sha256-K8Oo6QyFCfiEWTRpQVfzcwI3YNMKlz6Tu8rr+o3rzRQ=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "64fc73bd74f04d3e10cb4e70e1c65b92337e76db",
-        "type": "github"
-      },
-      "original": {
-        "id": "nixpkgs",
-        "type": "indirect"
-      }
-    },
-    "root": {
-      "inputs": {
-        "naersk": "naersk",
-        "nixpkgs": "nixpkgs",
-        "utils": "utils"
-      }
-    },
-    "utils": {
-      "locked": {
-        "lastModified": 1644229661,
-        "narHash": "sha256-1YdnJAsNy69bpcjuoKdOYQX0YxZBiCYZo4Twxerqv7k=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "3cecb5b042f7f209c56ffd8371b2711a290ec797",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "type": "github"
-      }
-    }
-  },
-  "root": "root",
-  "version": 7
-}

flake.nix

@@ -1,100 +0,0 @@
-{
-  description = "Decrypt your LUKS partition using a FIDO2 compatible authenticator";
-
-  inputs = {
-    utils.url = "github:numtide/flake-utils";
-    naersk = {
-      url = "github:nmattia/naersk";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
-  };
-
-outputs = inputs @ { self, nixpkgs, utils, naersk, ... }:
-    let
-      root = inputs.source or self;
-      pname = (builtins.fromTOML (builtins.readFile (root + "/Cargo.toml"))).package.name;
-      # toolchains: stable, beta, default(nightly)
-      toolchain = pkgs: if inputs ? fenix then inputs.fenix.packages."${pkgs.system}".complete.toolchain 
-                  else with pkgs; symlinkJoin { name = "rust-toolchain"; paths = [ rustc cargo ]; };
-      forSystem = system:
-      let 
-        pkgs = nixpkgs.legacyPackages."${system}";
-      in
-        rec {
-          # `nix build`
-          packages.${pname} = (self.overlay pkgs pkgs).${pname};
-
-          packages.dockerImage = pkgs.runCommandLocal "docker-${pname}.tar.gz" {} "${apps.streamDockerImage.program} | gzip --fast > $out";
-
-          packages.default = packages.${pname};
-
-          # `nix run`
-          apps.${pname} = utils.lib.mkApp {
-            drv = packages.${pname};
-          };
-          
-          # `nix run .#streamDockerImage | docker load`
-          apps.streamDockerImage = utils.lib.mkApp {
-            drv = with pkgs; dockerTools.streamLayeredImage {
-              name = pname;
-              tag = self.shortRev or "latest";
-              config = {
-                Entrypoint = apps.default.program;
-              };
-            };
-            exePath = "";
-          };
-          apps.default = apps.${pname};
-
-          # `nix flake check`
-          checks = {
-            fmt = with pkgs; runCommandLocal "${pname}-fmt" { buildInputs = [ cargo rustfmt nixpkgs-fmt ]; } ''
-              cd ${root}
-              cargo fmt -- --check
-              nixpkgs-fmt --check *.nix
-              touch $out
-            '';
-          };
-
-          hydraJobs = checks // packages;
-
-          # `nix develop`
-          devShell = pkgs.mkShell rec {
-            RUST_SRC_PATH = "${if inputs ? fenix then "${toolchain pkgs}/lib/rustlib" else pkgs.rustPlatform.rustLibSrc}";
-            nativeBuildInputs = with pkgs; [ (toolchain pkgs) cargo-edit rustfmt nixpkgs-fmt ] ++ packages.default.nativeBuildInputs;
-            inherit (packages.default) buildInputs LIBCLANG_PATH;
-            shellHook = ''
-              printf "Rust version:"
-              rustc --version
-              printf "\nbuild inputs: ${pkgs.lib.concatStringsSep ", " (map (bi: bi.name) (buildInputs ++ nativeBuildInputs))}"
-            '';
-          };
-
-        };
-    in
-    (utils.lib.eachDefaultSystem forSystem) // {
-      overlays.pinned = final: prev: (self.overlay final (import nixpkgs {
-        inherit (final) localSystem;
-      })).packages;
-      overlay = final: prev:
-        let
-          naersk-lib = naersk.lib."${final.system}".override {
-            rustc = toolchain prev;
-            cargo = toolchain prev;
-          };
-          buildInputs = with prev; [ 
-            udev cryptsetup.dev
-          ];
-          nativeBuildInputs = with prev; [
-            pkg-config clang
-          ];
-        in
-        {
-          "${pname}" =
-            naersk-lib.buildPackage {
-              LIBCLANG_PATH = "${final.llvmPackages.libclang.lib}/lib";
-              inherit pname root buildInputs nativeBuildInputs;
-            };
-        };
-    };
-}

initcpio/Makefile

@@ -1,18 +0,0 @@
-.PHONY: install remove
-
-install:
-	install -Dm644 hooks/fido2luks -t /usr/lib/initcpio/hooks
-	install -Dm644 install/fido2luks -t /usr/lib/initcpio/install
-ifdef preset
-	mkinitcpio -p $(preset)
-else
-	mkinitcpio -P
-endif
-
-remove:
-	rm /usr/lib/initcpio/{hooks,install}/fido2luks
-ifdef preset
-	mkinitcpio -p $(preset)
-else
-	mkinitcpio -P
-endif

initcpio/README.md

@@ -1,52 +0,0 @@
-## fido2luks hook for mkinitcpio (ArchLinux and derivatives)
-
-> ⚠️ Before proceeding, it is very advised to [backup your existing LUKS2 header](https://wiki.archlinux.org/title/dm-crypt/Device_encryption#Backup_using_cryptsetup) to external storage
-
-### Setup
-
-1. Connect your FIDO2 authenticator
-2. Generate credential id
-
-```shell
-fido2luks credential
-```
-
-3. Generate salt (random string)
-
-```shell
-pwgen 48 1
-```
-
-4. Add key to your LUKS2 device
-
-```shell
-fido2luks add-key -Pt --salt <salt> <block_device> <credential_id>
-```
-
-`-P` - request PIN to unlock the authenticator  
-`-t` - add token (including credential id) to the LUKS2 header  
-`-e` - wipe all other keys  
-
-For the full list of options see `fido2luks add-key --help`
-
-5. Edit [/etc/fido2luks.conf](/initcpio/fido2luks.conf)
-
-Keyslot (`FIDO2LUKS_DEVICE_SLOT`) can be obtained from the output of
-
-```shell
-cryptsetup luksDump <block_device>
-```
-
-6. Add fido2luks hook to /etc/mkinitcpio.conf
-
-Before or instead of `encrypt` hook, for example:
-
-```shell
-HOOKS=(base udev autodetect modconf keyboard block fido2luks filesystems fsck)
-```
-
-7. Recreate initial ramdisk
-
-```shell
-mkinitcpio -p <preset>
-```

initcpio/fido2luks.conf

@@ -1,18 +0,0 @@
-# Set credential *ONLY IF* it's not embedded in the LUKS2 header
-FIDO2LUKS_CREDENTIAL_ID=
-
-# Encrypted device and its name under /dev/mapper
-# Can be overridden by `cryptdevice` kernel parameter
-FIDO2LUKS_DEVICE=
-FIDO2LUKS_MAPPER_NAME=
-
-FIDO2LUKS_SALT=string:<salt>
-
-# Use specific keyslot (ignore all other slots)
-FIDO2LUKS_DEVICE_SLOT=
-
-# Await for an authenticator to be connected (in seconds)
-FIDO2LUKS_DEVICE_AWAIT=
-
-# Set to 1 if PIN is required to unlock the authenticator
-FIDO2LUKS_ASK_PIN=

initcpio/hooks/fido2luks

@@ -1,55 +0,0 @@
-#!/usr/bin/ash
-
-run_hook() {
-    modprobe -a -q dm-crypt >/dev/null 2>&1
-    . /etc/fido2luks.conf
-
-    if [ -z "$cryptdevice" ]; then
-        device="$FIDO2LUKS_DEVICE"
-        dmname="$FIDO2LUKS_MAPPER_NAME"
-    else
-        IFS=: read cryptdev dmname _cryptoptions <<EOF
-$cryptdevice
-EOF
-        if ! device=$(resolve_device "${cryptdev}" ${rootdelay}); then
-            return 1
-        fi
-    fi
-
-    options="--salt $FIDO2LUKS_SALT"
-
-    if [ "$FIDO2LUKS_ASK_PIN" == 1 ]; then
-        options="$options --pin"
-    fi
-
-    if [ -n "$FIDO2LUKS_DEVICE_SLOT" ]; then
-        options="$options --slot $FIDO2LUKS_DEVICE_SLOT"
-    fi
-
-    if [ -n "$FIDO2LUKS_DEVICE_AWAIT" ]; then
-        options="$options --await-dev $FIDO2LUKS_DEVICE_AWAIT"
-    fi
-
-    # HACK: /dev/tty is hardcoded in rpassword, but not accessible from the ramdisk
-    # Temporary link it to /dev/tty1
-    mv /dev/tty /dev/tty.back
-    ln -s /dev/tty1 /dev/tty
-
-    printf "\nAuthentication is required to access the $dmname volume at $device\n"
-
-    if [ -z "$FIDO2LUKS_CREDENTIAL_ID" ]; then
-        fido2luks open-token $device $dmname $options
-    else
-        fido2luks open $device $dmname $FIDO2LUKS_CREDENTIAL_ID $options
-    fi
-    exit_code=$?
-
-    # Restore /dev/tty
-    mv /dev/tty.back /dev/tty
-
-    if [ $exit_code -ne 0 ]; then
-        printf '\n'
-        read -s -p 'Press Enter to continue'
-        printf '\n'
-    fi
-}

initcpio/install/fido2luks

@@ -1,31 +0,0 @@
-#!/bin/bash
-
-build() {
-    local mod
-
-    add_module dm-crypt
-    add_module dm-integrity
-    if [[ $CRYPTO_MODULES ]]; then
-        for mod in $CRYPTO_MODULES; do
-            add_module "$mod"
-        done
-    else
-        add_all_modules /crypto/
-    fi
-
-    add_binary fido2luks
-    add_binary dmsetup
-    add_file /usr/lib/udev/rules.d/10-dm.rules
-    add_file /usr/lib/udev/rules.d/13-dm-disk.rules
-    add_file /usr/lib/udev/rules.d/95-dm-notify.rules
-    add_file /usr/lib/initcpio/udev/11-dm-initramfs.rules /usr/lib/udev/rules.d/11-dm-initramfs.rules
-    add_file /etc/fido2luks.conf /etc/fido2luks.conf
-
-    add_runscript
-}
-
-help() {
-    cat <<HELPEOF
-This hook allows to decrypt LUKS2 partition using FIDO2 compatible authenticator
-HELPEOF
-}

initramfs-tools/Dockerfile

@@ -1,15 +0,0 @@
-FROM rust:bullseye
-
-RUN cargo install -f cargo-deb --debug --version 1.30.0
-
-ARG DEBIAN_FRONTEND=noninteractive
-
-RUN apt update && apt install -y cryptsetup pkg-config libclang-dev libcryptsetup-dev && mkdir -p /build/fido2luks
-
-WORKDIR /build/fido2luks
-
-ENV CARGO_TARGET_DIR=/build/fido2luks/target
-
-RUN cargo install fido2luks -f
-
-CMD bash -xc 'cp -rf /code/* /build/fido2luks && cargo-deb && cp target/debian/*.deb /out'

initramfs-tools/README.md

@@ -1,34 +1,13 @@
 ## Initramfs-tools based systems(Ubuntu and derivatives)
 
-For easiest installation [download and install the precompiled deb from releases.](https://github.com/shimunn/fido2luks/releases). However it is possible to build from source via the instructions on the main readme.
+After installation generate your credentials and add keys to your disk as described in the top-level README
+then add `initramfs,keyscript=fido2luks` to your `/etc/crypttab`
 
+Example:
 ```
-sudo -s
+sda6_crypt UUID=9793d81a-4cfb-4712-85f3-c7a8d715112c none luks,discard,initramfs,keyscript=fido2luks
-
-# Insert FIDO key.
-fido2luks credential
-# Tap FIDO key
-# Copy returned string <CREDENTIAL>
-
-nano /etc/fido2luks.conf
-# Insert <CREDENTIAL> 
-# FIDO2LUKS_CREDENTIAL_ID=<CREDENTIAL> 
-
-set -a
-. /etc/fido2luks.conf
-fido2luks -i add-key /dev/<LUKS PARTITION>
-# Current password: <Any current LUKS password>
-# Password: <Password used as FIDO challange>
-# Tap FIDO key
-
-nano /etc/crypttab
-# Append to end ",discard,initramfs,keyscript=fido2luks"
-# E.g. sda6_crypt UUID=XXXXXXXXXX none luks,discard,initramfs,keyscript=fido2luks
-
-update-initramfs -u
-
-
 ```
 
+But don't forget to run `make install` which will install all necessary scripts and regenerate your intrid.
+
 [Recording showing part of the setup](https://shimun.net/fido2luks/setup.svg)
-

initramfs-tools/build-deb.sh

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-
-set -ex
-
-docker build . -t fido2luks-deb
-
-mkdir -p debs
-
-docker run -ti -v "$(pwd)/..:/code:ro" -v "$(pwd)/debs:/out" fido2luks-deb

initramfs-tools/fido2luks.conf

@@ -1,3 +1,3 @@
 FIDO2LUKS_SALT=Ask
-#FIDO2LUKS_PASSWORD_HELPER="/usr/bin/plymouth ask-for-password --prompt 'FIDO2 password salt'"
+#FIDO2LUKS_PASSWORD_HELPER="/usr/bin/plymouth ask-for-password --promt 'FIDO2 password salt'"
 FIDO2LUKS_CREDENTIAL_ID=

initramfs-tools/keyscript.sh

@@ -3,8 +3,7 @@ set -a
 . /etc/fido2luks.conf
 
 if [ -z "$FIDO2LUKS_PASSWORD_HELPER" ]; then
-	MSG="FIDO2 password salt for $CRYPTTAB_NAME"
+	export FIDO2LUKS_PASSWORD_HELPER="plymouth ask-for-password --promt 'FIDO2 password salt for $CRYPTTAB_NAME'"
-	export FIDO2LUKS_PASSWORD_HELPER="plymouth ask-for-password --prompt '$MSG'"
 fi
 
-fido2luks print-secret --bin "$CRYPTTAB_SOURCE" $([ "$FIDO2LUKS_USE_TOKEN" -eq 0 ] && printf "--disable-token")
+fido2luks print-secret --bin

pam_mount/fido2luksmounthelper.sh

@@ -1,220 +0,0 @@
-#!/bin/bash
-#
-# This is a rather minimal example Argbash potential
-# Example taken from http://argbash.readthedocs.io/en/stable/example.html
-#
-# ARG_POSITIONAL_SINGLE([operation],[Operation to perform (mount|umount)],[])
-# ARG_OPTIONAL_SINGLE([credentials-type],[c],[Type of the credentials to use (external|embedded)])
-# ARG_OPTIONAL_SINGLE([device],[d],[Name of the device to create])
-# ARG_OPTIONAL_SINGLE([mount-point],[m],[Path of the mount point to use])
-# ARG_OPTIONAL_BOOLEAN([ask-pin],[a],[Ask for a pin],[off])
-# ARG_OPTIONAL_SINGLE([salt],[s],[Salt to use],[""])
-# ARG_HELP([Unlocks/Locks a LUKS volume and mount/unmount it in the given mount point.])
-# ARGBASH_GO()
-# needed because of Argbash --> m4_ignore([
-### START OF CODE GENERATED BY Argbash v2.9.0 one line above ###
-# Argbash is a bash code generator used to get arguments parsing right.
-# Argbash is FREE SOFTWARE, see https://argbash.io for more info
-# Generated online by https://argbash.io/generate
-
-
-die()
-{
-	local _ret="${2:-1}"
-	test "${_PRINT_HELP:-no}" = yes && print_help >&2
-	echo "$1" >&2
-	exit "${_ret}"
-}
-
-
-begins_with_short_option()
-{
-	local first_option all_short_options='cdmash'
-	first_option="${1:0:1}"
-	test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0
-}
-
-# THE DEFAULTS INITIALIZATION - POSITIONALS
-_positionals=()
-# THE DEFAULTS INITIALIZATION - OPTIONALS
-_arg_credentials_type=
-_arg_device=
-_arg_mount_point=
-_arg_ask_pin="off"
-_arg_salt=""
-
-
-print_help()
-{
-	printf '%s\n' "Unlocks/Locks a LUKS volume and mount/unmount it in the given mount point."
-	printf 'Usage: %s [-c|--credentials-type <arg>] [-d|--device <arg>] [-m|--mount-point <arg>] [-a|--(no-)ask-pin] [-s|--salt <arg>] [-h|--help] <operation>\n' "$0"
-	printf '\t%s\n' "<operation>: Operation to perform (mount|umount)"
-	printf '\t%s\n' "-c, --credentials-type: Type of the credentials to use (external|embedded) (no default)"
-	printf '\t%s\n' "-d, --device: Name of the device to create (no default)"
-	printf '\t%s\n' "-m, --mount-point: Path of the mount point to use (no default)"
-	printf '\t%s\n' "-a, --ask-pin, --no-ask-pin: Ask for a pin (off by default)"
-	printf '\t%s\n' "-s, --salt: Salt to use (default: '""')"
-	printf '\t%s\n' "-h, --help: Prints help"
-}
-
-
-parse_commandline()
-{
-	_positionals_count=0
-	while test $# -gt 0
-	do
-		_key="$1"
-		case "$_key" in
-			-c|--credentials-type)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_credentials_type="$2"
-				shift
-				;;
-			--credentials-type=*)
-				_arg_credentials_type="${_key##--credentials-type=}"
-				;;
-			-c*)
-				_arg_credentials_type="${_key##-c}"
-				;;
-			-d|--device)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_device="$2"
-				shift
-				;;
-			--device=*)
-				_arg_device="${_key##--device=}"
-				;;
-			-d*)
-				_arg_device="${_key##-d}"
-				;;
-			-m|--mount-point)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_mount_point="$2"
-				shift
-				;;
-			--mount-point=*)
-				_arg_mount_point="${_key##--mount-point=}"
-				;;
-			-m*)
-				_arg_mount_point="${_key##-m}"
-				;;
-			-a|--no-ask-pin|--ask-pin)
-				_arg_ask_pin="on"
-				test "${1:0:5}" = "--no-" && _arg_ask_pin="off"
-				;;
-			-a*)
-				_arg_ask_pin="on"
-				_next="${_key##-a}"
-				if test -n "$_next" -a "$_next" != "$_key"
-				then
-					{ begins_with_short_option "$_next" && shift && set -- "-a" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
-				fi
-				;;
-			-s|--salt)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_salt="$2"
-				shift
-				;;
-			--salt=*)
-				_arg_salt="${_key##--salt=}"
-				;;
-			-s*)
-				_arg_salt="${_key##-s}"
-				;;
-			-h|--help)
-				print_help
-				exit 0
-				;;
-			-h*)
-				print_help
-				exit 0
-				;;
-			*)
-				_last_positional="$1"
-				_positionals+=("$_last_positional")
-				_positionals_count=$((_positionals_count + 1))
-				;;
-		esac
-		shift
-	done
-}
-
-
-handle_passed_args_count()
-{
-	local _required_args_string="'operation'"
-	test "${_positionals_count}" -ge 1 || _PRINT_HELP=yes die "FATAL ERROR: Not enough positional arguments - we require exactly 1 (namely: $_required_args_string), but got only ${_positionals_count}." 1
-	test "${_positionals_count}" -le 1 || _PRINT_HELP=yes die "FATAL ERROR: There were spurious positional arguments --- we expect exactly 1 (namely: $_required_args_string), but got ${_positionals_count} (the last one was: '${_last_positional}')." 1
-}
-
-
-assign_positional_args()
-{
-	local _positional_name _shift_for=$1
-	_positional_names="_arg_operation "
-
-	shift "$_shift_for"
-	for _positional_name in ${_positional_names}
-	do
-		test $# -gt 0 || break
-		eval "$_positional_name=\${1}" || die "Error during argument parsing, possibly an Argbash bug." 1
-		shift
-	done
-}
-
-parse_commandline "$@"
-handle_passed_args_count
-assign_positional_args 1 "${_positionals[@]}"
-
-# OTHER STUFF GENERATED BY Argbash
-
-### END OF CODE GENERATED BY Argbash (sortof) ### ])
-# [ <-- needed because of Argbash
-
-if [ -z ${_arg_mount_point} ]; then
-  die "Missing '--mount-point' argument"
-fi
-
-if [ -z ${_arg_device} ]; then
-  die "Missing '--device' argument"
-fi
-
-ASK_PIN=${_arg_ask_pin}
-OPERATION=${_arg_operation}
-DEVICE=${_arg_device}
-DEVICE_NAME=$(sed "s|/|_|g" <<< ${DEVICE})
-MOUNT_POINT=${_arg_mount_point}
-CREDENTIALS_TYPE=${_arg_credentials_type}
-SALT=${_arg_salt}
-CONF_FILE_PATH="/etc/fido2luksmounthelper.conf"
-
-if [ "${OPERATION}" == "mount" ]; then
-	if [ "${CREDENTIALS_TYPE}" == "external" ]; then
-    if  [ -f ${CONF_FILE_PATH} ]; then
-			if [ "${ASK_PIN}" == "on" ]; then
-				read PASSWORD
-			fi
-			CREDENTIALS=$(<${CONF_FILE_PATH})
-		else
-			die "The configuration file '${CONF_FILE_PATH}' is missing. Please create it or use embedded credentials."
-		fi
-		printf ${PASSWORD} | fido2luks open --salt string:${SALT} --pin --pin-source /dev/stdin ${DEVICE} ${DEVICE_NAME} ${CREDENTIALS}
-	elif [ "${CREDENTIALS_TYPE}" == "embedded" ]; then
-		if [ "${ASK_PIN}" == "on" ]; then
-			read PASSWORD
-		fi
-		printf ${PASSWORD} | fido2luks open-token --salt string:${SALT} --pin --pin-source /dev/stdin ${DEVICE} ${DEVICE_NAME}
-	else
-		die "Given credential-type '${CREDENTIALS_TYPE}' is invalid. It must be 'external' or 'embedded'"
-	fi 
-	mount /dev/mapper/${DEVICE_NAME} ${MOUNT_POINT}
-elif [ "${OPERATION}" == "umount" ]; then
-  umount ${MOUNT_POINT}
-  cryptsetup luksClose ${DEVICE_NAME}
-else
-  die "Given operation '${OPERATION}' is invalid. It must be 'mount' or 'unmount'"
-fi
-
-exit 0
-
-# ] <-- needed because of Argbash

src/cli_args/mod.rs

@@ -1,329 +0,0 @@
-use std::fmt::{Display, Error, Formatter};
-use std::hash::{Hash, Hasher};
-use std::path::PathBuf;
-use std::str::FromStr;
-use structopt::clap::{AppSettings, Shell};
-use structopt::StructOpt;
-
-mod config;
-
-pub use config::*;
-
-#[derive(Debug, Eq, PartialEq, Clone)]
-pub struct HexEncoded(pub Vec<u8>);
-
-impl Display for HexEncoded {
-    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
-        f.write_str(&hex::encode(&self.0))
-    }
-}
-
-impl AsRef<[u8]> for HexEncoded {
-    fn as_ref(&self) -> &[u8] {
-        &self.0[..]
-    }
-}
-
-impl FromStr for HexEncoded {
-    type Err = hex::FromHexError;
-
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        Ok(HexEncoded(hex::decode(s)?))
-    }
-}
-
-impl Hash for HexEncoded {
-    fn hash<H: Hasher>(&self, state: &mut H) {
-        self.0.hash(state)
-    }
-}
-
-#[derive(Debug, Eq, PartialEq, Clone)]
-pub struct CommaSeparated<T: FromStr + Display>(pub Vec<T>);
-
-impl<T: Display + FromStr> Display for CommaSeparated<T> {
-    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
-        for i in &self.0 {
-            f.write_str(&i.to_string())?;
-            f.write_str(",")?;
-        }
-        Ok(())
-    }
-}
-
-impl<T: Display + FromStr> FromStr for CommaSeparated<T> {
-    type Err = <T as FromStr>::Err;
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        Ok(CommaSeparated(
-            s.split(',')
-                .map(|part| <T as FromStr>::from_str(part))
-                .collect::<Result<Vec<_>, _>>()?,
-        ))
-    }
-}
-
-#[derive(Debug, StructOpt)]
-pub struct Credentials {
-    /// FIDO credential ids, separated by ',' generate using fido2luks credential
-    #[structopt(
-        name = "credential-ids",
-        env = "FIDO2LUKS_CREDENTIAL_ID",
-        short = "c",
-        long = "creds"
-    )]
-    pub ids: Option<CommaSeparated<HexEncoded>>,
-}
-
-#[derive(Debug, StructOpt)]
-pub struct AuthenticatorParameters {
-    /// Request a PIN to unlock the authenticator if required
-    #[structopt(short = "P", long = "pin")]
-    pub pin: bool,
-
-    /// Request PIN and password combined `pin:password` when using an password helper
-    #[structopt(long = "pin-prefixed")]
-    pub pin_prefixed: bool,
-
-    /// Await for an authenticator to be connected, timeout after n seconds
-    #[structopt(
-        long = "await-dev",
-        name = "await-dev",
-        env = "FIDO2LUKS_DEVICE_AWAIT",
-        default_value = "15"
-    )]
-    pub await_time: u64,
-}
-
-#[derive(Debug, StructOpt)]
-pub struct LuksParameters {
-    #[structopt(env = "FIDO2LUKS_DEVICE")]
-    pub device: PathBuf,
-
-    /// Try to unlock the device using a specifc keyslot, ignore all other slots
-    #[structopt(long = "slot", env = "FIDO2LUKS_DEVICE_SLOT")]
-    pub slot: Option<u32>,
-
-    /// Disable implicit use of LUKS2 tokens
-    #[structopt(
-        long = "disable-token",
-    //  env = "FIDO2LUKS_DISABLE_TOKEN" // unfortunately clap will convert flags into args if they have an env attribute
-    )]
-    pub disable_token: bool,
-}
-
-#[derive(Debug, StructOpt, Clone)]
-pub struct LuksModParameters {
-    /// Number of milliseconds required to derive the volume decryption key
-    /// Defaults to 10ms when using an authenticator or the default by cryptsetup when using a password
-    #[structopt(long = "kdf-time", name = "kdf-time", env = "FIDO2LUKS_KDF_TIME")]
-    pub kdf_time: Option<u64>,
-}
-
-#[derive(Debug, StructOpt)]
-pub struct SecretParameters {
-    /// Salt for secret generation, defaults to 'ask'
-    ///
-    /// Options:{n}
-    ///  - ask              : Prompt user using password helper{n}
-    ///  - file:<PATH>      : Will read <FILE>{n}
-    ///  - string:<STRING>  : Will use <STRING>, which will be handled like a password provided to the 'ask' option{n}
-    #[structopt(
-        name = "salt",
-        long = "salt",
-        env = "FIDO2LUKS_SALT",
-        default_value = "ask"
-    )]
-    pub salt: SecretInput,
-    /// Script used to obtain passwords, overridden by --interactive flag
-    #[structopt(
-        name = "password-helper",
-        env = "FIDO2LUKS_PASSWORD_HELPER",
-        long = "password-helper"
-    )]
-    pub password_helper: Option<PasswordHelper>,
-}
-#[derive(Debug, StructOpt)]
-pub struct Args {
-    /// Request passwords via Stdin instead of using the password helper
-    #[structopt(short = "i", long = "interactive")]
-    pub interactive: bool,
-    #[structopt(short = "v", long = "verbose")]
-    pub verbose: bool,
-    #[structopt(subcommand)]
-    pub command: Command,
-}
-
-#[derive(Debug, StructOpt, Clone)]
-pub struct OtherSecret {
-    /// Use a keyfile instead of a password
-    #[structopt(short = "d", long = "keyfile", conflicts_with = "fido_device")]
-    pub keyfile: Option<PathBuf>,
-    /// Use another fido device instead of a password
-    /// Note: this requires for the credential for the other device to be passed as argument as well
-    #[structopt(short = "f", long = "fido-device", conflicts_with = "keyfile")]
-    pub fido_device: bool,
-}
-
-#[derive(Debug, StructOpt)]
-pub enum Command {
-    #[structopt(name = "print-secret")]
-    PrintSecret {
-        // version 0.3.0 will store use the lower case ascii encoded hex string making binary output unnecessary
-        /// Prints the secret as binary instead of hex encoded
-        #[structopt(hidden = true, short = "b", long = "bin")]
-        binary: bool,
-        #[structopt(flatten)]
-        credentials: Credentials,
-        #[structopt(flatten)]
-        authenticator: AuthenticatorParameters,
-        #[structopt(flatten)]
-        secret: SecretParameters,
-        /// Load credentials from LUKS header
-        #[structopt(env = "FIDO2LUKS_DEVICE")]
-        device: Option<PathBuf>,
-    },
-    /// Adds a generated key to the specified LUKS device
-    #[structopt(name = "add-key")]
-    AddKey {
-        #[structopt(flatten)]
-        luks: LuksParameters,
-        #[structopt(flatten)]
-        credentials: Credentials,
-        /// Comment to be associated with this credential
-        #[structopt(long = "comment")]
-        comment: Option<String>,
-        #[structopt(flatten)]
-        authenticator: AuthenticatorParameters,
-        #[structopt(flatten)]
-        secret: SecretParameters,
-        /// Will wipe all other keys
-        #[structopt(short = "e", long = "exclusive")]
-        exclusive: bool,
-        /// Will generate an credential while adding a new key to this LUKS device if supported
-        #[structopt(short = "g", long = "gen-cred")]
-        generate_credential: bool,
-        #[structopt(flatten)]
-        existing_secret: OtherSecret,
-        #[structopt(flatten)]
-        luks_mod: LuksModParameters,
-    },
-    /// Replace a previously added key with a password
-    #[structopt(name = "replace-key")]
-    ReplaceKey {
-        #[structopt(flatten)]
-        luks: LuksParameters,
-        #[structopt(flatten)]
-        credentials: Credentials,
-        #[structopt(flatten)]
-        authenticator: AuthenticatorParameters,
-        #[structopt(flatten)]
-        secret: SecretParameters,
-        /// Add the password and keep the key
-        #[structopt(short = "a", long = "add-password")]
-        add_password: bool,
-        /// Remove the affected credential from LUKS header
-        #[structopt(short = "r", long = "remove-cred")]
-        remove_cred: bool,
-        #[structopt(flatten)]
-        replacement: OtherSecret,
-        #[structopt(flatten)]
-        luks_mod: LuksModParameters,
-    },
-    /// Open the LUKS device
-    #[structopt(name = "open", alias = "open-token")]
-    Open {
-        #[structopt(flatten)]
-        luks: LuksParameters,
-        #[structopt(env = "FIDO2LUKS_MAPPER_NAME")]
-        name: String,
-        #[structopt(flatten)]
-        credentials: Credentials,
-        #[structopt(flatten)]
-        authenticator: AuthenticatorParameters,
-        #[structopt(flatten)]
-        secret: SecretParameters,
-        #[structopt(short = "r", long = "max-retries", default_value = "0")]
-        retries: i32,
-        /// Perform the whole procedure without mounting the LUKS volume on success
-        #[structopt(long = "dry-run")]
-        dry_run: bool,
-        /// Pass SSD trim instructions to the underlying block device
-        #[structopt(long = "allow-discards")]
-        allow_discards: bool,
-    },
-    /// Generate a new FIDO credential
-    #[structopt(name = "credential")]
-    Credential {
-        #[structopt(flatten)]
-        authenticator: AuthenticatorParameters,
-        /// Name to be displayed on the authenticator display
-        #[structopt(env = "FIDO2LUKS_CREDENTIAL_NAME", default_value = "")]
-        name: String,
-    },
-    /// Check if an authenticator is connected
-    #[structopt(name = "connected")]
-    Connected,
-    Token(TokenCommand),
-    /// Generate bash completion scripts
-    /// Example: fido2luks completions --shell bash /usr/share/bash-completion/completions
-    #[structopt(name = "completions", setting = AppSettings::Hidden)]
-    GenerateCompletions {
-        /// Shell to generate completions for
-        #[structopt(short = "s", long = "shell",possible_values = &Shell::variants()[..])]
-        shell: Option<String>,
-        out_dir: PathBuf,
-    },
-}
-
-///LUKS2 token related operations
-#[derive(Debug, StructOpt)]
-pub enum TokenCommand {
-    /// List all tokens associated with the specified device
-    List {
-        #[structopt(env = "FIDO2LUKS_DEVICE")]
-        device: PathBuf,
-        /// Dump all credentials as CSV
-        #[structopt(long = "csv")]
-        csv: bool,
-    },
-    /// Add credential to a keyslot
-    Add {
-        #[structopt(env = "FIDO2LUKS_DEVICE")]
-        device: PathBuf,
-        /// FIDO credential ids, separated by ',' generate using fido2luks credential
-        #[structopt(
-            name = "credential-ids",
-            env = "FIDO2LUKS_CREDENTIAL_ID",
-            short = "c",
-            long = "creds"
-        )]
-        credentials: CommaSeparated<HexEncoded>,
-        /// Comment to be associated with this credential
-        #[structopt(long = "comment")]
-        comment: Option<String>,
-        /// Slot to which the credentials will be added
-        #[structopt(long = "slot", env = "FIDO2LUKS_DEVICE_SLOT")]
-        slot: u32,
-    },
-    /// Remove credentials from token(s)
-    Remove {
-        #[structopt(env = "FIDO2LUKS_DEVICE")]
-        device: PathBuf,
-        /// FIDO credential ids, separated by ',' generate using fido2luks credential
-        #[structopt(
-            name = "credential-ids",
-            env = "FIDO2LUKS_CREDENTIAL_ID",
-            short = "c",
-            long = "creds"
-        )]
-        credentials: CommaSeparated<HexEncoded>,
-        /// Token from which the credentials will be removed
-        #[structopt(long = "token")]
-        token_id: Option<u32>,
-    },
-    /// Remove all unassigned tokens
-    GC {
-        #[structopt(env = "FIDO2LUKS_DEVICE")]
-        device: PathBuf,
-    },
-}

src/config.rs

@@ -7,37 +7,36 @@ use std::fs::File;
 use std::io::Read;
 use std::path::PathBuf;
 use std::process::Command;
-use std::process::Stdio;
 use std::str::FromStr;
 
 #[derive(Debug, Clone, PartialEq)]
-pub enum SecretInput {
+pub enum InputSalt {
     AskPassword,
     String(String),
     File { path: PathBuf },
 }
 
-impl Default for SecretInput {
+impl Default for InputSalt {
     fn default() -> Self {
-        SecretInput::AskPassword
+        InputSalt::AskPassword
     }
 }
 
-impl From<&str> for SecretInput {
+impl From<&str> for InputSalt {
     fn from(s: &str) -> Self {
         let mut parts = s.split(':');
         match parts.next() {
-            Some("ask") | Some("Ask") => SecretInput::AskPassword,
+            Some("ask") | Some("Ask") => InputSalt::AskPassword,
-            Some("file") => SecretInput::File {
+            Some("file") => InputSalt::File {
                 path: parts.collect::<Vec<_>>().join(":").into(),
             },
-            Some("string") => SecretInput::String(parts.collect::<Vec<_>>().join(":")),
+            Some("string") => InputSalt::String(parts.collect::<Vec<_>>().join(":")),
             _ => Self::default(),
         }
     }
 }
 
-impl FromStr for SecretInput {
+impl FromStr for InputSalt {
     type Err = Fido2LuksError;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
@@ -45,54 +44,21 @@ impl FromStr for SecretInput {
     }
 }
 
-impl fmt::Display for SecretInput {
+impl fmt::Display for InputSalt {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
         f.write_str(&match self {
-            SecretInput::AskPassword => "ask".to_string(),
+            InputSalt::AskPassword => "ask".to_string(),
-            SecretInput::String(s) => ["string", s].join(":"),
+            InputSalt::String(s) => ["string", s].join(":"),
-            SecretInput::File { path } => ["file", path.display().to_string().as_str()].join(":"),
+            InputSalt::File { path } => ["file", path.display().to_string().as_str()].join(":"),
         })
     }
 }
 
-impl SecretInput {
+impl InputSalt {
-    pub fn obtain_string(
+    pub fn obtain(&self, password_helper: &PasswordHelper) -> Fido2LuksResult<[u8; 32]> {
-        &self,
-        password_helper: Option<impl FnOnce() -> Fido2LuksResult<String>>,
-    ) -> Fido2LuksResult<String> {
-        Ok(String::from_utf8(self.obtain(password_helper)?)?)
-    }
-
-    pub fn obtain(
-        &self,
-        password_helper: Option<impl FnOnce() -> Fido2LuksResult<String>>,
-    ) -> Fido2LuksResult<Vec<u8>> {
-        let mut secret = Vec::new();
-        match self {
-            SecretInput::File { path } => {
-                //TODO: replace with try_blocks
-                let mut do_io = || File::open(path)?.read_to_end(&mut secret);
-                do_io().map_err(|cause| Fido2LuksError::KeyfileError { cause })?;
-            }
-            SecretInput::AskPassword => secret.extend_from_slice(
-                password_helper.ok_or_else(|| Fido2LuksError::AskPassError {
-                    cause: AskPassError::FailedHelper,
-                })?()?
-                .as_bytes(),
-            ),
-
-            SecretInput::String(s) => secret.extend_from_slice(s.as_bytes()),
-        }
-        Ok(secret)
-    }
-
-    pub fn obtain_sha256(
-        &self,
-        password_helper: Option<impl FnOnce() -> Fido2LuksResult<String>>,
-    ) -> Fido2LuksResult<[u8; 32]> {
         let mut digest = digest::Context::new(&digest::SHA256);
         match self {
-            SecretInput::File { path } => {
+            InputSalt::File { path } => {
                 let mut do_io = || {
                     let mut reader = File::open(path)?;
                     let mut buf = [0u8; 512];
@@ -107,7 +73,10 @@ impl SecretInput {
                 };
                 do_io().map_err(|cause| Fido2LuksError::KeyfileError { cause })?;
             }
-            _ => digest.update(self.obtain(password_helper)?.as_slice()),
+            InputSalt::AskPassword => {
+                digest.update(password_helper.obtain()?.as_bytes());
+            }
+            InputSalt::String(s) => digest.update(s.as_bytes()),
         }
         let mut salt = [0u8; 32];
         salt.as_mut().copy_from_slice(digest.finish().as_ref());
@@ -164,13 +133,12 @@ impl PasswordHelper {
         use PasswordHelper::*;
         match self {
             Systemd => unimplemented!(),
-            Stdin => Ok(util::read_password("Password", true, false)?),
+            Stdin => Ok(util::read_password("Password", true)?),
             Script(password_helper) => {
-                let password = Command::new("sh")
+                let mut helper_parts = password_helper.split(' ');
-                    .arg("-c")
+
-                    .arg(&password_helper)
+                let password = Command::new((&mut helper_parts).next().unwrap())
-                    .stdin(Stdio::inherit())
+                    .args(helper_parts)
-                    .stderr(Stdio::inherit())
                     .output()
                     .map_err(|e| Fido2LuksError::AskPassError {
                         cause: error::AskPassError::IO(e),
@@ -190,30 +158,24 @@ mod test {
     #[test]
     fn input_salt_from_str() {
         assert_eq!(
-            "file:/tmp/abc".parse::<SecretInput>().unwrap(),
+            "file:/tmp/abc".parse::<InputSalt>().unwrap(),
-            SecretInput::File {
+            InputSalt::File {
                 path: "/tmp/abc".into()
             }
         );
         assert_eq!(
-            "string:abc".parse::<SecretInput>().unwrap(),
+            "string:abc".parse::<InputSalt>().unwrap(),
-            SecretInput::String("abc".into())
+            InputSalt::String("abc".into())
-        );
-        assert_eq!(
-            "ask".parse::<SecretInput>().unwrap(),
-            SecretInput::AskPassword
-        );
-        assert_eq!(
-            "lol".parse::<SecretInput>().unwrap(),
-            SecretInput::default()
         );
+        assert_eq!("ask".parse::<InputSalt>().unwrap(), InputSalt::AskPassword);
+        assert_eq!("lol".parse::<InputSalt>().unwrap(), InputSalt::default());
     }
 
     #[test]
     fn input_salt_obtain() {
         assert_eq!(
-            SecretInput::String("abc".into())
+            InputSalt::String("abc".into())
-                .obtain_sha256(Some(|| Ok("123456".to_string())))
+                .obtain(&PasswordHelper::Stdin)
                 .unwrap(),
             [
                 186, 120, 22, 191, 143, 1, 207, 234, 65, 65, 64, 222, 93, 174, 34, 35, 176, 3, 97,

src/device.rs

@@ -1,133 +1,73 @@
 use crate::error::*;
 
 use crate::util;
-use ctap_hid_fido2;
+use ctap::{
-use ctap_hid_fido2::fidokey::get_assertion::get_assertion_params;
+    self, extensions::hmac::HmacExtension, request_multiple_devices, FidoAssertionRequestBuilder,
-use ctap_hid_fido2::fidokey::make_credential::make_credential_params;
+    FidoCredential, FidoCredentialRequestBuilder, FidoDevice, FidoError, FidoErrorKind,
-use ctap_hid_fido2::fidokey::GetAssertionArgsBuilder;
+};
-use ctap_hid_fido2::fidokey::MakeCredentialArgsBuilder;
-use ctap_hid_fido2::get_fidokey_devices;
-use ctap_hid_fido2::public_key_credential_descriptor::PublicKeyCredentialDescriptor;
-use ctap_hid_fido2::public_key_credential_user_entity::PublicKeyCredentialUserEntity;
-use ctap_hid_fido2::FidoKeyHidFactory;
-use ctap_hid_fido2::HidInfo;
-use ctap_hid_fido2::LibCfg;
 use std::time::Duration;
 
 const RP_ID: &str = "fido2luks";
 
-fn lib_cfg() -> LibCfg {
-    let mut cfg = LibCfg::init();
-    cfg.enable_log = false;
-    cfg.keep_alive_msg = String::new();
-    cfg
-}
-
 pub fn make_credential_id(
     name: Option<&str>,
     pin: Option<&str>,
-    exclude: &[&PublicKeyCredentialDescriptor],
+) -> Fido2LuksResult<FidoCredential> {
-) -> Fido2LuksResult<PublicKeyCredentialDescriptor> {
+    let mut request = FidoCredentialRequestBuilder::default().rp_id(RP_ID);
-    let mut req = MakeCredentialArgsBuilder::new(RP_ID, &[])
+    if let Some(user_name) = name {
-        .extensions(&[make_credential_params::Extension::HmacSecret(Some(true))]);
+        request = request.user_name(user_name);
+    }
+    let request = request.build().unwrap();
+    let make_credential = |device: &mut FidoDevice| {
         if let Some(pin) = pin {
-        req = req.pin(pin);
+            device.unlock(pin)?;
-    } else {
-        req = req.without_pin_and_uv();
         }
-    for cred in exclude {
+        device.make_hmac_credential(&request)
-        req = req.exclude_authenticator(cred.id.as_ref());
+    };
-    }
+    Ok(request_multiple_devices(
-    if let Some(_) = name {
+        get_devices()?
-        req = req.user_entity(&PublicKeyCredentialUserEntity::new(
+            .iter_mut()
-            Some(b"00"),
+            .map(|device| (device, &make_credential)),
-            name.clone(),
+        None,
-            name,
+    )?)
-        ));
-    }
-    let devices = get_devices()?;
-    let mut err: Option<Fido2LuksError> = None;
-    let req = req.build();
-    for dev in devices {
-        let handle = FidoKeyHidFactory::create_by_params(&vec![dev.param], &lib_cfg()).unwrap();
-        match handle.make_credential_with_args(&req) {
-            Ok(resp) => return Ok(resp.credential_descriptor),
-            Err(e) => err = Some(e.into()),
-        }
-    }
-    Err(err.unwrap_or(Fido2LuksError::NoAuthenticatorError))
 }
 
 pub fn perform_challenge<'a>(
-    credentials: &'a [&'a PublicKeyCredentialDescriptor],
+    credentials: &'a [&'a FidoCredential],
     salt: &[u8; 32],
-    _timeout: Duration,
+    timeout: Duration,
     pin: Option<&str>,
-) -> Fido2LuksResult<([u8; 32], &'a PublicKeyCredentialDescriptor)> {
+) -> Fido2LuksResult<([u8; 32], &'a FidoCredential)> {
-    if credentials.is_empty() {
+    let request = FidoAssertionRequestBuilder::default()
-        return Err(Fido2LuksError::InsufficientCredentials);
+        .rp_id(RP_ID)
-    }
+        .credentials(credentials)
-    let mut req = GetAssertionArgsBuilder::new(RP_ID, &[]).extensions(&[
+        .build()
-        get_assertion_params::Extension::HmacSecret(Some(util::sha256(&[&salt[..]]))),
-    ]);
-    for cred in credentials {
-        req = req.add_credential_id(&cred.id);
-    }
-    if let Some(pin) = pin {
-        req = req.pin(pin);
-    } else {
-        req = req.without_pin_and_uv();
-    }
-    let process_response = |resp: Vec<get_assertion_params::Assertion>| -> Fido2LuksResult<([u8; 32], &'a PublicKeyCredentialDescriptor)> {
-    for att in resp {
-        for ext in att.extensions.iter() {
-            match ext {
-                get_assertion_params::Extension::HmacSecret(Some(secret)) => {
-                    //TODO: eliminate unwrap
-                    let cred_used = credentials
-                        .iter()
-                        .copied()
-                        .find(|cred| {
-                            att.credential_id == cred.id
-                        })
         .unwrap();
-                    return Ok((secret.clone(), cred_used));
+    let get_assertion = |device: &mut FidoDevice| {
+        if let Some(pin) = pin {
+            device.unlock(pin)?;
         }
-                _ => continue,
+        device.get_hmac_assertion(&request, &util::sha256(&[&salt[..]]), None)
-            }
-        }
-     }
-        Err(Fido2LuksError::WrongSecret)
     };
-
+    let (credential, (secret, _)) = request_multiple_devices(
-    let devices = get_devices()?;
+        get_devices()?
-    let mut err: Option<Fido2LuksError> = None;
+            .iter_mut()
-    let req = req.build();
+            .map(|device| (device, &get_assertion)),
-    for dev in devices {
+        Some(timeout),
-        let handle = FidoKeyHidFactory::create_by_params(&vec![dev.param], &lib_cfg()).unwrap();
+    )?;
-        match handle.get_assertion_with_args(&req) {
+    Ok((secret, credential))
-            Ok(resp) => return process_response(resp),
-            Err(e) => err = Some(e.into()),
-        }
-    }
-    Err(err.unwrap_or(Fido2LuksError::NoAuthenticatorError))
 }
 
-pub fn may_require_pin() -> Fido2LuksResult<bool> {
+pub fn get_devices() -> Fido2LuksResult<Vec<FidoDevice>> {
-    for dev in get_devices()? {
+    let mut devices = Vec::with_capacity(2);
-        let handle = FidoKeyHidFactory::create_by_params(&vec![dev.param], &lib_cfg()).unwrap();
+    for di in ctap::get_devices()? {
-        let info = handle.get_info()?;
+        match FidoDevice::new(&di) {
-        let needs_pin = info
+            Err(e) => match e.kind() {
-            .options
+                FidoErrorKind::ParseCtap | FidoErrorKind::DeviceUnsupported => (),
-            .iter()
+                err => return Err(FidoError::from(err).into()),
-            .any(|(name, val)| &name[..] == "clientPin" && *val);
+            },
-        if needs_pin {
+            Ok(dev) => devices.push(dev),
-            return Ok(true);
         }
     }
-    Ok(false)
+    Ok(devices)
-}
-
-pub fn get_devices() -> Fido2LuksResult<Vec<HidInfo>> {
-    Ok(get_fidokey_devices())
 }

src/error.rs

@@ -1,9 +1,5 @@
-use anyhow;
+use ctap::FidoError;
-use libcryptsetup_rs::LibcryptErr;
 use std::io;
-use std::io::ErrorKind;
-use std::string::FromUtf8Error;
-use Fido2LuksError::*;
 
 pub type Fido2LuksResult<T> = Result<T, Fido2LuksError>;
 
@@ -14,7 +10,7 @@ pub enum Fido2LuksError {
     #[fail(display = "unable to read keyfile: {}", cause)]
     KeyfileError { cause: io::Error },
     #[fail(display = "authenticator error: {}", cause)]
-    AuthenticatorError { cause: anyhow::Error },
+    AuthenticatorError { cause: ctap::FidoError },
     #[fail(display = "no authenticator found, please ensure your device is plugged in")]
     NoAuthenticatorError,
     #[fail(display = " {}", cause)]
@@ -29,16 +25,6 @@ pub enum Fido2LuksError {
     WrongSecret,
     #[fail(display = "not an utf8 string")]
     StringEncodingError { cause: FromUtf8Error },
-    #[fail(display = "not an hex string: {}", string)]
-    HexEncodingError { string: String },
-    #[fail(display = "couldn't obtain at least one credential")]
-    InsufficientCredentials,
-}
-
-impl From<anyhow::Error> for Fido2LuksError {
-    fn from(cause: anyhow::Error) -> Self {
-        Fido2LuksError::AuthenticatorError { cause }
-    }
 }
 
 impl Fido2LuksError {
@@ -60,8 +46,6 @@ pub enum AskPassError {
     IO(io::Error),
     #[fail(display = "provided passwords don't match")]
     Mismatch,
-    #[fail(display = "failed to call password helper")]
-    FailedHelper,
 }
 
 #[derive(Debug, Fail)]
@@ -97,6 +81,17 @@ impl From<LuksError> for Fido2LuksError {
     }
 }
 
+use libcryptsetup_rs::LibcryptErr;
+use std::io::ErrorKind;
+use std::string::FromUtf8Error;
+use Fido2LuksError::*;
+
+impl From<FidoError> for Fido2LuksError {
+    fn from(e: FidoError) -> Self {
+        AuthenticatorError { cause: e }
+    }
+}
+
 impl From<LibcryptErr> for Fido2LuksError {
     fn from(e: LibcryptErr) -> Self {
         match e {

src/luks.rs

@@ -1,8 +1,8 @@
 use crate::error::*;
 
 use libcryptsetup_rs::{
-    CryptActivateFlag, CryptActivateFlags, CryptDevice, CryptInit, CryptTokenInfo,
+    CryptActivateFlags, CryptDevice, CryptInit, CryptTokenInfo, EncryptionFormat, KeyslotInfo,
-    EncryptionFormat, KeyslotInfo, TokenInput,
+    TokenInput,
 };
 use std::collections::{HashMap, HashSet};
 use std::path::Path;
@@ -11,7 +11,7 @@ pub struct LuksDevice {
     device: CryptDevice,
     luks2: Option<bool>,
 }
-
+/// Wrapper around [CryptDevice](libcryptsetup_rs::CryptDevice)
 impl LuksDevice {
     pub fn load<P: AsRef<Path>>(path: P) -> Fido2LuksResult<LuksDevice> {
         let mut device = CryptInit::init(path.as_ref())?;
@@ -22,6 +22,7 @@ impl LuksDevice {
         })
     }
 
+    /// Check whether the device supports LUKS2
     pub fn is_luks2(&mut self) -> Fido2LuksResult<bool> {
         if let Some(luks2) = self.luks2 {
             Ok(luks2)
@@ -34,6 +35,7 @@ impl LuksDevice {
         }
     }
 
+    /// Check whether the device supports LUKS2, return an appropriate error if it does not
     fn require_luks2(&mut self) -> Fido2LuksResult<()> {
         if !self.is_luks2()? {
             return Err(LuksError::Luks2Required.into());
@@ -41,6 +43,7 @@ impl LuksDevice {
         Ok(())
     }
 
+    /// Returns an iterator over all tokens, of type fido2luks
     pub fn tokens<'a>(
         &'a mut self,
     ) -> Fido2LuksResult<Box<dyn Iterator<Item = Fido2LuksResult<(u32, Fido2LuksToken)>> + 'a>>
@@ -84,6 +87,7 @@ impl LuksDevice {
         ))
     }
 
+    /// Returns the first token with an reference to the specified keyslot
     pub fn find_token(&mut self, slot: u32) -> Fido2LuksResult<Option<(u32, Fido2LuksToken)>> {
         let slot_str = slot.to_string();
         for token in self.tokens()? {
@@ -111,20 +115,6 @@ impl LuksDevice {
         Ok(())
     }
 
-    pub fn remove_token_slot(&mut self, slot: u32) -> Fido2LuksResult<()> {
-        let mut remove = HashSet::new();
-        for token in self.tokens()? {
-            let (id, token) = token?;
-            if token.keyslots.contains(&slot.to_string()) {
-                remove.insert(id);
-            }
-        }
-        for rm in remove {
-            self.remove_token(rm)?;
-        }
-        Ok(())
-    }
-
     pub fn update_token(&mut self, token: u32, data: &Fido2LuksToken) -> Fido2LuksResult<()> {
         self.require_luks2()?;
         self.device
@@ -136,13 +126,14 @@ impl LuksDevice {
         Ok(())
     }
 
+    /// Add a new key `secret` using `old_secret` with the specified `iteration_time` in milliseconds
+    /// an LUKS2 token will be created if the device supports LUKS2 and a `credential_id` is provided
     pub fn add_key(
         &mut self,
         secret: &[u8],
         old_secret: &[u8],
         iteration_time: Option<u64>,
         credential_id: Option<&[u8]>,
-        comment: Option<String>,
     ) -> Fido2LuksResult<u32> {
         if let Some(millis) = iteration_time {
             self.device.settings_handle().set_iteration_time(millis)
@@ -153,7 +144,7 @@ impl LuksDevice {
             .add_by_passphrase(None, old_secret, secret)?;
         if let Some(id) = credential_id {
             self.device.token_handle().json_set(TokenInput::AddToken(
-                &serde_json::to_value(&Fido2LuksToken::new(id, slot, comment)).unwrap(),
+                &serde_json::to_value(&Fido2LuksToken::new(id, slot)).unwrap(),
             ))?;
         }
 
@@ -190,6 +181,8 @@ impl LuksDevice {
         Ok(destroyed)
     }
 
+    /// Replaces an existing key with `secret` using `old_secret` with the specified `iteration_time` in milliseconds
+    /// an LUKS2 token will be created or updated if the device supports LUKS2 and a `credential_id` is provided
     pub fn replace_key(
         &mut self,
         secret: &[u8],
@@ -207,9 +200,7 @@ impl LuksDevice {
             old_secret,
             CryptActivateFlags::empty(),
         )?;
-
+        self.device.keyslot_handle().change_by_passphrase(
-        // slot should stay the same but better be safe than sorry
-        let slot = self.device.keyslot_handle().change_by_passphrase(
             Some(slot),
             Some(slot),
             old_secret,
@@ -217,18 +208,9 @@ impl LuksDevice {
         )? as u32;
         if let Some(id) = credential_id {
             if self.is_luks2()? {
-                let (token_id, token_data) = match self.find_token(slot)? {
+                let token = self.find_token(slot)?.map(|(t, _)| t);
-                    Some((id, data)) => (Some(id), Some(data)),
+                let json = serde_json::to_value(&Fido2LuksToken::new(id, slot)).unwrap();
-                    _ => (None, None),
+                if let Some(token) = token {
-                };
-                let json = serde_json::to_value(&Fido2LuksToken::new(
-                    id,
-                    slot,
-                    // retain comment on replace
-                    token_data.map(|data| data.comment).flatten(),
-                ))
-                .unwrap();
-                if let Some(token) = token_id {
                     self.device
                         .token_handle()
                         .json_set(TokenInput::ReplaceToken(token, &json))?;
@@ -247,16 +229,10 @@ impl LuksDevice {
         name: &str,
         secret: &[u8],
         slot_hint: Option<u32>,
-        dry_run: bool,
-        allow_discard: bool,
     ) -> Fido2LuksResult<u32> {
-        let mut flags = CryptActivateFlags::empty();
-        if allow_discard {
-            flags = CryptActivateFlags::new(vec![CryptActivateFlag::AllowDiscards]);
-        }
         self.device
             .activate_handle()
-            .activate_by_passphrase(Some(name).filter(|_| !dry_run), slot_hint, secret, flags)
+            .activate_by_passphrase(Some(name), slot_hint, secret, CryptActivateFlags::empty())
             .map_err(LuksError::activate)
     }
 
@@ -265,8 +241,6 @@ impl LuksDevice {
         name: &str,
         secret: impl Fn(Vec<String>) -> Fido2LuksResult<([u8; 32], String)>,
         slot_hint: Option<u32>,
-        dry_run: bool,
-        allow_discard: bool,
     ) -> Fido2LuksResult<u32> {
         if !self.is_luks2()? {
             return Err(LuksError::Luks2Required.into());
@@ -310,7 +284,7 @@ impl LuksDevice {
                 .chain(std::iter::once(None).take(slots.is_empty() as usize)), // Try all slots as last resort
         );
         for slot in slots {
-            match self.activate(name, &secret, slot, dry_run, allow_discard) {
+            match self.activate(name, &secret, slot) {
                 Err(Fido2LuksError::WrongSecret) => (),
                 res => return res,
             }
@@ -319,25 +293,23 @@ impl LuksDevice {
     }
 }
 
+/// Represents a LUKS2 token
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct Fido2LuksToken {
     #[serde(rename = "type")]
     pub type_: String,
     pub credential: HashSet<String>,
     pub keyslots: HashSet<String>,
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub comment: Option<String>,
 }
 
 impl Fido2LuksToken {
-    pub fn new(credential_id: impl AsRef<[u8]>, slot: u32, comment: Option<String>) -> Self {
+    pub fn new(credential_id: impl AsRef<[u8]>, slot: u32) -> Self {
-        Self::with_credentials(std::iter::once(credential_id), slot, comment)
+        Self::with_credentials(std::iter::once(credential_id), slot)
     }
 
     pub fn with_credentials<I: IntoIterator<Item = B>, B: AsRef<[u8]>>(
         credentials: I,
         slot: u32,
-        comment: Option<String>,
     ) -> Self {
         Self {
             credential: credentials
@@ -345,7 +317,6 @@ impl Fido2LuksToken {
                 .map(|cred| hex::encode(cred.as_ref()))
                 .collect(),
             keyslots: vec![slot.to_string()].into_iter().collect(),
-            comment,
             ..Default::default()
         }
     }
@@ -360,7 +331,6 @@ impl Default for Fido2LuksToken {
             type_: Self::default_type().into(),
             credential: HashSet::new(),
             keyslots: HashSet::new(),
-            comment: None,
         }
     }
 }

src/main.rs

@@ -1,15 +1,126 @@
+//! This will allow you to unlock your luks encrypted disk with an fido2 compatible key
+//!
+//! Note: This has only been tested under Fedora 31, [Ubuntu 20.04](initramfs-tools/), [NixOS](https://nixos.org/nixos/manual/#sec-luks-file-systems-fido2) using a Solo Key, Trezor Model T
+//!
+//! ## Setup
+//!
+//! ### Prerequisites
+//!
+//! ```
+//! dnf install clang cargo cryptsetup-devel -y
+//! ```
+//!
+//! ### Device
+//!
+//! ```
+//! git clone https://github.com/shimunn/fido2luks.git && cd fido2luks
+//!
+//! # Alternativly cargo build --release && sudo cp target/release/fido2luks /usr/bin/
+//! sudo -E cargo install -f --path . --root /usr
+//!
+//! # Copy template
+//! cp dracut/96luks-2fa/fido2luks.conf /etc/
+//! # Name is optional but useful if your authenticator has a display
+//! echo FIDO2LUKS_CREDENTIAL_ID=$(fido2luks credential [NAME]) >> /etc/fido2luks.conf
+//!
+//! # Load config into env
+//! set -a
+//! . /etc/fido2luks.conf
+//!
+//! # Repeat for each luks volume
+//! # You can also use the `--token` flag when using LUKS2 which will then store the credential in the LUKS header,
+//! # enabling you to use `fido2luks open-token` without passing a credential as parameter
+//! sudo -E fido2luks -i add-key /dev/disk/by-uuid/<DISK_UUID>
+//!
+//! # Test(only works if the luks container isn't active)
+//! sudo -E fido2luks -i open /dev/disk/by-uuid/<DISK_UUID> luks-<DISK_UUID>
+//!
+//! ```
+//!
+//! ### Dracut
+//!
+//! ```
+//! cd dracut
+//!
+//! sudo make install
+//! ```
+//!
+//! ### Grub
+//!
+//! Add `rd.luks.2fa=<CREDENTIAL_ID>:<DISK_UUID>` to `GRUB_CMDLINE_LINUX` in /etc/default/grub
+//!
+//! Note: This is only required for your root disk, systemd will try to unlock all other LUKS partions using the same key if you added it using `fido2luks add-key`
+//!
+//! ```
+//! grub2-mkconfig > /boot/grub2/grub.cfg
+//! ```
+//!
+//! I'd also recommend to copy the executable onto /boot so that it is accessible in case you have to access your disk from a rescue system
+//!
+//! ```
+//! mkdir /boot/fido2luks/
+//! cp /usr/bin/fido2luks /boot/fido2luks/
+//! cp /etc/fido2luks.conf /boot/fido2luks/
+//! ```
+//!
+//! ## Test
+//!
+//! Just reboot and see if it works, if that's the case you should remove your old less secure password from your LUKS header:
+//!
+//! ```
+//! # Recommend in case you lose your authenticator, store this backupfile somewhere safe
+//! cryptsetup luksHeaderBackup /dev/disk/by-uuid/<DISK_UUID> --header-backup-file luks_backup_<DISK_UUID>
+//! # There is no turning back if you mess this up, make sure you made a backup
+//! # You can also pass `--token` if you're using LUKS2 which will then store the credential in the LUKS header,
+//! # which will enable you to use `fido2luks open-token` without passing a credential as parameter
+//! fido2luks -i add-key --exclusive /dev/disk/by-uuid/<DISK_UUID>
+//! ```
+//!
+//! ## Addtional settings
+//!
+//! ### Password less
+//!
+//! Remove your previous secret as described in the next section, in case you've already added one.
+//!
+//! Open `/etc/fido2luks.conf` and replace `FIDO2LUKS_SALT=Ask` with `FIDO2LUKS_SALT=string:<YOUR_RANDOM_STRING>`
+//! but be warned that this password will be included to into your initramfs.
+//!
+//! Import the new config into env:
+//!
+//! ```
+//! set -a
+//! . /etc/fido2luks.conf
+//! ```
+//!
+//! Then add the new secret to each device and update dracut afterwards `dracut -f`
+//!
+//! ## Removal
+//!
+//! Remove `rd.luks.2fa` from `GRUB_CMDLINE_LINUX` in /etc/default/grub
+//!
+//! ```
+//! set -a
+//! . fido2luks.conf
+//! sudo -E fido2luks -i replace-key /dev/disk/by-uuid/<DISK_UUID>
+//!
+//! sudo rm -rf /usr/lib/dracut/modules.d/96luks-2fa /etc/dracut.conf.d/luks-2fa.conf /etc/fido2luks.conf
+//!```
+
 #[macro_use]
 extern crate failure;
+extern crate ctap_hmac as ctap;
 #[macro_use]
 extern crate serde_derive;
 use crate::cli::*;
+use crate::config::*;
 use crate::device::*;
 use crate::error::*;
 use std::io;
+use std::path::PathBuf;
 use std::process::exit;
 
 mod cli;
-pub mod cli_args;
+mod config;
 mod device;
 mod error;
 mod luks;
@@ -18,7 +129,10 @@ mod util;
 fn main() -> Fido2LuksResult<()> {
     match run_cli() {
         Err(e) => {
+            #[cfg(debug_assertions)]
             eprintln!("{:?}", e);
+            #[cfg(not(debug_assertions))]
+            eprintln!("{}", e);
             exit(e.exit_code())
         }
         _ => exit(0),

src/util.rs

@@ -13,17 +13,9 @@ pub fn sha256(messages: &[&[u8]]) -> [u8; 32] {
     secret.as_mut().copy_from_slice(digest.finish().as_ref());
     secret
 }
-pub fn read_password_tty(q: &str, verify: bool) -> Fido2LuksResult<String> {
+
-    read_password(q, verify, true)
+pub fn read_password(q: &str, verify: bool) -> Fido2LuksResult<String> {
-}
+    match rpassword::read_password_from_tty(Some(&[q, ": "].join("")))? {
-pub fn read_password(q: &str, verify: bool, tty: bool) -> Fido2LuksResult<String> {
-    let res = if tty {
-        rpassword::read_password_from_tty(Some(&[q, ": "].join("")))
-    } else {
-        print!("{}: ", q);
-        rpassword::read_password()
-    }?;
-    match res {
         ref pass
             if verify
                 && &rpassword::read_password_from_tty(Some(&[q, "(again): "].join(" ")))?
@@ -37,6 +29,10 @@ pub fn read_password(q: &str, verify: bool, tty: bool) -> Fido2LuksResult<String
     }
 }
 
+pub fn read_password_hashed(q: &str, verify: bool) -> Fido2LuksResult<[u8; 32]> {
+    read_password(q, verify).map(|pass| sha256(&[pass.as_bytes()]))
+}
+
 pub fn read_keyfile<P: Into<PathBuf>>(path: P) -> Fido2LuksResult<Vec<u8>> {
     let mut file = File::open(path.into())?;
     let mut key = Vec::new();