hcaptcha-rs

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

  • Allgemein

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

    hcaptcha-rs is a library to verify hcaptcha responses.

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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#developer-certificate-of-origin-dco
    GitHub DCO app enabled and required via branch protection; CONTRIBUTING documents -s sign-off; recent PR rebased with sign-offs verified by CI.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md
    CONTRIBUTING.md documents project governance including contribution process, PR requirements, code review by maintainer @jerusdp, and decision-making process



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CODE_OF_CONDUCT.md
    Project uses Contributor Covenant Code of Conduct v2.0, referenced in CONTRIBUTING.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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/GOVERNANCE.md
    Governance documented with roles (maintainers/reviewers), decision-making (lazy consensus), monthly scheduled release cadence (28th via CI), and continuity (repo/crates.io/CI access). CODEOWNERS references shared ownership.



    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]


    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.

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

    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.

    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md#security-expectations-and-scope
    Defines scope (server-side token verification), trust boundaries, safe configuration (TLS backend, timeouts, no secret logging), and notes on dynamic analysis.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/README.md#quick-start
    Minimal, compilable example shows how to verify a token; uses current API (Client::verify).



    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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    CI runs doctests (cargo +stable test -p hcaptcha --doc) on every validation pipeline; failing snippets are blocked by CI.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/README.md
    README displays the OpenSSF Best Practices Passing badge (linked), making achievements


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

    This is a backend library providing API verification functionality without user interface components



    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.

    Library generates no end-user text. Error messages are intended for developers and are in English per standard practice.


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md#security-expectations-and-scope
    This is a Rust library and does not operate any website or service that stores or processes user passwords. Project pages and the repository are hosted on GitHub/crates.io; authentication and password policies for those platforms are out of scope for this project.


 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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/README.md#installation
    The library is distributed on crates.io and uses semantic versioning; users update via Cargo (e.g., bump version or run cargo update). The project maintains regular releases (documented in GOVERNANCE.md “Releases”), and the crates.io/README badges make current versions visible.
    Release process: https://github.com/jerus-org/hcaptcha-rs/blob/main/GOVERNANCE.md#releases
    Crate page: https://crates.io/crates/hcaptcha


 Berichterstattung 3/3

  • Bug-Report-Prozess


    Das Projekt MUSS ein Issue-Tracking-System zur Verwaltung einzelner Issues verwenden. [report_tracker]
  • 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 reported in the last 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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md#vulnerability-response-process
    SECURITY.md documents acknowledgement window, triage/CVE via GitHub Security Advisories, remediation, timelines (30/90 days), disclosure, and reporter credit.


 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 .

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#coding-standards
    CONTRIBUTING explicitly defines standards and CI enforces fmt/clippy/tests/doctests with DCO.



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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#coding-standards
    Coding standards are enforced by CI. The CircleCI “validation” workflow runs:
    ◦ toolkit/idiomatic_rust (fmt + clippy; build fails on formatting or lint errors),
    ◦ common tests across workspace crates,
    ◦ test_doc_build and doc_tests to compile documentation examples as doctests.


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#build-flags-and-environment
    Project builds with Cargo; standard env vars (RUSTFLAGS, RUSTDOCFLAGS, CC, CFLAGS) are honored; no custom wrappers/recursive builds.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#build-flags-and-environment
    CI does not strip debug information; standard dev/release profiles respected unless users override.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#coding-standards
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    The project uses Cargo workspaces; builds and tests are invoked with cargo (e.g., cargo build/test) and not via recursive per‑directory build scripts. CONTRIBUTING explicitly states the build “does not rely on recursive cross‑directory builds,” and CI runs cargo jobs directly in a single top‑level workflow.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#coding-standards
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/Cargo.lock
    Builds are repeatable from a clean checkout with Cargo. Dependencies are pinned via Cargo.lock (checked into VCS). CI runs in fixed container images with a pinned Rust toolchain (MSRV 1.88; jobs use +stable), ensuring a consistent environment. The CONTRIBUTING guide documents the exact commands (cargo build/test), and CI executes the same commands, producing consistent results across runs.


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/README.md#installation
    https://crates.io/crates/hcaptcha
    Installation uses the standard Rust package manager (Cargo). Users add hcaptcha to Cargo.toml and build with cargo on common platforms (Linux/macOS/Windows) using the stable toolchain (MSRV 1.88). No custom installers or platform-specific steps are required; CI validates builds with the same commands.



    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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#build-flags-and-environment
    This project is a Rust library/binary installed via Cargo; there is no custom “make install” or installer that would use POSIX variables like DESTDIR or PREFIX. Cargo handles installation and honors standard Rust toolchain variables (e.g., RUSTFLAGS), so DESTDIR/PREFIX are not applicable.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#setting-up-your-development-environment
    https://github.com/jerus-org/hcaptcha-rs/blob/main/README.md#quick-start
    The project provides a short, copy‑pasteable developer setup: clone, cargo build, cargo test. No custom tooling is required beyond the standard Rust toolchain (MSRV 1.88). README includes a minimal “Quick start” code example; CI verifies doctests so the example stays current.


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/Cargo.toml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/README.md#feature-flags
    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#prerequisites
    All external dependencies are declared in Cargo.toml and resolved by Cargo. With the default rustls-backend feature, no system libraries are required beyond the standard Rust toolchain (MSRV 1.88). Optional nativetls-backend may require platform TLS libraries (e.g., OpenSSL/Schannel/SecureTransport) per the target OS; this is documented under “Feature Flags.” CI builds with the default configuration to verify dependency resolution.



    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.


    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 .

    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/Cargo.toml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/Cargo.lock
    https://github.com/jerus-org/hcaptcha-rs/blob/main/renovate.json
    All reused components (dependencies) are sourced from crates.io and declared in Cargo.toml with SemVer; they can be updated via Cargo (e.g., cargo update or version bumps). Dependencies are pinned in Cargo.lock for repeatable builds, and Renovate is configured to automatically propose updates in PRs. CI builds and tests every update PR, ensuring components remain updateable and verified.



    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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/README.md#quick-start
    https://docs.rs/hcaptcha
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    Public interfaces are documented in README and on docs.rs. CI compiles doctest examples (doc_tests) to ensure code snippets track the current API. Breaking changes follow semver; examples and docs were recently updated to use the non-deprecated Client::verify 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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    https://github.com/jerus-org/hcaptcha-rs/tree/main/test-suite-default
    https://github.com/jerus-org/hcaptcha-rs/tree/main/test-suite-enterprise
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/client.rs
    Integration tests run automatically in CI on every PR/commit. The CircleCI validation workflow executes cargo tests across workspace crates via a matrix of suites (e.g., test-suite-default, test-suite-enterprise, rustls/native/no-default variants), runs doctests, and executes CLI binary smoke tests. Network interactions are mocked (wiremock) in async integration tests (see hcaptcha/src/client.rs), ensuring end-to-end behavior is verified without external services.



    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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#test-policy
    https://github.com/jerus-org/hcaptcha-rs/tree/main/test-suite-default
    https://github.com/jerus-org/hcaptcha-rs/tree/main/test-suite-enterprise
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/client.rs
    The contribution policy requires adding tests when fixing bugs or adding features. CI blocks merges unless tests pass across the workspace (including doctests). Recent fixes routinely include or update tests in the integration suites and client module tests, so at least 50% of bug fixes have accompanying regression 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.

    https://codecov.io/gh/jerus-org/hcaptcha-rs
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    The CircleCI code_coverage job uploads coverage to Codecov. As of 2025‑12‑13, Codecov reports ≥80% statement coverage on the main branch for the core crate(s). Coverage is enforced via CI and tracked with a README badge.


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md
    CONTRIBUTING.md section "Testing" → "Test Policy" mandates that major new functionality must be accompanied by automated tests of that functionality. The policy ensures new features are validated, regressions are detected, and code quality is maintained. CI enforces the policy by requiring all test suites to pass green before merge.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#test-policy
    Explicit policy documented that major new functionality must include tests in the automated test suite


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/lib.rs
    The project treats compiler and documentation warnings strictly. The idiomatic_rust CI job (line 173–177 of .circleci/config.yml) runs cargo clippy across all targets and features, failing the build on warnings (controlled by lint_flags: "-A deprecated" to allow only deprecated warnings). Library code declares #![warn(missing_docs)] and #![warn(rustdoc::invalid_codeblock_attributes)] at the crate root (hcaptcha/src/lib.rs lines 2, 4), turning missing doc and invalid doc attribute issues into warnings. CONTRIBUTING.md mandates clippy-clean code (no warnings) and that CI must be green before merge.


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md
    SECURITY.md section "Security expectations and scope" documents secure design principles: trust boundaries (untrusted client inputs, HTTPS API calls), configuration guidance (prefer rustls default, set HTTP timeouts, no secret logging), and weekly dynamic analysis (Miri for memory safety, libFuzzer for parser fuzzing). CONTRIBUTING.md "Coding Standards" mandates library code must not panic on valid inputs, prefer Result with meaningful errors, disallow unsafe Rust except when justified and tested, and dependency updates via Renovate. These practices ensure the design addresses security from the start.


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

    URL: https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    SECURITY.md section "Cryptography note" explicitly states: "This project does not implement cryptographic primitives or protocols. TLS and certificate validation are delegated to well-vetted dependencies (reqwest/rustls or native-tls). As such, cryptography-specific criteria on bestpractices.dev are Not Applicable for this project." The library does not contain custom cryptographic code; all cryptographic operations are handled by established, audited 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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    SECURITY.md section "Cryptography note" explicitly states: "This project does not implement cryptographic primitives or protocols. TLS and certificate validation are delegated to well-vetted dependencies (reqwest/rustls or native-tls). As such, cryptography-specific criteria on bestpractices.dev are Not Applicable for this project." Since the project does not implement cryptographic algorithms, algorithm agility does not apply.



    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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    SECURITY.md section "Cryptography note" explicitly states: "This project does not implement cryptographic primitives or protocols. TLS and certificate validation are delegated to well-vetted dependencies (reqwest/rustls or native-tls). As such, cryptography-specific criteria on bestpractices.dev are Not Applicable for this project." Since the project does not implement cryptographic credential management, credential agility does not apply.



    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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    SECURITY.md section "Security expectations and scope" documents that "network calls target hCaptcha servers over HTTPS via reqwest" and section "Cryptography note" states "TLS and certificate validation are delegated to well-vetted dependencies (reqwest/rustls or native-tls)." All network communication to the hCaptcha API uses HTTPS with TLS provided by industry-standard libraries (rustls by default, or native-tls as an option), ensuring cryptographic protection of network traffic.



    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]

    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/Cargo.toml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/Cargo.toml
    The project uses reqwest 0.12.24 with rustls-tls (default) or native-tls backends for HTTPS. Workspace Cargo.toml specifies reqwest with http2 feature enabled (line 48), ensuring HTTP/2 support. Both rustls (current versions support TLS 1.2 and 1.3) and native-tls delegate to platform TLS libraries that support TLS 1.2+. The library does not configure minimum TLS versions below 1.2, relying on secure defaults from reqwest and its TLS dependencies.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    SECURITY.md section "Cryptography note" states "TLS and certificate validation are delegated to well-vetted dependencies (reqwest/rustls or native-tls)." The codebase does not disable certificate verification (no use of danger_accept_invalid_certs or similar options). Both rustls and native-tls perform full certificate validation by default, including chain verification and hostname checks. All HTTPS connections to the hCaptcha API benefit from these secure defaults.



    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]

    • Status: N/A
    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    SECURITY.md section "Cryptography note" explicitly states: "This project does not implement cryptographic primitives or protocols. TLS and certificate validation are delegated to well-vetted dependencies (reqwest/rustls or native-tls). As such, cryptography-specific criteria on bestpractices.dev are Not Applicable for this project." Since the project does not implement cryptographic credential management, credential agility does not apply.


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

    https://github.com/jerus-org/hcaptcha-rs/tags
    https://github.com/jerus-org/hcaptcha-rs/releases/tag/hcaptcha-v3.1.0
    Release tags are GPG‑signed. For example, hcaptcha-v3.1.0, hcaptcha-cli-v3.1.0, and hcaptcha-wasm-v3.1.0 verify with “Good signature” using ED25519 key 5A0E5A078D8A661AACC7CB5AEB85EDFF0BCB42F8 (Jerus Bot). Older historical tags (e.g., 0.2.0) were unsigned; all current releases are signed.



    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]

    https://github.com/jerus-org/hcaptcha-rs/tags
    https://github.com/jerus-org/hcaptcha-rs/releases/tag/hcaptcha-v3.1.0
    Version tags are GPG‑signed. Recent tags such as hcaptcha-v3.1.0, hcaptcha-cli-v3.1.0, and hcaptcha-wasm-v3.1.0 verify with a “Good signature” using ED25519 key 5A0E5A078D8A661AACC7CB5AEB85EDFF0BCB42F8 (Jerus Bot). Older historical tags were unsigned; current releases use signed annotated tags.


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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/domain/client_response.rs
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/domain/secret.rs
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/domain/sitekey.rs
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/domain/remoteip.rs
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/captcha.rs
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/request.rs
    Server‑side inputs are validated before constructing requests. Client response, secret, sitekey, and remote IP each have parse/validator functions that reject empty/blank strings and malformed values: response and secret must be non‑empty; sitekey must be a valid UUID; remoteip must parse as IPv4 or IPv6. Optional fields set to empty become None rather than passing invalid data. Failures return structured errors with specific codes (e.g., MissingResponse, InvalidSiteKey, InvalidUserIp). Unit tests cover these behaviors. Secrets are excluded from tracing spans to avoid leaking sensitive inputs.



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

    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/audit.yml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/request.rs
    The project applies multiple hardening measures: memory‑safe Rust with no unsafe blocks in the core crate; strict input validation for all externally supplied values; secrets are excluded from logs/tracing (e.g., request.rs instruments spans with skip(secret)); HTTPS/TLS via reqwest with verified certificates; CI runs clippy with zero‑warning policy and doctests; weekly dynamic analysis includes Miri (UB/memory safety) and a libFuzzer target for response parsing (see .circleci/audit.yml). SECURITY.md documents trust boundaries and non‑logging of secrets; CONTRIBUTING.md codifies the “no unsafe unless strictly justified” rule and CI gates.



    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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/ARCHITECTURE.md
    https://github.com/jerus-org/hcaptcha-rs/blob/main/SECURITY.md
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/audit.yml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    https://github.com/jerus-org/hcaptcha-rs/tags
    The project presents an evidence-backed assurance case across its docs and CI: (1) Correct input handling is specified and enforced via domain validators and tests (see Captcha/Request and domain types in ARCHITECTURE.md and source files), (2) Memory safety is ensured by safe Rust (no unsafe in core) and dynamic analysis (Miri and a libFuzzer target in .circleci/audit.yml), (3) Communication security relies on HTTPS with certificate verification (SECURITY.md), (4) Release integrity uses signed, annotated version tags (tags page), and (5) Continuous verification via CI runs builds, doctests, clippy, feature-matrix test suites, and coverage reporting (.circleci/config.yml). This forms a coherent argument with concrete evidence for correctness, safety, and delivery integrity.


 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.

    https://github.com/jerus-org/hcaptcha-rs/blob/main/.github/workflows/scorecards-analysis.yml
    Clippy includes security lints. Additionally, OSSF Scorecard runs weekly to check for common vulnerabilities.


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

    Miri runs with -Zmiri-disable-isolation to allow std syscalls while still catching memory safety violations and undefined behavior



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 Jeremiah Russell und die OpenSSF Best Practices Badge-Mitwirkenden als Urheber.

Projekt-Badge-Eintrag im Besitz von: Jeremiah Russell.
Eintrag erstellt: 2025-01-31 12:51:53 UTC, zuletzt aktualisiert: 2025-12-16 08:03:23 UTC. Letztes verlorenes Badge: 2025-12-12 12:44:22 UTC. Letztes erreichtes Badge: 2025-12-12 12:45:03 UTC.