traceredact 0.1.0__tar.gz

traceredact-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+uv.lock

traceredact-0.1.0/LICENSE

@@ -0,0 +1,166 @@
+                                 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.
+
+   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.
+
+   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.
+
+   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
+
+   Copyright 2026 traceredact contributors
+
+   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.

traceredact-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: traceredact
+Version: 0.1.0
+Summary: Redact PII and secrets from AI prompts, traces and tool-call arguments before they reach your loggers.
+Project-URL: Homepage, https://github.com/traceredact/traceredact
+Project-URL: Issues, https://github.com/traceredact/traceredact/issues
+Author: traceredact contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: dlp,llm,observability,pii,privacy,redaction,secrets
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.6
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.12
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.25; extra == 'anthropic'
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.2; extra == 'langchain'
+Provides-Extra: openai
+Requires-Dist: openai>=1.0; extra == 'openai'
+Description-Content-Type: text/markdown
+
+# traceredact
+
+**Redact PII and secrets from AI prompts, agent traces and tool-call arguments
+*before* they reach your loggers / observability backend.**
+
+LLM apps log everything — prompts, agent traces, tool-call arguments — into
+Langfuse / Helicone / Datadog / your own DB. Customer PII and API keys leak into
+those traces. `traceredact` is a small, dependency-light library that detects
+and redacts that data deterministically, in-process, before it leaves you.
+
+It is **content-based**: it catches a `sk-…` key or a credit-card number even
+when it sits under an innocuous JSON key — not just well-known field names.
+
+> A missed secret is a real incident, so detection is treated as
+> safety-critical: bounded (ReDoS-safe) patterns, entropy fallback, Luhn/IBAN
+> validation, and adversarial evasion fixtures.
+
+## Install
+
+```bash
+pip install traceredact          # or: uv add traceredact
+```
+
+## Usage (3 lines)
+
+```python
+from traceredact import redact
+
+result = redact({"args": {"email": "a@b.com", "key": "sk-1234567890abcdefABCDEFGH"}})
+print(result.value)      # {'args': {'email': '[REDACTED:pii]', 'key': '[REDACTED:secret]'}}
+print(result.findings)   # [Finding(detector_id='pii.email', json_path='args.email', ...), ...]
+```
+
+`redact()` accepts a string, dict, list, or any nested mix. The input is never
+mutated; `result.value` is a redacted copy and `result.findings` lists every hit
+with its `detector_id`, `category`, `confidence`, `json_path` and `span`.
+
+### CLI (CI-gateable)
+
+```bash
+traceredact scan ./logs/            # report findings as a table; exit 1 if any
+traceredact scan trace.json -f json # machine-readable output for CI
+traceredact redact trace.json -o redacted.json
+```
+
+`scan` exits non-zero when anything is found, so you can gate a CI job on it.
+
+### SDK integrations
+
+```python
+from openai import OpenAI
+from traceredact.integrations.openai import wrap_openai
+
+client = wrap_openai(OpenAI())   # prompts + completions now redacted in-flight
+```
+
+Also: `traceredact.integrations.anthropic.wrap_anthropic(client)` and
+`traceredact.integrations.langchain.RedactingCallbackHandler()`.
+
+> **Limitation (MVP):** the wrappers patch the **synchronous, non-streaming**
+> `create` call. Outbound prompts are always redacted, but **streamed**
+> (`stream=True`) response *content* and **async** clients (`AsyncOpenAI`) are
+> not yet redacted on the response side. Don't rely on response redaction for
+> streaming until that lands.
+
+## Policy file (`traceredact.yml`)
+
+Drop a `traceredact.yml` in your repo root (auto-discovered) or pass `--policy`:
+
+```yaml
+entropy_threshold: 4.0
+min_entropy_len: 20
+disabled_detectors:
+  - pii.phone
+allowlist:
+  - "noreply@example.com"
+allow_patterns:
+  - ".*@example\\.com"
+placeholder: "[REDACTED:{category}]"
+hash_correlation: false        # set true + hash_key to emit correlation tags
+custom_patterns:
+  - id: custom.internal_user_id
+    category: pii
+    regex: "ACME-USR-[0-9]{8}"
+    confidence: 0.95
+```
+
+See [`traceredact.yml`](./traceredact.yml) in this repo for a fully-commented example.
+
+## Detectors
+
+**Secrets:** `secrets.openai_key`, `secrets.aws_access_key`,
+`secrets.github_token`, `secrets.slack_token`, `secrets.slack_webhook`,
+`secrets.google_api_key`, `secrets.stripe_key`, `secrets.sendgrid_key`,
+`secrets.twilio_key`, `secrets.jwt`, `secrets.private_key`,
+`secrets.basic_auth_url`, `secrets.env_assignment`, `secrets.high_entropy`.
+
+**PII:** `pii.email`, `pii.credit_card` (Luhn), `pii.iban` (mod-97),
+`pii.ipv4`, `pii.phone`.
+
+Secret *pattern* hits are deterministic (confidence `1.0`); fuzzy heuristics
+(entropy, phone, IP) carry lower confidence so policy thresholds can gate them.
+
+## Design & safety
+
+- **Deterministic, no data retained.** Pure functions; nothing is stored.
+- **Copy, never mutate.** Your objects are untouched.
+- **ReDoS-safe.** Cheap literal prefilters gate bounded regexes; no nested
+  quantifiers; input length is capped.
+- **Fail-closed.** Hash correlation without a key, or exceeding `max_depth`,
+  raises rather than silently leaking.
+
+Detectors were hardened against adversarial evasion cases (see
+`tests/test_evasion.py`).
+
+## License
+
+Apache-2.0.

