Prepare for release

nickray · nickray · commit 4427112d1f67 · 2021-11-06T23:43:57.000+01:00
diff --git a/70-solo2.rules b/70-solo2.rules
@@ -0,0 +1,8 @@
+# NXP LPC55 ROM bootloader (unmodified)
+SUBSYSTEM=="hidraw", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="0021", TAG+="uaccess"
+# NXP LPC55 ROM bootloader (with Solo 2 VID:PID)
+SUBSYSTEM=="hidraw", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="beee", TAG+="uaccess"
+# Solo 2
+SUBSYSTEM=="tty", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="beee", TAG+="uaccess"
+# Solo 2
+SUBSYSTEM=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="beee", TAG+="uaccess"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.6] - 2021-11-06
+
+### Changed
+
+- No more async - we're not a high throughput webserver
+- Nicer user dialogs (dialoguer/indicatif)
+- Model devices modes (bootloader/card)
+- Add udev rules
+
 ## [0.0.5] - 2021-11-06
 
 ### Added
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "solo2"
-version = "0.0.5"
+version = "0.0.6"
 authors = ["SoloKeys Developers"]
 edition = "2021"
 rust-version = "1.56"
diff --git a/src/apps.rs b/src/apps.rs
@@ -1,7 +1,7 @@
 use hex_literal::hex;
 
+use crate::device::{prompt_user_to_select_device, Device};
 use crate::{Card, Result, Uuid};
-use crate::device::{Device, prompt_user_to_select_device};
 
 pub mod admin;
 pub mod ndef;
