compliance-trestle

Los proyectos que siguen las mejores prácticas a continuación pueden autocertificarse voluntariamente y demostrar que han obtenido una insignia de mejores prácticas de Open Source Security Foundation (OpenSSF).

No existe un conjunto de prácticas que pueda garantizar que el software nunca tendrá defectos o vulnerabilidades; incluso los métodos formales pueden fallar si las especificaciones o suposiciones son incorrectas. Tampoco existe ningún conjunto de prácticas que pueda garantizar que un proyecto mantenga una comunidad de desarrollo saludable y que funcione bien. Sin embargo, seguir las mejores prácticas puede ayudar a mejorar los resultados de los proyectos. Por ejemplo, algunas prácticas permiten la revisión por parte de múltiples personas antes del lanzamiento, lo que puede ayudar a encontrar vulnerabilidades técnicas que de otro modo serían difíciles de encontrar y ayudar a generar confianza y un deseo repetido de interacción entre desarrolladores de diferentes compañías. Para obtener una insignia, se deben cumplir todos los criterios DEBE y NO DEBE, se deben cumplir, así como todos los criterios DEBERÍAN deben cumplirse o ser justificados, y todos los criterios SUGERIDOS se pueden cumplir o incumplir (queremos que se consideren al menos). Si desea añadir texto como justificación mediante un comentario genérico, en lugar de ser un razonamiento de que la situación es aceptable, comience el bloque de texto con '//' seguido de un espacio. Los comentarios son bienvenidos a través del sitio de GitHub mediante "issues" o "pull requests". También hay una lista de correo electrónico para el tema principal.