traceredact-0.1.0/README.md

@@ -0,0 +1,118 @@
+# traceredact
+
+**Redact PII and secrets from AI prompts, agent traces and tool-call arguments
+*before* they reach your loggers / observability backend.**
+
+LLM apps log everything — prompts, agent traces, tool-call arguments — into
+Langfuse / Helicone / Datadog / your own DB. Customer PII and API keys leak into
+those traces. `traceredact` is a small, dependency-light library that detects
+and redacts that data deterministically, in-process, before it leaves you.
+
+It is **content-based**: it catches a `sk-…` key or a credit-card number even
+when it sits under an innocuous JSON key — not just well-known field names.
+
+> A missed secret is a real incident, so detection is treated as
+> safety-critical: bounded (ReDoS-safe) patterns, entropy fallback, Luhn/IBAN
+> validation, and adversarial evasion fixtures.
+
+## Install
+
+```bash
+pip install traceredact          # or: uv add traceredact
+```
+
+## Usage (3 lines)
+
+```python
+from traceredact import redact
+
+result = redact({"args": {"email": "a@b.com", "key": "sk-1234567890abcdefABCDEFGH"}})
+print(result.value)      # {'args': {'email': '[REDACTED:pii]', 'key': '[REDACTED:secret]'}}
+print(result.findings)   # [Finding(detector_id='pii.email', json_path='args.email', ...), ...]
+```
+
+`redact()` accepts a string, dict, list, or any nested mix. The input is never
+mutated; `result.value` is a redacted copy and `result.findings` lists every hit
+with its `detector_id`, `category`, `confidence`, `json_path` and `span`.
+
+### CLI (CI-gateable)
+
+```bash
+traceredact scan ./logs/            # report findings as a table; exit 1 if any
+traceredact scan trace.json -f json # machine-readable output for CI
+traceredact redact trace.json -o redacted.json
+```
+
+`scan` exits non-zero when anything is found, so you can gate a CI job on it.
+
+### SDK integrations
+
+```python
+from openai import OpenAI
+from traceredact.integrations.openai import wrap_openai
+
+client = wrap_openai(OpenAI())   # prompts + completions now redacted in-flight
+```
+
+Also: `traceredact.integrations.anthropic.wrap_anthropic(client)` and
+`traceredact.integrations.langchain.RedactingCallbackHandler()`.
+
+> **Limitation (MVP):** the wrappers patch the **synchronous, non-streaming**
+> `create` call. Outbound prompts are always redacted, but **streamed**
+> (`stream=True`) response *content* and **async** clients (`AsyncOpenAI`) are
+> not yet redacted on the response side. Don't rely on response redaction for
+> streaming until that lands.
+
+## Policy file (`traceredact.yml`)
+
+Drop a `traceredact.yml` in your repo root (auto-discovered) or pass `--policy`:
+
+```yaml
+entropy_threshold: 4.0
+min_entropy_len: 20
+disabled_detectors:
+  - pii.phone
+allowlist:
+  - "noreply@example.com"
+allow_patterns:
+  - ".*@example\\.com"
+placeholder: "[REDACTED:{category}]"
+hash_correlation: false        # set true + hash_key to emit correlation tags
+custom_patterns:
+  - id: custom.internal_user_id
+    category: pii
+    regex: "ACME-USR-[0-9]{8}"
+    confidence: 0.95
+```
+
+See [`traceredact.yml`](./traceredact.yml) in this repo for a fully-commented example.
+
+## Detectors
+
+**Secrets:** `secrets.openai_key`, `secrets.aws_access_key`,
+`secrets.github_token`, `secrets.slack_token`, `secrets.slack_webhook`,
+`secrets.google_api_key`, `secrets.stripe_key`, `secrets.sendgrid_key`,
+`secrets.twilio_key`, `secrets.jwt`, `secrets.private_key`,
+`secrets.basic_auth_url`, `secrets.env_assignment`, `secrets.high_entropy`.
+
+**PII:** `pii.email`, `pii.credit_card` (Luhn), `pii.iban` (mod-97),
+`pii.ipv4`, `pii.phone`.
+
+Secret *pattern* hits are deterministic (confidence `1.0`); fuzzy heuristics
+(entropy, phone, IP) carry lower confidence so policy thresholds can gate them.
+
+## Design & safety
+
+- **Deterministic, no data retained.** Pure functions; nothing is stored.
+- **Copy, never mutate.** Your objects are untouched.
+- **ReDoS-safe.** Cheap literal prefilters gate bounded regexes; no nested
+  quantifiers; input length is capped.
+- **Fail-closed.** Hash correlation without a key, or exceeding `max_depth`,
+  raises rather than silently leaking.
+
+Detectors were hardened against adversarial evasion cases (see
+`tests/test_evasion.py`).
+
+## License
+
+Apache-2.0.

