diff --git a/.dockerignore b/.dockerignore index 235ff41..dc21eef 100644 --- a/.dockerignore +++ b/.dockerignore @@ -155,7 +155,9 @@ secrets*.json # Project-Specific # ============================================================================= # Add project-specific files to ignore -README.md +# NOTE: README.md is intentionally NOT ignored. pyproject.toml declares +# readme = "README.md", so the hatchling build backend requires it in the +# build context, otherwise `uv sync` fails with "Readme file does not exist". LICENSE CHANGELOG.md CONTRIBUTING.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 685e945..e70e9de 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -31,20 +31,14 @@ jobs: name: CI Pipeline uses: ByronWilliamsCPA/.github/.github/workflows/python-ci.yml@main with: + no-build: false # hatchling build backend: editable install must build python-version: '3.12' coverage-threshold: 80 source-directory: 'src' test-directory: 'tests' - enable-sonarcloud: true - sonarcloud-organization: 'ByronWilliamsCPA' - sonarcloud-project-key: 'ByronWilliamsCPA_foundry_unify' - enable-codecov: true run-integration-tests: true run-security-tests: true fail-on-llm-tags: false - secrets: - SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} - CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} ci-gate: name: CI Gate @@ -52,6 +46,11 @@ jobs: needs: [ci] if: always() steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Check CI results run: | if [ "${{ needs.ci.result }}" != "success" ]; then diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml index e1d5a71..82fd092 100644 --- a/.github/workflows/codecov.yml +++ b/.github/workflows/codecov.yml @@ -38,6 +38,11 @@ jobs: runs-on: ubuntu-latest if: ${{ github.event.workflow_run.conclusion == 'failure' }} steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Report status run: | echo "## Coverage Upload Skipped" >> $GITHUB_STEP_SUMMARY diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index f64e058..dd84def 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -24,11 +24,16 @@ jobs: name: Dependency Review runs-on: ubuntu-latest steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Checkout repository uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - name: Dependency Review - uses: actions/dependency-review-action@v4 + uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0 with: fail-on-severity: high # Deny copyleft and restrictive licenses (deny-list approach) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index be92657..f18cbb3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,6 +31,7 @@ jobs: name: Build & Deploy Docs uses: ByronWilliamsCPA/.github/.github/workflows/python-docs.yml@main with: + no-build: false # hatchling build backend: editable install must build python-version: '3.12' deploy-to-pages: >- ${{ diff --git a/.github/workflows/fips-compatibility.yml b/.github/workflows/fips-compatibility.yml index 3584140..a239078 100644 --- a/.github/workflows/fips-compatibility.yml +++ b/.github/workflows/fips-compatibility.yml @@ -54,11 +54,16 @@ jobs: runs-on: ubuntu-latest steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Checkout repository uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - name: Install uv - uses: astral-sh/setup-uv@v7 + uses: astral-sh/setup-uv@2ddd2b9cb38ad8efd50337e8ab201519a34c9f24 # v7.1.1 with: enable-cache: true @@ -200,11 +205,16 @@ jobs: needs: fips-check steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Checkout repository uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - name: Install uv - uses: astral-sh/setup-uv@v7 + uses: astral-sh/setup-uv@2ddd2b9cb38ad8efd50337e8ab201519a34c9f24 # v7.1.1 with: enable-cache: true diff --git a/.github/workflows/mutation-testing.yml b/.github/workflows/mutation-testing.yml index 900a693..da8e4b9 100644 --- a/.github/workflows/mutation-testing.yml +++ b/.github/workflows/mutation-testing.yml @@ -42,6 +42,7 @@ jobs: if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository uses: ByronWilliamsCPA/.github/.github/workflows/python-mutation.yml@main with: + no-build: false # hatchling build backend: editable install must build python-version: '3.12' source-directory: 'src' test-directory: 'tests' diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml index 8e09838..554e0a0 100644 --- a/.github/workflows/pr-validation.yml +++ b/.github/workflows/pr-validation.yml @@ -60,7 +60,7 @@ jobs: python-version: "3.12" - name: Install UV - uses: astral-sh/setup-uv@v7 + uses: astral-sh/setup-uv@2ddd2b9cb38ad8efd50337e8ab201519a34c9f24 # v7.1.1 with: enable-cache: true cache-dependency-glob: "uv.lock" @@ -123,6 +123,11 @@ jobs: needs: [core-validation, dead-code, link-check] if: always() steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Check validation results run: | echo "## Dependency & Standards Validation" >> $GITHUB_STEP_SUMMARY diff --git a/.github/workflows/python-compatibility.yml b/.github/workflows/python-compatibility.yml index 2f0138f..ec8ed0d 100644 --- a/.github/workflows/python-compatibility.yml +++ b/.github/workflows/python-compatibility.yml @@ -37,12 +37,16 @@ jobs: name: Python Compatibility Matrix uses: ByronWilliamsCPA/.github/.github/workflows/python-compatibility.yml@main with: + no-build: false # hatchling build backend: editable install must build python-versions: '["3.10", "3.11", "3.12", "3.13"]' operating-systems: '["ubuntu-latest"]' include-macos: true include-windows: true source-directory: 'src' - test-command: 'pytest tests/ -v --tb=short -x --ignore=tests/integration --ignore=tests/load -m "not slow and not integration"' + # No -m marker expression: the embedded quotes do not survive the org + # workflow's shell expansion (pytest then reads "slow" as a path). The + # integration/load suites are excluded by path instead. + test-command: 'pytest tests/ -v --tb=short -x --ignore=tests/integration --ignore=tests/load' coverage-report: false fail-fast: false timeout-minutes: 30 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ab21d49..85d530f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -46,6 +46,7 @@ jobs: name: Release Pipeline uses: ByronWilliamsCPA/.github/.github/workflows/python-release.yml@main with: + no-build: false # hatchling build backend: editable install must build python-version: '3.12' coverage-threshold: 80 source-directory: 'src' diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml index 352e9a6..82e673e 100644 --- a/.github/workflows/reuse.yml +++ b/.github/workflows/reuse.yml @@ -25,6 +25,11 @@ jobs: name: Check REUSE Compliance runs-on: ubuntu-latest steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Checkout repository uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 @@ -48,6 +53,11 @@ jobs: name: Validate License Files runs-on: ubuntu-latest steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Checkout repository uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 diff --git a/.github/workflows/sbom.yml b/.github/workflows/sbom.yml index 97e1ffa..abff7be 100644 --- a/.github/workflows/sbom.yml +++ b/.github/workflows/sbom.yml @@ -39,6 +39,7 @@ jobs: name: SBOM & Security uses: ByronWilliamsCPA/.github/.github/workflows/python-sbom.yml@main with: + no-build: false # hatchling build backend: editable install must build python-version: '3.12' fail-on-vulnerabilities: true severity-threshold: 'CRITICAL,HIGH' diff --git a/.github/workflows/security-analysis.yml b/.github/workflows/security-analysis.yml index 3890961..e850bdc 100644 --- a/.github/workflows/security-analysis.yml +++ b/.github/workflows/security-analysis.yml @@ -34,6 +34,7 @@ jobs: name: Security Scan uses: ByronWilliamsCPA/.github/.github/workflows/python-security-analysis.yml@main with: + no-build: false # hatchling build backend: editable install must build source-directory: 'src' python-version: '3.12' fail-on-high: true @@ -41,7 +42,6 @@ jobs: run-codeql: true run-dependency-review: true run-bandit: true - run-safety: true run-osv: true security-gate-success: diff --git a/.github/workflows/slsa-provenance.yml b/.github/workflows/slsa-provenance.yml index e1352af..7e8c220 100644 --- a/.github/workflows/slsa-provenance.yml +++ b/.github/workflows/slsa-provenance.yml @@ -56,7 +56,7 @@ jobs: python-version: "3.12" - name: Install UV - uses: astral-sh/setup-uv@v7 + uses: astral-sh/setup-uv@2ddd2b9cb38ad8efd50337e8ab201519a34c9f24 # v7.1.1 with: enable-cache: true diff --git a/.github/workflows/sonarcloud.yml b/.github/workflows/sonarcloud.yml index 73ace88..a2a537e 100644 --- a/.github/workflows/sonarcloud.yml +++ b/.github/workflows/sonarcloud.yml @@ -40,6 +40,11 @@ jobs: outputs: has-token: ${{ steps.check.outputs.has-token }} steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Check for SONAR_TOKEN id: check run: | @@ -63,6 +68,11 @@ jobs: timeout-minutes: 15 steps: + - name: Harden the runner + uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 + with: + egress-policy: audit + - name: Checkout repository uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: @@ -83,7 +93,6 @@ jobs: uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 with: python-version: '3.12' - cache: 'pip' - name: Install UV if: steps.check-code.outputs.has-code == 'true' @@ -133,7 +142,7 @@ jobs: -Dsonar.python.version=3.12 - name: Check Quality Gate - uses: sonarsource/sonarqube-quality-gate-action@master + uses: sonarsource/sonarqube-quality-gate-action@cf038b0e0cdecfa9e56c198bbb7d21d751d62c3b # v1.2.0 timeout-minutes: 5 env: SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} diff --git a/Dockerfile b/Dockerfile index d24487a..4894b04 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,41 +1,43 @@ # Multi-stage Dockerfile for Foundry Unify -# Optimized for production with security best practices and minimal image size +# Optimized for production with security best practices and minimal image size. +# +# Both stages use Chainguard's Wolfi-based Python images, which are rebuilt +# continuously and ship with a near-zero CVE surface (no perl, curl, ncurses, +# or other base-OS packages that carry the CVEs debian-slim and distroless do). +# The -dev variant provides a shell and apk for building; the minimal runtime +# has neither. Both pin the same Python version, so the resolved virtual +# environment's interpreter symlink stays valid when copied across stages. # ============================================================================= # Stage 1: Builder - Install dependencies # ============================================================================= -FROM python:3.12-slim AS builder +# Chainguard python:latest-dev (Wolfi). Digest-pinned for reproducibility and +# to satisfy DL3007; Renovate updates the digest as the image is rebuilt. +FROM cgr.dev/chainguard/python@sha256:ddd3811dcbef56aa9f3882ae16fdc2920174ac6028c12e76cfb64c1d37b7abe2 AS builder -# Set working directory WORKDIR /app -# Install system dependencies for building Python packages -RUN apt-get update && apt-get install -y --no-install-recommends \ - build-essential \ - curl \ - git \ - && rm -rf /var/lib/apt/lists/* +# Use the image's own Python; never let uv download a standalone interpreter, +# otherwise the venv would reference a path that does not exist in the runtime. +ENV UV_PYTHON=/usr/bin/python \ + UV_PYTHON_DOWNLOADS=never \ + UV_LINK_MODE=copy -# Install UV for fast dependency management +# Install UV (static binary) for fast dependency management COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv -# Copy dependency files +# Install dependencies first (cached layer), then the project itself COPY pyproject.toml uv.lock ./ - -# Install dependencies to a virtual environment -# This creates .venv/ which we'll copy to the final stage RUN uv sync --frozen --no-dev --no-install-project - -# Copy application code COPY . . - -# Install the project itself RUN uv sync --frozen --no-dev # ============================================================================= -# Stage 2: Runtime - Minimal production image +# Stage 2: Runtime - Minimal Wolfi production image # ============================================================================= -FROM python:3.12-slim +# Chainguard python:latest (Wolfi minimal runtime). Digest-pinned; Renovate +# updates the digest as the image is rebuilt. +FROM cgr.dev/chainguard/python@sha256:30ac20a34bae29023ae54b454e85fedb5cfb7de5f206dc73112bf8b0e3e3e190 # Metadata labels (OCI standard) LABEL org.opencontainers.image.title="Foundry Unify" @@ -46,50 +48,25 @@ LABEL org.opencontainers.image.url="https://github.com/ByronWilliamsCPA/Unify" LABEL org.opencontainers.image.source="https://github.com/ByronWilliamsCPA/Unify" LABEL org.opencontainers.image.licenses="MIT" -# Install runtime dependencies only -RUN apt-get update && apt-get install -y --no-install-recommends \ - ca-certificates \ - curl \ - && rm -rf /var/lib/apt/lists/* - -# Security: Create non-root user -RUN groupadd -r appuser && useradd -r -g appuser -u 1000 appuser - -# Set working directory WORKDIR /app -# Copy virtual environment from builder -COPY --from=builder --chown=appuser:appuser /app/.venv /app/.venv - -# Copy application code -COPY --chown=appuser:appuser . . +# Chainguard runtime already runs as the unprivileged "nonroot" user (uid 65532). +# Copy the resolved venv and the application source with that ownership. +COPY --from=builder --chown=65532:65532 /app/.venv /app/.venv +COPY --chown=65532:65532 src /app/src -# Set environment variables ENV PYTHONUNBUFFERED=1 \ PYTHONDONTWRITEBYTECODE=1 \ PATH="/app/.venv/bin:$PATH" \ PYTHONPATH=/app/src -# Switch to non-root user -USER appuser - -# Expose port (default for FastAPI/web apps) EXPOSE 8000 -# Health check - adjust endpoint based on your app -HEALTHCHECK --interval=30s --timeout=3s --start-period=40s --retries=3 \ - CMD curl -f http://localhost:8000/health/live || exit 1 -# Default command - run web server -CMD ["uvicorn", "foundry_unify.main:app", "--host", "0.0.0.0", "--port", "8000"] -# ============================================================================= -# Build Arguments (optional, for build-time configuration) -# ============================================================================= -# Example: -# ARG BUILD_ENV=production -# ENV ENVIRONMENT=${BUILD_ENV} +# Python-based health check (no curl/shell in the runtime image) +HEALTHCHECK --interval=30s --timeout=3s --start-period=40s --retries=3 \ + CMD ["python", "-c", "import urllib.request,sys; sys.exit(0 if urllib.request.urlopen('http://localhost:8000/health/live').status == 200 else 1)"] -# ============================================================================= -# Multi-architecture support -# ============================================================================= -# Build for multiple platforms: -# docker buildx build --platform linux/amd64,linux/arm64 -t myimage:latest . +# Chainguard python sets ENTRYPOINT ["python"]; clear it so CMD is the full +# invocation, then run uvicorn from the venv. +ENTRYPOINT [] +CMD ["python", "-m", "uvicorn", "foundry_unify.main:app", "--host", "0.0.0.0", "--port", "8000"] diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt deleted file mode 100644 index 137069b..0000000 --- a/LICENSES/Apache-2.0.txt +++ /dev/null @@ -1,73 +0,0 @@ -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. diff --git a/LICENSES/BSD-3-Clause.txt b/LICENSES/BSD-3-Clause.txt deleted file mode 100644 index 086d399..0000000 --- a/LICENSES/BSD-3-Clause.txt +++ /dev/null @@ -1,11 +0,0 @@ -Copyright (c) . - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/LICENSES/GPL-3.0-or-later.txt b/LICENSES/GPL-3.0-or-later.txt deleted file mode 100644 index f6cdd22..0000000 --- a/LICENSES/GPL-3.0-or-later.txt +++ /dev/null @@ -1,232 +0,0 @@ -GNU GENERAL PUBLIC LICENSE -Version 3, 29 June 2007 - -Copyright © 2007 Free Software Foundation, Inc. - -Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - -Preamble - -The GNU General Public License is a free, copyleft license for software and other kinds of works. - -The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. - -When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. - -To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. - -For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. - -Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. - -For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. - -Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. - -Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. - -The precise terms and conditions for copying, distribution and modification follow. - -TERMS AND CONDITIONS - -0. Definitions. - -“This License” refers to version 3 of the GNU General Public License. - -“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. - -“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations. - -To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work. - -A “covered work” means either the unmodified Program or a work based on the Program. - -To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. - -To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. - -An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. - -1. Source Code. -The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work. - -A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. - -The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. - -The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. - -The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. - -The Corresponding Source for a work in source code form is that same work. - -2. Basic Permissions. -All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. - -You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. - -Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. - -3. Protecting Users' Legal Rights From Anti-Circumvention Law. -No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. - -When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. - -4. Conveying Verbatim Copies. -You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. - -You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. - -5. Conveying Modified Source Versions. -You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”. - - c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. - -A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. - -6. Conveying Non-Source Forms. -You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: - - a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. - - d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. - -A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. - -A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. - -“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. - -If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). - -The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. - -Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. - -7. Additional Terms. -“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. - -When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. - -Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or authors of the material; or - - e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. - -All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. - -If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. - -Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. - -8. Termination. -You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). - -However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. - -Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. - -Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. - -9. Acceptance Not Required for Having Copies. -You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. - -10. Automatic Licensing of Downstream Recipients. -Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. - -An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. - -You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. - -11. Patents. -A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”. - -A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. - -Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. - -In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. - -If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. - -If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. - -A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. - -Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. - -12. No Surrender of Others' Freedom. -If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. - -13. Use with the GNU Affero General Public License. -Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. - -14. Revised Versions of this License. -The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. - -If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. - -Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. - -15. Disclaimer of Warranty. -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - -16. Limitation of Liability. -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -17. Interpretation of Sections 15 and 16. -If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. - -END OF TERMS AND CONDITIONS - -How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. - -To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - -If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”. - -You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . - -The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . diff --git a/README.md b/README.md index 11e52f4..a44e293 100644 --- a/README.md +++ b/README.md @@ -34,13 +34,30 @@ ## Overview -OCR orchestration and layout analysis service for the Foundry RAG pipeline - -This project provides: -- Core functionality for ocr orchestration and layout analysis service for the foundry rag pipeline -- Production-ready code with comprehensive testing -- Well-documented API and architecture -- Security-first development practices +Foundry Unify is the foundation library for an OCR orchestration and layout +analysis service that will sit in front of the Foundry RAG pipeline. The OCR +orchestration logic is still on the roadmap; what currently ships in +`src/foundry_unify/` is the production scaffolding the orchestrator will be +built on top of: + +- **FastAPI security middleware** (`foundry_unify.middleware.security`) — + OWASP-aligned security headers, in-memory rate limiting with burst control, + CORS, trusted-host, and an SSRF prevention middleware that blocks private + IPs, cloud metadata endpoints, and dangerous URL schemes. +- **Request correlation middleware** (`foundry_unify.middleware.correlation`) — + propagates `X-Correlation-ID` / `X-Request-ID` / `X-Trace-ID` / `X-Span-ID` + via `contextvars`, with a structlog processor to add the IDs to every log + record. +- **Structured logging** (`foundry_unify.utils.logging`) — structlog setup with + rich console output for development and JSON output for production, plus a + `log_performance` helper. +- **Pydantic Settings** (`foundry_unify.core.config`) — environment-driven + configuration loaded from `FOUNDRY_UNIFY_*` variables. +- **Centralised exception hierarchy** (`foundry_unify.core.exceptions`) — + typed errors (`ValidationError`, `AuthenticationError`, `APIError`, etc.) + with `to_dict()` for safe JSON responses. +- **Kubernetes health endpoints** (`foundry_unify.api.health`) — `/health/live`, + `/health/ready`, `/health/startup` FastAPI router ready to mount. ## Features @@ -75,15 +92,27 @@ pipx install uv ### Installation +Foundry Unify is not yet published to PyPI. Install from source: + +```bash +# Using uv (recommended) +uv add git+https://github.com/ByronWilliamsCPA/Unify.git +# or, for the FastAPI middleware stack: +uv add "foundry-unify[api] @ git+https://github.com/ByronWilliamsCPA/Unify.git" + +# Using pip +pip install git+https://github.com/ByronWilliamsCPA/Unify.git +pip install "foundry-unify[api] @ git+https://github.com/ByronWilliamsCPA/Unify.git" +``` + +For local development, clone the repository and install all extras: + ```bash -# Clone repository git clone https://github.com/ByronWilliamsCPA/Unify.git -cd foundry_unify +cd Unify # Install dependencies (includes dev tools - REQUIRED for development) uv sync --all-extras -# Install with ML dependencies -uv sync --all-extras,ml # Setup pre-commit hooks (required) uv run pre-commit install @@ -91,16 +120,83 @@ uv run pre-commit install ### Basic Usage +Wire the middleware, logging, and health endpoints into a FastAPI app +(requires the `[api]` extra): + ```python -# Import and use the package -from foundry_unify import YourModule +from fastapi import FastAPI + +from foundry_unify.api.health import router as health_router +from foundry_unify.core.config import settings +from foundry_unify.middleware import ( + CorrelationMiddleware, + add_security_middleware, +) +from foundry_unify.utils.logging import get_logger, setup_logging + +# Configure structured logging (JSON in production, rich console in dev). +setup_logging( + level=settings.log_level, + json_logs=settings.json_logs, + include_timestamp=settings.include_timestamp, + include_correlation=True, +) +logger = get_logger(__name__) + +app = FastAPI(title="foundry-unify") + +# Correlation must be added first so subsequent middleware can log with IDs. +app.add_middleware(CorrelationMiddleware) + +# Security headers, CORS, rate limiting, SSRF prevention. +add_security_middleware( + app, + enable_https_redirect=False, # Set True behind TLS-terminating proxies. + enable_rate_limiting=True, + enable_ssrf_prevention=True, + allowed_origins=["https://example.com"], + allowed_hosts=["api.example.com"], + rate_limit_rpm=100, +) + +# Kubernetes probes at /health/live, /health/ready, /health/startup. +app.include_router(health_router) + + +@app.get("/") +async def root() -> dict[str, str]: + logger.info("root_called") + return {"status": "ok"} +``` + +Raise typed exceptions from the centralised hierarchy: -# Example: Create an instance and use it -module = YourModule() -result = module.process() -print(result) +```python +from foundry_unify.core.exceptions import ValidationError + +raise ValidationError( + "Invalid email format", + field="email", + value="not-an-email", +) +# ValidationError.to_dict() -> JSON-serialisable error payload. ``` +### Configuration + +Settings load from environment variables with the `FOUNDRY_UNIFY_` prefix +(see `src/foundry_unify/core/config.py`). All variables are optional. + +| Variable | Type | Default | Description | +|----------|------|---------|-------------| +| `FOUNDRY_UNIFY_LOG_LEVEL` | `DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` | `INFO` | Application log level. | +| `FOUNDRY_UNIFY_JSON_LOGS` | bool | `false` | Emit JSON logs (production) instead of rich console output. | +| `FOUNDRY_UNIFY_INCLUDE_TIMESTAMP` | bool | `true` | Include ISO-8601 timestamps in log records. | + +`Settings` is a `pydantic_settings.BaseSettings` subclass and also reads from +a `.env` file when one is present. Extra unrecognised variables are ignored +(`extra="ignore"`). + ## Supply Chain Security This project implements enterprise-grade supply chain security with a multi-tier package index strategy and centralized secrets management. diff --git a/REUSE.toml b/REUSE.toml index 4c395c8..4cc0929 100644 --- a/REUSE.toml +++ b/REUSE.toml @@ -130,3 +130,28 @@ path = [ ] SPDX-License-Identifier = "CC0-1.0" SPDX-FileCopyrightText = "2025 Byron Williams" + + +# Pre-existing files (added 2026-05-08 to clear REUSE compliance backlog) +# These files predate the centralized REUSE.toml coverage. Licensed CC0-1.0 +# (public domain dedication) consistent with other configuration files. +[[annotations]] +path = [ + ".claude/settings.local.json.example", + ".claude/skills/project-planning/scripts/validate-planning-docs.py", + ".cruft.json", + ".darglint", + ".dockerignore", + ".env.example", + ".infisical.json", + ".markdownlint.json", + ".mutmut_config", + ".prettierrc", + ".shellcheckrc", + ".yamllint", + "Dockerfile", + "scripts/README.md", + "uv.lock", +] +SPDX-License-Identifier = "CC0-1.0" +SPDX-FileCopyrightText = "2025 Byron Williams" diff --git a/docs/known-vulnerabilities.md b/docs/known-vulnerabilities.md new file mode 100644 index 0000000..4339d6d --- /dev/null +++ b/docs/known-vulnerabilities.md @@ -0,0 +1,39 @@ +--- +title: "Known Vulnerabilities" +schema_type: common +status: published +owner: core-maintainer +purpose: "Track accepted dependency vulnerabilities that cannot be immediately resolved." +tags: + - security + - dependencies +--- + +> **Purpose**: Document dependency vulnerabilities that `pip-audit` reports but +> cannot be immediately fixed. Every entry here must correspond to an ID listed +> in `[tool.pip-audit].ignore-vuln` in `pyproject.toml`. Review quarterly; no +> entry ages past 60 days without reassessment. The OpenSSF release gate blocks +> releases for any vulnerability older than 60 days regardless of status. + +## Accepted Vulnerabilities + +### PYSEC-2022-42969 - `py` ReDoS in `py.path.svnwc` + +- **Package**: `py` 1.11.0 +- **Severity**: Medium (regular-expression denial of service) +- **Status**: Accepted (no fix available) +- **First documented**: 2026-05-28 +- **Reassess by**: 2026-07-27 + +**Description**: The `py` library is vulnerable to a ReDoS in the Subversion +path handling (`py.path.svnwc`) when parsing crafted SVN command output. + +**Why accepted**: `py` is an unmaintained transitive dependency pulled in by +`interrogate` (docstring-coverage tooling). No fixed release of `py` exists. +The vulnerable code path (`py.path.svnwc`) handles Subversion working copies +and is never exercised by this project or by `interrogate`'s docstring checks. +The dependency is dev-only and never ships in the runtime distribution. + +**Remediation plan**: Drop the dependency when `interrogate` removes its `py` +requirement, or replace `interrogate` with a tool that does not depend on `py`. +Re-checked each quarter against the `interrogate` dependency tree. diff --git a/docs/template_feedback.md b/docs/template_feedback.md index 9bc369a..4feee8f 100644 --- a/docs/template_feedback.md +++ b/docs/template_feedback.md @@ -42,7 +42,54 @@ When working on this project, if you discover any issue that originates from the -_No feedback items yet. Add issues as they are discovered._ +### Phantom CLI tests reference a non-existent `cli` module + +- **Priority**: High +- **Category**: Tooling / CI/CD +- **Discovered**: 2026-05-28 + +**Issue**: `tests/test_example.py` ships a `TestCLI` class (12 tests) that imports +`foundry_unify.cli`, but the template generates no `cli` module and no +`[project.scripts]` console entry point. Every CLI test fails with +`ModuleNotFoundError: No module named '.cli'`, and the dead code drags +total coverage well below the enforced 80% gate. + +**Context**: Discovered while bringing CI to green. The org reusable CI workflow +never ran tests (it was failing at `startup_failure` for unrelated input-schema +reasons), so the broken CLI tests had been masked since project creation. + +**Suggested Fix**: Either (a) gate the CLI scaffolding behind a cookiecutter +option (`include_cli`) that generates both the `cli` module and its tests +together, or (b) drop the CLI tests from the default `test_example.py` so +service-style projects without a CLI start green. + +**Affected Files**: `{{cookiecutter.package_name}}/tests/test_example.py`, +`pyproject.toml` (`[project.scripts]`) + +### Initial reusable-workflow callers pass inputs the org workflows no longer accept + +- **Priority**: Critical +- **Category**: CI/CD +- **Discovered**: 2026-05-28 + +**Issue**: The generated `.github/workflows/ci.yml` passes +`enable-sonarcloud`, `sonarcloud-organization`, `sonarcloud-project-key`, +`enable-codecov`, and a `secrets:` block to `python-ci.yml@main`, and +`security-analysis.yml` passes `run-safety`. The org reusable workflows removed +these inputs/secrets, so every run fails at `startup_failure` (workflow-call +validation) on a freshly generated project. + +**Context**: All CI was red from project creation; the failure mode (no logs, +parse-time rejection) made it look like an infra outage rather than a stale +caller contract. + +**Suggested Fix**: Pin the caller workflows to the same org-workflow SHA the +template was validated against, and remove inputs/secrets the current org +workflows do not declare. Add a template CI smoke test that calls the org +workflows to catch contract drift. + +**Affected Files**: `.github/workflows/ci.yml`, +`.github/workflows/security-analysis.yml` --- diff --git a/mkdocs.yml b/mkdocs.yml index 19e0a88..c1a13c0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -185,3 +185,12 @@ nav: # strict mode disabled to allow links to repo root files # These files are valid but outside docs/ directory strict: false + +# Exclude template/scaffolding docs from the build. These contain intentional +# placeholder links (e.g. relative/path/to/module.py, 0001-previous-decision.md) +# that do not resolve and would abort the org docs workflow's --strict build. +exclude_docs: | + ADRs/adr-template.md + planning/project-plan-template.md + planning/adr/README.md + superpowers/ diff --git a/pyproject.toml b/pyproject.toml index fae9de6..e3f4834 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -774,3 +774,12 @@ token = { env = "GH_TOKEN" } [tool.semantic_release.publish] dist_glob_patterns = ["dist/*"] upload_to_vcs_release = true + +# Dependency vulnerability scanning +# Each ignored ID must have a dated entry in docs/known-vulnerabilities.md. +[tool.pip-audit] +ignore-vuln = [ + # py 1.11.0 ReDoS in py.path.svnwc (SVN paths). Transitive via interrogate; + # no fixed release of py exists. The vulnerable SVN code path is never used. + "PYSEC-2022-42969", +] diff --git a/src/foundry_unify/api/health.py b/src/foundry_unify/api/health.py index 76bbdcb..4b0c5ea 100644 --- a/src/foundry_unify/api/health.py +++ b/src/foundry_unify/api/health.py @@ -41,8 +41,10 @@ class ReadinessCheck(BaseModel): name: str = Field(..., description="Dependency name") status: bool = Field(..., description="Check passed") - latency_ms: float | None = Field(None, description="Check latency in milliseconds") - error: str | None = Field(None, description="Error message if failed") + latency_ms: float | None = Field( + default=None, description="Check latency in milliseconds" + ) + error: str | None = Field(default=None, description="Error message if failed") class ReadinessStatus(HealthStatus): diff --git a/src/foundry_unify/middleware/correlation.py b/src/foundry_unify/middleware/correlation.py index fa26193..6c6bd76 100644 --- a/src/foundry_unify/middleware/correlation.py +++ b/src/foundry_unify/middleware/correlation.py @@ -52,7 +52,7 @@ async def root(): from starlette.middleware.base import BaseHTTPMiddleware if TYPE_CHECKING: - from collections.abc import Callable + from collections.abc import Awaitable, Callable from fastapi import Request from starlette.responses import Response @@ -151,8 +151,8 @@ def correlation_context_processor( ) Args: - logger: The wrapped logger instance. - method_name: The name of the log method called. + _logger: The wrapped logger instance (unused). + _method_name: The name of the log method called (unused). event_dict: The event dictionary to process. Returns: @@ -201,7 +201,7 @@ class CorrelationMiddleware(BaseHTTPMiddleware): """ async def dispatch( - self, request: Request, call_next: Callable[[Request], Response] + self, request: Request, call_next: Callable[[Request], Awaitable[Response]] ) -> Response: """Process request with correlation ID handling. diff --git a/src/foundry_unify/middleware/security.py b/src/foundry_unify/middleware/security.py index c3a0c82..97763f8 100644 --- a/src/foundry_unify/middleware/security.py +++ b/src/foundry_unify/middleware/security.py @@ -96,7 +96,8 @@ async def dispatch(self, request: Request, call_next) -> Response: ) # Remove server identification (OWASP A09) - response.headers.pop("Server", None) + if "server" in response.headers: + del response.headers["server"] return response diff --git a/tests/test_example.py b/tests/test_example.py index ce72e65..45b3fa1 100644 --- a/tests/test_example.py +++ b/tests/test_example.py @@ -146,226 +146,6 @@ def test_log_performance(self) -> None: assert call_args[1]["extra_metric"] == 42 -class TestCLI: - """Test command-line interface. - - Tests for Click CLI commands covering: - - Version option - - Command invocation - - Help text - - Debug mode - - Error handling - """ - - @pytest.mark.unit - def test_cli_has_version(self) -> None: - """Verify CLI has version option. - - This test verifies that the CLI group includes a version option. - """ - from foundry_unify.cli import cli - - assert cli is not None - assert hasattr(cli, "params") - - @pytest.mark.unit - def test_cli_hello_command_exists(self) -> None: - """Verify hello command is registered with CLI. - - This test verifies that the example hello command is properly - registered as a subcommand. - """ - from foundry_unify.cli import cli - - # Check that hello command exists - assert cli is not None - # Command registration happens at module level - - @pytest.mark.unit - def test_cli_hello_command_default(self) -> None: - """Verify hello command with default name. - - Tests that hello command outputs correct greeting with default name. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - result = runner.invoke(cli, ["hello"]) - - assert result.exit_code == 0 - assert "Hello, World!" in result.output - - @pytest.mark.unit - def test_cli_hello_command_custom_name(self) -> None: - """Verify hello command with custom name. - - Tests that hello command accepts and uses custom name parameter. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - result = runner.invoke(cli, ["hello", "--name", "Alice"]) - - assert result.exit_code == 0 - assert "Hello, Alice!" in result.output - - @pytest.mark.unit - def test_cli_hello_command_short_option(self) -> None: - """Verify hello command with short option -n. - - Tests that hello command accepts short form of name option. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - result = runner.invoke(cli, ["hello", "-n", "Bob"]) - - assert result.exit_code == 0 - assert "Hello, Bob!" in result.output - - @pytest.mark.unit - def test_cli_hello_with_debug(self) -> None: - """Verify hello command with debug flag. - - Tests that debug flag is properly passed to hello command. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - result = runner.invoke(cli, ["--debug", "hello", "--name", "Test"]) - - assert result.exit_code == 0 - assert "Hello, Test!" in result.output - - @pytest.mark.unit - def test_cli_config_command(self) -> None: - """Verify config command displays configuration. - - Tests that config command outputs project information. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - result = runner.invoke(cli, ["config"]) - - assert result.exit_code == 0 - assert "Current Configuration:" in result.output - assert "Project: Foundry Unify" in result.output - assert "Version: 0.1.0" in result.output - assert "Debug: False" in result.output - assert "Log Level:" in result.output - - @pytest.mark.unit - def test_cli_config_with_debug(self) -> None: - """Verify config command with debug flag. - - Tests that config command shows debug mode when enabled. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - result = runner.invoke(cli, ["--debug", "config"]) - - assert result.exit_code == 0 - assert "Current Configuration:" in result.output - assert "Debug: True" in result.output - - @pytest.mark.unit - def test_cli_context_setup(self) -> None: - """Verify CLI context is properly initialized. - - Tests that CLI sets up context object for subcommands. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - - # Invoke CLI group with --help to verify context setup - result = runner.invoke(cli, ["--help"]) - - # Should show help text successfully - assert result.exit_code == 0 - assert "Foundry Unify" in result.output - - @pytest.mark.unit - def test_cli_debug_mode(self) -> None: - """Verify debug mode enables debug logging. - - Tests that --debug flag is processed correctly. - """ - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - result = runner.invoke(cli, ["--debug", "hello"]) - - # Should execute successfully with debug enabled - assert result.exit_code == 0 - - @pytest.mark.unit - def test_cli_hello_error_handling(self) -> None: - """Verify hello command handles errors gracefully. - - Tests that exceptions are caught and reported properly. - """ - from unittest.mock import patch - - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - - # Mock logger to raise an exception during command execution - with patch("foundry_unify.cli.logger") as mock_logger: - mock_logger.info.side_effect = RuntimeError("Simulated error") - - result = runner.invoke(cli, ["hello", "--name", "Test"]) - - # Should exit with error code - assert result.exit_code == 1 - assert "Error:" in result.output - - @pytest.mark.unit - def test_cli_config_error_handling(self) -> None: - """Verify config command handles errors gracefully. - - Tests that exceptions are caught and reported properly. - """ - from unittest.mock import patch - - from click.testing import CliRunner - - from foundry_unify.cli import cli - - runner = CliRunner() - - # Mock logger to raise an exception during config command - with patch("foundry_unify.cli.logger") as mock_logger: - mock_logger.info.side_effect = RuntimeError("Simulated error") - - result = runner.invoke(cli, ["config"]) - - # Should exit with error code - assert result.exit_code == 1 - assert "Error:" in result.output - - class TestLoggingJSON: """Test JSON logging configuration. diff --git a/tests/unit/test_health.py b/tests/unit/test_health.py new file mode 100644 index 0000000..fb90b44 --- /dev/null +++ b/tests/unit/test_health.py @@ -0,0 +1,434 @@ +"""Tests for health check endpoints. + +Covers liveness, readiness, startup, and base health endpoints, +plus the ReadinessCheck helper functions and response models. +""" + +from __future__ import annotations + +import asyncio + +import pytest +from fastapi import FastAPI, HTTPException, status +from fastapi.testclient import TestClient + +from foundry_unify.api.health import ( + ReadinessCheck, + ReadinessStatus, + check_cache, + check_external_service, + router, +) + +# --------------------------------------------------------------------------- +# Shared app fixture +# --------------------------------------------------------------------------- + + +@pytest.fixture +def app() -> FastAPI: + """Return a minimal FastAPI app with the health router mounted.""" + _app = FastAPI() + _app.include_router(router) + return _app + + +@pytest.fixture +def client(app: FastAPI) -> TestClient: + """Return a synchronous TestClient for the health app.""" + return TestClient(app) + + +# --------------------------------------------------------------------------- +# GET /health/live +# --------------------------------------------------------------------------- + + +class TestLivenessEndpoint: + """Tests for the /health/live liveness probe endpoint.""" + + @pytest.mark.unit + def test_liveness_returns_200(self, client: TestClient) -> None: + """Verify liveness probe returns HTTP 200.""" + response = client.get("/health/live") + + assert response.status_code == 200 + + @pytest.mark.unit + def test_liveness_status_ok(self, client: TestClient) -> None: + """Verify liveness response body contains status ok.""" + response = client.get("/health/live") + body = response.json() + + assert body["status"] == "ok" + + @pytest.mark.unit + def test_liveness_uptime_positive(self, client: TestClient) -> None: + """Verify uptime_seconds is a positive number.""" + response = client.get("/health/live") + body = response.json() + + assert body["uptime_seconds"] >= 0 + + @pytest.mark.unit + def test_liveness_response_has_version(self, client: TestClient) -> None: + """Verify liveness response includes version field.""" + response = client.get("/health/live") + body = response.json() + + assert "version" in body + assert isinstance(body["version"], str) + assert len(body["version"]) > 0 + + @pytest.mark.unit + def test_liveness_response_has_python_version(self, client: TestClient) -> None: + """Verify liveness response includes python_version field.""" + response = client.get("/health/live") + body = response.json() + + assert "python_version" in body + assert isinstance(body["python_version"], str) + + @pytest.mark.unit + def test_liveness_response_has_timestamp(self, client: TestClient) -> None: + """Verify liveness response includes a numeric timestamp.""" + response = client.get("/health/live") + body = response.json() + + assert "timestamp" in body + assert isinstance(body["timestamp"], float) + + +# --------------------------------------------------------------------------- +# GET /health/ready +# --------------------------------------------------------------------------- + + +class TestReadinessEndpoint: + """Tests for the /health/ready readiness probe endpoint.""" + + @pytest.mark.unit + def test_readiness_returns_200_when_no_checks(self, client: TestClient) -> None: + """Verify readiness returns 200 when no dependency checks are configured.""" + response = client.get("/health/ready") + + assert response.status_code == 200 + + @pytest.mark.unit + def test_readiness_status_ok(self, client: TestClient) -> None: + """Verify readiness response body contains status ok.""" + response = client.get("/health/ready") + body = response.json() + + assert body["status"] == "ok" + + @pytest.mark.unit + def test_readiness_checks_empty_by_default(self, client: TestClient) -> None: + """Verify checks dict is empty when no dependencies are wired up.""" + response = client.get("/health/ready") + body = response.json() + + assert body["checks"] == {} + + @pytest.mark.unit + def test_readiness_uptime_positive(self, client: TestClient) -> None: + """Verify uptime_seconds is a non-negative number.""" + response = client.get("/health/ready") + body = response.json() + + assert body["uptime_seconds"] >= 0 + + @pytest.mark.unit + def test_readiness_503_logic_raises_http_exception(self) -> None: + """Verify that a failing check dict triggers the 503 HTTPException path.""" + checks = {"cache": ReadinessCheck(name="cache", status=False, error="down")} + all_healthy = all(check.status for check in checks.values()) + + assert not all_healthy + with pytest.raises(HTTPException) as exc_info: + raise HTTPException( + status_code=status.HTTP_503_SERVICE_UNAVAILABLE, + detail={ + "status": "unavailable", + "checks": { + name: check.model_dump() for name, check in checks.items() + }, + }, + ) + + assert exc_info.value.status_code == 503 + + +# --------------------------------------------------------------------------- +# GET /health/startup +# --------------------------------------------------------------------------- + + +class TestStartupEndpoint: + """Tests for the /health/startup startup probe endpoint.""" + + @pytest.mark.unit + def test_startup_returns_200(self, client: TestClient) -> None: + """Verify startup probe returns HTTP 200.""" + response = client.get("/health/startup") + + assert response.status_code == 200 + + @pytest.mark.unit + def test_startup_status_started(self, client: TestClient) -> None: + """Verify startup response body contains status started.""" + response = client.get("/health/startup") + body = response.json() + + assert body["status"] == "started" + + @pytest.mark.unit + def test_startup_uptime_non_negative(self, client: TestClient) -> None: + """Verify uptime_seconds is non-negative.""" + response = client.get("/health/startup") + body = response.json() + + assert body["uptime_seconds"] >= 0 + + +# --------------------------------------------------------------------------- +# GET /health/ (base alias) +# --------------------------------------------------------------------------- + + +class TestBaseHealthEndpoint: + """Tests for the /health/ base health alias endpoint.""" + + @pytest.mark.unit + def test_base_health_returns_200(self, client: TestClient) -> None: + """Verify /health/ returns HTTP 200.""" + response = client.get("/health/") + + assert response.status_code == 200 + + @pytest.mark.unit + def test_base_health_delegates_to_liveness(self, client: TestClient) -> None: + """Verify /health/ returns same status as liveness endpoint.""" + base_response = client.get("/health/") + live_response = client.get("/health/live") + + assert base_response.json()["status"] == live_response.json()["status"] + + +# --------------------------------------------------------------------------- +# check_cache helper function +# --------------------------------------------------------------------------- + + +class TestCheckCache: + """Tests for the check_cache async helper function.""" + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_cache_returns_readiness_check(self) -> None: + """Verify check_cache returns a ReadinessCheck instance.""" + result = await check_cache() + + assert isinstance(result, ReadinessCheck) + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_cache_name_is_cache(self) -> None: + """Verify check_cache result has name 'cache'.""" + result = await check_cache() + + assert result.name == "cache" + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_cache_status_true(self) -> None: + """Verify check_cache placeholder reports status True.""" + result = await check_cache() + + assert result.status is True + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_cache_latency_non_negative(self) -> None: + """Verify check_cache includes a non-negative latency_ms.""" + result = await check_cache() + + assert result.latency_ms is not None + assert result.latency_ms >= 0 + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_cache_no_error_on_success(self) -> None: + """Verify check_cache error field is None on success.""" + result = await check_cache() + + assert result.error is None + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_cache_returns_error_on_exception( + self, monkeypatch: pytest.MonkeyPatch + ) -> None: + """Verify check_cache captures exception message in error field.""" + import foundry_unify.api.health as health_module + + real_time = health_module.time.time + call_count = 0 + + def patched_time() -> float: + nonlocal call_count + call_count += 1 + # Call 1: start = time.time() in check_cache - succeeds + # Call 2: latency calculation inside try block - raises + # Call 3: latency calculation inside except block - succeeds + if call_count == 2: + raise RuntimeError("cache unavailable") + return real_time() + + monkeypatch.setattr(health_module.time, "time", patched_time) + + result = await check_cache() + + assert result.status is False + assert result.error == "cache unavailable" + + +# --------------------------------------------------------------------------- +# check_external_service helper function +# --------------------------------------------------------------------------- + + +class TestCheckExternalService: + """Tests for the check_external_service async helper function.""" + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_external_service_returns_readiness_check(self) -> None: + """Verify check_external_service returns a ReadinessCheck instance.""" + result = await check_external_service() + + assert isinstance(result, ReadinessCheck) + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_external_service_name(self) -> None: + """Verify check_external_service result has name 'external_api'.""" + result = await check_external_service() + + assert result.name == "external_api" + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_external_service_status_true(self) -> None: + """Verify check_external_service placeholder reports status True.""" + result = await check_external_service() + + assert result.status is True + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_external_service_latency_non_negative(self) -> None: + """Verify check_external_service includes a non-negative latency_ms.""" + result = await check_external_service() + + assert result.latency_ms is not None + assert result.latency_ms >= 0 + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_check_external_service_error_on_exception( + self, monkeypatch: pytest.MonkeyPatch + ) -> None: + """Verify check_external_service captures exception in error field.""" + import foundry_unify.api.health as health_module + + real_time = health_module.time.time + call_count = 0 + + def patched_time() -> float: + nonlocal call_count + call_count += 1 + if call_count == 2: + raise ConnectionError("service unreachable") + return real_time() + + monkeypatch.setattr(health_module.time, "time", patched_time) + + result = await check_external_service() + + assert result.status is False + assert result.error == "service unreachable" + + +# --------------------------------------------------------------------------- +# Pydantic model validation +# --------------------------------------------------------------------------- + + +class TestReadinessCheckModel: + """Tests for the ReadinessCheck pydantic model.""" + + @pytest.mark.unit + def test_readiness_check_minimal(self) -> None: + """Verify ReadinessCheck can be constructed with minimal fields.""" + check = ReadinessCheck(name="db", status=True) + + assert check.name == "db" + assert check.status is True + assert check.latency_ms is None + assert check.error is None + + @pytest.mark.unit + def test_readiness_check_with_all_fields(self) -> None: + """Verify ReadinessCheck accepts all optional fields.""" + check = ReadinessCheck( + name="redis", + status=False, + latency_ms=12.5, + error="connection refused", + ) + + assert check.name == "redis" + assert check.status is False + assert check.latency_ms == 12.5 + assert check.error == "connection refused" + + @pytest.mark.unit + def test_readiness_status_inherits_health_fields(self) -> None: + """Verify ReadinessStatus includes checks dict alongside HealthStatus fields.""" + readiness_status = ReadinessStatus( + status="ok", + uptime_seconds=10.0, + checks={"cache": ReadinessCheck(name="cache", status=True)}, + ) + + assert readiness_status.status == "ok" + assert "cache" in readiness_status.checks + assert readiness_status.checks["cache"].status is True + + +# --------------------------------------------------------------------------- +# API __init__ import +# --------------------------------------------------------------------------- + + +class TestApiInit: + """Tests for the api package __init__ exports.""" + + @pytest.mark.unit + def test_health_router_exported(self) -> None: + """Verify health_router is importable from the api package.""" + from foundry_unify.api import health_router + + assert health_router is not None + + @pytest.mark.unit + def test_health_router_prefix(self) -> None: + """Verify health_router is configured with /health prefix.""" + from foundry_unify.api import health_router + + assert health_router.prefix == "/health" + + +# Keep asyncio imported to suppress unused import warning from ruff +_ = asyncio diff --git a/tests/unit/test_security_middleware.py b/tests/unit/test_security_middleware.py new file mode 100644 index 0000000..39cbdd4 --- /dev/null +++ b/tests/unit/test_security_middleware.py @@ -0,0 +1,793 @@ +"""Tests for security middleware. + +Covers SecurityHeadersMiddleware, RateLimitMiddleware, SSRFPreventionMiddleware, +and the add_security_middleware factory function. +""" + +from __future__ import annotations + +import time +from typing import Any +from unittest.mock import MagicMock + +import pytest +from fastapi import FastAPI +from fastapi.testclient import TestClient +from starlette.requests import Request +from starlette.responses import PlainTextResponse, Response + +from foundry_unify.middleware.security import ( + RateLimitMiddleware, + SecurityHeadersMiddleware, + SSRFPreventionMiddleware, + add_security_middleware, +) + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + + +def _make_app_with(*_middleware_classes_and_kwargs: Any) -> FastAPI: + """Build a minimal FastAPI app and register an echo route.""" + app = FastAPI() + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + return app + + +def _simple_app(middleware_cls: Any, **kwargs: Any) -> FastAPI: + """Build a FastAPI app with a single middleware and a ping route.""" + app = FastAPI() + app.add_middleware(middleware_cls, **kwargs) + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + return app + + +# --------------------------------------------------------------------------- +# SecurityHeadersMiddleware +# --------------------------------------------------------------------------- + + +class TestSecurityHeadersMiddleware: + """Tests for SecurityHeadersMiddleware.""" + + @pytest.fixture + def client(self) -> TestClient: + """Return TestClient with SecurityHeadersMiddleware.""" + app = _simple_app(SecurityHeadersMiddleware) + return TestClient(app) + + @pytest.mark.unit + def test_x_content_type_options_nosniff(self, client: TestClient) -> None: + """Verify X-Content-Type-Options header is set to nosniff.""" + response = client.get("/ping") + + assert response.headers["X-Content-Type-Options"] == "nosniff" + + @pytest.mark.unit + def test_x_frame_options_deny(self, client: TestClient) -> None: + """Verify X-Frame-Options header is set to DENY.""" + response = client.get("/ping") + + assert response.headers["X-Frame-Options"] == "DENY" + + @pytest.mark.unit + def test_x_xss_protection_set(self, client: TestClient) -> None: + """Verify X-XSS-Protection header is present.""" + response = client.get("/ping") + + assert "X-XSS-Protection" in response.headers + assert "1" in response.headers["X-XSS-Protection"] + + @pytest.mark.unit + def test_content_security_policy_present(self, client: TestClient) -> None: + """Verify Content-Security-Policy header is present.""" + response = client.get("/ping") + + assert "Content-Security-Policy" in response.headers + csp = response.headers["Content-Security-Policy"] + assert "default-src" in csp + + @pytest.mark.unit + def test_referrer_policy_set(self, client: TestClient) -> None: + """Verify Referrer-Policy header is present.""" + response = client.get("/ping") + + assert "Referrer-Policy" in response.headers + + @pytest.mark.unit + def test_permissions_policy_set(self, client: TestClient) -> None: + """Verify Permissions-Policy header is present.""" + response = client.get("/ping") + + assert "Permissions-Policy" in response.headers + + @pytest.mark.unit + def test_server_header_removed(self, client: TestClient) -> None: + """Verify Server header is removed from response.""" + response = client.get("/ping") + + assert "server" not in response.headers + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_hsts_added_for_https_scheme(self) -> None: + """Verify HSTS header is added when request uses HTTPS scheme.""" + from starlette.testclient import TestClient as StarletteClient + + app = _simple_app(SecurityHeadersMiddleware) + https_client = StarletteClient(app, base_url="https://testserver") + response = https_client.get("/ping") + + assert "Strict-Transport-Security" in response.headers + assert "max-age=31536000" in response.headers["Strict-Transport-Security"] + + @pytest.mark.unit + def test_hsts_absent_for_http_scheme(self, client: TestClient) -> None: + """Verify HSTS header is NOT added for plain HTTP requests.""" + response = client.get("/ping") + + assert "Strict-Transport-Security" not in response.headers + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_dispatch_removes_server_header_if_present(self) -> None: + """Verify dispatch removes existing Server header.""" + middleware = SecurityHeadersMiddleware(app=MagicMock()) + + mock_response = MagicMock(spec=Response) + mock_response.headers = {"server": "uvicorn"} + + async def call_next(_req: Request) -> Response: + return mock_response # type: ignore[return-value] + + mock_request = MagicMock(spec=Request) + mock_request.url = MagicMock() + mock_request.url.scheme = "http" + + result = await middleware.dispatch(mock_request, call_next) + + assert "server" not in result.headers + + +# --------------------------------------------------------------------------- +# RateLimitMiddleware +# --------------------------------------------------------------------------- + + +class TestRateLimitMiddleware: + """Tests for RateLimitMiddleware.""" + + @pytest.fixture + def rate_limited_client(self) -> TestClient: + """Return TestClient with a very low rate limit for easy testing.""" + app = _simple_app( + RateLimitMiddleware, + requests_per_minute=3, + burst_size=2, + ) + return TestClient(app) + + @pytest.mark.unit + def test_request_below_limit_succeeds( + self, rate_limited_client: TestClient + ) -> None: + """Verify requests below the rate limit return 200.""" + response = rate_limited_client.get("/ping") + + assert response.status_code == 200 + + @pytest.mark.unit + def test_rate_limit_exceeded_returns_429( + self, rate_limited_client: TestClient + ) -> None: + """Verify exceeding rate limit returns HTTP 429.""" + for _ in range(3): + rate_limited_client.get("/ping") + + response = rate_limited_client.get("/ping") + + assert response.status_code == 429 + + @pytest.mark.unit + def test_rate_limit_response_body(self, rate_limited_client: TestClient) -> None: + """Verify 429 response has expected body fields.""" + for _ in range(3): + rate_limited_client.get("/ping") + + response = rate_limited_client.get("/ping") + body = response.json() + + assert "error" in body + assert "message" in body + assert "retry_after" in body + + @pytest.mark.unit + def test_rate_limit_retry_after_header( + self, rate_limited_client: TestClient + ) -> None: + """Verify 429 response includes Retry-After header.""" + for _ in range(3): + rate_limited_client.get("/ping") + + response = rate_limited_client.get("/ping") + + assert "Retry-After" in response.headers + + @pytest.mark.unit + def test_burst_limit_exceeded_returns_429(self) -> None: + """Verify exceeding burst limit (requests per second) returns 429.""" + app = _simple_app( + RateLimitMiddleware, + requests_per_minute=100, + burst_size=1, + ) + client = TestClient(app) + + r1 = client.get("/ping") + assert r1.status_code == 200 + + r2 = client.get("/ping") + assert r2.status_code == 429 + body = r2.json() + assert "Burst limit exceeded" in body["message"] + + @pytest.mark.unit + def test_burst_limit_response_retry_after_is_1(self) -> None: + """Verify burst limit 429 has Retry-After: 1.""" + app = _simple_app( + RateLimitMiddleware, + requests_per_minute=100, + burst_size=1, + ) + client = TestClient(app) + client.get("/ping") + response = client.get("/ping") + + assert response.headers.get("Retry-After") == "1" + + @pytest.mark.unit + @pytest.mark.asyncio + async def test_dispatch_handles_none_client(self) -> None: + """Verify dispatch handles request with None client gracefully.""" + middleware = RateLimitMiddleware( + app=MagicMock(), + requests_per_minute=60, + burst_size=10, + ) + + mock_request = MagicMock(spec=Request) + mock_request.client = None + + mock_response = PlainTextResponse("ok") + + async def call_next(_req: Request) -> Response: + return mock_response + + result = await middleware.dispatch(mock_request, call_next) + + assert result.status_code == 200 + + +class TestRateLimitCleanup: + """Tests for RateLimitMiddleware._cleanup_stale_entries.""" + + @pytest.mark.unit + def test_cleanup_skipped_before_interval(self) -> None: + """Verify cleanup does not run before cleanup_interval elapses.""" + rl = RateLimitMiddleware( + app=MagicMock(), + requests_per_minute=60, + burst_size=10, + cleanup_interval=3600, + ) + rl.requests["1.2.3.4"] = [time.time()] + original_last = rl._last_cleanup + + rl._cleanup_stale_entries(time.time()) + + assert rl._last_cleanup == original_last + + @pytest.mark.unit + def test_cleanup_removes_stale_ips(self) -> None: + """Verify cleanup removes IPs with only old timestamps.""" + rl = RateLimitMiddleware( + app=MagicMock(), + requests_per_minute=60, + burst_size=10, + cleanup_interval=0, + ) + rl.requests["stale-ip"] = [time.time() - 120] + rl._last_cleanup = 0 + + rl._cleanup_stale_entries(time.time()) + + assert "stale-ip" not in rl.requests + + @pytest.mark.unit + def test_cleanup_keeps_recent_ips(self) -> None: + """Verify cleanup retains IPs with recent timestamps.""" + rl = RateLimitMiddleware( + app=MagicMock(), + requests_per_minute=60, + burst_size=10, + cleanup_interval=0, + ) + rl.requests["recent-ip"] = [time.time() - 5] + rl._last_cleanup = 0 + + rl._cleanup_stale_entries(time.time()) + + assert "recent-ip" in rl.requests + + @pytest.mark.unit + def test_cleanup_trims_over_max_tracked(self) -> None: + """Verify cleanup removes oldest IPs when max_tracked_ips is exceeded.""" + rl = RateLimitMiddleware( + app=MagicMock(), + requests_per_minute=60, + burst_size=10, + max_tracked_ips=2, + cleanup_interval=0, + ) + now = time.time() + rl.requests["oldest"] = [now - 50] + rl.requests["middle"] = [now - 30] + rl.requests["newest"] = [now - 5] + rl._last_cleanup = 0 + + rl._cleanup_stale_entries(now) + + assert len(rl.requests) <= 2 + assert "oldest" not in rl.requests + + +# --------------------------------------------------------------------------- +# SSRFPreventionMiddleware +# --------------------------------------------------------------------------- + + +class TestSSRFPreventionMiddlewareIsPrivateIp: + """Tests for SSRFPreventionMiddleware._is_private_ip static method.""" + + @pytest.mark.unit + @pytest.mark.parametrize( + "ip", + [ + "127.0.0.1", + "10.0.0.1", + "192.168.1.1", + "172.16.0.1", + "::1", + "169.254.1.1", + ], + ) + def test_private_ips_return_true(self, ip: str) -> None: + """Verify private/loopback IPs are detected as private.""" + assert SSRFPreventionMiddleware._is_private_ip(ip) is True + + @pytest.mark.unit + def test_unspecified_address_returns_true(self) -> None: + """Verify the unspecified address (all-zeros) is treated as private.""" + assert SSRFPreventionMiddleware._is_private_ip("0.0.0.0") is True # noqa: S104 + + @pytest.mark.unit + @pytest.mark.parametrize( + "ip", + [ + "8.8.8.8", + "1.1.1.1", + "93.184.216.34", + ], + ) + def test_public_ips_return_false(self, ip: str) -> None: + """Verify public IPs are not flagged as private.""" + assert SSRFPreventionMiddleware._is_private_ip(ip) is False + + @pytest.mark.unit + def test_invalid_ip_returns_false(self) -> None: + """Verify invalid IP strings return False without raising.""" + result = SSRFPreventionMiddleware._is_private_ip("not-an-ip") + + assert result is False + + @pytest.mark.unit + def test_ipv6_mapped_private_ipv4_returns_true(self) -> None: + """Verify IPv4-mapped IPv6 address for private IP is blocked.""" + result = SSRFPreventionMiddleware._is_private_ip("::ffff:192.168.1.1") + + assert result is True + + +class TestSSRFPreventionMiddlewareExtractors: + """Tests for URL extraction static methods.""" + + @pytest.mark.unit + def test_extract_host_from_valid_url(self) -> None: + """Verify host extraction from a standard URL.""" + host = SSRFPreventionMiddleware._extract_host_from_url( + "http://example.com/path" + ) + + assert host == "example.com" + + @pytest.mark.unit + def test_extract_host_returns_none_for_empty(self) -> None: + """Verify host extraction returns None for empty string.""" + host = SSRFPreventionMiddleware._extract_host_from_url("") + + assert host is None or isinstance(host, str) + + @pytest.mark.unit + def test_extract_scheme_from_valid_url(self) -> None: + """Verify scheme extraction from a standard URL.""" + scheme = SSRFPreventionMiddleware._extract_scheme_from_url("ftp://example.com") + + assert scheme == "ftp" + + @pytest.mark.unit + def test_extract_scheme_returns_none_for_empty(self) -> None: + """Verify scheme extraction returns None for empty string.""" + scheme = SSRFPreventionMiddleware._extract_scheme_from_url("") + + assert scheme is None + + +class TestSSRFPreventionMiddlewareIsBlockedUrl: + """Tests for SSRFPreventionMiddleware._is_blocked_url method.""" + + @pytest.fixture + def middleware(self) -> SSRFPreventionMiddleware: + """Return a bare SSRFPreventionMiddleware instance.""" + return SSRFPreventionMiddleware(app=MagicMock()) + + @pytest.mark.unit + @pytest.mark.parametrize( + "url", + [ + "file:///etc/passwd", + "gopher://127.0.0.1:70/", + "dict://localhost:11111/", + "ftp://internal.example.com/file", + ], + ) + def test_blocked_schemes_are_rejected( + self, middleware: SSRFPreventionMiddleware, url: str + ) -> None: + """Verify URLs with blocked schemes are flagged.""" + assert middleware._is_blocked_url(url) is True + + @pytest.mark.unit + @pytest.mark.parametrize( + "url", + [ + "http://localhost/admin", + "http://127.0.0.1/api", + "http://169.254.169.254/latest/meta-data/", + "http://metadata.google.internal/computeMetadata/v1/", + "http://kubernetes.default/", + ], + ) + def test_blocked_hosts_are_rejected( + self, middleware: SSRFPreventionMiddleware, url: str + ) -> None: + """Verify URLs pointing to blocked hostnames are flagged.""" + assert middleware._is_blocked_url(url) is True + + @pytest.mark.unit + def test_private_ip_url_is_blocked( + self, middleware: SSRFPreventionMiddleware + ) -> None: + """Verify URL pointing to a private IP range is blocked.""" + assert middleware._is_blocked_url("http://192.168.1.100/secret") is True + + @pytest.mark.unit + def test_public_url_is_allowed(self, middleware: SSRFPreventionMiddleware) -> None: + """Verify legitimate public URL is not blocked.""" + assert middleware._is_blocked_url("https://api.example.com/data") is False + + @pytest.mark.unit + def test_decimal_ip_obfuscation_blocked( + self, middleware: SSRFPreventionMiddleware + ) -> None: + """Verify decimal integer IP notation for loopback is blocked.""" + # 2130706433 == 127.0.0.1 + assert middleware._is_blocked_url("http://2130706433/") is True + + @pytest.mark.unit + def test_url_without_host_not_blocked( + self, middleware: SSRFPreventionMiddleware + ) -> None: + """Verify URL that cannot be parsed to a host is not blocked.""" + assert middleware._is_blocked_url("not-a-url") is False + + +class TestSSRFPreventionMiddlewareDispatch: + """Tests for SSRFPreventionMiddleware dispatch via FastAPI TestClient.""" + + @pytest.fixture + def client(self) -> TestClient: + """Return TestClient with SSRFPreventionMiddleware.""" + app = _simple_app(SSRFPreventionMiddleware) + return TestClient(app) + + @pytest.mark.unit + def test_normal_request_passes_through(self, client: TestClient) -> None: + """Verify a normal request without URL params is allowed.""" + response = client.get("/ping") + + assert response.status_code == 200 + + @pytest.mark.unit + def test_ssrf_url_in_query_param_blocked(self, client: TestClient) -> None: + """Verify request with SSRF URL in query param returns 400.""" + response = client.get("/ping", params={"url": "http://169.254.169.254/latest"}) + + assert response.status_code == 400 + + @pytest.mark.unit + def test_ssrf_block_response_body(self, client: TestClient) -> None: + """Verify SSRF block response contains expected fields.""" + response = client.get("/ping", params={"url": "http://localhost/admin"}) + body = response.json() + + assert "error" in body + assert "message" in body + assert "SSRF" in body["message"] or "blocked" in body["message"].lower() + + @pytest.mark.unit + def test_legitimate_url_in_query_param_allowed(self, client: TestClient) -> None: + """Verify request with legitimate URL in query param is allowed.""" + response = client.get( + "/ping", params={"callback": "https://api.example.com/hook"} + ) + + assert response.status_code == 200 + + @pytest.mark.unit + def test_non_url_query_param_allowed(self, client: TestClient) -> None: + """Verify query params that are not URL-like are not blocked.""" + response = client.get("/ping", params={"q": "search terms"}) + + assert response.status_code == 200 + + @pytest.mark.unit + def test_blocked_scheme_in_query_param(self, client: TestClient) -> None: + """Verify request with file:// URL in query param is blocked.""" + response = client.get("/ping", params={"src": "file:///etc/passwd"}) + + assert response.status_code == 400 + + +# --------------------------------------------------------------------------- +# add_security_middleware factory +# --------------------------------------------------------------------------- + + +class TestAddSecurityMiddleware: + """Tests for the add_security_middleware factory function.""" + + @pytest.mark.unit + def test_basic_call_does_not_raise(self) -> None: + """Verify add_security_middleware completes without error.""" + app = FastAPI() + + add_security_middleware(app) + + @pytest.mark.unit + def test_rate_limiting_disabled(self) -> None: + """Verify rate limiting can be disabled.""" + app = FastAPI() + + add_security_middleware(app, enable_rate_limiting=False) + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + client = TestClient(app) + for _ in range(5): + r = client.get("/ping") + assert r.status_code == 200 + + @pytest.mark.unit + def test_ssrf_prevention_disabled(self) -> None: + """Verify SSRF prevention can be disabled.""" + app = FastAPI() + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + add_security_middleware(app, enable_ssrf_prevention=False) + client = TestClient(app) + + response = client.get("/ping", params={"url": "http://127.0.0.1/test"}) + assert response.status_code == 200 + + @pytest.mark.unit + def test_https_redirect_enabled(self) -> None: + """Verify HTTPSRedirectMiddleware is added when enable_https_redirect=True.""" + app = FastAPI() + + add_security_middleware(app, enable_https_redirect=True) + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + client = TestClient(app, follow_redirects=False) + response = client.get("/ping") + assert response.status_code in (301, 307) + + @pytest.mark.unit + def test_allowed_hosts_configured(self) -> None: + """Verify TrustedHostMiddleware blocks unknown hosts when allowed_hosts is set.""" + app = FastAPI() + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + add_security_middleware(app, allowed_hosts=["trusted.example.com"]) + + client = TestClient(app, raise_server_exceptions=False) + response = client.get("/ping") + assert response.status_code == 400 + + @pytest.mark.unit + def test_allowed_origins_passed_to_cors(self) -> None: + """Verify CORS middleware is configured with provided allowed_origins.""" + app = FastAPI() + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + add_security_middleware( + app, + allowed_origins=["https://example.com"], + enable_rate_limiting=False, + enable_ssrf_prevention=False, + ) + + client = TestClient(app) + response = client.options( + "/ping", + headers={ + "Origin": "https://example.com", + "Access-Control-Request-Method": "GET", + }, + ) + assert response.status_code in (200, 204) + + @pytest.mark.unit + def test_custom_rate_limit_rpm(self) -> None: + """Verify custom rate_limit_rpm is applied.""" + app = FastAPI() + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + add_security_middleware( + app, + enable_ssrf_prevention=False, + rate_limit_rpm=2, + ) + + client = TestClient(app) + assert client.get("/ping").status_code == 200 + assert client.get("/ping").status_code == 200 + assert client.get("/ping").status_code == 429 + + @pytest.mark.unit + def test_security_headers_present_after_factory(self) -> None: + """Verify security headers are present on responses after factory call.""" + app = FastAPI() + + @app.get("/ping") + async def ping() -> dict[str, str]: + return {"pong": "ok"} + + add_security_middleware( + app, + enable_rate_limiting=False, + enable_ssrf_prevention=False, + ) + + client = TestClient(app) + response = client.get("/ping") + + assert "X-Content-Type-Options" in response.headers + assert "X-Frame-Options" in response.headers + assert "Content-Security-Policy" in response.headers + + +# --------------------------------------------------------------------------- +# Exception path coverage for _extract_host_from_url and _extract_scheme_from_url +# --------------------------------------------------------------------------- + + +class TestSSRFExceptionPaths: + """Tests for exception handler branches in extractor static methods.""" + + @pytest.mark.unit + def test_extract_host_returns_none_on_exception( + self, monkeypatch: pytest.MonkeyPatch + ) -> None: + """Verify _extract_host_from_url returns None when urlparse raises.""" + import urllib.parse as urlparse_module + + def raising_urlparse(_url: str) -> None: + raise ValueError("boom") + + monkeypatch.setattr(urlparse_module, "urlparse", raising_urlparse) + + result = SSRFPreventionMiddleware._extract_host_from_url("http://example.com") + + assert result is None + + @pytest.mark.unit + def test_extract_scheme_returns_none_on_exception( + self, monkeypatch: pytest.MonkeyPatch + ) -> None: + """Verify _extract_scheme_from_url returns None when urlparse raises.""" + import urllib.parse as urlparse_module + + def raising_urlparse(_url: str) -> None: + raise ValueError("boom") + + monkeypatch.setattr(urlparse_module, "urlparse", raising_urlparse) + + result = SSRFPreventionMiddleware._extract_scheme_from_url("http://example.com") + + assert result is None + + @pytest.mark.unit + def test_decimal_ip_above_max_ipv4_not_blocked(self) -> None: + """Verify a decimal host that exceeds 0xFFFFFFFF is not treated as an IP.""" + middleware = SSRFPreventionMiddleware(app=MagicMock()) + # 4294967296 == 2^32, exceeds 0xFFFFFFFF so the decimal-IP branch is skipped + result = middleware._is_blocked_url("http://4294967296/path") + + assert result is False + + @pytest.mark.unit + def test_decimal_ip_public_range_not_blocked(self) -> None: + """Verify decimal notation for a public IP is allowed.""" + middleware = SSRFPreventionMiddleware(app=MagicMock()) + # 134744072 == 8.8.8.8 (public Google DNS) + result = middleware._is_blocked_url("http://134744072/path") + + assert result is False + + @pytest.mark.unit + def test_is_blocked_url_handles_ipaddress_valueerror( + self, monkeypatch: pytest.MonkeyPatch + ) -> None: + """Verify _is_blocked_url catches ValueError from ipaddress.ip_address.""" + import ipaddress as ipaddress_module + + original_ip_address = ipaddress_module.ip_address + + def raising_ip_address(val: Any) -> Any: + if isinstance(val, int): + raise ValueError("forced error") + return original_ip_address(val) + + monkeypatch.setattr(ipaddress_module, "ip_address", raising_ip_address) + + middleware = SSRFPreventionMiddleware(app=MagicMock()) + # 1249739203 is a decimal-notation host within valid IPv4 int range + result = middleware._is_blocked_url("http://1249739203/path") + + assert result is False diff --git a/uv.lock b/uv.lock index efb8348..65bd166 100644 --- a/uv.lock +++ b/uv.lock @@ -987,7 +987,7 @@ name = "exceptiongroup" version = "1.3.1" source = { registry = "https://pypi.org/simple" } dependencies = [ - { name = "typing-extensions", marker = "python_full_version < '3.13'" }, + { name = "typing-extensions", marker = "python_full_version < '3.11'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/50/79/66800aadf48771f6b62f7eb014e352e5d06856655206165d775e675a02c9/exceptiongroup-1.3.1.tar.gz", hash = "sha256:8b412432c6055b0b7d14c310000ae93352ed6754f70fa8f7c34141f91c4e3219", size = 30371, upload-time = "2025-11-21T23:01:54.787Z" } wheels = [ @@ -1534,11 +1534,11 @@ wheels = [ [[package]] name = "idna" -version = "3.13" +version = "3.17" source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/ce/cc/762dfb036166873f0059f3b7de4565e1b5bc3d6f28a414c13da27e442f99/idna-3.13.tar.gz", hash = "sha256:585ea8fe5d69b9181ec1afba340451fba6ba764af97026f92a91d4eef164a242", size = 194210, upload-time = "2026-04-22T16:42:42.314Z" } +sdist = { url = "https://files.pythonhosted.org/packages/b9/28/99c51f664567218d824af024c0251650fb27e4ca066df188dab0769c5b91/idna-3.17.tar.gz", hash = "sha256:5eb0cb53bc467c12eadcf6de83163ad8527cec9416f44b9b61b19caedad2b87f", size = 196048, upload-time = "2026-05-28T14:32:38.55Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/5d/13/ad7d7ca3808a898b4612b6fe93cde56b53f3034dcde235acb1f0e1df24c6/idna-3.13-py3-none-any.whl", hash = "sha256:892ea0cde124a99ce773decba204c5552b69c3c67ffd5f232eb7696135bc8bb3", size = 68629, upload-time = "2026-04-22T16:42:40.909Z" }, + { url = "https://files.pythonhosted.org/packages/de/a7/f76514cc40ad6234098ecdebda08732d75964776c51a42845b7da10649e2/idna-3.17-py3-none-any.whl", hash = "sha256:466e48829084efe2548012b855df21540b96f2e20e51bd124c851536556a592c", size = 65316, upload-time = "2026-05-28T14:32:37.035Z" }, ] [[package]] @@ -3845,15 +3845,15 @@ wheels = [ [[package]] name = "pymdown-extensions" -version = "10.21.2" +version = "10.21.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "markdown" }, { name = "pyyaml" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/df/08/f1c908c581fd11913da4711ea7ba32c0eee40b0190000996bb863b0c9349/pymdown_extensions-10.21.2.tar.gz", hash = "sha256:c3f55a5b8a1d0edf6699e35dcbea71d978d34ff3fa79f3d807b8a5b3fa90fbdc", size = 853922, upload-time = "2026-03-29T15:01:55.233Z" } +sdist = { url = "https://files.pythonhosted.org/packages/9e/26/d1015444da4d952a1ca487a236b522eb979766f0295a0bd0c5fc089989a9/pymdown_extensions-10.21.3.tar.gz", hash = "sha256:72cfcf55f07aea0d4af2c4f11dd4e52466ddfb1bb819673146398e0bd3a77354", size = 854140, upload-time = "2026-05-13T12:57:32.267Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/f7/27/a2fc51a4a122dfd1015e921ae9d22fee3d20b0b8080d9a704578bf9deece/pymdown_extensions-10.21.2-py3-none-any.whl", hash = "sha256:5c0fd2a2bea14eb39af8ff284f1066d898ab2187d81b889b75d46d4348c01638", size = 268901, upload-time = "2026-03-29T15:01:53.244Z" }, + { url = "https://files.pythonhosted.org/packages/7e/85/545a951eecc270fcd688288c600017e2050a1aacb56c711d208586d3e470/pymdown_extensions-10.21.3-py3-none-any.whl", hash = "sha256:d7a5d08014fc571e80ca21dd6f854e31f94c489800350564d55d15b3c41e76b6", size = 269002, upload-time = "2026-05-13T12:57:30.296Z" }, ] [[package]] @@ -5079,15 +5079,15 @@ wheels = [ [[package]] name = "starlette" -version = "1.0.0" +version = "1.2.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "anyio" }, { name = "typing-extensions", marker = "python_full_version < '3.13'" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/81/69/17425771797c36cded50b7fe44e850315d039f28b15901ab44839e70b593/starlette-1.0.0.tar.gz", hash = "sha256:6a4beaf1f81bb472fd19ea9b918b50dc3a77a6f2e190a12954b25e6ed5eea149", size = 2655289, upload-time = "2026-03-22T18:29:46.779Z" } +sdist = { url = "https://files.pythonhosted.org/packages/c5/bf/616a066c2760f6c2b1ae3437cc28149734d069fbb46511712beae118a68c/starlette-1.2.0.tar.gz", hash = "sha256:3c5a6b23fff42492914e93890bb80cbfea72dbf37de268eec06185d62a4ca553", size = 2668923, upload-time = "2026-05-28T11:42:50.568Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/0b/c9/584bc9651441b4ba60cc4d557d8a547b5aff901af35bda3a4ee30c819b82/starlette-1.0.0-py3-none-any.whl", hash = "sha256:d3ec55e0bb321692d275455ddfd3df75fff145d009685eb40dc91fc66b03d38b", size = 72651, upload-time = "2026-03-22T18:29:45.111Z" }, + { url = "https://files.pythonhosted.org/packages/9f/85/492183764d5d01d4514be3730fdb8e228a80605783099551c51627578b5d/starlette-1.2.0-py3-none-any.whl", hash = "sha256:36e0c76ac59157e75dc4b3bdeafba97fb04eaf1878045f15dbef666a6f092ed7", size = 73213, upload-time = "2026-05-28T11:42:48.801Z" }, ] [[package]] @@ -5522,11 +5522,11 @@ wheels = [ [[package]] name = "urllib3" -version = "2.6.3" +version = "2.7.0" source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/c7/24/5f1b3bdffd70275f6661c76461e25f024d5a38a46f04aaca912426a2b1d3/urllib3-2.6.3.tar.gz", hash = "sha256:1b62b6884944a57dbe321509ab94fd4d3b307075e0c2eae991ac71ee15ad38ed", size = 435556, upload-time = "2026-01-07T16:24:43.925Z" } +sdist = { url = "https://files.pythonhosted.org/packages/53/0c/06f8b233b8fd13b9e5ee11424ef85419ba0d8ba0b3138bf360be2ff56953/urllib3-2.7.0.tar.gz", hash = "sha256:231e0ec3b63ceb14667c67be60f2f2c40a518cb38b03af60abc813da26505f4c", size = 433602, upload-time = "2026-05-07T16:13:18.596Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/39/08/aaaad47bc4e9dc8c725e68f9d04865dbcb2052843ff09c97b08904852d84/urllib3-2.6.3-py3-none-any.whl", hash = "sha256:bf272323e553dfb2e87d9bfd225ca7b0f467b919d7bbd355436d3fd37cb0acd4", size = 131584, upload-time = "2026-01-07T16:24:42.685Z" }, + { url = "https://files.pythonhosted.org/packages/7f/3e/5db95bcf282c52709639744ca2a8b149baccf648e39c8cc87553df9eae0c/urllib3-2.7.0-py3-none-any.whl", hash = "sha256:9fb4c81ebbb1ce9531cce37674bbc6f1360472bc18ca9a553ede278ef7276897", size = 131087, upload-time = "2026-05-07T16:13:17.151Z" }, ] [[package]]