bouine

Projekte, die den nachfolgenden Best Practices folgen, können sich freiwillig selbst zertifizieren und zeigen, dass sie einen Core-Infrastruktur-Initiative-/OpenSSF-Badge erhalten haben.

Es gibt keine Auswahl an Praktiken, die garantieren können, dass Software niemals Fehler oder Schwachstellen hat. Selbst formale Methoden können fehlschlagen, wenn die Spezifikationen oder Annahmen falsch sind. Auch gibt es keine Auswahl an Praktiken, die garantieren können, dass ein Projekt eine gesunde und gut funktionierende Entwicklungsgemeinschaft erhalten wird. Allerdings können Best Practices dabei helfen, die Ergebnisse von Projekten zu verbessern. Zum Beispiel ermöglichen einige Praktiken die Mehrpersonen-Überprüfung vor der Freigabe, die sowohl helfen können ansonsten schwer zu findende technische Schwachstellen zu finden und gleichzeitig dazu beitragen Vertrauen und den Wunsch nach wiederholter Zusammenarbeit zwischen Entwicklern verschiedener Unternehmen zu schaffen. Um ein Badge zu verdienen, müssen alle MÜSSEN und MÜSSEN NICHT Kriterien erfüllt sein, alle SOLLTEN Kriterien müssen erfüllt sein oder eine Rechtfertigung enthalten, und alle EMPFHOLEN Kriterien müssen erfüllt sein oder nicht (wir wollen sie zumindest berücksichtigt wissen). Wenn lediglich ein allgemeiner Kommentar angebeben werden soll, keine direkte Begründung, dann ist das erlaubt, wenn der Text mit "//" und einem Leerzeichen beginnt. Feedback ist willkommen auf derGitHub-Website als Issue oder Pull-Request. Es gibt auch eine E-Mail-Liste für allgemeine Diskussionen.

