linebreak-gate 1.0.0__tar.gz

linebreak_gate-1.0.0/.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+dist/
+*.egg-info/

linebreak_gate-1.0.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 [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.

linebreak_gate-1.0.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: linebreak-gate
+Version: 1.0.0
+Summary: LineBreak security gate at the git/CI boundary: dependency CVE scan + AI SAST, human-approved overrides, git-native audit records
+Project-URL: Homepage, https://linebreakapp.com
+Project-URL: Source, https://github.com/Baktun-Studio/linebreak-gate
+Project-URL: Documentation, https://github.com/Baktun-Studio/linebreak-gate#readme
+Author: Baktun Studio
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ci,cve,osv-scanner,sast,security,supply-chain
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Requires-Python: >=3.11
+Requires-Dist: anthropic>=0.40.0
+Requires-Dist: pyyaml<7.0,>=6.0
+Description-Content-Type: text/markdown
+
+# linebreak-gate — the LineBreak security gate at the git/CI boundary
+
+Blocks merges that carry known vulnerabilities. One tool, two detectors:
+
+- **Dependency CVE scan** — [osv-scanner](https://google.github.io/osv-scanner/)
+  across every ecosystem (npm, PyPI, Go, Cargo, Maven, …), with an `npm audit`
+  fallback for npm projects (npm-only coverage and no installed-version data —
+  the GitHub Action fails closed if osv-scanner can't be installed instead of
+  degrading to it).
+- **AI SAST** — an LLM security review of first-party source (injection,
+  broken auth, secret exposure, SSRF, unsafe deserialization, crypto misuse)
+  with adversarial verification, enabled by `ANTHROPIC_API_KEY`.
+
+The gate **blocks and can propose; it never auto-clears on an agent's
+say-so**. A human approves the fix or records an override — with a reason and
+an approver — in a git-committed audit file.
+
+This is the same scanner core that powers the LineBreak desktop app's in-app
+security gate (the desktop backend imports this package), but it is fully
+standalone: a team that has never opened the desktop app can add the gate to
+their repo and get real enforcement.
+
+> **Where this code lives.** Development happens in the LineBreak monorepo
+> (`packages/gate`); every green change to it is automatically mirrored to
+> [`Baktun-Studio/linebreak-gate`](https://github.com/Baktun-Studio/linebreak-gate)
+> (the public repo the Action snippet uses) and published to PyPI as
+> [`linebreak-gate`](https://pypi.org/project/linebreak-gate/). Never edit the
+> mirror directly — the next sync overwrites it. Licensed Apache-2.0.
+
+## Quickstart — GitHub Actions
+
+```yaml
+# .github/workflows/security-gate.yml
+name: Security gate
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write # for the summary comment
+
+jobs:
+  gate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: Baktun-Studio/linebreak-gate@v1
+        with:
+          # fail-on: high                                  # default: critical
+          license-key: ${{ secrets.LINEBREAK_LICENSE_KEY }} # optional today
+          anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }} # enables AI SAST
+```
+
+The action runs `linebreak-gate scan`, always runs `report`, posts **one** PR
+comment (updated in place on every push, never spammed), uploads the JSON
+report + audit artifacts as a workflow artifact, and fails the check per the
+scan's exit code.
+
+### Make it a real boundary: require the check
+
+A CI job that can be ignored is a dashboard, not a gate. In your repo:
+
+**Settings → Branches → Branch protection rules → your default branch →
+"Require status checks to pass before merging"** → add the `gate` job (the
+name of the job that runs this action). From then on a PR carrying a critical
+CVE cannot be merged through the GitHub UI.
+
+## Quickstart — any other CI (GitLab example)
+
+The CLI is a plain Python package with strict exit codes — `0` pass, `1`
+blocking findings, `2` tool/config error (**fail closed**: a scanner crash
+fails the pipeline, it is never a clean pass). Any CI that respects exit codes
+gets the same enforcement:
+
+```yaml
+# .gitlab-ci.yml
+security-gate:
+  image: python:3.11
+  script:
+    - pip install linebreak-gate
+    - curl -fsSL -o /usr/local/bin/osv-scanner
+      "$(curl -fsSL https://api.github.com/repos/google/osv-scanner/releases/latest
+      | python -c "import json,sys;print(next(a['browser_download_url'] for a in json.load(sys.stdin)['assets'] if a['name'].endswith('linux_amd64')))")"
+    - chmod +x /usr/local/bin/osv-scanner
+    - linebreak-gate scan
+    - linebreak-gate report
+```
+
+Mark the job as required (no `allow_failure`) and protect the branch.
+
+## CLI
+
+```text
+linebreak-gate scan     [--path .] [--fail-on critical|high|medium|low] [--format summary|json]
+linebreak-gate report   [--path .] [--format summary|json]
+linebreak-gate override --finding <id> --reason "…" --approver <name/email> [--path .]
+```
+
+- `scan` runs both detectors, writes git-native audit artifacts under
+  `.linebreak/audit/`, and exits 0/1/2.
+- `report` renders the recorded scan: counts by severity and every finding
+  with CVE id, CVSS, advisory link, and override status. `--format json` for
+  machines.
+- `override` records a human-approved acknowledgment of **one exact finding**
+  — the package + installed version + CVE tuple. A different CVE, a bumped
+  version, or a new finding still blocks. `--reason` and `--approver` are
+  required; the record lands in the artifact's approval trail. Commit the
+  updated `.linebreak/audit/*.json` so CI sees it.
+
+## Configuration — `.linebreak/gate.yml`
+
+The gate's strictness is governance, so it lives in the repo — changing the
+threshold is itself a PR: visible, reviewable, attributable in git history.
+
+```yaml
+# .linebreak/gate.yml
+fail_on: critical # critical (default) | high | medium | low
+exclude_paths: # optional: root-relative globs excluded from scanning
+  - fixtures
+  - "sandbox/*"
+code_scan: auto # auto (run when ANTHROPIC_API_KEY is set) | on (required) | off
+```
+
+Precedence: explicit `--fail-on` flag / Action input → `.linebreak/gate.yml` →
+built-in default (`critical`). An invalid config is a tool error (exit 2) —
+a broken governance file never silently falls back to a default.
+
+## Audit records
+
+Every scan and every override is recorded in `.linebreak/audit/security.json`
+(dependencies) and `.linebreak/audit/code.json` (AI SAST) — the same versioned
+document format the LineBreak desktop app writes, carrying findings (CVE id,
+CVSS, advisory link), scanner engine, timestamp, actor, and the approval trail
+with each override's reason + approver. Who relaxed the gate, and when, is
+itself auditable.
+
+## Licensing
+
+The gate reads `LINEBREAK_LICENSE_KEY` from the environment (the Action's
+`license-key` input). Entitlements currently default open: without a key the
+gate runs and prints a notice. The check is wired through LineBreak's
+entitlements provider, so flipping `LINEBREAK_ENTITLEMENTS_PROVIDER=remote`
+enforces licensing without a client change — set the key in CI secrets now so
+the gate keeps working then.

linebreak_gate-1.0.0/README.md

@@ -0,0 +1,144 @@
+# linebreak-gate — the LineBreak security gate at the git/CI boundary
+
+Blocks merges that carry known vulnerabilities. One tool, two detectors:
+
+- **Dependency CVE scan** — [osv-scanner](https://google.github.io/osv-scanner/)
+  across every ecosystem (npm, PyPI, Go, Cargo, Maven, …), with an `npm audit`
+  fallback for npm projects (npm-only coverage and no installed-version data —
+  the GitHub Action fails closed if osv-scanner can't be installed instead of
+  degrading to it).
+- **AI SAST** — an LLM security review of first-party source (injection,
+  broken auth, secret exposure, SSRF, unsafe deserialization, crypto misuse)
+  with adversarial verification, enabled by `ANTHROPIC_API_KEY`.
+
+The gate **blocks and can propose; it never auto-clears on an agent's
+say-so**. A human approves the fix or records an override — with a reason and
+an approver — in a git-committed audit file.
+
+This is the same scanner core that powers the LineBreak desktop app's in-app
+security gate (the desktop backend imports this package), but it is fully
+standalone: a team that has never opened the desktop app can add the gate to
+their repo and get real enforcement.
+
+> **Where this code lives.** Development happens in the LineBreak monorepo
+> (`packages/gate`); every green change to it is automatically mirrored to
+> [`Baktun-Studio/linebreak-gate`](https://github.com/Baktun-Studio/linebreak-gate)
+> (the public repo the Action snippet uses) and published to PyPI as
+> [`linebreak-gate`](https://pypi.org/project/linebreak-gate/). Never edit the
+> mirror directly — the next sync overwrites it. Licensed Apache-2.0.
+
+## Quickstart — GitHub Actions
+
+```yaml
+# .github/workflows/security-gate.yml
+name: Security gate
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write # for the summary comment
+
+jobs:
+  gate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: Baktun-Studio/linebreak-gate@v1
+        with:
+          # fail-on: high                                  # default: critical
+          license-key: ${{ secrets.LINEBREAK_LICENSE_KEY }} # optional today
+          anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }} # enables AI SAST
+```
+
+The action runs `linebreak-gate scan`, always runs `report`, posts **one** PR
+comment (updated in place on every push, never spammed), uploads the JSON
+report + audit artifacts as a workflow artifact, and fails the check per the
+scan's exit code.
+
+### Make it a real boundary: require the check
+
+A CI job that can be ignored is a dashboard, not a gate. In your repo:
+
+**Settings → Branches → Branch protection rules → your default branch →
+"Require status checks to pass before merging"** → add the `gate` job (the
+name of the job that runs this action). From then on a PR carrying a critical
+CVE cannot be merged through the GitHub UI.
+
+## Quickstart — any other CI (GitLab example)
+
+The CLI is a plain Python package with strict exit codes — `0` pass, `1`
+blocking findings, `2` tool/config error (**fail closed**: a scanner crash
+fails the pipeline, it is never a clean pass). Any CI that respects exit codes
+gets the same enforcement:
+
+```yaml
+# .gitlab-ci.yml
+security-gate:
+  image: python:3.11
+  script:
+    - pip install linebreak-gate
+    - curl -fsSL -o /usr/local/bin/osv-scanner
+      "$(curl -fsSL https://api.github.com/repos/google/osv-scanner/releases/latest
+      | python -c "import json,sys;print(next(a['browser_download_url'] for a in json.load(sys.stdin)['assets'] if a['name'].endswith('linux_amd64')))")"
+    - chmod +x /usr/local/bin/osv-scanner
+    - linebreak-gate scan
+    - linebreak-gate report
+```
+
+Mark the job as required (no `allow_failure`) and protect the branch.
+
+## CLI
+
+```text
+linebreak-gate scan     [--path .] [--fail-on critical|high|medium|low] [--format summary|json]
+linebreak-gate report   [--path .] [--format summary|json]
+linebreak-gate override --finding <id> --reason "…" --approver <name/email> [--path .]
+```
+
+- `scan` runs both detectors, writes git-native audit artifacts under
+  `.linebreak/audit/`, and exits 0/1/2.
+- `report` renders the recorded scan: counts by severity and every finding
+  with CVE id, CVSS, advisory link, and override status. `--format json` for
+  machines.
+- `override` records a human-approved acknowledgment of **one exact finding**
+  — the package + installed version + CVE tuple. A different CVE, a bumped
+  version, or a new finding still blocks. `--reason` and `--approver` are
+  required; the record lands in the artifact's approval trail. Commit the
+  updated `.linebreak/audit/*.json` so CI sees it.
+
+## Configuration — `.linebreak/gate.yml`
+
+The gate's strictness is governance, so it lives in the repo — changing the
+threshold is itself a PR: visible, reviewable, attributable in git history.
+
+```yaml
+# .linebreak/gate.yml
+fail_on: critical # critical (default) | high | medium | low
+exclude_paths: # optional: root-relative globs excluded from scanning
+  - fixtures
+  - "sandbox/*"
+code_scan: auto # auto (run when ANTHROPIC_API_KEY is set) | on (required) | off
+```
+
+Precedence: explicit `--fail-on` flag / Action input → `.linebreak/gate.yml` →
+built-in default (`critical`). An invalid config is a tool error (exit 2) —
+a broken governance file never silently falls back to a default.
+
+## Audit records
+
+Every scan and every override is recorded in `.linebreak/audit/security.json`
+(dependencies) and `.linebreak/audit/code.json` (AI SAST) — the same versioned
+document format the LineBreak desktop app writes, carrying findings (CVE id,
+CVSS, advisory link), scanner engine, timestamp, actor, and the approval trail
+with each override's reason + approver. Who relaxed the gate, and when, is
+itself auditable.
+
+## Licensing
+
+The gate reads `LINEBREAK_LICENSE_KEY` from the environment (the Action's
+`license-key` input). Entitlements currently default open: without a key the
+gate runs and prints a notice. The check is wired through LineBreak's
+entitlements provider, so flipping `LINEBREAK_ENTITLEMENTS_PROVIDER=remote`
+enforces licensing without a client change — set the key in CI secrets now so
+the gate keeps working then.