diff --git a/tools/ossf_best_practices/passing_criteria.md b/tools/ossf_best_practices/passing_criteria.md index cff6a83d..9237a6b3 100644 --- a/tools/ossf_best_practices/passing_criteria.md +++ b/tools/ossf_best_practices/passing_criteria.md @@ -4,27 +4,47 @@ Check the official [report](https://bestpractices.coreinfrastructure.org/en/proj # Basics > What is the human-readable name of the project? -Node.js +**Node.js** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) + > What is a brief description of the project? -Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine +**Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) > What is the URL for the project (as a whole)? -https://nodejs.org +**https://nodejs.org** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) ->What is the URL for the version control repository (it may be the same as the project URL)? +> What is the URL for the version control repository (it may be the same as the project URL)? -https://github.com/nodejs/node +**https://github.com/nodejs/node** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) > What programming language(s) are used to implement the project? -JavaScript, C++, Python (CII estimate) +**JavaScript, C++, Python (CII estimate)** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) > What is the [Common Platform Enumeration (CPE)](https://nvd.nist.gov/cpe.cfm) name for the project (if it has one)? -`cpe:2.3:a:nodejs:node.js:*:*:*:*:-:*:*:*` +**`cpe:2.3:a:nodejs:node.js:*:*:*:*:-:*:*:*`** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1197621966) ## Basic project website content @@ -32,23 +52,30 @@ JavaScript, C++, Python (CII estimate) **Met** +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) + > The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. -**Met** -https://nodejs.org/en/get-involved +**Met. https://nodejs.org/en/get-involved** +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) -> The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) +> The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) -**Met** -https://github.com/nodejs/node/blob/master/CONTRIBUTING.md +**Met. https://github.com/nodejs/node/blob/master/CONTRIBUTING.md** +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) > The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) -**Met** -https://github.com/nodejs/node/blob/master/CONTRIBUTING.md +**Met. https://github.com/nodejs/node/blob/master/CONTRIBUTING.md** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) ## FLOSS license @@ -57,26 +84,42 @@ https://github.com/nodejs/node/blob/master/CONTRIBUTING.md **Met** +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) +- [CII Best practices: FLOSS license](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#floss_license) + > It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). **Met** +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) + > The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) -**Met** -https://github.com/nodejs/node/blob/master/LICENSE +**Met. https://github.com/nodejs/node/blob/master/LICENSE** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) +- [CII Best Practices: License Location](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#license_location) ## Documentation > The project MUST provide basic documentation for the software produced by the project. -**Met** -https://nodejs.org/en/docs/ +**Met. https://nodejs.org/en/docs/** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) +- [CII Best Practices: Documentation Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#documentation_basics) > The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. -**Met** -https://nodejs.org/api/ +**Met. https://nodejs.org/api/** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) +- [CII Best Practices: Documentation Interface](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#documentation_interface) ## Other @@ -84,19 +127,30 @@ https://nodejs.org/api/ **Met** ->The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) +- [CII Best Practices: Sites HTTPS](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#sites_https) -**Met** -GitHub issue tracker and pull requests support discussion +> The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. + +**Met. GitHub issue tracker and pull requests support discussion** + +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) > The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. **Met** +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) + > The project MUST be maintained. **Met** +Context: +- [CII Best Practices: Criteria Basics](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#basics) # Change Control @@ -106,91 +160,148 @@ GitHub issue tracker and pull requests support discussion **Met** +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) +- [CII Best Practices: Repo Public](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#repo_public) + > The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. **Met** +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) + > To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. **Met** +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) +- [CII Best Practices: Repo Interim](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#repo_interim) + > It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. **Met** +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) +- [CII Best Practices: Repo Distributed](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#repo_distributed) + ## Unique version numbering > The project results MUST have a unique version identifier for each release intended to be used by users. -**Met** -strictly semver +**Met. Strictly semver** + +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) +- [CII Best Practices: Version Unique](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#version_unique) > It is SUGGESTED that the [Semantic Versioning (SemVer)](https://semver.org/) or [Calendar Versioning (CalVer)](https://calver.org/) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value **Met** +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) +- [CII Best Practices: Version Semver](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#version_semver) + > It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. -**Met** -git tags +**Met. Git tags** + +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) ## Release notes > The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) -**Met** -https://github.com/nodejs/node/blob/master/CHANGELOG.md +**Met. https://github.com/nodejs/node/blob/master/CHANGELOG.md** + +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) +- [CII Best Practices: Release Notes](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#release_notes) > The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. **Met** -# Reporting +Context: +- [CII Best Practices: Change Control](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#change-control) +- [CII Best Practices: Release Notes Vulnerabilities](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#release_notes_vulns) +# Reporting ## Bug-reporting process > The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) -**Met** -https://github.com/nodejs/node/issues +**Met. https://github.com/nodejs/node/issues** + +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) +- [CII Best Practices: Report Process](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#report_process) > The project SHOULD use an issue tracker for tracking individual issues. -**Met** -https://github.com/nodejs/node/issues +**Met. https://github.com/nodejs/node/issues** + +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) +- [CII Best Practices: Report Process](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#report_process) > The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. **Met** +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) +- [CII Best Practices: Report Process](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#report_process) + > The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). **Met** +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) +- [CII Best Practices: Report Process](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#report_process) + > The project MUST have a publicly available archive for reports and responses for later searching. (URL required) -**Met** -https://github.com/nodejs/node/issues +**Met. https://github.com/nodejs/node/issues** + +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) ## Vulnerability report process > The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) -**Met** -https://nodejs.org/en/security/ +**Met. https://nodejs.org/en/security/** + +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) +- [CII Best Practices: Vulnerability Report Process](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#vulnerability_report_process) > If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) -**Met** https://nodejs.org/en/security/#disclosure-policy +**Met. https://nodejs.org/en/security/#disclosure-policy** + +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) +- [CII Best Practices: Vulnerability Report Private](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#vulnerability_report_private) > The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. -**Met** Your email will be acknowledged within 24 hours +**Met. Your email will be acknowledged within 24 hours** + +Context: +- [CII Best Practices: Reporting](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#reporting) +- [CII Best Practices: Vulnerability Report Response](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#vulnerability_report_response) # Quality @@ -199,20 +310,28 @@ https://nodejs.org/en/security/ > If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. -**Met** -https://github.com/nodejs/node#build +**Met. https://github.com/nodejs/node#build** + +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Build](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#build) > It is SUGGESTED that common tools be used for building the software. -**Met** -python, make or batch file, gcc or clang +**Met. python, make or batch file, gcc or clang** + +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Build Common Tools](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#build_common_tools) > The project SHOULD be buildable using only FLOSS tools. -**Met** -python, make or batch file, gcc or clang +**Met. python, make or batch file, gcc or clang** + +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) ## Automated test suite @@ -221,55 +340,89 @@ python, make or batch file, gcc or clang **Met** +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Build FLOSS Tools](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#build_floss_tools) +- [CII Best Practices: Test](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#test) + > A test suite SHOULD be invocable in a standard way for that language. -**Met** -make or batch file, executed using python +**Met. make or batch file, executed using python** + +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) > It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. **Met** +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Test Most](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#test_most) +- [CII Best Practices: Test Continuos Integration](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#test_continuous_integration) > It is SUGGESTED that the project 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** -https://ci.nodejs.org/ +**Met. https://ci.nodejs.org/** +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Test Most](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#test_most) +- [CII Best Practices: Test Continuos Integration](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#test_continuous_integration) ## New functionality testing > The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. -**Met** -https://github.com/nodejs/node/blob/main/doc/contributing/pull-requests.md#step-6-test +**Met. https://github.com/nodejs/node/blob/main/doc/contributing/pull-requests.md#step-6-test** + +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Tests Policy](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#test_policy) > The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. **Met** +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) + > It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals **Met** +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Tests Documented Added](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#tests_documented_added) + ## Warning flags > The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. -**Met** --Wall for compiling, c++ and JS linting as part of test suite +**Met. Wall for compiling, c++ and JS linting as part of test suite** + +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Warnings](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#warnings) > The project MUST address warnings. **Met** +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) +- [CII Best Practices: Warnings Fixed](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#warnings_fixed) + > It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. **Met** +Context: +- [CII Best Practices: Quality](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#quality) + # Security ## Secure development knowledge @@ -278,77 +431,135 @@ https://github.com/nodejs/node/blob/main/doc/contributing/pull-requests.md#step- **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Know Secure Design](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#know_secure_design) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1179649274) +- [Follow up issue](https://github.com/nodejs/security-wg/issues/987) + > At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Know Common Errors](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#know_common_errors) + ## Use basic good cryptographic practices > The software produced by the project MUST use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). -**Met** -all crypto uses openssl +**Met. All crypto uses openssl** + +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto Published](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_published) > If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. -**Met** -all crypto uses openssl +**Met. All crypto uses openssl** + +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto All](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_call) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1179649710) > All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto FLOSS](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_floss) + > The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. -**Met** -If someone wants to, they can use custom OpenSSL configurations, custom OpenSSL providers, or even custom dynamically linked OpenSSL builds to "configure" Node.js's crypto module +**Met. If someone wants to, they can use custom OpenSSL configurations, custom OpenSSL providers, or even custom dynamically linked OpenSSL builds to "configure" Node.js's crypto module** + +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto Keylengths](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_keylength) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1179650439) and [also](https://github.com/nodejs/security-wg/pull/954#discussion_r1223129515) +- [Follow up issue](https://github.com/nodejs/security-wg/issues/988) > The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto Working](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_working) > The default security mechanisms within the software produced by the project SHOULD 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** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto Weaknesses](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_weaknesses) + > The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto PFS](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_pfs) + > If the software produced by the project causes the storing of passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). See also OWASP Password Storage Cheat Sheet. **N/A** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto Password Storage](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_password_storage) + > The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Crypto Random](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#crypto_random) + ## Secured delivery against man-in-the-middle (MITM) attacks > The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) + > A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. -**Met** -https://github.com/nodejs/node#verifying-binaries +**Met. https://github.com/nodejs/node#verifying-binaries** + +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) ## Publicly known vulnerabilities fixed > There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. -**Met** +**Met. For Node.js dependencies we have a repository https://github.com/nodejs/nodejs-dependency-vuln-assessments/issues containing all the public CVEs that weren't addressed in the Node.js scope and all of them are assessed regularly.** + +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Vulnerabilities Fixed in 60 days](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#vulnerabilities_fixed_60_days) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1179651456) and [also](https://github.com/nodejs/security-wg/pull/954#discussion_r1223147346) +- [Follow up issue](https://github.com/nodejs/security-wg/issues/986) -For Node.js dependencies we have a repository https://github.com/nodejs/nodejs-dependency-vuln-assessments/issues containing all the public CVEs that weren't addressed in the Node.js scope and all of them are assessed regularly. > Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) + ## Other security issues @@ -356,46 +567,78 @@ For Node.js dependencies we have a repository https://github.com/nodejs/nodejs-d **Met** +Context: +- [CII Best Practices: Security](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#security) +- [CII Best Practices: Vulnerabilities Critical Fixed](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#vulnerabilities_critical_fixed) + # Analysis ## Static code analysis > At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. -**Met** -https://scan.coverity.com/projects/node-js +**Met. https://scan.coverity.com/projects/node-js** + +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) +- [CII Best Practices: Static Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#static_analysis) > It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. **Met** +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) + > All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. **Met** +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) +- [CII Best Practices: Static Analysis Fixed](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#static_analysis_fixed) + > It is SUGGESTED that static source code analysis occur on every commit or at least daily. **Met** +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1167970826) +- [Follow up issue](https://github.com/nodejs/security-wg/issues/985) + ## Dynamic code analysis > It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. -**Met** -Infrastructure for running several different dynamic analysis tools is provided by the project. See: https://github.com/nodejs/node/tree/master/tools +**Met. Infrastructure for running several different dynamic analysis tools is provided by the project. See: https://github.com/nodejs/node/tree/master/tools** + +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) +- [CII Best Practices: Dynamic Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#dynamic_analysis) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1197621044) > It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). -**Met** -valgrind for c++ +**Met. valgrind for c++** +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) +- [CII Best Practices: Dynamic Analysis Unsafe](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#dynamic_analysis_unsafe) +- [Team discussion](https://github.com/nodejs/security-wg/pull/954#discussion_r1179745283) > It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. **Met** +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) + > All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. -**Met** \ No newline at end of file +**Met** + +Context: +- [CII Best Practices: Analysis](https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/criteria.md#analysis) \ No newline at end of file