Struct nitrokey::User

pub struct User<'a, T: Device<'a>> { /* fields omitted */ }

A Nitrokey device with user authentication.

To obtain an instance of this struct, use the [authenticate_user][] method from the Authenticate trait. To get back to an unauthenticated device, use the device method.

Methods

impl<'a, T: Device<'a>> User<'a, T>

pub fn device(self) -> T

Forgets the user authentication and returns an unauthenticated device. This method consumes the authenticated device. It does not perform any actual commands on the Nitrokey.

Trait Implementations

impl<'a, T: Debug + Device<'a>> Debug for User<'a, T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a, T: Device<'a>> Deref for User<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: Device<'a>> DerefMut for User<'a, T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T: Device<'a>> GenerateOtp for User<'a, T>

fn get_hotp_code(&mut self, slot: u8) -> Result<String, Error>

Generates an HOTP code on the given slot. This operation may require user authorization, depending on the device configuration (see [get_config][]).

fn get_totp_code(&self, slot: u8) -> Result<String, Error>

Generates a TOTP code on the given slot. This operation may require user authorization, depending on the device configuration (see [get_config][]).

fn set_time(&mut self, time: u64, force: bool) -> Result<(), Error>

Sets the time on the Nitrokey.

fn get_hotp_slot_name(&self, slot: u8) -> Result<String, Error>

Returns the name of the given HOTP slot.

fn get_totp_slot_name(&self, slot: u8) -> Result<String, Error>

Returns the name of the given TOTP slot.