The compliance-trestle project satisfies this requirement through three overlapping mechanisms: active maintenance of older major versions, explicit upgrade documentation, and clear install instructions for every historical version. Evidence is drawn directly from the repository.

1. Older versions are actively maintained
   README.md at lines 97–119 declares the support status of every major line:

Branch Status Notes
v5 (main) Stable – actively developed Current
v4 Stable – maintenance mode Security & bug-fix releases until 2026-12-31
v3 Deprecated No longer supported
v2 Deprecated No longer supported
The v4 maintenance branch is a live, release-capable branch—not just an archived tag. docs/contributing/maintenance_releases.md documents the formal procedure for creating and managing these branches, and pyproject.toml lines 342–368 configures the semantic-release pipeline to publish from any branch matching ^v\d+$.

2. Detailed upgrade path is documented
   docs/upgrading.md provides a dedicated upgrade guide. It covers:

v4 → v5: Breaking changes (minimum Python raised from 3.10 → 3.11, interface changes), with step-by-step migration instructions.
Pinned install commands for both the new and the prior version:
pip install --upgrade "compliance-trestle>=5,<6" # v5
pip install --upgrade "compliance-trestle>=4,<5" # stay on v4

A "Still on v4?" section explicitly acknowledging users who cannot yet upgrade.
3. Install instructions for all historical versions are publicly documented
docs/index.md lines 55–78 gives exact pip install commands for every major version (0.37.x through 5.x) and maps each to its supported OSCAL schema version, so users can pin to whichever release their toolchain requires.

4. Version history is publicly traceable
   CHANGELOG.md contains a full release log from v0.x through the current v5.1.0, giving a complete audit trail of changes between versions.

Supporting URLs
Resource URL
PyPI release history https://pypi.org/project/compliance-trestle/#history
All branches (v4, v5, main, develop) https://github.com/oscal-compass/compliance-trestle/branches/all
Upgrade guide (docs/upgrading.md rendered) https://oscal-compass.github.io/compliance-trestle/upgrading/
Maintenance releases process https://oscal-compass.github.io/compliance-trestle/contributing/maintenance_releases/
CHANGELOG https://github.com/oscal-compass/compliance-trestle/blob/main/CHANGELOG.md
Conclusion: The project keeps the previous major version (v4) alive with security/bug-fix patches, documents a clear v4→v5 upgrade path with exact pip commands and interface-change details, and publishes install commands for all historical versions on its public documentation site—fully satisfying the [maintenance_or_update] requirement.

Reports are tracked under GIT issues.
https://github.com/oscal-compass/compliance-trestle/issues

New issues are reviewed at least bi-weekly by the maintainers.

OpenSSF Silver — vulnerability_report_credit Criterion Met

Requirement: The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for reporters who request anonymity. If no vulnerabilities were resolved in the last 12 months, select N/A.

Justification: All vulnerability reports resolved in the last 12 months are published as GitHub Security Advisories. Each advisory includes a first-class Credits field that formally names every reporter by GitHub login and role. Credits are only shown for reporters who accepted attribution — those who requested anonymity are excluded automatically. This mechanism satisfies the criterion without any supplementary documentation.

Verification steps:

1. Navigate to the project's Security Advisories page.
2. Open each advisory published or resolved within the last 12 months.
3. Confirm the Credits section lists at least one reporter with state: accepted, or that no external reporters were involved.

Key URLs

• Security Advisories — compliance-trestle ← primary evidence URL
• GHSA-w76h-q7c6-jpjp — SSRF advisory with three accepted reporter credits
• SECURITY.md — project security policy

Per security-insights.yml: repository.documentation.security-policy=https://github.com/oscal-compass/community/blob/main/SECURITY.md [osps_vm_01_01]

The project identifies specific coding style guides for its primary language (Python) with URLs, and explicitly requires that contributions comply with them.

The CONTRIBUTING.md file, under the "Code style and formatting" section, states:

"All contributions must comply with the following coding style guides:"

and lists the following with direct URLs:

Scope Style guide URL
Python — general style PEP 8 – Style Guide for Python Code https://peps.python.org/pep-0008/
Python — type annotations PEP 484 – Type Hints https://peps.python.org/pep-0484/
Python — docstrings Google Python Style Guide (docstrings section) https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
Python — security SEI CERT Python Coding Standard https://wiki.sei.cmu.edu/confluence/display/python/SEI+CERT+Python+Coding+Standard
Compliance with these guides is mechanically enforced on every pull request through:

ruff — enforces PEP 8 style (pycodestyle E/W rules), security checks (flake8-bandit S rules aligned with SEI CERT guidance), import ordering, and additional code-quality rules
mypy — enforces PEP 484 type annotations
pre-commit hooks — run automatically on every commit and in CI, ensuring no contribution can be merged without passing all style and lint checks
The full tool configuration is publicly documented in pyproject.toml ([tool.ruff] and [tool.mypy] sections) and .pre-commit-config.yaml.

The project automatically enforces its selected coding style on every pull request and every push to develop and main using multiple FLOSS tools. All tool configuration is committed to the repository.

Tools and their enforcement scope:

Tool What it enforces Configuration
ruff (formatter) PEP 8 formatting, quote style, indent width, import ordering pyproject.toml [tool.ruff.format]
ruff (linter) PEP 8 errors/warnings, Pyflakes, pep8-naming, bugbear, comprehensions, simplify, security (bandit), pyupgrade, ruff-specific rules pyproject.toml [tool.ruff.lint]
mypy PEP 484 type annotation correctness pyproject.toml [tool.mypy]
mdformat Markdown document formatting .pre-commit-config.yaml
Enforcement layers — no contribution can bypass all three:

