scan-for-secrets 0.1__tar.gz

scan_for_secrets-0.1/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.

scan_for_secrets-0.1/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: scan-for-secrets
+Version: 0.1
+Summary: Scan for secrets in files you plan to share
+Author: Simon Willison
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/simonw/scan-for-secrets
+Project-URL: Changelog, https://github.com/simonw/scan-for-secrets/releases
+Project-URL: Issues, https://github.com/simonw/scan-for-secrets/issues
+Project-URL: CI, https://github.com/simonw/scan-for-secrets/actions
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Dynamic: license-file
+
+# scan-for-secrets
+
+[![PyPI](https://img.shields.io/pypi/v/scan-for-secrets.svg)](https://pypi.org/project/scan-for-secrets/)
+[![Changelog](https://img.shields.io/github/v/release/simonw/scan-for-secrets?include_prereleases&label=changelog)](https://github.com/simonw/scan-for-secrets/releases)
+[![Tests](https://github.com/simonw/scan-for-secrets/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/scan-for-secrets/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/scan-for-secrets/blob/master/LICENSE)
+
+Scan for secrets in files you plan to share
+
+## Installation
+
+Install this tool using `pip`:
+```bash
+pip install scan-for-secrets
+```
+Or `uv`:
+```bash
+uv tool install scan-for-secrets
+```
+Or use without installing via `uvx`:
+```bash
+uvx scan-for-secrets --help
+```
+
+## Usage
+
+This tool helps scan all of the text files in a directory (ignoring binary files) to see if they include specified secret strings. For example, run this if you want to publish the logs from a coding agent session after first confirming no secrets from environment variables are exposed in those logs.
+
+Basic usage looks like this:
+```bash
+scan-for-secrets $OPENAI_API_KEY $ANTHROPIC_API_KEY
+```
+This will scan text files in the current folder and all sub-folders looking for the values that were passed as positional arguments, including common escaping schemes that might mean a direct string match misses them.
+
+To scan for a secret that can be accessed using another command, use `$(command)` syntax:
+```bash
+scan-for-secrets "$(llm keys get openai)"
+```
+Add `-d/--directory` to specify a different directory to scan:
+```bash
+scan-for-secrets $OPENAI_API_KEY -d ~/my-project
+```
+You can also pipe a list of newline-separated secrets to the tool:
+```bash
+cat secrets.txt | scan-for-secrets
+```
+This can be combined with secrets passed as positional arguments.
+
+## Output
+
+If no secrets are found, the tool will terminate with an exit code 0 and output nothing. If secrets are found it will return an exit code 1 and list the files, line numbers and the first few characters of each secret that was spotted.
+
+Example output:
+
+```
+logs/2024-03-15.jsonl:42: sk-a... (literal)
+logs/2024-03-15.jsonl:108: sk-a... (json)
+config/debug.html:7: ghp_... (html)
+```
+
+## Configuration file
+
+If you run `scan-for-secrets` without any extra arguments or piped data the command will look for a default configuration file to tell it what to scan for instead.
+
+This file lives at `~/.scan-for-secrets.conf.sh` and contains commands that will be executed to retrieve secrets. Each line should be a shell command that outputs a single secret to stdout (or a blank line or a comment).
+
+```bash
+# API keys
+echo $OPENAI_API_KEY
+echo $ANTHROPIC_API_KEY
+
+# AWS (using xargs to strip whitespace)
+awk -F= '/aws_secret_access_key/{print $2}' ~/.aws/credentials | xargs
+
+# 1Password
+op read "op://Vault/API Key/password"
+
+# LLM keys
+llm keys get gemini
+```
+
+Blank lines and lines starting with `#` are ignored. By default the file is executed with `sh`. Add a shebang line (e.g. `#!/bin/bash` or `#!/usr/bin/env python3`) to use a different interpreter.
+
+With a configuration file setup you can run `scan-for-secrets` like this:
+
+```bash
+cd agent-logs/
+scan-for-secrets
+```
+Or this:
+```bash
+scan-for-secrets -d agent-logs
+```
+You can also pass a path to a configuration file using the `-c/--config` option:
+
+```bash
+scan-for-secrets -c scan.sh
+```
+Unlike the default configuration behavior, this `-c` option will be combined with any piped data or additional positional arguments.
+
+## Using this as a Python library
+
+This package can also be used as a Python library. Add `scan-for-secrets` as a dependency and use it like this:
+
+```python
+from scan_for_secrets import scan_directory
+
+result = scan_directory("./logs", ["sk-abc123...", "ghp_secret..."])
+
+if result.has_secrets:
+    for match in result.matches:
+        print(f"{match.file_path}:{match.line_number}: {match.secret_hint} ({match.encoding})")
+```
+
+### API reference
+
+#### `scan_directory(directory: str | Path, secrets: list[str]) -> ScanResult`
+
+Recursively scans all text files in `directory` for the given `secrets`, checking both literal matches and common escaped variants (JSON, URL percent-encoding, HTML entities, backslash-doubled, Unicode escapes and Python repr).
+
+- **`directory`**: Root directory to scan. Can be a string path or a `pathlib.Path`.
+- **`secrets`**: List of secret strings to search for. Empty strings are ignored.
+
+Binary files (detected by null bytes in the first 8192 bytes) are skipped. The following directories are also skipped: `.git`, `.hg`, `.svn`, `node_modules`, `__pycache__`, `.venv`, `venv`.
+
+#### `ScanResult`
+
+```python
+@dataclass
+class ScanResult:
+    matches: list[Match]  # All matches found across all files
+    files_scanned: int    # Number of text files checked
+
+    @property
+    def has_secrets(self) -> bool:
+        """True if any matches were found."""
+```
+
+#### `Match`
+
+```python
+@dataclass
+class Match:
+    file_path: str     # Path relative to the scanned directory
+    line_number: int   # 1-based line number where the match was found
+    secret_hint: str   # First 4 characters of the original secret + "..."
+    encoding: str      # How the secret was encoded: "literal", "json", "url",
+                       # "html", "backslash-doubled", "unicode-escape", or "repr"
+```
+
+## Help
+
+For help, run:
+```bash
+scan-for-secrets --help
+```
+You can also use:
+```bash
+python -m scan_for_secrets --help
+```
+
+## Development
+
+To contribute to this tool, first checkout the code. Then run the tests:
+```bash
+cd scan-for-secrets
+uv run pytest
+```
+To run the development version of the command itself:
+```bash
+uv run scan-for-secrets --help
+```

scan_for_secrets-0.1/README.md

@@ -0,0 +1,172 @@
+# scan-for-secrets
+
+[![PyPI](https://img.shields.io/pypi/v/scan-for-secrets.svg)](https://pypi.org/project/scan-for-secrets/)
+[![Changelog](https://img.shields.io/github/v/release/simonw/scan-for-secrets?include_prereleases&label=changelog)](https://github.com/simonw/scan-for-secrets/releases)
+[![Tests](https://github.com/simonw/scan-for-secrets/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/scan-for-secrets/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/scan-for-secrets/blob/master/LICENSE)
+
+Scan for secrets in files you plan to share
+
+## Installation
+
+Install this tool using `pip`:
+```bash
+pip install scan-for-secrets
+```
+Or `uv`:
+```bash
+uv tool install scan-for-secrets
+```
+Or use without installing via `uvx`:
+```bash
+uvx scan-for-secrets --help
+```
+
+## Usage
+
+This tool helps scan all of the text files in a directory (ignoring binary files) to see if they include specified secret strings. For example, run this if you want to publish the logs from a coding agent session after first confirming no secrets from environment variables are exposed in those logs.
+
+Basic usage looks like this:
+```bash
+scan-for-secrets $OPENAI_API_KEY $ANTHROPIC_API_KEY
+```
+This will scan text files in the current folder and all sub-folders looking for the values that were passed as positional arguments, including common escaping schemes that might mean a direct string match misses them.
+
+To scan for a secret that can be accessed using another command, use `$(command)` syntax:
+```bash
+scan-for-secrets "$(llm keys get openai)"
+```
+Add `-d/--directory` to specify a different directory to scan:
+```bash
+scan-for-secrets $OPENAI_API_KEY -d ~/my-project
+```
+You can also pipe a list of newline-separated secrets to the tool:
+```bash
+cat secrets.txt | scan-for-secrets
+```
+This can be combined with secrets passed as positional arguments.
+
+## Output
+
+If no secrets are found, the tool will terminate with an exit code 0 and output nothing. If secrets are found it will return an exit code 1 and list the files, line numbers and the first few characters of each secret that was spotted.
+
+Example output:
+
+```
+logs/2024-03-15.jsonl:42: sk-a... (literal)
+logs/2024-03-15.jsonl:108: sk-a... (json)
+config/debug.html:7: ghp_... (html)
+```
+
+## Configuration file
+
+If you run `scan-for-secrets` without any extra arguments or piped data the command will look for a default configuration file to tell it what to scan for instead.
+
+This file lives at `~/.scan-for-secrets.conf.sh` and contains commands that will be executed to retrieve secrets. Each line should be a shell command that outputs a single secret to stdout (or a blank line or a comment).
+
+```bash
+# API keys
+echo $OPENAI_API_KEY
+echo $ANTHROPIC_API_KEY
+
+# AWS (using xargs to strip whitespace)
+awk -F= '/aws_secret_access_key/{print $2}' ~/.aws/credentials | xargs
+
+# 1Password
+op read "op://Vault/API Key/password"
+
+# LLM keys
+llm keys get gemini
+```
+
+Blank lines and lines starting with `#` are ignored. By default the file is executed with `sh`. Add a shebang line (e.g. `#!/bin/bash` or `#!/usr/bin/env python3`) to use a different interpreter.
+
+With a configuration file setup you can run `scan-for-secrets` like this:
+
+```bash
+cd agent-logs/
+scan-for-secrets
+```
+Or this:
+```bash
+scan-for-secrets -d agent-logs
+```
+You can also pass a path to a configuration file using the `-c/--config` option:
+
+```bash
+scan-for-secrets -c scan.sh
+```
+Unlike the default configuration behavior, this `-c` option will be combined with any piped data or additional positional arguments.
+
+## Using this as a Python library
+
+This package can also be used as a Python library. Add `scan-for-secrets` as a dependency and use it like this:
+
+```python
+from scan_for_secrets import scan_directory
+
+result = scan_directory("./logs", ["sk-abc123...", "ghp_secret..."])
+
+if result.has_secrets:
+    for match in result.matches:
+        print(f"{match.file_path}:{match.line_number}: {match.secret_hint} ({match.encoding})")
+```
+
+### API reference
+
+#### `scan_directory(directory: str | Path, secrets: list[str]) -> ScanResult`
+
+Recursively scans all text files in `directory` for the given `secrets`, checking both literal matches and common escaped variants (JSON, URL percent-encoding, HTML entities, backslash-doubled, Unicode escapes and Python repr).
+
+- **`directory`**: Root directory to scan. Can be a string path or a `pathlib.Path`.
+- **`secrets`**: List of secret strings to search for. Empty strings are ignored.
+
+Binary files (detected by null bytes in the first 8192 bytes) are skipped. The following directories are also skipped: `.git`, `.hg`, `.svn`, `node_modules`, `__pycache__`, `.venv`, `venv`.
+
+#### `ScanResult`
+
+```python
+@dataclass
+class ScanResult:
+    matches: list[Match]  # All matches found across all files
+    files_scanned: int    # Number of text files checked
+
+    @property
+    def has_secrets(self) -> bool:
+        """True if any matches were found."""
+```
+
+#### `Match`
+
+```python
+@dataclass
+class Match:
+    file_path: str     # Path relative to the scanned directory
+    line_number: int   # 1-based line number where the match was found
+    secret_hint: str   # First 4 characters of the original secret + "..."
+    encoding: str      # How the secret was encoded: "literal", "json", "url",
+                       # "html", "backslash-doubled", "unicode-escape", or "repr"
+```
+
+## Help
+
+For help, run:
+```bash
+scan-for-secrets --help
+```
+You can also use:
+```bash
+python -m scan_for_secrets --help
+```
+
+## Development
+
+To contribute to this tool, first checkout the code. Then run the tests:
+```bash
+cd scan-for-secrets
+uv run pytest
+```
+To run the development version of the command itself:
+```bash
+uv run scan-for-secrets --help
+```

scan_for_secrets-0.1/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "scan-for-secrets"
+version = "0.1"
+description = "Scan for secrets in files you plan to share"
+readme = "README.md"
+authors = [{name = "Simon Willison"}]
+license = "Apache-2.0"
+requires-python = ">=3.10"
+classifiers = []
+dependencies = [
+    "click"
+]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project.urls]
+Homepage = "https://github.com/simonw/scan-for-secrets"
+Changelog = "https://github.com/simonw/scan-for-secrets/releases"
+Issues = "https://github.com/simonw/scan-for-secrets/issues"
+CI = "https://github.com/simonw/scan-for-secrets/actions"
+
+[project.scripts]
+scan-for-secrets = "scan_for_secrets.cli:cli"
+
+[dependency-groups]
+dev = ["pytest"]

scan_for_secrets-0.1/scan_for_secrets/__init__.py

@@ -0,0 +1,3 @@
+from .scanner import Match, ScanResult, scan_directory
+
+__all__ = ["scan_directory", "ScanResult", "Match"]

scan_for_secrets-0.1/scan_for_secrets/__main__.py

@@ -0,0 +1,4 @@
+from .cli import cli
+
+if __name__ == "__main__":
+    cli()