Move common CLI helpers into the library behind a feature flag

Cargo.toml

@@ -55,5 +55,6 @@ man = "0.3"
 
 [features]
 default = ["cli", "mount"]
-cli = ["chrono", "console", "dialoguer", "dirs", "gumdrop", "minreq"]
-mount = ["dialoguer", "dirs", "env_logger", "fuse_mt", "gumdrop", "libc", "log", "time", "zip"]
+cli-common = ["dialoguer", "dirs", "gumdrop"]
+cli = ["cli-common", "chrono", "console", "minreq"]
+mount = ["cli-common", "env_logger", "fuse_mt", "libc", "log", "time", "zip"]

src/bin/rage-mount/main.rs

@@ -1,75 +1,10 @@
-use dialoguer::PasswordInput;
+use age::cli_common::{read_keys, read_passphrase};
 use gumdrop::Options;
 use log::{error, info};
 use std::ffi::OsStr;
-use std::fs::File;
-use std::io::{self, BufReader};
-use std::path::PathBuf;
 
 mod zip;
 
-/// Returns the age config directory.ALIAS_PREFIX
-///
-/// Replicates the behaviour of [os.UserConfigDir] from Golang, which the
-/// reference implementation uses. See [this issue] for more details.
-///
-/// [os.UserConfigDir]: https://golang.org/pkg/os/#UserConfigDir
-/// [this issue]: https://github.com/FiloSottile/age/issues/15
-fn get_config_dir() -> Option<PathBuf> {
-    #[cfg(target_os = "macos")]
-    {
-        dirs::data_dir()
-    }
-
-    #[cfg(not(target_os = "macos"))]
-    {
-        dirs::config_dir()
-    }
-}
-
-/// Reads keys from the provided files if given, or the default system locations
-/// if no files are given.
-fn read_keys(filenames: Vec<String>) -> io::Result<Vec<age::SecretKey>> {
-    let mut keys = vec![];
-
-    if filenames.is_empty() {
-        let default_filename = get_config_dir()
-            .map(|mut path| {
-                path.push("age/keys.txt");
-                path
-            })
-            .expect("an OS for which we know the default config directory");
-        let f = File::open(&default_filename).map_err(|e| match e.kind() {
-            io::ErrorKind::NotFound => io::Error::new(
-                io::ErrorKind::NotFound,
-                format!(
-                    "no keys specified as arguments, and default file {} does not exist",
-                    default_filename.to_str().unwrap()
-                ),
-            ),
-            _ => e,
-        })?;
-        let buf = BufReader::new(f);
-        keys.extend(age::SecretKey::from_data(buf)?);
-    } else {
-        for filename in filenames {
-            let buf = BufReader::new(File::open(filename)?);
-            keys.extend(age::SecretKey::from_data(buf)?);
-        }
-    }
-
-    Ok(keys)
-}
-
-fn read_passphrase(confirm: bool) -> io::Result<String> {
-    let mut input = PasswordInput::new();
-    input.with_prompt("Type passphrase");
-    if confirm {
-        input.with_confirmation("Confirm passphrase", "Passphrases mismatching");
-    }
-    input.interact()
-}
-
 #[derive(Debug, Options)]
 struct AgeMountOptions {
     #[options(free, help = "The encrypted ZIP file to mount")]

src/bin/rage/main.rs

@@ -1,34 +1,14 @@
-use dialoguer::PasswordInput;
+use age::cli_common::{get_config_dir, read_keys, read_passphrase};
 use gumdrop::Options;
 use std::collections::HashMap;
 use std::fs::{read_to_string, File};
 use std::io::{self, BufRead, BufReader, Write};
-use std::path::PathBuf;
 
 mod file_io;
 
 const ALIAS_PREFIX: &str = "alias:";
 const GITHUB_PREFIX: &str = "github:";
 
-/// Returns the age config directory.ALIAS_PREFIX
-///
-/// Replicates the behaviour of [os.UserConfigDir] from Golang, which the
-/// reference implementation uses. See [this issue] for more details.
-///
-/// [os.UserConfigDir]: https://golang.org/pkg/os/#UserConfigDir
-/// [this issue]: https://github.com/FiloSottile/age/issues/15
-fn get_config_dir() -> Option<PathBuf> {
-    #[cfg(target_os = "macos")]
-    {
-        dirs::data_dir()
-    }
-
-    #[cfg(not(target_os = "macos"))]
-    {
-        dirs::config_dir()
-    }
-}
-
 /// Load map of aliases from the given file, or the default system location
 /// otherwise.
 ///
@@ -169,49 +149,6 @@ fn read_recipients(
     Ok(recipients)
 }
 
-/// Reads keys from the provided files if given, or the default system locations
-/// if no files are given.
-fn read_keys(filenames: Vec<String>) -> io::Result<Vec<age::SecretKey>> {
-    let mut keys = vec![];
-
-    if filenames.is_empty() {
-        let default_filename = get_config_dir()
-            .map(|mut path| {
-                path.push("age/keys.txt");
-                path
-            })
-            .expect("an OS for which we know the default config directory");
-        let f = File::open(&default_filename).map_err(|e| match e.kind() {
-            io::ErrorKind::NotFound => io::Error::new(
-                io::ErrorKind::NotFound,
-                format!(
-                    "no keys specified as arguments, and default file {} does not exist",
-                    default_filename.to_str().unwrap()
-                ),
-            ),
-            _ => e,
-        })?;
-        let buf = BufReader::new(f);
-        keys.extend(age::SecretKey::from_data(buf)?);
-    } else {
-        for filename in filenames {
-            let buf = BufReader::new(File::open(filename)?);
-            keys.extend(age::SecretKey::from_data(buf)?);
-        }
-    }
-
-    Ok(keys)
-}
-
-fn read_passphrase(confirm: bool) -> io::Result<String> {
-    let mut input = PasswordInput::new();
-    input.with_prompt("Type passphrase");
-    if confirm {
-        input.with_confirmation("Confirm passphrase", "Passphrases mismatching");
-    }
-    input.interact()
-}
-
 fn generate_new_key() {
     let sk = age::SecretKey::generate();
 

src/cli_common.rs

@@ -0,0 +1,71 @@
+//! Common helpers for CLI binaries.
+
+use dialoguer::PasswordInput;
+use std::fs::File;
+use std::io::{self, BufReader};
+use std::path::PathBuf;
+
+use crate::keys::SecretKey;
+
+/// Returns the age config directory.ALIAS_PREFIX
+///
+/// Replicates the behaviour of [os.UserConfigDir] from Golang, which the
+/// reference implementation uses. See [this issue] for more details.
+///
+/// [os.UserConfigDir]: https://golang.org/pkg/os/#UserConfigDir
+/// [this issue]: https://github.com/FiloSottile/age/issues/15
+pub fn get_config_dir() -> Option<PathBuf> {
+    #[cfg(target_os = "macos")]
+    {
+        dirs::data_dir()
+    }
+
+    #[cfg(not(target_os = "macos"))]
+    {
+        dirs::config_dir()
+    }
+}
+
+/// Reads keys from the provided files if given, or the default system locations
+/// if no files are given.
+pub fn read_keys(filenames: Vec<String>) -> io::Result<Vec<SecretKey>> {
+    let mut keys = vec![];
+
+    if filenames.is_empty() {
+        let default_filename = get_config_dir()
+            .map(|mut path| {
+                path.push("age/keys.txt");
+                path
+            })
+            .expect("an OS for which we know the default config directory");
+        let f = File::open(&default_filename).map_err(|e| match e.kind() {
+            io::ErrorKind::NotFound => io::Error::new(
+                io::ErrorKind::NotFound,
+                format!(
+                    "no keys specified as arguments, and default file {} does not exist",
+                    default_filename.to_str().unwrap()
+                ),
+            ),
+            _ => e,
+        })?;
+        let buf = BufReader::new(f);
+        keys.extend(SecretKey::from_data(buf)?);
+    } else {
+        for filename in filenames {
+            let buf = BufReader::new(File::open(filename)?);
+            keys.extend(SecretKey::from_data(buf)?);
+        }
+    }
+
+    Ok(keys)
+}
+
+/// Reads a passphrase from stdin.
+pub fn read_passphrase(confirm: bool) -> io::Result<String> {
+    let mut input = PasswordInput::new();
+    input.with_prompt("Type passphrase");
+    if confirm {
+        input.with_confirmation("Confirm passphrase", "Passphrases mismatching");
+    }
+    input.interact()
+}

src/lib.rs

@@ -73,3 +73,6 @@ mod util;
 pub use keys::{RecipientKey, SecretKey};
 pub use primitives::stream::StreamReader;
 pub use protocol::{Decryptor, Encryptor};
+
+#[cfg(feature = "cli-common")]
+pub mod cli_common;