From 067fceec813a124cd1badda98eb1a4fe218a763f Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 4 May 2016 21:41:36 +0200 Subject: update documentation again, give real example --- README-dracut.md | 18 ++++++++++-------- README-mkinitcpio.md | 18 ++++++++++-------- 2 files changed, 20 insertions(+), 16 deletions(-) diff --git a/README-dracut.md b/README-dracut.md index 6cbb1c4..6039d6f 100644 --- a/README-dracut.md +++ b/README-dracut.md @@ -75,21 +75,23 @@ This will store a challenge in `/etc/ykfde.d/` and add a new slot to your LUKS device. When `ykfde` asks for a passphrase it requires a valid passphrase from available slot. -Alternatively, adding a key with second factor is as easy: +Alternatively, adding a key with second factor (`foo` in this example) +is as easy: -> ykfde --new-2nd-factor 2nd-factor +> ykfde --new-2nd-factor foo To update the challenge run: -> ykfde --2nd-factor 2nd-factor +> ykfde --2nd-factor foo -And changing second factor is straight forward: +And changing second factor (from `foo` to `bar` in this example) is +straight forward: -> ykfde --2nd-factor current-2nd-factor --new-2nd-factor new-2nd-factor +> ykfde --2nd-factor foo --new-2nd-factor bar -The second factor can be read from terminal, increasing security by not -displaying on display and not writing to shell history. Use switches -`--ask-2nd-factor` and `--ask-new-2nd-factor` for that. +The current and new second factor can be read from terminal, increasing +security by not displaying on display and not writing to shell history. +Use switches `--ask-2nd-factor` and `--ask-new-2nd-factor` for that. Make sure to enable second factor in `/etc/ykfde.conf`. diff --git a/README-mkinitcpio.md b/README-mkinitcpio.md index adc07cc..9f2ee4a 100644 --- a/README-mkinitcpio.md +++ b/README-mkinitcpio.md @@ -73,21 +73,23 @@ This will store a challenge in `/etc/ykfde.d/` and add a new slot to your LUKS device. When `ykfde` asks for a passphrase it requires a valid passphrase from available slot. -Alternatively, adding a key with second factor is as easy: +Alternatively, adding a key with second factor (`foo` in this example) +is as easy: -> ykfde --new-2nd-factor 2nd-factor +> ykfde --new-2nd-factor foo To update the challenge run: -> ykfde --2nd-factor 2nd-factor +> ykfde --2nd-factor foo -And changing second factor is straight forward: +And changing second factor (from `foo` to `bar` in this example) is +straight forward: -> ykfde --2nd-factor current-2nd-factor --new-2nd-factor new-2nd-factor +> ykfde --2nd-factor foo --new-2nd-factor bar -The second factor can be read from terminal, increasing security by not -displaying on display and not writing to shell history. Use switches -`--ask-2nd-factor` and `--ask-new-2nd-factor` for that. +The current and new second factor can be read from terminal, increasing +security by not displaying on display and not writing to shell history. +Use switches `--ask-2nd-factor` and `--ask-new-2nd-factor` for that. Make sure to enable second factor in `/etc/ykfde.conf`. -- cgit v1.2.3-54-g00ecf