feat(clipboard-manager): add support for writing secrets

examples/api/src-tauri/capabilities/desktop.json

@@ -11,6 +11,7 @@
     "global-shortcut:allow-register",
     "global-shortcut:allow-unregister-all",
     { "identifier": "fs:allow-watch", "allow": ["*", "**/*"] },
-    "fs:allow-unwatch"
+    "fs:allow-unwatch",
+    "clipboard-manager:allow-write-secret"
   ]
 }

examples/api/src/views/Clipboard.svelte

@@ -36,6 +36,13 @@
     }
   }
 
+  function writeSecret() {
+    clipboard.writeSecret(text).then(() => {
+      onMessage("Wrote secret to the clipboard")
+    })
+    .catch(onMessage)
+  }
+
   async function read() {
     try {
       const image = await clipboard.readImage()
@@ -64,6 +71,7 @@
     bind:value={text}
   />
   <button class="btn" type="button" on:click={writeText}>Write</button>
+  <button class="btn" type="button" on:click={writeSecret}>Write Secret</button>
   <button class="btn" type="button" on:click={writeImage}>Pick Image</button>
   <button class="btn" type="button" on:click={read}>Read</button>
 </div>

plugins/clipboard-manager/build.rs

@@ -9,6 +9,7 @@ const COMMANDS: &[&str] = &[
     "read_image",
     "write_html",
     "clear",
+    "write_secret",
 ];
 
 fn main() {

plugins/clipboard-manager/guest-js/index.ts

@@ -148,4 +148,22 @@ async function clear(): Promise<void> {
   await invoke('plugin:clipboard-manager|clear')
 }
 
-export { writeText, readText, writeHtml, clear, readImage, writeImage }
+/**
+ * Writes text to clipboard and sets hints for clipboard managers to exclude it
+ * from history
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ */
+async function writeSecret(text: string): Promise<void> {
+  await invoke('plugin:clipboard-manager|write_secret', { text })
+}
+
+export {
+  writeText,
+  readText,
+  writeHtml,
+  clear,
+  readImage,
+  writeImage,
+  writeSecret
+}

plugins/clipboard-manager/permissions/autogenerated/commands/write_secret.toml

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-write-secret"
+description = "Enables the write_secret command without any pre-configured scope."
+commands.allow = ["write_secret"]
+
+[[permission]]
+identifier = "deny-write-secret"
+description = "Denies the write_secret command without any pre-configured scope."
+commands.deny = ["write_secret"]

plugins/clipboard-manager/permissions/autogenerated/reference.md

@@ -148,6 +148,32 @@ Denies the write_image command without any pre-configured scope.
 <tr>
 <td>
 
+`clipboard-manager:allow-write-secret`
+
+</td>
+<td>
+
+Enables the write_secret command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`clipboard-manager:deny-write-secret`
+
+</td>
+<td>
+
+Denies the write_secret command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
 `clipboard-manager:allow-write-text`
 
 </td>

plugins/clipboard-manager/permissions/schemas/schema.json

@@ -354,6 +354,18 @@
           "const": "deny-write-image",
           "markdownDescription": "Denies the write_image command without any pre-configured scope."
         },
+        {
+          "description": "Enables the write_secret command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-write-secret",
+          "markdownDescription": "Enables the write_secret command without any pre-configured scope."
+        },
+        {
+          "description": "Denies the write_secret command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-write-secret",
+          "markdownDescription": "Denies the write_secret command without any pre-configured scope."
+        },
         {
           "description": "Enables the write_text command without any pre-configured scope.",
           "type": "string",

plugins/clipboard-manager/src/commands.rs

@@ -78,3 +78,13 @@ pub(crate) async fn clear<R: Runtime>(
 ) -> Result<()> {
     clipboard.clear()
 }
+
+#[command]
+#[cfg(desktop)]
+pub(crate) async fn write_secret<R: Runtime>(
+    _app: AppHandle<R>,
+    clipboard: State<'_, Clipboard<R>>,
+    text: &str,
+) -> Result<()> {
+    clipboard.write_secret(text)
+}

plugins/clipboard-manager/src/desktop.rs

@@ -8,6 +8,9 @@ use tauri::{image::Image, plugin::PluginApi, AppHandle, Runtime};
 
 use std::{borrow::Cow, sync::Mutex};
 
+#[cfg(desktop)]
+use crate::secret::ExcludeSecret;
+
 pub fn init<R: Runtime, C: DeserializeOwned>(
     app: &AppHandle<R>,
     _api: PluginApi<R, C>,
@@ -120,4 +123,21 @@ impl<R: Runtime> Clipboard<R> {
             clipboard.lock().unwrap().take();
         }
     }
+
+    /// This is the same as write_text but it will set hints using [`arboard::SetExtLinux`], [`arboard::SetExtWindows`], or [`arboard::SetExtApple`] depending on the platform.
+    #[cfg(desktop)]
+    pub fn write_secret<'a, T: Into<Cow<'a, str>>>(&self, text: T) -> crate::Result<()> {
+        match &self.clipboard {
+            Ok(clipboard) => clipboard
+                .lock()
+                .unwrap()
+                .as_mut()
+                .unwrap()
+                .set()
+                .exclude_secret()
+                .text(text)
+                .map_err(Into::into),
+            Err(e) => Err(crate::Error::Clipboard(e.to_string())),
+        }
+    }
 }

plugins/clipboard-manager/src/lib.rs

@@ -22,6 +22,9 @@ mod mobile;
 mod commands;
 mod error;
 
+#[cfg(desktop)]
+mod secret;
+
 pub use error::{Error, Result};
 
 #[cfg(desktop)]
@@ -49,7 +52,9 @@ pub fn init<R: Runtime>() -> TauriPlugin<R> {
             commands::read_image,
             commands::write_image,
             commands::write_html,
-            commands::clear
+            commands::clear,
+            #[cfg(desktop)]
+            commands::write_secret,
         ])
         .setup(|app, api| {
             #[cfg(mobile)]

plugins/clipboard-manager/src/secret.rs

@@ -0,0 +1,45 @@
+#[cfg(all(
+    unix,
+    not(any(target_os = "macos", target_os = "android", target_os = "emscripten")),
+))]
+use arboard::SetExtLinux;
+
+#[cfg(windows)]
+use arboard::SetExtWindows;
+
+#[cfg(target_os = "macos")]
+use arboard::SetExtApple;
+
+/// Trait to expose exclude from history functionality from [`arboard`] crate's `SetExt*` extensions.
+/// On Linux, it calls [`arboard::SetExtLinux::exclude_from_history`]
+/// On MacOS, it calls [`arboard::SetExtApple::exclude_from_history`]
+/// On Windows, it calls [`arboard::SetExtWindows::exclude_from_history`], [`arboard::SetExtWindows::exclude_from_cloud`], and [`arboard::SetExtWindows::exclude_from_monitoring`]
+pub trait ExcludeSecret<'clipboard> {
+    fn exclude_secret(self) -> arboard::Set<'clipboard>;
+}
+
+#[cfg(all(
+    unix,
+    not(any(target_os = "macos", target_os = "android", target_os = "emscripten"))
+))]
+impl<'clipboard> ExcludeSecret<'clipboard> for arboard::Set<'clipboard> {
+    fn exclude_secret(self) -> arboard::Set<'clipboard> {
+        self.exclude_from_history()
+    }
+}
+
+#[cfg(windows)]
+impl<'clipboard> ExcludeSecret<'clipboard> for arboard::Set<'clipboard> {
+    fn exclude_secret(self) -> arboard::Set<'clipboard> {
+        self.exclude_from_history()
+            .exclude_from_cloud()
+            .exclude_from_monitoring()
+    }
+}
+
+#[cfg(target_os = "macos")]
+impl<'clipboard> ExcludeSecret<'clipboard> for arboard::Set<'clipboard> {
+    fn exclude_secret(self) -> arboard::Set<'clipboard> {
+        self.exclude_from_history()
+    }
+}