codefence 1.0.0__tar.gz

codefence-1.0.0/CHANGELOG.md

@@ -0,0 +1,138 @@
+# Changelog
+
+All notable changes to CodeFence.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] — 2026-09-16
+
+### Added
+- Initial public release.
+- Offline, single-file CLI scanner for AI-generated Python and
+  JavaScript source code.
+- 28 pattern rules across secrets, injection, cryptography,
+  authentication, configuration, quality, and reliability.
+- Four output formats: colored CLI, JSON, HTML (dark/light theme),
+  SARIF 2.1.0.
+- Support for `.py`, `.js`, `.mjs`, `.cjs` input files.
+- Config file (`--config`), glob include/exclude (`--include`,
+  `--exclude`), and severity threshold (`--severity`).
+- Optional local cache (`--cache`), off by default, mode 0o600.
+- Strict `rules.json` schema validation and ReDoS mitigation
+  (line-by-line regex with per-call timeout).
+- Friendly welcome screen on zero-argument invocation and a full
+  `--help` reference.
+- JSON and SARIF outputs are pure on stdout (no banners), suitable
+  for CI/CD and agent pipelines.
+
+### Security
+- Zero network calls. Zero telemetry.
+- Zero third-party dependencies (Python standard library only).
+- Cache path is not user-overridable via environment variables.
+- `CHECKSUMS.txt` shipped for verification.
+
+### Known limitations
+- Autofix is intentionally not provided.
+- No TypeScript support.
+- No interprocedural or dataflow analysis.
+- Clean scan does not mean the code is secure.
+
+[1.0.0]: https://example.invalid/codefence/releases/v1.0.0
+
+### Added during pre-release preparation (Day 12)
+- `SECURITY.md` — transparent threat model and design rationale.
+- `NOTICE.md` — statement on source availability (source-readable, not
+  open source).
+- `LICENSE.txt` — Custom Source-Available EULA with machine-use and
+  redistribution restrictions.
+- `TERMS_OF_USE.md` — Terms of Use with explicit scope, payment, and
+  no-support clauses.
+- `REFUND_POLICY.md` — Refund policy preserving EU/UK statutory
+  consumer rights.
+- `README.md` — full user-facing documentation, honest about scope
+  and limitations.
+- `tools/make_checksums.py` — internal helper for generating
+  `CHECKSUMS.txt`.
+- Copyright header in `codefence.py`.
+- `fix_before` / `fix_after` fields per rule (typical fix examples).
+- CLI fix blocks and HTML fix blocks with Copy button.
+- HTML dark/light theme toggle with system-preference detection.
+- Friendly welcome screen on zero-argument invocation.
+- Comprehensive `--help` reference.
+- `--config`, `--include`, `--exclude` flags for flexible scanning.
+- ReDoS mitigation: line-by-line regex with per-call timeout.
+- Strict `rules.json` schema validation.
+- Optional cache (opt-in, mode 0o600, keyed by SHA-256).
+
+### Changed
+- Default excludes expanded to cover common build/cache directories.
+- `--severity` accepts `info` for full verbosity.
+
+### Fixed
+- Removed duplicate `debug=True` pattern in R017.
+- R024 no longer flags `from __future__ import annotations`.
+- R027 is now context-aware (only fires in security-relevant contexts).
+- Empty target list produces a clear message instead of silent output.
+
+### Added (post-consultation, Days 14-28)
+- `codefence init` — one-command setup (config + hook)
+- `codefence init-hook` / `uninstall-hook` — git pre-commit integration
+- `codefence init-github` — GitHub Actions workflow installer
+- `codefence baseline` — snapshot current findings to .codefence/baseline.json
+- `--staged` — scan only git-staged files
+- `--diff` — report only new findings since baseline
+- `--no-baseline` — ignore baseline even with --diff
+- `--policy FILE` — policy-as-code with ORG-* rules and allow/warn/block
+- `codefence policy validate FILE` — schema validation for policy files
+- `--evidence FILE` — deterministic evidence JSON
+  (result_hash, rules_hash, policy_hash, baseline_hash, commit_sha, scan_id)
+- `--history` — record scans in SQLite at ~/.local/share/codefence/history.db
+- `codefence history` — recent scans table
+- `codefence stats` — summary statistics
+- `codefence explain RXXX` — structured rule explanation
+- `# noqa` / `# noqa: R001,R002` inline suppression
+- `CODEFENCE_CMD` / `CODEFENCE_RULES` env overrides for the hook
+- `CODEFENCE_NO_HISTORY=1` env to disable history
+- Two AI-specific rules: R030 (typosquatted imports), R031 (TODO/FIXME/HACK)
+- Rule versioning + fingerprints (rule_version, fingerprint)
+- SARIF partialFingerprints with `codefence/v1` key
+- Auto-discovery of `.codefence/config.json`
+- `pyproject.toml` (PEP 621), pip-installable as `codefence`
+- Console scripts: `cfence` and `codefence`
+- LICENSE_FAQ.md
+- 80 tests (unit + integration), pytest suite
+- Internal docs: NAMING_DUE_DILIGENCE.md
+
+### Changed (post-consultation)
+- Renamed product from "AI Code Sanitizer" to "CodeFence"
+- Product definition: "A tiny offline policy gate for code."
+- Acquisition tagline: "Check AI-generated code before it reaches Git."
+- README rewritten (no forbidden phrases, no geographic identity)
+- LICENSE_FAQ.md added for source-available clarity
+- SECURITY.md updated (history DB, path corrections)
+- `--help` USAGE line now shows `cfence [OPTIONS] PATH...`
+- Default `action` for all rules: `block`
+
+### Removed (from earlier v1.0 plan)
+- Watch mode (deferred)
+- VS Code extension (deferred to v1.1)
+- R029 hallucinated packages (deferred to v1.1)
+- R032 prompt-context secrets (deferred to v1.1)
+- Team tier pricing (deferred to v1.1)
+
+### Fixed
+- R024 no longer flags `from __future__ import annotations`
+- R027 context-aware (only fires in security-relevant contexts)
+- R017 duplicate pattern removed
+- R022 expanded to detect both TOCTOU directions
+- Hook env override (CODEFENCE_CMD) for testing and custom installs
+
+### Security
+- ReDoS mitigation: line-by-line regex, per-call timeout
+- rules.json schema validation (strict)
+- Cache mode 0o600, dir 0o700
+- History DB mode 0o600, dir 0o700
+- Symlink rejection in cache
+- Atomic writes (mkstemp + os.replace)
+- noqa directives parsed safely (regex, no eval)

