bouine

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 14035 es silver 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/14035/badge)](https://www.bestpractices.dev/projects/14035)
o insertando esto en su HTML:
<a href="https://www.bestpractices.dev/projects/14035"><img src="https://www.bestpractices.dev/projects/14035/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.

    ⚡ Bouine is a cloud-native HTTP cache in Go - RFC9111 compliant, zero-alloc hit path, gossip clustering, no external K/V store

    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]

    https://github.com/bouine-cache/bouine/blob/main/CONTRIBUTING.md

    CONTRIBUTING.md documents the requirements for acceptable contributions:

    • Coding standards ("Coding standards summary" referencing AGENTS.md)
    • Performance discipline ("Performance discipline" referencing AGENTS.md)
    • Testing discipline ("Testing discipline" referencing AGENTS.md)
    • A PR checklist ("Pull request checklist" mirroring AGENTS.md)
    • Commit message conventions (Conventional Commits)
    • Required tooling setup (make hooks mandatory, Go 1.26, Docker, etc.)

  • 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) v1.1. Every commit must include a Signed-off-by: trailer certifying the contributor's right to submit the work under the project's Apache 2.0 license. This is enforced by a commit-msg prek hook ( scripts/check-dco.sh ) that rejects commits missing the trailer, and by a CI job ( dco in .github/workflows/ci.yml ) that checks all commits in a PR. Contributors add the trailer with git commit -s . The
    full DCO text and instructions are documented at CONTRIBUTING.md#developer-certificate-of-origin-dco (https://github.com/bouine-cache/bouine/blob/main/CONTRIBUTING.md#developer-certificate-of-origin-dco).



    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: https://github.com/bouine-cache/bouine/blob/main/GOVERNANCE.md

    bouine uses a maintainer collective governance model documented in GOVERNANCE.md . The document defines key roles (lead maintainer, maintainers, contributors), the decision-making process for standard and architectural changes (consensus with lead maintainer as tie-breaker), dispute resolution escalation (discuss → maintainer review → lead maintainer decides), how maintainers are added/removed, and access continuity in case a contributor becomes unavailable. The file is protected by CODEOWNERS and linked from both README.md and CONTRIBUTING.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/bouine-cache/bouine/blob/main/CODE_OF_CONDUCT.md

    The project adopts the Contributor Covenant v2.1 code of conduct, posted at the repository root (CODE_OF_CONDUCT.md ), a standard location recognized by GitHub. It is linked from CONTRIBUTING.md and referenced in .github/ISSUE_TEMPLATE/config.yml . Enforcement responsibilities, scope, and a 4-level escalation ladder (Correction → Warning → Temporary Ban → Permanent Ban) are documented.



    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: https://github.com/bouine-cache/bouine/blob/main/GOVERNANCE.md#2-roles

    GOVERNANCE.md defines four key roles (lead maintainer, maintainer, contributor, AI agent) with their responsibilities and concrete key tasks. Who holds each role is visible via the @bouine-cache/maintainers https://github.com/orgs/bouine-cache/teams/maintainers GitHub team page and the lead maintainer's GitHub handle (@theotime-leveque ). The CODEOWNERS file maps codebase areas to the maintainer team for auto-requested reviews.



    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]

    URL: https://github.com/bouine-cache/bouine/blob/main/GOVERNANCE.md#4-access-continuity

    GOVERNANCE.md §4 documents that the GitHub org has two admins ( @thylong and @chridupin-33 ), both with full admin access to the repo and org. If either becomes unavailable, the remaining admin can within one week:
    create/close issues (triage+admin perms), merge PRs (branch protection can be overridden by admins), release software (credentials in GitHub Secrets, cosign uses keyless OIDC tied to the workflow not an individual, releases triggered by git tag push), and respond to security reports (all maintainers are security contacts via GitHub PVR). No external
    infrastructure (DNS, standalone CI, external registries) requires credentials outside GitHub, eliminating the need for a
    lockbox or will.



    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.

    URL: https://github.com/bouine-cache/bouine/blob/main/GOVERNANCE.md#4-access-continuity

    bouine has a bus factor of 2. The @bouine-cache/maintainers GitHub team has two members with admin access to the repository and organization ( @thylong and @chridupin-33 ), both familiar with the codebase architecture release pipeline, and security response process. The loss of either one leaves the other fully capable of continuing the
    project. All credentials live in GitHub Secrets, not on individual machines.


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

    URL: https://github.com/bouine-cache/bouine/blob/main/ROADMAP.md

    ROADMAP.md documents the project's intended direction for the next 12 months across six feature areas (multilayer caching, authentication, fasthttp migration, eviction algorithms, competitive benchmarks, blog), with targets, non-goals, and a deferred backlog. Linked from README.md, CONTRIBUTING.md, and GOVERNANCE.md; protected by CODEOWNERS.



    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.

    URL: https://github.com/bouine-cache/bouine/blob/main/docs/architecture.md

    docs/architecture.md is the project's architecture reference. It documents the major components (8-layer model: L1 Server through L8 AI Insights), their relationships (dependency matrix, allowed imports), the module layout mapping layers to Go packages, the HTTP stack design, implementation decisions, and operational characteristics. Each layer has a doc.go with purpose, public surface, invariants, and performance notes. Architectural decisions are
    recorded as ADRs in docs/decisions/ (30 ADRs in MADR format).



    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.

    URL: https://github.com/bouine-cache/bouine/blob/main/SECURITY.md#security-requirements

    SECURITY.md has a "Security Requirements" section documenting what bouine does and does not guarantee It covers TLS (min 1.2, prefer 1.3), cluster mTLS, admin auth (bearer/mTLS), HTTP smuggling defenses, header hygiene (RFC 9110 §7.6.1), private response protection, path traversal prevention, resource limits, secret-free logging, signed releases (cosign + SBOM), and vulnerability scanning (govulncheck, gitleaks, Trivy). Security non-goals are explicitly
    listed: no data-plane auth, no rate limiting, no WAF/DDoS scrubbing, no encryption at rest, no multi-tenant isolation, no built-in ACME. The full STRIDE threat model is in docs/security/threat-model.md .



    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.

    URL: https://github.com/bouine-cache/bouine/blob/main/README.md#quick-start

    The README has a "Quick Start" section that gets a user from zero to a cached request in under a minute: create a minimal bouine.yaml , run bouine via Docker, make two curl requests to see MISS then HIT, and check the admin /healthz endpoint. It includes a worked demo showing the expected output.



    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.

    The project makes an active effort to keep documentation consistent with the current version. A documentation audit identified and fixed 8 staleness defects: stale version in install URL, outdated conformance score, stale Fiber references in the threat model, non-existent runbook filenames in the index, missing ADRs and a number collision in the ADR index, a broken anchor typo in the issue template, an outdated phase dropdown, and stale threshold/queue references. The CHANGELOG is maintained with an Unreleased section and enforced by a pre-push reminder hook plus a release-time promotion workflow. Conformance scores are verified live in CI against a floor of 339. The AGENTS.md working loop (§16) requires documentation updates as part of every task, and CODEOWNERS protects all docs for maintainer review.



    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.

    URL: https://github.com/bouine-cache/bouine/blob/main/README.md (lines 10-19, the badge row in the repository front page)

    The README displays all project achievements as hyperlinked badges in the header: CI status, Codecov coverage, Release workflow, latest release, Docker pulls, Docker image version, Artifact Hub, Apache 2.0 license, and the OpenSSF Best Practices badge (line 19, linking to https://www.bestpractices.dev/projects/14035 ). All badges are clickable hyperlinks to their respective achievement pages.


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

    The project follows WCAG 2.0 AA where reasonable. The CLI is text-based and inherently accessible. The embedded dashboard uses semantic HTML landmarks, ARIA roles and labels, a skip-to-content link, :focus-visible keyboard indicators, prefers-reduced-motion support, AA-compliant color contrast, keyboard-operable sortable tables, proper form labels, and alt text on all images/SVGs. An accessibility statement is published at docs/accessibility.md listing implemented measures and known limitations. The README has alt text on all badge images.



    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.

    The documentation is fully available in 3 different languages on the official website: https://bouine.org


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

    No passwords are stored, no authentication is provided.


 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]

    bouine maintains older versions and provides documented upgrade paths. The SECURITY.md supported-versions table shows the latest minor receives security fixes and the previous minor is supported for 6 months. The CHANGELOG.md (Keep a Changelog format, SemVer) documents all notable changes per release, with breaking changes explicitly flagged (e.g., "Breaking (SDK): removed Client.Reload "). The cluster protocol maintains an N/N-1 compatibility window for rolling upgrades, documented in docs/architecture.md §5 . Migration guides exist for Varnish (docs/migration/varnish.md ), NGINX ( docs/migration/nginx.md ), and cluster mode changes ( docs/migration/cluster-mode.md ). The Go SDK ( pkg/bouineapi ) follows semver — wire types in pkg/api are additive, and breaking changes require a major version bump with a migration note per AGENTS.md §13.


 Informes 3/3 ●

  • Proceso de reporte de errores


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

    The project uses GitHub Issues at https://github.com/bouine-cache/bouine/issues, referenced in the README and CONTRIBUTING.md.


  • 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]

    No vulnerabilities raised in the past 12 months.



    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.

    URL: https://github.com/bouine-cache/bouine/blob/main/SECURITY.md#vulnerability-response-process

    SECURITY.md documents a six-step vulnerability response process: (1) triage within 3 business days with severity assignment, (2) assess and reproduce within 1 week, (3) develop a fix on a private branch with maintainer review, threat model update, and CHANGELOG entry, (4) release a signed tagged release (out-of-band for critical, batched for medium/low), (5) publish GHSA advisory and request CVE, (6) post-release review within one week to strengthen
    controls. Reporters receive weekly status updates during the embargo, and target fix timeframes are 30 days for high-severity and 90 days for medium-severity issues.


 Calidad 19/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.

    URL: https://github.com/bouine-cache/bouine/blob/main/AGENTS.md#4-coding-standards-go-126 (with CONTRIBUTING.md#coding-standards-summary as the human-facing entry point)

    bouine's primary (and only) language is Go 1.26. The coding style guide is documented in AGENTS.md §4 and summarized in CONTRIBUTING.md § "Coding standards" . It identifies specific style guides and rules: gofmt -s + goimports for formatting, 100-column soft limit, idiomatic Go naming (short receivers, no Hungarian notation), no panic outside main, no init() doing work, no global mutable state, context.Context as first argument for I/O
    functions, no bare goroutines, no reflection on the hot path, comments explain why and cite RFC clauses. Enforced automatically via golangci-lint (17 linters including govet , staticcheck , errcheck , gosec , gocritic , revive depguard , gocyclo , funlen , forbidigo ) in prek hooks and CI. Contributions must comply — the PR checklist in CONTRIBUTING.md requires prek run --all-files to pass.



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

    bouine automatically enforces its Go coding style via multiple FLOSS tools, all configured in the repository:Formatters (in .golangci.yaml ):

    • gofmt -s (simplify) — enforces standard Go formatting
    • goimports with local prefix github.com/bouine-cache/bouine Linters (17 enabled in .golangci.yaml , mandated by AGENTS.md §14.4 ):
    • govet , staticcheck , errcheck , gosec , bodyclose , contextcheck , noctx , nilerr , gocritic , revive ,
      forbidigo , gocyclo (≤15), funlen (≤80), depguard (layer enforcement), unparam , ineffassign , unused ,
      misspell
      Enforcement points:
    • prek pre-commit hook — runs gofmt -s , golangci-lint --new-from-rev=HEAD~ on changed lines, go mod tidy check,
      go test -race -short on every commit
    • prek pre-push hook — runs full go test -race and govulncheck
    • CI ( ci.yml ) — re-runs prek run --all-files as its first stage, so bypassed local hooks still fail the build Style exceptions are rare and must be documented at their location (e.g., gosec suppressions require a comment citing the threat model per AGENTS.md §6 ).

  • 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).

    bouine is pure Go (no import "C" ), but produces native binaries and uses CGO_ENABLED=1 in CI for the race detector. The build system honors relevant compiler/linker variables:

    • GO — respected via ?= in the Makefile, so GO=gccgo make build works
    • GOFLAGS — respected via ?= and passed to go build
    • CC — honored by the Go toolchain when CGO is enabled (used by the race detector)
    • CGO_CFLAGS , CGO_CXXFLAGS , CGO_LDFLAGS — honored by the Go toolchain for cgo compilation
    • LDFLAGS — the Makefile now uses += to append project-specific Go -ldflags to any caller-provided LDFLAGS , so distribution hardening flags or ASAN-related linker options are passed through rather than overwritten
      This makes it easy to enable special build features like ASAN ( CGO_CFLAGS="-fsanitize=address" CGO_LDFLAGS="-fsanitize=address" make build ) or distribution hardening flags.


    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.

    The build system preserves debugging information when requested. Symbol stripping ( -s -w ) is now controlled by a STRIPFLAGS variable (default: -s -w ) in both the Makefile and Dockerfile. To produce a debug build with full DWARF info and symbol table:

    • Makefile: make build STRIPFLAGS=
    • Dockerfile: docker build --build-arg STRIPFLAGS= .
      The Go toolchain natively generates DWARF debug info; the strip flags were the only thing removing it. With STRIPFLAGS=empty, go tool nm and go tool objdump work on the resulting binary, and hardening audit tools can inspect the binary No install -s is used anywhere in the build or installation process.


    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.

    bouine uses a single Go module ( go.mod at repo root). The build command go build ./cmd/bouine invokes the Go toolchain, which resolves all cross-package dependencies through the import graph — there are no recursive make -C subdir calls, no per-subdirectory Makefiles, and no recursive build hierarchy. The Makefile is a thin wrapper with a single build target that calls go build once. The Go toolchain guarantees correct dependency ordering across packages within the module.



    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.

    bouine supports bit-for-bit reproducible builds via SOURCE_DATE_EPOCH.

    The build already uses - trimpath (strips filesystem paths from the binary) and CGO_ENABLED=0 in the Dockerfile (eliminates C compiler variability). The remaining non-determinism was the build timestamp injected via -ldflags -X ...buildinfo.Date= . When SOURCE_DATE_EPOCH is set, both the Makefile and Dockerfile derive a stable ISO timestamp from it instead of using date -u . Verified: two consecutive builds with SOURCE_DATE_EPOCH=1700000000 make build produce identical SHA-256 checksums


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

    bouine provides multiple commonly-used installation and uninstallation methods:

    • Homebrew (macOS): brew install bouine-cache/bouine/bouine / brew uninstall bouine-cache/bouine/bouine
    • Go install: go install github.com/bouine-cache/bouine/cmd/bouine@latest
    • Docker (standard OCI container image on Docker Hub): docker pull bouinecache/bouine:latest / docker rmi bouinecache/bouine:latest
    • Helm (Kubernetes package manager, chart published on Artifact Hub): helm install bouine bouine/bouine / helm uninstall bouine
    • Prebuilt binaries: downloadable from GitHub Releases with standard tar -xzf extraction

    All four are commonly-used conventions. The Helm chart and Docker image are the primary distribution channels for
    production deployments.



    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]

    The Makefile provides make install and make uninstall targets that honor the DESTDIR environment variable, the standard POSIX convention for staged installs. The install location is controlled by PREFIX (default: /usr/local ), so make install DESTDIR=/tmp/staging PREFIX=/opt/bouine writes to /tmp/staging/opt/bouine/bin/bouine . Both targets use the standard install command with explicit permissions (0755). Verified: install writes the binary, uninstall removes it.



    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.

    make setup-dev provides a one-command setup that installs all development tools ( golangci-lint , govulncheck , gitleaks , templ ), downloads Go module dependencies, installs prek hooks, and verifies the build and short tests pass. The only prerequisites are Go 1.26.x (pinned in go.mod ), prek (installed via brew / pip / uv ), and Docker (for integration/conformance tests). The target is documented in CONTRIBUTING.md § "Setting up" and AGENTS.md §14.1 , and uses commonly-used conventions: go install for tool installation, go mod download for dependencies, and make for orchestration.


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

    URL: https://github.com/bouine-cache/bouine/blob/main/go.mod

    The project uses Go modules: go.mod enumerates all direct dependencies, and go.sum pins their
    checksums. CI enforces hygiene with a go mod tidy pre-commit hook ( .pre-commit-config.yaml ) that fails if go.mod / go.sum drift, plus govulncheck on pre-push and in CI. [osps_qa_02_01]



    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.

    bouine monitors external dependencies through multiple mechanisms:

    1. govulncheck — runs in CI ( .github/workflows/ci.yml , on every push) and as a pre-push prek hook ( .pre-commit-config.yaml ). It analyzes the Go dependency graph against the Go vulnerability database and reports known vulnerabilities in direct and transitive dependencies.
    2. Dependabot ( .github/dependabot.yml ) — automatically checks for outdated dependencies weekly across Go modules, GitHub Actions, and Docker base images. Grouped updates for OTel and golang.org/x packages. Creates PRs to bump versions, which triggers CI including govulncheck.
    3. Trivy ( release.yml ) — scans the released container image for HIGH/CRITICAL vulnerabilities ( exit-code: 1 ) before publishing. Blocks releases if exploitable vulnerabilities are found.
    4. docs/deps.md — the dependency allow-list includes a manual license audit of the production build graph, and every new dependency requires an ADR and a security review pass per AGENTS.md §5.


    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.

    The project uses Go modules: go.mod enumerates all direct dependencies, and go.sum pins their
    checksums. CI enforces hygiene with a go mod tidy pre-commit hook ( .pre-commit-config.yaml ) that fails if go.mod / go.sum drift, plus govulncheck on pre-push and in CI. [osps_qa_02_01]



    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]

    bouine avoids deprecated or obsolete functions and APIs through automated enforcement. staticcheck is enabled in .golangci.yaml and runs in prek hooks and CI. Its SA1019 check (which flags use of deprecated APIs) is not suppressed anywhere in the project. The only staticcheck exclusion is SA5011 in test files (a known false positive with t.Fatal ). Dependabot bumps dependencies weekly, ensuring the project stays on current API versions. The Go toolchain is pinned to 1.26.x via go.mod . The one internal // Deprecated: comment in responsewriter.go marks an internal API that callers should not use; it is not a deprecated external API.


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

    The test-linux job in .github/workflows/ci.yml runs go test -race -count=1 -timeout=120s -coverprofile=coverage.out ./... on every pull request and every push to main . It produces a visible pass/fail report in the GitHub Actions UI and prints a coverage summary ( go tool cover -func ). Coverage results are uploaded to Codecov for trend tracking. Additionally, the test-arm job runs the same test suite on ubuntu-24.04-arm for architecture coverage on PRs. The prek job runs go test -race -short as a pre-commit hook mirror. All jobs gate merging — a test failure blocks the PR.



    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]

    An audit of substantive bug fix commits in the last 6 months shows that every fix included regression tests in the same commit.

    Examples: 84fa0f0 (purge deletes Vary variants) added tests in handler_test.go and tiered_test.go ; b566ba1 (Vary:* non-matchable) added tests in vary_test.go ; c3ee147 (tombstone queue overflow) added tests in tiered_test.go ; 2d641a1 (reflected-XSS) added tests in handler_invalidation_test.go ; b9f3333 (attacker-controlled route label) added tests in dataplane_source_test.go ; 847e4cd (SWR use-after-close) added tests in handler_test.go . This far exceeds the 50% threshold. The AGENTS.md working loop (§16) and PR checklist require "Tests added or updated; coverage not reduced" for every change, and the prek hook runs go test -race -short on every commit.



    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.

    The production code has 87.9% statement coverage (measured with go test -coverprofile across all non-test-infrastructure, non-generated packages). Every production package individually exceeds 80%:

    • internal/cache : 91.9%, internal/admin : 96.5%, internal/server : 80.1%, internal/config : 80.3%, internal/origin : 81.1%, internal/storage : 81.7%, internal/cluster : 84.0%, internal/cloudflare : 91.7%, internal/dashboard : 93.4%, internal/dashboard/insights : 88.1%, pkg/api : 98.5%, pkg/bouineapi : 97.9%
    • 6 packages are at 100%: observability/accesslog , observability/responsewriter , platform , runtime/shutdown, storage/cachaner , storage/evictor

    The total across all packages (including test infrastructure at 0% and generated templ code) is 56.6%, but the 0% packages are: cmd/bouine (4-line main() ), internal/testutil/testkey (no test files, test helper), and internal/dashboard/templates (generated _templ.go files, not manually editable). The FLOSS tool ( go test -coverprofile ) measures coverage per-package; the aggregate of 87.9% across production packages meets the 80% threshold.


  • 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]

    URL: https://github.com/bouine-cache/bouine/blob/main/AGENTS.md#8-testing-rules

    Justification: AGENTS.md §8 contains a formal written policy: "When major new functionality is added to the software tests for that functionality MUST be added to an automated test suite in the same pull request. A PR that adds major functionality without tests will be rejected by reviewers and will fail the CI gate." The policy defines "major new functionality" as any change that adds a new user-visible capability, configuration option, API endpoint, or code path
    in the cache, storage, cluster, or server layers. It is reinforced in CONTRIBUTING.md § "Testing discipline" and in the PR checklist.



    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.

    The test-adding policy is documented in CONTRIBUTING.md ("The working loop", step 4: "Implement smallest reasonable change, follow neighboring patterns, add tests as you go") and in the PR checklist ("Pull request checklist": "Tests added or updated; coverage not reduced"). AGENTS.md mandates "Add tests as you go, not at the end" and requires "Tests added/updated; coverage not reduced" on every PR.


  • 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 is maximally strict with warnings:

    • 19 linters enabled in .golangci.yaml (govet, staticcheck, errcheck, gosec, bodyclose, contextcheck, noctx, nilerr, gocritic, revive, forbidigo, gocyclo ≤15, funlen ≤80, depguard, unparam, ineffassign, unused, misspell, lll)
    • forbidigo bans fmt.Println , panic , os.Exit outside main
    • depguard enforces architectural layer boundaries
    • Pre-commit hook runs golangci-lint on every commit ( --new-from-rev=HEAD~ )
    • CI re-runs prek run --all-files as first stage
    • govulncheck runs on pre-push and CI
    • -race flag always on in CI and pre-commit tests
    • Coverage gates: ≥85% per package, ≥95% for cache / storage

 Seguridad 13/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).

    docs/security/threat-model.md §2.1 documents how bouine implements secure design principles, with concrete examples for each:

    • Fail-safe defaults — admin API denies by default (401 without token), upstream TLS verification on by default, Set-Cookie responses not cached by default, container runs non-root with read-only rootfs by default
    • Complete mediation — every admin write request authenticated through a single middleware chain with no bypass; every data-plane request passes through route matcher and RFC 9111 freshness evaluation; peer-fetch requires mTLS on every call
    • Least privilege — non-root container with dropped capabilities, minimal CI permissions, admin token scoped to admin ops only, separate CAs for data-plane and cluster mTLS
    • Economy of mechanism — single HTTP stack ( net/http ), declarative YAML config (no eval), no web framework
    • Defense in depth — smuggling defenses + header hygiene + private response protection + path traversal prevention + resource limits, each layer independent
    • Separation of privilege — separate admin and data ports, separate cluster and data-plane CAs, tokens in env vars not config files
    • Psychological acceptability — secure defaults documented in Helm chart and SECURITY.md hardening checklist, insecure options require explicit opt-in

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

    Go's TLS 1.2+ default cipher suites prefer AEAD modes (GCM, ChaCha20-Poly1305) and exclude SHA-1-dependent suites. CBC mode is not used in SSH (bouine doesn't implement SSH). xxhash is used for cache keys (non-cryptographic, no security claim). crypto/sha256 is used for checksums. No SHA-1 or CBC mode dependencies.



    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]

    bouine supports multiple cryptographic algorithms through Go's crypto/tls package, which provides algorithm agility by default:

    • TLS 1.3 (preferred when MinVersion >= 1.3 ): AES-256-GCM, AES-128-GCM, ChaCha20-Poly1305 for symmetric encryption; SHA-256, SHA-384 for transcript hashing. The cipher suite list is managed by Go's stdlib and cannot be customized for TLS 1.3 (all suites are AEAD, all are secure).
    • TLS 1.2 (minimum supported): Go's default cipher suite list includes AES-128-GCM, AES-256-GCM, ChaCha20-Poly1305 — multiple symmetric algorithms so users can switch if one is broken. The CipherSuites field on tls.Config is available for operators to further restrict or reorder suites via the TLS config struct.
    • Hash algorithms: Go's stdlib provides SHA-224, SHA-256, SHA-384, SHA-512 (SHA-2 family) and SHA-3. bouine uses these
      for TLS transcript hashing and certificate verification. Cache keys use xxhash (non-cryptographic, by design — performance-critical path).
      If a cipher or hash is found broken, operators can update Go's toolchain (which updates the default suite list) or pin specific cipher suites via the TLS config. No code change is required to switch algorithms.


    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]

    bouine supports storing authentication credentials and private cryptographic keys in files separate from configuration:

    • Admin bearer token — can be set via ${ADMIN_TOKEN} env var expansion in the YAML config (the loader supports ${VAR} substitution), or left empty to auto-generate a random token at startup. The token value is never compiled into the binary. Operators can rotate it by changing the env var or config value and restarting — no recompilation.
    • TLS private keys — the TLS config struct references cert and key files by path ( cert_file , key_file ), loaded at runtime from disk. Operators replace the files on disk and restart to rotate — no recompilation, no config change needed if the paths stay the same.
    • Cluster mTLS keys — the cluster config ( ClusterTLS struct) similarly references cert_file and key_file by path loaded at runtime.
    • Origin mTLS client certs — upstream pool TLS config references cert/key files by path. All credentials and keys are in separate files or environment variables, never hardcoded, and can be updated and replaced without recompilation.


    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]

    bouine supports secure protocols for all network communications, with insecure protocols disabled by default:

    • Data plane: HTTP/1.1 and HTTP/2 over TLS (HTTPS). Minimum TLS version is 1.2 ( tls.Config{MinVersion: tls.VersionTLS12} in listener.go:143 ), configurable to 1.3. Plaintext HTTP (h2c) is available only via explicit configuration for in-mesh traffic; the default Helm chart enables TLS.
    • Cluster (peer-to-peer): mTLS required for all gossip and peer-fetch traffic. Separate CA from the data plane. No plaintext cluster communication is supported.
    • Origin (upstream): TLS verification enabled by default ( insecure_skip_verify refused in release builds). Optional mTLS for client cert authentication.
    • Admin API: Separate port, bearer token or mTLS authentication. The Helm chart binds it to cluster-internal only by default (not exposed to the Internet).
    • Insecure protocols disabled by default: SSLv3 and earlier are not supported (Go's crypto/tls minimum is TLS 1.0, but bouine sets the minimum to 1.2). FTP, telnet, SSHv1 are not used. insecure_skip_verify is refused in release builds. The admin API rejects insecure HTTP for write methods.


    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]

    bouine requires at least TLS 1.2 on all TLS surfaces.

    The HTTPS listener sets tls.Config{MinVersion: tls.VersionTLS12} by default ( internal/server/listener.go:143 ). The minimum version is configurable via tls.min_version in the config ( internal/config/config.go:101 ), but the default and minimum supported value is 1.2. Cluster mTLS and origin TLS also inherit Go's secure defaults with TLS 1.2 as the floor. The test utility (internal/testutil/tlsutil/tlsutil.go:92 ) explicitly asserts MinVersion >= tls.VersionTLS12 .



    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.

    bouine performs TLS certificate verification by default on all TLS surfaces:

    • Origin (upstream) TLS — Go's default tls.Config performs full certificate verification ( InsecureSkipVerify: false is the Go default). There is no InsecureSkipVerify field in the production config or origin/peer-fetch code. The threat model (T02) confirms: "TLS verify enabled by default; insecure_skip_verify refused in release builds."
    • Cluster mTLS — peer-fetch and gossip use a tls.Config with certificate verification enabled (separate CA, mutual verification).
    • Data-plane TLS — the HTTPS listener terminates TLS with standard certificate verification; clients verify the server certificate.
    • Admin API — when mTLS is configured, client certificates are verified.
      The only InsecureSkipVerify: true occurrences are in test files ( broadcast_test.go:342 , listener_test.go:96 ), both annotated with //nolint:gosec // G402: test-only . No production code disables certificate verification.


    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]

    bouine performs TLS certificate verification before any HTTP headers (including private ones) are sent. Go's net/http client and server establish the TLS handshake (including certificate verification) before any HTTP data is exchanged — this is inherent to the TLS protocol (handshake completes before application data flows). Since InsecureSkipVerify is false by default in all production code paths (confirmed: no InsecureSkipVerify in non-test origin, cluster, or server code), certificate verification always completes before HTTP headers with private information (such as Authorization , Cookie , admin bearer tokens) are sent to origin or peers.


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

    URL: https://github.com/bouine-cache/bouine/blob/main/README.md#verifying-release-signatures

    All releases are cryptographically signed using cosign with keyless signing (Sigstore, via GitHub Actions OIDC). The release.yml workflow signs both the binary checksums ( cosign sign-blob ) and the Docker image ( cosign sign ). The private key is never stored on any distribution server — signatures are generated in CI using ephemeral OIDC credentials tied to the GitHub workflow. The README documents the verification process with step-by-step commands for both binary releases ( cosign verify-blob ) and Docker images ( cosign verify ), including the certificate identity and OIDC issuer to trust. An SPDX SBOM is also generated for each release.



    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]

    Release tags are annotated tag objects created by the maintainer.

    While the tags themselves are not GPG-signed, each tag triggers the release.yml GitHub Actions workflow which produces cosign-signed artifacts (binary checksums and Docker images) using keyless Sigstore signing tied to the GitHub OIDC identity of the workflow. The certificate identity is bound to refs/tags/v* in the bouine-cache/bouine repository, so the signature proves the release was built from that specific tag by the official CI pipeline. Users verify via cosign verify-blob as documented in the README. Additionally, git tags could be GPG/SSH-signed in the future for defense-in-depth, but the cosign-signed release artifacts already provide cryptographic verification of the release provenance.


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

    bouine validates all inputs from potentially untrusted sources using allowlist and bounds-checking patterns:
    HTTP data plane — MaxHeaderBytes 64 KiB, ReadHeaderTimeout 10s, MaxConnections configurable, fast-path H1
    parser caps at 100 headers and 16 KiB read buffer, HTTP smuggling detection rejects CL+TE conflicts and duplicate Content-Length.Admin API — MaxBodyBytes (default 1 MiB) enforced via http.MaxBytesReader , batch purge capped at MaxBatchSize (default 1000) with empty-entry rejection, JSON decoder uses DisallowUnknownFields() , regex ban predicates validated via regexp.Compile before use, bearer token checked with subtle.ConstantTimeCompare .Config validation — Config.Validate() checks: pool names unique, routes reference valid pools, HTTP methods validated against an 8-method allowlist ( isKnownHTTPMethod ), cluster mode restricted to "strong" / "eventual" allowlist, eviction algorithm restricted to "sieve" / "cachaner" allowlist, all durations and sizes >= 0, JitterPercent 0-50, static root must be absolute path, index files must not contain / , YAML strict mode rejects unknown fields.Static file serving — path traversal prevention via path.Clean + isPathContained() check (rejects paths escaping root with 403), only GET/HEAD allowed, file size capped at MaxBytes , fuzz-tested with FuzzPathTraversal .Cluster protocol — binary frames validated with magic byte ( 0x42 ), version byte, message type, minimum length checks, string length cap (64 KiB) payload bounds checking on every field read, hop limit enforced (max 2, returns 508), request/response body size limits (512 bytes / 64 MiB), unrecognized gossip message types logged and dropped.Query param allowlist — keepParams in keypolicy.go implements an explicit allowlist: only listed params participate in the cache key, all others stripped.
    Fuzz tests — 13 fuzz functions cover H1 parsing, header parsing, smuggling detection, path traversal, cluster codec
    round-trips, cache key building, Cache-Control parsing, Vary variant keys, cache state machine, and storage object
    decoding. All ensure no panics on arbitrary input.



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

    bouine uses multiple hardening mechanisms so that software defects are less likely to result in security vulnerabilities:Container hardening (Helm chart values.yaml + Dockerfile):

    • Runs as non-root ( runAsNonRoot: true , runAsUser: 65534 )
    • Read-only root filesystem ( readOnlyRootFilesystem: true )
    • All Linux capabilities dropped ( capabilities.drop: [ALL] )
    • No privilege escalation ( allowPrivilegeEscalation: false )
    • Seccomp profile RuntimeDefault (blocks unsafe syscalls)
    • Distroless base image ( gcr.io/distroless/static-debian13:nonroot ) — no shell, no package manager, no attack surface

    Language-level hardening (Go):

    • Go is a memory-safe language with garbage collection — no buffer overflows, no use-after-free, no format string vulnerabilities
    • panic forbidden outside main (enforced by forbidigo linter) — errors are returned, not crashed
    • os.Exit forbidden outside main — graceful shutdown via context cancellation
    • fmt.Print* forbidden outside main — structured logging via slog only
      Code-level hardening:
    • HTTP smuggling detection rejects ambiguous framing (CL+TE, duplicate CL, obs-fold)
    • Hop-by-hop headers stripped per RFC 9110 §7.6.1
    • Private responses ( Set-Cookie , Authorization ) not cached by default
    • Storage paths derived from xxhash64 of cache keys, never from user-controlled strings (path traversal prevention)
    • All parsers have byte caps (headers <= 64 KiB, URLs bounded, strings <= 64 KiB in cluster protocol)
    • Every queue is bounded (connection limits, in-flight caps, latch caps, body size limits)
    • gosec linter enforces zero security findings; suppressions require threat model justification


    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.

    URL: https://github.com/bouine-cache/bouine/blob/main/docs/security/threat-model.md#8-assurance-case

    docs/security/threat-model.md §8 provides a structured assurance case with all four required components:

    1. Threat model description (§8.1) — references the STRIDE-based threat model in §§1-7 with 13 assets, 6 trust boundaries, 8 attacker classes, and 40+ threat rows with controls and residual risk.
    2. Trust boundaries (§8.2) — 6 boundaries clearly identified (Internet/data-plane, listener/engine, bouine/origin, bouine/peer, operator/admin, process/disk) with per-boundary trust assumptions and controls.
    3. Secure design principles argument (§8.3) — maps each Saltzer-Schroeder / OWASP principle (fail-safe defaults, complete mediation, least privilege, economy of mechanism, defense in depth, separation of privilege, psychological acceptability) to concrete bouine implementations.
    4. Common implementation weaknesses countered (§8.4) — systematic mapping of all 10 OWASP Top 10 (2021) categories and 7 additional CWE Top 25 categories (CWE-125, 190, 400, 444, 22, 79, 352) to specific bouine controls, with references to fuzz tests, linters, and config validation.

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

    The project applies multiple static analysis tools beyond compiler warnings:

    • govulncheck, Go vulnerability scanner, runs on pre-push and CI
    • gitleaks, secret detection, runs on every commit and CI

    All three run before any release (CI gate in ci.yml runs before release.yml on tag pushes).


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

    The project is written entirely in Go, a memory-safe language. No memory-unsafe languages (C/C++) are used.



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

Entrada de insignia del proyecto propiedad de: Théotime Lévêque.
Entrada creada el 2026-08-12 12:54:41 UTC, última actualización el 2026-08-19 20:35:31 UTC. Última obtención de la insignia de nivel básico el 2026-08-13 07:59:52 UTC.