cordon-scanner 0.1.0__tar.gz

cordon_scanner-0.1.0/CHANGELOG.md

@@ -0,0 +1,177 @@
+# Changelog
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+Versions follow [semantic versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-09-09
+
+First release. Everything below is in it; there is no earlier published
+version, so nothing here is a change from one.
+
+### Names
+
+The distribution is `cordon-scanner`, the console script is `cordon-scanner`,
+and the import package is `cordon_scanner`.
+
+Not `cordon` in any of the three. That name belongs on PyPI to an unrelated
+project which ships both a top-level `cordon` package and a `cordon` console
+script, so installing both into one environment has pip write two distributions
+into the same directory and leave whichever landed last. Configuration
+filenames (`cordon.yaml`), cache paths and the `CORDON_*` variables are
+unaffected -- they are not installed names and cannot collide.
+
+### Scanning
+
+- Scans a directory, a file or an archive across eight package ecosystems, with
+  no third-party runtime dependencies and no network access.
+- `--staged`, `--tracked` and `--git-diff REF`, through a file-source
+  abstraction. Staged mode reads blobs from the git index rather than the
+  working tree, so a payload cannot be staged and the clean copy restored.
+- Findings in five categories with independent severity and confidence axes.
+  `MALICIOUS` at `CONFIRMED` confidence is reachable only through an exact
+  package-and-version match against the advisory database.
+- `text`, `json`, `sarif`, `markdown` and `junit` output.
+- A live progress line on standard error while a scan runs, showing the phase,
+  the count and the current file. On only when standard error is an
+  interactive terminal; `--progress always|never` overrides that. It is on
+  standard error so it stays out of the report a pipeline parses, and the paths
+  it shows are escaped, because a filename may legally contain an ANSI control
+  sequence or a bidirectional override. The line is measured in terminal
+  columns rather than code points, so a CJK or emoji filename does not wrap.
+- Incremental cache keyed on content, configuration and detector identity, with
+  every entry authenticated by a per-machine HMAC.
+- `cordon-scanner baseline create|compare` and `scan --baseline PATH`, so the tool can
+  be adopted on a repository that is not clean yet.
+- `cordon-scanner rules`, `cordon-scanner config`, `cordon-scanner inventory`, `cordon-scanner report` and
+  `cordon-scanner guard`, plus `python -m cordon_scanner_scanner`.
+
+### Not looking is reported as not looking
+
+The invariant the design is built around: a scan that examined nothing must
+never report like a scan that found nothing.
+
+- Configuration supplied by the scan target cannot exclude paths, disable
+  detectors or disable rules without that appearing in the report at a severity
+  the default gate fails on.
+- A scan that examined no files fails, whether the files were excluded, removed
+  by the selected source, or could not be read.
+- Truncated files, per-file and whole-scan timeouts, memory and path limits,
+  rejected archive members and detector failures are each reported and mark the
+  scan incomplete.
+- Reporting thresholds cannot hide a finding from the failure gate.
+- Organisation policy acts as a ceiling that command-line overrides are
+  re-checked against.
+
+### Not becoming the leak
+
+- Evidence is redacted at construction, never at render time, so unredacted
+  content never reaches a reporter. Secret-category rules cannot opt out.
+- Package coordinates are bounded at the model, so a parser that reads past the
+  field it wanted cannot publish the rest of the line.
+- Reports carry no absolute filesystem paths.
+
+### Not executing the target
+
+- Manifests and lockfiles are parsed, never invoked; `setup.py` is read through
+  `ast.parse` and nothing in it is evaluated.
+- Git runs with system and global configuration disabled and with every
+  configuration key that names an external command neutralised, so a
+  repository cannot execute code through the scan that examines it.
+- Rule patterns are validated by walking the parsed regex, so nesting,
+  lookaheads and non-capturing groups cannot hide a catastrophic shape. Every
+  pattern compiled inside the package is held to the same rule by test.
+- File loading opens with `O_NOFOLLOW` and checks the descriptor, closing a
+  time-of-check/time-of-use window. Symbolic links are recorded, never
+  followed.
+- A third-party distribution cannot shadow a built-in detector.
+
+### The Action
+
+- Installs with `--require-hashes` against `action/requirements.txt`, generated
+  at release time from the artefacts actually published. Pinning the Action to
+  a commit SHA covers `action.yml` only; without this it says nothing about
+  what pip downloads, and a compromised index or release account would replace
+  the scanner in every workflow using it.
+- A ref carrying no pin refuses to install rather than installing unverified.
+  `allow-unverified-install: true` overrides that in the workflow file, where
+  it is reviewable, and warns about what it gives up.
+- Every action referenced by this project's own workflows is pinned to a commit
+  digest, enforced by test rather than by review.
+
+### Rule kinds
+
+`MatchKind` declares `ast`, `structural` and `graph`, and nothing implements
+them. A rule pack using one is refused at load with a message saying so, rather
+than accepted and silently unable to match. A rule that never fires looks
+exactly like a rule that found nothing, which is the failure this project is
+organised around, applied to rules.
+
+### Air-gapped installation
+
+- `cordon-scanner bundle create|verify|install` moves a release across an air
+  gap with the transfer made checkable. The bundle carries a `MANIFEST.sha256`
+  in `sha256sum` format, so an operator who distrusts it does not have to run
+  the program inside it to decide whether to trust it.
+- `verify` fails closed on a modified file, a missing file, an unlisted extra
+  file, a traversal member, a symlink, or a missing manifest. `install`
+  verifies first and writes nothing if verification fails.
+- It reports what it did *not* prove: the manifest shows the bundle is the one
+  its own manifest describes, not who produced it. That comes from the detached
+  signature made at release.
+
+### Organisation policy distribution
+
+- `--policy` accepts a URL, which must carry a `#sha256=` digest. Without one
+  it is refused: an organisation policy is the ceiling, so whoever controls the
+  network would otherwise control whether the ceiling exists.
+- Fetching requires `--allow-network`, the only network operation the tool has.
+  Scanning never uses the network.
+- Verified policies are cached by digest, so the second scan on a machine needs
+  no network and an air-gapped site can populate the cache by hand. The digest
+  is re-checked on every use, because the cache is an ordinary directory other
+  processes can write.
+- HTTPS only, a 1 MB cap, and nothing is cached when verification fails.
+
+### Audit
+
+- `--audit-log PATH` appends one JSON line per scan: the rule pack and
+  configuration hashes, the commit, counts by severity, whether the scan
+  completed, the exit code, and every suppression that applied with its
+  justification, approver and expiry. Never file content.
+- A git remote is recorded with its credential stripped. Every CI checkout
+  looks like `https://x-access-token:<token>@host/org/repo.git`, and an audit
+  log is retained longer and read by more people than a report.
+- An unwritable path is refused before the scan runs, not after it.
+- `Repository.revision` and `remote` are now populated. They were declared,
+  serialised into every report and SARIF upload, and never set, so results
+  recorded `null` for the two fields that say which code was examined.
+
+### Release integrity
+
+- Every release carries a CycloneDX and an SPDX SBOM, generated from packaging
+  metadata rather than restated, and recording the digests of the exact files
+  published. The dependency list is empty and that is the point: the claim is
+  checkable rather than asserted.
+- Artefacts and both SBOMs are signed with Sigstore keyless signing, so there
+  is no signing key to protect, rotate or leak.
+- SLSA build provenance is attested for each artefact, and PyPI receives PEP
+  740 attestations, so an installer can ask not only whether the project signed
+  something but whether it was built by the process the project describes.
+- Builds set `SOURCE_DATE_EPOCH`, so a third party can rebuild from the tag and
+  compare digests with the SBOM.
+
+### Known limits
+
+- The bundled advisory database is deliberately small and covers documented
+  supply-chain incidents. It is not a substitute for a feed; load one with
+  `--advisories`.
+- Semantic (`ast`), structural and graph rule kinds are not implemented, and a
+  pack declaring one is refused rather than silently ignored. There is no
+  `[ast]` extra: it declared two packages nothing imported, which do not work
+  together at their current releases, for a feature that does not exist.
+- The source distribution ships `corpus/benign`, so the false-positive suite
+  runs downstream, and not `corpus/malicious`. The detection suite therefore
+  skips from an sdist and says so; clone the repository at the release tag to
+  run it.
+- The YAML accepted in configuration is a restricted subset: no anchors,
+  aliases or tags.

cordon_scanner-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing
+
+## Getting set up
+
+```bash
+git clone https://github.com/Threx-code/cordon
+cd cordon
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev]"
+
+pytest -q
+ruff check src/ tests/
+ruff format --check src/ tests/
+cordon-scanner scan .            # the tool scans its own repository
+```
+
+Python 3.11 or newer. There are no runtime dependencies and there will not be
+any: it is what makes the air-gapped story real, and every proposal to add one
+should assume it will be refused.
+
+## What a change needs
+
+**A test that fails without it.** For a bug fix, the test should reproduce the
+bug. For a detection change, add a sample to `corpus/` or an inline rule sample.
+
+**A reason in the code.** Comments and docstrings here explain *why* a decision
+was made, not what the line does. A change that alters a security property
+should say what it prevents and what it costs.
+
+**No new runtime dependency.**
+
+**Coverage at or above 85 percent**, which CI enforces.
+
+## Adding a detection rule
+
+Rules live in `src/cordon_scanner/rules/builtin/` as YAML and are data, not code:
+
+```bash
+cordon-scanner rules list                  # what exists
+cordon-scanner rules show RULE.ID          # one rule in full
+cordon-scanner rules test                  # every rule's own samples
+```
+
+Every rule declares at least one positive and one negative sample, and the
+loader refuses a pack without them. A rule that parses, compiles, loads and
+matches nothing is the failure a detection tool cannot see from the inside, so
+the samples are what make an inert rule impossible to ship.
+
+`confidence: high` additionally requires a zero baseline over `corpus/benign`.
+
+Patterns are validated at load time and refused if they can backtrack
+catastrophically. If yours is rejected, rewrite it rather than working around
+the check: Python's `re` cannot be interrupted mid-match, so nothing downstream
+can bound a pathological pattern.
+
+## Reporting a false positive
+
+Open an issue with the smallest file that triggers it and the output of
+`cordon-scanner rules show <RULE.ID>`. False positives are treated as seriously as
+missed detections: a tool people mute is a tool that detects nothing.
+
+## Security issues
+
+Do not open a public issue. See [SECURITY.md](SECURITY.md).
+
+## Licence
+
+Contributions are accepted under Apache-2.0, matching the project.

cordon_scanner-0.1.0/LICENSE

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

cordon_scanner-0.1.0/MANIFEST.in

@@ -0,0 +1,47 @@
+# What goes into the source distribution beyond the package itself.
+#
+# A wheel carries the importable package; an sdist is what a distribution
+# packager, an auditor, or anyone rebuilding from source actually receives. For
+# a security tool that gap matters more than usual: without the tests, nobody
+# downstream can verify that the copy they were handed behaves the way the
+# project claims, and re-running the suite is the only check that does not
+# require trusting this repository.
+
+include LICENSE
+include README.md
+include CHANGELOG.md
+include requirements-build.txt
+include SECURITY.md
+include CONTRIBUTING.md
+
+recursive-include tests *.py *.yaml *.yml *.json *.toml
+
+# The benign corpus, which is ordinary source that must produce nothing above
+# `low`. Shipping it lets a downstream packager run the false-positive suite,
+# which is half of what decides whether this product works.
+#
+# `corpus/malicious` is deliberately not shipped. Those fixtures are inert and
+# point only at reserved domains, but they are the shapes a package index's own
+# malware scanning looks for in an sdist. The detection suite therefore skips
+# from an sdist and says so; clone the repository at the release tag to run it.
+recursive-include corpus/benign *
+recursive-include docs *.md
+recursive-include docs/assets *.svg
+recursive-include action *.yml
+
+# The release tooling. Shipped for the same reason the tests are: six tests
+# exercise `generate_sbom.py`, and without it the suite an sdist consumer runs
+# is not the suite this project runs -- it errors on a missing file rather than
+# verifying anything. A packager rebuilding from source also needs it to
+# regenerate the bill of materials for their own build.
+recursive-include scripts *.py
+
+recursive-include src/cordon_scanner/rules/builtin *.yaml
+include src/cordon_scanner/py.typed
+
+# Never shipped: caches, build output and editor state carry nothing a consumer
+# of the sdist can use, and a stale one is a way to ship a file nobody reviewed.
+global-exclude __pycache__ *.py[cod] .DS_Store
+prune .github
+prune reviews
+prune .venv

cordon_scanner-0.1.0/NOTICE

@@ -0,0 +1,26 @@
+Cordon
+Copyright 2026 Cordon Contributors
+
+This product includes software developed by the Cordon 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.
+
+-------------------------------------------------------------------------------
+Third-party data
+
+The Cordon engine has no third-party runtime dependencies.
+
+Rule packs and threat-intelligence databases distributed alongside Cordon may
+incorporate third-party data under separate terms. Every pack declares its own
+`license` and `source` fields, and any pack whose licence is incompatible with
+Apache-2.0 is distributed separately rather than bundled with this
+distribution.