codefence-1.0.0/LICENSE.txt

@@ -0,0 +1,194 @@
+CODEFENCE
+END USER LICENSE AGREEMENT (EULA)
+Version 1.0.0
+
+Copyright (c) 2026 CodeFence. All rights reserved.
+
+PLEASE READ THIS AGREEMENT CAREFULLY BEFORE USING THIS SOFTWARE.
+BY USING THIS SOFTWARE, YOU AGREE TO BE BOUND BY ITS TERMS.
+
+--------------------------------------------------------------------
+1. DEFINITIONS
+--------------------------------------------------------------------
+
+"Software" means the CodeFence command-line tool, its source
+code, documentation, rules file (rules.json), sample files, and any
+accompanying materials delivered together.
+
+"Licensor" means the copyright holder of the Software.
+
+"You" or "Licensee" means the individual person who purchased or
+acquired the Software.
+
+"Personal Use" means use of the Software by a single individual, on
+computers that the individual owns or controls, for that individual's
+own development work. Personal Use does not include use on behalf of
+a commercial entity as a service to third parties.
+
+--------------------------------------------------------------------
+2. GRANT OF LICENSE
+--------------------------------------------------------------------
+
+Subject to your compliance with this Agreement, the Licensor grants
+You a non-exclusive, non-transferable, worldwide, perpetual license
+to:
+
+  (a) install and use the Software on up to three (3) devices that
+      You personally own or control;
+  (b) read, study, and audit the source code for Your own personal
+      understanding of its behavior;
+  (c) create private modifications of the source code for Your own
+      personal use, provided such modifications remain strictly
+      private and are not distributed.
+
+This is a license, not a sale. The Licensor retains all right, title,
+and interest in and to the Software.
+
+--------------------------------------------------------------------
+3. RESTRICTIONS
+--------------------------------------------------------------------
+
+You may NOT:
+
+  (a) redistribute, sublicense, sell, resell, rent, lease, lend, or
+      otherwise transfer the Software or any modification of it;
+  (b) publish, share, or make available the source code, in original
+      or modified form, on any public or private repository, forum,
+      chat, file-sharing service, or bundle;
+  (c) include the Software in any commercial product, bundle, or
+      service offering;
+  (d) remove, alter, or obscure any copyright, license, or
+      attribution notice in the Software;
+  (e) use the Software for any unlawful purpose;
+  (f) use the Software to provide scanning-as-a-service to third
+      parties on a commercial basis.
+
+--------------------------------------------------------------------
+4. SOURCE CODE AVAILABILITY
+--------------------------------------------------------------------
+
+The Software is delivered in human-readable source form. This is done
+intentionally so that any user can inspect exactly what the tool does,
+confirm that it performs no network calls, and verify that it does not
+touch files outside the scope documented in SECURITY.md.
+
+Availability of the source code under this Agreement does NOT make
+the Software open source. Open-source licenses grant redistribution
+rights; this Agreement does not.
+
+--------------------------------------------------------------------
+5. NO SUPPORT, NO UPDATES
+--------------------------------------------------------------------
+
+The Software is provided as-is at the time of purchase. The Licensor
+has no obligation to:
+
+  (a) provide technical support, bug fixes, or updates;
+  (b) maintain compatibility with future Python versions, operating
+      systems, or third-party libraries;
+  (c) respond to any communication regarding the Software.
+
+Any future updates, if ever released, are provided at the Licensor's
+sole discretion and do not extend the obligations of this Agreement.
+
+--------------------------------------------------------------------
+6. CONSUMER RIGHTS (EU/UK)
+--------------------------------------------------------------------
+
+If You are a consumer resident in the European Union or the United
+Kingdom, nothing in this Agreement limits or excludes any statutory
+right or remedy You have under applicable mandatory consumer law.
+
+In particular:
+
+  (a) RIGHT OF WITHDRAWAL (EU): You have the right to withdraw from
+      the purchase within fourteen (14) days of delivery, without
+      giving any reason, provided that You have not downloaded the
+      Software file. Once digital content has been downloaded, the
+      withdrawal right is typically waived under the EU Consumer
+      Rights Directive (2011/83/EU), Article 16(m), unless the
+      vendor has obtained Your prior express consent and
+      acknowledgement of that waiver.
+
+  (b) CONFORMITY: If the Software does not conform to its
+      description, You may be entitled to a remedy under the
+      applicable EU/UK consumer legislation.
+
+To exercise the right of withdrawal, follow the process documented
+in REFUND_POLICY.md.
+
+--------------------------------------------------------------------
+7. DISCLAIMER OF WARRANTY
+--------------------------------------------------------------------
+
+THE SOFTWARE IS PROVIDED "AS IS" AND "AS AVAILABLE", WITHOUT WARRANTY
+OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
+NON-INFRINGEMENT.
+
+THE LICENSOR DOES NOT WARRANT THAT:
+
+  (a) the Software will detect every issue in the scanned code;
+  (b) the Software will produce no false positives or false negatives;
+  (c) a clean scan means the scanned code is secure, correct, or
+      complete;
+  (d) the Software will run uninterrupted or error-free on every
+      environment.
+
+The Software is a pattern-based sanity checker. It is NOT a security
+audit, NOT a substitute for professional security review, and NOT a
+guarantee of code quality.
+
+--------------------------------------------------------------------
+8. LIMITATION OF LIABILITY
+--------------------------------------------------------------------
+
+TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE TOTAL
+AGGREGATE LIABILITY OF THE LICENSOR ARISING OUT OF OR RELATING TO
+THIS AGREEMENT OR THE SOFTWARE SHALL NOT EXCEED THE AMOUNT ACTUALLY
+PAID BY YOU FOR THE SOFTWARE.
+
+IN NO EVENT SHALL THE LICENSOR BE LIABLE FOR ANY INDIRECT,
+INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES, OR FOR ANY
+LOSS OF PROFITS, DATA, BUSINESS, OR GOODWILL, ARISING OUT OF OR
+RELATING TO THE USE OR INABILITY TO USE THE SOFTWARE.
+
+NOTHING IN THIS SECTION EXCLUDES OR LIMITS LIABILITY THAT CANNOT BE
+EXCLUDED OR LIMITED UNDER APPLICABLE MANDATORY LAW.
+
+--------------------------------------------------------------------
+9. TERMINATION
+--------------------------------------------------------------------
+
+This Agreement is effective until terminated. Your rights under this
+Agreement terminate automatically if You materially breach any of its
+terms. Upon termination, You must stop using the Software and delete
+all copies in Your possession or control.
+
+Sections 3, 4, 7, 8, 10, and 11 survive termination.
+
+--------------------------------------------------------------------
+10. GOVERNING LAW
+--------------------------------------------------------------------
+
+This Agreement is governed by the laws of England and Wales, without
+regard to its conflict of law rules. Any dispute that cannot be
+resolved amicably shall be subject to the exclusive jurisdiction of
+the courts of England and Wales, except that mandatory consumer
+protections in Your country of residence may grant You the right to
+bring proceedings in Your local courts.
+
+--------------------------------------------------------------------
+11. ENTIRE AGREEMENT
+--------------------------------------------------------------------
+
+This Agreement, together with TERMS_OF_USE.md, REFUND_POLICY.md, and
+SECURITY.md, constitutes the entire agreement between You and the
+Licensor concerning the Software.
+
+If any provision is held unenforceable, the remaining provisions
+remain in full force and effect.
+
+--------------------------------------------------------------------
+END OF LICENSE
+--------------------------------------------------------------------

