rustdoc
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing

This commit is contained in:
shimun 2020-06-29 22:26:06 +02:00
parent 9b246ad4a1
commit 0e90169aad
Signed by: shimun
GPG Key ID: E81D8382DC2F971B

View File

@ -5,7 +5,7 @@
//! //!
//! `fido2luks credential 'My 2FA protected disk'` //! `fido2luks credential 'My 2FA protected disk'`
//! //!
//! It is advisable to repeat this step and the next step for more than one authenticator, as a backup //! It is advisable to repeat this step and the next step for more than one authenticator, as backup
//! ### Securing a disk //! ### Securing a disk
//! To utilise the previously generated credential you simply run //! To utilise the previously generated credential you simply run
//! //!
@ -38,6 +38,16 @@
//! `fido2luks -i open-token <device> <name>` //! `fido2luks -i open-token <device> <name>`
//! //!
//! which should even be faster since it allows for the credential to be matched to the right keyslot //! which should even be faster since it allows for the credential to be matched to the right keyslot
//!
//!
//! ### Common options
//!
//! `--salt` Determines what data will be provided to the authenticator in order to derive the secret, the default being `ask` which will prompt the user for an password.
//! Alternatives being `file:<PATH>` where the specified file will be hashed and then used as input, the same goes for the `string:<STRING>` option which will behave in the same manner as the `ask` option.
//!
//! `--pin` Allows for a PIN to be passed to the authenticator if needed, it is however recommended not to use a PIN since the bootscript doesn't support this feature atm.
//!
//! `--help` Will provide context dependant help for each command
use crate::error::*; use crate::error::*;
use crate::*; use crate::*;