preflight-engine 0.1.0__py3-none-any.whl

preflight_engine-0.1.0.dist-info/METADATA

@@ -0,0 +1,271 @@
+Metadata-Version: 2.5
+Name: preflight-engine
+Version: 0.1.0
+Summary: Infrastructure change risk analysis engine for Terraform plans
+Project-URL: Homepage, https://github.com/adityacodes-root/Preflight
+Project-URL: Documentation, https://github.com/adityacodes-root/Preflight#readme
+Project-URL: Repository, https://github.com/adityacodes-root/Preflight.git
+Project-URL: Issues, https://github.com/adityacodes-root/Preflight/issues
+Project-URL: Changelog, https://github.com/adityacodes-root/Preflight/releases
+Author: Preflight Contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ci-cd,cloud,devops,infrastructure,risk-analysis,security,terraform
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.7.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.0; extra == 'dev'
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0.12; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Preflight
+
+Preflight is an infrastructure change risk analysis engine that parses Terraform plan JSON to detect destructive operations, security regressions, and architectural risks before deployment.
+
+```bash
+terraform plan -out=tfplan
+terraform show -json tfplan | preflight analyze -
+```
+
+---
+
+## Performance & Quality Metrics
+
+Measured across synthetic benchmarks and automated test suites:
+
+| Metric | Measured Value | Standard |
+|---|---|---|
+| **Analysis Latency** | **< 0.50 ms** avg per plan | Sub-millisecond static evaluation |
+| **Detection Rate** | **100%** (11/11 target scenarios) | Synthetic test fixtures |
+| **False Positive Rate** | **0** on control fixtures | Clean control plans produce 0 findings |
+| **Test Coverage** | **88%** statement coverage | 105 unit and integration tests |
+| **Type Safety** | **100%** strictly typed | `mypy --strict` with zero warnings |
+| **Code Quality** | **Zero errors** | Compliant with `ruff` linter and formatter |
+| **Scoring Determinism** | **100% bit-for-bit identical** | Zero drift across 50 sequential runs |
+
+---
+
+## Installation
+
+Requires Python 3.12+.
+
+### Recommended: Standalone CLI with `pipx`
+Installs `preflight` into an isolated global environment so the binary is directly available in any terminal:
+
+```bash
+# Install from PyPI:
+pipx install preflight-engine
+
+# Or install directly from GitHub:
+pipx install git+https://github.com/adityacodes-root/Preflight.git
+```
+
+### With `uv` (Fastest)
+```bash
+uv tool install preflight-engine
+```
+
+### Standard `pip`
+```bash
+pip install preflight-engine
+```
+
+### From Source (Development)
+```bash
+git clone https://github.com/adityacodes-root/Preflight.git
+cd preflight
+python -m venv .venv
+source .venv/bin/activate  # On Windows: .\.venv\Scripts\Activate.ps1
+pip install -e ".[dev]"
+```
+
+---
+
+## Usage
+
+```bash
+# Pipe directly via stdin (recommended for CI/CD)
+terraform show -json tfplan | preflight analyze -
+terraform show -json tfplan | preflight analyze - --fail-on high
+
+# Publish or update sticky PR comment in CI
+terraform show -json tfplan | preflight comment - --fail-on high
+
+# Generate SARIF report for GitHub Code Scanning
+terraform show -json tfplan | preflight analyze - --format sarif --output preflight.sarif
+
+# Analyze a local plan file
+preflight analyze plan.json
+preflight analyze plan.json --fail-on high
+preflight analyze plan.json --environment staging
+preflight analyze plan.json --format markdown --output report.md
+preflight analyze plan.json --format json --output report.json
+```
+
+### Options
+
+| Option | Flag | Description | Default |
+|---|---|---|---|
+| `--environment` | `-e` | `development`, `staging`, or `production` | `production` |
+| `--format` | `-f` | `terminal`, `json`, `markdown`, or `sarif` | `terminal` |
+| `--fail-on` | | Block if findings reach: `low`, `moderate`, `high`, `critical` | *None* |
+| `--output` | `-o` | Output file path | stdout |
+| `--config` | `-c` | Custom YAML configuration path | `preflight.yaml` |
+| `--verbose` | `-v` | Show traceback on error | `false` |
+| `--version` | `-V` | Display version | |
+
+### Exit Codes
+
+| Code | Status | Meaning |
+|:---:|---|---|
+| `0` | **Pass** | Analysis completed; no blocking policy conditions triggered. |
+| `1` | **Block** | Analysis completed; a configured policy threshold was met. |
+| `2` | **Error** | File not found, invalid JSON syntax, or bad configuration. |
+
+---
+
+## CI/CD & GitHub Integration
+
+Preflight integrates directly into CI/CD pipelines to automate infrastructure risk gates and pull request reviews.
+
+### Pull Request Sticky Comments (`preflight comment`)
+Posts an infrastructure risk analysis directly to active pull requests. Subsequent commits update the comment in place to prevent notification noise. Repository, token, and PR number are resolved automatically from environment variables (`GITHUB_REPOSITORY`, `GITHUB_TOKEN`, and `GITHUB_REF`).
+
+```bash
+# In GitHub Actions
+terraform show -json tfplan | preflight comment - --fail-on high
+
+# Local test or manual invocation
+preflight comment plan.json --repo owner/repo --pr 42 --token $GITHUB_TOKEN --dry-run
+```
+
+### SARIF Code Scanning (`--format sarif`)
+Exports findings in OASIS SARIF v2.1.0 to surface inline risk annotations in GitHub Code Scanning, GitLab Security Dashboards, or Azure DevOps.
+
+```bash
+terraform show -json tfplan | preflight analyze - --format sarif --output preflight.sarif
+```
+
+See [.github/workflows/terraform-pr-check.yml](.github/workflows/terraform-pr-check.yml) for a complete GitHub Actions workflow.
+
+---
+
+## Risk Scoring Model
+
+Preflight scores risks from `0.0` to `100.0` using five weighted dimensions:
+
+| Factor | Weight | Evaluation Scope |
+|---|:---:|---|
+| **Change Impact** | 30% | Structural blast radius (in-place modification vs. resource recreation vs. deletion) |
+| **Security Exposure** | 25% | External reachability, administrative port ingress, permissive IAM wildcards |
+| **Reversibility** | 20% | Recovery complexity (permanent data loss vs. declarative attribute update) |
+| **Environment Criticality** | 15% | Target tier: `development` (1.0/5), `staging` (3.0/5), `production` (5.0/5) |
+| **Uncertainty** | 10% | Attributes computed at apply-time that cannot be evaluated statically |
+
+$$\text{Score} = \sum_{i} \left( \text{Weight}_i \times \frac{\text{Factor Score}_i}{5.0} \right)$$
+
+### Risk Categories
+- `0 – 24.9`: **Low** (tag updates, read-only data sources, benign attribute changes)
+- `25 – 49.9`: **Moderate** (scoped additions, non-destructive replacements)
+- `50 – 74.9`: **High** (recreations, destructive storage operations, broad IAM policies)
+- `75 – 100.0`: **Critical** (public SSH/RDP, disabled S3 access blocks, DB deletion)
+
+Overall plan risk is calculated as the maximum resource-level risk score to prevent critical issues from being masked by volume of benign changes.
+
+---
+
+## Detection Rules
+
+### Generic Rules
+- `GEN-DEL-001`: Resource deletion in plan.
+- `GEN-REP-001`: Resource replacement (destroy and recreate due to immutable attributes).
+- `GEN-ACT-001`: Unrecognized or unsupported Terraform lifecycle action sequences.
+- `GEN-UNK-001`: Computed unknown values in critical configuration fields.
+- `GEN-DST-001`: Destructive changes to stateful resources (databases, volumes, clusters).
+
+### AWS Rules
+- `AWS-NET-001`: Security group ingress opening administrative ports (22, 3389) or all traffic to `0.0.0.0/0` or `::/0`.
+- `AWS-S3-001`: S3 Public Access Block removal or disabled settings (`block_public_acls`, `block_public_policy`, etc.), or public bucket ACLs.
+- `AWS-IAM-001`: Context-sensitive IAM wildcard policies (`*` on `*` is Critical; service-level wildcards on `*` is High).
+- `AWS-DB-001`: Deletion or replacement of RDS instances, Aurora clusters, DynamoDB tables, or ElastiCache clusters.
+
+### Azure Rules
+- `AZR-NET-001`: Network Security Group (NSG) rules allowing `0.0.0.0/0` or `Internet` to ports 22, 3389, or wildcard `*`.
+- `AZR-STG-001`: Storage account public blob access or missing firewall restrictions.
+- `AZR-KV-001`: Azure Key Vault changes with `purge_protection_enabled = false` or soft delete retention < 7 days.
+- `AZR-DB-001`: Deletion or replacement of Azure SQL, Cosmos DB, or PostgreSQL flexible servers.
+
+### Google Cloud Rules
+- `GCP-FW-001`: Ingress compute firewall rules allowing `0.0.0.0/0` or `::/0` to sensitive administrative ports (22, 3389) or all traffic.
+- `GCP-IAM-001`: Cloud Storage bucket IAM bindings or members granting access to `allUsers` or `allAuthenticatedUsers`.
+- `GCP-SQL-001`: Cloud SQL instance deletion, replacement, or disabling `deletion_protection`.
+
+### Kubernetes Rules
+- `K8S-SEC-001`: Workloads or Helm charts deploying with `security_context.privileged: true` or `hostNetwork: true`.
+- `K8S-RBAC-001`: RoleBindings and ClusterRoleBindings binding to superuser role `cluster-admin`.
+
+---
+
+## Policy Configuration (`preflight.yaml`)
+
+```yaml
+environment: production
+format: terminal
+fail_on: high
+
+blocked_rules:
+  - AWS-DB-001
+  - AWS-NET-001
+
+allowed_rules: []
+
+max_score: 75.0
+```
+
+---
+
+## Defensive Redaction
+
+Preflight prevents secrets and credentials from appearing in terminal output, CI logs, or pull request comments. The engine recursively redacts:
+- Sensitive key names matching password, secret, token, api_key, private_key, or auth patterns.
+- Terraform plan attributes flagged via `before_sensitive` and `after_sensitive` metadata.
+
+---
+
+## Verification & Benchmarks
+
+```bash
+pytest
+pytest --cov=preflight --cov-report=term-missing
+ruff check .
+ruff format --check .
+mypy src tests
+python scripts/benchmark.py
+```
+
+---
+
+## License
+
+Apache-2.0

