netdata

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 2231 is passing Here is how to embed it:

These are the Silver level criteria. You can also view the Passing or Gold level criteria.

        

 Basics 16/17 ●

  • Identification

    Real-time performance and health web monitoring, for Linux, FreeBSD and MacOS.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    https://github.com/netdata/netdata/blob/master/CONTRIBUTING.md#contributions-ground-rules contains the markdown version, https://docs.netdata.cloud/contributing/#contributions-ground-rules contains the generated HTML version


  • Project oversight


    Enough for a badge!

    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), 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) [dco]

    We use CLA Assistant and all users have to sign the Netdata Contributors License Agreement, as found here: https://cla-assistant.io/netdata/netdata


    Not enough for a badge.

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md


    Enough for a badge!

    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) [roles_responsibilities]

    Every part of the project is owned by at least two different people, who are fully responsible for all work in their respective areas. The list is available at https://github.com/netdata/netdata/blob/master/.github/CODEOWNERS


    Enough for a badge!

    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) [access_continuity]

    The github.com/netdata organization usually has a minimum of two and usually more than 5 users with the role "Owner". Some CI/CD keys are stored in passwords vaults accessible by the SRE team (minimum 2, usually 4+ people), who are further backed up by the company's CEO.

    Every part of the project is owned by at least two different people, who are fully responsible for all work in their respective areas. The list is available at https://github.com/netdata/netdata/blob/master/.github/CODEOWNERS


    Enough for a badge!

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

    Every part of the project is owned by at least two different people, who are fully responsible for all work in their respective areas. The list is available at https://github.com/netdata/netdata/blob/master/.github/CODEOWNERS


  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    https://www.netdata.cloud/roadmap/


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    https://my-netdata.io/infographic.html


    Enough for a badge!

    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) [documentation_security]

    https://learn.netdata.cloud/docs/deployment-in-production/security-and-privacy-design


    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    https://learn.netdata.cloud/docs/getting-started/


    Enough for a badge!

    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. [documentation_current]

    https://learn.netdata.cloud/


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    https://github.com/netdata/netdata#readme


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    Netdata has 3 user-facing functions:

    1. Configuration: We follow CI/CD practices where users need to edit configuration files. This is done via a terminal and users can have whatever accessibility tools their operating system provides, include screen zoom, custom colors, font sizes, text to speech tools, etc.

    2. Dashboards: The main goal of dashboards is to present charts with graphs on them. Netdata dashboards are web based. Given the complexity of this scope and its limiting factors, we have provided themes to allow users change to light and dark theme which also affects the colors of the charts, web browser zoom does work on Netdata dashboards, we do provide a lot of shortcuts for the most common operations (we can't support every action via keyboard, due to the amount of operations available), and web browser plugins for text input and text to speech can be used. There are still quite a few usability issues we are trying to improve.

    3. Documentation: The Netdata documentation is web based and already provides everything possible via web browser functions.


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    The text in the application is minimal. It is mainly charts, dimension and metric names, which shouldn't be translated. Since Netdata is web based, users can use the translate feature of their web browser to translate the minimal UI navigation text and its info lines to any language they need.


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store 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). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    Netdata does not store passwords


  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    The full version history is maintained, both as source code and as binary packages. We also issue detailed release notes with every release.


  • Bug-reporting process


    Enough for a badge!

    The project MUST use an issue tracker for tracking individual issues. [report_tracker]

    We use github issues: https://github.com/netdata/netdata/issues


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    We always give credit to reporters, like https://github.com/netdata/netdata/security/advisories/GHSA-xg38-3vmw-2978


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    https://github.com/netdata/netdata/security/policy


  • Coding standards


    Enough for a badge!

    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) [coding_standards]

    See https://learn.netdata.cloud/docs/improving-netdata---developers/#code-style


    Enough for a badge!

    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). [coding_standards_enforced]

    Each pull request may trigger one or more linters, depending on the languages used. The linter execution and results can be seen of every pull request. A PR can't be merged until the linter checks pass.


  • Working build system


    Enough for a badge!

    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). [build_standard_variables]

    See https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md


    Enough for a badge!

    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). [build_preserve_debug]

    See https://github.com/netdata/netdata/blob/master/daemon/README.md#debugging


    Enough for a badge!

    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). [build_non_recursive]

    We use automake and autoconf that automatically takes care of dependencies.


    Not enough for a badge.

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    We use automake and autoconf that automatically takes care of build order.


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    All the available options are documented in https://learn.netdata.cloud/docs/installation/ The Markdown source files for those documents are in github.com/netdata/netdata and accessible via the "Edit file" links in the HTML documents. The most common installation method is kickstart.sh, with the options documented in https://github.com/netdata/netdata/tree/master/packaging/installer


    Enough for a badge!

    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). [installation_standard_variables]

    We use automake and autoconf that automatically takes care of this.


    Enough for a badge!

    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. [installation_development_quick]

    We use automake and autoconf that automatically takes care of this.


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    Build dependencies are listed in https://github.com/netdata/netdata/blob/master/netdata.spec.in The Github dependency graph is available at https://github.com/netdata/netdata/network/dependencies


    Enough for a badge!

    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. [dependency_monitoring]

    We use dependabot: https://docs.github.com/en/code-security/dependabot/working-with-dependabot


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    We use git submodules, automake and autoconf that automatically takes care of this.


    Enough for a badge!

    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). [interfaces_current]

    We don't use any deprecated or obsolete functions and APIs.


  • Automated test suite


    Enough for a badge!

    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. [automated_integration_testing]

    All the automated tests we run are accessible on every pull request in Github. We use Github Actions for our CI/CD.


    Not enough for a badge.

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    When bugs are found at the critical components already covered by unit and stress tests, we always update the units and stress tests to cover new issues identified. In some cases where critical bugs are identified on components that did not have units test, we add unit tests on them.


    Not enough for a badge.

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]

  • New functionality testing


    Not enough for a badge.

    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. [test_policy_mandated]

    Not enough for a badge.

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]

  • Warning flags


    Enough for a badge!

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    Under development we always compile with (for gcc):

    CFLAGS="-O1 -ggdb -Wall -Wextra -Wformat-signedness -fstack-protector-all -DNETDATA_INTERNAL_CHECKS=1 -D_FORTIFY_SOURCE=2"


  • Secure development knowledge


    Enough for a badge!

    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). [implement_secure_design]

    See https://learn.netdata.cloud/docs/deployment-in-production/security-and-privacy-design In addition to what is mentioned in the document, access to the project in Github is protected by 2FA for all code owners.


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    Enough for a badge!

    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). [crypto_weaknesses]

    We rely on modern versions of OpenSSL.


    Enough for a badge!

    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. [crypto_algorithm_agility]

    We support configuration of crypto algorithms for HTTP API, Streaming, but we don't support it for ACLK.


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    The Netdata agent does not require authentication credentials to function. Credentials of other systems can be optionally entered in certain data collection configuration files, in order to query those systems. Where more secure methods than username/password are available to connect to such systems, Netdata supports those mentions. Users can update these credentials without code recompilation.


    Barely enough for a badge.

    The software produced by the project SHOULD 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 SHOULD 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). [crypto_used_network]

    The default Netdata installation permits unencrypted access to the user interface.


    Enough for a badge!

    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). [crypto_tls12]

    Netdata supports TLS version 1.3. See https://github.com/netdata/netdata/blob/master/web/server/README.md


    Enough for a badge!

    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). [crypto_certificate_verification]

    We fully support TLS and verify the certificates by default. Users can configure Netdata to skip certificate validation, if they decide to take the risk.


    Enough for a badge!

    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). [crypto_verification_private]

    Certificate verification precedes the sending of secure cookies.


  • Secure release


    Not enough for a badge.

    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). [signed_releases]

    Native packages for various distributions are signed. Static binary files and source archives and docker images are not signed.


    Barely enough for a badge.

    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. [version_tags_signed]

  • Other security issues


    Enough for a badge!

    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. [input_validation]

    The Netdata API is the only way a user can provide input to a Netdata agent. The API accepts very specific characters for each user configurable parameter and there an an extensive access list for IP based filtering.


    Unknown required information, not enough for a badge.

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    Unknown required information, not enough for a badge.

    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) [assurance_case]

  • Static code analysis


    Enough for a badge!

    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. [static_analysis_common_vulnerabilities]

    Several of the tools and static code analysis tools we use perform security analysis.

    For example:


  • Dynamic code analysis


    Enough for a badge!

    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) MUST 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). [dynamic_analysis_unsafe]

    We regularly use valgrind and we enforce its use before a release.



This data is available under the Creative Commons Attribution version 3.0 or later license (CC-BY-3.0+). All are free to share and adapt the data, but must give appropriate credit. Please credit Chris Akritidis and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Chris Akritidis.
Entry created on 2018-09-22 15:19:07 UTC, last updated on 2023-05-18 12:57:16 UTC. Last achieved passing badge on 2023-05-18 12:02:33 UTC.

Back