From 7bd3679342d32d319df89cc796d096ded7ad3fa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ulises=20Gasc=C3=B3n?= Date: Tue, 7 May 2024 11:30:28 +0200 Subject: [PATCH 1/2] docs: update OpenSSF Best practices silver criteria Ref: https://www.bestpractices.dev/en/projects/29?criteria_level=1 --- tools/ossf_best_practices/silver_criteria.md | 36 ++++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/tools/ossf_best_practices/silver_criteria.md b/tools/ossf_best_practices/silver_criteria.md index c2c886b1..3c5d8e27 100644 --- a/tools/ossf_best_practices/silver_criteria.md +++ b/tools/ossf_best_practices/silver_criteria.md @@ -41,7 +41,7 @@ Context: > The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a [Developer Certificate of Origin (DCO)](https://developercertificate.org/), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/CONTRIBUTING.md#developers-certificate-of-origin** +**Met. https://github.com/nodejs/node/blob/main/CONTRIBUTING.md#developers-certificate-of-origin** Context: - [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#basics) @@ -50,7 +50,7 @@ Context: > The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/GOVERNANCE.md** +**Met. https://github.com/nodejs/node/blob/main/GOVERNANCE.md** Context: - [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#basics) @@ -59,7 +59,7 @@ Context: > The project MUST adopt a code of conduct and post it in a standard location. -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/CODE_OF_CONDUCT.md** +**Met. https://github.com/nodejs/node/blob/main/CODE_OF_CONDUCT.md** Context: - [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#basics) @@ -67,7 +67,7 @@ Context: > The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/GOVERNANCE.md** +**Met. https://github.com/nodejs/node/blob/main/GOVERNANCE.md** Context: - [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#basics) @@ -75,7 +75,7 @@ Context: > The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names) (URL required). -**Met** https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/GOVERNANCE.md +**Met. https://github.com/nodejs/node/blob/main/GOVERNANCE.md** Context: @@ -85,7 +85,7 @@ Context: > The project SHOULD have a "bus factor" of 2 or more. (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/README.md#current-project-team-members** +**Met. https://github.com/nodejs/node/blob/main/README.md#current-project-team-members** Context: - [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#basics) @@ -112,7 +112,7 @@ Context: > The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/SECURITY.md and https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/SECURITY.md#the-nodejs-threat-model** +**Met. https://github.com/nodejs/node/blob/main/SECURITY.md and https://github.com/nodejs/node/blob/main/SECURITY.md#the-nodejs-threat-model** Context: - [CII Best Practices: Documentation](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#documentation) @@ -130,7 +130,7 @@ Context: > The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. -**Met** +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/api-documentation.md** Context: - [CII Best Practices: Documentation](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#documentation) @@ -209,7 +209,7 @@ Context: > The project MUST have a documented process for responding to vulnerability reports. (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/SECURITY.md** +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/cpp-style-guide.md** Context: - [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#reporting) @@ -221,7 +221,7 @@ Context: > The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) -**Met** https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/doc/contributing/cpp-style-guide.md +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/cpp-style-guide.md** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -230,7 +230,7 @@ Context: > The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). -**Met** +**Met. The details can be found at https://github.com/nodejs/node/blob/main/Makefile** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -274,7 +274,7 @@ Context: > The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. -**Met** +**Met. https://nodejs.org/en/download** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -290,7 +290,7 @@ Context: > The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/doc/contributing/pull-requests.md#setting-up-your-local-environment** +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/pull-requests.md#setting-up-your-local-environment** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -301,7 +301,7 @@ Context: > The project MUST list external dependencies in a computer-processable way. (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/doc/contributing/maintaining/maintaining-dependencies.md** +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/maintaining/maintaining-dependencies.md** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -467,7 +467,7 @@ Context: > The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/doc/contributing/releases.md#3-a-publicly-listed-gpg-key** +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/releases.md#3-a-publicly-listed-gpg-key** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -476,7 +476,7 @@ Context: > It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in [signed_releases](https://bestpractices.coreinfrastructure.org/en/projects/29?criteria_level=1#signed_releases). -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/doc/contributing/releases.md#11-tag-and-sign-the-release-commit** +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/releases.md#11-tag-and-sign-the-release-commit** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -504,7 +504,7 @@ Context: > The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/SECURITY.md** +**Met. https://github.com/nodejs/node/blob/main/SECURITY.md** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -516,7 +516,7 @@ Context: > The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. -**Met. https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/doc/contributing/static-analysis.md** +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/static-analysis.md** Context: - [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#analysis) From 8e0ea90db63fed7032bfbc19a664b53abbb4f17f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ulises=20Gasc=C3=B3n?= Date: Tue, 7 May 2024 11:38:07 +0200 Subject: [PATCH 2/2] docs: remark pending justifications --- tools/ossf_best_practices/silver_criteria.md | 40 ++++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/tools/ossf_best_practices/silver_criteria.md b/tools/ossf_best_practices/silver_criteria.md index 3c5d8e27..75bf6e5c 100644 --- a/tools/ossf_best_practices/silver_criteria.md +++ b/tools/ossf_best_practices/silver_criteria.md @@ -240,7 +240,7 @@ Context: > Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -248,7 +248,7 @@ Context: > The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -256,7 +256,7 @@ Context: > The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -282,7 +282,7 @@ Context: > The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -309,7 +309,7 @@ Context: > Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -322,7 +322,7 @@ Context: > > Then, if a vulnerability is found in a reused component, it will be easy to update that component. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -330,7 +330,7 @@ Context: > The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -340,7 +340,7 @@ Context: > An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -348,7 +348,7 @@ Context: > The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -367,7 +367,7 @@ Context: > The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -375,7 +375,7 @@ Context: > The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -385,7 +385,7 @@ Context: > Projects MUST be maximally strict with warnings in the software produced by the project, where practical. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#quality) @@ -397,7 +397,7 @@ Context: > The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -409,7 +409,7 @@ _Note that some software does not need to use cryptographic mechanisms. If your > The default security mechanisms within the software produced by the project MUST NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -417,7 +417,7 @@ Context: > The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -441,7 +441,7 @@ Context: > The software produced by the project SHOULD, 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). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -449,7 +449,7 @@ Context: > The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -457,7 +457,7 @@ Context: > The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -486,7 +486,7 @@ Context: > The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. -**Met** +**Met. Warning: Requires lengthier justification.** Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security) @@ -495,7 +495,7 @@ Context: > Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. -**N/A** The the final user has the power to decide, see: Node.js thread model (https://github.com/nodejs/node/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/SECURITY.md#the-nodejs-threat-model) +**N/A** The the final user has the power to decide, see: Node.js thread model (https://github.com/nodejs/node/blob/main/SECURITY.md#the-nodejs-threat-model) Context: - [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/a51ed45fdcd8e2959781a86929f561521ac2e0e0/docs/other.md#security)