Ready the next release.

brotskydotcom · brotskydotcom · commit 0fff59b11cd9 · 2024-09-18T15:47:05.000-07:00
CLI: Better help and output wording.

Changelog update.

Bump version to 3.3.0.

Tweak typos and clarity of docs.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,25 @@
+## Version 3.3.0
+- Add support for credential-store attributes other than those used by this crate.  This allows the creation of credentials that are more compatible with 3rd-party clients, such as the OS-provided GUIs over credentials.
+- Make the textual descriptions of entries consistently follow the form `user@service` (or  `user@service:target` if a target was specified).
+
+## Version 3.2.1
+- Re-enable access to v1 credentials. The fixes of version 3.2 meant that legacy credentials with no target attribute couldn't be accessed.
+
+## Version 3.2.0
+- Improve secret-service handling of targets, so that searches on locked items distinguish items with different targets properly.
+
+## Version 3.1.0
+- enhance the CLI to allow empty user names and better info about `Ambiguous` credentials.
+
+## Version 3.0.5
+- updated docs and clean up dead code. No code changes.
+
+## Version 3.0.4
+- expose a cross-platform module alias via the `default` module.
+
+## Version 3.0.3
+- fix feature `linux-native`, which was causing compile errors.
+
 ## Version 3.0.2
 - add missing implementations for iOS `set_secret` and `get_secret`
 
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,7 +6,7 @@ keywords = ["password", "credential", "keychain", "keyring", "cross-platform"]
 license = "MIT OR Apache-2.0"
 name = "keyring"
 repository = "https://github.com/hwchen/keyring-rs.git"
-version = "3.2.1"
+version = "3.3.0"
 rust-version = "1.75"
 edition = "2021"
 exclude = [".github/"]
@@ -64,6 +64,7 @@ path = "examples/cli.rs"
 base64 = "0.22"
 clap = { version = "4", features = ["derive", "wrap_help"] }
 rpassword = "7"
+rprompt = "2"
 rand = "0.8"
 doc-comment = "0.3"
 whoami = "1"
diff --git a/build-xplat-docs.sh b/build-xplat-docs.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-cargo doc --no-deps --target aarch64-unknown-linux-musl $OPEN_DOCS
-cargo doc --no-deps --target aarch64-pc-windows-msvc $OPEN_DOCS
-cargo doc --no-deps --target aarch64-apple-darwin $OPEN_DOCS
-cargo doc --no-deps --target aarch64-apple-ios $OPEN_DOCS
+cargo doc --no-deps --features=linux-native --target aarch64-unknown-linux-musl $OPEN_DOCS
+cargo doc --no-deps --features=windows-native --target aarch64-pc-windows-msvc $OPEN_DOCS
+cargo doc --no-deps --features=apple-native --target aarch64-apple-darwin $OPEN_DOCS
+cargo doc --no-deps --features=apple-native --target aarch64-apple-ios $OPEN_DOCS
diff --git a/examples/cli.rs b/examples/cli.rs
@@ -107,7 +107,8 @@ pub enum Command {
 
         #[clap(value_parser)]
         /// The input to parse. If not specified, it will be
-        /// read interactively (without echo) from the terminal.
+        /// read interactively from the terminal. Password/secret
+        /// input will not be echoed.
         input: Option<String>,
     },
     /// Retrieve the (string) password from the secure store
@@ -123,18 +124,20 @@ pub enum Command {
 }
 
 #[derive(Debug, Args)]
-#[group(multiple = false)]
+#[group(multiple = false, required = true)]
 pub struct What {
-    #[clap(short, long, action)]
-    // The input is a password.
+    #[clap(short, long, action, help = "The input is a password")]
     password: bool,
 
-    #[clap(short, long, action)]
-    // The input is a base64-encoded secret.
+    #[clap(short, long, action, help = "The input is a base64-encoded secret")]
     secret: bool,
 
-    #[clap(short, long, action)]
-    // The input is comma-separated, key=val attribute pairs.
+    #[clap(
+        short,
+        long,
+        action,
+        help = "The input is comma-separated, key=val attribute pairs"
+    )]
     attributes: bool,
 }
 
