Enum nitrokey::DeviceWrapper

pub enum DeviceWrapper {
    Storage(Storage),
    Pro(Pro),
}

A wrapper for a Nitrokey device of unknown type.

Use the function connect to obtain a wrapped instance. The wrapper implements all traits that are shared between all Nitrokey devices so that the shared functionality can be used without knowing the type of the underlying device. If you want to use functionality that is not available for all devices, you have to extract the device.

Examples

Authentication with error handling:

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

fn perform_user_task(device: &User<DeviceWrapper>) {}
fn perform_other_task(device: &DeviceWrapper) {}

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

Device-specific commands:

use nitrokey::{DeviceWrapper, Storage};

fn perform_common_task(device: &DeviceWrapper) {}
fn perform_storage_task(device: &Storage) {}

let device = nitrokey::connect()?;
perform_common_task(&device);
match device {
    DeviceWrapper::Storage(storage) => perform_storage_task(&storage),
    _ => (),
};

Variants

Storage(Storage)

A Nitrokey Storage device.

Pro(Pro)

A Nitrokey Pro device.

Trait Implementations

impl Authenticate for DeviceWrapper

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

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<Self>, (Self, CommandError)>

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 Debug for DeviceWrapper

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

Formats the value using the given formatter.

impl Device for DeviceWrapper

fn get_model(&self) -> Model

Returns the model of the connected Nitrokey device.

fn get_serial_number(&self) -> Result<String, CommandError>

Returns the serial number of the Nitrokey device. The serial number is the string representation of a hex number.

fn get_user_retry_count(&self) -> u8

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

fn get_admin_retry_count(&self) -> u8

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

fn get_major_firmware_version(&self) -> i32

Returns the major part of the firmware version (should be zero).

fn get_minor_firmware_version(&self) -> i32

Returns the minor part of the firmware version (for example 8 for version 0.8).

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

Returns the current configuration of the Nitrokey device.

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

Changes the administrator PIN.

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

Changes the user PIN.

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

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

fn lock(&self) -> Result<(), CommandError>

Locks the Nitrokey device.

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

Performs a factory reset on the Nitrokey device.

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

Builds a new AES key on the Nitrokey.

impl GenerateOtp for DeviceWrapper

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

Returns the name of the given HOTP slot.

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

Returns the name of the given TOTP slot.

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

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, CommandError>

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(&self, time: u64, force: bool) -> Result<(), CommandError>

Sets the time on the Nitrokey.

impl GetPasswordSafe for DeviceWrapper

fn get_password_safe(
    &self,
    user_pin: &str
) -> Result<PasswordSafe, CommandError>

Enables and returns the password safe.