From dbee55efa41496c8a683bfab96163facc93d6639 Mon Sep 17 00:00:00 2001
From: Robin Krahl <robin.krahl@ireas.org>
Date: Sat, 11 Jan 2020 20:05:39 +0100
Subject: Add support for the GET_STATUS command

This patch adds support for the GET_STATUS command that returns the
status information common to all Nitrokey devices.  It can be accessed
using the Device::get_status function and is stored in a Status struct.

Due to a bug in the Storage firmware [0], the GET_STATUS command returns
wrong firmware versions and serial numbers.  Until this is fixed in
libnitrokey [1], we have to manually execute the GET_DEVICE_STATUS
command to fix these values for the Nitrokey Storage.

Also, this leads to a name clash with the existing Storage::get_status
function, which will be renamed in an upcoming patch.

[0] https://github.com/Nitrokey/nitrokey-storage-firmware/issues/96
[1] https://github.com/Nitrokey/libnitrokey/issues/166
---
 src/device/mod.rs | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)

(limited to 'src/device/mod.rs')

diff --git a/src/device/mod.rs b/src/device/mod.rs
index e015886..668c230 100644
--- a/src/device/mod.rs
+++ b/src/device/mod.rs
@@ -153,6 +153,35 @@ impl fmt::Display for FirmwareVersion {
     }
 }
 
+/// The status information common to all Nitrokey devices.
+pub struct Status {
+    /// The firmware version of the device.
+    pub firmware_version: FirmwareVersion,
+    /// The serial number of the device.
+    pub serial_number: u32,
+    /// The configuration of the device.
+    pub config: Config,
+}
+
+impl From<nitrokey_sys::NK_status> for Status {
+    fn from(status: nitrokey_sys::NK_status) -> Self {
+        Self {
+            firmware_version: FirmwareVersion {
+                major: status.firmware_version_major,
+                minor: status.firmware_version_minor,
+            },
+            serial_number: status.serial_number_smart_card,
+            config: RawConfig {
+                numlock: status.config_numlock,
+                capslock: status.config_capslock,
+                scrollock: status.config_scrolllock,
+                user_password: status.otp_user_password,
+            }
+            .into(),
+        }
+    }
+}
+
 /// A Nitrokey device.
 ///
 /// This trait provides the commands that can be executed without authentication and that are
@@ -197,6 +226,35 @@ pub trait Device<'a>: Authenticate<'a> + GetPasswordSafe<'a> + GenerateOtp + fmt
     /// # }
     fn get_model(&self) -> Model;
 
+    /// Returns the status of the Nitrokey device.
+    ///
+    /// This methods returns the status information common to all Nitrokey devices as a
+    /// [`Status`][] struct.  Some models may provide more information, for example
+    /// [`Storage::get_status`][] returns the [`StorageStatus`][] struct.
+    ///
+    /// # Errors
+    ///
+    /// - [`NotConnected`][] if the Nitrokey device has been disconnected
+    ///
+    /// # Example
+    ///
+    /// ```no_run
+    /// use nitrokey::Device;
+    ///
+    /// let mut manager = nitrokey::take()?;
+    /// let device = manager.connect()?;
+    /// let status = device.get_status()?;
+    /// println!("Firmware version: {}", status.firmware_version);
+    /// println!("Serial number:    {:x}", status.serial_number);
+    /// # Ok::<(), nitrokey::Error>(())
+    /// ```
+    ///
+    /// [`NotConnected`]: enum.CommunicationError.html#variant.NotConnected
+    /// [`Status`]: struct.Status.html
+    /// [`Storage::get_status`]: struct.Storage.html#method.get_status
+    /// [`StorageStatus`]: struct.StorageStatus.html
+    fn get_status(&self) -> Result<Status, Error>;
+
     /// Returns the serial number of the Nitrokey device.  The serial number is the string
     /// representation of a hex number.
     ///
-- 
cgit v1.2.1