summaryrefslogtreecommitdiffstats
path: root/README-dracut.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2015-01-06 11:26:45 +0100
committerGravatar Christian Hesse <mail@eworm.de>2015-01-06 11:26:45 +0100
commite9810f76dae9471d61d3ca475a762d9d64de08bc (patch)
treeb8b26ce43adcd2dc065c0c13017006e7bf9e55b8 /README-dracut.md
parent8cce6dc19907ba44e29555fa83168619365beb32 (diff)
downloadmkinitcpio-ykfde-e9810f76dae9471d61d3ca475a762d9d64de08bc.tar.gz
mkinitcpio-ykfde-e9810f76dae9471d61d3ca475a762d9d64de08bc.tar.zst
update documentation for mkinitcpio & dracut
Diffstat (limited to 'README-dracut.md')
-rw-r--r--README-dracut.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/README-dracut.md b/README-dracut.md
new file mode 100644
index 0000000..bdbe718
--- /dev/null
+++ b/README-dracut.md
@@ -0,0 +1,65 @@
+Full disk encryption with Yubikey (Yubico key) for dracut
+=========================================================
+
+This allows to automatically unlock a LUKS encrypted hard disk from `systemd`-
+enabled initramfs.
+
+Requirements
+------------
+
+To compile and use yubikey full disk encryption you need:
+
+[...]
+
+Build and install
+-----------------
+
+Building and installing is very easy. Just run:
+
+> make
+
+followed by:
+
+> make install-dracut
+
+This will place files to their desired places in filesystem.
+
+Usage
+-----
+
+Make sure systemd knows about your encrypted device by
+adding a line to `/etc/crypttab.initramfs`. It should read like:
+
+> `mapping-name` /dev/`LUKS-device` -
+
+Update `/etc/ykfde.conf` with correct settings. Add `mapping-name` from
+above to `device name` in the `general` section. Then add a new section
+with your key's decimal serial number containing the key slot setting.
+The file should look like this:
+
+ [general]
+ device name = crypt
+
+ [1234567]
+ luks slot = 1
+
+*Be warned*: Do not remove or overwrite your interactive key! Keep that
+for backup and rescue!
+
+`ykfde` will read its information from these files. Then prepare
+the key. Plug it in, make sure it is configured for `HMAC-SHA1`.
+After that run:
+
+> ykfde
+
+This will store a challenge in `/etc/ykfde.d/` and add a new slot to
+your LUKS device. When `ykfde` asks for a password it requires a valid
+password from available slot.
+
+[...]
+
+Additionally enable `systemd` service `ykfde-cpio.service` and make your
+bootloader load the new `cpio` image `/boot/ykfde-challenges.img` (in
+addition to your usual initramfs).
+
+Reboot and have fun!