hcaptcha-rs

遵循以下最佳实践的项目将能够自愿的自我认证，并显示他们已经实现了核心基础设施计划（OpenSSF）徽章。

没有一套可以保证软件永远不会有缺陷或漏洞的做法；如果规范或假设是错误的，即使合适的方法也可能失败。也没有哪些做法可以保证一个项目能够维持健康和运作良好的开发者社区。但是，遵循最佳做法可以帮助改善项目的成果。例如，一些做法可以在发布之前进行多人评估，这可以帮助您找到其他难以找到的技术漏洞，并帮助建立信任，并希望不同公司的开发人员之间进行重复的交互。要获得徽章，必须满足所有“必须”和“禁止”的条款，满足所有“应该”条款或有合适的理由，和所有“建议”条款必须满足或未满足（至少希望考虑）。欢迎通过 GitHub网站创建问题或提出请求进行反馈。另外还有一个一般讨论邮件列表。

如果这是您的项目，请在您的项目页面上显示您的徽章状态！徽章状态如下所示： 项目9974的徽章级别为passing 这里是如何嵌入它：
您可以通过将其嵌入在您的Markdown文件中：
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9974/badge)](https://www.bestpractices.dev/projects/9974)
或将其嵌入到HTML中来显示您的徽章状态：
<a href="https://www.bestpractices.dev/projects/9974"><img src="https://www.bestpractices.dev/projects/9974/badge"></a>


这些是黄金级别条款。您还可以查看通过或白银级别条款。

Baseline Series: 基准等级1 基准等级2 基准等级3

        

 基本 2/5 ●

  • 常规

    请注意，其他项目可能使用相同的名称。

    hcaptcha-rs is a library to verify hcaptcha responses.

    请使用 SPDX许可证表达格式;例子包括“Apache-2.0”，“BSD-2-Clause”，“BSD-3-Clause”，“GPL-2.0+”，“LGPL-3.0 +”，“MIT”和“(BSD-2-Clause OR Ruby)”。
    如果有多种语言，请将它们列为逗号分隔值（可选空格），并将它们从最多到最少使用。如果有长列表，请至少列出前三个最常见的列表。如果没有语言（例如，这是仅文档或仅测试项目），请使用单个字符“ - ”。请使用每种语言的常规大小写，例如“JavaScript”。
    通用平台枚举（CPE）是用于信息技术系统，软件和软件包的结构化命名方案。在报告漏洞时，它可用于多个系统和数据库。

  • 先决条件


    不足以获得徽章。

    该项目必须拥有银级徽章。 [achieve_silver]

  • 项目监督


    未知的所需信息，不足以用于徽章。

    项目必须具有2个或更多的“公交车因子”。 (需要网址) [bus_factor]
    “公交车系数”（又名“卡车因子”）是指最少数量的项目成员，如果突然离开项目（“被公交车撞了”），项目会由于缺乏具备知识的或有能力的人员而暂停。 卡车因子 工具可以对GitHub上的项目进行估计。有关详细信息，请参阅Cosentino等人的评估Git存储库的卡车因子。

    未知的所需信息，不足以用于徽章。

    该项目必须至少有两个不相关的重要贡献者。 (需要网址) [contributors_unassociated]
    如果同一组织（作为雇员或承包商）支付工作费用，并且组织将从项目的结果中受益，则贡献者是相关联的。如果通过其他组织得到财务补助（例如，源自政府或非政府组织，支付给不同组织的科学补助金不会导致捐助者关联），不视为来自同一组织。重要贡献者定义为过去一年对项目做出了不平凡的贡献。一个重要贡献者的良好指标的例子是：编写至少1,000行代码，贡献50个提交或至少提交20页的文档。

  • 其他


    足够获得徽章！

    项目必须在每个源文件中包含许可证声明。这可以通过在每个文件开头附近的注释中加入以下内容来实现： SPDX-License-Identifier: [SPDX license expression for project]。 [license_per_file]
    这可以通过在自然语言中包含许可证标识来完成。该项目还可以包括完整许可证文本，或者指向许可证文本的稳定URL。请注意，license_location条款要求项目许可证在标准位置。有关SPDX许可证表达式的更多信息，请参阅SPDX教程。请注意与 copyright_per_file 的关系，其内容通常在许可证信息之前。

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md
    https://github.com/jerus-org/hcaptcha-rs/blob/main/hcaptcha/src/lib.rs
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    https://github.com/jerus-org/hcaptcha-rs/blob/main/renovate.json.license
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.vscode/launch.json.license
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.vscode/settings.json.license
    The project applies per‑file licensing via SPDX headers in source and config files (e.g., “SPDX-License-Identifier: MIT OR Apache-2.0”), and uses REUSE‑style sidecar “.license” files for non‑commentable assets. CONTRIBUTING.md documents the requirement and provides the exact header snippet; representative files across Rust and YAML show the headers, and sidecar files cover JSON/VS Code assets.


 变更控制 4/4 ●

 质量 5/7 ●

  • 编码标准


    足够获得徽章！

    该项目必须记录其代码检视需求，包括代码检视是如何进行的，必须检查的内容以及哪些是可接纳的内容。 (需要网址) [code_review_standards]
    另请参阅 two_person_review 和contribution_requirements 条款。

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#pull-request-guidelines
    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#coding-standards
    https://github.com/jerus-org/hcaptcha-rs/blob/main/GOVERNANCE.md#process-requirements
    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/config.yml
    The project documents clear code‑review standards and enforces them in CI. All changes must land via pull request; direct commits to main are prohibited. PRs must be focused, have descriptive commits with DCO sign‑off, include tests, and pass formatting and clippy with zero warnings. Review is required by a maintainer, and merges occur only when CI is green (build, doctests, lints, multi‑suite tests). Governance further codifies the requirement that CI checks pass and that review is part of the standard process.


    足够获得徽章！

    该项目必须至少有50％的修改（作者之外的人提出的）在发布之前审查，以确定是否是一个有价值的修改，并且没有已知的问题，会反对其包含 [two_person_review]

    • URL:
    ◦ https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md#pull-request-guidelines
    ◦ https://github.com/jerus-org/hcaptcha-rs/blob/main/GOVERNANCE.md#process-requirements
    • Justification: The GitHub Ruleset “Protect the Main Branch” enforces PRs on main and requires at least one approval from someone other than the author (applies to admins), with CI checks required before merge. CONTRIBUTING and Governance documents also require review for every change, so two‑person review is both documented and technically enforced.


  • 可工作的构建系统


    足够获得徽章！

    该项目必须具有可重复构建。如果没有发生构建（例如，直接使用源代码而不是编译的脚本语言），请选择“不适用”（N/A）。 (需要网址) [build_reproducible]
    可重复的构建意味着多方可以独立地重做从源文件生成信息的过程，并获得每比特完全相同的结果。在某些情况下，这可以通过强制某种排序来解决。 JavaScript开发人员可能会考虑使用npm shrinkwrap和webpack的OccurenceOrderPlugin。 GCC和clang用户可能会发现-frandom-seed选项有用。通常可以通过指定可用于重新构建的特定容器或虚拟机的加密散列来为外部方定义构建环境（包括工具集）。 可重复构建项目具有文档指导如何执行此操作。

    The project has established reproducible builds. Multiple parties can independently rebuild crate packages and verify bit-for-bit identical results given the same inputs.

    Implementation:
    • Deterministic build process: CI uses SOURCE_DATE_EPOCH (fixed to last commit timestamp), RUSTFLAGS path remapping (--remap-path-prefix), and CFLAGS remapping for C dependencies to eliminate host-specific paths and timestamps.
    • Locked dependencies: Cargo.lock is committed, ensuring consistent dependency versions.
    • Specified build environment: Builds run in pinned Docker container images (jerusdp/ci-rust:1.88-wasi). The exact image, toolchain version, and environment variables are documented.
    • Verification support: SHA256 checksums of packaged crates are computed and attached to each GitHub release, allowing users to verify their local builds match official releases.

    Documentation:
    • Rebuild instructions with exact commands and environment variables: docs/REPRODUCIBLE_BUILDS.md
    • CI configuration: .circleci/config.yml (see set_repro_env command and compute_checksums_and_upload job)
    • Container pin file for future digest-based pinning: ci/container-pins.yaml

    URL: https://github.com/jerus-org/hcaptcha-rs/blob/main/docs/REPRODUCIBLE_BUILDS.md


  • 自动测试套件


    足够获得徽章！

    测试套件必须以该语言的标准方式进行调用。 (需要网址) [test_invocation]
    例如“make check”，“mvn test”或“rake test”。

    https://github.com/jerus-org/hcaptcha-rs/blob/main/CONTRIBUTING.md
    CONTRIBUTING.md line 85 documents test invocation: cargo test --all


    足够获得徽章！

    该项目必须实施持续集成，将新的或更改的代码经常集成到中央代码库中，并对结果进行自动化测试。 (需要网址) [test_continuous_integration]
    在大多数情况下，这意味着每个在项目上全职工作的开发人员至少每天都会整合。

    https://dl.circleci.com/status-badge/redirect/gh/jerus-org/hcaptcha-rs/tree/main
    CircleCI runs comprehensive CI pipeline including tests on every commit. CircleCI badge displayed in README.


    未知的所需信息，不足以用于徽章。

    如果有至少一个FLOSS工具可以以所选语言度量此条款，该项目的FLOSS自动测试套件必须具有至少90％语句覆盖率。 [test_statement_coverage90]

    未知的所需信息，不足以用于徽章。

    如果有至少一个FLOSS工具可以以所选语言度量此条款，该项目的FLOSS自动测试套件必须具有至少80％分支覆盖率。 [test_branch_coverage80]

 安全 4/5 ●

  • 使用基础的良好加密实践

    请注意，某些软件不需要使用加密机制。

    足够获得徽章！

    项目生成的软件必须支持所有网络通信的安全协议，如SSHv2或更高版本，TLS1.2或更高版本（HTTPS），IPsec，SFTP和SNMPv3。默认情况下，FTP，HTTP，Telnet，SSLv3或更早版本以及SSHv1等不安全协议必须被禁用，只有在用户专门配置时才启用。如果项目生成的软件不支持网络通信，请选择“不适用”（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.


    足够获得徽章！

    由项目生成的软件必须，如果支持或使用TLS，至少支持TLS版本1.2。请注意，TLS的前身称为SSL。如果软件不使用TLS，请选择“不适用”（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.


  • 安全交付防御中间人（MITM）的攻击


    足够获得徽章！

    项目网站，存储库（如果可通过网络访问）和下载站点（如果单独）必须包括具有非允许值的密钥加固头。 (需要网址) [hardened_site]
    请注意，GitHub是已知满足的。 https://securityheaders.io/ 等网站可以快速查看。主要头加固包含：内容安全策略（CSP），HTTP严格传输安全性（HSTS），X-Content-Type-Options（“nosniff”），X-Frame-Options和X-XSS-Protection。

    Found all required security hardening headers.
    https://github.com/jerus-org/hcaptcha-rs
    https://docs.rs/hcaptcha
    This project does not operate or control its own project website or web application; it uses GitHub for the repo and docs.rs for documentation. The “hardened_site” (gold) criterion applies to project‑run sites/apps where the project can configure headers and defenses (e.g., HSTS, CSP, SRI, secure cookies, no mixed content). Since no such site exists under project control, this is Not Applicable. If a site is added later (e.g., GitHub Pages with a custom domain or another host), we can implement and document HSTS (preload where possible), strict CSP (no inline script/styles), SRI on third‑party assets, secure cookies with SameSite, and CI checks for mixed content.


  • 其他安全问题


    不足以获得徽章。

    该项目必须在过去5年内进行安全审查。此审查必须考虑安全需求和安全边界。 [security_review]
    这可以由项目成员完成和/或独立评估。此评估可能由静态和动态分析工具支持，但还必须进行人工审查，以确定工具无法检测到的问题（特别是设计问题）。

    Status: Not yet (planned)
    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/ARCHITECTURE.md
    We have not yet completed an independent/security‑specialist review. Dynamic analysis (Miri + libFuzzer) and documented security practices are in place, but a formal review with public results is pending. Plan: engage an external reviewer to assess the core crate, dependency risk, misuse‑resistance of APIs, CI/supply‑chain controls, and fuzzing coverage; fix findings; publish a summary report (SECURITY-REVIEW.md) and reference it from SECURITY.md. Target window: January–February 2026 (publish summary no later than March 15, 2026). After the report is published, we will mark this criterion Met.


    足够获得徽章！

    加固机制必须用于项目生产的软件，以便软件缺陷不太可能导致安全漏洞。 (需要网址) [hardening]
    加固机制可能包括HTTP头，如内容安全策略（CSP），用于减轻攻击的编译器标志（如-fstack-protector）或用以消除未定义行为的编译器标志。对于此条款的目的，最小权限不被认为是一种加固机制（最少权限是重要的，但是另有条款）。

    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.


 分析 2/2 ●

  • 动态代码分析


    足够获得徽章！

    必须在发布之前，至少将一个动态分析工具应用于软件任何候选发布的主要生产版本。 [dynamic_analysis]
    动态分析工具通过执行特定输入来检查软件。例如，项目可以使用模糊工具（例如， American Fuzzy Lop ）或Web应用扫描程序（例如， ZAP 或 w3af ）。在某些情况下， OSS-Fuzz 项目可以对您的项目应用模糊测试。为满足此条款，动态分析工具需要以某种方式改变输入，以寻找各种问题，或者将其作为一个具有至少80％分支覆盖率的自动测试套件。 动态分析维基百科页面和 OWASP的fuzzing页面 识别一些动态分析工具。分析工具可能专注于寻找安全漏洞，但这不是必需的。

    https://github.com/jerus-org/hcaptcha-rs/blob/main/.circleci/audit.yml
    Weekly dynamic analysis via Miri (Rust interpreter detecting undefined behavior and memory errors) and libFuzzer (fuzz testing response parser). Configured in CircleCI audit workflow.


    足够获得徽章！

    项目应该在其生成的软件中包含许多运行时断言，并在动态分析期间检查这些断言。 [dynamic_analysis_enable_assertions]
    这个标准并不建议使生产过程中的断言;这完全取决于项目及其用户的决定。该标准的重点是在部署之前的动态分析过程中改善故障检测。在生产使用中启用断言与在动态分析（例如测试）期间启用断言完全不同。在某些情况下，在生产中使用断言是极其不明智的（尤其是在高完整性组件中）。存在许多反对在生产环境中启用断言的论点，例如，库不应使调用程序崩溃，它们的存在可能会导致应用商店拒绝，和/或在生产环境中激活断言可能会暴露诸如私钥之类的私有数据。请注意，在许多Linux发行版中都未定义NDEBUG ，因此C / C ++缺省情况下，assert（）将在这些环境中启用生产。对于那些环境中的生产，使用不同的断言机制或定义NDEBUG可能很重要。

    Miri and fuzz tests run with debug assertions enabled (Rust default for test/dev builds)



该数据可在社区数据许可协议 – 许可性，版本 2.0 (CDLA-Permissive-2.0)下获取。这意味着数据接收方可以共享数据，无论是否经过修改，只要数据接收方在共享数据时提供本协议文本。请注明Jeremiah Russell和OpenSSF最佳实践徽章贡献者。

项目徽章条目拥有者： Jeremiah Russell.
最后更新于 2025-01-31 12:51:53 UTC, 最后更新于 2025-12-16 08:03:23 UTC。 最后在2025-12-12 12:44:22 UTC丢失通过徽章。 最后在 2025-12-12 12:45:03 UTC 获得通过徽章。