Struct nitrokey::Pro

pub struct Pro<'a> { /* fields omitted */ }

A Nitrokey Pro device without user or admin authentication.

Use the connect method to obtain an instance wrapper or the connect_pro method to directly obtain an instance. If you want to execute a command that requires user or admin authentication, use authenticate_admin or authenticate_user.

Examples

Authentication with error handling:

use nitrokey::{Authenticate, User, Pro};

fn perform_user_task<'a>(device: &User<'a, Pro<'a>>) {}
fn perform_other_task(device: &Pro) {}

let mut manager = nitrokey::take()?;
let device = manager.connect_pro()?;
let device = match device.authenticate_user("123456") {
    Ok(user) => {
        perform_user_task(&user);
        user.device()
    },
    Err((device, err)) => {
        eprintln!("Could not authenticate as user: {}", err);
        device
    },
};
perform_other_task(&device);

Trait Implementations

impl<'a> Authenticate<'a> for Pro<'a>

fn authenticate_user(
    self,
    password: &str
) -> Result<User<'a, Self>, (Self, Error)>

Performs user authentication. This method consumes the device. If successful, an authenticated device is returned. Otherwise, the current unauthenticated device and the error are returned.

fn authenticate_admin(
    self,
    password: &str
) -> Result<Admin<'a, Self>, (Self, Error)>

Performs admin authentication. This method consumes the device. If successful, an authenticated device is returned. Otherwise, the current unauthenticated device and the error are returned.

impl<'a> Debug for Pro<'a>

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

Formats the value using the given formatter.

impl<'a> Device<'a> for Pro<'a>

fn into_manager(self) -> &'a mut Manager

Returns the Manager instance that has been used to connect to this device.

fn get_model(&self) -> Model

Returns the model of the connected Nitrokey device.

fn get_status(&self) -> Result<Status, Error>

Returns the status of the Nitrokey device.

fn get_serial_number(&self) -> Result<SerialNumber, Error>

Returns the serial number of the Nitrokey device.

fn get_user_retry_count(&self) -> Result<u8, Error>

Returns the number of remaining authentication attempts for the user. The total number of available attempts is three.

fn get_admin_retry_count(&self) -> Result<u8, Error>

Returns the number of remaining authentication attempts for the admin. The total number of available attempts is three.

fn get_firmware_version(&self) -> Result<FirmwareVersion, Error>

Returns the firmware version.

fn get_config(&self) -> Result<Config, Error>

Returns the current configuration of the Nitrokey device.

fn change_admin_pin(&mut self, current: &str, new: &str) -> Result<(), Error>

Changes the administrator PIN.

fn change_user_pin(&mut self, current: &str, new: &str) -> Result<(), Error>

Changes the user PIN.

fn unlock_user_pin(
    &mut self,
    admin_pin: &str,
    user_pin: &str
) -> Result<(), Error>

Unlocks the user PIN after three failed login attempts and sets it to the given value.

fn lock(&mut self) -> Result<(), Error>

Locks the Nitrokey device.

fn factory_reset(&mut self, admin_pin: &str) -> Result<(), Error>

Performs a factory reset on the Nitrokey device.

fn build_aes_key(&mut self, admin_pin: &str) -> Result<(), Error>

Builds a new AES key on the Nitrokey.

impl<'a> Drop for Pro<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<Pro<'a>> for DeviceWrapper<'a>

fn from(device: Pro<'a>) -> Self

Performs the conversion.

impl<'a> GenerateOtp for Pro<'a>

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.

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).

impl<'a> GetPasswordSafe<'a> for Pro<'a>

fn get_password_safe(
    &mut self,
    user_pin: &str
) -> Result<PasswordSafe<'_, 'a>, Error>

Enables and returns the password safe.