Pre-commit hooks — ruff format + lint and mdformat run automatically on every git commit via .pre-commit-config.yaml. Hooks are installed and kept current by make develop.
PR CI pipeline — the lint job in .github/workflows/python-test.yml runs make code-format, make code-lint, make code-typing, and make mdformat on every pull request. The build job in .github/workflows/python-push.yml repeats the same checks on every push to develop and main. A PR cannot be merged if these steps fail.
SonarCloud quality gate — an additional static-analysis scan runs on every PR and must pass before merge.
Exceptions — rare and documented in-code:

Where a lint rule must be suppressed, a # noqa: <RULE> inline comment is required with a human-readable justification. Only two such suppressions exist in the entire non-generated source tree:

trestle/core/commands/author/jinja.py:166 — # noqa: N802 - LUT is an established acronym; renaming is a breaking API change
trestle/core/remote/cache.py:291 — # noqa: S105 - sentinel value {{_}}, not a real password
The RUF100 rule (unused/invalid noqa directives) is enabled globally, so any suppression that no longer corresponds to an active violation is itself flagged — ensuring that exceptions cannot silently accumulate. All project-level rule exceptions in pyproject.toml are annotated with FIXME comments tracking the count of violations to be remediated incrementally.

The OpenSSF Best Practices criterion [build_standard_variables] states:

"If no native binaries are being generated, select "not applicable" (N/A)."

This project (compliance-trestle) is a pure Python package managed with Hatchling (pyproject.toml). It contains no native C/C++/Rust/Go source files or compiled extensions that generate native binary executables/libraries requiring compiler and linker flags (CC, CFLAGS, CXX, CXXFLAGS, LDFLAGS).

build_preserve_debug — Justification
Criterion met: N/A (Not Applicable)

compliance-trestle is a pure Python library. It contains no compiled native code, no C/C++ extensions, no Rust crates, and no other compiled language components. Therefore:

CFLAGS / CXXFLAGS / debug-stripping flags are entirely irrelevant — there are no binaries, shared objects (.so), or other compiled artifacts to strip.
The build backend is hatchling (declared in pyproject.toml), which assembles pure-Python source distributions (.tar.gz) and wheels (.whl). Both formats contain only .py source files and data assets — no native compilation step is involved.
The install command used internally (pip install -e .[dev] in Makefile) does not invoke install -s, strip flags, or any equivalent that could remove debugging information, because there is nothing binary to strip.
Release builds use python -m build (see pyproject.toml:343-346) which likewise produces pure-Python wheel and sdist archives.
Python's own .pyc bytecode files (which CPython generates at import time) do carry debug information (line numbers, co_filename, etc.) and are never stripped by the build or install process. The clean target removes leftover .pyc files from the source tree only for housekeeping — it does not affect installed packages.
Conclusion: Because compliance-trestle has no compiled language components, the build_preserve_debug criterion is N/A. The concept of preserving compiler debug information (-g flags, DWARF sections, .pdb files, etc.) and avoiding stripping (install -s) simply does not apply to this project. Python's inherent source-level debuggability is always fully preserved by the standard hatchling/pip build and install pipeline.

build_non_recursive — Assessment: Met ✅
Here's the analysis of the compliance-trestle project's build system against this criterion:

Build System
The project uses Hatchling (PEP 517/518 backend) declared in pyproject.toml:

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

The wheel target explicitly packages the entire trestle package in a single invocation:

[tool.hatch.build.targets.wheel]
packages = ["trestle"]

Why This Criterion Is Met
Factor Finding
Build invocation Single hatch build from the repository root — no recursive subdirectory traversal
Nested Makefiles / make -C None found
Independent subproject builds None — all of trestle/common/, trestle/core/, trestle/tasks/, trestle/oscal/, etc. are modules within one package, not separate build units
Cross-dependencies Extensive cross-imports exist between subdirectories, but they are irrelevant to the build because no recursive build is attempted
The Cross-Dependency Note (Why It Would Be a Problem If It Were Recursive)
The subdirectories are heavily interdependent — e.g., trestle/tasks/xlsx_helper.py imports from trestle.core.catalog, trestle.oscal, and trestle.common. If the project used a recursive make-style build with per-subdirectory independence, this would cause broken dependency ordering. However, because Hatchling packages the entire trestle/ tree as a single unit from the root, there is no such problem.

Answer
Met — The project does not use a recursive build system. It uses a single-invocation Hatchling build that packages the whole trestle package at once, avoiding the recursive-make anti-pattern entirely.

Build Repeatability Assessment: N/A
This project should be marked Not Applicable (N/A) for the build_repeatable criterion.

Justification
compliance-trestle is a pure Python scripting/library project. There is no compilation step. Python source files (.py) are distributed and executed directly — no binary artifacts (.o, .so, .a, executables, .wasm, etc.) are produced from source that would need to be reproduced bit-for-bit.

What the project actually does:

Activity Nature Compilation?
hatch build Packages .py source files into a .whl/.tar.gz archive No — archives source as-is
make gen-oscal Runs scripts/gen_oscal.py → generates .py model files from JSON schemas Generates source files, not compiled binaries
python -m build (semantic-release) Builds sdist + wheel via pyproject.toml / hatchling Packages Python source; no compilation
Tests, linting, typing Runtime checks against source Not a build
The wheels (.whl) produced are "pure Python" wheels — they contain .py source files verbatim, no compiled C extensions. The build backend is hatchling, which is a source-packaging tool that zips up the trestle/ directory as declared in the [tool.hatch.build.targets.wheel] stanza.

