From 994e10c2d7ea46ee745ed428e739e83c44a0a7c5 Mon Sep 17 00:00:00 2001
From: Heiko Schaefer <heiko@schaefer.name>
Date: Fri, 12 Nov 2021 19:02:35 +0100
Subject: [PATCH] Minor restructuring, add some comments.

---
 scdc/src/lib.rs | 72 ++++++++++++++++++++++++++-----------------------
 1 file changed, 38 insertions(+), 34 deletions(-)

diff --git a/scdc/src/lib.rs b/scdc/src/lib.rs
index 8da52f0..cc516ee 100644
--- a/scdc/src/lib.rs
+++ b/scdc/src/lib.rs
@@ -55,6 +55,40 @@ pub struct ScdClient {
 }
 
 impl ScdClient {
+    /// Open a CardApp that uses an scdaemon instance as its backend.
+    ///
+    /// If multiple cards are available, scdaemon implicitly selects one.
+    /// (NOTE: implicitly picking some card seems like a bad idea. You might
+    /// want to avoid using this fn.)
+    pub fn open_yolo(agent: Option<Agent>) -> Result<CardApp, Error> {
+        let card = ScdClient::new(agent, true)?;
+
+        Ok(CardApp::initialize(Box::new(card))?)
+    }
+
+    /// Open a CardApp that uses an scdaemon instance as its backend.
+    /// The specific card with AID `serial` is requested from scdaemon.
+    pub fn open_by_serial(
+        agent: Option<Agent>,
+        serial: &str,
+    ) -> Result<CardApp, Error> {
+        let mut card = ScdClient::new(agent, true)?;
+        card.select_card(serial)?;
+
+        Ok(CardApp::initialize(Box::new(card))?)
+    }
+
+    /// Helper fn that shuts down scdaemon via GnuPG Agent.
+    /// This may be useful to obtain access to a Smard card via PCSC.
+    pub fn shutdown_scd(agent: Option<Agent>) -> Result<()> {
+        let mut scdc = Self::new(agent, false)?;
+
+        scdc.send("SCD RESTART")?;
+        scdc.send("SCD BYE")?;
+
+        Ok(())
+    }
+
     /// Initialize an ScdClient object that is connected to an scdaemon
     /// instance via a GnuPG `agent` instance.
     ///
@@ -75,15 +109,15 @@ impl ScdClient {
         };
 
         if init {
-            // call "SCD SERIALNO", which causes scdaemon to be started by gpg
-            // agent (if it's not running yet)
-            scdc.init()?;
+            scdc.serialno()?;
         }
 
         Ok(scdc)
     }
 
-    fn init(&mut self) -> Result<()> {
+    /// Call "SCD SERIALNO", which causes scdaemon to be started by gpg
+    /// agent (if it's not running yet).
+    fn serialno(&mut self) -> Result<()> {
         let mut rt = RT.lock().unwrap();
 
         let send = "SCD SERIALNO";
@@ -105,27 +139,6 @@ impl ScdClient {
         Err(anyhow!("SCDC init() failed"))
     }
 
-    /// Create a CardClientBox object that uses an scdaemon instance as its
-    /// backend. If multiple cards are available, scdaemon implicitly
-    /// selects one.
-    pub fn open(agent: Option<Agent>) -> Result<CardApp, Error> {
-        let card = ScdClient::new(agent, true)?;
-
-        Ok(CardApp::initialize(Box::new(card))?)
-    }
-
-    /// Create a CardClientBox object that uses an scdaemon instance as its
-    /// backend. Requests the specific card `serial`.
-    pub fn open_by_serial(
-        agent: Option<Agent>,
-        serial: &str,
-    ) -> Result<CardApp, Error> {
-        let mut card = ScdClient::new(agent, true)?;
-        card.select_card(serial)?;
-
-        Ok(CardApp::initialize(Box::new(card))?)
-    }
-
     /// Ask scdameon to switch to using a specific OpenPGP card, based on
     /// its `serial`.
     fn select_card(&mut self, serial: &str) -> Result<()> {
@@ -178,15 +191,6 @@ impl ScdClient {
 
         Err(anyhow!("Error sending command {}", cmd))
     }
-
-    pub fn shutdown_scd(agent: Option<Agent>) -> Result<()> {
-        let mut scdc = Self::new(agent, false)?;
-
-        scdc.send("SCD RESTART")?;
-        scdc.send("SCD BYE")?;
-
-        Ok(())
-    }
 }
 
 impl CardClient for ScdClient {