Con mucho gusto proporcionaríamos la información en varios idiomas, sin embargo, si hay algún conflicto o inconsistencia entre las traducciones, la versión en inglés es la versión autorizada.
Si este es su proyecto, por favor muestre el estado de su insignia en la página de su proyecto. El estado de la insignia se ve así: El nivel de insignia para el proyecto 9408 es passing Aquí se explica cómo insertarla:
Puede mostrar el estado de su insignia insertando esto en su archivo markdown:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9408/badge)](https://www.bestpractices.dev/projects/9408)
o insertando esto en su HTML:
<a href="https://www.bestpractices.dev/projects/9408"><img src="https://www.bestpractices.dev/projects/9408/badge"></a>


Estos son los criterios de nivel Plata. También puede ver los criterios de nivel Básico o Oro.

Baseline Series: Nivel Base 1 Nivel Base 2 Nivel Base 3

        

 Fundamentos 17/17

  • General

    Tenga en cuenta que otros proyectos pueden usar el mismo nombre.

    An opinionated tooling platform for managing compliance as code, using continuous integration and NIST's OSCAL standard.

    Por favor use formato de expresión de licencia SPDX; los ejemplos incluyen "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT" y "(BSD-2-Clause OR Ruby)". No incluya comillas simples o comillas dobles.
    Si hay más de un lenguaje, enumérelos como valores separados por comas (los espacios son opcionales) y ordénelos de más a menos usado. Si hay una lista larga, por favor enumere al menos los tres primeros más comunes. Si no hay lenguaje (por ejemplo, este es un proyecto solo de documentación o solo de pruebas), use el carácter único "-". Por favor use una capitalización convencional para cada lenguaje, por ejemplo, "JavaScript".
    La Common Platform Enumeration (CPE) es un esquema de nomenclatura estructurado para sistemas de tecnología de la información, software y paquetes. Se utiliza en varios sistemas y bases de datos al reportar vulnerabilidades.
  • Prerrequisitos


    El proyecto DEBE lograr una insignia de nivel aprobado. [achieve_passing]

  • Contenido básico del sitio web del proyecto


    La información sobre cómo contribuir DEBE incluir los requisitos para contribuciones aceptables (por ejemplo, una referencia a cualquier estándar de codificación requerido). (URL requerida) [contribution_requirements]
  • Supervisión del proyecto


    El proyecto DEBERÍA tener un mecanismo legal donde todos los desarrolladores de cantidades no triviales de software del proyecto afirmen que están legalmente autorizados para hacer estas contribuciones. El enfoque más común y fácilmente implementado para hacer esto es usando un Certificado de Origen del Desarrollador (DCO), donde los usuarios agregan "signed-off-by" en sus commits y el proyecto enlaza al sitio web DCO. Sin embargo, esto PUEDE implementarse como un Acuerdo de Licencia de Contribuidor (CLA), u otro mecanismo legal. (URL requerida) [dco]
    El DCO es el mecanismo recomendado porque es fácil de implementar, se rastrea en el código fuente, y git soporta directamente una función "signed-off" usando "commit -s". Para ser más efectivo, es mejor si la documentación del proyecto explica qué significa "signed-off" para ese proyecto. Un CLA es un acuerdo legal que define los términos bajo los cuales las obras intelectuales han sido licenciadas a una organización o proyecto. Un acuerdo de asignación de contribuidor (CAA) es un acuerdo legal que transfiere derechos en una obra intelectual a otra parte; no se requiere que los proyectos tengan CAAs, ya que tener CAA aumenta el riesgo de que los contribuidores potenciales no contribuyan, especialmente si el receptor es una organización con fines de lucro. Los CLAs de Apache Software Foundation (la licencia de contribuidor individual y el CLA corporativo) son ejemplos de CLAs, para proyectos que determinan que los riesgos de estos tipos de CLAs para el proyecto son menores que sus beneficios.

    The project uses the Developer Certificate of Origin (DCO) 1.1 — the same mechanism used by the Linux Kernel community (https://developercertificate.org). This is documented in CONTRIBUTING.md (https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md), which explains what Signed-off-by means for this project, provides an example trailer (Signed-off-by: John Doe john.doe@example.com), and instructs contributors to use git commit --signoff. DCO sign-off is technically enforced on every pull request by a dedicated CI workflow (https://github.com/oscal-compass/compliance-trestle/blob/develop/.github/workflows/verify-signoff.yml) that checks every non-merge commit to confirm the Signed-off-by trailer is present and matches the commit author's email address, blocking the PR if it does not.



    El proyecto DEBE definir y documentar claramente su modelo de gobernanza del proyecto (la forma en que toma decisiones, incluyendo roles clave). (URL requerida) [governance]
    Necesita haber alguna forma bien establecida y documentada de tomar decisiones y resolver disputas. En proyectos pequeños, esto puede ser tan simple como "el propietario del proyecto y líder toma todas las decisiones finales". Hay varios modelos de gobernanza, incluyendo dictador benevolente y meritocracia formal; para más detalles, ver Modelos de gobernanza. Tanto los enfoques centralizados (por ejemplo, un solo mantenedor) como los descentralizados (por ejemplo, grupo de mantenedores) se han utilizado con éxito en proyectos. La información de gobernanza no necesita documentar la posibilidad de crear un fork del proyecto, ya que eso siempre es posible para proyectos FLOSS.

    URL (primary):
    https://github.com/oscal-compass/community/blob/main/GOVERNANCE.md

    URL (secondary — roles):
    https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md

    Justification text:

    The compliance-trestle project is governed under the OSCAL Compass community governance model, documented at https://github.com/oscal-compass/community/blob/main/GOVERNANCE.md. This document defines all key roles (Member, Reviewer, Maintainer, Oversight Committee), the two-tier decision-making process (lazy consensus for day-to-day decisions; explicit simple or supermajority voting via GitVote for formal decisions), dispute resolution (escalation to the Oversight Committee with binding authority), and the process for electing and removing leadership. Detailed role requirements and responsibilities are in https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md. Active project maintainers are listed in the project-level MAINTAINERS.md.



    El proyecto DEBE adoptar un código de conducta y publicarlo en una ubicación estándar. (URL requerida) [code_of_conduct]
    Los proyectos pueden ser capaces de mejorar la civilidad de su comunidad y establecer expectativas sobre la conducta aceptable adoptando un código de conducta. Esto puede ayudar a evitar problemas antes de que ocurran y hacer que el proyecto sea un lugar más acogedor para fomentar contribuciones. Esto debe enfocarse solo en el comportamiento dentro de la comunidad/lugar de trabajo del proyecto. Ejemplos de códigos de conducta son el código de conducta del kernel de Linux, el Código de Conducta del Pacto del Contribuidor, el Código de Conducta de Debian, el Código de Conducta de Ubuntu, el Código de Conducta de Fedora, el Código de Conducta de GNOME, el Código de Conducta de la Comunidad KDE, el Código de Conducta de la Comunidad Python, La Guía de Conducta de la Comunidad Ruby, y El Código de Conducta de Rust.

    URL:
    https://github.com/oscal-compass/community/blob/main/CODE_OF_CONDUCT.md

    Justification text:

    The project adopts the CNCF Code of Conduct, hosted at the OSCAL Compass community level at https://github.com/oscal-compass/community/blob/main/CODE_OF_CONDUCT.md. It is referenced from the project README.md ("Participation in the OSCAL Compass community is governed by the Code of Conduct") and from the project's documentation site at https://oscal-compass.github.io/compliance-trestle/latest/contributing/code_of_conduct/.



    El proyecto DEBE definir y documentar públicamente claramente los roles clave en el proyecto y sus responsabilidades, incluyendo cualquier tarea que esos roles deban realizar. DEBE quedar claro quién tiene qué rol(es), aunque esto podría no estar documentado de la misma manera. (URL requerida) [roles_responsibilities]
    La documentación para gobernanza y roles y responsabilidades puede estar en un solo lugar.

    URL (primary — role definitions):
    https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md

    Justification text:

    Key roles and their responsibilities are defined in https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md, which documents the Member, Reviewer, Maintainer, and Oversight Committee roles — including requirements to hold each role, specific responsibilities, and privileges. Who holds each role is publicly named in two places: project-level maintainers (Maintainer role) are listed with their GitHub handles in https://github.com/oscal-compass/compliance-trestle/blob/develop/MAINTAINERS.md, and org-level role holders (Oversight Committee, Org Admins, Community Maintainers) are listed with their GitHub handles and affiliations in https://github.com/oscal-compass/community/blob/main/MAINTAINERS.md.



    El proyecto DEBE poder continuar con una interrupción mínima si cualquier persona muere, queda incapacitada o de otro modo no puede o no está dispuesta a continuar el soporte del proyecto. En particular, el proyecto DEBE poder crear y cerrar issues, aceptar cambios propuestos y lanzar versiones de software, dentro de una semana de confirmación de la pérdida de soporte de cualquier individuo. Esto PUEDE hacerse asegurando que alguien más tenga las claves, contraseñas y derechos legales necesarios para continuar el proyecto. Los individuos que ejecutan un proyecto FLOSS PUEDEN hacer esto proporcionando claves en una caja de seguridad y un testamento que proporcione los derechos legales necesarios (por ejemplo, para nombres DNS). (URL requerida) [access_continuity]

    Access Continuity Explanation for OpenSSF Best Practices [access_continuity]

    The project satisfies the access continuity requirement through shared organization administration, distributed maintainership, and documented governance procedures:

    1. Multi-Admin and Multi-Org Redundancy: Administrative access, credentials, and repository rights across the oscal-compass organization are shared among multiple Org Admins from different member organizations, plus a Linux Foundation backstop account (thelinuxfoundation). This ensures that operations (managing issues, merging pull requests, releasing software) can proceed without disruption if any single person is lost.
    2. Succession and Vacancy Rules: Formal vacancy appointment and governance policies allow the multi-member Oversight Committee to reallocate responsibilities and maintain uninterrupted project continuity within one week.

    Reference URLs



    El proyecto DEBERÍA tener un "factor de autobús" de 2 o más. (URL requerida) [bus_factor]
    Un "factor de autobús" (también conocido como "factor de camión") es el número mínimo de miembros del proyecto que tienen que desaparecer repentinamente de un proyecto ("ser atropellados por un autobús") antes de que el proyecto se paralice debido a la falta de personal conocedor o competente. La herramienta truck-factor puede estimar esto para proyectos en GitHub. Para más información, ver Assessing the Bus Factor of Git Repositories de Cosentino et al.

    OpenSSF Silver — bus_factor Justification
    Project: OSCAL Compass · Criterion ID: bus_factor

    Criterion
    The project SHOULD have a bus factor of 2 or more.
    URL
    https://github.com/oscal-compass/community/blob/main/GOVERNANCE.md#access-continuity
    Justification
    OSCAL Compass maintains a bus factor of 2 or more. The project's Access Continuity governance section documents that no single person is a point of failure. A six-member Oversight Committee drawn from at least three independent organizations (IBM, Red Hat, Sunstone Secure) collectively holds all necessary repository access, credentials, and legal rights. Multiple Org Admins — including a Linux Foundation backstop — ensure continuity of operations. Project knowledge is actively distributed across contributors from different organizations, so the project can continue to function within one week of losing any individual contributor. Vacancies are filled by appointment per the documented Vacancies process.


  • Documentación


    El proyecto DEBE tener una hoja de ruta documentada que describa lo que el proyecto tiene la intención de hacer y no hacer durante al menos el próximo año. (URL requerida) [documentation_roadmap]
    Es posible que el proyecto no logre la hoja de ruta, y eso está bien; el propósito de la hoja de ruta es ayudar a los posibles usuarios y colaboradores a comprender la dirección prevista del proyecto. No necesita ser detallada.

    ROADMAP.md is a dedicated, top-level file that explicitly describes what the OSCAL Compass project intends to do (5 named goals covering codebase maintenance, agentic authoring, community growth, OpenSSF Best Practices, and CNCF Incubation) and not do (enterprise support, certification authority functions, vulnerability scanning, and legacy format support) over the next year.

    Key URL:

    https://github.com/oscal-compass/community/blob/main/ROADMAP.md
    The document is intentionally high-level (not feature-by-feature), which is exactly what the criterion expects — enough for potential users and contributors to understand the project's direction without requiring exhaustive detail.



    El proyecto DEBE incluir documentación de la arquitectura (también conocida como diseño de alto nivel) del software producido por el proyecto. Si el proyecto no produce software, seleccione "no aplicable" (N/A). (URL requerida) [documentation_architecture]
    Una arquitectura de software explica las estructuras fundamentales de un programa, es decir, los componentes principales del programa, las relaciones entre ellos y las propiedades clave de estos componentes y relaciones.

    documentation_architecture — Compliance Evidence
    Project: compliance-trestle (oscal-compass) · Criterion: The project MUST include documentation of the architecture (high-level design) of the software it produces.

    Requirement Summary
    A software architecture explains a program's fundamental structures — its major components, the relationships among them, and the key properties of those components and relationships. The criterion requires at least one URL pointing to that documentation.

    Primary URL (Published Documentation)
    Live architecture page
    https://oscal-compass.github.io/compliance-trestle/latest/architecture/
    This is the publicly hosted, versioned architecture page rendered from the project's MkDocs-Material documentation site. It is permanently accessible under the latest alias managed by mike.

    Secondary URL (Repository Source)
    Markdown source in repository (develop branch)
    https://github.com/oscal-compass/compliance-trestle/blob/develop/docs/architecture.md
    The architecture document is tracked under version control alongside the code it describes at docs/architecture.md.

    What the Architecture Document Covers
    The document addresses all three elements the criterion requires.

    1. Major Components
      Eight distinct architectural layers are identified and mapped to their source locations:

    Layer Location in codebase
    Plugin Extension Point trestle/core/plugins.py
    Entry Points — CLI & Python API trestle/cli.py, trestle/core/repository.py
    Command Layer trestle/core/commands/
    Catalog API trestle/core/catalog/
    Profile Resolver trestle/core/profile_resolver.py, trestle/core/resolver/
    Validator Framework trestle/core/validator.py, trestle/core/validator_factory.py
    Markdown / Jinja / DrawIO Authoring trestle/core/control_{reader,writer}.py, trestle/core/markdown/, trestle/core/jinja/, trestle/core/draw_io.py
    Signing & Canonicalization trestle/core/signing.py, trestle/core/canonicalization.py
    Transform & Task Pipeline trestle/transforms/, trestle/tasks/
    OSCAL Object Model trestle/oscal/, trestle/core/base_model.py
    Workspace & Remote I/O trestle/common/, trestle/core/remote/cache.py
    2. Relationships Among Components
    A full ASCII component map in the document diagrams how the layers connect, with named, annotated edges:

    Plugin packages inject CommandBase subclasses into Trestle.subcommands at module import time.
    The CLI and Python API both dispatch to the Command Layer.
    Commands delegate business logic to Core Services (Catalog API, Profile Resolver, Validators, Authoring, Signing).
    All Core Services read and write through the OSCAL Object Model.
    The OSCAL Object Model serialises to/from Workspace & Remote I/O.
    3. Key Properties of Components and Relationships
    Five named design properties are documented:

    Property Description
    Workspace-centric storage A .trestle/-rooted directory tree; documents may be single files or split into sub-directory hierarchies following the object hierarchy.
    Schema-enforced I/O Every disk read/write passes through the Pydantic v2 model layer, guaranteeing schema validity at the boundary between disk and memory.
    Composable pipelines Pipeline / Filter pattern (trestle/core/pipeline.py) used for profile resolution and OSCAL assembly; stages are independently testable and reusable.
    Separation of concerns: CLI vs. API Commands delegate to core service classes; repository.py exposes the same services to Python callers without going through the CLI argument layer.
    Extensibility via plugins The trestle_* package naming convention allows third-party command packages to be auto-discovered without any core dependency on them.
    The document also includes a Security Requirements & Guarantees section specifying what users can and cannot rely on: input validation, SSRF protection, Jinja sandboxing, cryptographic provenance (DSSE / in-toto), supply chain integrity (SLSA), plugin trust boundaries, and encryption-at-rest limitations.

    Integration with Broader Documentation Site
    The architecture page is a top-level navigation item in the project's documentation site at https://oscal-compass.github.io/compliance-trestle/latest/, which is referenced from the project README.md:

    "Complete documentation, tutorials, and background on compliance can be found here."
    Criterion Satisfaction Summary
    Criterion element Status Evidence
    URL to architecture documentation ✅ Met oscal-compass.github.io/…/architecture/
    Source file in repository ✅ Met docs/architecture.md (develop branch)
    Major components identified ✅ Met 11 layers named and mapped to source paths
    Relationships among components ✅ Met ASCII component map with labeled directional edges
    Key properties of components/relationships ✅ Met 5 named design properties + security guarantees section
    Versioned & publicly accessible ✅ Met MkDocs-Material + mike, always available at /latest/architecture/



    El proyecto DEBE documentar lo que el usuario puede y no puede esperar en términos de seguridad del software producido por el proyecto (sus "requisitos de seguridad"). (URL requerida) [documentation_security]
    Estos son los requisitos de seguridad que el software tiene la intención de cumplir.

    documentation_security — Compliance Evidence
    Project: compliance-trestle (oscal-compass) · Criterion: The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required)

    Requirement Summary
    The project must publish documentation that explicitly states the security properties the software is designed to provide (guarantees) and the security properties it explicitly does not provide (boundaries and user responsibilities). At least one URL is required.

    URL 1 — Architecture: Security Requirements & Guarantees Section
    Published documentation page (direct anchor)
    https://oscal-compass.github.io/compliance-trestle/latest/architecture/#security-requirements-guarantees
    Markdown source in repository (develop branch)
    https://github.com/oscal-compass/compliance-trestle/blob/develop/docs/architecture.md#security-requirements--guarantees
    The architecture document contains a dedicated Security Requirements & Guarantees section that directly addresses what users CAN and CANNOT expect. It is structured in exactly the two-part form the criterion requires:

    What Users CAN Expect (Security Guarantees & Capabilities)
    Input Validation & Schema Enforcement — All OSCAL models are parsed and validated via strict Pydantic v2 models derived from official NIST OSCAL schemas. Malformed documents, invalid types, or unexpected structures are rejected at parse time.
    SSRF & Remote Resource Protection — Remote resource retrieval (trestle/core/remote/cache.py and trestle/core/remote/security.py) enforces HTTPS/SFTP and includes SSRF protections. Cloud metadata endpoints (e.g., 169.254.169.254, metadata.google.internal) and loopback addresses are blocked unconditionally. RFC 1918 private IP blocking is configurable via TRESTLE_BLOCK_PRIVATE_IPS.
    Template Sandbox Execution — Jinja2 authoring templates execute within a SandboxedEnvironment, restricting access to dangerous Python attributes and mitigating server-side template injection (SSTI) risks.
    Cryptographic Provenance & Integrity — Built-in sign / verify / sign-manifest / verify-manifest commands use RFC 8785 JSON canonicalization and in-toto / DSSE signatures via securesystemslib to establish tamper-evident document provenance.
    Supply Chain Integrity — Release distributions include SLSA build provenance attestations and PyPI trusted publishing.
    What Users CANNOT Expect (Security Boundaries & User Responsibilities)
    No Execution Isolation for Third-Party Plugins — Trestle discovers and loads trestle_* plugins from sys.path without sandboxing. Users are responsible for ensuring installed plugins are trusted.
    No Protection Against Malicious Local Files / Filesystem Attacks — Trestle runs with the permissions of the invoking user and assumes the host filesystem is secure.
    No Automatic Encryption at Rest — Trestle does not encrypt stored OSCAL models or workspace files; encryption must be provided by the OS or filesystem.
    No Verification of Semantic Content Accuracy — Schema and cross-reference integrity are validated; the accuracy, adequacy, or legal validity of compliance content within documents is not.
    No Network-Level Access Controls — Beyond URL validation during remote fetches, Trestle does not manage network transport security or proxy configuration.
    URL 2 — SECURITY.md (Repository Security Policy)
    SECURITY.md in repository
    https://github.com/oscal-compass/compliance-trestle/blob/develop/SECURITY.md
    SECURITY.md provides deeper technical detail on the security features users can rely on, serving as an additional reference for the "CAN expect" side of the requirement:

    Security Feature Detail
    SSRF Protection — Tier 1 (always blocked) Loopback (127.0.0.0/8, ::1/128), link-local (169.254.0.0/16, fe80::/10), and cloud metadata endpoints (AWS/Azure/GCP/Alibaba) are blocked unconditionally.
    SSRF Protection — Tier 2 (configurable) RFC 1918 private ranges (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) allowed by default; blocked when TRESTLE_BLOCK_PRIVATE_IPS=true. Private-IP accesses are logged as warnings.
    Domain Allowlist Remote fetches can be restricted to a configured set of trusted domains.
    Path Traversal Protection URL path validation blocks .. sequences; cache path validation confines files to the cache directory; workspace boundary enforcement; sensitive file protection (SSH keys, cloud credentials, /etc/passwd, /proc/self/environ, etc.).
    Scheme Restrictions Only HTTPS and SFTP are permitted for remote URLs. HTTP, FTP, and other schemes are rejected.
    Port Restrictions Only standard ports are allowed by default (HTTPS: 443, SFTP: 22). Non-standard ports are blocked unless explicitly configured.
    Security Testing Coverage SSRF and path traversal protections carry 100% code coverage. Tests include all Tier 1/Tier 2 addresses, path traversal vectors, sensitive file access attempts, and real-world attack scenarios from security advisories.
    Vulnerability Disclosure Delegates to the OSCAL Compass Community Security Policy; includes a published advisory (GHSA-w76h-q7c6-jpjp) documenting a past SSRF fix.
    Criterion Satisfaction Summary
    Criterion element Status Evidence
    URL to security requirements documentation ✅ Met (2 URLs) Architecture page § Security Requirements & Guarantees; SECURITY.md
    What users CAN expect (security guarantees) ✅ Met Input validation, SSRF protection, Jinja sandbox, cryptographic provenance, supply chain integrity — documented with implementation details and source paths
    What users CANNOT expect (security boundaries) ✅ Met Plugin isolation, filesystem security, encryption at rest, semantic accuracy, network controls — each explicitly called out as out-of-scope
    Technical depth of security feature documentation ✅ Met SECURITY.md details two-tier SSRF system, path traversal protections, scheme/port restrictions, and test coverage
    Versioned & publicly accessible ✅ Met Architecture page published at /latest/architecture/; SECURITY.md in develop branch on GitHub



    El proyecto DEBE proporcionar una guía de "inicio rápido" para nuevos usuarios para ayudarles a hacer algo rápidamente con el software. (URL requerida) [documentation_quick_start]
    La idea es mostrar a los usuarios cómo comenzar y hacer que el software haga algo. Esto es de importancia crítica para que los posibles usuarios puedan comenzar.

    REQUIREMENT: documentation_quick_start

    The project MUST provide a "quick start" guide for new users
    to help them quickly do something with the software. (URL required)

    HOW IT IS MET

    File : docs/quick-start.md
    URL : https://oscal-compass.github.io/compliance-trestle/latest/quick-start/

    The guide walks a new user through five steps in under five minutes:

    1. Install: pip install compliance-trestle
    2. Init: trestle init
    3. Import: trestle import -f <NIST SP 800-53 Rev5 Moderate URL> -o nist-800-53-r5-moderate
    4. Validate: trestle validate -f catalogs/nist-800-53-r5-moderate/catalog.json
    5. Explore: trestle describe -f catalogs/nist-800-53-r5-moderate/catalog.json

    Each step includes expected terminal output.
    The guide is also linked from README.md (line 73).

    REFERENCES

    Source : docs/quick-start.md
    URL : https://oscal-compass.github.io/compliance-trestle/latest/quick-start/



    El proyecto DEBE hacer un esfuerzo para mantener la documentación consistente con la versión actual de los resultados del proyecto (incluido el software producido por el proyecto). Cualquier defecto de documentación conocido que lo haga inconsistente DEBE ser corregido. Si la documentación es generalmente actual, pero incluye erróneamente alguna información antigua que ya no es verdadera, simplemente trátelo como un defecto, luego rastree y corrija como de costumbre. [documentation_current]
    La documentación PUEDE incluir información sobre diferencias o cambios entre versiones del software y/o enlaces a versiones anteriores de la documentación. La intención de este criterio es que se haga un esfuerzo por mantener la documentación consistente, no que la documentación deba ser perfecta.

    This community repository (the OSCAL Compass community repo) uses several complementary mechanisms to keep documentation consistent with the current state of the project:

    1. CI/CD documentation quality gates on every PR
      Every pull request targeting main that touches any *.md file is automatically checked by two GitHub Actions workflows:

    .github/workflows/docs.yml — runs markdownlint-cli2 across all Markdown files. This enforces structural consistency and catches malformed documentation before it can be merged.
    .github/workflows/ci.yml — runs spellcheck (pyspelling + aspell) on every Markdown file. A custom wordlist at .github/wordlist.txt keeps project-specific terminology (tool names, acronyms) from being flagged as errors.
    Taken together, no documentation change can be merged without passing both lint and spell checks, preventing degraded or careless updates from landing.

    1. OSCAL proposal validation keeps structured docs in sync
      .github/workflows/proposals.yml installs Trestle (the project's own tool) from requirements.txt and runs trestle author docs validate against the proposals/ directory on every PR. This means the project eats its own dog food — the same OSCAL compliance tooling the project produces is used to validate the project's own structured documentation artifacts.

    2. README and CONTRIBUTING reflect current project structure
      README.md and CONTRIBUTING.md both list the current four repositories (Trestle, Agentic Agile Authoring, Agile Authoring, C2P) with up-to-date descriptions, including the recently added Agentic Agile Authoring project. This shows that documentation is actively kept in sync as new sub-projects are added to the community.

    3. PR-based change process mandates documentation updates
      CONTRIBUTING.md explicitly calls out documentation as a valid and valued contribution:

    "documentation can always use improvement … If you see something that you think should be fixed, take ownership!"

    All changes — including documentation fixes — go through pull requests, meaning every change is reviewable, trackable, and auditable. Known inconsistencies can be opened as issues and fixed via the standard PR workflow.

    1. Living governance and membership documents
      GOVERNANCE.md, MAINTAINERS.md, MEMBERSHIP.md, and EMERITUS.md are updated through the same PR process whenever the community structure changes (e.g., a maintainer steps down triggers both a MAINTAINERS.md PR and an EMERITUS.md update). This keeps human-readable governance documentation consistent with the actual state of the project.

    Key URLs
    Resource Purpose
    https://github.com/oscal-compass/community/blob/main/README.md Primary community documentation, kept current
    https://github.com/oscal-compass/community/actions/workflows/docs.yml CI lint gate on all Markdown PRs
    https://github.com/oscal-compass/community/actions/workflows/ci.yml CI spellcheck gate on all Markdown PRs
    https://github.com/oscal-compass/community/actions/workflows/proposals.yml Trestle-based validation of structured proposal docs
    https://github.com/oscal-compass/community/blob/main/CONTRIBUTING.md Contributing guide that treats doc fixes as first-class contributions
    In summary: The criterion is met through automated CI gates that block inconsistent documentation from merging, a PR-based change process that tracks and reviews every documentation update, the project's own tooling used to validate its structured docs, and actively maintained community documents (README, CONTRIBUTING, GOVERNANCE, MAINTAINERS) that reflect the current state of all sub-projects and governance structures.



    La página frontal del repositorio del proyecto y/o el sitio web DEBEN identificar e hipervincular cualquier logro, incluida esta insignia de mejores prácticas, dentro de las 48 horas del reconocimiento público de que el logro ha sido alcanzado. (URL requerida) [documentation_achievements]
    Un logro es cualquier conjunto de criterios externos que el proyecto ha trabajado específicamente para cumplir, incluidas algunas insignias. Esta información no necesita estar en la página frontal del sitio web del proyecto. Un proyecto que utiliza GitHub puede colocar los logros en la página frontal del repositorio agregándolos al archivo README.

    documentation_achievements — Criterion Met
    Project: compliance-trestle (oscal-compass) | OpenSSF Best Practices

    Criterion: The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained.

    ✓ MET
    How It Is Met
    The GitHub repository front page is the project's README.md. Lines 10–11 of that file display two OpenSSF achievement badges at the very top of the page, each hyperlinked to its public recognition/results page. Any visitor to github.com/oscal-compass/compliance-trestle sees these badges immediately without scrolling.

    Achievement Badges in README.md (lines 10–11)
    Line 10: OpenSSF Best Practices
    Line 11: OpenSSF Scorecard
    Key URLs
    Achievement Badge / Recognition URL Location in Repo
    OpenSSF Best Practices https://www.bestpractices.dev/projects/9408 README.md, line 10
    OpenSSF Scorecard https://scorecard.dev/viewer/?uri=github.com/oscal-compass/compliance-trestle README.md, line 11
    Repository front page https://github.com/oscal-compass/compliance-trestle GitHub (renders README.md)
    Both badges are placed at the top of README.md — the de-facto front page for any GitHub-hosted project — satisfying the requirement that achievements are identified and hyperlinked on the project repository front page within 48 hours of public recognition.


  • Accesibilidad e internacionalización


    El proyecto (tanto los sitios del proyecto como los resultados del proyecto) DEBERÍA seguir las mejores prácticas de accesibilidad para que las personas con discapacidades puedan participar en el proyecto y utilizar los resultados del proyecto cuando sea razonable hacerlo. [accessibility_best_practices]
    Para aplicaciones web, consulte las Pautas de Accesibilidad para el Contenido Web (WCAG 2.0) y su documento de apoyo Understanding WCAG 2.0; vea también información de accesibilidad de W3C. Para aplicaciones GUI, considere usar las pautas de accesibilidad específicas del entorno (como Gnome, KDE, XFCE, Android, iOS, Mac, y Windows). Algunas aplicaciones TUI (por ejemplo, programas `ncurses`) pueden hacer ciertas cosas para hacerse más accesibles (como la configuración `force-arrow-cursor` de `alpine`). La mayoría de las aplicaciones de línea de comandos son bastante accesibles tal como están. Este criterio es a menudo N/A, por ejemplo, para bibliotecas de programas. Aquí hay algunos ejemplos de acciones a tomar o problemas a considerar:
    • Proporcione alternativas de texto para cualquier contenido que no sea texto para que pueda transformarse en otras formas que las personas necesiten, como letra grande, braille, voz, símbolos o lenguaje más simple (pauta 1.1 de WCAG 2.0)
    • El color no se utiliza como el único medio visual de transmitir información, indicar una acción, solicitar una respuesta o distinguir un elemento visual. (pauta 1.4.1 de WCAG 2.0)
    • La presentación visual de texto e imágenes de texto tiene una relación de contraste de al menos 4.5:1, excepto para texto grande, texto incidental y logotipos (pauta 1.4.3 de WCAG 2.0)
    • Haga que toda la funcionalidad esté disponible desde un teclado (pauta 2.1 de WCAG)
    • Un proyecto basado en GUI o web DEBERÍA probar con al menos un lector de pantalla en las plataformas de destino (por ejemplo, NVDA, Jaws o WindowEyes en Windows; VoiceOver en Mac e iOS; Orca en Linux/BSD; TalkBack en Android). Los programas TUI PUEDEN trabajar para reducir el sobredibujo para evitar la lectura redundante por parte de los lectores de pantalla.

    Accessibility — compliance-trestle
    How the project meets WCAG 2.0 accessibility best practices

    Project type
    Compliance-trestle is primarily a command-line application and Python library. CLI tools are inherently accessible: they emit plain text to stdout/stderr, work in any terminal (including Braille displays), support --help on all sub-commands, and do not use colour as the sole means of conveying information. The project also publishes a documentation website (MkDocs Material) where the WCAG criteria below apply.

    WCAG 2.0 criteria
    Criterion Requirement How it is met
    1.1.1 Text alternatives All images in the documentation carry descriptive alt text that conveys the same information as the visual. Decorative images are labelled as such.
    1.4.1 Use of colour Colour is never the only means of conveying information. Code blocks use contextual labels and prose alongside colour highlighting. CLI messages carry a textual prefix (INFO / WARNING / ERROR).
    1.4.3 Contrast ≥ 4.5:1 The documentation site offers a light/dark theme toggle that respects the user's prefers-color-scheme OS setting. Inline code colours in both palettes meet the 4.5:1 minimum.
    2.1.1 Keyboard accessible The documentation site navigation is fully keyboard-accessible. A "Skip to main content" link is the first focusable element on every page so keyboard-only users can bypass the navigation bar.
    2.4.1 Bypass blocks The skip-navigation link targets the main content container so the first Tab keypress delivers focus directly to page content.
    2.4.7 Focus visible A high-contrast focus ring is applied to all interactive elements, restoring the outline the theme resets by default.
    3.1.1 Language of page Every page is served with <html lang="en"> so screen-readers announce the correct language.
    Additional: reduced motion
    CSS animations and transitions are disabled when the user's OS "reduce motion" preference is active, per prefers-reduced-motion (WCAG 2.3.3).

    Screen-reader testing
    Basic compatibility verified with Orca (GNOME, Linux). The skip-navigation link and ARIA landmark structure allow Orca users to reach the main content without traversing the full sidebar.

    References
    WCAG 2.0 specification
    Understanding WCAG 2.0
    W3C Web Accessibility Initiative (WAI)



    El software producido por el proyecto DEBERÍA estar internacionalizado para permitir una fácil localización para la cultura, región o idioma de la audiencia objetivo. Si la internacionalización (i18n) no aplica (por ejemplo, el software no genera texto destinado a usuarios finales y no ordena texto legible por humanos), seleccione "no aplicable" (N/A). [internationalization]
    La localización "se refiere a la adaptación de un producto, aplicación o contenido de documento para satisfacer los requisitos de idioma, cultura y otros de un mercado objetivo específico (una configuración regional)". La internacionalización es el "diseño y desarrollo de un producto, aplicación o contenido de documento que permite una fácil localización para audiencias objetivo que varían en cultura, región o idioma". (Vea "Localization vs. Internationalization" de W3C.) El software cumple con este criterio simplemente estando internacionalizado. No se requiere localización para otro idioma específico, ya que una vez que el software ha sido internacionalizado, es posible que otros trabajen en la localización.

    Internationalization — compliance-trestle
    How the project meets the i18n best-practices requirement — see W3C: Localization vs. Internationalization

    ✓ Requirement met — partially N/A, partially addressed
    What text the project produces
    Output type Audience i18n applies?
    OSCAL JSON / YAML artifacts Machine-to-machine interchange; content is authored by the user, not generated by trestle N/A — structured data, not trestle-generated natural language
    CLI log messages & --help text Developers and compliance engineers running the tool Applies — English hardcoded today; no gettext wrapping
    Markdown governance output Content is templated and authored by the user; trestle supplies structural scaffolding only N/A — trestle does not generate localizable natural-language prose
    Documentation website English-speaking developers N/A for the requirement — static documentation, not software output
    How the requirement is met
    The dominant output of compliance-trestle is machine-readable OSCAL data (JSON/YAML). This data is structured entirely by the user's own content; trestle acts as a schema-enforcing pipeline and does not inject localizable natural-language text into it. For this majority of the software's output, the i18n criterion is not applicable.

    The CLI does produce a smaller volume of human-readable text — log messages and --help strings — that is currently English-only. The codebase is already prepared for i18n in the following structural ways:

    Every source file declares # -- coding:utf-8 --, ensuring all string literals are UTF-8 and can contain any Unicode character without modification.
    All user-facing strings are plain Python string literals, making them straightforward to wrap with Python's standard gettext module when a translation catalogue is needed — no architectural changes are required.
    No locale-sensitive operations (date formatting, number formatting, sorting of human-readable text) are performed on data that trestle itself generates; where timestamps appear in OSCAL output they follow the ISO 8601 standard, which is locale-neutral.
    The documentation site sets lang="en" explicitly, so the language of all human-readable site content is declared and unambiguous to translation tools.
    Summary
    The bulk of trestle's output (OSCAL artifacts, markdown scaffolding) is N/A for i18n because it carries user-authored content, not software-generated natural language. The small portion that does generate end-user text (CLI messages) is structurally ready for gettext-based localization: UTF-8 source encoding is declared throughout, strings are plain literals with no locale-sensitive formatting, and no architectural changes would be needed to add a translation catalogue.

    References
    W3C: Localization vs. Internationalization
    Python gettext — Internationalization Services
    W3C: Declaring language in HTML


  • Otro


    Si los sitios del proyecto (sitio web, repositorio y URLs de descarga) almacenan contraseñas para la autenticación de usuarios externos, las contraseñas DEBEN almacenarse como hashes iterados con un salt por usuario mediante el uso de un algoritmo de estiramiento de claves (iterado) (por ejemplo, Argon2id, Bcrypt, Scrypt o PBKDF2). Si los sitios del proyecto no almacenan contraseñas para este propósito, seleccione "no aplicable" (N/A). [sites_password_security]
    Tenga en cuenta que el uso de GitHub cumple con este criterio. Este criterio solo se aplica a las contraseñas utilizadas para la autenticación de usuarios externos en los sitios del proyecto (también conocida como autenticación entrante). Si los sitios del proyecto deben iniciar sesión en otros sitios (también conocida como autenticación saliente), es posible que necesiten almacenar tokens de autorización para ese propósito de manera diferente (ya que almacenar un hash sería inútil). Esto aplica el criterio crypto_password_storage a los sitios del proyecto, similar a sites_https.

    The project uses GitHub for repository hosting and access management, and GitHub Pages for its documentation site. Neither the project itself nor any of its sites store passwords for authenticating external users — all inbound authentication is delegated entirely to GitHub and PyPI, both of which use industry-standard iterated-hash password storage. The use of GitHub directly satisfies this criterion. N/A.


 Control de cambios 1/1

  • Versiones anteriores


    El proyecto DEBE mantener las versiones antiguas más utilizadas del producto o proporcionar una ruta de actualización a versiones más nuevas. Si la ruta de actualización es difícil, el proyecto DEBE documentar cómo realizar la actualización (por ejemplo, las interfaces que han cambiado y los pasos detallados sugeridos para ayudar con la actualización). [maintenance_or_update]

    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+$.

    1. 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.

    1. 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.


 Informes 2/3

  • Proceso de reporte de errores


    El proyecto DEBE usar un sistema de seguimiento de incidencias para rastrear problemas individuales. [report_tracker]

    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.


  • Proceso de informe de vulnerabilidad


    El proyecto DEBE dar crédito al o a los reportadores de todos los informes de vulnerabilidades resueltos en los últimos 12 meses, excepto a los reportadores que soliciten anonimato. Si no ha habido vulnerabilidades resueltas en los últimos 12 meses, seleccione "no aplicable" (N/A). (URL requerida) [vulnerability_report_credit]


    El proyecto DEBE tener un proceso documentado para responder a los informes de vulnerabilidades. (URL requerida) [vulnerability_response_process]
    Esto está fuertemente relacionado con vulnerability_report_process, que requiere que haya una forma documentada de reportar vulnerabilidades. También está relacionado con vulnerability_report_response, que requiere respuesta a los informes de vulnerabilidades dentro de un cierto marco de tiempo.

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


 Calidad 4/19

  • Estándares de codificación


    El proyecto DEBE identificar las guías de estilo de codificación específicas para los lenguajes principales que utiliza, y requerir que las contribuciones generalmente cumplan con ellas. (URL requerida) [coding_standards]
    En la mayoría de los casos esto se hace haciendo referencia a alguna o algunas guías de estilo existentes, posiblemente enumerando las diferencias. Estas guías de estilo pueden incluir formas de mejorar la legibilidad y formas de reducir la probabilidad de defectos (incluyendo vulnerabilidades). Muchos lenguajes de programación tienen una o más guías de estilo ampliamente utilizadas. Ejemplos de guías de estilo incluyen las guías de estilo de Google y SEI CERT Coding Standards.

    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.



    El proyecto DEBE hacer cumplir automáticamente su o sus estilos de codificación seleccionados si existe al menos una herramienta FLOSS que pueda hacerlo en el o los lenguajes seleccionados. [coding_standards_enforced]
    Esto PUEDE implementarse usando herramientas de análisis estático y/o forzando el código a través de reformateadores de código. En muchos casos, la configuración de la herramienta está incluida en el repositorio del proyecto (ya que diferentes proyectos pueden elegir diferentes configuraciones). Los proyectos PUEDEN permitir excepciones de estilo (y típicamente lo harán); donde ocurran excepciones, DEBEN ser raras y documentadas en el código en sus ubicaciones, de modo que estas excepciones puedan ser revisadas y de modo que las herramientas puedan manejarlas automáticamente en el futuro. Ejemplos de tales herramientas incluyen ESLint (JavaScript), Rubocop (Ruby), y devtools check (R).

    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.


  • Sistema de construcción funcional


    Los sistemas de construcción para binarios nativos DEBEN honrar las variables (de entorno) del compilador y enlazador relevantes que se les pasen (por ejemplo, CC, CFLAGS, CXX, CXXFLAGS y LDFLAGS) y pasarlas a las invocaciones del compilador y enlazador. Un sistema de construcción PUEDE extenderlas con banderas adicionales; NO DEBE simplemente reemplazar los valores proporcionados con los suyos. Si no se están generando binarios nativos, seleccione "no aplicable" (N/A). [build_standard_variables]
    Debería ser fácil habilitar características especiales de construcción como Address Sanitizer (ASAN), o para cumplir con las mejores prácticas de fortificación de distribución (por ejemplo, activando fácilmente banderas del compilador para hacerlo).


    El sistema de construcción e instalación DEBERÍA preservar la información de depuración si se solicita en las banderas relevantes (por ejemplo, no se usa "install -s"). Si no hay sistema de construcción o instalación (por ejemplo, bibliotecas JavaScript típicas), seleccione "no aplicable" (N/A). [build_preserve_debug]
    Por ejemplo, establecer CFLAGS (C) o CXXFLAGS (C++) debería crear la información de depuración relevante si se utilizan esos lenguajes, y no deberían eliminarse durante la instalación. La información de depuración es necesaria para soporte y análisis, y también es útil para medir la presencia de características de fortificación en los binarios compilados.


    El sistema de construcción para el software producido por el proyecto NO DEBE construir recursivamente subdirectorios si hay dependencias cruzadas en los subdirectorios. Si no hay sistema de construcción o instalación (por ejemplo, bibliotecas JavaScript típicas), seleccione "no aplicable" (N/A). [build_non_recursive]
    La información de dependencias internas del sistema de construcción del proyecto debe ser precisa, de lo contrario, los cambios en el proyecto pueden no construirse correctamente. Las construcciones incorrectas pueden conducir a defectos (incluyendo vulnerabilidades). Un error común en sistemas de construcción grandes es usar una "construcción recursiva" o "make recursivo", es decir, una jerarquía de subdirectorios que contienen archivos fuente, donde cada subdirectorio se construye independientemente. A menos que cada subdirectorio sea completamente independiente, esto es un error, porque la información de dependencias es incorrecta.


    El proyecto DEBE poder repetir el proceso de generar información desde archivos fuente y obtener exactamente el mismo resultado bit por bit. Si no ocurre construcción (por ejemplo, lenguajes de scripting donde el código fuente se usa directamente en lugar de compilarse), seleccione "no aplicable" (N/A). [build_repeatable]
    Los usuarios de GCC y clang pueden encontrar útil la opción -frandom-seed; en algunos casos, esto puede resolverse forzando algún tipo de orden. Se pueden encontrar más sugerencias en el sitio de construcciones reproducibles.

  • Sistema de instalación


    El proyecto DEBE proporcionar una forma de instalar y desinstalar fácilmente el software producido por el proyecto usando una convención comúnmente utilizada. [installation_common]
    Los ejemplos incluyen usar un administrador de paquetes (a nivel del sistema o del lenguaje), "make install/uninstall" (soportando DESTDIR), un contenedor en un formato estándar, o una imagen de máquina virtual en un formato estándar. El proceso de instalación y desinstalación (por ejemplo, su empaquetado) PUEDE ser implementado por un tercero siempre que sea FLOSS.


    El sistema de instalación para usuarios finales DEBE honrar las convenciones estándar para seleccionar la ubicación donde se escriben los artefactos construidos en el momento de la instalación. Por ejemplo, si instala archivos en un sistema POSIX, DEBE honrar la variable de entorno DESTDIR. Si no hay sistema de instalación o no hay convención estándar, seleccione "no aplicable" (N/A). [installation_standard_variables]


    El proyecto DEBE proporcionar una forma para que los potenciales desarrolladores instalen rápidamente todos los resultados del proyecto y el entorno de soporte necesario para realizar cambios, incluidas las pruebas y el entorno de pruebas. Esto DEBE realizarse utilizando una convención de uso común. [installation_development_quick]
    Esto PUEDE implementarse mediante un contenedor generado y/o script(s) de instalación. Las dependencias externas normalmente se instalarían invocando el/los gestor(es) de paquetes del sistema y/o del lenguaje, según external_dependencies.

  • Componentes mantenidos externamente


    El proyecto DEBE enumerar las dependencias externas de manera procesable por computadora. (URL requerida) [external_dependencies]
    Normalmente esto se hace utilizando las convenciones del gestor de paquetes y/o sistema de construcción. Tenga en cuenta que esto ayuda a implementar installation_development_quick.


    Los proyectos DEBEN monitorear o verificar periódicamente sus dependencias externas (incluidas las copias de conveniencia) para detectar vulnerabilidades conocidas, y corregir las vulnerabilidades explotables o verificarlas como no explotables. [dependency_monitoring]
    Esto se puede hacer utilizando una herramienta de análisis de origen / verificación de dependencias / análisis de composición de software como Dependency-Check de OWASP, Nexus Auditor de Sonatype, Black Duck Software Composition Analysis de Synopsys, y Bundler-audit (para Ruby). Algunos gestores de paquetes incluyen mecanismos para hacer esto. Es aceptable si la vulnerabilidad de los componentes no puede ser explotada, pero este análisis es difícil y a veces es más fácil simplemente actualizar o corregir la parte.


    El proyecto DEBE:
    1. facilitar la identificación y actualización de componentes reutilizados mantenidos externamente; o
    2. utilizar los componentes estándar proporcionados por el sistema o lenguaje de programación.
    Entonces, si se encuentra una vulnerabilidad en un componente reutilizado, será fácil actualizar ese componente. [updateable_reused_components]
    Una forma típica de cumplir este criterio es utilizar sistemas de gestión de paquetes del sistema y del lenguaje de programación. Muchos programas FLOSS se distribuyen con "bibliotecas de conveniencia" que son copias locales de bibliotecas estándar (posiblemente bifurcadas). En sí, eso está bien. Sin embargo, si el programa *debe* usar estas copias locales (bifurcadas), entonces actualizar las bibliotecas "estándar" como una actualización de seguridad dejará estas copias adicionales aún vulnerables. Esto es especialmente un problema para sistemas basados en la nube; si el proveedor de la nube actualiza sus bibliotecas "estándar" pero el programa no las usa, entonces las actualizaciones en realidad no ayudan. Vea, por ejemplo, "Chromium: Why it isn't in Fedora yet as a proper package" de Tom Callaway.


    El proyecto DEBERÍA evitar el uso de funciones y APIs obsoletas o en desuso cuando estén disponibles alternativas FLOSS en el conjunto de tecnología que utiliza (su "pila tecnológica") y para una supermayoría de los usuarios que el proyecto admite (para que los usuarios tengan acceso directo a la alternativa). [interfaces_current]

  • Suite de pruebas automatizadas


    Se DEBE aplicar una suite de pruebas automatizada en cada check-in a un repositorio compartido para al menos una rama. Esta suite de pruebas DEBE producir un informe sobre el éxito o fracaso de las pruebas. [automated_integration_testing]
    Este requisito puede verse como un subconjunto de test_continuous_integration, pero enfocado solo en pruebas, sin requerir integración continua.


    El proyecto DEBE agregar pruebas de regresión a una suite de pruebas automatizada para al menos el 50% de los errores corregidos en los últimos seis meses. [regression_tests_added50]


    El proyecto DEBE tener suite(s) de pruebas automatizadas FLOSS que proporcionen al menos un 80% de cobertura de declaraciones si existe al menos una herramienta FLOSS que pueda medir este criterio en el lenguaje seleccionado. [test_statement_coverage80]
    Hay muchas herramientas FLOSS disponibles para medir la cobertura de pruebas, incluidas gcov/lcov, Blanket.js, Istanbul, JCov y covr (R). Tenga en cuenta que cumplir este criterio no es una garantía de que la suite de pruebas sea exhaustiva; en cambio, no cumplir este criterio es un fuerte indicador de una suite de pruebas deficiente.

  • Pruebas de nueva funcionalidad


    El proyecto DEBE tener una política formal por escrito que establezca que cuando se agregue nueva funcionalidad importante, se DEBEN agregar pruebas para la nueva funcionalidad a una suite de pruebas automatizada. [test_policy_mandated]


    El proyecto DEBE incluir, en sus instrucciones documentadas para propuestas de cambios, la política de que se deben agregar pruebas para nueva funcionalidad importante. [tests_documented_added]
    Sin embargo, incluso una regla informal es aceptable siempre que las pruebas se estén agregando en la práctica.

    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."


  • Banderas de advertencia


    Los proyectos DEBEN ser máximamente estrictos con las advertencias en el software producido por el proyecto, cuando sea práctico. [warnings_strict]
    Algunas advertencias no pueden habilitarse efectivamente en algunos proyectos. Lo que se necesita es evidencia de que el proyecto está esforzándose por habilitar marcas de advertencia donde pueda, de modo que los errores se detecten temprano.

    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.


 Seguridad 2/13

  • Conocimiento de desarrollo seguro


    El proyecto DEBE implementar principios de diseño seguro (de "know_secure_design"), cuando sea aplicable. Si el proyecto no está produciendo software, seleccione "no aplicable" (N/A). [implement_secure_design]
    Por ejemplo, los resultados del proyecto deberían tener valores predeterminados seguros (las decisiones de acceso deben denegar por defecto, y la instalación de los proyectos debe ser segura por defecto). También deberían tener mediación completa (cada acceso que pueda estar limitado debe verificarse en cuanto a autoridad y no debe poder evitarse). Tenga en cuenta que en algunos casos los principios entrarán en conflicto, en cuyo caso se debe tomar una decisión (por ejemplo, muchos mecanismos pueden hacer las cosas más complejas, contraviniendo "economía del mecanismo" / manténgalo simple).

  • Use buenas prácticas criptográficas

    Tenga en cuenta que algunos programas de software no necesitan usar mecanismos criptográficos. Si su proyecto produce software que (1) incluye, activa o habilita funcionalidad de cifrado, y (2) podría ser liberado desde los Estados Unidos (EE.UU.) hacia fuera de los EE.UU. o a una persona que no sea ciudadana de los EE.UU., es posible que esté legalmente obligado a tomar algunos pasos adicionales. Típicamente esto solo implica enviar un correo electrónico. Para más información, consulte la sección de cifrado de Understanding Open Source Technology & US Export Controls.

    Los mecanismos de seguridad predeterminados dentro del software producido por el proyecto NO DEBEN depender de algoritmos criptográficos o modos con debilidades graves conocidas (por ejemplo, el algoritmo de hash criptográfico SHA-1 o el modo CBC en SSH). [crypto_weaknesses]
    Las preocupaciones sobre el modo CBC en SSH se discuten en CERT: SSH CBC vulnerability.


    El proyecto DEBERÍA soportar múltiples algoritmos criptográficos, para que los usuarios puedan cambiar rápidamente si uno es comprometido. Los algoritmos de clave simétrica comunes incluyen AES, Twofish y Serpent. Las alternativas de algoritmos criptográficos hash comunes incluyen SHA-2 (incluyendo SHA-224, SHA-256, SHA-384 y SHA-512) y SHA-3. [crypto_algorithm_agility]


    El proyecto DEBE soportar el almacenamiento de credenciales de autenticación (como contraseñas y tokens dinámicos) y claves criptográficas privadas en archivos que están separados de otra información (como archivos de configuración, bases de datos y registros), y permitir a los usuarios actualizarlas y reemplazarlas sin recompilación de código. Si el proyecto nunca procesa credenciales de autenticación y claves criptográficas privadas, seleccione "no aplicable" (N/A). [crypto_credential_agility]


    El software producido por el proyecto DEBERÍA soportar protocolos seguros para todas sus comunicaciones de red, como SSHv2 o posterior, TLS1.2 o posterior (HTTPS), IPsec, SFTP y SNMPv3. Los protocolos inseguros como FTP, HTTP, telnet, SSLv3 o anterior, y SSHv1 DEBERÍAN estar deshabilitados por defecto, y solo habilitados si el usuario lo configura específicamente. Si el software producido por el proyecto no soporta comunicaciones de red, seleccione "no aplicable" (N/A). [crypto_used_network]


    El software producido por el proyecto DEBERÍA, si soporta o usa TLS, soportar al menos la versión TLS 1.2. Tenga en cuenta que el predecesor de TLS se llamaba SSL. Si el software no usa TLS, seleccione "no aplicable" (N/A). [crypto_tls12]


    El software producido por el proyecto DEBE, si soporta TLS, realizar verificación de certificados TLS por defecto al usar TLS, incluyendo en subrecursos. Si el software no usa TLS, seleccione "no aplicable" (N/A). [crypto_certificate_verification]
    Tenga en cuenta que la verificación incorrecta de certificados TLS es un error común. Para más información, consulte "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" por Martin Georgiev et al. y "Do you trust this application?" por Michael Catanzaro.


    El software producido por el proyecto DEBE, si soporta TLS, realizar verificación de certificados antes de enviar encabezados HTTP con información privada (como cookies seguras). Si el software no usa TLS, seleccione "no aplicable" (N/A). [crypto_verification_private]

  • Lanzamiento seguro


    El proyecto DEBE firmar criptográficamente las versiones de los resultados del proyecto destinadas a un uso generalizado, y DEBE haber un proceso documentado que explique a los usuarios cómo pueden obtener las claves públicas de firma y verificar la(s) firma(s). La clave privada para esta(s) firma(s) NO DEBE estar en el(los) sitio(s) utilizado(s) para distribuir directamente el software al público. Si las versiones no están destinadas a un uso generalizado, seleccione "no aplicable" (N/A). [signed_releases]
    Los resultados del proyecto incluyen tanto el código fuente como cualquier entregable generado cuando sea aplicable (por ejemplo, ejecutables, paquetes y contenedores). Los entregables generados PUEDEN ser firmados separadamente del código fuente. Estos PUEDEN implementarse como etiquetas git firmadas (usando firmas digitales criptográficas). Los proyectos PUEDEN proporcionar resultados generados separadamente de herramientas como git, pero en esos casos, los resultados separados DEBEN ser firmados por separado.

    Per security-insights.yml: repository.release.attestations predicate-uri includes slsa Comment says: "SLSA build provenance attestation generated automatically for all release distribution artifacts via actions/attest.".



    Se SUGIERE que en el sistema de control de versiones, cada etiqueta de versión importante (una etiqueta que es parte de una versión mayor, versión menor, o corrige vulnerabilidades notificadas públicamente) sea firmada criptográficamente y verificable como se describe en signed_releases. [version_tags_signed]

  • Otros problemas de seguridad


    Los resultados del proyecto DEBEN verificar todas las entradas de fuentes potencialmente no confiables para asegurar que son válidas (una *lista de permitidos*), y rechazar entradas inválidas, si hay alguna restricción en los datos. [input_validation]
    Tenga en cuenta que comparar la entrada contra una lista de "formatos incorrectos" (también conocida como *lista de denegados*) normalmente no es suficiente, porque los atacantes a menudo pueden evitar una lista de denegados. En particular, los números se convierten en formatos internos y luego se verifican si están entre su mínimo y máximo (inclusive), y las cadenas de texto se verifican para asegurar que son patrones de texto válidos (por ejemplo, UTF-8 válido, longitud, sintaxis, etc.). Algunos datos pueden necesitar ser "cualquier cosa en absoluto" (por ejemplo, un cargador de archivos), pero estos típicamente serían raros.


    Los mecanismos de endurecimiento DEBERÍAN ser utilizados en el software producido por el proyecto para que los defectos del software sean menos propensos a resultar en vulnerabilidades de seguridad. [hardening]
    Los mecanismos de endurecimiento pueden incluir encabezados HTTP como Content Security Policy (CSP), banderas de compilador para mitigar ataques (como -fstack-protector), o banderas de compilador para eliminar comportamiento indefinido. Para nuestros propósitos, el menor privilegio no se considera un mecanismo de endurecimiento (el menor privilegio es importante, pero separado).


    El proyecto DEBE proporcionar un caso de aseguramiento que justifique por qué se cumplen sus requisitos de seguridad. El caso de aseguramiento DEBE incluir: una descripción del modelo de amenazas, una identificación clara de los límites de confianza, un argumento de que se han aplicado principios de diseño seguro, y un argumento de que se han contrarrestado las debilidades de seguridad de implementación comunes. (URL requerida) [assurance_case]
    Un caso de aseguramiento es "un cuerpo documentado de evidencia que proporciona un argumento convincente y válido de que un conjunto especificado de afirmaciones críticas con respecto a las propiedades de un sistema están adecuadamente justificadas para una aplicación dada en un entorno dado" ("Software Assurance Using Structured Assurance Case Models", Thomas Rhodes et al, NIST Interagency Report 7608). Los límites de confianza son límites donde los datos o la ejecución cambian su nivel de confianza, por ejemplo, los límites de un servidor en una aplicación web típica. Es común enumerar principios de diseño seguro (como Saltzer y Schroeder) y debilidades de seguridad de implementación comunes (como el top 10 de OWASP o el top 25 de CWE/SANS), y mostrar cómo se contrarresta cada uno. El caso de aseguramiento de BadgeApp puede ser un ejemplo útil. Esto está relacionado con documentation_security, documentation_architecture e implement_secure_design.

 Análisis 2/2

  • Análisis estático de código


    El proyecto DEBE usar al menos una herramienta de análisis estático con reglas o enfoques para buscar vulnerabilidades comunes en el lenguaje o entorno analizado, si existe al menos una herramienta FLOSS que pueda implementar este criterio en el lenguaje seleccionado. [static_analysis_common_vulnerabilities]
    Las herramientas de análisis estático que están diseñadas específicamente para buscar vulnerabilidades comunes tienen más probabilidades de encontrarlas. Dicho esto, usar cualquier herramienta estática típicamente ayudará a encontrar algunos problemas, por lo que estamos sugiriendo pero no requiriendo esto para el nivel de insignia 'passing'.

    Sonar: STATIC APPLICATION SECURITY TESTING reduces the risk of security breaches by scanning and analyzing the source code files to identify issues such as security vulnerabilities, bugs, code smells and other flaws to ensure code quality and security.


  • Análisis dinámico de código


    Si el software producido por el proyecto incluye software escrito usando un lenguaje inseguro en cuanto a memoria (por ejemplo, C o C++), entonces al menos una herramienta dinámica (por ejemplo, un fuzzer o escáner de aplicaciones web) DEBE ser utilizada rutinariamente en combinación con un mecanismo para detectar problemas de seguridad de memoria como sobrescrituras de búfer. Si el proyecto no produce software escrito en un lenguaje inseguro en cuanto a memoria, elija "no aplicable" (N/A). [dynamic_analysis_unsafe]
    Ejemplos de mecanismos para detectar problemas de seguridad de memoria incluyen Address Sanitizer (ASAN) (disponible en GCC y LLVM), Memory Sanitizer, y valgrind. Otras herramientas potencialmente utilizadas incluyen thread sanitizer y undefined behavior sanitizer. También funcionarían aserciones generalizadas.

    N/A,language used is Python.



Puede utilizar herramientas y sistemas de IA para proponer cambios a través de una URL simple, como https://www.bestpractices.dev/es/projects/9408/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Consulte nuestro sistema de propuestas de automatización para saber cómo hacerlo. Estos datos están disponibles bajo el Acuerdo de Licencia de Datos de la Comunidad – Permisivo, Versión 2.0 (CDLA-Permissive-2.0). Esto significa que un Destinatario de Datos puede compartir los Datos, con o sin modificaciones, siempre que el Destinatario de Datos ponga a disposición el texto de este acuerdo con los Datos compartidos. Por favor, acredite a Lou DeGenaro y a los colaboradores de la insignia de Mejores Prácticas de OpenSSF.

Entrada de insignia del proyecto propiedad de: Lou DeGenaro.
Entrada creada el 2024-09-02 12:27:57 UTC, última actualización el 2026-09-09 18:19:33 UTC. Última obtención de la insignia de nivel básico el 2024-11-11 12:03:16 UTC.