codefence-1.0.0/LICENSE_FAQ.md

@@ -0,0 +1,83 @@
+# License FAQ
+
+CodeFence is **source-available**, not open source. This document
+answers the questions developers actually ask before adopting it.
+
+For the full legal terms, see LICENSE.txt and TERMS_OF_USE.md.
+
+---
+
+## Can I read the source code?
+
+Yes. The tool ships as a single readable Python file. You can open it,
+inspect every line, and verify that it performs no network calls,
+collects no telemetry, and writes only to the documented locations.
+
+## Can I modify the source?
+
+Yes, for private use. You can change rules, tune detection, or add
+your own checks. Your modifications stay yours. You may not
+redistribute modified versions.
+
+## Can I fork the repository?
+
+You may fork for personal use. You may not publish the fork, sell it,
+or offer it as a service. If you want to contribute back, open an
+issue or pull request on the upstream repository.
+
+## Can my company use it?
+
+Yes, but each developer who uses CodeFence on their own machine
+needs their own license. A single license covers one individual on
+up to three devices they own or control.
+
+## Can CI download and run it?
+
+Yes, if the CI job runs on behalf of a licensed user. The GitHub
+Action workflow installed by codefence init-github is designed
+for this. The workflow does not transmit source code to any third
+party; the scan runs locally in the CI runner.
+
+## Can I vendor the single file into my project?
+
+For private use on your own machine, yes. You may not redistribute
+it as part of your own product or bundle.
+
+## Can I offer CodeFence as a paid service?
+
+No. Scanning-as-a-service on a commercial basis is not permitted.
+
+## Can I redistribute my copy?
+
+No. Redistribution, resale, sublicensing, and bundling are all
+prohibited. If you find CodeFence useful and would like others to
+benefit, please point them to the official distribution channels.
+
+## What if I lost my copy?
+
+There is no license recovery process. This is intentional and part
+of the product design: no email, no chat, no support, no trackers.
+Keep your download.
+
+## Is this the same as open source?
+
+No. Open source licenses grant redistribution rights; this license
+does not. Source-available means you can read, study, and privately
+modify; it does not mean you can share or resell.
+
+## Why source-available and not open source?
+
+A security tool that hides its own behavior cannot be trusted. Source
+is shipped readable so that you can verify what it does. At the same
+time, this is a commercial product, and it is not intended to be
+repackaged by others under a different name.
+
+## What about the rules file (rules.json)?
+
+rules.json is part of the product and is covered by the same license.
+You may edit it for your own use. You may not redistribute it as a
+standalone rules package.
+
+---
+
+*End of License FAQ.*

