canarywire 0.1.0a1__tar.gz

canarywire-0.1.0a1/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+
+# Environments
+.venv/
+.env
+
+# Tooling caches
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# canarywire run output
+out/
+.canarywire/
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store
+
+# Local agent workspaces
+.superpowers/
+.claude/
+
+# Internal design docs (kept locally, not published)
+docs/specs/
+docs/plans/
+docs/roadmap.md

canarywire-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to canarywire. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/);
+versions follow [Semantic Versioning](https://semver.org/). Before 1.0, a minor version may break
+the config file, the `report.json` format or exit-code rules; each such change is listed here.
+
+## [0.1.0a1] - 2026-09-27
+
+First public release, an alpha.
+
+### Added
+
+- `canarywire serve [--detach]`, `run` and `stop`; exit codes `0` (the invariant held), `1`
+  (fail) and `2` (untrusted).
+- Capture server: a fake upstream that records every request to `.canarywire/capture.jsonl` and
+  relays it to the runner. Credential headers (`authorization`, `x-api-key`, …) are redacted
+  in the record.
+- Generators: `baseline`, `fragmentation` (placeholders split across SSE events) and `fault`
+  (your `before`/`after` commands break the environment; the gateway must refuse).
+- Protocols: OpenAI Chat Completions and Anthropic Messages, streaming and non-streaming;
+  `target.routes` for several paths; `target.duty: mask-only` for gateways that never restore.
+- Canaries: built-in types (email, phone, IBAN, card, national ID, …), custom types, seeded and
+  replayable with `--seed`.
+- Templates: built-in `default`, `tool-calls` and `multi-turn`, plus your own.
+- Verdicts: leak (URL, headers, body, JSON keys, JSON inside strings), unrestored/altered,
+  inconsistent placeholders, mangled request text; a negative control and a no-traffic rule
+  guard against passes that tested nothing.
+- Reports: `report.json` (version 4) with grouped findings, `report.md`, JUnit (`--junit`), and
+  custom Mustache outputs.
+- Worked examples against real gateways: `examples/litellm-presidio`, `examples/pasteguard`,
+  `examples/kiji`.
+
+### Known limitations
+
+- Gateways that refuse requests containing PII (block mode) can't pass: a refusal outside a
+  fault is `untrusted`.
+- Leaks are exact matches; a value forwarded transformed (re-cased, re-spaced, encoded) is not
+  detected.
+- POSIX only.
+
+[0.1.0a1]: https://github.com/pitkonst/canarywire/releases/tag/v0.1.0a1

canarywire-0.1.0a1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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
+
+       https://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.

canarywire-0.1.0a1/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.5
+Name: canarywire
+Version: 0.1.0a1
+Summary: A regression test for your PII gateway's trust boundary.
+Project-URL: Homepage, https://github.com/pitkonst/canarywire
+Project-URL: Documentation, https://github.com/pitkonst/canarywire/tree/main/docs/guide
+Project-URL: Source, https://github.com/pitkonst/canarywire
+Project-URL: Issues, https://github.com/pitkonst/canarywire/issues
+Project-URL: Changelog, https://github.com/pitkonst/canarywire/blob/main/CHANGELOG.md
+Author-email: Petr Konstantinov <pit.here@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: anthropic,gateway,llm,openai,pii,security,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: anyio>=4.15.1
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: starlette>=1.7.0
+Requires-Dist: uvicorn>=0.53.0
+Requires-Dist: websockets>=16.1.1
+Description-Content-Type: text/markdown
+
+# canarywire
+
+**A regression test for your PII gateway's trust boundary.**
+Black-box, self-hosted, and it runs in CI. It works with any gateway that speaks the OpenAI or Anthropic API: public, commercial, or one your team wrote.
+
+## Quick start
+
+```bash
+pip install canarywire
+canarywire serve --detach --listen 127.0.0.1:8765                       # 1. fake upstream that records everything
+your-gateway --upstream http://127.0.0.1:8765 --listen 127.0.0.1:4000  # 2. your gateway, pointed at it
+canarywire run --target http://127.0.0.1:4000                           # 3. attack the gateway, check the boundary
+canarywire stop
+```
+
+You start your gateway the way you always do, only with a different upstream. Exit code `0` means the boundary held. The report is in `out/report.json` and `out/report.md`.
+
+A gateway that also serves Anthropic Messages, or uses other paths, needs a config file:
+
+```yaml
+# canarywire.yaml  →  canarywire run --config canarywire.yaml
+target:
+  base_url: http://127.0.0.1:4000
+  routes:
+    - {protocol: openai-chat, path: /v1/chat/completions}
+    - {protocol: anthropic-messages, path: /v1/messages}
+```
+
+See [docs/guide/canarywire.yaml](https://github.com/pitkonst/canarywire/blob/main/docs/guide/canarywire.yaml) for every option with its default.
+
+## Why
+
+Most teams test PII masking with unit tests on the masking function. The function can be correct while the system as a whole leaks. Bugs like these pass function-level tests, and have been reported against widely used open-source gateways:
+
+- a placeholder split across two SSE events is never restored;
+- the detector goes down, and the gateway forwards the request **unmasked** instead of refusing it;
+- placeholders are restored in message text, but not in tool-call arguments;
+- two people get the same placeholder in one conversation, and the wrong name comes back.
+
+canarywire checks what actually crossed the boundary.
+
+## The invariant
+
+1. **Absolute.** No canary value ever reaches the upstream, in any attack, whatever the outcome.
+2. **Conditional.** If the request succeeded, every canary that the template echoes back reaches the client restored, in the right place.
+
+A refused request is an acceptable outcome once the gateway has shown it works: under a fault, or
+in a fragmentation case after the unsplit stream came back restored. A silent pass-through never
+is. In `baseline` a refusal verifies nothing, so the run is `untrusted`: gateways that block
+requests containing PII instead of masking them aren't supported yet.
+
+## How it works
+
+- `canarywire serve` runs a **capture server**, and you point your gateway's upstream at it.
+- `canarywire run` generates **canaries**: synthetic values in the formats you declare sensitive. It sends them through the gateway, inside requests built from **templates**.
+- The capture hands every upstream request to the runner, which:
+  - checks it for canaries;
+  - answers with a scripted response that echoes the gateway's placeholders;
+  - then checks that the original values reached the client, in the right positions.
+
+| Generator | What it tries |
+| --- | --- |
+| `baseline` | each template once: masked upstream, restored to the client, consistent placeholders |
+| `fragmentation` | placeholders split across SSE events at every character offset |
+| `fault` | your commands break the environment (e.g. stop the analyzer); the gateway must refuse |
+
+The built-in templates cover plain messages (`default`), tool calls (`tool-calls`) and multi-turn conversations (`multi-turn`). You can add your own canary types, such as customer IDs or contract numbers, and your own templates. For gateways that only anonymize on the way in, set `target.duty: mask-only`.
+
+| Exit code | Meaning |
+| --- | --- |
+| `0` | the invariant held |
+| `1` | a leak, a value not restored (or altered under `mask-only`), inconsistent placeholders, or a request mangled around a canary |
+| `2` | the run can't be trusted (capture unreachable, negative control not caught, config error, …) |
+
+## Documentation
+
+- [Configuration](https://github.com/pitkonst/canarywire/blob/main/docs/guide/configuration.md): target, routes, duty, generators, seed, timeouts.
+- [Canaries and templates](https://github.com/pitkonst/canarywire/blob/main/docs/guide/canaries-and-templates.md): built-in and custom types, the template format, protocols.
+- [Faults](https://github.com/pitkonst/canarywire/blob/main/docs/guide/faults.md): breaking the environment and the fail-closed verdicts.
+- [Report](https://github.com/pitkonst/canarywire/blob/main/docs/guide/report.md): `report.json`, findings, templated outputs (Markdown, JUnit, your own), exit codes.
+- [CI](https://github.com/pitkonst/canarywire/blob/main/docs/guide/ci.md): GitHub Actions and GitLab CI examples.
+
+## What this is not
+
+- **Not a gateway.** canarywire masks nothing and ships no proxy.
+- **Not a detection-recall benchmark.** It proves the gateway handles the formats you declared, not how well a detector finds names in arbitrary text.
+- **Not a quality benchmark.** How masking affects answer quality is a separate study.
+- **Not proof of absence.** A format you didn't declare is a format that wasn't tested.
+- **Not a fuzzy matcher.** A leak is the exact canary value in the upstream request (URL, headers,
+  body, JSON inside strings). A gateway that forwards a value transformed, e.g. re-cased,
+  re-spaced or base64-encoded, isn't caught.
+- **Not a view of other channels.** Only what reaches the capture is checked. Values the gateway
+  sends elsewhere (an external detection API, logs, telemetry) aren't seen.
+
+## License
+
+Apache-2.0

canarywire-0.1.0a1/README.md

@@ -0,0 +1,97 @@
+# canarywire
+
+**A regression test for your PII gateway's trust boundary.**
+Black-box, self-hosted, and it runs in CI. It works with any gateway that speaks the OpenAI or Anthropic API: public, commercial, or one your team wrote.
+
+## Quick start
+
+```bash
+pip install canarywire
+canarywire serve --detach --listen 127.0.0.1:8765                       # 1. fake upstream that records everything
+your-gateway --upstream http://127.0.0.1:8765 --listen 127.0.0.1:4000  # 2. your gateway, pointed at it
+canarywire run --target http://127.0.0.1:4000                           # 3. attack the gateway, check the boundary
+canarywire stop
+```
+
+You start your gateway the way you always do, only with a different upstream. Exit code `0` means the boundary held. The report is in `out/report.json` and `out/report.md`.
+
+A gateway that also serves Anthropic Messages, or uses other paths, needs a config file:
+
+```yaml
+# canarywire.yaml  →  canarywire run --config canarywire.yaml
+target:
+  base_url: http://127.0.0.1:4000
+  routes:
+    - {protocol: openai-chat, path: /v1/chat/completions}
+    - {protocol: anthropic-messages, path: /v1/messages}
+```
+
+See [docs/guide/canarywire.yaml](https://github.com/pitkonst/canarywire/blob/main/docs/guide/canarywire.yaml) for every option with its default.
+
+## Why
+
+Most teams test PII masking with unit tests on the masking function. The function can be correct while the system as a whole leaks. Bugs like these pass function-level tests, and have been reported against widely used open-source gateways:
+
+- a placeholder split across two SSE events is never restored;
+- the detector goes down, and the gateway forwards the request **unmasked** instead of refusing it;
+- placeholders are restored in message text, but not in tool-call arguments;
+- two people get the same placeholder in one conversation, and the wrong name comes back.
+
+canarywire checks what actually crossed the boundary.
+
+## The invariant
+
+1. **Absolute.** No canary value ever reaches the upstream, in any attack, whatever the outcome.
+2. **Conditional.** If the request succeeded, every canary that the template echoes back reaches the client restored, in the right place.
+
+A refused request is an acceptable outcome once the gateway has shown it works: under a fault, or
+in a fragmentation case after the unsplit stream came back restored. A silent pass-through never
+is. In `baseline` a refusal verifies nothing, so the run is `untrusted`: gateways that block
+requests containing PII instead of masking them aren't supported yet.
+
+## How it works
+
+- `canarywire serve` runs a **capture server**, and you point your gateway's upstream at it.
+- `canarywire run` generates **canaries**: synthetic values in the formats you declare sensitive. It sends them through the gateway, inside requests built from **templates**.
+- The capture hands every upstream request to the runner, which:
+  - checks it for canaries;
+  - answers with a scripted response that echoes the gateway's placeholders;
+  - then checks that the original values reached the client, in the right positions.
+
+| Generator | What it tries |
+| --- | --- |
+| `baseline` | each template once: masked upstream, restored to the client, consistent placeholders |
+| `fragmentation` | placeholders split across SSE events at every character offset |
+| `fault` | your commands break the environment (e.g. stop the analyzer); the gateway must refuse |
+
+The built-in templates cover plain messages (`default`), tool calls (`tool-calls`) and multi-turn conversations (`multi-turn`). You can add your own canary types, such as customer IDs or contract numbers, and your own templates. For gateways that only anonymize on the way in, set `target.duty: mask-only`.
+
+| Exit code | Meaning |
+| --- | --- |
+| `0` | the invariant held |
+| `1` | a leak, a value not restored (or altered under `mask-only`), inconsistent placeholders, or a request mangled around a canary |
+| `2` | the run can't be trusted (capture unreachable, negative control not caught, config error, …) |
+
+## Documentation
+
+- [Configuration](https://github.com/pitkonst/canarywire/blob/main/docs/guide/configuration.md): target, routes, duty, generators, seed, timeouts.
+- [Canaries and templates](https://github.com/pitkonst/canarywire/blob/main/docs/guide/canaries-and-templates.md): built-in and custom types, the template format, protocols.
+- [Faults](https://github.com/pitkonst/canarywire/blob/main/docs/guide/faults.md): breaking the environment and the fail-closed verdicts.
+- [Report](https://github.com/pitkonst/canarywire/blob/main/docs/guide/report.md): `report.json`, findings, templated outputs (Markdown, JUnit, your own), exit codes.
+- [CI](https://github.com/pitkonst/canarywire/blob/main/docs/guide/ci.md): GitHub Actions and GitLab CI examples.
+
+## What this is not
+
+- **Not a gateway.** canarywire masks nothing and ships no proxy.
+- **Not a detection-recall benchmark.** It proves the gateway handles the formats you declared, not how well a detector finds names in arbitrary text.
+- **Not a quality benchmark.** How masking affects answer quality is a separate study.
+- **Not proof of absence.** A format you didn't declare is a format that wasn't tested.
+- **Not a fuzzy matcher.** A leak is the exact canary value in the upstream request (URL, headers,
+  body, JSON inside strings). A gateway that forwards a value transformed, e.g. re-cased,
+  re-spaced or base64-encoded, isn't caught.
+- **Not a view of other channels.** Only what reaches the capture is checked. Values the gateway
+  sends elsewhere (an external detection API, logs, telemetry) aren't seen.
+
+## License
+
+Apache-2.0