sentinel

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 base en la página de su proyecto. El estado de la insignia base se ve así: El nivel de insignia base para el proyecto 14063 es baseline-1 Aquí se explica cómo insertar la insignia base:
Puede mostrar el estado de su insignia base insertando esto en su archivo markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/14063/baseline)](https://www.bestpractices.dev/projects/14063)
o insertando esto en su HTML:
<a href="https://www.bestpractices.dev/projects/14063"><img src="https://www.bestpractices.dev/projects/14063/baseline"></a>


Estos son los criterios de Nivel Base 3. Estos son los criterios de la versión v2026.08.28.

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

        

 Fundamentos

  • General

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

    The security update management platform for SUSE and openSUSE Linux distributions

    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.

 Controles 12/21

  • Controles


    Cuando se asigna permisos a un trabajo en un pipeline de CI/CD, el código fuente o configuración DEBE asignar solo los privilegios mínimos necesarios para la actividad correspondiente. [OSPS-AC-04.02]
    Configure los pipelines de CI/CD del proyecto para asignar los permisos más bajos disponibles a usuarios y servicios por defecto, elevando los permisos solo cuando sea necesario para tareas específicas. En algunos sistemas de control de versiones, esto puede ser posible a nivel organizacional o de repositorio. Si no es posible, establezca los permisos en el nivel superior del pipeline.

    Every workflow declares permissions at either the top level or per-job, restricted to the minimum required for that specific activity. Examples: ci.yml uses only contents: read; build-images.yml grants packages: write only to the publish job; deploy-api-docs.yml splits permissions per job (contents: read for build, pages: write + id-token: write only for the deploy job); release-please.yml sets top-level permissions: {} and grants contents: write, issues: write, pull-requests: write only to the single job that needs them. The repository default workflow permissions are set to read, ensuring any job without explicit permissions receives the minimum.



    Los flujos de CI/CD que aceptan entradas de colaboradores de confianza DEBEN sanear y validar dichas entradas antes de utilizarlas en el flujo. [OSPS-BR-01.04]
    Los flujos de CI/CD deben sanear (entre comillas, escapar o salir en valores esperados) todas las entradas de colaboradores en ejecuciones explícitas de flujos de trabajo. Aunque los colaboradores son generalmente de confianza, las entradas manuales a un flujo de trabajo no pueden revisarse y podrían ser abusadas por una toma de control de cuenta o una amenaza interna.

    All workflows that consume collaborator-controlled input (PR title, PR body, branch names) pass those values exclusively through environment variables (env:) rather than inline ${{ }} interpolation in run: blocks — preventing shell injection. The pr-metadata.yml workflow (the only one that processes attacker-controllable input like PR titles and bodies) explicitly uses env: PR_TITLE: ${{ github.event.pull_request.title }} and then references "${PR_TITLE}" with proper quoting in the shell script. The build-images.yml workflow similarly passes image tags via env: IMAGE_TAGS with an inline comment explaining this is done "to avoid shell-injection risk from untrusted ref/tag content." No workflow interpolates untrusted input directly into a run: script.



    Cuando se crea un lanzamiento oficial, todos los activos dentro de ese lanzamiento DEBEN estar claramente asociados con el identificador del lanzamiento u otro identificador único para el activo. [OSPS-BR-02.02]
    Asigne un identificador de versión único a cada activo de software producido por el proyecto, siguiendo una convención de nomenclatura o esquema de numeración consistente. Ejemplos incluyen SemVer, CalVer, o git commit id.

    Each GitHub Release is associated with its unique version tag (v0.3.0, etc.). The container images published to ghcr.io are tagged with the corresponding semver release tag (e.g., ghcr.io/staypirate/sentinel:0.3.0) alongside latest, ensuring the OCI artifact is clearly tied to the release identifier. The release changelog in the GitHub Release body references the exact Git commits (SHAs) included in that version. The uv.lock file is version-bumped by release-please as part of the release commit, associating the locked dependency set with the release.



    El proyecto DEBE definir una política para gestionar secretos y credenciales utilizados por el proyecto. La política debe incluir directrices para almacenar, acceder y rotar secretos y credenciales. [OSPS-BR-07.02]
    Documente cómo se gestionan y utilizan los secretos y credenciales dentro del proyecto. Esto debe incluir detalles sobre cómo se almacenan los secretos (por ejemplo, utilizando una herramienta de gestión de secretos), cómo se controla el acceso y cómo se rotan o actualizan los secretos. Asegúrese de que la información sensible no esté codificada directamente en el código fuente ni almacenada en sistemas de control de versiones.

    The project defines a multi-layered secrets management policy across its documentation:

    • Storage: docs/deployment.md (No secrets in workflow files) mandates that CI credentials are stored exclusively in GitHub Secrets (${{ secrets.* }}), never as literals in workflow files. The Repository Secrets section documents each secret's purpose and required permissions.
    • Access: docs/conventions.md (Secret Field Typing) requires all secret configuration fields to use Pydantic SecretStr, preventing accidental exposure via repr/logging/serialization. Log statements are forbidden from including secrets (Secrets and PII Discipline in logging.md).
    • Rotation: docs/deployment.md documents JWT_SECRET_KEY rotation impact (session invalidation, off-peak maintenance window). Environment-variable injection ensures secrets are never baked into images.
    • Prevention: gitleaks pre-commit hook scans for accidentally committed secrets; GitHub Push Protection is enabled at the repository level.


    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE contener instrucciones para verificar la integridad y autenticidad de los activos del lanzamiento. [OSPS-DO-03.01]
    Las instrucciones en el proyecto deben contener información sobre la tecnología utilizada, los comandos a ejecutar y la salida esperada. Cuando sea posible, evite almacenar esta documentación en la misma ubicación que el pipeline de compilación y lanzamiento para evitar que una sola violación comprometa tanto el software como la documentación para verificar la integridad del software.

    There are no instructions in the project documentation for verifying the integrity or authenticity of release assets. No cryptographic signatures, checksums, or signed manifests are published alongside releases (as noted in the earlier signing criterion). Without signed assets, there is nothing for a consumer to verify. This is the counterpart to the earlier "release MUST be signed" criterion — both are currently unmet.



    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE contener instrucciones para verificar la identidad esperada de la persona o proceso que crea el lanzamiento del software. [OSPS-DO-03.02]
    La identidad esperada puede estar en forma de IDs de clave utilizados para firmar, emisor e identidad de un certificado sigstore, u otras formas similares. Cuando sea posible, evite almacenar esta documentación en la misma ubicación que el pipeline de compilación y lanzamiento para evitar que una sola violación comprometa tanto el software como la documentación para verificar la integridad del software.

    The project does not document how to verify who authored a release. Releases are created by the release-please automation using a RELEASE_TOKEN PAT, but there are no instructions for consumers to verify that a given release was produced by an authorized project maintainer (e.g., via GPG-signed tags, Sigstore identity verification, or GitHub's commit signing verification). The Git tags are unsigned, and no provenance attestation links the release to a specific verified identity.



    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE incluir una declaración descriptiva sobre el alcance y la duración del soporte para cada lanzamiento. [OSPS-DO-04.01]
    Para comunicar el alcance y la duración del soporte para los activos de software lanzados del proyecto, el proyecto debe tener un archivo SUPPORT.md, una sección "Soporte" en SECURITY.md, u otra documentación que explique el ciclo de vida del soporte, incluyendo la duración esperada del soporte para cada lanzamiento, los tipos de soporte proporcionados (por ejemplo, corrección de errores, actualizaciones de seguridad), y cualquier política o procedimiento relevante para obtener soporte.

    The project documentation does not include a support policy stating which releases receive security patches, bug fixes, or how long each release is supported. The versioning section in docs/conventions.md defines SemVer interpretation and pre-1.0 rules, but does not state whether only the latest release is supported, whether older minor versions receive backports, or what the expected support duration is for any given release.



    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE proporcionar una declaración descriptiva sobre cuándo los lanzamientos o versiones ya no recibirán actualizaciones de seguridad. [OSPS-DO-05.01]
    Para comunicar el alcance y la duración del soporte para correcciones de seguridad, el proyecto debe tener un SUPPORT.md u otra documentación que explique la política del proyecto para actualizaciones de seguridad.

    Same gap as above — there is no end-of-life (EOL) or end-of-support policy documented. The project does not state when a given release will stop receiving security updates, nor does it define the conditions under which a version transitions from "supported" to "unsupported."



    La documentación del proyecto DEBE tener una política que exija que los colaboradores de código sean revisados antes de otorgarles permisos elevados a recursos sensibles. [OSPS-GV-04.01]
    Publique una política exigible en la documentación del proyecto que requiera que los colaboradores de código sean revisados y aprobados antes de otorgarles permisos elevados a recursos sensibles, como aprobación de fusiones o acceso a secretos. Se recomienda que la verificación incluya establecer un linaje justificable de identidad, como confirmar la asociación del colaborador con una organización confiable conocida.

    The repository is currently single-maintainer (sole owner of all repository permissions). GitHub's built-in access model requires the repository owner to explicitly grant collaborator access — no one can self-escalate. Branch protection rules enforce PR review requirements for all code reaching master. The CONTRIBUTING.md documents the contribution workflow (fork, PR, CI must pass), and the repository owner is the sole merge authority. For a single-maintainer project, this satisfies the criterion — there is no delegation of sensitive access without the owner's explicit action.



    Cuando el proyecto haya realizado un lanzamiento, todos los activos de software compilados lanzados DEBEN ser entregados con una lista de materiales de software. [OSPS-QA-02.02]
    Se recomienda generar automáticamente SBOMs en el momento de la compilación utilizando una herramienta que haya sido verificada para precisión. Esto permite a los usuarios ingerir estos datos en un enfoque estandarizado junto con otros proyectos en su entorno.

    No SBOM (Software Bill of Materials) is generated or published with releases. The build-images.yml workflow builds and pushes the container image to ghcr.io but does not generate an SBOM (e.g., via docker/build-push-action's sbom option, syft, or trivy). GitHub Releases contain no attached assets at all — no SPDX, CycloneDX, or other SBOM format is produced or distributed alongside the OCI image or the source release.



    Cuando el proyecto haya realizado un lanzamiento que comprenda múltiples repositorios de código fuente, todos los subproyectos DEBEN aplicar requisitos de seguridad que sean tan estrictos o más estrictos que la base de código principal. [OSPS-QA-04.02]
    Cualquier repositorio de código de subproyecto adicional producido por el proyecto y compilado en un lanzamiento debe aplicar requisitos de seguridad según sea aplicable al estado e intención de la base de código respectiva. Además de seguir los requisitos correspondientes de la Línea Base OSPS, esto puede incluir requerir una revisión de seguridad, asegurar que esté libre de vulnerabilidades y asegurar que esté libre de problemas de seguridad conocidos.

    Sentinel is a single-repository project. There is no multi-repo release comprising subprojects — the backend, migrations, task definitions, and specifications all live in this single repository and ship as one OCI image. The frontend will be developed in a separate repository but is not yet released. This criterion does not apply until a release spans mul



    La documentación del proyecto DEBE documentar claramente cuándo y cómo se ejecutan las pruebas. [OSPS-QA-06.02]
    Agregue una sección a la documentación de contribución que explique cómo ejecutar las pruebas localmente y cómo ejecutar las pruebas en el pipeline de CI/CD. La documentación debe explicar qué están probando las pruebas y cómo interpretar los resultados.

    docs/features/platform/testing-strategy.md is the authoritative document for the testing strategy, including when and how tests are run. It defines the test pyramid (unit, integration, e2e), the CI pipeline gate composition, required markers (@pytest.mark.unit, @pytest.mark.integration, @pytest.mark.e2e), and execution model. docs/deployment.md (Workflow Inventory) documents that the CI workflow runs on every push to master and every pull request. CONTRIBUTING.md documents how developers run tests locally (make test, uv run pytest). The pre-commit hook automatically runs the unit test subset on every commit.



    La documentación del proyecto DEBE incluir una política de que todos los cambios importantes al software producido por el proyecto deben agregar o actualizar pruebas de la funcionalidad en un conjunto de pruebas automatizado. [OSPS-QA-06.03]
    Agregue una sección a la documentación de contribución que explique la política para agregar o actualizar pruebas. La política debe explicar qué constituye un cambio importante y qué pruebas deben agregarse o actualizarse.

    AGENTS.md (Guardrail 6, Mandatory Testing) defines an explicit policy: "Every code change (new feature or modification) MUST include tests." It requires tests for new API endpoints (happy path, validation, auth), new models (creation, constraints, relationships), new services (business logic, edge cases, error handling), and bug fixes (regression tests). The policy explicitly states "NEVER skip tests" and instructs that if asked to skip, the developer must be reminded of the requirement. CONTRIBUTING.md reinforces this under the "Pull Request Checklist" — all PRs must include tests and CI must pass before merge.



    Cuando se realiza un commit a la rama principal, el sistema de control de versiones del proyecto DEBE requerir al menos una aprobación humana no autora de los cambios antes de fusionarlos. [OSPS-QA-07.01]
    Configure el sistema de control de versiones del proyecto para requerir al menos una aprobación humana no autora de los cambios antes de fusionarlos en la rama de lanzamiento o principal. Esto se puede lograr requiriendo que un pull request sea revisado y aprobado por al menos otro colaborador antes de que pueda fusionarse.

    Branch protection on master requires a pull request before merge, but the required approvals count is set to 0. This means a PR author can merge their own changes without any non-author human review. The project is currently single-maintainer, which makes enforcing non-author approval impractical (there is no second person to approve), but the criterion as stated is not satisfied by the current configuration.



    Cuando el proyecto haya realizado un lanzamiento, el proyecto DEBE realizar un modelado de amenazas y análisis de superficie de ataque para comprender y protegerse contra ataques en rutas de código críticas, funciones e interacciones dentro del sistema. [OSPS-SA-03.02]
    El modelado de amenazas es una actividad donde el proyecto examina la base de código, procesos asociados e infraestructura, interfaces, componentes clave y "piensa como un hacker" y hace una lluvia de ideas sobre cómo el sistema puede ser vulnerado o comprometido. Cada amenaza identificada se enumera para que el proyecto pueda pensar en cómo evitar proactivamente o cerrar cualquier brecha/vulnerabilidad que pueda surgir. Asegúrese de que esto se actualice para nuevas características o cambios importantes.

    The project performs systematic threat modeling and attack surface analysis through its mandatory @security-reviewer invocations (Guardrail 10) on every security-sensitive change. The docs/reviews/ directory contains 50+ review documents with explicit threat model assessments for critical code paths — authentication (local-authentication.md documents brute-force resistance, offline attack models), networking (networking.md documents trusted-upstream assumptions, connection security), RBAC (rbac.md documents pre-disclosure data exposure), and all external integrations. Specifications themselves document threat considerations inline (e.g., API key self-replication prevention, JWT secret minimum length enforcement, session fixation protections, rate limiting requirements). The attack surface is analyzed per-component rather than in a single monolithic document, with each review recording findings, risk acceptance decisions with rationale, and residual risk.



    Cualquier vulnerabilidad en los componentes de software que no afecte al proyecto DEBE ser contabilizada en un documento VEX, complementando el informe de vulnerabilidad con detalles de no explotabilidad. [OSPS-VM-04.02]
    Establezca un feed VEX comunicando el estado de explotabilidad de vulnerabilidades conocidas, incluyendo detalles de evaluación o cualquier mitigación implementada que impida que el código vulnerable sea ejecutado.

    The project does not produce or publish VEX (Vulnerability Exploitability eXchange) documents. While image-scan.yml runs weekly Trivy scans and opens tracking issues for OS-level vulnerabilities, and pip-audit gates Python dependencies on every merge, neither produces a VEX document that formally accounts for non-exploitable vulnerabilities with justification (e.g., "not affected", "false positive", "component not reachable"). There is no CSAF/VEX or OpenVEX artifact generated as part of the release or scanning process.



    La documentación del proyecto DEBE incluir una política que defina un umbral para la corrección de los hallazgos de SCA relacionados con vulnerabilidades y licencias. [OSPS-VM-05.01]
    Documente una política en el proyecto que defina un umbral para la remediación de hallazgos de Análisis de Composición de Software (SCA) relacionados con vulnerabilidades y licencias. Incluya el proceso para identificar, priorizar y remediar estos hallazgos.

    The project does not document a policy defining remediation timeframes for SCA (Software Composition Analysis) findings. While pip-audit gates every PR (blocking merge if a known-vulnerable dependency is present) and image-scan.yml runs weekly Trivy scans with tracking issues, there is no documented policy specifying:

    • Maximum time allowed to remediate critical/high/medium/low vulnerability findings
    • How license compliance findings are handled (no license scanning is configured)
    • Thresholds or SLAs for when a vulnerability must be addressed vs. accepted as risk


    La documentación del proyecto DEBE incluir una política para abordar las infracciones de SCA antes de cualquier lanzamiento. [OSPS-VM-05.02]
    Documente una política en el proyecto para abordar los resultados aplicables del Análisis de Composición de Software antes de cualquier lanzamiento, y agregue verificaciones de estado que comprueben el cumplimiento de esa política antes del lanzamiento.

    The CI pipeline enforces a strict gate: pip-audit runs on every pull request and blocks merge if any known-vulnerable dependency is detected (backend-security job in ci.yml). This means no release can be created with a known Python dependency vulnerability — the release path requires CI to pass on master, and release-please.yml only triggers after a successful CI run. Additionally, image-scan.yml runs weekly Trivy scans against the published container image for OS-level vulnerabilities and opens tracking issues. The combination ensures SCA violations are addressed (Python deps) or tracked (OS-level) prior to and between releases.



    Todos los cambios a la base de código del proyecto DEBEN ser evaluados automáticamente contra una política documentada de dependencias maliciosas y vulnerabilidades conocidas en las dependencias, y bloqueados en caso de infracciones, excepto cuando se declaren y se supriman por no ser explotables. [OSPS-VM-05.03]
    Cree una verificación de estado en el sistema de control de versiones del proyecto que ejecute una herramienta de Análisis de Composición de Software en todos los cambios en la base de código. Requiera que la verificación de estado pase antes de que los cambios puedan fusionarse.

    Every change to the codebase is automatically evaluated by the CI pipeline before merge: pip-audit (in the backend-security job of ci.yml) checks all Python dependencies against known vulnerability databases and blocks the PR if a violation is found. bandit runs static security analysis in the same job. Branch protection requires the "Backend Security Scan" status check to pass — no code reaches master without passing these gates. Dependabot is configured to propose dependency updates weekly, providing proactive notification of vulnerable or outdated dependencies. The suppression mechanism exists via pip-audit's --ignore-vuln flag (though currently unused), which would require explicit declaration of non-exploitability.



    La documentación del proyecto DEBE incluir una política que defina un umbral para la corrección de los hallazgos de SAST. [OSPS-VM-06.01]
    Documente una política en el proyecto que defina un umbral para la remediación de hallazgos de Pruebas de Seguridad de Aplicaciones Estáticas (SAST). Incluya el proceso para identificar, priorizar y remediar estos hallazgos.

    The project does not document a policy defining remediation timeframes or thresholds for SAST (Static Application Security Testing) findings. While bandit runs on every PR as part of the backend-security CI job and blocks merge on findings, there is no documented policy specifying:

    • Severity thresholds for blocking vs. non-blocking findings
    • Maximum remediation timeframes by severity level
    • Suppression/acceptance process for false positives (e.g., required justification format for # nosec annotations)


    Todos los cambios a la base de código del proyecto DEBEN ser evaluados automáticamente contra una política documentada de debilidades de seguridad y bloqueados en caso de infracciones, excepto cuando se declaren y se supriman por no ser explotables. [OSPS-VM-06.02]
    Cree una verificación de estado en el sistema de control de versiones del proyecto que ejecute una herramienta de Pruebas de Seguridad de Aplicaciones Estáticas (SAST) en todos los cambios en la base de código. Requiera que la verificación de estado pase antes de que los cambios puedan fusionarse.

    All changes to the codebase are automatically evaluated for security weaknesses before merge: bandit (SAST) runs in the backend-security job of ci.yml and blocks the PR on findings. mypy --strict (static type checking) catches type-safety issues that can lead to security weaknesses. Branch protection requires "Backend Security Scan" and "Backend Type Check" to pass — no code reaches master without passing these gates. Suppression is supported via bandit's # nosec inline annotations for declared false positives, and mypy's per-line type-ignore with required error codes (blanket suppressions are forbidden per docs/conventions.md).



Puede utilizar herramientas y sistemas de IA para proponer cambios a través de una URL simple, como https://www.bestpractices.dev/es/projects/14063/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 Gianluca Gabrielli y a los colaboradores de la insignia de Mejores Prácticas de OpenSSF.

Entrada de insignia del proyecto propiedad de: Gianluca Gabrielli.
Entrada creada el 2026-08-13 13:55:49 UTC, última actualización el 2026-08-14 06:09:03 UTC. Última obtención de la insignia de nivel básico el 2026-08-13 16:48:08 UTC.