opgpcard: Extract status command into module

tools/src/bin/opgpcard/cli.rs

@@ -5,6 +5,7 @@
 use clap::{AppSettings, Parser, ValueEnum};
 use std::path::PathBuf;
 
+use crate::commands;
 use crate::{OutputFormat, OutputVersion};
 
 pub const OUTPUT_VERSIONS: &[OutputVersion] = &[OutputVersion::new(0, 9, 0)];
@@ -41,17 +42,7 @@ pub enum Command {
     List {},
 
     /// Show information about the data on a card
-    Status {
+    Status(commands::status::StatusCommand),
-        #[clap(name = "card ident", short = 'c', long = "card")]
-        ident: Option<String>,
-
-        #[clap(name = "verbose", short = 'v', long = "verbose")]
-        verbose: bool,
-
-        /// Print public key material for each key slot
-        #[clap(name = "pkm", short = 'K', long = "public-key-material")]
-        pkm: bool,
-    },
 
     /// Show technical details about a card
     Info {

tools/src/bin/opgpcard/commands/mod.rs

@@ -0,0 +1,5 @@
+// SPDX-FileCopyrightText: 2021-2022 Heiko Schaefer <heiko@schaefer.name>
+// SPDX-FileCopyrightText: 2022 Nora Widdecke <mail@nora.pink>
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+pub mod status;

tools/src/bin/opgpcard/commands/status.rs

@@ -0,0 +1,206 @@
+// SPDX-FileCopyrightText: 2021-2022 Heiko Schaefer <heiko@schaefer.name>
+// SPDX-FileCopyrightText: 2022 Lars Wirzenius <liw@liw.fi>
+// SPDX-FileCopyrightText: 2022 Nora Widdecke <mail@nora.pink>
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+use anyhow::Result;
+use clap::Parser;
+
+use openpgp_card_sequoia::card::Card;
+use openpgp_card_sequoia::types::KeyType;
+
+use crate::output;
+use crate::pick_card_for_reading;
+use crate::versioned_output::{OutputBuilder, OutputFormat, OutputVersion};
+
+#[derive(Parser, Debug)]
+pub struct StatusCommand {
+    #[clap(name = "card ident", short = 'c', long = "card")]
+    pub ident: Option<String>,
+
+    #[clap(name = "verbose", short = 'v', long = "verbose")]
+    pub verbose: bool,
+
+    /// Print public key material for each key slot
+    #[clap(name = "pkm", short = 'K', long = "public-key-material")]
+    pub pkm: bool,
+}
+
+pub fn print_status(
+    format: OutputFormat,
+    output_version: OutputVersion,
+    command: StatusCommand,
+) -> Result<()> {
+    let mut output = output::Status::default();
+    output.verbose(command.verbose);
+
+    let backend = pick_card_for_reading(command.ident)?;
+    let mut card = Card::new(backend);
+    let mut open = card.transaction()?;
+
+    output.ident(open.application_identifier()?.ident());
+
+    let ai = open.application_identifier()?;
+    let version = ai.version().to_be_bytes();
+    output.card_version(format!("{}.{}", version[0], version[1]));
+
+    // card / cardholder metadata
+    let crd = open.cardholder_related_data()?;
+
+    if let Some(name) = crd.name() {
+        // FIXME: decoding as utf8 is wrong (the spec defines this field as latin1 encoded)
+        let name = String::from_utf8_lossy(name).to_string();
+
+        // // This field is silly, maybe ignore it?!
+        // if let Some(sex) = crd.sex() {
+        //     if sex == Sex::Male {
+        //         print!("Mr. ");
+        //     } else if sex == Sex::Female {
+        //         print!("Mrs. ");
+        //     }
+        // }
+
+        // re-format name ("last<<first")
+        let name: Vec<_> = name.split("<<").collect();
+        let name = name.iter().cloned().rev().collect::<Vec<_>>().join(" ");
+
+        output.card_holder(name);
+    }
+
+    let url = open.url()?;
+    if !url.is_empty() {
+        output.url(url);
+    }
+
+    if let Some(lang) = crd.lang() {
+        for lang in lang {
+            output.language_preference(format!("{}", lang));
+        }
+    }
+
+    // key information (imported vs. generated on card)
+    let ki = open.key_information().ok().flatten();
+
+    let pws = open.pw_status_bytes()?;
+
+    // information about subkeys
+
+    let fps = open.fingerprints()?;
+    let kgt = open.key_generation_times()?;
+
+    let mut signature_key = output::KeySlotInfo::default();
+    if let Some(fp) = fps.signature() {
+        signature_key.fingerprint(fp.to_spaced_hex());
+    }
+    signature_key.algorithm(format!("{}", open.algorithm_attributes(KeyType::Signing)?));
+    if let Some(kgt) = kgt.signature() {
+        signature_key.created(format!("{}", kgt.to_datetime()));
+    }
+    if let Some(uif) = open.uif_signing()? {
+        signature_key.touch_policy(format!("{}", uif.touch_policy()));
+        signature_key.touch_features(format!("{}", uif.features()));
+    }
+    if let Some(ks) = ki.as_ref().map(|ki| ki.sig_status()) {
+        signature_key.status(format!("{}", ks));
+    }
+
+    if pws.pw1_cds_valid_once() {
+        signature_key.pin_valid_once();
+    }
+
+    if command.pkm {
+        if let Ok(pkm) = open.public_key(KeyType::Signing) {
+            signature_key.public_key_material(pkm.to_string());
+        }
+    }
+
+    output.signature_key(signature_key);
+
+    let sst = open.security_support_template()?;
+    output.signature_count(sst.signature_count());
+
+    let mut decryption_key = output::KeySlotInfo::default();
+    if let Some(fp) = fps.decryption() {
+        decryption_key.fingerprint(fp.to_spaced_hex());
+    }
+    decryption_key.algorithm(format!(
+        "{}",
+        open.algorithm_attributes(KeyType::Decryption)?
+    ));
+    if let Some(kgt) = kgt.decryption() {
+        decryption_key.created(format!("{}", kgt.to_datetime()));
+    }
+    if let Some(uif) = open.uif_decryption()? {
+        decryption_key.touch_policy(format!("{}", uif.touch_policy()));
+        decryption_key.touch_features(format!("{}", uif.features()));
+    }
+    if let Some(ks) = ki.as_ref().map(|ki| ki.dec_status()) {
+        decryption_key.status(format!("{}", ks));
+    }
+    if command.pkm {
+        if let Ok(pkm) = open.public_key(KeyType::Decryption) {
+            decryption_key.public_key_material(pkm.to_string());
+        }
+    }
+    output.decryption_key(decryption_key);
+
+    let mut authentication_key = output::KeySlotInfo::default();
+    if let Some(fp) = fps.authentication() {
+        authentication_key.fingerprint(fp.to_spaced_hex());
+    }
+    authentication_key.algorithm(format!(
+        "{}",
+        open.algorithm_attributes(KeyType::Authentication)?
+    ));
+    if let Some(kgt) = kgt.authentication() {
+        authentication_key.created(format!("{}", kgt.to_datetime()));
+    }
+    if let Some(uif) = open.uif_authentication()? {
+        authentication_key.touch_policy(format!("{}", uif.touch_policy()));
+        authentication_key.touch_features(format!("{}", uif.features()));
+    }
+    if let Some(ks) = ki.as_ref().map(|ki| ki.aut_status()) {
+        authentication_key.status(format!("{}", ks));
+    }
+    if command.pkm {
+        if let Ok(pkm) = open.public_key(KeyType::Authentication) {
+            authentication_key.public_key_material(pkm.to_string());
+        }
+    }
+    output.authentication_key(authentication_key);
+
+    // technical details about the card's state
+
+    output.user_pin_remaining_attempts(pws.err_count_pw1());
+    output.admin_pin_remaining_attempts(pws.err_count_pw3());
+    output.reset_code_remaining_attempts(pws.err_count_rc());
+
+    // FIXME: Handle attestation key information as a separate
+    // KeySlotInfo! Attestation touch information should go into its
+    // own `Option<KeySlotInfo>`, and (if any information about the
+    // attestation key exists at all, which is not the case for most
+    // cards) it should be printed as a fourth KeySlot block.
+    if let Some(uif) = open.uif_attestation()? {
+        output.card_touch_policy(uif.touch_policy().to_string());
+        output.card_touch_features(uif.features().to_string());
+    }
+
+    if let Some(ki) = ki {
+        let num = ki.num_additional();
+        for i in 0..num {
+            output.key_status(ki.additional_ref(i), ki.additional_status(i).to_string());
+        }
+    }
+
+    if let Ok(fps) = open.ca_fingerprints() {
+        for fp in fps.iter().flatten() {
+            output.ca_fingerprint(fp.to_string());
+        }
+    }
+
+    // FIXME: print "Login Data"
+
+    println!("{}", output.print(format, output_version)?);
+
+    Ok(())
+}

tools/src/bin/opgpcard/main.rs

@@ -28,6 +28,7 @@ use crate::util::{load_pin, print_gnuk_note};
 use std::io::Write;
 
 mod cli;
+mod commands;
 mod output;
 mod util;
 mod versioned_output;
@@ -50,12 +51,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         cli::Command::List {} => {
             list_cards(cli.output_format, cli.output_version)?;
         }
-        cli::Command::Status {
+        cli::Command::Status(cmd) => {
-            ident,
+            commands::status::print_status(cli.output_format, cli.output_version, cmd)?;
-            verbose,
-            pkm,
-        } => {
-            print_status(cli.output_format, cli.output_version, ident, verbose, pkm)?;
         }
         cli::Command::Info { ident } => {
             print_info(cli.output_format, cli.output_version, ident)?;
@@ -610,187 +607,6 @@ fn pick_card_for_reading(ident: Option<String>) -> Result<Box<dyn CardBackend +
     }
 }
 
-fn print_status(
-    format: OutputFormat,
-    output_version: OutputVersion,
-    ident: Option<String>,
-    verbose: bool,
-    pkm: bool,
-) -> Result<()> {
-    let mut output = output::Status::default();
-    output.verbose(verbose);
-
-    let backend = pick_card_for_reading(ident)?;
-    let mut card = Card::new(backend);
-    let mut open = card.transaction()?;
-
-    output.ident(open.application_identifier()?.ident());
-
-    let ai = open.application_identifier()?;
-    let version = ai.version().to_be_bytes();
-    output.card_version(format!("{}.{}", version[0], version[1]));
-
-    // card / cardholder metadata
-    let crd = open.cardholder_related_data()?;
-
-    if let Some(name) = crd.name() {
-        // FIXME: decoding as utf8 is wrong (the spec defines this field as latin1 encoded)
-        let name = String::from_utf8_lossy(name).to_string();
-
-        // // This field is silly, maybe ignore it?!
-        // if let Some(sex) = crd.sex() {
-        //     if sex == Sex::Male {
-        //         print!("Mr. ");
-        //     } else if sex == Sex::Female {
-        //         print!("Mrs. ");
-        //     }
-        // }
-
-        // re-format name ("last<<first")
-        let name: Vec<_> = name.split("<<").collect();
-        let name = name.iter().cloned().rev().collect::<Vec<_>>().join(" ");
-
-        output.card_holder(name);
-    }
-
-    let url = open.url()?;
-    if !url.is_empty() {
-        output.url(url);
-    }
-
-    if let Some(lang) = crd.lang() {
-        for lang in lang {
-            output.language_preference(format!("{}", lang));
-        }
-    }
-
-    // key information (imported vs. generated on card)
-    let ki = open.key_information().ok().flatten();
-
-    let pws = open.pw_status_bytes()?;
-
-    // information about subkeys
-
-    let fps = open.fingerprints()?;
-    let kgt = open.key_generation_times()?;
-
-    let mut signature_key = output::KeySlotInfo::default();
-    if let Some(fp) = fps.signature() {
-        signature_key.fingerprint(fp.to_spaced_hex());
-    }
-    signature_key.algorithm(format!("{}", open.algorithm_attributes(KeyType::Signing)?));
-    if let Some(kgt) = kgt.signature() {
-        signature_key.created(format!("{}", kgt.to_datetime()));
-    }
-    if let Some(uif) = open.uif_signing()? {
-        signature_key.touch_policy(format!("{}", uif.touch_policy()));
-        signature_key.touch_features(format!("{}", uif.features()));
-    }
-    if let Some(ks) = ki.as_ref().map(|ki| ki.sig_status()) {
-        signature_key.status(format!("{}", ks));
-    }
-
-    if pws.pw1_cds_valid_once() {
-        signature_key.pin_valid_once();
-    }
-
-    if pkm {
-        if let Ok(pkm) = open.public_key(KeyType::Signing) {
-            signature_key.public_key_material(pkm.to_string());
-        }
-    }
-
-    output.signature_key(signature_key);
-
-    let sst = open.security_support_template()?;
-    output.signature_count(sst.signature_count());
-
-    let mut decryption_key = output::KeySlotInfo::default();
-    if let Some(fp) = fps.decryption() {
-        decryption_key.fingerprint(fp.to_spaced_hex());
-    }
-    decryption_key.algorithm(format!(
-        "{}",
-        open.algorithm_attributes(KeyType::Decryption)?
-    ));
-    if let Some(kgt) = kgt.decryption() {
-        decryption_key.created(format!("{}", kgt.to_datetime()));
-    }
-    if let Some(uif) = open.uif_decryption()? {
-        decryption_key.touch_policy(format!("{}", uif.touch_policy()));
-        decryption_key.touch_features(format!("{}", uif.features()));
-    }
-    if let Some(ks) = ki.as_ref().map(|ki| ki.dec_status()) {
-        decryption_key.status(format!("{}", ks));
-    }
-    if pkm {
-        if let Ok(pkm) = open.public_key(KeyType::Decryption) {
-            decryption_key.public_key_material(pkm.to_string());
-        }
-    }
-    output.decryption_key(decryption_key);
-
-    let mut authentication_key = output::KeySlotInfo::default();
-    if let Some(fp) = fps.authentication() {
-        authentication_key.fingerprint(fp.to_spaced_hex());
-    }
-    authentication_key.algorithm(format!(
-        "{}",
-        open.algorithm_attributes(KeyType::Authentication)?
-    ));
-    if let Some(kgt) = kgt.authentication() {
-        authentication_key.created(format!("{}", kgt.to_datetime()));
-    }
-    if let Some(uif) = open.uif_authentication()? {
-        authentication_key.touch_policy(format!("{}", uif.touch_policy()));
-        authentication_key.touch_features(format!("{}", uif.features()));
-    }
-    if let Some(ks) = ki.as_ref().map(|ki| ki.aut_status()) {
-        authentication_key.status(format!("{}", ks));
-    }
-    if pkm {
-        if let Ok(pkm) = open.public_key(KeyType::Authentication) {
-            authentication_key.public_key_material(pkm.to_string());
-        }
-    }
-    output.authentication_key(authentication_key);
-
-    // technical details about the card's state
-
-    output.user_pin_remaining_attempts(pws.err_count_pw1());
-    output.admin_pin_remaining_attempts(pws.err_count_pw3());
-    output.reset_code_remaining_attempts(pws.err_count_rc());
-
-    // FIXME: Handle attestation key information as a separate
-    // KeySlotInfo! Attestation touch information should go into its
-    // own `Option<KeySlotInfo>`, and (if any information about the
-    // attestation key exists at all, which is not the case for most
-    // cards) it should be printed as a fourth KeySlot block.
-    if let Some(uif) = open.uif_attestation()? {
-        output.card_touch_policy(uif.touch_policy().to_string());
-        output.card_touch_features(uif.features().to_string());
-    }
-
-    if let Some(ki) = ki {
-        let num = ki.num_additional();
-        for i in 0..num {
-            output.key_status(ki.additional_ref(i), ki.additional_status(i).to_string());
-        }
-    }
-
-    if let Ok(fps) = open.ca_fingerprints() {
-        for fp in fps.iter().flatten() {
-            output.ca_fingerprint(fp.to_string());
-        }
-    }
-
-    // FIXME: print "Login Data"
-
-    println!("{}", output.print(format, output_version)?);
-
-    Ok(())
-}
-
 /// print metadata information about a card
 fn print_info(
     format: OutputFormat,