summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/pws.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/pws.rs b/src/pws.rs
index 99a256e..c20ad1d 100644
--- a/src/pws.rs
+++ b/src/pws.rs
@@ -73,7 +73,11 @@ pub trait GetPasswordSafe {
///
/// # Errors
///
+ /// - [`AesDecryptionFailed`][] if the secret for the password safe could not be decrypted
+ /// (Nitrokey Pro only)
/// - [`InvalidString`][] if one of the provided passwords contains a null byte
+ /// - [`Unknown`][] if the secret for the password safe could not be decrypted (Nitrokey
+ /// Storage only)
/// - [`WrongPassword`][] if the current user password is wrong
///
/// # Example
@@ -99,7 +103,9 @@ pub trait GetPasswordSafe {
///
/// [`device`]: struct.PasswordSafe.html#method.device
/// [`lock`]: trait.Device.html#method.lock
+ /// [`AesDecryptionFailed`]: enum.CommandError.html#variant.AesDecryptionFailed
/// [`InvalidString`]: enum.CommandError.html#variant.InvalidString
+ /// [`Unknown`]: enum.CommandError.html#variant.Unknown
/// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword
fn get_password_safe(&self, user_pin: &str) -> Result<PasswordSafe<'_>, CommandError>;
}