chock

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 14155 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/14155/badge)](https://www.bestpractices.dev/projects/14155)
oder indem Sie Folgendes in Ihr HTML einbetten:
<a href="https://www.bestpractices.dev/projects/14155"><img src="https://www.bestpractices.dev/projects/14155/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.

    Governance-as-code for AI coding agents — write a policy once as reviewable committed files; a compiler emits enforcement per agent (pre-tool-use hooks, git hooks, CI gate, instruction files) with an honest per-agent coverage report.

    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/open-coder-ai/chock/blob/main/CONTRIBUTING.md — documents the requirements for acceptable contributions: DCO sign-off on every commit (enforced by a CI check), ruff for code style and formatting (enforced in CI and by the repo's own commit hooks), tests expected for behavior changes, and PR-only changes to main with required status checks.


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

    All contributions require a Developer Certificate of Origin sign-off: every commit must carry a Signed-off-by line, enforced automatically by a required dco status check that blocks merging, and documented in CONTRIBUTING.md with a link to developercertificate.org.
    https://github.com/open-coder-ai/chock/blob/main/CONTRIBUTING.md



    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.

    Governance is documented in GOVERNANCE.md: the decision-making model (solo-maintainer with final say, bound in practice to the project's published invariants rather than taste), key roles and their responsibilities (maintainer, contributors, security reporters), how disagreements are handled (issues/Discussions, decisions explained), and how the document itself changes (by pull request, material changes noted in release notes).
    https://github.com/open-coder-ai/chock/blob/main/GOVERNANCE.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.

    The project has adopted a code of conduct (Contributor Covenant), posted at the standard location CODE_OF_CONDUCT.md in the repository root, where GitHub surfaces it in the community profile and the new-issue/PR flows.
    https://github.com/open-coder-ai/chock/blob/main/CODE_OF_CONDUCT.md



    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.

    GOVERNANCE.md ("Roles and responsibilities") defines each role and its tasks: the maintainer (reviews and merges PRs, triages issues, cuts releases, holds the security-report inbox, approves policy-catalog additions, reviews every weekly threat-intel digest before merge), contributors (via pull request, with the requirements in CONTRIBUTING.md), and security reporters (per SECURITY.md). Who holds each role is explicit: the maintainer is named (@open-coder-ai), and the document states that any future grant of triage/commit rights will be recorded there.
    https://github.com/open-coder-ai/chock/blob/main/GOVERNANCE.md



    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]

    Documented in GOVERNANCE.md ("Access continuity"). The repositories live under the open-coder-ai GitHub organization rather than a personal account, so access can be extended or transferred without rewriting history or URLs. Publishing uses PyPI Trusted Publishing (OIDC) scoped to the repository's release workflow — there are no long-lived personal tokens, so a successor with repository access immediately inherits the ability to release. Everything needed to maintain the project (build, tests, release workflow, policy sources, documentation) is in the repository itself; there is no private infrastructure, no separate DNS, and no keys held only by one person. Independently of any credential transfer, the Apache-2.0 license makes forking a legitimate continuity path: any user can fork, build, and continue the project within a week using only public material.

    https://github.com/open-coder-ai/chock/blob/main/GOVERNANCE.md



    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.

    The project is currently maintained by one person, stated plainly rather than padded with nominal co-maintainers who do not actually review or release. What the criterion protects against — the project becoming unrecoverable if that person stops — is addressed structurally, and the recovery path needs no cooperation from the current maintainer:

    Repositories are owned by the open-coder-ai GitHub organization, not a personal account, so ownership can be transferred or extended without rewriting history or URLs. Publishing to PyPI uses Trusted Publishing (OIDC) scoped to the repository's release workflow, so the ability to release travels with repository access rather than with a person holding a token; there is no credential to recover from anyone. Everything required to build, test, validate, and release is committed in the repository — there is no private infrastructure, no separately-held DNS, and no unpublished process. Under Apache-2.0, any user can fork the project today and cut a working release from public material alone.

    GOVERNANCE.md documents both halves of the succession commitment: sustained, high-quality contributors may be offered triage or commit rights (recorded there when it first happens), and if the project is visibly unmaintained for six months and someone credible wants to continue it, the maintainer's stated intent is to add maintainers or transfer stewardship rather than let it rot.

    The project will not appoint a second maintainer solely to satisfy this criterion; the role will be offered when a contributor has earned it, at which point this criterion becomes genuinely met rather than nominally so.
    https://github.com/open-coder-ai/chock/blob/main/GOVERNANCE.md


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

    docs/roadmap.md is the narrative roadmap: planned enforcement surfaces (MCP-gateway with its scope stated precisely, additional pre-tool-use adapters, human-approval flows), evidence work (tamper-evident gate log, Sigstore-signed catalog policies), each linked to a roadmap-labeled issue carrying rationale and acceptance criteria. It also explicitly documents what the project will NOT do — no policy language (a deliberate scope limit keeping the honesty guarantee tractable) and no hosted service (the project is repo-local by design). Direction is fed by the weekly threat-intel digests, reviewed before merge.
    https://github.com/open-coder-ai/chock/blob/main/docs/roadmap.md



    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.

    Architecture is documented across three linked documents: docs/concepts.md (the high-level design — policies as versioned manifests, the compile step, artifact types, the coverage-honesty model), docs/enforcement-surfaces.md (the surface architecture: how one policy compiles to pre-tool-use guards, git hooks, the CI gate, and ambient rules, with the per-agent capability matrix), and spec/ (the normative layer: policy spec, gate DSL, enforcement matrix). An automated docs-accuracy test suite keeps these consistent with the code.
    https://github.com/open-coder-ai/chock/blob/main/docs/concepts.md



    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.

    Security expectations and limits are documented in two places. docs/assurance-case.md states the security requirements, the threat model (six threat classes), the mechanism meeting each requirement with its test evidence, and — critically — the residual risks users must not assume away: catalog installs are trust-on-first-use (hash-pinned, not signed), git hooks are bypassable outside gated agents (the CI gate is the opt-in backstop), and guards are best-effort filters rather than a security boundary. SECURITY.md adds the operational half: supported versions, the private-advisory reporting process with response timelines, release verification, and the same runtime limits stated for adopters. The project's coverage report enforces this honesty per policy and per agent: enforced is claimed only where an installed mechanism is witnessed.
    https://github.com/open-coder-ai/chock/blob/main/docs/assurance-case.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.

    The README opens with a quick start (pip install chock, chock init, chock sync, first blocked commit), and a dedicated companion repository — chock-quickstart — walks a new user from a cold clone to a working governed repo, verified end-to-end against the published PyPI package and the live policy catalog (including seeing a policy actually block a commit).
    https://github.com/open-coder-ai/chock-quickstart



    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

    Documentation consistency is machine-enforced, not best-effort: an automated docs-accuracy test suite runs in CI on every change and fails the build when documentation disagrees with the code — it checks that every documented CLI command exists (and none that were removed are still described), that documented artifact types match the manifest schema, that documented gate kinds match the implementation, and that referenced repository paths exist. Documentation inconsistencies found by these tests are fixed in the same PR that would have introduced them.
    https://github.com/open-coder-ai/chock/blob/main/tests/test_docs_accuracy.py



    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.

    The repository front page (README) displays and hyperlinks the project's achievements as badges at the top: the OpenSSF Best Practices badge (added the same day the Passing level was attained), the OpenSSF Scorecard score, and the PyPI release badge. New achievements are added to the README as part of the same-day workflow that attains them.
    https://github.com/open-coder-ai/chock/blob/main/README.md


  • 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 software is a text-only command-line tool: all output is plain text consumable by screen readers, information is never conveyed by color alone (gate failures are stated in words with explicit exit codes), and no GUI is produced. Project participation happens through GitHub issues, PRs, and markdown documentation, which follow standard accessible-markdown structure (headings, link text, fenced code blocks).
    https://github.com/open-coder-ai/chock



    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.

    Unmet: the CLI's messages and documentation are English-only and not internationalized. Localization is deliberately out of scope for now: the tool's primary consumers include AI coding agents (which parse the English rule text), and much of the user-visible text is adopter-authored policy content the project does not control. If adopter demand for localization emerges it would be tracked on the public roadmap.


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

    N/A: the project's sites are GitHub (repository, issues, releases) and PyPI (downloads); the project itself stores no passwords and runs no authentication service.


 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]

    The latest release line (0.1.x) is the supported version, stated in SECURITY.md's supported-versions table. The upgrade path is documented and deliberately predictable: CHANGELOG.md describes every release's changes, and the project's versioning contract makes upgrades safe to reason about — PATCH releases never change compiled output (enforced mechanically by a golden-file test suite), and MINOR releases document what changed. Upgrading is pip install --upgrade chock followed by chock sync, which recompiles the repo's artifacts deterministically.
    https://github.com/open-coder-ai/chock/blob/main/CHANGELOG.md


 Berichterstattung 3/3

  • Bug-Report-Prozess


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

    GitHub Issues on the repository (https://github.com/open-coder-ai/chock/issues), with issue templates, labels (good first issue, roadmap; the catalog repo adds policy wanted), and all current issues triaged.


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

    N/A: no vulnerability reports have been received or resolved in the last 12 months (the project's first public release was August 2026). The policy is already in place for when one arrives: SECURITY.md commits to crediting reporters unless they request otherwise.
    https://github.com/open-coder-ai/chock/blob/main/SECURITY.md



    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.

    SECURITY.md documents the full response process: reports come through GitHub private security advisories (with an explicit instruction not to open public issues for exploitable findings), what a report should include, acknowledgment within 7 days and initial assessment within 14 days, fixes shipped in a patch release, reporter credit unless anonymity is requested, and a new enforcement-matrix invariant (SEC-* entry) when the fix requires one.
    https://github.com/open-coder-ai/chock/blob/main/SECURITY.md


 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 .

    Python is the sole implementation language. The coding style is defined by the Ruff configuration committed in pyproject.toml (lint ruleset + formatter, line length, target Python version), supplemented by the repository's coding rules in AGENTS.md. CONTRIBUTING.md requires contributions to pass these checks, and CI enforces them on every pull request.
    https://github.com/open-coder-ai/chock/blob/main/pyproject.toml



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

    Enforced automatically by Ruff (FLOSS): ruff check and ruff format --check run in CI on every pull request as part of the required validate jobs, and locally in the repository's own pre-commit conformance gate — a style violation fails the build rather than relying on reviewer attention.
    https://github.com/open-coder-ai/chock/blob/main/.github/workflows/ci.yml


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

    N/A: the project is pure Python and generates no native binaries; there is no compiler or linker invocation in the build.



    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.

    N/A: pure Python — there is no compilation step that could strip debugging information; installed files are the source files themselves, and Python tracebacks retain full source context.



    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.

    The project builds as a single Python package via the standard PEP 517 build backend (python -m build); there is no recursive sub-directory build, so no cross-dependency ordering problem can arise.



    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.

    N/A: Python is used directly from source rather than compiled — the distribution is a pure-Python wheel containing the source files, with no build-time code generation. (Separately, the artifacts the tool itself generates into adopter repositories are deterministic and byte-identical across platforms and reruns, enforced by a golden-file test suite in CI, but that is the software's runtime behavior rather than a build step.)


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

    Installation and uninstallation follow the standard Python packaging convention: pip install chock and pip uninstall chock. The package is published on PyPI, works in any virtualenv, and is also runnable without installation via pipx run chock. Uninstalling removes the tool cleanly; artifacts the tool wrote into an adopter's repository are ordinary committed files under the adopter's control.



    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]

    Installation is delegated entirely to pip, which honors the standard Python installation conventions: virtual environments (VIRTUAL_ENV), --prefix, --root (the DESTDIR equivalent for Python packaging), --target, --user, and PIP_* environment variables. The project defines no custom installer and overrides none of these locations.



    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.

    CONTRIBUTING.md opens with a numbered quick-setup block using standard Python conventions: clone, then pip install -e '.[dev]' (editable install with the dev extra, which brings in the full test and lint environment), followed by an explicit verification sequence the contributor runs to confirm the environment works — pytest -q, ruff check ., ruff format --check ., and the project's own conformance checks. No custom tooling or bespoke bootstrap script is required.
    https://github.com/open-coder-ai/chock/blob/main/CONTRIBUTING.md


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

    Runtime and development dependencies are declared in pyproject.toml in the standard PEP 621 computer-processable form (project.dependencies and project.optional-dependencies). CI and build dependencies are additionally pinned in compiled requirements files under requirements/ (generated by pip-compile), each carrying exact versions and sha256 hashes and installed with --require-hashes.
    https://github.com/open-coder-ai/chock/blob/main/pyproject.toml



    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.

    Dependabot is enabled on the repository for both security alerts and version updates (grouped into a single weekly PR to keep the update stream reviewable), so newly disclosed vulnerabilities in external dependencies surface automatically and are fixed by merging the update. GitHub secret scanning and CodeQL run alongside it. The project vendors no convenience copies of third-party code — every external dependency arrives via pip from the declared manifests — and CI installs are hash-pinned with --require-hashes, so a tampered or substituted dependency fails the build closed rather than installing silently.
    https://github.com/open-coder-ai/chock/blob/main/.github/dependabot.yml



    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 .

    Both apply. The project uses the standard Python library wherever possible — notably, the vendored pre-tool-use adapter and gate runner that Chock writes into adopter repositories are stdlib-only by contract, so they carry no third-party surface at all. The remaining externally-maintained components are ordinary pip dependencies declared in pyproject.toml (and hash-pinned in requirements/ for CI), so identifying one is reading a single manifest and updating it is a version bump — which Dependabot proposes automatically.
    https://github.com/open-coder-ai/chock/blob/main/pyproject.toml



    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]

    The project targets Python 3.11+ and uses current standard-library APIs (e.g. pathlib, tomllib, importlib.resources, datetime with explicit timezones) rather than their deprecated predecessors. Deprecation warnings are treated as defects rather than noise: the test suite surfaces them and Ruff's lint ruleset flags outdated constructs in CI, so a deprecated call fails review rather than accumulating.


  • 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 full automated test suite (712 tests) runs in GitHub Actions on every push and every pull request to main, across Python 3.11 and 3.12, alongside an acceptance tier, a packaged-binary check, lint/format checks, and CodeQL. Results are reported as GitHub status checks on the commit and PR, and the core jobs are required checks under branch protection — a failing suite blocks the merge rather than merely reporting
    https://github.com/open-coder-ai/chock/blob/main/.github/workflows/ci.yml



    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]

    The project's practice is 100%, not 50%: every bug fix ships with a regression test in the same pull request, and CONTRIBUTING.md requires it. Recent examples each landed with a dedicated test module — the gate-runner bypass fixes (tests/test_gate_bypasses.py), manifest-id validation (tests/test_manifest_id_safety.py), coverage-honesty overclaims (tests/test_coverage_honesty*.py), Windows line-ending defects (tests/test_windows_line_endings.py), adopter-data-loss fixes (tests/test_adopter_safety.py), and the policy-id trailing-newline fix found by the property suite (tests/test_properties.py).
    https://github.com/open-coder-ai/chock/tree/main/tests



    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.

    Measured with coverage.py (FLOSS): 81% statement coverage across 712 tests. The measured figure understates actual coverage, because a substantial share of the CLI and hook code paths execute in subprocesses during the acceptance tier — coverage.py cannot attribute those lines to the parent run — and the installed hooks execute vendored copies of the source rather than the source files themselves. The test suite itself is FLOSS (pytest + Hypothesis), and coverage is reproducible locally with pytest --cov.


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

    CONTRIBUTING.md states the policy in writing: behavior changes require tests in the same pull request, and the project's review standards name the test suite as non-negotiable for new functionality. It is enforced rather than aspirational — CI runs the full suite plus an acceptance tier on every pull request as required status checks, and the repository's own committed policies (agent-discipline) additionally block weakening or deleting assertions to make a change pass.
    https://github.com/open-coder-ai/chock/blob/main/CONTRIBUTING.md



    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.

    Documented in CONTRIBUTING.md, the instructions contributors are pointed at for change proposals: tests are expected for behavior changes, and required CI must pass before merge.


  • 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 linters run at strict settings repo-wide with no ignore-baseline; the one deliberately pinned choice (ruff minor version) exists to keep formatting deterministic in CI, not to relax rules. Beyond linting, the project holds itself to stricter-than-typical machine-enforced contracts: byte-identical compiled outputs across PATCH releases (golden suite) and a documented line-budget/style check on its own sources.


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

    he design applies the standard principles where they bear on a repo-local governance tool. Least privilege: workflow tokens are read-only by default with write scopes granted per-job, and the tool requests no credentials of its own. Fail-safe defaults: gates fail closed — an unresolvable CI base ref exits non-zero rather than passing, the hook installer bakes an absolute interpreter path (a missing interpreter previously meant exit 127, which a host reads as "allow"), and empty or uninstalled surfaces claim nothing. Complete mediation: the CI gate re-checks the same compiled gates server-side, where local hook bypasses cannot reach. Input validation by allowlist: policy ids, manifests, agent selections, URL schemes, and catalog paths are all validated against fixed patterns or schemas. Economy of mechanism: one compiled gate definition drives every surface, so there is a single place to reason about behavior. Untrusted-input separation: repository and web content processed by the tool is treated as data, never as instructions. No dynamic code execution (eval/exec) exists anywhere in the codebase. The full argument, with the test suite proving each mechanism, is in docs/assurance-case.md.
    https://github.com/open-coder-ai/chock/blob/main/docs/assurance-case.md


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

    No weakened algorithms either: SHA-256 only — no SHA-1, no CBC or any cipher modes (nothing is encrypted), no legacy fallbacks.



    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]

    Unmet, deliberately. The project's only cryptographic primitive is SHA-256, used for integrity hashing in the lockfile and artifact verification; it performs no encryption and stores no secrets. Algorithm agility in an integrity format is a net negative here: supporting multiple hash algorithms introduces algorithm-confusion and downgrade risk in exactly the check that is supposed to be unambiguous. If SHA-256 ever needed replacing, it would be a versioned change to the lockfile format with an explicit migration, not a runtime-selectable option. Release signing is handled by Sigstore, whose own algorithm agility the project inherits.



    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]

    N/A: the software never processes authentication credentials or private cryptographic keys. It runs locally against a repository, and its one network path is an unauthenticated HTTPS document fetch. Publishing to PyPI uses OIDC Trusted Publishing, so the release pipeline holds no stored token or key either.



    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]

    The software's network surface is minimal and HTTPS-only. The one fetch path enforces the scheme explicitly — a URL that is not https:// is refused with a warning and returns empty rather than falling back, so http://, file://, and custom schemes cannot be used even if a future caller passed one. Catalog installs use git clone over HTTPS (or the user's own SSH configuration). There is no insecure-protocol option to disable, because none is implemented.



    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]

    TLS is used through Python's standard library (urllib over the ssl module) with default settings on Python 3.11+, where the minimum protocol version is TLS 1.2 and older SSL/TLS versions are disabled. The project does not lower or override these defaults.



    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.

    Certificate verification is on by default and never disabled: the fetch path uses Python's standard urllib.request.urlopen with the default SSL context, which verifies the server certificate and hostname against the system trust store. The codebase contains no unverified context (ssl._create_unverified_context), no verify=False equivalent, and no certificate-check bypass flag for users to enable.



    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]

    Met, and vacuously safe: certificate verification is performed by the standard library as part of establishing the connection, before any request headers are sent. The software additionally sends no private information at all over its network path — the fetch is an unauthenticated GET of a public documentation page, with no cookies, credentials, or authorization headers.


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

    Every release is cryptographically signed via Sigstore: the tag-triggered release workflow generates a build-provenance attestation for each distribution artifact, binding the artifact's digest to the exact source commit and workflow that produced it. Signing uses Sigstore's keyless flow with short-lived certificates issued against the workflow's OIDC identity, so there is no long-lived private signing key at all — and therefore none stored on PyPI or any distribution site. Publishing itself uses PyPI Trusted Publishing (OIDC), so no static credential exists in the pipeline either.

    The verification process is documented in SECURITY.md under "Verifying a release", pinned to the signing workflow and the version tag rather than to the repository alone:

    gh attestation verify chock-0.1.1-py3-none-any.whl --repo open-coder-ai/chock --signer-workflow open-coder-ai/chock/.github/workflows/release.yml --source-ref refs/tags/v0.1.1

    Trust roots come from Sigstore's public transparency log, so users need no project-specific key distribution. This command was verified against the published v0.1.1 wheel.
    https://github.com/open-coder-ai/chock/blob/main/SECURITY.md



    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]

    Unmet: version tags are not GPG-signed. Release integrity is instead provided by Sigstore build-provenance attestations on the distributed artifacts, which bind each artifact to the exact source commit, tag ref, and workflow that produced it — verifiable with a documented command and no project-specific key distribution. Tags are additionally protected by branch/tag rules and can only be pushed by the maintainer. GPG-signing tags as well is a reasonable future addition, but it would duplicate a guarantee the attestation already provides in a form users can verify more easily.


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

    All untrusted inputs are validated against allowlists and rejected on mismatch, never sanitized into something "close enough" — a rewritten value would silently disagree with the identifier every other artifact is keyed by. Specifically: policy ids are checked with an anchored fullmatch against a fixed character pattern with a length bound, and must equal their folder name; manifests are validated against committed JSON Schemas; agent selections are checked against a fixed set of known agents; URLs must begin with https:// or the fetch is refused; catalog paths and artifact ids are confined to a single path component within the catalog root, blocking traversal; and content processed from repositories and the web is treated as data, never as instructions. These parsers are covered by property-based tests and weekly coverage-guided fuzzing — which is how a trailing-newline acceptance bug in the id validator was found and fixed in 0.1.1.
    https://github.com/open-coder-ai/chock/blob/main/docs/assurance-case.md



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

    Hardening is applied both to the project's own supply chain and to the artifacts it produces. Supply chain: every GitHub Action is pinned to an immutable commit SHA, workflow tokens default to read-only with write scopes granted per job, pip installs use compiled requirements with --require-hashes so substituted content fails closed, publishing uses OIDC with no stored credentials, and all repositories are under branch-protection rulesets requiring passing checks. Produced artifacts: generated hooks and guards are stdlib-only with no third-party imports, no eval/exec exists in the codebase, subprocess calls avoid shell interpretation and use explicit argument lists, hook commands are written with absolute interpreter paths so a missing interpreter is a hard failure rather than a silent allow, and hooks run under a timeout. Static analysis (CodeQL plus Ruff's security rules) runs on every pull request with findings triaged to zero.



    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.

    The assurance case is published at docs/assurance-case.md. It contains all four required elements as named sections:

    Threat model — six threat classes with their adversaries: agent misbehavior in-session (destructive commands, guardrail tampering, secret commits), malicious or compromised catalog content (policy folders ship executable guard scripts), tampering with installed artifacts, gate bypass by construction (renames, merge commits, non-ASCII paths, unresolvable CI ranges, missing interpreters), overclaim — the project reporting enforcement no installed mechanism provides — and supply-chain compromise of the project itself.

    Trust boundaries — four, identified explicitly: the adopter repository (trusted, versioned), the agent session (untrusted executor that may ignore or attempt to modify guidance), the catalog (semi-trusted remote shipping executable content, trust-on-first-use with hash pinning), and CI (the enforcement floor a local actor cannot bypass).

    Secure design principles applied — least privilege, fail-safe defaults, complete mediation, economy of mechanism, separation of data from instructions, and open design, each tied to the concrete decision implementing it in this codebase.

    Common implementation weaknesses countered — a table mapping CWE classes (command/argument injection, path traversal, improper input validation, insecure transport, improper handling of exceptional conditions, prompt injection, hardcoded credentials) to the counter and the test suite or gate that evidences it, plus CodeQL and Ruff security rules on every pull request.

    The document also states residual risks plainly rather than claiming completeness: no catalog signing (hash pinning gives detection, not prevention), git hooks bypassable outside gated agents, guards are best-effort filters rather than a security boundary, and fail-open agent hosts.
    https://github.com/open-coder-ai/chock/blob/main/docs/assurance-case.md


 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.

    CodeQL runs with its security query packs for Python — the queries specifically target common vulnerability classes (injection, path traversal, clear-text logging of sensitive data, uninitialized use). They have produced real findings here that were fixed (e.g., statically-unprovable parser exits, a dead re-export), not just noise.


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

    N/A: the project is written entirely in Python, a memory-safe language, with no C/C++ extension modules. (Beyond what this criterion requires, the project does run coverage-guided fuzzing with atheris weekly against its id-validation and agent-selection parsers.)



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 Open Coder AI und die OpenSSF Best Practices Badge-Mitwirkenden als Urheber.

Projekt-Badge-Eintrag im Besitz von: Open Coder AI.
Eintrag erstellt: 2026-08-19 13:59:52 UTC, zuletzt aktualisiert: 2026-08-21 02:29:59 UTC. Letztes erreichtes Badge: 2026-08-19 14:49:16 UTC.