Recommended justification text:

This project is a pure Python library (compliance-trestle). No compilation of source to binary occurs. The build process (hatch build / python -m build) packages Python source files (.py) and data directly into a standard sdist .tar.gz and a pure-Python .whl archive using hatchling as the build backend. Because no compiled artifacts are produced from source code, the bit-for-bit reproducibility requirement for compiled builds does not apply. The gen_oscal.py code generation step produces Python source files (not binaries), and those generated files are committed to the repository and tracked in version control. Select: N/A.

[installation_common] — Met ✅
The compliance-trestle project fully satisfies this criterion through two standard, commonly-used Python conventions:

1. PyPI package — pip install
   The project is published to PyPI as compliance-trestle. Any user can install the software in a single command:

pip install compliance-trestle

And uninstall equally simply:

pip uninstall compliance-trestle

This is the dominant convention for Python language-level package management. pyproject.toml is the package manifest, using hatchling as the build backend, and defines the entry-point console script trestle that becomes available after install.

2. Documented installation guide
   docs/installation.md provides a complete, step-by-step installation guide covering:

Python version prerequisites
Virtual environment setup
pip install compliance-trestle
Post-install verification (trestle -h)
Workspace initialization
The README.md also explicitly states and links to this guide.

Justification text (for the badge form)
compliance-trestle is distributed as a Python package on PyPI under the name compliance-trestle and can be installed via the standard language-level package manager: pip install compliance-trestle and uninstalled with pip uninstall compliance-trestle. The package is built using hatchling with a standard pyproject.toml, exposes the trestle console script entry point, and includes a dedicated installation guide at docs/installation.md. This satisfies the requirement for a commonly-used installation convention.

Answer: Met

Justification:

compliance-trestle is a Python package distributed via the standard pip/PyPA ecosystem. Its build backend is hatchling (declared in pyproject.toml), and its artifacts are published as a wheel and sdist via hatch build (see Makefile:106) and uploaded to PyPI.

End-users install the package with:

pip install compliance-trestle

This installation path fully honors the standard Python installation conventions, including:

--prefix / --target – pip respects these to redirect the install destination.
DESTDIR – when building the wheel and installing via pip into a staging root (common in OS packaging, e.g., RPM/DEB %install phases), pip install --root <DESTDIR> is the standard mechanism, and it is fully supported because the package is a compliant wheel.
Virtual environments – the primary recommended installation target, where VIRTUAL_ENV drives the prefix automatically.
--user – honors PYTHONUSERBASE per PEP 370.
Because the project delegates entirely to pip + hatchling (a PEP 517/518-compliant build backend) rather than implementing a bespoke installer, it inherits all of pip's support for standard installation-location variables with no extra work required. There is no custom install script that would need to be audited for DESTDIR compliance — the standard toolchain handles it.

Verdict: Met — the installation system is the standard Python/pip toolchain, which honors DESTDIR, --prefix, --root, VIRTUAL_ENV, and PYTHONUSERBASE as per platform and pip conventions.

Met

Justification: The project provides a conventional Makefile development setup command:

make develop

This command:

Initializes required Git submodules used by tests via make submodules.
Installs Hatch, the project’s development environment manager.
Installs the project in editable mode with all development dependencies using pip install -e .[dev].
The development dependency set is defined in pyproject.toml, and the Hatch test environment installs the required test tooling, including pytest, coverage support, parallel test execution, randomized tests, and mypy (pyproject.toml).

Tests can then be run using the documented convention:

make test

as defined in Makefile and documented in CONTRIBUTING.md.

Key URLs for the justification:

Development setup instructions:

https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md#setup---developing-trestle

Documents make develop, dependency installation, submodule setup, and make test.

Development command definitions:

https://github.com/oscal-compass/compliance-trestle/blob/develop/Makefile

Defines the develop, submodules, test, test-all, and coverage targets.

Project dependency and test configuration:

https://github.com/oscal-compass/compliance-trestle/blob/develop/pyproject.toml

Defines the [dev] optional dependencies and Hatch test environment.

End-user installation guide:

https://oscal-compass.github.io/compliance-trestle/latest/installation/

Documents Python virtual-environment installation and validation.

Quick Start guide:

https://oscal-compass.github.io/compliance-trestle/latest/quick-start/

Provides a quick path to installing and initializing a Trestle workspace.

A concise justification with URLs could be:

Met. The project uses the commonly adopted make convention through Makefile. Developers can run make develop to initialize test submodules and install the editable project with development dependencies, then run make test to execute the test suite. These steps are documented in the Contributing guide, while the development and test dependencies are defined in pyproject.toml.

OpenSSF external_dependencies Criterion — Status: Met ✅
The criterion requires:

"The project MUST list external dependencies in a computer-processable way."

How compliance-trestle satisfies it
The project uses pyproject.toml — the modern, standardised Python packaging manifest (PEP 517 / PEP 621) — as its single source of truth for all external dependencies. This file is machine-readable by all standard Python tooling (pip, hatch, build, dependency scanners, etc.).

All dependency categories are declared in pyproject.toml:

Section Purpose Examples
[project.dependencies] (line 35–55) Runtime dependencies pydantic, cryptography, requests, Jinja2, …
[project.optional-dependencies] typing (line 59–65) Type-checking extras mypy, types-paramiko, …
[project.optional-dependencies] docs (line 67–82) Documentation extras mkdocs, mkdocstrings, …
[project.optional-dependencies] dev (line 84–91) Development / release tooling pre-commit, pylint, gitpython, …
[tool.hatch.envs.hatch-test].dependencies (line 127–133) Test runner dependencies pytest, pytest-xdist, coverage, …
Justification URL
The canonical, publicly reachable location of this file is:

https://github.com/oscal-compass/compliance-trestle/blob/develop/pyproject.toml

This is the URL you should enter as the External dependencies justification URL in the OpenSSF Best Practices badge submission. It directly links to the computer-processable dependency manifest in the project's default development branch.

Status: Met
Dependency Monitoring Justification
The oscal-compass/compliance-trestle project satisfies the [dependency_monitoring] requirement through multiple, layered, automated controls operating in CI/CD and on a recurring schedule:

1. Snyk SCA — Primary Dependency Vulnerability Scanner
   Tool: Snyk (Software Composition Analysis)
   Evidence: .github/actions/snyk-test/action.yaml · .github/workflows/python-test.yml · .snyk

On every qualifying pull request, the CI pipeline runs snyk test against a compiled requirements.txt derived from pyproject.toml. This scans all transitive Python dependencies for known CVEs.
Known, accepted exceptions (e.g., SNYK-PYTHON-ORJSON-15123465, SNYK-PYTHON-PARAMIKO-16425764) are documented in .snyk with justifications, expiry dates, and risk acceptance rationale — satisfying the "verify as unexploitable / accepted risk" path.
License policy violations are similarly tracked (e.g., MPL-2.0 for certifi and pathspec, approved via CNCF exceptions).
Key URL: https://snyk.io

2. GitHub Dependabot — Automated Weekly Dependency Updates
   Tool: GitHub Dependabot
   Evidence: .github/dependabot.yml

Configured for weekly automated PRs covering both:
pip Python package dependencies
github-actions CI action pin updates
Opens up to 10 PRs per cycle, keeping dependencies continuously patched against newly discovered vulnerabilities.
Key URL: https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates

3. OpenSSF Scorecard — Supply-Chain Security Posture
   Tool: OpenSSF Scorecard
   Evidence: .github/workflows/scorecard.yml

Runs weekly (every Saturday) and on every push to develop.
Scorecard evaluates supply-chain risk factors including dependency pinning, token permissions, and branch protection — complementing direct vulnerability scanning.
Key URLs:

https://scorecard.dev/viewer/?uri=github.com/oscal-compass/compliance-trestle
https://github.com/ossf/scorecard
4. SonarCloud — SAST with Dependency & Security Rules
Tool: SonarCloud
Evidence: .github/workflows/python-test.yml · docs/code-review-policy.md

Runs on every PR as a mandatory merge gate (no PR may merge while SonarCloud checks fail).
Detects security vulnerabilities in source code including insecure dependency usage patterns.
Key URL: https://sonarcloud.io/project/overview?id=compliance-trestle

5. Ruff / flake8-bandit — Static Security Linting
   Evidence: pyproject.toml ("S" ruleset enabled)

The S (flake8-bandit security) ruleset is enforced on every commit via ruff linting, catching insecure API usage that may relate to dependency misuse.
Summary Table
Control Tool Frequency Scope
Dependency CVE scan Snyk Every PR All Python transitive deps
Automated patch PRs Dependabot Weekly pip + GitHub Actions
Supply-chain posture OpenSSF Scorecard Weekly + push Repository-wide
Code security gate SonarCloud Every PR (mandatory) Source + security rules
Static security lint Ruff/Bandit Every commit Source code
The combination of Snyk (reactive CVE detection) + Dependabot (proactive patching) + Scorecard (supply-chain posture) provides continuous, automated coverage of the [dependency_monitoring] requirement across both direct and transitive dependencies.

updateable_reused_components — Met ✅
The project fully satisfies this criterion. All reused external components are managed through the standard Python ecosystem package management toolchain, making them trivially identifiable and updatable. Evidence:

Standard package manager — pyproject.toml
All runtime and development dependencies are declared in the [project.dependencies] and [project.optional-dependencies] sections of pyproject.toml, following PEP 518 and PEP 621. There are no vendored or embedded copies of third-party libraries anywhere in the repository. Every dependency is resolved, fetched, and installed at build/install time by pip / hatch.

No local (forked) convenience copies
A search of the repository found no vendor/, third_party/, or equivalent directories. The only git submodule (.gitmodules) is nist-content, which is upstream OSCAL reference content — not a code library — and does not need to be patched as a security update path.

Automated dependency update bot — .github/dependabot.yml
GitHub Dependabot is configured for both pip packages and github-actions on a weekly schedule. When a new version of any dependency is released (including security patches), Dependabot automatically opens a pull request to update pyproject.toml, ensuring no vulnerable version is left in place silently.

package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
Version constraints allow patching — pyproject.toml
Most dependencies use >= or = (compatible-release) constraints, not exact pins, so security patch releases from upstream are automatically picked up by installers:
"cryptography>=46.0.7"
"requests>=2.32.2"
"pydantic[email]>=2.11.0"
"openpyxl=3.0"

The handful of exact pins (e.g., paramiko==5.0.0, Jinja2==3.1.6) are tracked by Dependabot and have documented rationale in .snyk where relevant.

Vulnerability scanning in CI — .snyk
The project integrates Snyk for dependency vulnerability scanning. Accepted exceptions carry explicit reasons and expiry dates, ensuring no silent or permanent vulnerability suppression.

