Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sosthene-nitrokey committed Apr 5, 2023
1 parent cc33cb6 commit 718cec7
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/extension.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,10 @@ pub trait AuthClient: ExtensionClient<AuthExtension> {
})
}

/// Reset a pin.
/// Set a pin, resetting it's retry counter and setting the key to be wrapped
///
/// Similar to [`set_pin`](AuthClient::set_pin), but allows the key that the pin will unwrap to be configured.
/// Currently only symmetric 256 bit keys are accepted. This method should be used only with keys that were obtained through [`get_pin_key`](AuthClient::get_pin_key)
/// This allows for example backing up the key for a pin, to be able to restore it from another source.
fn set_pin_with_key<I: Into<PinId>>(
&mut self,
Expand Down

0 comments on commit 718cec7

Please sign in to comment.