hMailServer (Progressive Robot's fork)

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

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

如果这是您的项目,请在项目页面上显示您的基准徽章状态!基准徽章状态如下所示: 项目14949的基准徽章等级为baseline-2 以下是如何嵌入基准徽章:
您可以通过将其嵌入到Markdown文件中来显示您的基准徽章状态:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/14949/baseline)](https://www.bestpractices.dev/projects/14949)
或者将其嵌入到HTML中:
<a href="https://www.bestpractices.dev/projects/14949"><img src="https://www.bestpractices.dev/projects/14949/baseline"></a>


这些是基准等级3的标准。 这些是标准版本 v2026.08.28。

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

        

 基本

  • 常规

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

    Progressive Robot's fork of hMailServer, not the original hMailServer by Martin Knafve, which is developed separately: a free, open-source mail server for Windows and Linux implementing SMTP, IMAP and POP3, with webmail, a REST API and a Control Panel, brought up to date with a current toolchain and current cryptography. Maintained by Progressive Robot Ltd.

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

    This entry replaces https://www.bestpractices.dev/en/projects/14187, which was made through a GitHub login. GitHub suspended the project account on 18 September 2026, so that entry can no longer be edited. The project has lived on GitLab since 22 September 2026: https://gitlab.com/hmailserver/hmailserver. Every answer here was checked again against the project on 26 September 2026. hMailServer 6.3.4 was released on 27 September 2026 (https://gitlab.com/hmailserver/hmailserver/-/releases/v6.3.4), and the answers it made true were updated that day.

 控制 19/21 ●

  • 控制


    当在CI/CD管道中为作业分配权限时,源代码或配置必须仅分配相应活动所需的最低权限。 [OSPS-AC-04.02]
    配置项目的CI/CD流水线,默认为用户和服务分配最低可用权限,仅在特定任务需要时才提升权限。在某些版本控制系统中,这可以在组织或代码仓库级别实现。如果不行,请在流水线的顶层设置权限。

    Each job is given only what its task needs. The jobs that declare an OIDC ID token each name the one audience they use and run only for protected refs: release-authenticode (api://AzureADTokenExchange) and release-sign (sigstore) for a protected v* tag, the container image's signing (sigstore) in a release's pipeline, the PyPI publish (pypi, sigstore) on master, and the release rehearsal's signing (sigstore) on a protected batch* branch, an identity no server trusts. build/ci/repo-hygiene.py fails any job that a merge request or an unprotected ref can start and that reaches the project's runners or asks for an ID token. On the GitHub copy both workflows default to permissions: read-all and grant a job only the write it needs. https://gitlab.com/hmailserver/hmailserver/-/blob/master/.gitlab-ci.yml



    接受可信协作者输入的 CI/CD 流水线在流水线中使用该输入之前,必须对其进行清理和验证。 [OSPS-BR-01.04]
    CI/CD 流水线应对显式工作流执行中的所有协作者输入进行清理(引用、转义或在期望值时退出)。虽然协作者通常是可信的,但工作流的手动输入无法经过审查,可能被账户劫持或内部威胁所滥用。

    GitLab pipelines here accept no collaborator input: the project's minimum role for pipeline variables is 'no one allowed' (read through GitLab's API on 23 October 2026), so nobody can pass variables when starting a pipeline, .gitlab-ci.yml defines no spec:inputs, the manual jobs take no parameters, and what a schedule sets is only compared in rules. Branch and tag names reach scripts only through the environment, and the release scripts refuse a tag that is not a release version. On GitHub, the two workflows take no workflow_dispatch input. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#branch-and-tag-names-in-the-pipelines



    当创建正式发布版本时,该发布版本中的所有资产必须明确关联到发布标识符或资产的其他唯一标识符。 [OSPS-BR-02.02]
    为项目生成的每个软件资产分配唯一的版本标识符,遵循一致的命名约定或编号方案。示例包括SemVer、CalVer或git提交ID。

    Each release's files are in the package registry under the version, e.g. /packages/generic/hmailserver/6.3.3/, and are linked from the release with that tag. The installer and the packages also carry the version in their file names (hMailServer-6.3.3-x64.exe, hmailserver_6.3.3_amd64.deb). See https://gitlab.com/hmailserver/hmailserver/-/releases/v6.3.3



    项目必须定义管理项目使用的秘密和凭证的策略。该策略应包括存储、访问和轮换秘密和凭证的指南。 [OSPS-BR-07.02]
    记录项目内如何管理和使用秘密和凭证。这应包括如何存储秘密(例如,使用秘密管理工具)、如何控制访问以及如何轮换或更新秘密的详细信息。确保敏感信息不会硬编码在源代码中或存储在版本控制系统中。

    SECURITY.md, 'Secrets and credentials', is the policy. No token, password or signing key is committed, and the test keys are throwaway fixtures. Release-asset signing is keyless (Sigstore), and the tag-signing keys' public halves are in allowed_signers. A secret is rotated when a maintainer leaves, when its pipeline changes hands, on any suspicion of exposure, and before it expires. GOVERNANCE.md says only Christopher Holloway holds the credentials under 'Critical assets'. See https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md



    当项目已发布版本时,项目文档必须包含验证发布资产完整性和真实性的说明。 [OSPS-DO-03.01]
    项目中的说明应包含所使用技术、要运行的命令以及预期输出的信息。如果可能,避免将此文档存储在构建和发布流水线的相同位置,以避免单一漏洞同时危及软件和验证软件完整性的文档。

    SECURITY.md, 'Verifying a release', gives the commands and names the tools: git verify-tag against the committed .gitlab/allowed_signers for the tag; cosign verify-blob with each file's Sigstore bundle, certificate identity and OIDC issuer for every file of the releases from 6.2.19 on (but 6.3.4); cosign verify-blob-attestation against the build provenance from 6.3.6; ssh-keygen -Y verify and sha256sum -c for the signed sums of a release made by hand; and Get-AuthenticodeSignature for the Windows installer from 6.3.1. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#verifying-a-release



    当项目已发布版本时,项目文档必须包含验证软件发布作者的预期身份的说明。 [OSPS-DO-03.02]
    预期身份可能采用用于签名的密钥ID、来自sigstore证书的颁发者和身份或其他类似形式。如果可能,避免将此文档存储在构建和发布流水线的相同位置,以避免单一漏洞同时危及软件和验证软件完整性的文档。

    SECURITY.md, 'Verifying a release', says which identity authored each release and how to check it: the release tags against .gitlab/allowed_signers, which holds one key, the owner's (christopher.j.holloway@outlook.com); the files from 6.3.6 against the Sigstore identity https://gitlab.com/hmailserver/hmailserver//.gitlab-ci.yml@refs/tags/v<version> with the issuer https://gitlab.com, and the project's id, 86730559, in the certificate; 6.3.5 against the path the project began at; and the releases up to 6.3.3 against ^https://github.com/Progressiverobot/hmailserver/ with GitHub's issuer. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#verifying-a-release



    当项目已发布版本时,项目文档必须包含关于每个发布版本支持范围和持续时间的描述性声明。 [OSPS-DO-04.01]
    为了传达项目发布的软件资产的支持范围和持续时间,项目应有SUPPORT.md文件、SECURITY.md中的"支持"部分或其他文档,说明支持生命周期,包括每个发布版本的预期支持持续时间、提供的支持类型(例如,错误修复、安全更新)以及获取支持的任何相关策略或程序。

    SECURITY.md's 'Supported versions' and 'While releases pause' state the scope and duration of support: the 6.3 line, as its newest release, receives security fixes until 30 September 2027, and a fix ships in the next release, cut from master, with no back-ports, since there are no maintenance branches. SUPPORT.md describes the support offered: issues, the forum, what to expect, and no guaranteed response time. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#supported-versions



    当项目已发布版本时,项目文档必须提供描述性声明说明何时发布版本或版本将不再接收安全更新。 [OSPS-DO-05.01]
    为了传达安全修复的支持范围和持续时间,项目应有SUPPORT.md或其他文档,说明项目的安全更新策略。

    SECURITY.md says when releases stop receiving security updates: only the 6.3 line receives them, until 30 September 2027 unless the maintainers write otherwise there before that date, and everything older than 6.3 receives none; a fix ships in the next 6.3 release and is not back-ported, so a release stops receiving security updates once a newer one is published. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#supported-versions



    项目文档必须制定一项政策,规定在向代码协作者授予提升权限以访问敏感资源之前对其进行审核。 [OSPS-GV-04.01]
    在项目文档中发布可执行的策略,要求在授予对敏感资源(例如合并批准或访问秘密)的提升权限之前审查和批准代码协作者。建议审查包括建立可证明的身份血统,例如确认贡献者与已知可信组织的关联。

    GOVERNANCE.md, 'Becoming a maintainer', sets the rule for escalated access: a sustained record of correct, tested changes and willingness to take on the release and security duties, decided by the maintainers. It records openly that the second maintainer, Zain Ul Abidin, was appointed by the owner in September 2026 before building that record. Only the owner, the project's one member with the Maintainer role or above, can grant a GitLab role. https://gitlab.com/hmailserver/hmailserver/-/blob/master/GOVERNANCE.md#becoming-a-maintainer



    当项目已发布版本时,所有编译的已发布软件资产必须附带软件物料清单。 [OSPS-QA-02.02]
    建议在构建时使用经过准确性审查的工具自动生成SBOM。这使用户能够以标准化的方式将此数据与其环境中的其他项目一起提取。

    Not met yet. Every compiled file of a version release from 6.3.4 on - the Windows installers, the .deb and the .rpm among them - is delivered with its own CycloneDX 1.6 SBOM (<file>.cdx.json), generated at build time (build/asset-sbom.py) and naming the file by its SHA-256, beside the release's SPDX and CycloneDX SBOMs of the tree, and the release is refused without them. Releases 6.2.3 to 6.3.3 carry SPDX and CycloneDX SBOMs beside their assets, and the five earlier releases with an installer (v6.0.0-B1, v6.0.0, v6.1.0, v6.2.1, v6.2.2) carry <installer>.cdx.json made from the installer itself, attached on 26 September 2026. But the two build-inputs releases on the same page carry compiled files and no SBOM: build-inputs-1 (third-party Windows build inputs) and build-inputs-2 (MariaDB Connector/C 3.4.11, which the project builds from MariaDB's signed source with libraries/build-mariadb-connector-c.ps1). This is met when each carries a CycloneDX SBOM of its own or leaves the releases page. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#software-bills-of-materials and https://gitlab.com/hmailserver/hmailserver/-/releases/build-inputs-2



    当项目已发布包含多个源代码仓库的版本时,所有子项目必须执行与主代码库一样严格或更严格的安全要求。 [OSPS-QA-04.02]
    项目生成并编译到发布版本中的任何其他子项目代码仓库必须根据相应代码库的状态和意图执行安全要求。除了遵循相应的OSPS基线要求外,这还可能包括要求进行安全审查、确保其没有漏洞以及确保其没有已知的安全问题。

    Releases are built from one repository alone: the server, the .NET tools, the web front ends and the vendored third-party code (inventoried in hmailserver/docs/third-party-binaries.json) all live there, so there are no subproject repositories to hold to the primary codebase's requirements. https://gitlab.com/hmailserver/hmailserver



    项目文档必须清楚地记录测试的运行时间和方式。 [OSPS-QA-06.02]
    在贡献文档中添加一个章节,说明如何在本地运行测试以及如何在CI/CD管道中运行测试。文档应说明测试的测试内容以及如何解释测试结果。

    CONTRIBUTING.md's Testing section says how to run the Windows regression suite (the bench, build/preflight-tests.ps1, build/run-tests.ps1) and the Linux suite (dotnet test with the HMTEST_* settings), what they exercise and how to read the result; 'The checkers' and hmailserver/docs/ContinuousIntegration.md say which checks and suites each GitLab CI job runs, where, and for which refs. RELEASE.md requires the full suite, zero failures, on the exact binary that ships. https://gitlab.com/hmailserver/hmailserver/-/blob/master/CONTRIBUTING.md#testing



    项目文档必须包含一项政策,规定对项目生成的软件所做的所有重大更改都应在自动化测试套件中添加或更新相应功能的测试。 [OSPS-QA-06.03]
    在贡献文档中添加一个章节,说明添加或更新测试的政策。该政策应说明什么是重大更改以及应该添加或更新哪些测试。

    CONTRIBUTING.md makes it policy: 'Add or update regression tests for a change of behaviour' (Merge requests), and 'A fix ships with a test that fails against the build before it' (Writing a test); RELEASE.md requires a negative-control test for every defect fix. https://gitlab.com/hmailserver/hmailserver/-/blob/master/CONTRIBUTING.md#merge-requests



    当向主分支提交时,项目的版本控制系统必须在合并之前要求至少一名非作者人工审批更改。 [OSPS-QA-07.01]
    配置项目的版本控制系统,要求在合并到发布分支或主分支之前至少有一名非作者人工审批更改。这可以通过要求拉取请求在合并之前必须由至少另一位协作者审查和批准来实现。

    No approval rule is configured on GitLab, so the version control system does not require a non-author human approval before a change reaches master; build/land-via-mr.py records whether one was given and refuses without it unless the owner overrides it for that landing. Since 13 October 2026 nobody but the owner holds a role in the project, so every batch lands on his recorded override, under his standing decision of 6 October 2026 to leave this unmet for the moment. (The GitHub copy's ruleset holds a pull request to two approvals, but changes land on GitLab.) https://gitlab.com/hmailserver/hmailserver/-/blob/master/GOVERNANCE.md#how-decisions-are-made



    当项目发布版本时,项目必须执行威胁建模和攻击面分析,以理解和防护针对系统内关键代码路径、函数和交互的攻击。 [OSPS-SA-03.02]
    威胁建模是一项活动,其中项目查看代码库、相关流程和基础设施、接口、关键组件,并"像黑客一样思考",集思广益探讨系统可能如何被破坏或受到损害。每个识别的威胁都会被列出,以便项目可以考虑如何主动避免或关闭可能出现的任何漏洞/脆弱点。确保为新功能或破坏性更改更新此分析。

    Sections 3 and 4 of ASSURANCE-CASE.md are the threat model and attack-surface analysis: actors A1-A6 with their assumed capabilities, the assets, the principal attack surfaces (protocol parsers, MIME parsing, TLS, the scanner and DNS paths, persistence, and the REST, metrics and web-services listeners) and trust boundaries B1-B6 with the check made at each. https://gitlab.com/hmailserver/hmailserver/-/blob/master/ASSURANCE-CASE.md#3-threat-model



    软件组件中不影响本项目的任何漏洞必须在VEX文档中予以记录,通过补充不可利用性的详细信息来完善漏洞报告。 [OSPS-VM-04.02]
    建立VEX供给源,传达已知漏洞的可利用性状态,包括评估细节或任何阻止易受攻击代码执行的缓解措施。

    The project keeps an OpenVEX document, .gitlab/hmailserver.openvex.json, with a not_affected statement and its justification for every advisory dismissed as not affecting the project: nine on 23 October 2026, for zlib, Boost, QuickJS and a Python package of the semgrep job's own tooling. SECURITY.md requires a statement for each such dismissal, and the dependency-scan job and the release's security gate honour the document. https://gitlab.com/hmailserver/hmailserver/-/blob/master/.gitlab/hmailserver.openvex.json



    项目文档必须包含一项政策,为与漏洞和许可证相关的软件成分分析(SCA)发现结果的修复设定阈值。 [OSPS-VM-05.01]
    在项目中记录一项政策,定义与漏洞和许可证相关的SCA发现的修复阈值。包括识别、优先级排序和修复这些发现的流程。

    SECURITY.md's Vulnerability management policy sets the SCA thresholds: a high or critical advisory in a dependency is fixed, or the dependency replaced, before the next release and within 14 days; moderate within 30 days; low within 90 days or with the next refresh; a licence incompatible with AGPL-3.0-or-later is treated as high. It says how findings are found (the dependency-scan job's Trivy and OSV queries, Renovate) and how a not-affected one is recorded in the VEX document. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#dependencies-software-composition-analysis



    项目文档必须包含一项政策,要求在任何发布之前处理软件成分分析(SCA)违规问题。 [OSPS-VM-05.02]
    在项目中记录一项政策,在任何发布之前解决适用的软件组成分析结果,并添加状态检查以验证在发布之前符合该政策。

    SECURITY.md's policy addresses SCA findings before every release, and the release job holds it: build/ci/security-gate.py refuses a release while dependency-scan did not finish or found a Critical or High vulnerability with a fixed version that the VEX document does not dismiss and .gitlab/security-exceptions.yml does not accept; a component the scan marks UNKNOWN, and one the SBOM lists and the scan does not, is checked by hand against the release's SBOM. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#before-a-release



    对项目代码库的所有更改都必须根据针对恶意依赖项和依赖项中已知漏洞的书面政策进行自动评估,并在出现违规情况时予以阻止,但已声明并抑制为不可利用的情况除外。 [OSPS-VM-05.03]
    在项目的版本控制系统中创建一个状态检查,对代码库的所有更改运行软件组成分析工具。要求状态检查在更改可以合并之前必须通过。

    Every change is evaluated by mr-dependency-check (build/ci/mr-dependency-check.py), in every merge request's pipeline and every batch* branch's, against the policy in SECURITY.md's 'Every change': a NuGet or PyPI version the change adds, or a native library pin it moves, with an OSV MAL- record (the OpenSSF malicious-packages data) or a Critical or High advisory, or a requirement that pins no version, fails the pipeline, which a merge request needs to land; a finding passes only through a not-exploitable declaration already on master, landed in a change of its own. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#every-change



    项目文档必须包含一项政策,为静态应用程序安全测试(SAST)发现结果的修复设定阈值。 [OSPS-VM-06.01]
    在项目中记录一项政策,定义静态应用程序安全测试(SAST)发现的修复阈值。包括识别、优先级排序和修复这些发现的流程。

    SECURITY.md's Vulnerability management policy sets the SAST threshold: an error-level finding, or a high or critical security finding, is fixed before merge; medium within 30 days; low or note-level with the next change to that file or dismissed with a written reason; no release with an open error-level finding. It names the tools (cppcheck, clang-tidy and Semgrep in CI, MSVC /analyze by hand) and how suppressions are recorded. https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#source-code-static-analysis



    对项目代码库的所有更改都必须根据书面政策针对安全弱点进行自动评估,并在出现违规情况时予以阻止,但已声明并抑制为不可利用的情况除外。 [OSPS-VM-06.02]
    在项目的版本控制系统中创建一个状态检查,对代码库的所有更改运行静态应用程序安全测试(SAST)工具。要求状态检查在更改可以合并之前必须通过。

    Every change is evaluated by GitLab's SAST (semgrep-sast) and semgrep-sast-gate, in every merge request's pipeline and every batch* branch's, against the policy in SECURITY.md's 'Every change': a Critical or High finding in a file the change touches, a baseline it grows, a suppression comment it adds, or a narrowing of what the scan reads that does not land alone fails the pipeline, which a merge request needs to land, unless a declaration already on master says why the finding is not exploitable ('Declaring a finding not exploitable'). https://gitlab.com/hmailserver/hmailserver/-/blob/master/SECURITY.md#every-change



您可以使用工具和AI系统通过简单的URL提交变更建议,例如 https://www.bestpractices.dev/zh-CN/projects/14949/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced。请参阅我们的自动化提案系统,了解具体操作方法。 该数据可在社区数据许可协议 – 许可性,版本 2.0 (CDLA-Permissive-2.0)下获取。这意味着数据接收方可以共享数据,无论是否经过修改,只要数据接收方在共享数据时提供本协议文本。请注明christopher holloway和OpenSSF最佳实践徽章贡献者。

项目徽章条目拥有者: christopher holloway.
最后更新于 2026-09-26 05:28:20 UTC, 最后更新于 2026-10-23 04:54:19 UTC。 最后在 2026-09-26 05:45:21 UTC 获得通过徽章。