diff options
| author |  Christian Hesse <mail@eworm.de> | 2016-05-04 21:14:16 +0200 |
|---|---|---|
| committer | Christian Hesse <mail@eworm.de> | 2016-05-04 21:14:16 +0200 |
| commit | 1c02924892b0ee0e325677351667bad799b7a254 (patch) | |
| tree | 0f0c0b3609cda30bb4b85ed6450dc1c2560f92e8 | |
| parent | 631b93a7d056b1d73b14993cd13c5bdc3b1785a6 (diff) | |
| download | mkinitcpio-ykfde-1c02924892b0ee0e325677351667bad799b7a254.tar.gz mkinitcpio-ykfde-1c02924892b0ee0e325677351667bad799b7a254.tar.zst | |
update documentation
* Use long version of switches.
* Use --new-2nd-factor (instead of --2nd-factor) for initialization.
| -rw-r--r-- | README-dracut.md | 20 | ||||
| -rw-r--r-- | README-mkinitcpio.md | 20 |
2 files changed, 24 insertions, 16 deletions
diff --git a/README-dracut.md b/README-dracut.md index a410438..6cbb1c4 100644 --- a/README-dracut.md +++ b/README-dracut.md @@ -72,20 +72,24 @@ 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. +your LUKS device. When `ykfde` asks for a passphrase it requires a valid +passphrase from available slot. -Adding a key with second factor is as easy: +Alternatively, adding a key with second factor is as easy: -> ykfde -s 2nd-factor +> ykfde --new-2nd-factor 2nd-factor -And updating key and second factor is straight forward: +To update the challenge run: -> ykfde -s old-2nd-factor -n new-2nd-factor +> ykfde --2nd-factor 2nd-factor + +And changing second factor is straight forward: + +> ykfde --2nd-factor current-2nd-factor --new-2nd-factor new-2nd-factor The second factor can be read from terminal, increasing security by not -displaying on display and not writing to shell history. Use capital -switches (`-S` and `-N`) for that. +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 78c0052..adc07cc 100644 --- a/README-mkinitcpio.md +++ b/README-mkinitcpio.md @@ -70,20 +70,24 @@ 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. +your LUKS device. When `ykfde` asks for a passphrase it requires a valid +passphrase from available slot. -Adding a key with second factor is as easy: +Alternatively, adding a key with second factor is as easy: -> ykfde -s 2nd-factor +> ykfde --new-2nd-factor 2nd-factor -And updating key and second factor is straight forward: +To update the challenge run: -> ykfde -s old-2nd-factor -n new-2nd-factor +> ykfde --2nd-factor 2nd-factor + +And changing second factor is straight forward: + +> ykfde --2nd-factor current-2nd-factor --new-2nd-factor new-2nd-factor The second factor can be read from terminal, increasing security by not -displaying on display and not writing to shell history. Use capital -switches (`-S` and `-N`) for that. +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`. |