traceredact-0.1.0/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "traceredact"
+version = "0.1.0"
+description = "Redact PII and secrets from AI prompts, traces and tool-call arguments before they reach your loggers."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "Apache-2.0" }
+authors = [{ name = "traceredact contributors" }]
+keywords = ["pii", "redaction", "secrets", "dlp", "llm", "observability", "privacy"]
+dependencies = [
+    "pydantic>=2.6",
+    "typer>=0.12",
+    "pyyaml>=6.0",
+]
+
+[project.optional-dependencies]
+openai = ["openai>=1.0"]
+anthropic = ["anthropic>=0.25"]
+langchain = ["langchain-core>=0.2"]
+
+[project.scripts]
+traceredact = "traceredact.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/traceredact/traceredact"
+Issues = "https://github.com/traceredact/traceredact/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/traceredact"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.5",
+    "mypy>=1.10",
+    "types-pyyaml>=6.0",
+]
+
+[tool.ruff]
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.ruff.lint.per-file-ignores]
+# typer's API requires calling typer.Option/Argument in parameter defaults.
+"src/traceredact/cli.py" = ["B008"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+files = ["src/traceredact"]
+
+[[tool.mypy.overrides]]
+module = ["langchain_core.*"]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+pythonpath = ["src"]

traceredact-0.1.0/src/traceredact/__init__.py

@@ -0,0 +1,43 @@
+"""traceredact — redact PII & secrets from AI prompts, traces and tool-call args.
+
+Quick start::
+
+    from traceredact import redact
+
+    result = redact({"args": {"email": "a@b.com", "key": "sk-abc123..."}})
+    result.value        # -> {"args": {"email": "[REDACTED:pii]", "key": "[REDACTED:secret]"}}
+    result.findings     # -> [Finding(json_path="args.email", ...), ...]
+    result.has_findings # -> True
+
+Deterministic, no data retained. Configure via a :class:`Policy` (in code or a
+``traceredact.yml`` file).
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from traceredact.detectors.base import Finding
+from traceredact.engine import Engine, RedactionResult
+from traceredact.policy import CustomPattern, Policy
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "redact",
+    "Engine",
+    "RedactionResult",
+    "Finding",
+    "Policy",
+    "CustomPattern",
+    "__version__",
+]
+
+
+def redact(value: Any, policy: Policy | None = None) -> RedactionResult:
+    """Redact ``value`` (str, dict, list, or nested mix) and return the result.
+
+    ``policy`` defaults to a sensible built-in policy. The input is never
+    mutated; ``result.value`` is a redacted copy.
+    """
+    return Engine(policy).redact(value)