@@ -53,7 +53,6 @@ pub trait App: Sized {
     fn card(&mut self) -> &mut Card;
 
     fn connect(uuid: Option<Uuid>) -> Result<Card> {
-
         let mut cards = Card::list(Default::default());
 
         if cards.is_empty() {
@@ -73,10 +72,11 @@ pub trait App: Sized {
                     }
                 }
 
-                return Err(anyhow::anyhow!("Could not find any Solo 2 device with uuid {}.", uuid.hex()));
-
+                return Err(anyhow::anyhow!(
+                    "Could not find any Solo 2 device with uuid {}.",
+                    uuid.hex()
+                ));
             } else {
-
                 let devices = cards.into_iter().map(Device::from).collect();
 
                 let selected = prompt_user_to_select_device(devices)?;
diff --git a/src/apps/oath.rs b/src/apps/oath.rs
@@ -1,7 +1,4 @@
-use core::{
-    convert::{TryFrom, TryInto},
-    fmt,
-};
+use core::fmt;
 
 use anyhow::anyhow;
 use flexiber::{Encodable, TaggedSlice};
diff --git a/src/apps/provisioner.rs b/src/apps/provisioner.rs
@@ -1,5 +1,3 @@
-use core::convert::TryInto;
-
 use anyhow::anyhow;
 use iso7816::Instruction;
 
diff --git a/src/bin/solo2/main.rs b/src/bin/solo2/main.rs
@@ -19,10 +19,10 @@ fn main() {
 }
 
 fn try_main(args: clap::ArgMatches<'_>) -> anyhow::Result<()> {
-
-    let uuid = args.value_of("uuid")
+    let uuid = args
+        .value_of("uuid")
         // if uuid is Some, parse and fail on invalidity (no silent failure)
-        .map(|uuid| solo2::Uuid::from_hex(&uuid))
+        .map(|uuid| solo2::Uuid::from_hex(uuid))
         .transpose()?;
 
     if let Some(args) = args.subcommand_matches("app") {
@@ -229,7 +229,6 @@ fn try_main(args: clap::ArgMatches<'_>) -> anyhow::Result<()> {
     }
 
     if let Some(_args) = args.subcommand_matches("list") {
-
         let devices = solo2::Device::list();
         for device in devices {
             println!("{}", &device);
diff --git a/src/dev_pki.rs b/src/dev_pki.rs
@@ -3,8 +3,6 @@
 //! In particular, there is no root CA, no use of hardware keys / PKCS #11,
 //! no revocation, etc. etc.
 
-use core::convert::TryInto;
-
 use pkcs8::FromPrivateKey as _;
 use rand_core::{OsRng, RngCore};
 
diff --git a/src/device.rs b/src/device.rs
@@ -3,21 +3,22 @@
 use anyhow::anyhow;
 use lpc55::bootloader::Bootloader;
 
-use core::fmt;
 use crate::{Card, Result, Uuid};
+use core::fmt;
 
 // #[derive(Debug, Eq, PartialEq)]
 pub enum Device {
     Bootloader(Bootloader),
     Card(Card),
 }
 
-
 impl fmt::Display for Device {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         match self {
-            Device::Bootloader(bootloader) =>
-                f.write_fmt(format_args!("Bootloader UUID: {}", Uuid::from(bootloader.uuid).hex())),
+            Device::Bootloader(bootloader) => f.write_fmt(format_args!(
+                "Bootloader UUID: {}",
+                Uuid::from(bootloader.uuid).hex()
+            )),
             Device::Card(card) => card.fmt(f),
         }
     }
@@ -26,18 +27,21 @@ impl fmt::Display for Device {
 impl Device {
     pub fn list() -> Vec<Self> {
         let bootloaders = Bootloader::list().into_iter().map(Device::from);
-        let cards = Card::list(crate::smartcard::Filter::SoloCards).into_iter().map(Device::from);
+        let cards = Card::list(crate::smartcard::Filter::SoloCards)
+            .into_iter()
+            .map(Device::from);
 
-        let devices = bootloaders.chain(cards).collect();
-        devices
+        bootloaders.chain(cards).collect()
     }
 
     /// If this is a Solo device, this will successfully report the UUID.
     /// Not guaranteed to work with other devices.
     pub fn uuid(&self) -> Result<Uuid> {
         match self {
             Device::Bootloader(bootloader) => Ok(bootloader.uuid.into()),
-            Device::Card(card) => card.uuid.ok_or(anyhow!("Device does not have a UUID")),
+            Device::Card(card) => card
+                .uuid
+                .ok_or_else(|| anyhow!("Device does not have a UUID")),
         }
     }
 
@@ -79,7 +83,10 @@ pub fn find_bootloader(uuid: Option<Uuid>) -> Result<Bootloader> {
                 return Ok(bootloader);
             }
         }
-        return Err(anyhow!("Could not find any Solo 2 device with uuid {}.", uuid.hex()));
+        return Err(anyhow!(
+            "Could not find any Solo 2 device with uuid {}.",
+            uuid.hex()
+        ));
     } else {
         let mut devices: Vec<Device> = Default::default();
         for bootloader in bootloaders {
@@ -97,35 +104,36 @@ pub fn prompt_user_to_select_device(mut devices: Vec<Device>) -> Result<Device>
         return Err(anyhow!("No Solo 2 devices connected"));
     }
 
-    let items: Vec<String> = devices.iter().map(|device| {
-        match device {
-            Device::Bootloader(bootloader) => {
-                format!(
-                    "Bootloader UUID: {}",
-                    hex::encode(bootloader.uuid.to_be_bytes())
-                )
-
-            },
-            Device::Card(card) => {
-                if let Some(uuid) = card.uuid {
-                    // format!("\"{}\" UUID: {}", card.reader_name, hex::encode(uuid.to_be_bytes()))
-                    format!("Solo 2 {}", uuid.hex())
-                } else {
-                    format!(" \"{}\"", card.reader_name)
+    let items: Vec<String> = devices
+        .iter()
+        .map(|device| {
+            match device {
+                Device::Bootloader(bootloader) => {
+                    format!(
+                        "Bootloader UUID: {}",
+                        hex::encode(bootloader.uuid.to_be_bytes())
+                    )
+                }
+                Device::Card(card) => {
+                    if let Some(uuid) = card.uuid {
+                        // format!("\"{}\" UUID: {}", card.reader_name, hex::encode(uuid.to_be_bytes()))
+                        format!("Solo 2 {}", uuid.hex())
+                    } else {
+                        format!(" \"{}\"", card.reader_name)
+                    }
                 }
             }
-        }
-    }).collect();
+        })
+        .collect();
 
-    use dialoguer::{Select, theme};
+    use dialoguer::{theme, Select};
     // let selection = Select::with_theme(&theme::SimpleTheme)
     let selection = Select::with_theme(&theme::ColorfulTheme::default())
         .with_prompt("Multiple Solo 2 devices connected, select one or hit Escape key")
         .items(&items)
         .default(0)
         .interact_opt()?
-        .ok_or(anyhow!("No device selected"))?;
+        .ok_or_else(|| anyhow!("No device selected"))?;
 
     Ok(devices.remove(selection))
-
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,5 @@
+#![deny(warnings, trivial_casts, unused_qualifications)]
+
 #[macro_use]
 extern crate log;
 
diff --git a/src/smartcard.rs b/src/smartcard.rs
@@ -1,5 +1,5 @@
 use anyhow::anyhow;
-use core::{convert::{TryFrom, TryInto}, fmt};
+use core::fmt;
 use iso7816::Status;
 
 use pcsc::{Context, Protocols, Scope, ShareMode};
@@ -44,20 +44,16 @@ impl TryFrom<(&std::ffi::CStr, &Context)> for Card {
         Ok(Self {
             card,
             reader_name: reader.to_str().unwrap().to_owned(),
-            uuid: uuid_maybe
+            uuid: uuid_maybe,
         })
     }
 }
 
 impl Card {
     pub fn list(filter: Filter) -> Vec<Self> {
         let cards = match Self::try_list() {
-            Ok(cards) => {
-                cards
-            }
-            _ => {
-                Default::default()
-            }
+            Ok(cards) => cards,
+            _ => Default::default(),
         };
         match filter {
             Filter::AllCards => cards,
@@ -69,7 +65,6 @@ impl Card {
     }
 
     pub fn try_list() -> crate::Result<Vec<Self>> {
-
         let mut cards_with_trussed: Vec<Self> = Default::default();
 
         let context = Context::establish(Scope::User)?;
@@ -116,18 +111,11 @@ impl Card {
             Some(&aid),
         )?;
 
-        let uuid_bytes = Self::call_card(
-            card,
-            0,
-            apps::admin::App::UUID_COMMAND,
-            0x00,
-            0x00,
-            None,
-        )?;
+        let uuid_bytes =
+            Self::call_card(card, 0, apps::admin::App::UUID_COMMAND, 0x00, 0x00, None)?;
 
-        Ok(Uuid::try_from(uuid_bytes.as_ref())
-            .map_err(|_| anyhow!("Did not read 16 byte uuid from mgmt app."))?
-        )
+        Uuid::try_from(uuid_bytes.as_ref())
+            .map_err(|_| anyhow!("Did not read 16 byte uuid from mgmt app."))
     }
 
     fn call_card(
diff --git a/src/update.rs b/src/update.rs
@@ -4,10 +4,10 @@ use anyhow::anyhow;
 use lpc55::bootloader::Bootloader;
 use serde_json::{from_value, Value};
 
-use crate::{Card, smartcard, Uuid};
-use crate::apps::App;
 use crate::apps::admin;
-use crate::device::{Device, prompt_user_to_select_device};
+use crate::apps::App;
+use crate::device::{prompt_user_to_select_device, Device};
+use crate::{smartcard, Card, Uuid};
 
 pub fn download_latest_solokeys_firmware() -> crate::Result<Vec<u8>> {
     println!("Downloading latest release from https://github.com/solokeys/solo2/");
@@ -48,7 +48,7 @@ pub fn download_latest_solokeys_firmware() -> crate::Result<Vec<u8>> {
                 .set("User-Agent", "solo2-cli")
                 .call()?
                 .into_string()?;
-            sha256hash = Some(hashfile.split(" ").collect::<Vec<&str>>()[0].into());
+            sha256hash = Some(hashfile.split(' ').collect::<Vec<&str>>()[0].into());
         }
     }
 
@@ -71,7 +71,7 @@ pub fn download_latest_solokeys_firmware() -> crate::Result<Vec<u8>> {
 }
 
 // A rather tolerant update function, intended to be used by end users.
-pub fn run_update_procedure (
+pub fn run_update_procedure(
     sbfile: Option<String>,
     uuid: Option<Uuid>,
     _skip_major_prompt: bool,
@@ -99,13 +99,13 @@ pub fn run_update_procedure (
             match device.uuid() {
                 Ok(device_uuid) => {
                     if device_uuid == uuid {
-                        return program_device(device, sbfile)
+                        return program_device(device, sbfile);
                     }
                 }
                 _ => continue,
             }
         }
-        return Err(anyhow!("Cannot find solo2 device with UUID {}", uuid.hex()))
+        return Err(anyhow!("Cannot find solo2 device with UUID {}", uuid.hex()));
     } else if update_all {
         for device in devices {
             program_device(device, sbfile.clone())?;
@@ -128,8 +128,8 @@ pub fn program_device(device: Device, sbfile: Vec<u8>) -> crate::Result<()> {
             let device_version: u32 = admin.version()?.into();
             let sb2_product_version =
                 lpc55::secure_binary::Sb2Header::from_bytes(&sbfile.as_slice()[..96])
-                .unwrap()
-                .product_version();
+                    .unwrap()
+                    .product_version();
 
             // Device stores version as:
             //          major    minor   patch
@@ -139,16 +139,16 @@ pub fn program_device(device: Device, sbfile: Vec<u8>) -> crate::Result<()> {
             info!("new sb2 firmware version: {:?}", sb2_product_version);
 
             if device_version_major < sb2_product_version.major as u32 {
-                use dialoguer::{Confirm, theme};
+                use dialoguer::{theme, Confirm};
                 println!("Warning: This is is major update and it could risk breaking any current credentials on your key.");
                 println!("Check latest release notes here to double check: https://github.com/solokeys/solo2/releases");
-                println!("If you haven't used your key for anything yet, you can ignore this.");
+                println!("If you haven't used your key for anything yet, you can ignore this.\n");
 
-                println!("");
                 if Confirm::with_theme(&theme::ColorfulTheme::default())
                     .with_prompt("Continue?")
                     .wait_for_newline(true)
-                    .interact()? {
+                    .interact()?
+                {
                     println!("Continuing");
                 } else {
                     return Err(anyhow!("User aborted."));
diff --git a/src/uuid.rs b/src/uuid.rs

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-use core::convert::TryInto;`
`2`		`-`
`3`	`1`	`use anyhow::anyhow;`
`4`	`2`	`use iso7816::Instruction;`
`5`	`3`