pqblocks-agility 0.1.0__tar.gz

pqblocks_agility-0.1.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 2026 The PQBlocks Authors
+
+   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.

pqblocks_agility-0.1.0/NOTICE

@@ -0,0 +1,7 @@
+pqblocks-agility
+Copyright 2026 The PQBlocks Authors
+
+This product is part of PQBlocks (https://github.com/PQBlocks).
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+

pqblocks_agility-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: pqblocks-agility
+Version: 0.1.0
+Summary: Cryptographic Agility Readiness Scoring (CARS) and CI/CD regression firewall for CycloneDX 1.6 CBOM inventories.
+Author: The PQBlocks Authors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/PQBlocks/crypto-agility
+Project-URL: Documentation, https://github.com/PQBlocks/crypto-agility#readme
+Project-URL: Source, https://github.com/PQBlocks/crypto-agility
+Project-URL: Changelog, https://github.com/PQBlocks/crypto-agility/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/PQBlocks/crypto-agility/issues
+Project-URL: Security, https://github.com/PQBlocks/crypto-agility/security/policy
+Keywords: cbom,cars,crypto-agility,cyclonedx,sarif,ci-gate,post-quantum,pqc
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security :: Cryptography
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: click
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# pqblocks-agility
+
+Computes Cryptographic Agility Readiness Scores (CARS) and acts as a CI/CD regression firewall for CycloneDX 1.6 Cryptographic Bills of Materials (CBOM).
+Use it to quantitatively measure how easily your codebase can transition away from deprecated classical cryptography to post-quantum standards, and fail pull requests that re-introduce quantum-vulnerable primitives.
+Implements the 5-dimension CARS model (Costa, IACR ePrint 2026/1467) and OASIS SARIF 2.1.0 telemetry export.
+
+```bash
+pip install pqblocks-agility
+```
+
+```python
+import json
+from pqblocks_agility.cbom import parse_cbom_dict
+from pqblocks_agility.cli import compute_cars_score
+
+cbom_data = {
+    "bomFormat": "CycloneDX", "specVersion": "1.6",
+    "serialNumber": "urn:uuid:6c361972-23c3-4d4b-9721-a47fa266184a", "version": 1,
+    "components": [{"type": "cryptographic-asset", "name": "ML-KEM-768",
+                    "properties": [{"name": "pqblocks-scan.algorithm", "value": "ML-KEM-768"},
+                                   {"name": "pqblocks-scan.grade", "value": "A"}]}]
+}
+score, dims = compute_cars_score(parse_cbom_dict(cbom_data))
+print(f"CARS score: {score:.1f} / 100.0 (Grade A)")
+```
+
+From the command line:
+
+```bash
+# Evaluate agility score from a CBOM (exit 1 below --min-cars)
+pqblocks-agility evaluate --cbom cbom.json --json-out summary.json
+
+# Gate a GitHub Pull Request against regression
+pqblocks-agility gate --cbom cbom.json --diff-file pr.diff --fail-on-regression --min-cars 60.0 --sarif-out results.sarif
+```
+
+Exit codes: `0` pass, `1` policy failure (score below threshold, a Grade-F component, or a regression), `2` usage or input error (missing or malformed CBOM, missing or unparsable diff, bad option value).
+
+---
+
+## Why PQBlocks
+
+- **Standardized scoring:** Implements the formal 5-dimension weighted composite model ($w = [0.20, 0.25, 0.25, 0.15, 0.15]$) covering inventory completeness, algorithm compliance, decoupling, toolchains, and governance.
+- **CI/CD regression firewall:** Prevents pull requests from slipping deprecated classical algorithms (MD5, SHA-1, 1024-bit RSA) into repositories with established migration thresholds.
+- **GitHub Advanced Security integration:** Emits standard SARIF 2.1.0 logs uploaded directly to GitHub Code Scanning or GitLab Security dashboards.
+- **Pure Python:** No native C libraries or GPU requirements. Runs in milliseconds on standard CI runners.
+
+---
+
+## Usage
+
+### Command Line Interface
+
+```bash
+pqblocks-agility [OPTIONS] COMMAND [ARGS]...
+```
+
+Commands:
+- `evaluate [OPTIONS]`: Evaluates CARS score and dimension breakdowns from a CycloneDX 1.6 CBOM.
+  - `--cbom PATH`: Path to CycloneDX 1.6 CBOM JSON.
+  - `--profile [default|cloud-enterprise|embedded-iot]`: Weight distribution profile.
+  - `--d1-mode [scenario|empirical]`: Inventory completeness estimation mode.
+  - `--min-cars FLOAT`: Exit 1 when the score is below this (0-100, default: 56.0).
+  - `--json-out PATH`, `--sarif-out PATH`, `--gitlab-report PATH`: Report outputs.
+- `gate [OPTIONS]`: Enforces CI/CD gate policies on CBOM and git diffs.
+  - `--cbom PATH`: Path to CycloneDX 1.6 CBOM JSON.
+  - `--diff-file PATH` / `--diff-base REF`: Diff source for the regression firewall.
+  - `--fail-on-regression`: Enable the regression firewall (off by default). Requires `--diff-file` or `--diff-base`; a missing or unparsable diff exits 2, never passes.
+  - `--allow-disallowed`: Do not fail on Grade-F components. By default any Grade-F component fails the gate.
+  - `--min-cars FLOAT`: Minimum CARS score threshold, 0-100 (default: 56.0).
+  - `--sarif-out PATH`, `--json-out PATH`: Report outputs.
+- `check-staged [OPTIONS]`: Pre-commit hook scanning staged blobs (`git show :path`) for private-key material and FIPS-disallowed primitive names (regex heuristics; exits 1 on a hit and never prints matched content).
+- `scan [OPTIONS] SOURCE_DIR`: Writes an empty baseline CBOM template. It does not inspect SOURCE_DIR; an empty inventory is not evidence that no crypto exists.
+
+---
+
+## CARS 5-Dimension Agility Model
+
+The readiness score is calculated as a weighted composite:
+$$\text{CARS} = 100 \sum_{i=1}^5 w_i d_i$$
+
+| Dimension | Meaning | Metric Basis |
+|---|---|---|
+| $d_1$ ($w_1 = 0.20$) | Inventory Completeness | Ratio of discovered components vs repository complexity |
+| $d_2$ ($w_2 = 0.25$) | Algorithm Compliance | Mean algorithm grade ($A=1.0, B=0.85, C=0.60, D=0.30, E/F=0.0$) |
+| $d_3$ ($w_2 = 0.25$) | Architectural Decoupling | Ratio of abstracted vs hardcoded direct cryptographic call sites |
+| $d_4$ ($w_4 = 0.15$) | Toolchain Readiness | CI/CD automation and automated scanning integration |
+| $d_5$ ($w_5 = 0.15$) | Governance Alignment | Sunset planning, cryptographic migration policies |
+
+Score tiers:
+Tiers as implemented in `ci_gate.get_cars_tier`: Critical $\le 30$, At-Risk $\le 55$, Transitional $\le 75$, Advanced $\le 90$, Ready $> 90$.
+
+---
+
+## API Reference
+
+| Module | Function / Class | Purpose |
+|---|---|---|
+| `pqblocks_agility.cbom` | `parse_cbom(path: str) -> CBOM` | Parse a CycloneDX 1.6 CBOM file into a structured dataclass |
+| | `parse_cbom_dict(data: dict) -> CBOM` | Parse a CBOM dictionary in-memory |
+| | `CBOM`, `CBOMComponent` | Dataclasses holding components, algorithm properties, and grades |
+| `pqblocks_agility.cars_scoring` | `compute_cars_score(cbom, profile, d1_mode) -> (float, dict)` | The single CARS implementation (CLI and API); `score_cbom(cbom)` is the default-profile alias |
+| `pqblocks_agility.ci_gate` | `evaluate_gate(cbom, min_cars, diff, ..., allow_disallowed=False)` | Evaluate gate policy (score, Grade-F, regression firewall); raises `DiffError` on an unparsable diff |
+| `pqblocks_agility.sarif_export` | `export_sarif(cbom, score, dimensions, ...)` | Generate SARIF 2.1.0 telemetry dictionary |
+| `pqblocks_agility.ast_decoupling` | `compute_d3(cbom: CBOM) -> float` | Evaluate AST decoupling ratios from call site metadata |
+
+---
+
+## Limitations
+
+- **CycloneDX 1.6 required:** CycloneDX 1.4/1.5/1.7 files are rejected (`CBOMVersionError`).
+- **Static analysis heuristic:** $d_3$ evaluates AST call sites and configuration locations. It does not trace dynamic object loading or C shared-object symbol resolution.
+- **Dimensions $d_1, d_4, d_5$ defaults:** In standalone offline CBOM evaluation, $d_1, d_4, d_5$ default to 0.50 scenario mode unless explicit CI flags or empirical scans are supplied.
+- **Not a cryptographic engine:** Does not perform encryption, decryption, or signing.
+
+---
+
+## Security Notes
+
+See [SECURITY_NOTES.md](SECURITY_NOTES.md) for details on AST parsing limits, denial of service mitigation, and dependency integrity.
+
+## Verification
+
+[TESTING.md](TESTING.md) · [BENCHMARKS.md](BENCHMARKS.md) · [EVIDENCE.md](EVIDENCE.md) · [VERIFICATION_REPORT.md](VERIFICATION_REPORT.md) · [USE_CASES.md](USE_CASES.md)
+
+## Part of PQBlocks
+
+[PQBlocks](https://github.com/PQBlocks) builds modular, verified building blocks for post-quantum cryptographic transitions.

pqblocks_agility-0.1.0/README.md

@@ -0,0 +1,128 @@
+# pqblocks-agility
+
+Computes Cryptographic Agility Readiness Scores (CARS) and acts as a CI/CD regression firewall for CycloneDX 1.6 Cryptographic Bills of Materials (CBOM).
+Use it to quantitatively measure how easily your codebase can transition away from deprecated classical cryptography to post-quantum standards, and fail pull requests that re-introduce quantum-vulnerable primitives.
+Implements the 5-dimension CARS model (Costa, IACR ePrint 2026/1467) and OASIS SARIF 2.1.0 telemetry export.
+
+```bash
+pip install pqblocks-agility
+```
+
+```python
+import json
+from pqblocks_agility.cbom import parse_cbom_dict
+from pqblocks_agility.cli import compute_cars_score
+
+cbom_data = {
+    "bomFormat": "CycloneDX", "specVersion": "1.6",
+    "serialNumber": "urn:uuid:6c361972-23c3-4d4b-9721-a47fa266184a", "version": 1,
+    "components": [{"type": "cryptographic-asset", "name": "ML-KEM-768",
+                    "properties": [{"name": "pqblocks-scan.algorithm", "value": "ML-KEM-768"},
+                                   {"name": "pqblocks-scan.grade", "value": "A"}]}]
+}
+score, dims = compute_cars_score(parse_cbom_dict(cbom_data))
+print(f"CARS score: {score:.1f} / 100.0 (Grade A)")
+```
+
+From the command line:
+
+```bash
+# Evaluate agility score from a CBOM (exit 1 below --min-cars)
+pqblocks-agility evaluate --cbom cbom.json --json-out summary.json
+
+# Gate a GitHub Pull Request against regression
+pqblocks-agility gate --cbom cbom.json --diff-file pr.diff --fail-on-regression --min-cars 60.0 --sarif-out results.sarif
+```
+
+Exit codes: `0` pass, `1` policy failure (score below threshold, a Grade-F component, or a regression), `2` usage or input error (missing or malformed CBOM, missing or unparsable diff, bad option value).
+
+---
+
+## Why PQBlocks
+
+- **Standardized scoring:** Implements the formal 5-dimension weighted composite model ($w = [0.20, 0.25, 0.25, 0.15, 0.15]$) covering inventory completeness, algorithm compliance, decoupling, toolchains, and governance.
+- **CI/CD regression firewall:** Prevents pull requests from slipping deprecated classical algorithms (MD5, SHA-1, 1024-bit RSA) into repositories with established migration thresholds.
+- **GitHub Advanced Security integration:** Emits standard SARIF 2.1.0 logs uploaded directly to GitHub Code Scanning or GitLab Security dashboards.
+- **Pure Python:** No native C libraries or GPU requirements. Runs in milliseconds on standard CI runners.
+
+---
+
+## Usage
+
+### Command Line Interface
+
+```bash
+pqblocks-agility [OPTIONS] COMMAND [ARGS]...
+```
+
+Commands:
+- `evaluate [OPTIONS]`: Evaluates CARS score and dimension breakdowns from a CycloneDX 1.6 CBOM.
+  - `--cbom PATH`: Path to CycloneDX 1.6 CBOM JSON.
+  - `--profile [default|cloud-enterprise|embedded-iot]`: Weight distribution profile.
+  - `--d1-mode [scenario|empirical]`: Inventory completeness estimation mode.
+  - `--min-cars FLOAT`: Exit 1 when the score is below this (0-100, default: 56.0).
+  - `--json-out PATH`, `--sarif-out PATH`, `--gitlab-report PATH`: Report outputs.
+- `gate [OPTIONS]`: Enforces CI/CD gate policies on CBOM and git diffs.
+  - `--cbom PATH`: Path to CycloneDX 1.6 CBOM JSON.
+  - `--diff-file PATH` / `--diff-base REF`: Diff source for the regression firewall.
+  - `--fail-on-regression`: Enable the regression firewall (off by default). Requires `--diff-file` or `--diff-base`; a missing or unparsable diff exits 2, never passes.
+  - `--allow-disallowed`: Do not fail on Grade-F components. By default any Grade-F component fails the gate.
+  - `--min-cars FLOAT`: Minimum CARS score threshold, 0-100 (default: 56.0).
+  - `--sarif-out PATH`, `--json-out PATH`: Report outputs.
+- `check-staged [OPTIONS]`: Pre-commit hook scanning staged blobs (`git show :path`) for private-key material and FIPS-disallowed primitive names (regex heuristics; exits 1 on a hit and never prints matched content).
+- `scan [OPTIONS] SOURCE_DIR`: Writes an empty baseline CBOM template. It does not inspect SOURCE_DIR; an empty inventory is not evidence that no crypto exists.
+
+---
+
+## CARS 5-Dimension Agility Model
+
+The readiness score is calculated as a weighted composite:
+$$\text{CARS} = 100 \sum_{i=1}^5 w_i d_i$$
+
+| Dimension | Meaning | Metric Basis |
+|---|---|---|
+| $d_1$ ($w_1 = 0.20$) | Inventory Completeness | Ratio of discovered components vs repository complexity |
+| $d_2$ ($w_2 = 0.25$) | Algorithm Compliance | Mean algorithm grade ($A=1.0, B=0.85, C=0.60, D=0.30, E/F=0.0$) |
+| $d_3$ ($w_2 = 0.25$) | Architectural Decoupling | Ratio of abstracted vs hardcoded direct cryptographic call sites |
+| $d_4$ ($w_4 = 0.15$) | Toolchain Readiness | CI/CD automation and automated scanning integration |
+| $d_5$ ($w_5 = 0.15$) | Governance Alignment | Sunset planning, cryptographic migration policies |
+
+Score tiers:
+Tiers as implemented in `ci_gate.get_cars_tier`: Critical $\le 30$, At-Risk $\le 55$, Transitional $\le 75$, Advanced $\le 90$, Ready $> 90$.
+
+---
+
+## API Reference
+
+| Module | Function / Class | Purpose |
+|---|---|---|
+| `pqblocks_agility.cbom` | `parse_cbom(path: str) -> CBOM` | Parse a CycloneDX 1.6 CBOM file into a structured dataclass |
+| | `parse_cbom_dict(data: dict) -> CBOM` | Parse a CBOM dictionary in-memory |
+| | `CBOM`, `CBOMComponent` | Dataclasses holding components, algorithm properties, and grades |
+| `pqblocks_agility.cars_scoring` | `compute_cars_score(cbom, profile, d1_mode) -> (float, dict)` | The single CARS implementation (CLI and API); `score_cbom(cbom)` is the default-profile alias |
+| `pqblocks_agility.ci_gate` | `evaluate_gate(cbom, min_cars, diff, ..., allow_disallowed=False)` | Evaluate gate policy (score, Grade-F, regression firewall); raises `DiffError` on an unparsable diff |
+| `pqblocks_agility.sarif_export` | `export_sarif(cbom, score, dimensions, ...)` | Generate SARIF 2.1.0 telemetry dictionary |
+| `pqblocks_agility.ast_decoupling` | `compute_d3(cbom: CBOM) -> float` | Evaluate AST decoupling ratios from call site metadata |
+
+---
+
+## Limitations
+
+- **CycloneDX 1.6 required:** CycloneDX 1.4/1.5/1.7 files are rejected (`CBOMVersionError`).
+- **Static analysis heuristic:** $d_3$ evaluates AST call sites and configuration locations. It does not trace dynamic object loading or C shared-object symbol resolution.
+- **Dimensions $d_1, d_4, d_5$ defaults:** In standalone offline CBOM evaluation, $d_1, d_4, d_5$ default to 0.50 scenario mode unless explicit CI flags or empirical scans are supplied.
+- **Not a cryptographic engine:** Does not perform encryption, decryption, or signing.
+
+---
+
+## Security Notes
+
+See [SECURITY_NOTES.md](SECURITY_NOTES.md) for details on AST parsing limits, denial of service mitigation, and dependency integrity.
+
+## Verification
+
+[TESTING.md](TESTING.md) · [BENCHMARKS.md](BENCHMARKS.md) · [EVIDENCE.md](EVIDENCE.md) · [VERIFICATION_REPORT.md](VERIFICATION_REPORT.md) · [USE_CASES.md](USE_CASES.md)
+
+## Part of PQBlocks
+
+[PQBlocks](https://github.com/PQBlocks) builds modular, verified building blocks for post-quantum cryptographic transitions.

pqblocks_agility-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pqblocks-agility"
+version = "0.1.0"
+description = "Cryptographic Agility Readiness Scoring (CARS) and CI/CD regression firewall for CycloneDX 1.6 CBOM inventories."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+requires-python = ">=3.11"
+authors = [{name = "The PQBlocks Authors"}]
+keywords = ["cbom", "cars", "crypto-agility", "cyclonedx", "sarif", "ci-gate", "post-quantum", "pqc"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Security :: Cryptography",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = ["click"]
+
+[project.optional-dependencies]
+test = ["pytest"]
+
+[project.scripts]
+pqblocks-agility = "pqblocks_agility.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/PQBlocks/crypto-agility"
+Documentation = "https://github.com/PQBlocks/crypto-agility#readme"
+Source = "https://github.com/PQBlocks/crypto-agility"
+Changelog = "https://github.com/PQBlocks/crypto-agility/blob/main/CHANGELOG.md"
+Issues = "https://github.com/PQBlocks/crypto-agility/issues"
+Security = "https://github.com/PQBlocks/crypto-agility/security/policy"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

pqblocks_agility-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pqblocks_agility-0.1.0/src/pqblocks_agility/__init__.py

@@ -0,0 +1,3 @@
+"""pqblocks-agility: crypto-agility assessment and CI gate."""
+
+__version__ = "0.1.0"

pqblocks_agility-0.1.0/src/pqblocks_agility/ast_decoupling.py

@@ -0,0 +1,70 @@
+"""
+AST Decoupling Heuristics (Slice feature 3).
+Implements the IS_DECOUPLED predicate and dimension d3 calculation per Spec §3.2 & §3.3.
+"""
+
+from __future__ import annotations
+
+import ast
+import re
+from typing import Optional, List
+from pqblocks_agility.cbom import CBOM, CBOMComponent
+
+CONFIG_EXTENSIONS = (".yaml", ".yml", ".json", ".toml", ".ini", ".env", ".conf", ".cfg")
+HARDCODED_KEY_PATTERNS = [
+    re.compile(r"-----BEGIN (RSA|EC|OPENSSH|PRIVATE) KEY-----"),
+    re.compile(r"b['\"][0-9a-fA-F]{32,}['\"]"),
+    re.compile(r"b['\"][0-9a-zA-Z+/=]{32,}['\"]"),
+]
+
+def is_decoupled(component: CBOMComponent, source_code: Optional[str] = None) -> bool:
+    """Evaluate if a cryptographic asset is decoupled from application logic.
+    
+    Condition (a): Zero cryptographic keys hardcoded.
+    Condition (b): Algorithm replaceable via policy/configuration change without recompilation.
+    Condition (c): Key rotation feasible operationally without service downtime.
+    """
+    loc = (component.location or "").lower()
+    file_part = loc.split(":")[0] if ":" in loc else loc
+
+    # Rule 1: Config file locations are configurable/replaceable by definition
+    if any(file_part.endswith(ext) for ext in CONFIG_EXTENSIONS):
+        return True
+
+    # Rule 2: If source code is provided, inspect for hardcoded keys and provider abstraction
+    if source_code:
+        for pattern in HARDCODED_KEY_PATTERNS:
+            if pattern.search(source_code):
+                return False
+        
+        # AST analysis: check if primitive is called directly or via an abstracted provider/release pipeline
+        try:
+            tree = ast.parse(source_code)
+            for node in ast.walk(tree):
+                if isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute):
+                    # Direct inline constructor calls like AES.new, RSA.generate without wrapper
+                    if node.func.attr in ("new", "generate") and isinstance(node.func.value, ast.Name):
+                        if node.func.value.id in ("AES", "RSA", "DES", "ARC4"):
+                            return False
+        except Exception:
+            pass
+
+    # Rule 3: Legacy/quantum-vulnerable assets directly in code are tightly coupled by default
+    if component.quantum_vulnerable:
+        return False
+
+    # Default for PQC or modern components without hardcoded locations
+    return True
+
+def compute_d3(cbom: CBOM) -> float:
+    """Calculate the d3 Architectural Decoupling dimension score in [0.0, 1.0].
+    
+    Formula:
+    d3 = (1 / |I|) * sum(1 for a in I if IS_DECOUPLED(a))
+    Empty inventory yields 0.0 per Edge Case E6.
+    """
+    if not cbom.components:
+        return 0.0
+
+    decoupled_count = sum(1 for c in cbom.components if is_decoupled(c))
+    return round(decoupled_count / len(cbom.components), 4)