use libc; use nitrokey_sys; use crate::auth::Authenticate; use crate::config::{Config, RawConfig}; use crate::otp::GenerateOtp; use crate::pws::GetPasswordSafe; use crate::util::{get_command_result, get_cstring, get_last_error, result_from_string, CommandError}; /// Available Nitrokey models. #[derive(Debug, PartialEq)] enum Model { /// The Nitrokey Storage. Storage, /// The Nitrokey 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: /// /// ```no_run /// use nitrokey::{Authenticate, DeviceWrapper, User}; /// # use nitrokey::CommandError; /// /// fn perform_user_task(device: &User) {} /// fn perform_other_task(device: &DeviceWrapper) {} /// /// # fn try_main() -> Result<(), CommandError> { /// 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); /// # Ok(()) /// # } /// ``` /// /// Device-specific commands: /// /// ```no_run /// use nitrokey::{DeviceWrapper, Storage}; /// # use nitrokey::CommandError; /// /// fn perform_common_task(device: &DeviceWrapper) {} /// fn perform_storage_task(device: &Storage) {} /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// perform_common_task(&device); /// match device { /// DeviceWrapper::Storage(storage) => perform_storage_task(&storage), /// _ => (), /// }; /// # Ok(()) /// # } /// ``` /// /// [`connect`]: fn.connect.html // TODO: add example for Storage-specific code #[derive(Debug)] pub enum DeviceWrapper { /// A Nitrokey Storage device. Storage(Storage), /// A Nitrokey Pro device. Pro(Pro), } /// A Nitrokey Pro device without user or admin authentication. /// /// Use the global function [`connect`][] to obtain an instance wrapper or the method /// [`connect`][`Pro::connect`] 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: /// /// ```no_run /// use nitrokey::{Authenticate, User, Pro}; /// # use nitrokey::CommandError; /// /// fn perform_user_task(device: &User) {} /// fn perform_other_task(device: &Pro) {} /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::Pro::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); /// # Ok(()) /// # } /// ``` /// /// [`authenticate_admin`]: trait.Authenticate.html#method.authenticate_admin /// [`authenticate_user`]: trait.Authenticate.html#method.authenticate_user /// [`connect`]: fn.connect.html /// [`Pro::connect`]: #method.connect #[derive(Debug)] pub struct Pro {} /// A Nitrokey Storage device without user or admin authentication. /// /// Use the global function [`connect`][] to obtain an instance wrapper or the method /// [`connect`][`Storage::connect`] 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: /// /// ```no_run /// use nitrokey::{Authenticate, User, Storage}; /// # use nitrokey::CommandError; /// /// fn perform_user_task(device: &User) {} /// fn perform_other_task(device: &Storage) {} /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::Storage::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); /// # Ok(()) /// # } /// ``` /// /// [`authenticate_admin`]: trait.Authenticate.html#method.authenticate_admin /// [`authenticate_user`]: trait.Authenticate.html#method.authenticate_user /// [`connect`]: fn.connect.html /// [`Storage::connect`]: #method.connect #[derive(Debug)] pub struct Storage {} /// The status of a volume on a Nitrokey Storage device. #[derive(Debug)] pub struct VolumeStatus { /// Indicates whether the volume is read-only. pub read_only: bool, /// Indicates whether the volume is active. pub active: bool, } /// The status of a Nitrokey Storage device. #[derive(Debug)] pub struct StorageStatus { /// The status of the unencrypted volume. pub unencrypted_volume: VolumeStatus, /// The status of the encrypted volume. pub encrypted_volume: VolumeStatus, /// The status of the hidden volume. pub hidden_volume: VolumeStatus, /// The major firmware version, e. g. 0 in v0.40. pub firmware_version_major: u8, /// The minor firmware version, e. g. 40 in v0.40. pub firmware_version_minor: u8, /// Indicates whether the firmware is locked. pub firmware_locked: bool, /// The serial number of the SD card in the Storage stick. pub serial_number_sd_card: u32, /// The serial number of the smart card in the Storage stick. pub serial_number_smart_card: u32, /// The number of remaining login attempts for the user PIN. pub user_retry_count: u8, /// The number of remaining login attempts for the admin PIN. pub admin_retry_count: u8, /// Indicates whether a new SD card was found. pub new_sd_card_found: bool, /// Indicates whether the SD card is filled with random characters. pub filled_with_random: bool, /// Indicates whether the stick has been initialized by generating /// the AES keys. pub stick_initialized: bool, } /// A Nitrokey device. /// /// This trait provides the commands that can be executed without authentication and that are /// present on all supported Nitrokey devices. pub trait Device: Authenticate + GetPasswordSafe + GenerateOtp { /// Returns the serial number of the Nitrokey device. The serial number is the string /// representation of a hex number. /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// match device.get_serial_number() { /// Ok(number) => println!("serial no: {}", number), /// Err(err) => println!("Could not get serial number: {}", err), /// }; /// # Ok(()) /// # } /// ``` fn get_serial_number(&self) -> Result { unsafe { result_from_string(nitrokey_sys::NK_device_serial_number()) } } /// Returns the number of remaining authentication attempts for the user. The total number of /// available attempts is three. /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// let count = device.get_user_retry_count(); /// println!("{} remaining authentication attempts (user)", count); /// # Ok(()) /// # } /// ``` fn get_user_retry_count(&self) -> u8 { unsafe { nitrokey_sys::NK_get_user_retry_count() } } /// Returns the number of remaining authentication attempts for the admin. The total number of /// available attempts is three. /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// let count = device.get_admin_retry_count(); /// println!("{} remaining authentication attempts (admin)", count); /// # Ok(()) /// # } /// ``` fn get_admin_retry_count(&self) -> u8 { unsafe { nitrokey_sys::NK_get_admin_retry_count() } } /// Returns the major part of the firmware version (should be zero). /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// println!( /// "Firmware version: {}.{}", /// device.get_major_firmware_version(), /// device.get_minor_firmware_version(), /// ); /// # Ok(()) /// # } /// ``` fn get_major_firmware_version(&self) -> i32 { unsafe { nitrokey_sys::NK_get_major_firmware_version() } } /// Returns the minor part of the firmware version (for example 8 for version 0.8). /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// println!( /// "Firmware version: {}.{}", /// device.get_major_firmware_version(), /// device.get_minor_firmware_version(), /// ); /// # Ok(()) /// # } fn get_minor_firmware_version(&self) -> i32 { unsafe { nitrokey_sys::NK_get_minor_firmware_version() } } /// Returns the current configuration of the Nitrokey device. /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// let config = device.get_config()?; /// println!("numlock binding: {:?}", config.numlock); /// println!("capslock binding: {:?}", config.capslock); /// println!("scrollock binding: {:?}", config.scrollock); /// println!("require password for OTP: {:?}", config.user_password); /// # Ok(()) /// # } /// ``` fn get_config(&self) -> Result { unsafe { let config_ptr = nitrokey_sys::NK_read_config(); if config_ptr.is_null() { return Err(get_last_error()); } let config_array_ptr = config_ptr as *const [u8; 5]; let raw_config = RawConfig::from(*config_array_ptr); libc::free(config_ptr as *mut libc::c_void); return Ok(raw_config.into()); } } /// Changes the administrator PIN. /// /// # Errors /// /// - [`InvalidString`][] if one of the provided passwords contains a null byte /// - [`WrongPassword`][] if the current admin password is wrong /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// match device.change_admin_pin("12345678", "12345679") { /// Ok(()) => println!("Updated admin PIN."), /// Err(err) => println!("Failed to update admin PIN: {}", err), /// }; /// # Ok(()) /// # } /// ``` /// /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword fn change_admin_pin(&self, current: &str, new: &str) -> Result<(), CommandError> { let current_string = get_cstring(current)?; let new_string = get_cstring(new)?; unsafe { get_command_result(nitrokey_sys::NK_change_admin_PIN( current_string.as_ptr(), new_string.as_ptr(), )) } } /// Changes the user PIN. /// /// # Errors /// /// - [`InvalidString`][] if one of the provided passwords contains a null byte /// - [`WrongPassword`][] if the current user password is wrong /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// match device.change_user_pin("123456", "123457") { /// Ok(()) => println!("Updated admin PIN."), /// Err(err) => println!("Failed to update admin PIN: {}", err), /// }; /// # Ok(()) /// # } /// ``` /// /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword fn change_user_pin(&self, current: &str, new: &str) -> Result<(), CommandError> { let current_string = get_cstring(current)?; let new_string = get_cstring(new)?; unsafe { get_command_result(nitrokey_sys::NK_change_user_PIN( current_string.as_ptr(), new_string.as_ptr(), )) } } /// Unlocks the user PIN after three failed login attempts and sets it to the given value. /// /// # Errors /// /// - [`InvalidString`][] if one of the provided passwords contains a null byte /// - [`WrongPassword`][] if the admin password is wrong /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// match device.unlock_user_pin("12345678", "123456") { /// Ok(()) => println!("Unlocked user PIN."), /// Err(err) => println!("Failed to unlock user PIN: {}", err), /// }; /// # Ok(()) /// # } /// ``` /// /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword fn unlock_user_pin(&self, admin_pin: &str, user_pin: &str) -> Result<(), CommandError> { let admin_pin_string = get_cstring(admin_pin)?; let user_pin_string = get_cstring(user_pin)?; unsafe { get_command_result(nitrokey_sys::NK_unlock_user_password( admin_pin_string.as_ptr(), user_pin_string.as_ptr(), )) } } /// Locks the Nitrokey device. /// /// This disables the password store if it has been unlocked. On the Nitrokey Storage, this /// also disables the volumes if they have been enabled. /// /// # Example /// /// ```no_run /// use nitrokey::Device; /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::connect()?; /// match device.lock() { /// Ok(()) => println!("Locked the Nitrokey device."), /// Err(err) => println!("Could not lock the Nitrokey device: {}", err), /// }; /// # Ok(()) /// # } /// ``` fn lock(&self) -> Result<(), CommandError> { unsafe { get_command_result(nitrokey_sys::NK_lock_device()) } } } /// Connects to a Nitrokey device. This method can be used to connect to any connected device, /// both a Nitrokey Pro and a Nitrokey Storage. /// /// # Example /// /// ``` /// use nitrokey::DeviceWrapper; /// /// fn do_something(device: DeviceWrapper) {} /// /// match nitrokey::connect() { /// Ok(device) => do_something(device), /// Err(err) => println!("Could not connect to a Nitrokey: {}", err), /// } /// ``` pub fn connect() -> Result { unsafe { match nitrokey_sys::NK_login_auto() { 1 => match get_connected_device() { Some(wrapper) => Ok(wrapper), None => Err(CommandError::Unknown), }, _ => Err(CommandError::Unknown), } } } fn get_connected_model() -> Option { unsafe { match nitrokey_sys::NK_get_device_model() { nitrokey_sys::NK_device_model_NK_PRO => Some(Model::Pro), nitrokey_sys::NK_device_model_NK_STORAGE => Some(Model::Storage), _ => None, } } } fn create_device_wrapper(model: Model) -> DeviceWrapper { match model { Model::Pro => DeviceWrapper::Pro(Pro {}), Model::Storage => DeviceWrapper::Storage(Storage {}), } } fn get_connected_device() -> Option { get_connected_model().map(create_device_wrapper) } fn connect_model(model: Model) -> bool { let model = match model { Model::Storage => nitrokey_sys::NK_device_model_NK_STORAGE, Model::Pro => nitrokey_sys::NK_device_model_NK_PRO, }; unsafe { nitrokey_sys::NK_login_enum(model) == 1 } } impl DeviceWrapper { fn device(&self) -> &dyn Device { match *self { DeviceWrapper::Storage(ref storage) => storage, DeviceWrapper::Pro(ref pro) => pro, } } } impl GenerateOtp for DeviceWrapper { fn get_hotp_slot_name(&self, slot: u8) -> Result { self.device().get_hotp_slot_name(slot) } fn get_totp_slot_name(&self, slot: u8) -> Result { self.device().get_totp_slot_name(slot) } fn get_hotp_code(&self, slot: u8) -> Result { self.device().get_hotp_code(slot) } fn get_totp_code(&self, slot: u8) -> Result { self.device().get_totp_code(slot) } } impl Device for DeviceWrapper {} impl Pro { /// Connects to a Nitrokey Pro. /// /// # Example /// /// ``` /// use nitrokey::Pro; /// /// fn use_pro(device: Pro) {} /// /// match nitrokey::Pro::connect() { /// Ok(device) => use_pro(device), /// Err(err) => println!("Could not connect to the Nitrokey Pro: {}", err), /// } /// ``` pub fn connect() -> Result { // TODO: maybe Option instead of Result? match connect_model(Model::Pro) { true => Ok(Pro {}), false => Err(CommandError::Unknown), } } } impl Drop for Pro { fn drop(&mut self) { unsafe { nitrokey_sys::NK_logout(); } } } impl Device for Pro {} impl GenerateOtp for Pro {} impl Storage { /// Connects to a Nitrokey Storage. /// /// # Example /// /// ``` /// use nitrokey::Storage; /// /// fn use_storage(device: Storage) {} /// /// match nitrokey::Storage::connect() { /// Ok(device) => use_storage(device), /// Err(err) => println!("Could not connect to the Nitrokey Storage: {}", err), /// } /// ``` pub fn connect() -> Result { // TODO: maybe Option instead of Result? match connect_model(Model::Storage) { true => Ok(Storage {}), false => Err(CommandError::Unknown), } } /// Enables the encrypted storage volume. /// /// Once the encrypted volume is enabled, it is presented to the operating system as a block /// device. The API does not provide any information on the name or path of this block device. /// /// # Errors /// /// - [`InvalidString`][] if the provided password contains a null byte /// - [`WrongPassword`][] if the provided user password is wrong /// /// # Example /// /// ```no_run /// # use nitrokey::CommandError; /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::Storage::connect()?; /// match device.enable_encrypted_volume("123456") { /// Ok(()) => println!("Enabled the encrypted volume."), /// Err(err) => println!("Could not enable the encrypted volume: {}", err), /// }; /// # Ok(()) /// # } /// ``` /// /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword pub fn enable_encrypted_volume(&self, user_pin: &str) -> Result<(), CommandError> { let user_pin = get_cstring(user_pin)?; unsafe { get_command_result(nitrokey_sys::NK_unlock_encrypted_volume(user_pin.as_ptr())) } } /// Disables the encrypted storage volume. /// /// Once the volume is disabled, it can be no longer accessed as a block device. If the /// encrypted volume has not been enabled, this method still returns a success. /// /// # Example /// /// ```no_run /// # use nitrokey::CommandError; /// /// fn use_volume() {} /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::Storage::connect()?; /// match device.enable_encrypted_volume("123456") { /// Ok(()) => { /// println!("Enabled the encrypted volume."); /// use_volume(); /// match device.disable_encrypted_volume() { /// Ok(()) => println!("Disabled the encrypted volume."), /// Err(err) => { /// println!("Could not disable the encrypted volume: {}", err); /// }, /// }; /// }, /// Err(err) => println!("Could not enable the encrypted volume: {}", err), /// }; /// # Ok(()) /// # } /// ``` pub fn disable_encrypted_volume(&self) -> Result<(), CommandError> { unsafe { get_command_result(nitrokey_sys::NK_lock_encrypted_volume()) } } /// Returns the status of the connected storage device. /// /// # Example /// /// ```no_run /// # use nitrokey::CommandError; /// /// fn use_volume() {} /// /// # fn try_main() -> Result<(), CommandError> { /// let device = nitrokey::Storage::connect()?; /// match device.get_status() { /// Ok(status) => { /// println!("SD card ID: {:#x}", status.serial_number_sd_card); /// }, /// Err(err) => println!("Could not get Storage status: {}", err), /// }; /// # Ok(()) /// # } /// ``` pub fn get_status(&self) -> Result { let mut raw_status = nitrokey_sys::NK_storage_status { unencrypted_volume_read_only: false, unencrypted_volume_active: false, encrypted_volume_read_only: false, encrypted_volume_active: false, hidden_volume_read_only: false, hidden_volume_active: false, firmware_version_major: 0, firmware_version_minor: 0, firmware_locked: false, serial_number_sd_card: 0, serial_number_smart_card: 0, user_retry_count: 0, admin_retry_count: 0, new_sd_card_found: false, filled_with_random: false, stick_initialized: false, }; let raw_result = unsafe { nitrokey_sys::NK_get_status_storage(&mut raw_status) }; let result = get_command_result(raw_result); result.and(Ok(StorageStatus::from(raw_status))) } } impl Drop for Storage { fn drop(&mut self) { unsafe { nitrokey_sys::NK_logout(); } } } impl Device for Storage {} impl GenerateOtp for Storage {} impl From for StorageStatus { fn from(status: nitrokey_sys::NK_storage_status) -> Self { StorageStatus { unencrypted_volume: VolumeStatus { read_only: status.unencrypted_volume_read_only, active: status.unencrypted_volume_active, }, encrypted_volume: VolumeStatus { read_only: status.encrypted_volume_read_only, active: status.encrypted_volume_active, }, hidden_volume: VolumeStatus { read_only: status.hidden_volume_read_only, active: status.hidden_volume_active, }, firmware_version_major: status.firmware_version_major, firmware_version_minor: status.firmware_version_minor, firmware_locked: status.firmware_locked, serial_number_sd_card: status.serial_number_sd_card, serial_number_smart_card: status.serial_number_smart_card, user_retry_count: status.user_retry_count, admin_retry_count: status.admin_retry_count, new_sd_card_found: status.new_sd_card_found, filled_with_random: status.filled_with_random, stick_initialized: status.stick_initialized, } } }