stegguard 0.4.0__tar.gz

stegguard-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

stegguard-0.4.0/NOTICE

@@ -0,0 +1,4 @@
+StegGuard
+Copyright 2025-2026 Aditya Arakeri and StegGuard contributors
+
+This product is licensed under the Apache License, Version 2.0.

stegguard-0.4.0/PKG-INFO

@@ -0,0 +1,356 @@
+Metadata-Version: 2.4
+Name: stegguard
+Version: 0.4.0
+Summary: Detect, decode, and safely remove hidden content and provenance signals
+Author: Aditya Arakeri
+Maintainer: Aditya Arakeri
+License-Expression: Apache-2.0
+Project-URL: Source, https://github.com/stegguard/stegguard
+Project-URL: Documentation, https://github.com/stegguard/stegguard/tree/main/docs
+Project-URL: Issues, https://github.com/stegguard/stegguard/issues
+Project-URL: Security, https://github.com/stegguard/stegguard/security/policy
+Keywords: steganography,detection,security,llm,nlp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Security
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: <3.15,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Provides-Extra: images
+Requires-Dist: Pillow>=12.0.0; extra == "images"
+Provides-Extra: dev
+Requires-Dist: bandit>=1.8; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: check-wheel-contents>=0.6; extra == "dev"
+Requires-Dist: hypothesis>=6.0; extra == "dev"
+Requires-Dist: mypy>=1.15; extra == "dev"
+Requires-Dist: pip-audit>=2.9; extra == "dev"
+Requires-Dist: pygments>=2.20.0; extra == "dev"
+Requires-Dist: pytest>=9.0.3; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff>=0.12; extra == "dev"
+Requires-Dist: twine>=6.0; extra == "dev"
+Dynamic: license-file
+
+# StegGuard
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/stegguard/stegguard/main/images/steg_banner.png" alt="StegGuard: Uncovering Hidden Data" width="630">
+</p>
+
+**Find what is hiding in plain sight.**
+
+[![Python 3.12+](https://img.shields.io/badge/Python-3.12%2B-3776AB)](https://www.python.org/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-4EAA25)](https://github.com/stegguard/stegguard/blob/main/LICENSE)
+[![Runtime dependencies: 0](https://img.shields.io/badge/runtime_dependencies-0-2F855A)](https://github.com/stegguard/stegguard/blob/main/pyproject.toml)
+
+StegGuard is a local-first toolkit for finding, decoding, and safely removing
+hidden content from files. It looks beyond ordinary metadata and scans for
+invisible Unicode, whitespace channels, homoglyphs, suspicious media
+structures, watermark signals, fingerprints, and Content Credentials.
+
+It runs on the Python standard library, stays offline by default, and explains
+what it found in JSON and HTML reports you can actually hand to another person.
+
+StegGuard is alpha software. Treat its findings as investigative evidence, not
+as an infallible verdict.
+
+## See it work
+
+The repository includes a deterministic, harmless demo. It hides the word
+`DEMO` in zero-width characters, detects and decodes it, writes a sanitized
+copy, verifies the result, and analyzes a synthetic PNG for watermark and
+provenance signals.
+
+```bash
+python3 demo/run_demo.py
+```
+
+Expected ending:
+
+```text
+Demo completed successfully
+Decoded hidden text: DEMO
+Original preserved: True
+Reports: .../demo-output/reports
+Summary: .../demo-output/summary.json
+```
+
+The demo makes no network requests and contains no executable or malicious
+payload. Open `demo-output/reports/detect.html` after the run to inspect the
+report. See [the demo guide](https://github.com/stegguard/stegguard/blob/main/demo/README.md) for every generated artifact.
+
+## Why StegGuard exists
+
+Hidden content is rarely one neat payload in one neat format. It can be a
+zero-width message in a prompt, a Cyrillic character in a source file, trailing
+spaces in a document, bytes after a media container, a private PNG chunk, or a
+provenance claim that exists but has never been cryptographically validated.
+
+Most tools handle one of those cases. StegGuard gives them a shared workflow:
+
+```text
+untrusted file -> detect -> inspect -> decode -> sanitize a copy -> verify
+```
+
+The original stays untouched unless you explicitly authorize an in-place
+replacement.
+
+## Install
+
+When a release is available on PyPI:
+
+```bash
+python3 -m pip install stegguard
+```
+
+From source:
+
+```bash
+git clone https://github.com/stegguard/stegguard.git
+cd stegguard
+python3 -m pip install -e .
+```
+
+StegGuard requires Python 3.12 or newer and has no mandatory runtime
+dependencies.
+
+For wider image-format decoding through the explicitly tested Pillow path:
+
+```bash
+python3 -m pip install "stegguard[images]"
+```
+
+The supported Python range is 3.12 through 3.14. CI is configured for Linux,
+macOS, and Windows; hosted results are required before those targets are
+described as verified. Architecture details and current evidence are in
+[docs/platform-support.md](https://github.com/stegguard/stegguard/blob/main/docs/platform-support.md).
+
+## Quick start
+
+Scan one file:
+
+```bash
+stegguard detect suspicious.py
+```
+
+Scan a repository and save both report formats:
+
+```bash
+stegguard detect ./repo -r --json findings.json --html report.html
+```
+
+Decode recognized text-carried channels without modifying the source:
+
+```bash
+stegguard decode suspicious.txt
+```
+
+Write a sanitized copy and receive hashes, change counts, and a unified diff:
+
+```bash
+stegguard sanitize suspicious.txt
+```
+
+Analyze watermark and provenance signals:
+
+```bash
+stegguard watermark image.png --json watermark.json --html watermark.html
+```
+
+Validate Content Credentials with the official `c2patool` executable:
+
+```bash
+stegguard watermark image.png --c2pa-tool c2patool --html provenance.html
+```
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `stegguard detect` | Scans files or directories for hidden-content signals |
+| `stegguard decode` | Extracts recognized text-carried payloads without changing the input |
+| `stegguard sanitize` | Writes a safer copy and reports every change |
+| `stegguard watermark` | Analyzes watermark, fingerprint, and provenance evidence |
+
+Run `stegguard COMMAND --help` for command-specific options.
+
+For `detect`, exit status `0` means a completed clean scan, `1` means a
+completed scan with findings, and `2` means invalid input or an incomplete
+scan. The complete compatibility contract is in
+[docs/compatibility.md](https://github.com/stegguard/stegguard/blob/main/docs/compatibility.md).
+
+## What it detects
+
+### Text and source files
+
+- Zero-width and invisible Unicode characters
+- Bidirectional controls and suspicious formatting characters
+- Cyrillic and Greek homoglyphs
+- Trailing-space and tab channels, including SNOW-style patterns
+- Mixed and encoded line-ending patterns
+- Repeated punctuation, spacing, and layout intervals
+
+### Images, audio, and structured media
+
+- Pixel-level LSB anomalies as a distinct detection category
+- Transform and block-correlation signals in decodable lossless images
+- Phase, echo, spectral, spread-spectrum, and silence-interval statistics in
+  PCM WAV audio
+- PNG metadata, private chunks, and appended data
+- JPEG EXIF, XMP, and IPTC indicators
+- RIFF trailing data, ISO BMFF private boxes, and PSD structures
+- Pluggable analyzers for compressed codecs, keyed schemes, and video
+
+### Documents and containers
+
+- PDF embedded files and active or hidden structures
+- DOCX, PPTX, XLSX, ZIP, and compatible archive members
+- Nested media and archives with bounded member and decompression limits
+- SVG and HTML comments, hidden styles, and external references
+
+### Watermarks and provenance
+
+- Metadata, structural, text-pattern, and layout evidence
+- Robust image, audio, and video signal families
+- Device, camera, printer, encoder, and codec fingerprints
+- Embedded and sidecar C2PA manifests
+- Content Credentials validated through `c2patool`
+- External manifest references with opt-in, bounded HTTPS retrieval
+- Pluggable AI text-watermark verifiers
+
+Detection categories remain separate in the output. An LSB anomaly is not
+reported as a robust watermark, and the presence of a C2PA manifest is not
+reported as cryptographic validation.
+
+## Sanitization is deliberately cautious
+
+By default, this command:
+
+```bash
+stegguard sanitize suspicious.txt
+```
+
+writes `suspicious.sanitized.txt`. It will not overwrite an existing output and
+it reports:
+
+- SHA-256 hashes before and after
+- A unified text diff
+- Counts for every normalization
+- Whether the original was preserved
+- Provenance status before and after
+- Whether a content change invalidated provenance
+
+Overwriting the original requires both flags:
+
+```bash
+stegguard sanitize suspicious.txt --in-place --confirm
+```
+
+Unsupported binary formats are copied byte-for-byte and marked
+`NO_OP_UNSUPPORTED`. StegGuard does not push binary data through a text cleaner
+and hope for the best.
+
+## Reports built for review
+
+JSON findings are machine-readable, JSON-compatible, and designed for downstream tools.
+HTML reports include:
+
+- Executive severity and provenance summaries
+- Per-file evidence with locations and confidence
+- Nested container findings
+- Signer, source type, manifest location, and validation errors
+- C2PA actions, timestamps, edits, and ingredients
+- Clear disclaimers around authorship and missing watermarks
+
+Valid provenance is informational. Tampered or untrusted provenance raises the
+reported risk.
+
+Machine-readable reports carry `schema_version`. The supported schema is
+packaged at `stegguard/schemas/report-v1.schema.json` and its evolution policy
+is documented in [docs/compatibility.md](https://github.com/stegguard/stegguard/blob/main/docs/compatibility.md).
+
+## Python API
+
+The core workflows are also available as Python functions:
+
+```python
+from stegguard import analyze_file, decode_file, sanitize_file, scan_file
+
+detection = analyze_file("suspicious.txt")
+decoded = decode_file("suspicious.txt")
+sanitized = sanitize_file("suspicious.txt")
+watermarks = scan_file("image.png")
+```
+
+Each function returns JSON-compatible data.
+
+## Trust and network model
+
+StegGuard does not make unsolicited network requests. Remote C2PA manifests are
+disabled unless `--allow-remote-manifests` is supplied. When enabled, retrieval
+is HTTPS-only, rejects redirects and non-global addresses, and enforces timeout
+and response-size limits.
+
+C2PA states are explicit: `VALID`, `TAMPERED`, `UNTRUSTED_SIGNER`, `MISSING`,
+`UNSUPPORTED`, or `NOT_CHECKED`. If cryptographic validation did not happen,
+StegGuard says so.
+
+Scans have configurable limits for input bytes, decompression, image pixels,
+archive members, nesting depth, elapsed time, and retained findings. See
+[docs/resource-limits.md](https://github.com/stegguard/stegguard/blob/main/docs/resource-limits.md) before processing uploads or
+running StegGuard as a service.
+
+## Current limitations
+
+- `c2patool` is optional and installed separately. Without a validator, an
+  embedded C2PA claim remains `NOT_CHECKED`.
+- Keyed and proprietary watermark schemes require their corresponding analyzer.
+- Generic robust-media statistics are leads, not cryptographic proof.
+- Video and compressed-codec analysis require a configured analyzer. Missing
+  analysis is reported as `NOT_CHECKED`, not clean.
+- No official Anthropic text-watermark verifier is bundled. StegGuard does not
+  replace one with a home-grown guess.
+- Valid provenance means an asset passed the configured validation. It does not
+  prove authorship. A missing mark does not prove human authorship either.
+
+## Development
+
+```bash
+git clone https://github.com/stegguard/stegguard.git
+cd stegguard
+uv run pytest
+uv run pytest --cov=stegguard --cov-report=term-missing
+uv run ruff check stegguard tests demo scripts benchmarks
+```
+
+The project intentionally keeps its runtime dependency-free. Tests may use
+development dependencies declared in `pyproject.toml`. Contributor setup,
+fixture safety, review expectations, and all local gates are in
+[CONTRIBUTING.md](https://github.com/stegguard/stegguard/blob/main/CONTRIBUTING.md).
+
+## Contributing
+
+Bug reports, new fixtures, detector improvements, and careful false-positive
+reports are welcome. Please include a minimal reproducible sample generated at
+test time. Do not commit suspicious payloads, credentials, or generated reports.
+
+Open an issue or pull request at
+[github.com/stegguard/stegguard](https://github.com/stegguard/stegguard).
+
+Project policies: [security](https://github.com/stegguard/stegguard/blob/main/SECURITY.md), [support](https://github.com/stegguard/stegguard/blob/main/SUPPORT.md),
+[governance](https://github.com/stegguard/stegguard/blob/main/GOVERNANCE.md), [releases](https://github.com/stegguard/stegguard/blob/main/RELEASING.md),
+[detection quality](https://github.com/stegguard/stegguard/blob/main/docs/detection-quality.md), and [changelog](https://github.com/stegguard/stegguard/blob/main/CHANGELOG.md).
+
+## License
+
+StegGuard is licensed under Apache License 2.0. See [LICENSE](https://github.com/stegguard/stegguard/blob/main/LICENSE) and
+[NOTICE](https://github.com/stegguard/stegguard/blob/main/NOTICE).