appsec-rules-pack 0.2.0__tar.gz

appsec_rules_pack-0.2.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. Do not 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 Lucas Henrique Grifoni
+
+   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.

appsec_rules_pack-0.2.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: appsec-rules-pack
+Version: 0.2.0
+Summary: Generic AppSec policy-as-code rules pack and validator.
+Author: Lucas Henrique Grifoni
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/lucashgrifoni/AppSec-Rules-Pack
+Project-URL: Repository, https://github.com/lucashgrifoni/AppSec-Rules-Pack
+Project-URL: Issues, https://github.com/lucashgrifoni/AppSec-Rules-Pack/issues
+Project-URL: Changelog, https://github.com/lucashgrifoni/AppSec-Rules-Pack/blob/master/CHANGELOG.md
+Keywords: appsec,application-security,policy-as-code,security-rules,secure-code-review,devsecops,owasp-asvs,ci-quality-gate
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema<5,>=4.21
+Requires-Dist: PyYAML<7,>=6.0.1
+Requires-Dist: typer<1,>=0.12
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == "dev"
+Requires-Dist: pytest<9,>=8; extra == "dev"
+Requires-Dist: pytest-cov<7,>=5; extra == "dev"
+Requires-Dist: ruff<1,>=0.5; extra == "dev"
+Dynamic: license-file
+
+# AppSec Rules Pack
+
+[![CI](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/ci.yml/badge.svg)](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/ci.yml)
+[![Security CI/CD](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/security-ci-cd.yml/badge.svg)](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/security-ci-cd.yml)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/lucashgrifoni/AppSec-Rules-Pack/badge)](https://scorecard.dev/viewer/?uri=github.com/lucashgrifoni/AppSec-Rules-Pack)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.12%2B-blue.svg)](pyproject.toml)
+
+Reusable AppSec policy-as-code rules for secure application review, CI quality gates,
+and manual evidence collection.
+
+This initial pack is intentionally generic. It does not contain product names,
+tenant identifiers, customer data, secrets, internal endpoints, or environment-specific
+configuration.
+
+## What Is Included
+
+- A short technical specification in `TECHNICAL_SPEC.md` and a direction summary in
+  `ROADMAP.md`.
+- A JSON Schema rule contract in `src/appsec_rules_pack/schemas/appsec-rule.schema.json`.
+- A baseline YAML rules pack of 19 generic rules in `rules/appsec-baseline.yaml`,
+  covering authentication, authorization, input validation, injection (including
+  output-encoding/XSS), SSRF, secrets, file handling, logging, dependency risk,
+  configuration, session hardening, CSRF, webhook/message integrity, excessive data
+  exposure, mass assignment, open redirect, and rate limiting. Every rule ships an
+  explicit compliant and violating code example.
+- A Python 3.12 validator with a Typer CLI supporting `--version`,
+  `--fail-on-warnings`, `--require-examples`, and `--format json` output for CI, plus
+  derivation-only `export index`, `export semgrep`, `export sarif`, and `report coverage`
+  subcommands.
+- Derived, drift-tested artifacts under `exports/`: a machine-readable rule index
+  (`appsec-baseline.index.json`), a clearly labeled NON-runnable Semgrep scaffold, and a
+  SARIF 2.1.0 rule catalog (empty results). Derivation only — the validator stays
+  engine-agnostic and never executes rules (ADR-0001).
+- Unit tests and pass/fail/warn fixtures for valid packs, invalid schema shape,
+  enum/type/additionalProperties failures, duplicate rule IDs, cross-file
+  duplicate IDs, exception-window warnings, exception-policy contradictions,
+  malformed framework mapping IDs, and sensitive-value detection.
+- A 90% coverage gate plus a hardened CI/CD surface: a build/lint/test workflow,
+  a security pipeline (Semgrep, CodeQL, Bandit, Trivy, KICS, pip-audit, Gitleaks,
+  Dependency Review, actionlint), and OpenSSF Scorecard analysis.
+- Contribution guidance for safe rule additions, a code of conduct, and issue/PR
+  templates.
+- A CI integration template in `examples/`.
+
+## Project Layout
+
+```text
+.
+|-- .github/
+|   |-- ISSUE_TEMPLATE/
+|   |   |-- bug_report.md
+|   |   |-- config.yml
+|   |   `-- rule_proposal.md
+|   |-- workflows/
+|   |   |-- ci.yml
+|   |   |-- scorecard.yml
+|   |   `-- security-ci-cd.yml
+|   |-- CODEOWNERS
+|   |-- PULL_REQUEST_TEMPLATE.md
+|   `-- dependabot.yml
+|-- examples/
+|   `-- README.md
+|-- rules/
+|   `-- appsec-baseline.yaml
+|-- src/
+|   `-- appsec_rules_pack/
+|       |-- __init__.py
+|       |-- __main__.py
+|       |-- cli.py
+|       |-- loader.py
+|       |-- validator.py
+|       `-- schemas/
+|           `-- appsec-rule.schema.json
+|-- tests/
+|   |-- fixtures/
+|   |   |-- cross-file-dup/
+|   |   |-- exception-consistency/
+|   |   |-- fail/
+|   |   |-- pass/
+|   |   `-- warn/
+|   |-- test_edge_cases.py
+|   |-- test_examples.py
+|   |-- test_loader.py
+|   |-- test_packaging.py
+|   |-- test_validator.py
+|   `-- test_validator_paths.py
+|-- CHANGELOG.md
+|-- CODE_OF_CONDUCT.md
+|-- CONTRIBUTING.md
+|-- LICENSE
+|-- README.md
+|-- ROADMAP.md
+|-- SECURITY.md
+|-- STATUS.md
+|-- TECHNICAL_SPEC.md
+`-- pyproject.toml
+```
+
+## Setup
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\python -m pip install -e ".[dev]"
+```
+
+On macOS/Linux:
+
+```bash
+python -m venv .venv
+.venv/bin/python -m pip install -e ".[dev]"
+```
+
+If the dependencies already exist in the active Python environment, the validator can
+also be run directly with `PYTHONPATH=src`.
+
+## Usage
+
+Validate the baseline rules pack:
+
+```bash
+python -m appsec_rules_pack validate rules/appsec-baseline.yaml
+```
+
+Validate every `.yaml` or `.yml` rules pack under a directory:
+
+```bash
+python -m appsec_rules_pack validate rules
+```
+
+Or, after installation, use the console script:
+
+```bash
+appsec-rules validate rules/appsec-baseline.yaml
+```
+
+Fail on warnings as well as errors:
+
+```bash
+appsec-rules validate rules/appsec-baseline.yaml --fail-on-warnings
+```
+
+Warn when an enabled rule ships no compliant/violating examples (opt-in):
+
+```bash
+appsec-rules validate rules --require-examples
+```
+
+Emit machine-readable JSON for CI pipelines:
+
+```bash
+appsec-rules validate rules --format json
+```
+
+Show the installed version:
+
+```bash
+appsec-rules --version
+```
+
+Derive a machine-readable rule index (JSON) for downstream tooling. This only reads
+and derives pack metadata; it does not execute rules or emit findings:
+
+```bash
+appsec-rules export index rules/appsec-baseline.yaml
+appsec-rules export index rules/appsec-baseline.yaml --output exports/appsec-baseline.index.json
+```
+
+The JSON report contains a `summary` object (`files`, `rules`, `errors`, `warnings`,
+`ok`) and a `files` array with per-file issues (`level`, `path`, `message`). The exit
+code is non-zero when validation fails, matching the text output.
+
+## Use It In Your CI
+
+`examples/README.md` contains a GitHub Actions template for installing the pack,
+validating a rules directory, and failing the build on errors (and optionally
+warnings). Pin the template to a reviewed tag or commit before enabling it as a
+quality gate.
+
+## Rule Pack Model
+
+Rules are advisory by default. Each rule defines:
+
+- a stable ID and severity;
+- the target surface and AppSec category;
+- framework mappings such as OWASP ASVS 5.0, OWASP API Security Top 10, OWASP Top 10:2025
+  (optional), CWE, and NIST SSDF;
+- expected evidence and review signals;
+- match guidance for reviewers or automation;
+- remediation and validation guidance;
+- exception metadata requirements;
+- a compliant and a violating code example with a short explanation.
+
+The initial version is optimized for reviewability and deterministic validation, not for
+deep scanner-specific matching.
+
+## Validation
+
+```bash
+python -m pytest
+PYTHONPATH=src python -m appsec_rules_pack validate rules
+```
+
+The validator checks JSON Schema compliance, duplicate rule IDs within a file and across
+a validated directory, exception-window limits, exception-policy contradictions
+(for example, a disallowed exception that still declares a window), malformed framework
+mapping identifiers (CWE, OWASP API Top 10 2023, OWASP ASVS, NIST SSDF), and basic
+sensitive-value patterns. Directory validation reports each issue with the relative file
+path, schema path, severity, and a concise remediation-oriented message.
+
+## Contributing
+
+See `CONTRIBUTING.md` for rule authoring principles, the severity model, exception
+requirements, and the required checks. All participation is governed by
+`CODE_OF_CONDUCT.md`. To report a security issue, follow `SECURITY.md`.
+
+## License
+
+Licensed under the Apache License 2.0. See `LICENSE`.

appsec_rules_pack-0.2.0/README.md

@@ -0,0 +1,219 @@
+# AppSec Rules Pack
+
+[![CI](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/ci.yml/badge.svg)](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/ci.yml)
+[![Security CI/CD](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/security-ci-cd.yml/badge.svg)](https://github.com/lucashgrifoni/AppSec-Rules-Pack/actions/workflows/security-ci-cd.yml)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/lucashgrifoni/AppSec-Rules-Pack/badge)](https://scorecard.dev/viewer/?uri=github.com/lucashgrifoni/AppSec-Rules-Pack)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.12%2B-blue.svg)](pyproject.toml)
+
+Reusable AppSec policy-as-code rules for secure application review, CI quality gates,
+and manual evidence collection.
+
+This initial pack is intentionally generic. It does not contain product names,
+tenant identifiers, customer data, secrets, internal endpoints, or environment-specific
+configuration.
+
+## What Is Included
+
+- A short technical specification in `TECHNICAL_SPEC.md` and a direction summary in
+  `ROADMAP.md`.
+- A JSON Schema rule contract in `src/appsec_rules_pack/schemas/appsec-rule.schema.json`.
+- A baseline YAML rules pack of 19 generic rules in `rules/appsec-baseline.yaml`,
+  covering authentication, authorization, input validation, injection (including
+  output-encoding/XSS), SSRF, secrets, file handling, logging, dependency risk,
+  configuration, session hardening, CSRF, webhook/message integrity, excessive data
+  exposure, mass assignment, open redirect, and rate limiting. Every rule ships an
+  explicit compliant and violating code example.
+- A Python 3.12 validator with a Typer CLI supporting `--version`,
+  `--fail-on-warnings`, `--require-examples`, and `--format json` output for CI, plus
+  derivation-only `export index`, `export semgrep`, `export sarif`, and `report coverage`
+  subcommands.
+- Derived, drift-tested artifacts under `exports/`: a machine-readable rule index
+  (`appsec-baseline.index.json`), a clearly labeled NON-runnable Semgrep scaffold, and a
+  SARIF 2.1.0 rule catalog (empty results). Derivation only — the validator stays
+  engine-agnostic and never executes rules (ADR-0001).
+- Unit tests and pass/fail/warn fixtures for valid packs, invalid schema shape,
+  enum/type/additionalProperties failures, duplicate rule IDs, cross-file
+  duplicate IDs, exception-window warnings, exception-policy contradictions,
+  malformed framework mapping IDs, and sensitive-value detection.
+- A 90% coverage gate plus a hardened CI/CD surface: a build/lint/test workflow,
+  a security pipeline (Semgrep, CodeQL, Bandit, Trivy, KICS, pip-audit, Gitleaks,
+  Dependency Review, actionlint), and OpenSSF Scorecard analysis.
+- Contribution guidance for safe rule additions, a code of conduct, and issue/PR
+  templates.
+- A CI integration template in `examples/`.
+
+## Project Layout
+
+```text
+.
+|-- .github/
+|   |-- ISSUE_TEMPLATE/
+|   |   |-- bug_report.md
+|   |   |-- config.yml
+|   |   `-- rule_proposal.md
+|   |-- workflows/
+|   |   |-- ci.yml
+|   |   |-- scorecard.yml
+|   |   `-- security-ci-cd.yml
+|   |-- CODEOWNERS
+|   |-- PULL_REQUEST_TEMPLATE.md
+|   `-- dependabot.yml
+|-- examples/
+|   `-- README.md
+|-- rules/
+|   `-- appsec-baseline.yaml
+|-- src/
+|   `-- appsec_rules_pack/
+|       |-- __init__.py
+|       |-- __main__.py
+|       |-- cli.py
+|       |-- loader.py
+|       |-- validator.py
+|       `-- schemas/
+|           `-- appsec-rule.schema.json
+|-- tests/
+|   |-- fixtures/
+|   |   |-- cross-file-dup/
+|   |   |-- exception-consistency/
+|   |   |-- fail/
+|   |   |-- pass/
+|   |   `-- warn/
+|   |-- test_edge_cases.py
+|   |-- test_examples.py
+|   |-- test_loader.py
+|   |-- test_packaging.py
+|   |-- test_validator.py
+|   `-- test_validator_paths.py
+|-- CHANGELOG.md
+|-- CODE_OF_CONDUCT.md
+|-- CONTRIBUTING.md
+|-- LICENSE
+|-- README.md
+|-- ROADMAP.md
+|-- SECURITY.md
+|-- STATUS.md
+|-- TECHNICAL_SPEC.md
+`-- pyproject.toml
+```
+
+## Setup
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\python -m pip install -e ".[dev]"
+```
+
+On macOS/Linux:
+
+```bash
+python -m venv .venv
+.venv/bin/python -m pip install -e ".[dev]"
+```
+
+If the dependencies already exist in the active Python environment, the validator can
+also be run directly with `PYTHONPATH=src`.
+
+## Usage
+
+Validate the baseline rules pack:
+
+```bash
+python -m appsec_rules_pack validate rules/appsec-baseline.yaml
+```
+
+Validate every `.yaml` or `.yml` rules pack under a directory:
+
+```bash
+python -m appsec_rules_pack validate rules
+```
+
+Or, after installation, use the console script:
+
+```bash
+appsec-rules validate rules/appsec-baseline.yaml
+```
+
+Fail on warnings as well as errors:
+
+```bash
+appsec-rules validate rules/appsec-baseline.yaml --fail-on-warnings
+```
+
+Warn when an enabled rule ships no compliant/violating examples (opt-in):
+
+```bash
+appsec-rules validate rules --require-examples
+```
+
+Emit machine-readable JSON for CI pipelines:
+
+```bash
+appsec-rules validate rules --format json
+```
+
+Show the installed version:
+
+```bash
+appsec-rules --version
+```
+
+Derive a machine-readable rule index (JSON) for downstream tooling. This only reads
+and derives pack metadata; it does not execute rules or emit findings:
+
+```bash
+appsec-rules export index rules/appsec-baseline.yaml
+appsec-rules export index rules/appsec-baseline.yaml --output exports/appsec-baseline.index.json
+```
+
+The JSON report contains a `summary` object (`files`, `rules`, `errors`, `warnings`,
+`ok`) and a `files` array with per-file issues (`level`, `path`, `message`). The exit
+code is non-zero when validation fails, matching the text output.
+
+## Use It In Your CI
+
+`examples/README.md` contains a GitHub Actions template for installing the pack,
+validating a rules directory, and failing the build on errors (and optionally
+warnings). Pin the template to a reviewed tag or commit before enabling it as a
+quality gate.
+
+## Rule Pack Model
+
+Rules are advisory by default. Each rule defines:
+
+- a stable ID and severity;
+- the target surface and AppSec category;
+- framework mappings such as OWASP ASVS 5.0, OWASP API Security Top 10, OWASP Top 10:2025
+  (optional), CWE, and NIST SSDF;
+- expected evidence and review signals;
+- match guidance for reviewers or automation;
+- remediation and validation guidance;
+- exception metadata requirements;
+- a compliant and a violating code example with a short explanation.
+
+The initial version is optimized for reviewability and deterministic validation, not for
+deep scanner-specific matching.
+
+## Validation
+
+```bash
+python -m pytest
+PYTHONPATH=src python -m appsec_rules_pack validate rules
+```
+
+The validator checks JSON Schema compliance, duplicate rule IDs within a file and across
+a validated directory, exception-window limits, exception-policy contradictions
+(for example, a disallowed exception that still declares a window), malformed framework
+mapping identifiers (CWE, OWASP API Top 10 2023, OWASP ASVS, NIST SSDF), and basic
+sensitive-value patterns. Directory validation reports each issue with the relative file
+path, schema path, severity, and a concise remediation-oriented message.
+
+## Contributing
+
+See `CONTRIBUTING.md` for rule authoring principles, the severity model, exception
+requirements, and the required checks. All participation is governed by
+`CODE_OF_CONDUCT.md`. To report a security issue, follow `SECURITY.md`.
+
+## License
+
+Licensed under the Apache License 2.0. See `LICENSE`.