@crewhaus/tool-desktop 0.7.0 → 0.8.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+CrewHaus Factory
+Copyright 2026 Max Meier
+
+This product includes software developed by Max Meier
+(operating as StudioMax — https://studiomax.io) and contributors.
+
+The CrewHaus name and logo are trademarks of Max Meier. See
+https://github.com/crewhaus/factory/blob/main/TRADEMARK.md for the
+use-of-marks policy.

package/README.md

@@ -0,0 +1,121 @@
+# @crewhaus/tool-desktop
+
+Deterministic access to the operator's desktop: the clipboard, notifications,
+opening a document or a page, printing, the window list, whether a person is at
+the machine, and keeping it awake. Every tool fails closed on a headless host.
+
+```yaml
+tools:
+  - all-desktop
+```
+
+| Tool | What it does |
+|---|---|
+| `ClipboardRead` | Read the clipboard as text, returned verbatim |
+| `ClipboardWrite` | Put text on the clipboard |
+| `DesktopNotify` | Show a local notification |
+| `OpenExternal` | Hand a URL or a workspace file to the operating system's registered handler |
+| `PrintDocument` | Send a workspace file to a printer through CUPS (macOS, Linux) or a Windows queue |
+| `WindowList` | List the open windows |
+| `UserPresence` | Report whether a person is likely at the machine |
+| `PowerAssertion` | Hold a bounded sleep inhibitor around a long step, release it, or report on one |
+
+## What holds across all of them
+
+- **Escaping is the security boundary.** `osascript -e` compiles AppleScript
+  and a Windows toast is XML inside a PowerShell script, so text that looks
+  like a value is source code. Every script here is a frozen constant, and
+  caller values travel beside the program (argv after `--`, or an environment
+  variable), never inside it.
+- **Argv is an array.** No `sh -c`, no `cmd /c`, no interpolated command line,
+  and nothing runs `sudo`, `doas`, `runas` or `pkexec`.
+- **A headless host fails closed.** CI has no desktop, clipboard, notification
+  daemon, printer or window server. Each tool answers with a typed
+  `unavailable` naming what was missing, never a crash and never a silent
+  success.
+- **Could not determine is not no.** An empty clipboard is not an unreadable
+  one, and a presence probe that failed is not "idle".
+- **A state-changing tool says so and offers `dryRun`,** resolved through the
+  same function as the real call.
+
+## OpenExternal
+
+"Open this" and "run this" are the same gesture to a desktop, and the URL side
+is wider than the file side: the scheme table on a real machine is large and
+mostly undocumented. So the gate is an allow-list, and it is short.
+
+- **Schemes.** Only `https`, `http` and `mailto`. Everything else is refused by
+  name: `file:` would bypass this tool's path containment; `smb:` and `nfs:`
+  mount a remote share and can leak an authentication handshake to the host
+  named in the URL; `javascript:` and `data:` run or render content the model
+  wrote; the Windows `ms-*` handlers reach settings pages and the Store, and on
+  unpatched builds have been argument-injection vectors. `allowSchemes` can
+  only narrow the set, never widen it: a knob that re-enables `smb:` is the
+  hole with extra steps.
+- **What is checked is what is opened.** An http(s) URL is handed to the
+  desktop in its normalised (WHATWG) form, not as it was typed, because a gate
+  that validates one spelling and passes on another is not a gate. A URL
+  containing a backslash is refused: parsers disagree about whether it is a
+  path separator, so the host checked here would not be the host opened there.
+  Credentials before the `@` are refused: they would sit in a process listing
+  and in the transcript, and `google.com@evil.example` reads as the host it is
+  not.
+- **mailto.** Only the headers RFC 6068 calls safe. `attach=` is refused by
+  name, because a mail client that honours it reads a local file into the
+  message.
+- **Paths.** A target with no scheme is a filesystem path, resolved inside the
+  workspace root with symlinks followed, and refused if it lands outside. A
+  local file is opened by naming its path, never by building a `file://` URL,
+  so exactly one code path decides whether a path is reachable.
+- **Files the desktop would run.** An executable file is refused even inside
+  the workspace. So is a file whose type the desktop runs, installs or follows
+  without an execute bit: scripts, installers and configuration profiles
+  (`.jnlp`, `.mobileconfig`, `.msix`, `.py`), and shortcut or location files
+  that point somewhere else (`.lnk`, `.url`, `.webloc`, `.fileloc`,
+  `.library-ms`).
+- **The result says `handedOff`, not `opened`.** Every opener returns as soon
+  as the handler has been asked, and none of them reports what the handler then
+  did.
+- **Gated like a change.** What it opens acts in the operator's own desktop
+  session and outlives the call: a browser tab carries the operator's cookies,
+  an app keeps running. So the tool is destructive, every call carries a
+  justification, and it is an egress sink whose destination the model chooses:
+  content that came from a tool result is blocked from reaching it.
+
+The three openers also disagree about `--`: macOS `open` honours it, Linux
+`xdg-open` rejects any argument beginning with `-` (so flag-shaped targets are
+refused), and on Windows the target crosses in an environment variable read by
+`Start-Process -FilePath`, never the `start` builtin.
+
+## ClipboardRead
+
+The clipboard is where people keep a password, a recovery code or an API key
+for the seconds between copying and pasting it. Whatever is on it when this
+runs is returned verbatim into the model's context, from there into the
+conversation transcript, and from there into any log or trace the harness
+keeps.
+
+The tool does **not** scan for or redact secrets. A heuristic that catches some
+patterns and misses others earns trust it cannot honour, and the caller who
+relied on it pastes the one it missed into a ticket. There is no schema knob
+for it either, because offering one implies the tool could do it. Ask for the
+clipboard only when the operator has been told to copy something for you, and
+treat the result as sensitive for the rest of the run. The tool requires a
+justification on every call, and its output goes through the runtime's output
+classifier.
+
+It has four outcomes and never conflates them: `read` with the text; `empty`
+(the clipboard was reachable and holds nothing); `noTextFlavour` (it holds
+something, such as an image or a file, that has no text form); and
+`unavailable` with a reason when there was no clipboard to ask (no desktop
+session, no backend program, an unsupported platform).
+
+## Tests
+
+```
+bun test packages/tool-desktop/src
+```
+
+Every child process goes through the `_setRunner` and `_setDetacher` seams, and
+the platform, session environment, clock and filesystem are injected too, so
+the suite runs on a host with no desktop at all.

package/dist/index.d.ts

@@ -15,6 +15,19 @@ export declare const openExternal: RegisteredTool;
 export declare const printDocument: RegisteredTool;
 export declare const windowList: RegisteredTool;
 export declare const userPresence: RegisteredTool;
+/**
+ * Where the held assertion is remembered: a file only this user can write,
+ * OUTSIDE the workspace, keyed by the workspace.
+ *
+ * 0.7.0 kept it at `.crewhaus/power-assertion.json` in the workspace, where
+ * the agent the tool serves can write, and `release` SIGTERMs the pid the
+ * record names (security-10#1). The directory is `$XDG_RUNTIME_DIR/crewhaus`
+ * when the session has one (Linux: per-user, 0700, cleared at logout), else
+ * `crewhaus-<uid>` under the OS temp directory (per-user on macOS and
+ * Windows), created 0700 and refused if another user owns it. The file name
+ * carries a hash of the workspace root, so two workspaces never share one.
+ */
+export declare function powerStateFile(): string;
 export declare const powerAssertion: RegisteredTool;
 /** Everything this package registers, in one place for the catalog wiring. */
 export declare const DESKTOP_TOOLS: ReadonlyArray<RegisteredTool>;