FLOSS Best Practices Criteria (Gold Badge)

This is the set of best practices for Free/Libre and Open Source Software (FLOSS) projects to achieve the Open Source Security Foundation (OpenSSF) Best Practices gold badge. You can show this list with just the criteria or with additional information. The full set of criteria are also available.

See criteria discussion for more information about these criteria.

Gold

Basics

Prerequisites

• The project MUST achieve a silver level badge. ^{[achieve_silver]}

Project oversight

• The project MUST have a "bus factor" of 2 or more. {Met URL} ^[bus_factor]
• The project MUST have at least two unassociated significant contributors. {Met URL} ^{[contributors_unassociated]}

Other

• The project MUST include a copyright statement in each source file, identifying the copyright holder (e.g., the [project name] contributors). {Met justification} ^{[copyright_per_file]}
• The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. {Met justification} ^{[license_per_file]}

Change Control

Public version-controlled source repository

• The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). {Met justification} ^{[repo_distributed]}
• The project MUST clearly identify small tasks that can be performed by new or casual contributors. {Met URL} ^{[small_tasks]}
• The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. {Met justification} ^{[require_2FA]}
• The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. {Met justification} ^[secure_2FA]

Quality

Coding standards

• The project MUST document its code review requirements, including how code review is conducted, what must be checked, and what is required to be acceptable. {N/A justification} {Met URL} ^{[code_review_standards]}
• The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion {Met justification} ^{[two_person_review]}

Working build system

• The project MUST have a reproducible build. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). {N/A justification} {Met URL} ^{[build_reproducible]}

Automated test suite

• A test suite MUST be invocable in a standard way for that language. {Met URL} ^{[test_invocation]}
• The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. {Met URL} ^{[test_continuous_integration]}
• The project MUST have FLOSS automated test suite(s) that provide at least 90% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. {N/A justification} {Met justification} ^{[test_statement_coverage90]}
• The project MUST have FLOSS automated test suite(s) that provide at least 80% branch coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. {N/A justification} {Met justification} ^{[test_branch_coverage80]}

Security

Use basic good cryptographic practices

• The software produced by the project MUST support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 MUST be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). {N/A allowed} {Met justification} ^{[crypto_used_network]}
• The software produced by the project MUST, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). {N/A allowed} {Met justification} ^{[crypto_tls12]}

Secured delivery against man-in-the-middle (MITM) attacks

• The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. {Met URL} ^{[hardened_site]}

Other security issues

• The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. {Met justification} ^{[security_review]}
• Hardening mechanisms MUST be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. {N/A justification} {Met URL} ^[hardening]

Analysis

Dynamic code analysis

• The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. {N/A justification} {Met justification} ^{[dynamic_analysis]}
• The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. {N/A justification} {Met justification} ^{[dynamic_analysis_enable_assertions]}