From 53a2893ee725e4ad678b2060fd71729ff55e6cee Mon Sep 17 00:00:00 2001
From: Robin Krahl <robin.krahl@ireas.org>
Date: Sun, 6 Jan 2019 00:10:44 +0100
Subject: Add the --format option to otp set to select the secret format

This patch introduces the -f/--format options for the otp set
subcommand to specify the format of the OTP secret.  Previously, the
default format was hexadecimal and ASCII format could be selected using
the --ascii option.  The new --format option takes the argument hex or
ascii, defaulting to hex, and replaces the --ascii option.

This patch does not remove the --ascii option but marks it as
deprecated.  It may not be set together with --format, and a warning is
printed if it is set.  It should be deleted with the next minor release.

This patch prepares the addition of a new format, base32.
---
 nitrocli/src/args.rs | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 51 insertions(+), 2 deletions(-)

(limited to 'nitrocli/src/args.rs')

diff --git a/nitrocli/src/args.rs b/nitrocli/src/args.rs
index ad296c2..b109944 100644
--- a/nitrocli/src/args.rs
+++ b/nitrocli/src/args.rs
@@ -324,6 +324,37 @@ impl From<OtpMode> for nitrokey::OtpMode {
   }
 }
 
+#[derive(Clone, Copy, Debug, PartialEq)]
+pub enum OtpSecretFormat {
+  Ascii,
+  Hex,
+}
+
+impl fmt::Display for OtpSecretFormat {
+  fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+    write!(
+      f,
+      "{}",
+      match *self {
+        OtpSecretFormat::Ascii => "ascii",
+        OtpSecretFormat::Hex => "hex",
+      }
+    )
+  }
+}
+
+impl str::FromStr for OtpSecretFormat {
+  type Err = ();
+
+  fn from_str(s: &str) -> result::Result<Self, Self::Err> {
+    match s {
+      "ascii" => Ok(OtpSecretFormat::Ascii),
+      "hex" => Ok(OtpSecretFormat::Hex),
+      _ => Err(()),
+    }
+  }
+}
+
 #[derive(Debug)]
 enum PinCommand {
   Clear,
@@ -700,6 +731,7 @@ pub fn otp_set(ctx: &ExecCtx, args: Vec<String>) -> Result<()> {
   let mut counter: u64 = 0;
   let mut time_window: u16 = 30;
   let mut ascii = false;
+  let mut secret_format: Option<OtpSecretFormat> = None;
   let mut parser = argparse::ArgumentParser::new();
   parser.set_description("Configures a one-time password slot");
   let _ =
@@ -740,11 +772,28 @@ pub fn otp_set(ctx: &ExecCtx, args: Vec<String>) -> Result<()> {
   let _ = parser.refer(&mut ascii).add_option(
     &["--ascii"],
     argparse::StoreTrue,
-    "Interpret the given secret as an ASCII string of the secret",
+    "Interpret the given secret as an ASCII string of the secret (deprecated, use --format instead)"
+  );
+  let _ = parser.refer(&mut secret_format).add_option(
+    &["-f", "--format"],
+    argparse::StoreOption,
+    "The format of the secret (ascii|hex)",
   );
   parse(&parser, args)?;
   drop(parser);
 
+  if ascii {
+    if secret_format.is_some() {
+      return Err(Error::Error(
+        "The --format and the --ascii option cannot be used at the same time".to_string(),
+      ));
+    }
+
+    println!("Warning: The --ascii option is deprecated. Please use --format ascii instead.");
+    secret_format = Some(OtpSecretFormat::Ascii);
+  }
+  let secret_format = secret_format.unwrap_or(OtpSecretFormat::Hex);
+
   let data = nitrokey::OtpSlotData {
     number: slot,
     name,
@@ -753,7 +802,7 @@ pub fn otp_set(ctx: &ExecCtx, args: Vec<String>) -> Result<()> {
     use_enter: false,
     token_id: None,
   };
-  commands::otp_set(ctx, data, algorithm, counter, time_window, ascii)
+  commands::otp_set(ctx, data, algorithm, counter, time_window, secret_format)
 }
 
 /// Clear an OTP slot.
-- 
cgit v1.2.1