preflight_engine-0.1.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+preflight/__init__.py,sha256=0lTmYoEM6gWg5fUCANFWWNhAdJPkhvSBMpBqPr2mhIo,84
+preflight/cli.py,sha256=vThM-Nm2OUYZx46Gevxt0jic2ub6oATs1jE5obuAR94,18194
+preflight/config.py,sha256=XsrjNhz9zDDL-zU03-ecmAxNkLrhHz9jtAdFdRn2a6s,3664
+preflight/engine.py,sha256=Ypf7MAxBKNn-HvKhYeeYR6sSWSawlXSVgjbKjUIna7A,4154
+preflight/github.py,sha256=BTNN32Sqai83BcqDVtuAjGEX9FGGHXTEt7h40Na12Zk,4467
+preflight/models.py,sha256=ynYSSoMzoeUT6yXRoioekDVWuKKjzTZU2X6shTS6Ld8,8260
+preflight/plan.py,sha256=a2AXKZm0GTKJh3X4pRWfsFCWKbjxG01XrfnsbVyp2Jg,6228
+preflight/policy.py,sha256=Uj-Wbfkjr1r8BIYjqNOc3bSJfhYesFcEY2pUKTR2L0Y,2790
+preflight/redaction.py,sha256=QDGfzeuVkf1RwmcEQ7yeMhNkcl-ox92NYoiydrrcxY0,1813
+preflight/reporting.py,sha256=j9mV32WrEpi8_V2GrKzt_hghKrEQLwAjdh6Qgk4C7sw,16698
+preflight/scoring.py,sha256=QpekTPUA4Kc4to4gg6QVUCY4ADLu50JS38jmHLVvf0s,4871
+preflight/rules/__init__.py,sha256=i-FRpsYHxjoh8HQfEjYs7dAph5PdVi-Tm3RryrkYBJM,2619
+preflight/rules/aws.py,sha256=9i7uKlucB1WCQsUt-Ipc4xQCVPrNVLoBqpmpA0P3XIA,24133
+preflight/rules/azure.py,sha256=B_a6iXsDIMrHS2h2tnrTbBA9MKd8S-O7X8XSg4dN_HQ,11718
+preflight/rules/base.py,sha256=JTUzDJravahPSzddw52yi7bFE5dXo869COGD7kUiAoI,634
+preflight/rules/gcp.py,sha256=8HVlOafUwbiwzCeIaFBZtUwvejO2AH0ZW9oCQR_ILGc,10267
+preflight/rules/generic.py,sha256=3ZZb632Atg8wp_h-2Uv70Q7mBuCzHkdMBR2NrSGgYiA,11238
+preflight/rules/kubernetes.py,sha256=7dfkE-K8f3V8nsuRD01hO0DPFckhNFW6oje-mE86K8U,9599
+preflight_engine-0.1.0.dist-info/METADATA,sha256=BSZ0HN0NfZgDfWNZ3MSVyhVgOFtI9Ykw99KW1myBwCc,10444
+preflight_engine-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+preflight_engine-0.1.0.dist-info/entry_points.txt,sha256=VcW1tXHanw5ExFiAv-nHrUeDFl0-p85MiGw2YhnnI30,49
+preflight_engine-0.1.0.dist-info/licenses/LICENSE,sha256=Kfa_K9kKLoq28ByAXkso1HdgWXzqL3R0eCIh88KD5ZQ,10120
+preflight_engine-0.1.0.dist-info/RECORD,,

preflight_engine-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

preflight_engine-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+preflight = preflight.cli:main

preflight_engine-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,175 @@
+                                 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.
+
+      "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