Build toolchain — pyproject.toml
The build backend is hatchling (declared in [build-system]), and the test/dev environment manager is hatch. Both are standard, well-maintained Python ecosystem tools. All dependency resolution happens through pip at environment creation time — no build-time vendoring or code copying occurs.

Summary: compliance-trestle uses the Python pip/hatch/pyproject.toml standard ecosystem exclusively for all reused components. There are no embedded library copies. Dependabot provides automated weekly pull requests for any upstream update, including security patches. This makes identifying and updating every reused component straightforward.

Package / Dependency Management
PyPI package page: https://pypi.org/project/compliance-trestle/ — the canonical distribution point; consumers install from here via pip install compliance-trestle
Source repository: https://github.com/oscal-compass/compliance-trestle
Automated Dependency Updates
Dependabot config: https://github.com/oscal-compass/compliance-trestle/blob/develop/.github/dependabot.yml — proves automated weekly pip + github-actions update PRs are in place
Vulnerability Scanning
Snyk policy: https://github.com/oscal-compass/compliance-trestle/blob/develop/.snyk — shows active scanning with documented, time-bounded exceptions
Dependency Declaration
pyproject.toml: https://github.com/oscal-compass/compliance-trestle/blob/develop/pyproject.toml — the single authoritative source of all declared dependencies with version constraints

[interfaces_current] Assessment — compliance-trestle
Criterion: The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the technology stack.

Verdict: ✅ MET — with two minor soft-deprecation notes worth tracking.

Technology Stack
Language: Python ≥ 3.11 (tested: 3.11, 3.12, 3.13, 3.14 — pyproject.toml)
Core framework: Pydantic ≥ 2.11.0
Build system: Hatchling
Key libraries: importlib_resources, requests, Jinja2, cryptography, openpyxl
Findings
✅ CLEAN — No use of removed/broken deprecated APIs
Category What was checked Result
collections.Callable/Mapping/MutableMapping Moved to collections.abc in 3.3, removed in 3.10 ✅ Not used
distutils Deprecated 3.10, removed in 3.12 ✅ Not used (was removed per CHANGELOG)
imp module Deprecated 3.4, removed in 3.12 ✅ Not used
asyncio.coroutine Removed in 3.11 ✅ Not used
datetime.utcnow() Deprecated since 3.12, fixed per CHANGELOG ✅ Not used
pkg_resources Deprecated; replaced by importlib.metadata ✅ Removed (per CHANGELOG)
xml.etree.cElementTree Deprecated since 3.3 ✅ Not used
unittest.mock Uses stdlib unittest.mock, not external mock package ✅ Correct
Pydantic v1 APIs (parse_obj, @validator, dict(), inner Config) Fully removed patterns ✅ Pydantic v2 APIs used throughout
DeprecationWarning suppression filterwarnings/simplefilter ✅ None found
Logging % string formatting Lazy %s interpolation is the correct logging pattern ✅ Correct
⚠️ Soft-Deprecated — Functional, no runtime warnings, tracked for future migration

1. typing.List, typing.Dict, typing.Tuple, typing.Set, typing.Optional, typing.Union