codefence-1.0.0/NOTICE.md

@@ -0,0 +1,56 @@
+# Notice on Source Availability
+
+CodeFence is shipped as **human-readable source code**. This
+is a deliberate design decision, not an accident.
+
+## Why the source is readable
+
+1. **Trust.** A security tool that hides its own behavior cannot be
+   trusted. You can read every line before running it.
+
+2. **Auditability.** You can verify that the tool:
+   - performs **zero network calls**,
+   - collects **zero telemetry**,
+   - writes only to `--output` and (optionally) `~/.cache/codefence/`,
+   - never executes the code it scans.
+
+3. **Portability.** The tool is a single Python file with zero
+   third-party dependencies. You can read it, keep it, and run it
+   on any system with Python 3.10 or newer.
+
+## What this is not
+
+Being able to read the source does **not** make this open-source
+software. The license (`LICENSE.txt`) grants you the right to read,
+study, and privately modify the code, but **not** to redistribute it,
+resell it, bundle it, or offer it as a service.
+
+## What you may do
+
+- Read the source.
+- Audit the source.
+- Modify the source for your own personal use.
+- Run it on up to 3 devices that you own.
+
+## What you may not do
+
+- Publish the source.
+- Share it with others.
+- Sell it or bundle it.
+- Offer it as part of a commercial service.
+
+If you find the tool useful and would like others to benefit, please
+point them to the official purchase page rather than sharing your
+copy. This keeps the project sustainable.
+
+## A note on honesty
+
+The vendor of this product has made a deliberate choice to be
+transparent about what the tool does and does not do. The limitations
+listed in `README.md` and `SECURITY.md` are real. The tool does not
+claim to be a complete security solution. It claims to be a fast,
+offline, pattern-based sanity checker — nothing more, nothing less.
+
+---
+
+*End of Notice.*