@@ -148,7 +151,7 @@ enum Value {
 impl Cli {
     fn description(&self) -> String {
         if let Some(target) = &self.target {
-            format!("[{target}]{}@{}", &self.user, &self.service)
+            format!("{}@{}:{target}", &self.user, &self.service)
         } else {
             format!("{}@{}", &self.user, &self.service)
         }
@@ -209,7 +212,7 @@ impl Cli {
                     eprintln!("Set password for '{description}' to '{password}'");
                 }
                 Value::Attributes(attributes) => {
-                    eprintln!("Set attributes for '{description}' to:");
+                    eprintln!("The following attributes for '{description}' were sent for update:");
                     eprint_attributes(attributes);
                 }
                 _ => panic!("Can't set without a value"),
@@ -248,7 +251,7 @@ impl Cli {
 
     fn get_password_and_attributes(&self) -> Value {
         if let Command::Set { what, input } = &self.command {
-            if what.password || (!what.secret && !what.attributes) {
+            if what.password {
                 Value::Password(read_password(input))
             } else if what.secret {
                 Value::Secret(decode_secret(input))
@@ -313,7 +316,7 @@ fn parse_attributes(input: &Option<String>) -> HashMap<String, String> {
     let input = if let Some(input) = input {
         input.clone()
     } else {
-        rpassword::prompt_password("Attributes: ").unwrap_or_else(|_| String::new())
+        rprompt::prompt_reply("Attributes: ").unwrap_or_else(|_| String::new())
     };
     if input.is_empty() {
         eprintln!("You must specify at least one key=value attribute pair to set")
diff --git a/src/keyutils.rs b/src/keyutils.rs
@@ -12,7 +12,8 @@ an explicit `target`, that value is used as the keyutils description.  Otherwise
 `keyring-rs:user@service` is used (where user and service come from the entry creation call).
 
 There is no notion of attribute other than the description supported by keyutils,
-so the [get_attributes](Entry::get_attributes) and [update_attributes](Entry::update_attributes)
+so the [get_attributes](crate::Entry::get_attributes)
+and [update_attributes](crate::Entry::update_attributes)
 calls are both no-ops for this credential store.
 
 # Persistence
diff --git a/src/lib.rs b/src/lib.rs
@@ -148,8 +148,8 @@ then retrieving that as a password will return a
 [BadEncoding](Error::BadEncoding) error.
 The returned error will have the raw bytes attached,
 so you can access them, but you can also just fetch
-them directly using [get_secret](Entry::get_password) rather than
-[get_password](Entry::get_secret).
+them directly using [get_secret](Entry::get_secret) rather than
+[get_password](Entry::get_password).
 
 While this crate's code is thread-safe, the underlying credential
 stores may not handle access from different threads reliably.
diff --git a/src/secret_service.rs b/src/secret_service.rs
@@ -13,7 +13,7 @@ In addition, when creating a new credential, this implementation assigns
 two additional attributes:
 
 - `application` (set to `rust-keyring-client`)
-- `label` (set to a string with the user, service, and keyring version at time of creation)
+- `label` (set to a string with the user, service, target, and keyring version at time of creation)
 
 Client code is allowed to retrieve and to set all attributes _except_ the
 three that are controlled by this implementation. (N.B. The `label` string
diff --git a/src/windows.rs b/src/windows.rs
@@ -21,9 +21,10 @@ So if you have a custom algorithm you want to use for computing the Windows targ
 you can specify the target name directly.  (You still need to provide a service and username,
 because they are used in the credential's metadata.)
 
-The [get_attributes](Entry::get_attributes)
+The [get_attributes](crate::Entry::get_attributes)
 call will return the values in the `username`, `comment`, and `target_alias` fields
-(using those strings as the attribute names), and the [update_attributes](Entry::update_attributes)
+(using those strings as the attribute names),
+and the [update_attributes](crate::Entry::update_attributes)
 call allows setting those fields.
 
 ## Caveat