Used in 103 files across trestle/, e.g. trestle/common/file_utils.py:25, trestle/core/base_model.py:32, all trestle/oscal/*.py files.

Status: Soft-deprecated per PEP 585 (Python 3.9+) in favour of built-in generics (list[str], dict[str, Any], etc.)
Runtime impact: None — no DeprecationWarning is emitted at runtime. These names are not scheduled for removal in any current Python roadmap.
Rationale for not blocking: The project's OSCAL models in trestle/oscal/ are auto-generated by datamodel-code-generator (evidenced by the comment in tests/trestle/core/models/element_path_test.py:224: "Newer datamodel-code-generator versions generate list[X] instead of typing.List[X]"). Upgrading the generator will naturally resolve this.
2. constr()/conint() from Pydantic

Used in all 9 trestle/oscal/*.py files, e.g. trestle/oscal/catalog.py:33.

Status: Documented as "will be deprecated in Pydantic 3.0" (pydantic/types.py:165) — not yet deprecated in the current version (2.13.4). Alternative is Annotated[str, StringConstraints(...)].
Runtime impact: None currently.
Rationale: These are also auto-generated by datamodel-code-generator from OSCAL JSON schemas. When Pydantic 3.0 is released, the generator update will address this.
3. importlib_resources backport dependency

Used in trestle/core/commands/author/versioning/template_versioning.py:24 and trestle/core/commands/init.py:24.

Status: The importlib_resources package is a backport of importlib.resources. Since this project requires Python ≥ 3.11, the stdlib importlib.resources.files() API (available since 3.9) is fully available and the backport dependency is redundant — though not deprecated in the harmful sense.
Runtime impact: None — the backport is API-compatible with the stdlib. It is an unnecessary third-party dependency for the declared Python floor.
Summary Justification
The project meets [interfaces_current]:

All removed deprecated APIs (Python standard library and Pydantic v1) have been actively cleaned up — confirmed by the CHANGELOG and verified by codebase search with zero hits.
The two soft-deprecations found (typing generics and Pydantic constr/conint) are: (a) not yet emitting runtime warnings, (b) not scheduled for removal in any current release, and (c) rooted in auto-generated code that will be fixed organically when the upstream code generator is updated.
The redundant importlib_resources backport has no negative functional impact.
CI tests across Python 3.11–3.14 ensure no silently-broken deprecated APIs slip through.
Key references:

PEP 585 – Type Hinting Generics In Standard Collections
Pydantic v2 Migration Guide
Python 3.12 What's New – Removed
importlib.resources docs (Python 3.11)

[automated_integration_testing] Justification
What the criterion requires
An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure.

Both requirements are fully satisfied.

1 — Automated test suite on every check-in
Two GitHub Actions workflows enforce this:

Workflow Trigger Branch(es) File
Trestle PR pipeline pull_request (all PRs) + push to develop develop + every PR target .github/workflows/python-test.yml
Trestle Deploy push to main and v[0-9]* release branches main, release branches .github/workflows/python-push.yml
Every check-in to the primary shared branch (develop) and every pull-request check-in triggers the full python-test.yml pipeline automatically — satisfying the "each check-in / at least one branch" requirement.

2 — Test suite execution
Tests run via pytest under the Hatch test runner, across a matrix of:

OS: Ubuntu, macOS, Windows
Python: 3.11 (min) and 3.14 (max), defined dynamically from version.json
Relevant configuration from pyproject.toml:

[tool.pytest.ini_options]
minversion = "6.2"
testpaths = ["tests"]

[tool.hatch.envs.hatch-test]
default-args = ["tests"]
parallel = true
randomize = true
dependencies = ["coverage[toml]~=7.4", "pytest>=8.1", "pytest-xdist[psutil]>=3.5", ...]

The test job in python-test.yml runs:

hatch test -py <version> for non-core matrix cells
hatch test --cover -py <version> for the core cell (Ubuntu + max Python)
3 — Test report produced
The suite produces reports at two levels:

a) GitHub Actions pass/fail status — every job exit code is reported natively in the GitHub Actions UI. The develop branch CI badge is published directly on the README:

b) Coverage XML report → SonarCloud — the core test cell generates coverage.xml, uploads it as a GitHub Actions artifact, and then the sonar job consumes it:

python-test.yml

• name: Generate coverage report
  run: coverage xml
• name: Upload artifact
  uses: actions/upload-artifact@...
  with:
  name: coverage
  path: coverage.xml

sonar job

• name: SonarQube Scan
  uses: SonarSource/sonarqube-scan-action@...
  with:
  args: -Dsonar.python.coverage.reportPaths=coverage.xml ...
• name: SonarQube Quality Gate check
  uses: sonarsource/sonarqube-quality-gate-action@...

The SonarCloud quality gate badge is also published on the README:

Key URLs
Resource URL
PR/develop CI workflow https://github.com/oscal-compass/compliance-trestle/actions/workflows/python-test.yml
Deploy/main CI workflow https://github.com/oscal-compass/compliance-trestle/actions/workflows/python-push.yml
SonarCloud dashboard https://sonarcloud.io/dashboard?id=compliance-trestle
SonarCloud coverage badge https://sonarcloud.io/api/project_badges/measure?project=compliance-trestle&metric=coverage
SonarCloud quality gate badge https://sonarcloud.io/api/project_badges/measure?project=compliance-trestle&metric=alert_status
OpenSSF Best Practices entry https://www.bestpractices.dev/projects/9408

[regression_tests_added50] — REQUIREMENT MET ✅

Justification:

Over the last six months (since 2026-03-10), the compliance-trestle project on GitHub (oscal-compass/compliance-trestle) has fixed approximately 28 distinct code-logic bugs and added regression tests for at least 20 of them — a ratio of approximately 71%, which exceeds the required 50% threshold.

Representative examples with test evidence:

Bug Fix PR Description Test File(s) Added/Extended
#2347 Pydantic v1→v2 migration issue tests/trestle/core/base_model_test.py (+33 lines)
#2222 ssp-generate KeyError on missing profile-param-value-origin tests/trestle/core/commands/author/ssp_test.py (+213 lines)
#2286 is_ordered_sublist matching substrings across list items tests/trestle/utils/list_utils_test.py (+7 lines)
#2177 Allow empty parameter labels in OSCAL imports tests/trestle/core/base_model_test.py (+63), tests/trestle/core/commands/import__test.py (+53)
#2171 Resolve indexed terminal alias in model-utils tests/trestle/utils/fs_test.py (+179 lines)
#2190 Handle optional by_components in SSP assemble merge tests/trestle/core/commands/author/ssp_test.py (+101 lines)
#2226 Bad HTML filtering regexp (CodeQL) tests/trestle/core/markdown/markdown_node_test.py (+35 lines)
#2209 Handle dotted directory paths in trash resolution tests/trestle/utils/trash_test.py (+33 lines)
#2146 Preserve dotted catalog names in validate -a tests/trestle/core/commands/validate_test.py (+16), tests/trestle/utils/fs_test.py (+12)
#2130 Timezone-aware datetimes in cache _time_since_modification tests/trestle/core/remote/cache_test.py (+30 lines)
#2118 Correct error path in assemble command tests/trestle/core/commands/author/ (assemble tests)
#2186 Handle missing metadata in version command tests/trestle/core/commands/version_test.py (+31 lines)
macOS path fix Path security validator behaviour on macOS tests/trestle/core/remote/cache_security_test.py (+14 lines)
#2166 Avoid duplicate file read in cache get_raw tests/trestle/core/remote/cache_test.py (+18 lines)
#2193 Clean up distributed subdir after merge tests/trestle/core/commands/merge_test.py (+2 lines)
Key URLs:

Repository: https://github.com/oscal-compass/compliance-trestle
Test suite directory: tests/trestle/
Example high-coverage fix PR: https://github.com/oscal-compass/compliance-trestle/pull/2222 (SSP KeyError — 213-line test addition)
Example regression test PR: https://github.com/oscal-compass/compliance-trestle/pull/2171 (indexed alias — 179-line test addition)
The project consistently enforces the practice of pairing bug fixes with regression tests in the same PR, as evidenced across all categories of fixes (commands, cache, markdown, model utilities, file system utilities, and task code).

test_statement_coverage80 — Justification
The compliance-trestle project meets the ≥80% statement coverage criterion. Here is the complete evidence:

Tool Used: coverage.py (via coverage[toml]~=7.4)
Python's industry-standard coverage.py is declared as an explicit dependency in pyproject.toml under the hatch-test environment:

[tool.hatch.envs.hatch-test]
dependencies = [
"coverage[toml]~=7.4",
...
]

Coverage is configured at pyproject.toml with parallel, multi-process collection:

[tool.coverage.run]
relative_files = true
parallel = true
concurrency = ["thread", "multiprocessing"]

Coverage is Enforced in CI/CD
The GitHub Actions workflow .github/workflows/python-test.yml runs tests with coverage on every PR and push to develop, generates a coverage.xml artifact, and feeds it into SonarQube Quality Gate:

hatch test --cover runs the full test suite with coverage instrumentation
coverage xml generates the XML report
The XML is uploaded as a workflow artifact and passed to SonarCloud at sonar.python.coverage.reportPaths=coverage.xml
The SonarQube Quality Gate step (line 276) fails the build if the gate does not pass — enforcing coverage as a mandatory merge requirement
Live Coverage Badge
The README.md displays a live SonarCloud coverage badge:

https://sonarcloud.io/api/project_badges/measure?project=compliance-trestle&metric=coverage

SonarCloud dashboard: https://sonarcloud.io/dashboard?id=compliance-trestle

This badge reflects the current measured statement coverage from the latest CI run.

Test Suite Scale
The project has 122 Python test files under tests/ covering all major subsystems, run across 3 OSes (Ubuntu, macOS, Windows) and multiple Python versions (3.11–3.14) as shown in the CI matrix at .github/workflows/python-test.yml.

Key URLs
Resource URL
SonarCloud coverage dashboard https://sonarcloud.io/dashboard?id=compliance-trestle
Live coverage badge https://sonarcloud.io/api/project_badges/measure?project=compliance-trestle&metric=coverage
CI workflow (coverage steps) https://github.com/oscal-compass/compliance-trestle/blob/develop/.github/workflows/python-test.yml
pyproject.toml (coverage config) https://github.com/oscal-compass/compliance-trestle/blob/develop/pyproject.toml
OpenSSF Best Practices entry https://www.bestpractices.dev/projects/9408

Justification
The requirement is satisfied by four mutually reinforcing, written, machine-enforced mechanisms:

1. Formal Written Policy in CONTRIBUTING.md — Explicit MUST language
   CONTRIBUTING.md line 41:

"Contributors must include test cases to meet at least the minimum code coverage requirements."

CONTRIBUTING.md line 195–201:

"Tests must exist for at least 96% of trestle Python code. … A PR without sufficient test coverage will fail the trestle CI process and will not be approved or merged."

This is a direct, formal, written policy using mandatory language. It explicitly ties new code (including new functionality) to test coverage requirements, and states that failure blocks merge.

2. Automated Enforcement via CI Pipeline — python-test.yml
   The CI workflow Trestle PR pipeline runs automatically on every pull request and every push to develop. It:

Runs the full test suite (make test) across Ubuntu, macOS, and Windows on both minimum and maximum supported Python versions (lines 160–219)
Collects and uploads a coverage report (lines 221–231)
Submits coverage to SonarCloud with a Quality Gate check that must pass before merging (lines 233–281)
A PR cannot be merged if tests fail or coverage falls below the Quality Gate threshold.

3. SonarCloud Quality Gate — sonarcloud.io
   The SonarCloud Quality Gate is a named, external gating system that enforces coverage and test metrics on every PR. The workflow step SonarQube Quality Gate check is configured to fail the pipeline if the gate is not passed. The project's SonarCloud dashboard is also linked directly in the PR template (see below).

4. Pull Request Template Checklist — .github/PULL_REQUEST_TEMPLATE/develop.md
   Every PR to develop is presented with a mandatory checklist that includes:

"My PR meets testing requirements."
"All new and existing tests passed."

And links directly to the SonarCloud coverage dashboard:

"Sonar coverage"

Key URLs
Evidence URL
Formal policy (CONTRIBUTING.md) https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md#code-testing
CI pipeline definition https://github.com/oscal-compass/compliance-trestle/blob/develop/.github/workflows/python-test.yml
PR template checklist https://github.com/oscal-compass/compliance-trestle/blob/develop/.github/PULL_REQUEST_TEMPLATE/develop.md
SonarCloud Quality Gate https://sonarcloud.io/project/overview?id=compliance-trestle

https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md

Trestle updating, testing and release logistics

"Contributors must include test cases to meet at least the minimum code coverage requirements."

The project uses Code formatting (yapf) and code linting (flake8) to flag code issues with both errors or warnings, depending on the issue. The project also use sonar https://sonarcloud.io/project/overview?id=compliance-trestle.

Status: Met

compliance-trestle is a software project that produces an OSCAL authoring and validation CLI tool. Secure design principles apply in full. The sections below map each principle to concrete, verifiable evidence in the codebase.

1. Fail-Safe Defaults
   Access decisions should deny by default; installation should be secure by default.

Evidence Location
HTTPS-only remote access. HTTP is unconditionally rejected; only https:// and sftp:// are permitted. security.py:149-162
Loopback, link-local, cloud-metadata endpoints always blocked. ALWAYS_BLOCKED_NETWORKS and METADATA_HOSTNAMES apply regardless of configuration. security.py:50-77
Private-IP blocking is an opt-in relaxation. SigningManifestDiscovery sets block_private_ips = True by default; callers must explicitly pass allow_private_uris=True. signing_manifest_discovery.py:45-57
Workspace-boundary enforcement is on by default. validate_local_file_path requires paths inside the workspace root unless the caller explicitly passes allow_outside_workspace=True. security.py:446-549
No-overwrite default for signed output. trestle sign raises TrestleError if the output file already exists and --overwrite was not requested. signing.py:119-147
Bounded resource defaults. Maximum discovered artifacts (1,000), depth (64), per-file size (50 MiB), and aggregate remote size (500 MiB) are fixed constants that prevent resource-exhaustion. signing_manifest_discovery.py:34-39
Safe YAML loading by default. YAML(typ='safe') is used everywhere YAML is parsed, preventing arbitrary Python-object construction. file_utils.py:223-237
Defusedxml for XML parsing. The defusedxml library is a declared dependency, blocking XML-bomb, XXE, and entity-expansion attacks. pyproject.toml:35-55
Default packaged config contains no credentials or permissive settings. config.ini
2. Complete Mediation
Every access that might be limited must be checked for authority; checks must be non-bypassable.

Evidence Location
Double validation for remote fetches. URLSecurityValidator.validate_url() is called both in the fetcher constructor and immediately before requests.get() in _do_fetch(), mitigating DNS-rebinding/TOCTOU attacks. cache.py:264-337
Every remote URL is fully parsed, DNS-resolved, canonicalized, and checked against blocked networks, metadata hostnames, and optional domain allowlist. security.py:80-129
IPv4-mapped IPv6 addresses are canonicalized to their IPv4 form before network checks, preventing bypass via ::ffff:127.0.0.1. security.py:216-230
Path-traversal checks at every file access boundary (URL paths for cache, resolved cache paths, trestle:// URIs, local workspace paths, signing output paths, manifest artifact paths). security.py:306-549, signing_manifest.py:213-236
Cryptographic authority verification. Signature verification checks DSSE envelope structure, in-toto statement type, predicate type, canonicalization algorithm, digest algorithm, and the SHA-256 digest of the canonical document — any mismatch raises an error. signing.py:182-232
Constant-time digest comparison (hmac.compare_digest) for signed package verification, preventing timing-oracle attacks. signing_manifest.py:136-191
Validated Pydantic model loading wraps all OSCAL model deserialization; validation errors are surfaced, not silently accepted. trestle_base_model.py:27-66
Symlink rejection at both signing output and remote-artifact vendoring paths. signing.py:119-147, signing_manifest_discovery.py:197-233
Cycle detection and recursion-depth limiting in manifest dependency discovery, with finally guaranteeing stack cleanup. signing_manifest_discovery.py:70-97
3. Economy of Mechanism (Keep It Simple)
Evidence Location
Dedicated security.py module centralizes all SSRF, path-traversal, and sensitive-file logic in one well-named place, making the security surface easy to audit. remote/security.py
Normalized exception handling converts all security violations to TrestleError, providing a single control-flow path. Throughout
4. Least Privilege / Credential Hygiene
Evidence Location
Credentials must be environment-variable references (mustache template syntax). Literal credential strings are rejected at parse time. cache.py:275-311
Documented in internal spec: Credentials MUST NOT be stored in cleartext. caching_spec.md:131-164
5. Defense-in-Depth / Input Validation
Evidence Location
SSTI prevention. Jinja2 template delimiters ({{, }}) in OSCAL prose are neutralized before output, applied at every prose-writing boundary. ssp_io.py:36-48
Security-tested Jinja2 sandbox with autoescape=True and tests confirming RCE-payload blocking. tags_security_test.py
Directory/task name validation rejects absolute paths, traversal segments, hidden names, reserved names, and file-extension names. file_utils.py:95-133
Sensitive-file denylist blocks access to credentials, SSH keys, cloud configuration, /proc, /sys, logs, and DB directories even when outside-workspace access is explicitly granted. security.py:446-549
Reject-unknown-fields validation in manifest parsing. signing_manifest.py:213-236
Bandit (flake8-bandit S rules) enabled in Ruff linting, providing static security analysis on every CI run. pyproject.toml:205-220
6. Open Design / Documented Security Properties
Evidence Location
CLI tutorial documents SSRF protections, limit constants, signature-verification steps, and HTTPS-only policy. docs/tutorials/cli.md:656-696
Caching spec documents HTTPS requirement and credential-handling policy. internal_spec_documents/caching_spec.md
Summary
The project implements all applicable secure-design principles from the know_secure_design framework:

Fail-safe defaults — deny-by-default for private networks, symlinks, path traversal, HTTP, and unknown fields; secure resource limits; safe parsers out of the box.
Complete mediation — every remote fetch, local file access, path lookup, and cryptographic verification goes through a non-bypassable validation layer before the operation executes.
Economy of mechanism — security logic is consolidated in dedicated, auditable modules.
Least privilege — credentials are env-var references; explicit opt-ins required for any relaxation.
Defense-in-depth — layered validation (URL → DNS → IP → path → size → type → signature), SSTI neutralization, sandbox testing, and static security linting.