agentscrub 1.1.0__tar.gz

agentscrub-1.1.0/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.

agentscrub-1.1.0/PKG-INFO

@@ -0,0 +1,279 @@
+Metadata-Version: 2.1
+Name: agentscrub
+Version: 1.1.0
+Summary: Scrub secrets and credentials from AI coding assistant session logs
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/ppravdin/agentscrub
+Project-URL: Repository, https://github.com/ppravdin/agentscrub
+Project-URL: Issues, https://github.com/ppravdin/agentscrub/issues
+Keywords: security,privacy,ai,claude,codex,cursor,redact,secrets
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13.0
+
+# agentscrub
+
+![agentscrub — scan code and logs, detect secrets, protect everywhere](assets/cover.png)
+
+Scrubs secrets and credentials from your AI coding assistant session logs.
+
+AI tools like Claude Code, Codex CLI, and Cursor store your entire conversation history locally — including any API keys, database passwords, JWTs, and OAuth tokens you've pasted in or that appeared in code. Supply-chain attacks on VS Code extensions or npm packages routinely scan these files. agentscrub finds and removes them.
+
+## Quick start
+
+```bash
+# Install
+pipx install agentscrub
+
+# Install the three detectors (gitleaks, TruffleHog, Titus). See "Detection tools"
+# below for macOS / Windows / arm64 builds.
+agentscrub doctor      # tells you what's missing
+
+# Read-only audit — writes nothing; produces two masked reports
+agentscrub scan
+
+# Redact in place — asks for confirmation, takes a backup first
+agentscrub run
+
+# Cron-friendly: backup + redact daily at 03:00
+agentscrub schedule install
+```
+
+## Safety model
+
+- `scan` is **read-only**. It never modifies a file. Use it to see what's exposed.
+- `run` writes a **timestamped backup** of every affected directory before touching anything. Restore with `agentscrub rollback`.
+- **Live auth and MCP credential stores are preserved by design** — files like `~/.claude/.credentials.json`, `~/.codex/auth.json`, `~/.gemini/oauth_creds.json`, `cline_mcp_settings.json`, and the Windsurf / OpenCode / Crush / Continue config files are scanned and reported but never modified. [Full list below](#live-auth--mcp-files-preserved-scanned-reported-never-modified).
+- **Raw secrets are never printed in reports.** Each match gets a stable proof hash so you can correlate the same secret across files without exposing it.
+- All scanners run **locally**. Nothing leaves your machine.
+
+## How it works
+
+```mermaid
+flowchart TD
+    A[Agent dirs<br/>~/.claude, ~/.codex, ~/.cursor, ...] --> B[3 scanners find secrets]
+    B --> C{Live auth /<br/>MCP file?}
+    C -->|Yes| D[Reported<br/>Never modified]
+    C -->|No| E[Backup +<br/>Redact in place]
+```
+
+## What it covers
+
+All tools are **auto-detected** — no configuration required. Each row lists every
+folder agentscrub recognises across Linux, macOS, and Windows; the first one
+that exists on your machine is scanned. Plain-text logs, JSONL sessions, and
+JSON state files are scrubbed in place; SQLite databases (`.sqlite`, `.db`,
+`.vscdb`) are scrubbed via SQL UPDATE on text columns containing detected
+secrets.
+
+| Tool | Where session/log data lives | Notes |
+|---|---|---|
+| Claude Code | `~/.claude/` | JSONL sessions, file-history snapshots, project trees |
+| OpenAI Codex CLI | `~/.codex/` | `sessions/`, `history.jsonl`, `logs_*.sqlite`, `state_*.sqlite` |
+| Cursor (CLI/IDE) | `~/.cursor/` | `projects/` (IDE chats), `chats/` (CLI), `acp-sessions/`, `logs/` |
+| Cursor (server) | `~/.cursor-server/` | remote-dev / SSH server-side trees |
+| Cursor (desktop) | `~/Library/Application Support/Cursor/User/workspaceStorage/`, `~/.config/Cursor/User/workspaceStorage/`, `~/AppData/Roaming/Cursor/User/workspaceStorage/` | chats live in `state.vscdb` (SQLite) |
+| Google Antigravity | `~/.antigravity-server/` | server-side IDE state |
+| Windsurf | `~/.codeium/windsurf/` (XDG canonical), `~/.config/Codeium/Windsurf/`, `~/AppData/Roaming/Codeium/Windsurf/`, `~/.windsurf/` | Cascade conversation history |
+| Windsurf (server) | `~/.windsurf-server/` | remote-dev / SSH server-side trees |
+| Windsurf (desktop) | `~/Library/Application Support/Windsurf/User/workspaceStorage/`, `~/.config/Windsurf/User/workspaceStorage/`, `~/AppData/Roaming/Windsurf/User/workspaceStorage/` | desktop IDE workspaceStorage |
+| Gemini CLI | `~/.gemini/` | `tmp/<project_hash>/chats/`, plus the Antigravity `brain/`, `skills/`, `commands/` trees |
+| Zed AI | `~/.local/share/zed/`, `~/Library/Application Support/Zed/`, `~/AppData/Roaming/Zed/`, legacy `~/.config/zed/conversations/` | conversation history in `threads/threads.db` (SQLite) |
+| OpenCode | `~/.local/share/opencode/` (state, sessions) and `~/.config/opencode/` (config) | state/session data plus global config |
+| Crush (Charm) | `~/.local/share/crush/` (state, logs) and `~/.config/crush/` (config) | per-workspace `.crush/` state, `crush.log` |
+| Cline | VS Code `globalStorage/saoudrizwan.claude-dev/` (cross-OS) **or** `~/.cline/data/` (CLI mode) | `tasks/<id>/`, `state/`, `checkpoints/` |
+| GitHub Copilot Chat | `Code/User/workspaceStorage/*/GitHub.copilot-chat/` (cross-OS, scoped to the Copilot extension only) | `chatSessions/`, `transcripts/`, plus `state.vscdb` chat data |
+| Aider | `~/.aider/` | repo-local `.aider.input.history` / `.aider.chat.history.md` are out of scope — pass them with `--also <path>` |
+| Continue | `~/.continue/` | CLI sessions in `~/.continue/sessions/` |
+
+### Live auth & MCP files preserved (scanned, reported, **never modified**)
+
+`agentscrub run` will not write to any of the following — they're the live
+credentials your agent needs to keep working. They're still scanned and any
+matched patterns are reported, so you can review them by hand if needed.
+
+| Tool | Preserved file(s) |
+|---|---|
+| Claude Code | `~/.claude/.credentials.json`, `~/.claude/settings.json`, `~/.claude.json` |
+| Codex CLI | `~/.codex/auth.json`, `~/.codex/.credentials.json`, `~/.codex/config.toml` |
+| Cursor | `~/.cursor/mcp.json` |
+| Windsurf | `~/.codeium/windsurf/mcp_config.json`, `~/.codeium/mcp_config.json`, `~/.config/Codeium/Windsurf/mcp_config.json`, `~/.windsurf/mcp.json`, `~/.windsurf/mcp_config.json` |
+| Gemini CLI | `~/.gemini/oauth_creds.json`, `~/.gemini/mcp-oauth-tokens.json`, `~/.gemini/settings.json`, `~/.gemini/google_accounts.json`, `~/.gemini/trustedFolders.json`, `~/.gemini/installation_id`, `~/.gemini/user_id`, `~/.gemini/antigravity/mcp_config.json` |
+| OpenCode | `~/.local/share/opencode/auth.json`, `~/.local/share/opencode/mcp-auth.json`, `~/.config/opencode/opencode.{json,jsonc}`, `~/.config/opencode/tui.{json,jsonc}` |
+| Crush | `~/.local/share/crush/mcp.json`, `~/.local/share/crush/crush.json`, `~/.config/crush/crush.json` |
+| Aider | `~/.aider.conf.yml` |
+| Continue | `~/.continue/config.yaml`, `~/.continue/config.json`, `~/.continue/config.ts`, `~/.continue/.env` |
+| Cline (VS Code) | `<globalStorage>/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`, `…/secrets.json` |
+| Cline (CLI) | `~/.cline/data/settings/cline_mcp_settings.json`, `~/.cline/data/secrets.json`, `~/.cline/data/globalState.json` |
+| Generic | everything under `~/.mcp-auth/` |
+
+The goal is to remove leaked copies from logs, histories, and caches without
+breaking agent logins or MCP connections.
+
+Each scan or run writes one masked full audit to `~/.agentscrub/logs/`:
+
+- `scan-...-full.txt` — complete file-by-file audit with detected pattern type,
+  hit count, and proof hash for every affected file.
+
+Old reports are rotated automatically: agentscrub keeps the newest 30 scan
+audits and newest 30 cron stdout logs, and removes legacy summary reports.
+
+Raw credentials are never printed in reports. Proof hashes let you recognize the
+same secret across files without exposing the secret itself.
+
+## How it finds secrets
+
+Three open-source scanners run locally, in parallel; agentscrub merges and deduplicates their findings:
+
+| Tool | Finds |
+|---|---|
+| **[gitleaks](https://github.com/gitleaks/gitleaks)** | JWTs, generic API keys, npm/GitHub tokens |
+| **[TruffleHog](https://github.com/trufflesecurity/trufflehog)** | Postgres URIs, GCP/AWS keys, Dockerhub, OAuth, Stripe, Groq, and dozens more |
+| **[Titus](https://github.com/praetorian-inc/titus)** (NoseyParker successor) | Username/password pairs, connection URIs, PostHog, LinkedIn, hundreds of generic rules |
+
+JSON lines are parsed and secrets are replaced inside string values only, preserving file structure even when secrets contain `"` or `{}` characters. SQLite databases are updated via SQL on text columns containing detected secrets.
+
+## Install
+
+**Requirements:** Python ≥ 3.11, pipx, rsync
+
+```bash
+pipx install agentscrub
+```
+
+### Detection tools
+
+The commands below install the **Linux x86_64** builds. For macOS, Windows, or arm64, grab the matching binary from each project's release page and drop it into `~/.local/bin/` (or any directory on your `PATH`):
+
+- gitleaks releases: <https://github.com/gitleaks/gitleaks/releases>
+- TruffleHog releases: <https://github.com/trufflesecurity/trufflehog/releases>
+- Titus releases: <https://github.com/praetorian-inc/titus/releases>
+
+```bash
+# gitleaks
+curl -sL https://github.com/gitleaks/gitleaks/releases/download/v8.26.0/gitleaks_8.26.0_linux_x64.tar.gz \
+  | tar xz -C ~/.local/bin/ gitleaks && chmod +x ~/.local/bin/gitleaks
+
+# TruffleHog
+curl -sL https://github.com/trufflesecurity/trufflehog/releases/download/v3.95.2/trufflehog_3.95.2_linux_amd64.tar.gz \
+  | tar xz -C ~/.local/bin/ trufflehog && chmod +x ~/.local/bin/trufflehog
+
+# Titus
+curl -sLo ~/.local/bin/titus \
+  https://github.com/praetorian-inc/titus/releases/download/v1.1.29/titus-linux-amd64 \
+  && chmod +x ~/.local/bin/titus
+```
+
+Verify everything is in place:
+
+```bash
+agentscrub doctor
+```
+
+## Usage
+
+```bash
+# See what's exposed — no writes
+agentscrub scan
+
+# Redact (asks for confirmation, creates backup first)
+agentscrub run
+
+# Non-interactive (for cron / CI)
+agentscrub run --yes
+
+# Restore a previous backup
+agentscrub rollback
+
+# Set up daily 3am cron job
+agentscrub schedule install
+agentscrub schedule status
+agentscrub schedule uninstall
+
+# Scan an extra directory not in the auto-detect list
+agentscrub run --also ~/my-other-ai-tool
+
+# Limit the run to specific tools — repeatable or comma-separated
+agentscrub run --only claude
+agentscrub run --only claude,codex
+agentscrub --list-tools             # show every known tool ID
+
+# Keep more backups (default: 3)
+agentscrub run --max-backups 10
+```
+
+## Backup & rollback
+
+Every live run creates a backup before touching anything:
+
+```
+~/.agentscrub/backups/
+  claude/
+    20260429-030000/    ← newest
+    20260428-030000/
+    20260427-030000/
+  codex/
+    20260429-030000/
+    ...
+```
+
+Oldest backups are rotated out automatically (default: keep 3 per tool).
+
+To restore:
+
+```bash
+agentscrub rollback
+
+# Available backups
+#   1  Claude Code        2026-04-29 03:00  (today)     1.2G
+#   2  Claude Code        2026-04-28 03:00  (yesterday) 1.1G
+#   3  OpenAI Codex CLI   2026-04-29 03:00  (today)     240M
+#
+# Restore backup # (or q to quit): 1
+```
+
+## What it does NOT catch
+
+| Gap | Why |
+|---|---|
+| Plain prose passwords (`my password is hunter2`) | No pattern; indistinguishable from normal text |
+| Short secrets < 8 chars | Below minimum length for all three tools |
+| Secrets in binary files | Skipped by design |
+| PII (names, phones, addresses) | Out of scope; agentscrub targets credentials and secret-like patterns |
+
+## Adding a new AI tool
+
+Edit `src/agentscrub/discover.py` → `_REGISTRY`:
+
+```python
+dict(
+    tool="my-tool",
+    display="My AI Tool",
+    dirs=["~/.my-tool/sessions"],
+    exclude_dirs={"cache"},
+    exclude_files={"credentials.json"},
+),
+```
+
+Open a PR — contributions welcome.
+
+## Upgrade / uninstall
+
+```bash
+pipx upgrade agentscrub
+pipx uninstall agentscrub
+```
+
+## License
+
+Apache-2.0