Wir stellen Ihnen gerne die Informationen in mehreren Sprachen zur Verfügung, allerdings ist die englische Version maßgeblich, insbesondere wenn es Konflikte oder Inkonsistenzen zwischen den Übersetzungen gibt.
Wenn dies Ihr Projekt ist, zeigen Sie bitte Ihren Badge-Status auf Ihrer Projektseite! Der Badge-Status sieht so aus: Badge-Level für Projekt 14035 ist silver So können Sie ihn einbetten:
Sie können Ihren Badge-Status anzeigen, indem Sie Folgendes in Ihre Markdown-Datei einbetten:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14035/badge)](https://www.bestpractices.dev/projects/14035)
oder indem Sie Folgendes in Ihr HTML einbetten:
<a href="https://www.bestpractices.dev/projects/14035"><img src="https://www.bestpractices.dev/projects/14035/badge"></a>


Dies sind die Kriterien das Level Silber. Sie können auch die Kriterien für die Level Passing oder Gold sehen.

Baseline Series: Baseline Niveau 1 Baseline Niveau 2 Baseline Niveau 3

        

 Grundlagen 17/17 ●

  • Allgemein

    Hinweis: Andere Projekte können den selben Namen benutzen.

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

    Bitte verwenden Sie das SPDX-License-Expression-Format; Beispiele sind "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT" und "(BSD-2-Clause OR Ruby)". Geben sie nicht die einfachen oder doppelten Anführungszeichen mit an.
    Wenn es mehr als eine Programmiersprache gibt, listen Sie sie als kommagetrennte Werte (Leerzeichen sind optional) auf und sortieren Sie sie von am häufigsten zum am wenigsten verwendeten. Wenn es eine lange Liste gibt, bitte mindestens die ersten drei häufigsten auflisten. Wenn es keine Programmiersprache gibt (z. B. ist dies nur ein Dokumentations- oder Testprojekt), verwenden Sie das einzelne Zeichen "-". Bitte verwenden Sie eine herkömmliche Großschreibung für jede Sprache, z.B. "JavaScript".
    Das Common Platform Enumeration (CPE) ist ein strukturiertes Namensschema für IT-Systeme, Software und Pakete. Es wird in diversen Systemen und Datenbanken bei der Meldung von Schwachstellen verwendet.
  • Voraussetzungen


    Das Projekt MUSS ein bestimmtes Level erreichen. [achieve_passing]

  • Grundlegende Informationen auf der Projektwebseite


    Die Informationen darüber, wie man mitwirken kann, MÜSSEN die Anforderungen für akzeptable Beiträge (z.B. einen Hinweis auf einen erforderlichen Codierungsstandard) enthalten. (URL erforderlich) [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.)

  • Projektüberwachung


    Das Projekt SOLLTE einen rechtlichen Mechanismus haben, wo alle Entwickler von nicht-trivialen Beiträgen versichern, dass sie rechtlich ermächtigt sind, diese Beiträge zu machen. Der häufigste und leicht umsetzbare Ansatz, ist die Verwendung eines Developer Certificate of Origin (DCO) , wo Benutzer "signed-off-by" in ihren Commits und die Projektlinks zur DCO-Website hinzufügen. Allerdings DARF dies als Contributor License Agreement (CLA) oder als ein anderer rechtlicher Mechanismus implementiert werden. (URL erforderlich) [dco]
    Die DCO ist der empfohlene Mechanismus, weil er einfach zu implementieren ist, im Quellcode verfolgt wird und git direkt eine "signed-off" Funktion mit "commit -s" unterstützt. Um am effektivsten zu sein, ist es am besten, wenn die Projektdokumentation erklärt, was "signed-off" für dieses Projekt bedeutet. Eine CLA ist eine rechtliche Vereinbarung, die die Bedingungen definiert, unter denen intellektuelle Werke an eine Organisation oder ein Projekt lizenziert wurden. Ein Contributor Assignment Agreement (CAA) ist eine gesetzliche Vereinbarung, die die Rechte an einer intellektuellen Arbeit an eine andere Person überträgt; Projekte müssen keine CAAs haben, da CAA das Risiko erhöht, dass potenzielle Mitwirkende nicht dazu beitragen werden, vor allem, wenn der Empfänger eine gewinnorientierte Organisation ist. Die Apache Software Foundation CLAs (die individuelle Contributor-Lizenz und die Corporate CLA) sind Beispiele für CLAs, für Projekte, die bestimmt haben, dass die Risiken dieser CLAs für das Projekt geringen sind als ihre Vorteile.

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



    Das Projekt MUSS eindeutig sein Projekt-Governance-Modell (die Art, wie es Entscheidungen fällt, einschließlich der wichtigsten Rollen) definieren und dokumentieren. (URL erforderlich) [governance]
    Es muss einen gut dokumentierten, etablierten Weg geben, Entscheidungen zu treffen und Streitigkeiten zu lösen. In kleinen Projekten kann dies so einfach sein wie, "der Projektinhaber und -Leiter trifft alle endgültigen Entscheidungen". Es gibt verschiedene Führungs-Modelle, darunter wohlwollender Diktator und formale Meritokratie; Für weitere Details siehe Governance-Modelle . Sowohl zentralisierte (z.B. Single-Maintainer) als auch dezentrale (z.B. Gruppen-Maintainer) Ansätze wurden erfolgreich in Projekten verwendet. Die Governance-Informationen müssen nicht die Möglichkeit einer Projektspaltung dokumentieren, da dies für FLOSS-Projekte immer möglich ist.

    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.



    Das Projekt MUSS einen Code of Conduct etablieren und an einem üblichen Ort veröffentlichen. (URL erforderlich) [code_of_conduct]
    Projekte können das Miteinander ihrer Gemeinschaft verbessern und Erwartungen in Bezug auf akzeptables Verhalten setzen, indem sie einen Verhaltenskodex verfassen. Dies kann helfen, Probleme zu vermeiden, bevor sie auftreten, und das Projekt zu einem einladenderen Ort zu machen. Dies sollte sich nur auf das Verhalten innerhalb der Gemeinschaft/ am Arbeitsplatz des Projekts konzentrieren. Beispielhafte Verhaltenskodizes sind der Linux Kernel Code of Conduct, der Contributor Covenant Code of Conduct, der Debian Code of Conduct, der Ubuntu Code of Conduct, der Fedora Code of Conduct, der GNOME Code Of Conduct, der KDE Community Code of Conduct, der Python Community Code of Conduct, die Ruby Community Conduct Guideline und der Rust Code of Conduct.

    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.



    Das Projekt MUSS klar und deutlich die Rollen- auf Aufgabenverteilung dokumentieren, inklusive einzelnen Tätigkeiten, die von den Rollenträgern ausgeführt werden müssen. Es MUSS eindeutig sein wer welche Rolle hat, auch wenn es in anderer Form dokumentiert ist. (URL erforderlich) [roles_responsibilities]
    Die Dokumentation für Governance und Rollen und Verantwortlichkeiten können an einem Ort sein.

    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.



    Das Projekt MUSS in der Lage sein, mit minimaler Unterbrechung fortzufahren, wenn eine beliebige Person nicht in der Lage ist oder stirbt. Insbesondere MUSS das Projekt in der Lage sein, Probleme zu lösen, vorgeschlagene Änderungen zu akzeptieren und Versionen der Software freizugeben, innerhalb einer Woche nach der Bestätigung, dass eine Person nicht mehr in der Lage ist oder gestorben ist. Dies DARF sichergestellt werden, indem man jemandem anderes notwendige Schlüssel, Passwörter und gesetzliche Rechte gibt, um das Projekt fortzusetzen. Einzelpersonen, die ein FLOSS-Projekt ausführen, DÜRFEN dies durch die Bereitstellung von Schlüsseln in einer Lockbox und einer Willenserklärung zur Bereitstellung von erforderlichen gesetzlichen Rechten (z. B. für DNS-Namen). (URL erforderlich) [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.



    Das Projekt SOLLTE einen Bus-Faktor von 2 oder mehr haben. (URL erforderlich) [bus_factor]
    Ein "bus factor" (aka "LKW-Faktor") ist die minimale Anzahl von Projektmitgliedern, die plötzlich aus einem Projekt ("hit by a bus") verschwinden müssen, bevor das Projekt aufgrund fehlender kompetenter Mitarbeiter stockt. Das Truck-Factor-Tool kann dies für Projekte auf GitHub schätzen. Weitere Informationen finden Sie unter Bewertung des Busfaktors von Git-Repositories von 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.


  • Dokumentation


    Das Projekt MUSS eine dokumentierte Roadmap, für mindestens das nächste Jahr haben, die beschreibt, was das Projekt beabsichtigt zu tun und nicht zu tun. (URL erforderlich) [documentation_roadmap]
    Das Projekt könnte die Roadmap nicht umsetzen, das ist ok; Der Zweck der Roadmap ist es, potenziellen Nutzern/innen und Entwicklern/innen zu helfen, die beabsichtigte Richtung des Projekts zu verstehen. Sie muss nicht detailliert sein.

    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.



    Das Projekt MUSS in der Dokumentation die Architektur (alias High-Level-Design) der vom Projekt entwickelten Software bereitstellen. Wenn das Projekt keine Software produziert, wählen Sie "nicht anwendbar" (N/A). (URL erforderlich) [documentation_architecture]
    Eine Softwarearchitektur erläutert die grundlegenden Strukturen eines Programms, d.h. die Hauptkomponenten des Programms, die Beziehungen zwischen ihnen und die Schlüsseleigenschaften dieser Komponenten und Beziehungen.

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



    Das Projekt MUSS dokumentieren, was der/die Benutzer/in in Bezug auf die Sicherheit der Projektsoftware (seine "Sicherheitsanforderungen") erwarten kann und nicht erwarten kann. (URL erforderlich) [documentation_security]
    Dies sind Sicherheitsanforderungen, die die Software erfüllen soll.

    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 .



    Das Projekt MUSS eine "Quickstart"-Anleitung für neue Benutzer/innen haben, um ihnen zu helfen, schnell mit der Software umgehen zu können. (URL erforderlich) [documentation_quick_start]
    Die Idee ist, den Benutzern/innen zu zeigen, wie man anfängt und was die Software überhaupt macht. Dies ist entscheidend für potenzielle Benutzer/innen, um loszulegen.

    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.



    Das Projekt MUSS sich bemühen, die Dokumentation mit der aktuellen Version der Projektergebnisse (einschließlich der vom Projekt produzierten Software) stehts zu aktualisieren. Jegliche bekannte Dokumentationsfehler, die es inkonsistent machen, MÜSSEN behoben werden. Wenn die Dokumentation in der Regel aktuell ist, aber fälschlicherweise einige ältere Informationen enthält, die nicht mehr wahr sind, behandeln Sie diese als Störung, dann verfolgen und beheben Sie diese wie üblich. [documentation_current]
    Die Dokumentation DARF Informationen über Unterschiede oder Änderungen zwischen Versionen der Software und/oder Links zu älteren Versionen der Dokumentation enthalten. Die Absicht dieses Kriteriums ist nicht, dass die Dokumentation perfekt sein muss, vielmehr soll Arbeit investiert, um die Dokumentation konsistent zu halten

    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.



    Die Projekt-Repository-Titelseite und / oder Website MUSS alle Errungenschaften, die erreicht wurden, einschließlich dieses Best Practices Abzeichens, innerhalb von 48 Stunden nach der öffentlichen Anerkennung ausweisen und verlinken. (URL erforderlich) [documentation_achievements]
    Eine Errungenschaft ist jegliche Form von externen Kriterien, auf die das Projekt speziell hingearbeitet hat, um diese zu erreichen, einschließlich einiger Abzeichen. Diese Informationen müssen nicht auf der ersten Seite der Website des Projekts einzusehen sein. Ein Projekt, das GitHub verwendet, kann Errungenschaften auf der Repository-Vorderseite setzen, indem man sie der README-Datei hinzufügt.

    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.


  • Zugänglichkeit und Internationalisierung


    Das Projekt (beide Projektwebsite und Projektergebnisse) SOLLTE den bewährten Praktiken der Erreichbarkeit folgen, damit Personen mit Behinderungen noch an dem Projekt teilnehmen und die Projektergebnisse nutzen können, wo es vernünftig ist. [accessibility_best_practices]
    Für Webanwendungen siehe Web Content Accessibility Guidelines (WCAG 2.0) und dessen unterstützendes Dokument Understanding WCAG 2.0; Siehe auch W3C accessibility information. Für GUI-Anwendungen sollten Sie die umweltbezogenen Barrierefreiheitsrichtlinien verwenden (z.B. Gnome, KDE, XFCE, Android, iOS , Mac und Windows). Einige TUI-Anwendungen (z.B. `ncurses`-Programme) können bestimmte Dinge ausführen, um sich selbst zugänglicher zu machen (z.B. `alpine`'s `force-arrow-cursor`-Einstellung). Die meisten Kommandozeilen-Anwendungen sind ziemlich unzugänglich. Dieses Kriterium ist oft N/A, z.B. für Programmbibliotheken. Hier sind einige Beispiele, welche Maßnahmen zu ergreifen oder Fragen zu berücksichtigen sind:
    • Stellen Sie Text Alternativen für alle Nicht-Text-Inhalte zur Verfügung, so dass dieser in andere Formen umgewandelt werden kann, wie z.B. Großdruck, Blindenschrift, Sprache, Symbole oder einfachere Sprache ( WCAG 2.0-guideline 1.1)
    • Farbe ist nicht das einzige Mittel um Informationen zu übermitteln, die eine Aktion anzeigen, zu einer Eingabe auffordern oder visuelle Elemente unterscheiden. (WCAG 2.0 guideline 1.4.1)
    • Die visuelle Darstellung von Text und Textbildern hat einen Kontrast Verhältnis von mindestens 4,5:1, außer für großen Text, nebensächlichen Text, und Logos(WCAG 2.0 guideline 1.4.3)
    • Machen Sie alle Funktionalitäten von einer Tastatur aus erreichbar (WCAG guideline 2.1)
    • Ein GUI oder ein webbasiertes Projekt SOLLTE mit mindestens einen Screen-Reader auf der Zielplattform(en) testen (z.B. NVDA, Jaws oder WindowEyes auf Windows; VoiceOver auf Mac & iOS; Orca auf Linux/BSD; TalkBack auf Android). TUI-Programme DÜRFEN die Übermalung reduzieren, um eine redundante Lesung durch Screenreader zu verhindern.

    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.



    Die Projektsoftware SOLLTE internationalisiert werden, um eine einfachen Zugang für die Kultur, Region oder Sprache der Zielgruppe zu ermöglichen. Wenn die Internationalisierung (i18n) nicht andzuwenden ist (z. B. die Software keine für Endbenutzer beabsichtigte Texte erzeugt und keinen menschlich lesbaren Text sortiert), wählen Sie "nicht anwendbar" (N/A). [internationalization]
    Lokalisierung "bezieht sich auf die Anpassung eines Produkt-, Applikations- oder Dokumentinhalts, um die Sprache, kulturelle und andere Anforderungen eines bestimmten Zielmarktes zu erfüllen." Internationalisierung ist die "Gestaltung und Entwicklung eines Produkt-, Applikations- oder Dokumentinhaltes, die eine einfache Lokalisierung für Zielgruppen ermöglicht, die in Kultur, Region oder Sprache variieren." (Siehe W3Cs "Lokalisierung vs. Internationalisierung" .) Software erfüllt dieses Kriterium einfach dadurch, dass sie internationalisiert ist. Es ist keine Lokalisierung für eine andere Sprache erforderlich, denn sobald Software internationalisiert wurde, ist es möglich für andere, an der Lokalisierung zu arbeiten.

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


  • Andere


    Wenn die Projektseiten (Website, Repository und Download-URLs) Passwörter für die Authentifizierung von externen Benutzern speichern, müssen die Passwörter als iterierte Hashes mit einem per-User-Salt unter Verwendung eines Key-Stretching (iterierten) Algorithmus (z. B. Argon2id, Bcrypt, Scrypt, or PBKDF2). Wenn die Projektseiten hierfür keine Passwörter speichern, wählen Sie "nicht anwendbar" (N/A) aus. [sites_password_security]
    Beachten Sie, dass die Verwendung von GitHub dieses Kriterium erfüllt. Dieses Kriterium gilt nur für Passwörter, die für die Authentifizierung von externen Benutzern in die Projektseiten verwendet werden (inbound authentication). Wenn sich die Projektseiten auf anderen Seiten anmelden müssen (outbound authentication), müssen sie eventuell Authorization-Tokens für diesen Zweck anders speichern (da das Speichern eines Hashes nutzlos wäre). Dies gilt für das Kriterium crypto_password_storage zu den Projektseiten, ähnlich wie sites_https.

    No passwords are stored, no authentication is provided.


 Verbesserungs-/Nacharbeits-Kontrolle 1/1 ●

  • Vorherige Versionen


    Das Projekt MUSS die am häufigsten verwendeten älteren Versionen des Produkts beibehalten oder einen Upgrade-Pfad zu neueren Versionen bieten. Wenn der Upgrade-Pfad schwierig durchzuführen ist, muss das Projekt dokumentieren, wie das Upgrade durchgeführt werden kann (z. B. die Interfaces, die sich geändert haben, detaillierte Anleitung für die Aktualisierung des Upgrades). [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.


 Berichterstattung 3/3 ●

  • Bug-Report-Prozess


    Das Projekt MUSS ein Issue-Tracking-System zur Verwaltung einzelner Issues verwenden. [report_tracker]

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


  • Anfälligkeits-Prozessbericht


    Das Projekt MUSS die Reporter/in von allen in den letzten 12 Monaten bekanntgegebenen Schwachstellenberichte aufführen, mit Ausnahme der Reporter, die Anonymität erbeten. Wurde in den letzten 12 Monaten keine Schwachstelle festgestellt, wählen Sie "nicht anwendbar" (N/A). (URL erforderlich) [vulnerability_report_credit]

    No vulnerabilities raised in the past 12 months.



    Das Projekt MUSS den Prozess für die Meldung von Schwachstellen auf der Projektseite veröffentlichen. (URL erforderlich) [vulnerability_response_process]
    Dies steht im Zusammenhang mit vulnerability_report_process, welcher erfordert, dass es eine dokumentierte Möglichkeit gibt, Schwachstellen zu melden. Es bezieht sich auch auf vulnerability_report_response, welcher eine Antwort auf Schwachstellenberichte innerhalb eines bestimmten Zeitrahmens erfordert.

    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.


 Qualität 19/19 ●

  • Programmierstil


    Das Projekt MUSS die spezifischen Codierungsstilrichtlinien für die primären Programmierprachen, die es verwendet, einhalten, und erfordern, dass die Beiträge die Bedingungen generell erfüllen. (URL erforderlich) [coding_standards]
    In den meisten Fällen erfolgt dies durch Verweis auf einige vorhandene Stilrichtlinien, möglicherweise Auflistung Unterschiede. Diese Stilrichtlinien können Möglichkeiten zur Verbesserung der Lesbarkeit und zur Verringerung der Wahrscheinlichkeit von Mängeln (einschließlich Schwachstellen) enthalten. Viele Programmiersprachen haben eine oder mehrere weit verbreitete Stilrichtlinien. Beispiele für Style Guides sind Google-Style-Guides und 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.



    Das Projekt MUSS automatisch dafür sorgen, dass die ausgewählten Stilrichtlinien eingehalten werden, wenn mindestens ein FLOSS-Tool vorhanden ist, welches das in der gewählten Programmiersprache tun kann. [coding_standards_enforced]
    Dies kann mit Hilfe von statischen Analysewerkzeugen und/oder durch das Durchlaufen des Codes durch Code-Umformatierer erreicht werden. In vielen Fällen ist die Werkzeugkonfiguration im Projekt-Repository enthalten (da verschiedene Projekte unterschiedliche Konfigurationen wählen können). Projekte DÜRFEN Stil Ausnahmen erlauben (und werden es in der Regel); Wo Ausnahmen getroffen werden, MÜSSEN sie selten sein und MÜSSEN dokumentiert werden an der Stelle im Code, wo sie auftreten, so dass diese Ausnahmen überprüft werden können und so dass Werkzeuge sie automatisch in der Zukunft bearbeiten können. Beispiele für solche Werkzeuge sind ESLint (JavaScript), Rubocop (Ruby) und 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 ).

  • Produktivsystem


    Build-Systeme für native Binärdateien MÜSSEN die relevanten Compiler- und Linker- (Umgebungs-) Variablen, die an sie übergeben werden (z.B. CC, CFLAGS, CXX, CXXFLAGS und LDFLAGS), respektieren und an Compiler- und Linker-Aufrufe weiterleiten. Ein Build-System DARF sie mit zusätzlichen Flags erweitern; Es DARF NICHT einfach die mitgelieferten Werte ersetzen. Wenn keine nativen Binärdateien erzeugt werden, wählen Sie "nicht anwendbar" (N/A). [build_standard_variables]
    Es sollte einfach sein, spezielle Build-Features wie Address Sanitizer (ASAN) zu aktivieren, oder verteilte und bewährte Best Practices einzuhalten (z.B. durch einfaches Einschalten von Compiler-Flags).

    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.


    Das Build- und Installationssystem SOLLTE Debugging-Informationen beibehalten, wenn sie in den entsprechenden Flags angefordert werden (z. B. "install -s" wird nicht verwendet). Wenn kein Build- oder Installationssystem vorhanden ist (z. B. typische JavaScript-Bibliotheken), wählen Sie "nicht anwendbar" (N / A). [build_preserve_debug]
    Z. B., die Festlegung von CFLAGS (C) oder CXXFLAGS (C ++) sollte die relevanten Debugging-Informationen erstellen, wenn diese Sprachen verwendet werden, und sie sollten während der Installation nicht ignoriert werden. Debugging-Informationen werden für Unterstützung und Analyse benötigt und sind auch nützlich, um das Vorhandensein von Härtungsmerkmalen in den kompilierten Binärdateien zu messen.

    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.


    Das Build-System für die Software, die durch das Projekt erzeugt wird, DARF NICHT rekursive Unterverzeichnisse aufbauen, wenn es Querverweise in den Unterverzeichnissen gibt. Wenn kein Build- oder Installationssystem vorhanden ist (z.B. typische JavaScript-Bibliotheken), wählen Sie "nicht anwendbar" (N / A). [build_non_recursive]
    Die interne Abhängigkeitsinformationen des Build-Systems des Projektes müssen präzise sein, andernfalls können Änderungen an dem Projekt nicht korrekt erfolgen. Falsche Builds können zu Defekten (einschließlich Schwachstellen) führen. Ein häufiger Fehler bei großen Build-Systemen ist die Verwendung eines "rekursiven Builds" oder "rekursiven Make", d.h. einer Hierarchie von Unterverzeichnissen, die Quelldateien enthalten, wobei jedes Unterverzeichnis unabhängig aufgebaut ist. Es sei denn, jedes Unterverzeichnis ist völlig unabhängig, was ist ein Fehler ist, da die Abhängigkeitsinformationen nicht korrekt sind.

    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.



    Das Projekt MUSS in der Lage sein, den Prozess der Generierung von Informationen aus Quelldateien zu wiederholen und genau das gleiche Bit-für-Bit-Ergebnis zu erhalten. Wenn kein Build auftritt (z. B. Skriptsprachen, in denen der Quellcode direkt verwendet wird, anstatt kompiliert zu werden), wählen Sie "nicht anwendbar" (N / A). [build_repeatable]
    GCC- und Clang-Benutzer finden die Option -frandom-seed womöglich nützlich; In manchen Fällen kann dies dadurch gelöst werden, dass man eine Sortierreihenfolge erzwingt. Weitere Vorschläge finden Sie auf der reproducible Build Seite.

    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


  • Installationssystem


    Das Projekt MUSS eine Möglichkeit zur einfachen Installation und Deinstallation der Software haben, unter Benutzung einer häufig verwendeten Methode. [installation_common]
    Beispiele hierfür sind die Verwendung eines Paketmanagers (auf dem System- oder Sprachniveaus), "make install/uninstall" (unterstützt DESTDIR), einem Container im Standardformat oder ein virtuelles Maschinenbild im Standardformat. Der Installations- und Deinstallationsvorgang (z.B. seine Verpackung) DARF von einem/einer Dritten implementiert werden, solange es FLOSS ist.

    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.



    Das Installationssystem für den/die Endbenutzer/in MUSS Standardkonventionen zur Auswahl des Zielortes, in dem gebildete Artefakte zur Installationszeit geschrieben werden, folgen. Zum Beispiel, wenn es Dateien auf einem POSIX-System installiert, muss es die DESTDIR-Umgebungsvariable verwenden. Wenn es kein Installationssystem oder keine Standardkonvention gibt, wählen Sie "nicht anwendbar" (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.



    Das Projekt MUSS einen Weg für potenzielle Entwickler bereithalten, um schnell alle erforderlich Projektergebnisse und Support-Umgebungen zu installieren, um Änderungen vornehmen zu können, einschließlich der Tests und Test-Umgebung. Dies MUSS mit einer gängigen Methode durchgeführt werden können. [installation_development_quick]
    Dies DARF mit einem generierten Container- und/oder Installationsskript(en) implementiert werden. Externe Abhängigkeiten würden typischerweise durch das Aufrufen von System- und/oder Sprachpaketmanager(n), als external_dependencies, installiert.

    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.


  • Externe gepflegte Komponenten


    Das Projekt MUSS externe Abhängigkeiten in computerlesbarer Form auflisten. (URL erforderlich) [external_dependencies]
    Dies geschieht in der Regel mit den Konventionen des Paketmanagers und / oder des Buildsystems. Dies hilft auch installation_development_quick zu erfüllen.

    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]



    Projekte MÜSSEN ihre externen Abhängigkeiten (einschließlich Bequemlichkeitskopien) überwachen oder regelmäßig überprüfen, um bekannte Schwachstellen zu erkennen und ausnutzbare Schwachstellen zu beheben oder sie als unausweichlich zu verifizieren. [dependency_monitoring]
    Dies kann mit einem Ursprungsanalysator / Abhängigkeitsüberprüfungswerkzeug / Softwarezusammensetzungsanalysator wie OWASPs Dependency-Check, Sonatypes Nexus Auditor, Synopsys' Black Duck Software Composition Analysis, und Bundler-Audit (für Ruby) erreicht werden. Einige Paketmanager beinhalten Mechanismen, um dies zu tun. Es ist akzeptabel, wenn die Anfälligkeit der Komponenten nicht ausgenutzt werden kann, aber diese Analyse ist schwierig und es ist manchmal einfacher, den Part einfach zu aktualisieren oder zu reparieren.

    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.


    Das Projekt MUSS entweder:
    1. Es einfach machen, wiederverwendbare extern gepflegte Komponenten zu identifizieren und zu aktualisieren;oder
    2. Die Standardkomponenten des Systems oder der Programmiersprache verwenden.
    Dann, wenn eine Schwachstelle in einer wiederverwendeten Komponente gefunden wird, wird es einfach sein diese Komponente zu aktualisieren. [updateable_reused_components]
    Ein typischer Weg, um dieses Kriterium zu erfüllen, ist die Verwendung von System- und Programmiersprachen-Paketverwaltungssystemen. Viele FLOSS-Programme werden mit "Convenience-Bibliotheken" ausgestattet, die lokale Kopien der Standardbibliotheken (ggf. geforkt) enthalten. Prinzipiell ist das gut. Wenn jedoch das Programm diese lokalen (geforkten) Kopien verwenden *muss*, dann wird die Aktualisierung der "Standard"-Bibliotheken, als Sicherheitsupdate, diese zusätzlichen Kopien immer noch verwundbar lassen. Dies ist vor allem ein Problem für Cloud-basierte Systeme; Wenn der Cloud-Provider seine "Standard"-Bibliotheken aktualisiert, aber das Programm sie nicht verwendt, dann helfen die Updates nicht wirklich. Siehe z.B. "Chromium: Why it isn't in Fedora yet as a proper package" von 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]



    Das Projekt SOLLTE vermeiden veraltete oder obsolete Funktionen und APIs zu verwenden, für die FLOSS-Alternativen in der eingesetzten Technologie verfügbar sind (ihr "Technologie-Stack") und eine Supermajorität der Benutzer, die das Projekt unterstützt (so dass die Benutzer den Zugriff auf die Alternative haben ). [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.


  • Automatisierte Test-Suite


    Eine automatisierte Test-Suite MUSS bei jedem Check-In auf ein gemeinsames Repository für mindestens einen Zweig angewendet werden. Diese Test-Suite muss einen Bericht über Erfolg oder Misserfolg des Testes produzieren. [automated_integration_testing]
    Diese Anforderung kann als Teilmenge von test_continuous_integration angesehen werden, konzentriert sich aber nur auf das Testen, ohne eine kontinuierliche Integration zu fordern.

    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.



    Das Projekt MUSS Regressionstests zu einer automatisierten Test-Suite hinzufügen für mindestens 50% der, in den letzten sechs Monaten, gefixten Bugs. [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.



    Das Projekt MUSS automatisierte FLOSS-Test-Suite(s) haben, die mindestens 80% Aussage Berichterstattung haben, wenn es mindestens ein FLOSS-Tool gibt, das dieses Kriterium in der ausgewählten Sprache erfüllen kann. [test_statement_coverage80]
    Viele FLOSS-Tools stehen zur Verfügung, um die Test-Coverage zu beurteilen, einschließlich gcov/lcov, Blanket.js, Istanbul, JCov, und covr (R). Beachten Sie, dass das Erfüllen dieses Kriteriums keine Garantie dafür ist, dass die Test-Suite gründlich ist, hingegen ist das Verfehlen dieses Kriteriums ein starker Indikator für eine schlechte Test-Suite.

    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.


  • Neue Funktionalitätsüberprüfung


    Das Projekt MUSS eine formale schriftliche Richtlinie dazu haben, wie wichtige neue Funktionalität hinzugefügt werden. Tests für die neue Funktionalität MÜSSEN zu einer automatisierten Test-Suite hinzugefügt werden. [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.



    Das Projekt MUSS in seinen dokumentierten Anweisungen für Änderungsvorschläge die Richtlinien enthalten, die Tests für große neue Funktionalität hinzugefügt werden sollen. [tests_documented_added]
    Allerdings ist auch eine informelle Regel akzeptabel, solange die Tests in der Praxis hinzugefügt werden.

    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.


  • Warnhinweise


    Projekte MÜSSEN praktischerweise sehr streng mit Warnungen in der Projektsoftware sein. [warnings_strict]
    Bei manchen Projekten können einige Warnungen effektiv nicht aktiviert werden. Was benötigt wird, ist ein Beleg dafür, dass das Projekt danach strebt, Warnungen zu aktivieren, wo es möglich ist, so dass Fehler frühzeitig erkannt werden.

    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

 Sicherheit 13/13 ●

  • Wissen über sichere Entwicklungspraktiken


    Das Projekt MUSS sichere Designprinzipien (von "know_secure_design"), soweit anwendbar, umsetzen. Wenn das Projekt keine Software produziert, wählen Sie "nicht anwendbar" (N/A). [implement_secure_design]
    Beispielsweise sollten die Projektergebnisse fehlersichere Vorgaben haben (Zugriffsentscheidungen sollten standardmäßig verweigert werden und die Installation von Projekten sollte standardmäßig sicher sein). Die Projektergebnisse sollten auch eine vollständige Vermittlung haben (jeder Zugang, der begrenzt werden kann, muss auf Autorität überprüft werden und nicht umgangen werden können). Beachten Sie, dass in einigen Fällen Prinzipien in Konflikt geraten, in welchen eine Entscheidung getroffen werden muss (z.B. viele Mechanismen können die Dinge komplexer machen, gegen die "Wirtschaftlichkeit des Mechanismus" verstoßen / halten Sie es einfach).

    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

  • Verwende grundlegend gute kryptographische Praktiken

    Beachten Sie, dass einige Software keine kryptographischen Mechanismen verwenden muss. Wenn Ihr Project Software erstellt das (1) kryptographische funktionen einbindet, aktiviert, oder ermöglicht und (2) aus den USA heraus an nicht US-Bürger verteilt wird, dann könnten sie rechtlich zu weiterne Schritten gezwungen sein. Meistens beinhaltet dies lediglich das Senden einer E-Mail. Für mehr Informationen, siehe den Abschnitt zu Encryption in Understanding Open Source Technology & US Export Controls.

    Die Standard-Sicherheitsmechanismen innerhalb der Projektsoftware DÜRFEN NICHT von kryptographischen Algorithmen oder Modi mit bekannten schweren Mängeln abhängen (z.B. der SHA-1-Kryptographie-Hash-Algorithmus oder der CBC-Modus in SSH). [crypto_weaknesses]
    Sorgen über den CBC-Modus in SSH werden in CERT: SSH CBC vulnerability erläutert.

    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.



    Das Projekt SOLLTE mehrere kryptographische Algorithmen unterstützen, so dass Benutzer schnell wechseln können, wenn eines defekt ist. Verbreitete symmetrische Schlüsselalgorithmen umfassen AES, Twofish und Serpent. Verbreitete kryptographische Hash-Algorithmus-Alternativen umfassen SHA-2 (einschließlich SHA-224, SHA-256, SHA-384 UND SHA-512) und 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.


    Das Projekt MUSS die Speicherung von Anmeldeinformationen (z.B. Passwörter und dynamische Token) und private kryptografische Schlüssel in Dateien, die von anderen Informationen getrennt sind (z.B. Konfigurationsdateien, Datenbanken und Protokolle), unterstützen und den Benutzern erlauben, sie ohne Code-Neukompilierung zu aktualisieren und zu ersetzen . Wenn das Projekt keine Anmeldeinformationen und private kryptographische Schlüssel verarbeitet, wählen Sie "nicht anwendbar" (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.


    Die vom Projekt produzierte Software SOLLTE sichere Protokolle für alle Netzwerkkommunikationen unterstützen , wie SSHv2 oder höher, TLS1.2 oder höher (HTTPS), IPsec, SFTP und SNMPv3. Unsichere Protokolle wie FTP, HTTP, Telnet, SSLv3 oder früher, und SSHv1 SOLLTEN standardmäßig deaktiviert werden und nur aktiviert werden, wenn der/die Benutzer/in es speziell konfiguriert. Wenn die vom Projekt produzierte Software keine Netzwerkkommunikation verwendet, wählen Sie "nicht anwendbar" (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.


    Wenn die Software, die durch das Projekt produziert wird, TLS unterstützt oder verwendet, SOLLTE sie mindestens TLS Version 1.2 verwenden. Beachten Sie, dass der Vorgänger von TLS SSL genannt wurde. Wenn die Software TLS nicht verwendet, wählen Sie "nicht anwendbar" (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 .



    Die Software, die vom Projekt produziert wird, muss, wenn es TLS unterstützt, die TLS-Zertifikatsüberprüfung standardmäßig bei der Verwendung von TLS, einschließlich auf Subresources, durchführen. Wenn die Software TLS nicht verwendet, wählen Sie "nicht anwendbar" (N/A). [crypto_certificate_verification]
    Beachten Sie, dass eine falsche TLS-Zertifikatsüberprüfung ein häufiger Fehler ist. Weitere Informationen finden Sie unter "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" von Martin Georgiev et al. und "Do you trust this application?" von 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.


    Die Software, die vom Projekt produziert wird, MUSS, wenn sie TLS unterstützt, eine Zertifikatsüberprüfung durchführen, bevor HTTP-Header mit privaten Informationen (wie z.B. sichere Cookies) versendet werden. Wenn die Software TLS nicht verwendet, wählen Sie "nicht anwendbar" (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.


  • Sicheres Release


    Das Projekt MUSS kryptographisch unterschriebene Releases der Projektergebnisse aufzeichnen, die für weit verbreitete Verwendung gedacht sind, und es MUSS ein dokumentierter Prozess sein, der den Benutzern/innen erklärt, wie sie die öffentlichen Signaturschlüssel erhalten und die Signatur(en) überprüfen können. Der private Schlüssel für diese Signatur(en) MUSS NICHT auf der Seite(n) verwendet werden, die öffentlich zugänglich sind. Wenn Releases nicht für eine weit verbreitete Verwendung bestimmt sind, wählen Sie "nicht anwendbar" (N/A). [signed_releases]
    Die Projektergebnisse umfassen sowohl Quellcode als auch alle erzeugten Ergebnisse, falls zutreffend (z. B. ausführbare Dateien, Pakete und Container). Generierte Ergebnisse können separat vom Quellcode signiert werden. Diese DÜRFEN als signierte git-Tags (mit kryptographischen digitalen Signaturen) implementiert werden. Projekte DÜRFEN generierte Ergebnisse getrennt von Werkzeugen wie git behandeln, aber in diesen Fällen MÜSSEN die separaten Ergebnisse separat unterzeichnet werden.

    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.



    Es wird empfohlen, dass in dem Versionskontrollsystem jeder wichtige Versions-Tag (ein Tag, der Teil eines Hauptrelease, eines kleineren Release, oder eines Fixes, öffentlich gemeldeten Schwachstellen, ist) kryptographisch signiert und verifizierbar ist, wie in 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.


  • Andere Sicherheitsissues


    Die Projektergebnisse MÜSSEN alle Eingaben aus potenziell nicht vertrauenswürdigen Quellen überprüfen, um sicherzustellen, dass sie gültig sind (eine *Allowliste*) und ungültige Eingaben ablehnen, wenn überhaupt Einschränkungen für die Daten vorliegen. [input_validation]
    Beachten Sie, dass der Vergleich der Eingabe mit einer Liste von "schlechten Formaten" (aka einer *Denylist*) normalerweise nicht ausreicht, weil Angreifer oft um eine Denyliste herumarbeiten können. Insbesondere werden Zahlen in interne Formate konvertiert und dann überprüft, ob sie zwischen ihrem Minimum und Maximum (inklusive) liegen und Textstrings werden überprüft, um sicherzustellen, dass sie gültige Textmuster haben (z.B. gültige UTF-8, Länge, Syntax, etc.). Einige Daten müssen möglicherweise "irgendetwas" (z. B. ein Datei-Uploader) sein, aber das ist typischerweise selten der Fall.

    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.



    Härtungsmechanismen SOLLTEN in der Software, die das Project entwickelt, verwendet werden, so dass Softwarefehler weniger wahrscheinlich zu Sicherheitslücken führen. [hardening]
    Härtungsmechanismen können HTTP-Header enthalten wie Content Security Policy (CSP), oder Compiler-Flags (z.B. -fstack-protector), um Angriffe zu mildern, oder Compiler-Flags, um undefiniertes Verhalten zu eliminieren. Für unsere Zwecke wird das Prinzip des kleinsten Privilegs nicht als Verhärtungsmechanismus betrachtet (trotzdem ist es wichtig, aber an anderer Stelle).

    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


    Das Projekt MUSS einen "Assurance Case" bereithalten, der rechtfertigt, wie die Sicherheitsanforderungen erfüllt werden. Der Assurance Case muss Folgendes beinhalten: eine Beschreibung des Bedrohungsmodells, eine eindeutige Identifizierung von Vertrauensgrenzen, eine Beschreibung wie sichere Designprinzipien angewendet wurden, und eine Beschreibung wie die üblichen Implementierungssicherheitsschwächen beseitige wurden. (URL erforderlich) [assurance_case]
    Ein "Assurance Case" ist ein dokumentierter Beweis, der ein überzeugendes und gültiges Argument enthällt, dass ein bestimmter Satz kritischer Ansprüche bezüglich der Eigenschaften eines Systems für eine gegebene Anwendung in einer gegebenen Umgebung hinreichend erfüllt ist ("Software Assurance Using Structured Assurance Case Models", Thomas Rhodes et al., NIST Interagency Report 7608 ). Vertrauensgrenzen sind Grenzen, in denen Daten oder Ausführung ihr Vertrauensniveau ändern, z.B. die Grenzen eines Servers in einer typischen Webanwendung. Es ist üblich, sichere Designprinzipien (wie Saltzer und Schroeer) und gemeinsame Implementierungssicherheitsschwächen (wie die OWASP Top 10 oder CWE/SANS Top 25) aufzurufen und zu zeigen, wie diesen entgegengewirkt wird. Die BadgeApp Assurance Case kann ein nützliches Beispiel sein. Dies bezieht sich auf documentation_security, documentation_architecture und 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.

 Analyse 2/2 ●

  • Statische Codeanalyse


    Das Projekt MUSS mindestens ein statisches Analyse-Tool mit Regeln oder Ansätzen verwenden, um nach bekannten Schwachstellen in der analysierten Sprache oder Umgebung zu suchen, wenn es mindestens ein FLOSS-Tool gibt, das dieses Kriterium in der ausgewählten Sprache implementieren kann. [static_analysis_common_vulnerabilities]
    Statische Analysetools, die speziell dafür entwickelt wurden, nach Schwachstellen zu suchen, finden diese eher. Das heißt, dass die Verwendung von statischen Tools in der Regel helfen wird einige Probleme zu finden. Wir schlagen dies vor, aber erwarten es für das "passing" -Level-Badge nicht.

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


  • Dynamische Codeanalyse


    Wenn die Projektsoftware Software mit einer speicherunsicheren Sprache (z.B. C oder C ++) enthält, MUSS mindestens ein dynamisches Werkzeug (z.B. ein Fuzzer oder ein Web-Applikationsscanner) routinemäßig in Kombination mit einem Mechanismus verwendet werden, welche Speichersicherheitsproblemen wie Puffer-Cach Überschreibe erkennen. Wenn das Projekt keine Software verwendet, die in einer speicherunsicheren Sprache geschrieben ist, wählen Sie "nicht anwendbar" (N/A). [dynamic_analysis_unsafe]
    Beispiele für Mechanismen zur Erkennung von Arbeitsspeicher Sicherheitsproblemen sind Adresse Sanitizer (ASAN) (verfügbar in GCC und LLVM), Memory Sanitizer und valgrind. Andere möglicherweise verwendete Werkzeuge sind Thread Sanitizer und Undefined Behavior Sanitizer. Weit verbreitete Assertions würden auch funktionieren.

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



Sie können Tools und KI-Systeme nutzen, um Änderungen über eine einfache URL vorzuschlagen, z. B. https://www.bestpractices.dev/de/projects/14035/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Wie das geht, erfahren Sie in unserem Automatisierungsvorschlagssystem. Diese Daten sind unter der Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0) verfügbar. Dies bedeutet, dass ein Datenempfänger die Daten mit oder ohne Änderungen weitergeben darf, solange der Datenempfänger den Text dieser Vereinbarung mit den weitergegebenen Daten zur Verfügung stellt. Bitte nennen Sie Théotime Lévêque und die OpenSSF Best Practices Badge-Mitwirkenden als Urheber.

Projekt-Badge-Eintrag im Besitz von: Théotime Lévêque.
Eintrag erstellt: 2026-08-12 12:54:41 UTC, zuletzt aktualisiert: 2026-08-19 20:35:31 UTC. Letztes erreichtes Badge: 2026-08-13 07:59:52 UTC.