keysnare 0.1.0__tar.gz

keysnare-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+# Python build and cache files
+__pycache__/
+*.py[cod]
+build/
+dist/
+*.egg-info/
+
+# Virtual environment
+.venv/
+
+# Tool caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Never commit real secrets
+.env
+.env.*
+!.env.example

keysnare-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing to KeySnare
+
+Thanks for helping. KeySnare protects developers from credential-stealing malware, so it holds
+itself to a few rules that every change must keep.
+
+## Rules every change keeps
+
+- **Offline.** No network calls, no telemetry, ever.
+- **Zero runtime dependencies.** Standard library only. Every third-party package is a
+  supply-chain risk, which is exactly what KeySnare defends against. Development tools are fine.
+- **Never a full secret.** Output, logs and errors show masked values only (`AKIA****WXYZ`).
+- **Never elevated.** No administrator or SYSTEM context may run code from a user-writable path.
+  KeySnare's Python code always runs as the normal user. Text from events, files or other
+  programs is data, never code or command arguments.
+- **Never browser stores or VS Code extension storage.**
+- **Few false positives.** Every finding says why it is risky and how to fix it.
+- **Never touch real credentials** without the user's explicit confirmation.
+
+## Setup
+
+```
+git clone https://github.com/Morello77/keysnare.git
+cd keysnare
+python -m venv .venv
+.venv\Scripts\activate        # macOS/Linux: source .venv/bin/activate
+python -m pip install -e ".[dev]"
+```
+
+## Checks
+
+All four must pass before a pull request is merged. CI runs them on Windows, macOS and Linux, on
+Python 3.10 and 3.13.
+
+```
+ruff check .
+black --check .
+mypy
+pytest
+```
+
+## Tests
+
+- Write the test first, then the code.
+- **Fake secrets are built from pieces at runtime** (`"ghp_" + "a1B2" * 9`), never written as
+  complete strings, so the repository never trips GitHub push protection or other scanners.
+- **Never run trap tests on your own machine.** `keysnare trap install` changes the audit policy,
+  scheduled tasks and file permissions. The trap integration test
+  (`tests/integration/trap_harness.ps1`) runs only on disposable GitHub Actions Windows runners,
+  and refuses to start anywhere else.
+- Changes to the admin command templates (`src/keysnare/trap/admin.py`) must update
+  `docs/design-traps.md` and `docs/usage.md` to match; a test checks that they are identical.
+
+## Style
+
+- Clear names over comments. Comments explain *why*, never repeat *what*.
+- Short docstrings on public functions.
+- No unused code and no speculative features.
+- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/):
+  `feat:`, `fix:`, `docs:`, `test:`, `ci:`, `refactor:`, `chore:`.
+
+## Releases
+
+Releases are built only by the release workflow; never upload locally built packages.
+
+## Security issues
+
+Do not open a public issue for a vulnerability. See [SECURITY.md](SECURITY.md).

keysnare-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 Morello Developers
+
+   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.

keysnare-0.1.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.5
+Name: keysnare
+Version: 0.1.0
+Summary: Find plain-text credentials on developer machines and trap credential stealers.
+Project-URL: Homepage, https://github.com/Morello77/keysnare
+Project-URL: Documentation, https://github.com/Morello77/keysnare/blob/main/docs/usage.md
+Project-URL: Issues, https://github.com/Morello77/keysnare/issues
+Project-URL: Security, https://github.com/Morello77/keysnare/security/policy
+Author: Morello Developers
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: credentials,honeytoken,scanner,secrets,security,supply-chain
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: jsonschema; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-jsonschema; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# KeySnare
+
+[![CI](https://github.com/Morello77/keysnare/actions/workflows/ci.yml/badge.svg)](https://github.com/Morello77/keysnare/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+Poisoned npm and PyPI packages, malicious VS Code extensions and compromised GitHub Actions all
+want the same thing: the credentials sitting in plain text on developer machines. KeySnare shows
+you exactly what a credential stealer would grab from your computer, plants clearly marked decoy
+credentials that alert you the moment a program reads them, and tells you, step by step, how to
+move each real secret somewhere safer. It runs entirely offline, has zero runtime dependencies,
+and never prints a full secret.
+
+![KeySnare finding fake credentials in a demo folder, then catching a simulated theft of a decoy](https://raw.githubusercontent.com/Morello77/keysnare/main/docs/demo.gif)
+
+## Why I built this
+
+I’m Morello, a developer in Nigeria. For the better part of this year, most of the cybersecurity news I read pointed to the same thing: exposed keys. Poisoned npm packages, and, most interesting to me, PyPI packages stealing developers’ keys. How do you protect yourself from attacks like that? So I decided to build a tool and see if it helps. It’s called KeySnare. When I first ran it on my PC, it found three tokens I didn’t know were there.
+
+What I wanted was simple: show me what a stealer would grab from my machine, tell me how to fix it, and warn me if something tries to take it. That’s what KeySnare does:
+
+- It looks at your machine, not just your code. Most secret scanners are built to check code before you push it. Stealers don’t care about your repo. They go straight for the files on your computer: .env files, cloud logins, npm and PyPI tokens, SSH keys, AI tool keys, even your shell history. KeySnare checks those.
+- It sets traps. On Windows, KeySnare can plant fake keys where stealers look. If any program reads one, you get a notification with the name of that program. It all happens on your machine, with no online service involved.
+- It tells you how to fix things. Every finding says why it matters and gives steps for your operating system.
+- It’s built so you can trust it. It works fully offline and has no dependencies. It never runs as administrator, never shows a full secret, and never touches your browser passwords. A tool that protects your keys shouldn’t become a risk itself.
+
+It doesn’t block attacks, and I say that openly in the limits section below. But knowing what’s exposed, and knowing fast when something goes after it, is a big step. I hope it helps you the way it helped me.
+
+## Install
+
+```
+pip install keysnare
+```
+
+Python 3.10 or newer. Windows, macOS and Linux for scanning; decoy traps are Windows-only for now.
+
+## Quick start
+
+```
+keysnare scan                                  # scan your home folder
+keysnare scan ~/code/my-project                # scan one folder or file
+keysnare scan --brief                          # one line per finding, no fix steps
+keysnare scan --sarif --output keysnare.sarif  # report for code-scanning tools
+keysnare trap install                          # Windows: plant decoys (see below)
+```
+
+Your home folder is shown as `~` in every report, so screenshots are safe to share. Exit codes
+make it usable in CI: `0` nothing at or above `--fail-on` (default `high`), `1` findings, `2`
+error. Full details: [docs/usage.md](docs/usage.md).
+
+## What it scans
+
+- `.env` files in your projects
+- Cloud and cluster credentials: AWS, Azure, Google Cloud, Kubernetes
+- Package registry tokens: npm, Yarn, PyPI, pip, Poetry, NuGet
+- Docker registry logins, Git credentials, GitHub CLI tokens, tokens inside Git remote URLs
+- AI tool keys and logins: OpenAI, Anthropic, Google, Hugging Face, Claude Code, Codex, Gemini
+  CLI, GitHub Copilot, MCP server configs
+- Service keys: Stripe, Slack, SendGrid
+- SSH and other private keys **without** a passphrase
+- Secrets typed into shell history (bash, zsh, PowerShell)
+
+Every finding has a severity, says why it is risky, and gives fix steps for your operating
+system. The locations and rules are documented in
+[docs/credential-locations.md](docs/credential-locations.md) and
+[docs/detection-rules.md](docs/detection-rules.md).
+
+## How traps work (Windows)
+
+`keysnare trap install` creates fake credentials where stealers look, for example
+`~\.ssh\id_rsa_backup` or `~\.aws\credentials.old`, only where no real tool will ever read them.
+Each decoy is clearly marked as a KeySnare decoy and works nowhere. KeySnare then prints a short
+list of administrator commands **for you to run yourself**: they turn on Windows file auditing
+for the decoys and register a small relay task that uses only built-in Windows programs. When any
+program reads a decoy, Windows records it, and you get a notification naming that program.
+
+No KeySnare program runs in the background, and KeySnare never runs as administrator.
+`keysnare trap test` simulates a theft so you see an alert, and `keysnare trap remove` undoes
+everything. The full design, including every system change and how it is undone:
+[docs/design-traps.md](docs/design-traps.md).
+
+## Principles
+
+- **Offline.** No network calls, no telemetry, ever.
+- **Zero runtime dependencies.** Only the Python standard library, because every third-party
+  package is a supply-chain risk.
+- **Never elevated.** KeySnare's own code never runs as administrator or SYSTEM. The admin steps
+  are short, published commands that you read and run yourself.
+- **Never prints a full secret.** Reports show `AKIA****WXYZ`, never the value.
+- **Never reads browser password stores or VS Code extension storage.** That would make it behave
+  like the malware it fights.
+
+## Honest limits
+
+- It finds credentials at the [documented locations](docs/credential-locations.md) and in the
+  documented formats. A secret in an unusual place or format can be missed.
+- Traps **detect** a theft; they do not block it. When you get an alert, rotate your real
+  credentials.
+- Traps are Windows-only for now, need administrator rights once for setup, and notify you only
+  while you are logged in (Windows still records every read).
+- Malware already running as you could disable your alert task before stealing. Windows' own
+  record of the read survives, but the notification would not come.
+- Fewer decoys are possible on machines where the matching tools are installed, because
+  KeySnare never puts a decoy where a real tool would read it.
+- Anyone who opens a decoy by hand can see it is a KeySnare decoy. That is deliberate.
+
+## Verify a release
+
+Every release is built by GitHub Actions from a tagged commit, with signed build provenance.
+
+GitHub artifact attestations, with the [GitHub CLI](https://cli.github.com/):
+
+```
+pip download keysnare --no-deps --dest keysnare-download
+gh attestation verify keysnare-download/keysnare-*.whl --repo Morello77/keysnare
+```
+
+PyPI attestations: each file on [pypi.org/project/keysnare](https://pypi.org/project/keysnare/)
+shows its verified source repository and workflow. To check one yourself, use the
+`pypi-attestations` tool in a separate, throwaway environment:
+
+```
+python -m pip install pypi-attestations
+pypi-attestations verify pypi --repository https://github.com/Morello77/keysnare pypi:keysnare-0.1.0-py3-none-any.whl
+```
+
+## Contributing and security
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Please report vulnerabilities privately, as described in
+[SECURITY.md](SECURITY.md).
+
+## License
+
+[Apache-2.0](LICENSE). Copyright 2026 Morello Developers.

keysnare-0.1.0/README.md

@@ -0,0 +1,133 @@
+# KeySnare
+
+[![CI](https://github.com/Morello77/keysnare/actions/workflows/ci.yml/badge.svg)](https://github.com/Morello77/keysnare/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+Poisoned npm and PyPI packages, malicious VS Code extensions and compromised GitHub Actions all
+want the same thing: the credentials sitting in plain text on developer machines. KeySnare shows
+you exactly what a credential stealer would grab from your computer, plants clearly marked decoy
+credentials that alert you the moment a program reads them, and tells you, step by step, how to
+move each real secret somewhere safer. It runs entirely offline, has zero runtime dependencies,
+and never prints a full secret.
+
+![KeySnare finding fake credentials in a demo folder, then catching a simulated theft of a decoy](https://raw.githubusercontent.com/Morello77/keysnare/main/docs/demo.gif)
+
+## Why I built this
+
+I’m Morello, a developer in Nigeria. For the better part of this year, most of the cybersecurity news I read pointed to the same thing: exposed keys. Poisoned npm packages, and, most interesting to me, PyPI packages stealing developers’ keys. How do you protect yourself from attacks like that? So I decided to build a tool and see if it helps. It’s called KeySnare. When I first ran it on my PC, it found three tokens I didn’t know were there.
+
+What I wanted was simple: show me what a stealer would grab from my machine, tell me how to fix it, and warn me if something tries to take it. That’s what KeySnare does:
+
+- It looks at your machine, not just your code. Most secret scanners are built to check code before you push it. Stealers don’t care about your repo. They go straight for the files on your computer: .env files, cloud logins, npm and PyPI tokens, SSH keys, AI tool keys, even your shell history. KeySnare checks those.
+- It sets traps. On Windows, KeySnare can plant fake keys where stealers look. If any program reads one, you get a notification with the name of that program. It all happens on your machine, with no online service involved.
+- It tells you how to fix things. Every finding says why it matters and gives steps for your operating system.
+- It’s built so you can trust it. It works fully offline and has no dependencies. It never runs as administrator, never shows a full secret, and never touches your browser passwords. A tool that protects your keys shouldn’t become a risk itself.
+
+It doesn’t block attacks, and I say that openly in the limits section below. But knowing what’s exposed, and knowing fast when something goes after it, is a big step. I hope it helps you the way it helped me.
+
+## Install
+
+```
+pip install keysnare
+```
+
+Python 3.10 or newer. Windows, macOS and Linux for scanning; decoy traps are Windows-only for now.
+
+## Quick start
+
+```
+keysnare scan                                  # scan your home folder
+keysnare scan ~/code/my-project                # scan one folder or file
+keysnare scan --brief                          # one line per finding, no fix steps
+keysnare scan --sarif --output keysnare.sarif  # report for code-scanning tools
+keysnare trap install                          # Windows: plant decoys (see below)
+```
+
+Your home folder is shown as `~` in every report, so screenshots are safe to share. Exit codes
+make it usable in CI: `0` nothing at or above `--fail-on` (default `high`), `1` findings, `2`
+error. Full details: [docs/usage.md](docs/usage.md).
+
+## What it scans
+
+- `.env` files in your projects
+- Cloud and cluster credentials: AWS, Azure, Google Cloud, Kubernetes
+- Package registry tokens: npm, Yarn, PyPI, pip, Poetry, NuGet
+- Docker registry logins, Git credentials, GitHub CLI tokens, tokens inside Git remote URLs
+- AI tool keys and logins: OpenAI, Anthropic, Google, Hugging Face, Claude Code, Codex, Gemini
+  CLI, GitHub Copilot, MCP server configs
+- Service keys: Stripe, Slack, SendGrid
+- SSH and other private keys **without** a passphrase
+- Secrets typed into shell history (bash, zsh, PowerShell)
+
+Every finding has a severity, says why it is risky, and gives fix steps for your operating
+system. The locations and rules are documented in
+[docs/credential-locations.md](docs/credential-locations.md) and
+[docs/detection-rules.md](docs/detection-rules.md).
+
+## How traps work (Windows)
+
+`keysnare trap install` creates fake credentials where stealers look, for example
+`~\.ssh\id_rsa_backup` or `~\.aws\credentials.old`, only where no real tool will ever read them.
+Each decoy is clearly marked as a KeySnare decoy and works nowhere. KeySnare then prints a short
+list of administrator commands **for you to run yourself**: they turn on Windows file auditing
+for the decoys and register a small relay task that uses only built-in Windows programs. When any
+program reads a decoy, Windows records it, and you get a notification naming that program.
+
+No KeySnare program runs in the background, and KeySnare never runs as administrator.
+`keysnare trap test` simulates a theft so you see an alert, and `keysnare trap remove` undoes
+everything. The full design, including every system change and how it is undone:
+[docs/design-traps.md](docs/design-traps.md).
+
+## Principles
+
+- **Offline.** No network calls, no telemetry, ever.
+- **Zero runtime dependencies.** Only the Python standard library, because every third-party
+  package is a supply-chain risk.
+- **Never elevated.** KeySnare's own code never runs as administrator or SYSTEM. The admin steps
+  are short, published commands that you read and run yourself.
+- **Never prints a full secret.** Reports show `AKIA****WXYZ`, never the value.
+- **Never reads browser password stores or VS Code extension storage.** That would make it behave
+  like the malware it fights.
+
+## Honest limits
+
+- It finds credentials at the [documented locations](docs/credential-locations.md) and in the
+  documented formats. A secret in an unusual place or format can be missed.
+- Traps **detect** a theft; they do not block it. When you get an alert, rotate your real
+  credentials.
+- Traps are Windows-only for now, need administrator rights once for setup, and notify you only
+  while you are logged in (Windows still records every read).
+- Malware already running as you could disable your alert task before stealing. Windows' own
+  record of the read survives, but the notification would not come.
+- Fewer decoys are possible on machines where the matching tools are installed, because
+  KeySnare never puts a decoy where a real tool would read it.
+- Anyone who opens a decoy by hand can see it is a KeySnare decoy. That is deliberate.
+
+## Verify a release
+
+Every release is built by GitHub Actions from a tagged commit, with signed build provenance.
+
+GitHub artifact attestations, with the [GitHub CLI](https://cli.github.com/):
+
+```
+pip download keysnare --no-deps --dest keysnare-download
+gh attestation verify keysnare-download/keysnare-*.whl --repo Morello77/keysnare
+```
+
+PyPI attestations: each file on [pypi.org/project/keysnare](https://pypi.org/project/keysnare/)
+shows its verified source repository and workflow. To check one yourself, use the
+`pypi-attestations` tool in a separate, throwaway environment:
+
+```
+python -m pip install pypi-attestations
+pypi-attestations verify pypi --repository https://github.com/Morello77/keysnare pypi:keysnare-0.1.0-py3-none-any.whl
+```
+
+## Contributing and security
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Please report vulnerabilities privately, as described in
+[SECURITY.md](SECURITY.md).
+
+## License
+
+[Apache-2.0](LICENSE). Copyright 2026 Morello Developers.

keysnare-0.1.0/SECURITY.md

@@ -0,0 +1,47 @@
+# Security policy
+
+KeySnare is a security tool, so a weakness in KeySnare itself matters. Thank you for reporting
+one privately.
+
+## Reporting a vulnerability
+
+Use GitHub's private vulnerability reporting: open the repository's **Security** tab and click
+**Report a vulnerability**. Only the maintainers see the report.
+
+Please do not open a public issue, pull request or discussion for a vulnerability until a fix is
+released.
+
+Include:
+
+- what an attacker can do, and what they need first (for example "malware running as the user
+  without admin rights");
+- steps to reproduce, ideally on a fresh Windows VM;
+- the KeySnare version (`keysnare --version`) and your operating system.
+
+**Never include real secrets** in a report. If a finding involves a credential, use a fake one.
+
+The maintainer aims to acknowledge reports within 7 days and will keep you updated until a fix
+is released. With your permission, you will be credited in the release notes.
+
+## Supported versions
+
+Only the latest release receives security fixes.
+
+## What counts as a vulnerability
+
+KeySnare makes promises that a vulnerability would break. Reports are especially welcome for:
+
+- any way for code running **without** administrator rights to make KeySnare's admin commands,
+  the SYSTEM relay task or anything else run code **as administrator or SYSTEM**;
+- writing to, or redirecting, `C:\ProgramData\KeySnare` as a standard user (junctions, symlinks,
+  pre-created folders);
+- KeySnare printing, logging or writing a full secret anywhere (terminal, JSON, SARIF, logs);
+- event text or file content being treated as code or command arguments;
+- any network connection made by KeySnare;
+- KeySnare reading browser password stores or VS Code extension storage;
+- a decoy that is a working credential anywhere;
+- `trap remove` deleting or changing a file KeySnare did not create.
+
+Known, documented limits (see "Remaining risks" in
+[docs/design-traps.md](docs/design-traps.md)) are not vulnerabilities, but ideas to reduce them
+are welcome as normal issues.