Zephyr Project

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 74 is gold Here is how to embed it:

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

        

 Basics 13/13 ●

  • Identification

    The Zephyr Project is a small, scalable real-time operating system for use on resource-constrained systems supporting multiple architectures. Developers are able to tailor their optimal solution. As a true open source project, the community can evolve the Zephyr Project to support new hardware, developer tools, sensor and device drivers. Advancements in security, device management capabilities, connectivity stacks and file systems can be easily implemented.

    What programming language(s) are used to implement the project?

  • Basic project website content


    Enough for a badge!

    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    https://www.zephyrproject.org/ -- on the landing page.


    Enough for a badge!

    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    https://www.zephyrproject.org/community/ - The project provides multiple channels to communicate and includes a GitHub instance to track development and report bugs. https://github.com/zephyrproject-rtos/zephyr/issues


    Enough for a badge!

    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]

    https://www.zephyrproject.org/community/#community-guidelines


    Enough for a badge!

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

    https://docs.zephyrproject.org/latest/contribute/index.html -- Require contributors to adhere to specific coding styles and guidelines outlined in the project documentation.


  • FLOSS license

    What license(s) is the project released under?


    Enough for a badge!

    The software produced by the project MUST be released as FLOSS. [floss_license]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI). https://opensource.org/licenses/Apache-2.0 The Apache-2.0 license is approved by the Open Source Initiative (OSI).


    Enough for a badge!

    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).


    Enough for a badge!

    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]

    https://github.com/zephyrproject-rtos/zephyr/releases -- Has tags of each release, including source code, with licensing information included An overview of the releases can be found on https://www.zephyrproject.org/developer-resources/#current-release


  • Documentation


    Enough for a badge!

    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    https://docs.zephyrproject.org/latest/


    Enough for a badge!

    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]

    This section describes the major features of the Zephyr and how to use them. https://docs.zephyrproject.org/latest/guides/index.html Also include an application development primer: https://docs.zephyrproject.org/latest/application/index.html


  • Other


    Enough for a badge!

    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    https://github.com/zephyrproject-rtos/zephyr https://www.zephyrproject.org


    Enough for a badge!

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

    Have multiple channels of communication, GitHub, Discord, Mailing lists, etc. For further details, see https://www.zephyrproject.org/community/#connect


    Enough for a badge!

    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    https://github.com/zephyrproject-rtos/zephyr/issues


    Enough for a badge!

    The project MUST be maintained. [maintained]


(Advanced) What other users have additional rights to edit this badge entry? Currently: [1548, 2234, 2235, 5121, 10009]



  • Public version-controlled source repository


    Enough for a badge!

    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    https://github.com/zephyrproject-rtos/zephyr


    Enough for a badge!

    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    It's a GitHub Repository with Git Issues for issue tracking. Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.


    Enough for a badge!

    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    https://github.com/zephyrproject-rtos/zephyr/releases


    Enough for a badge!

    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    https://github.com/zephyrproject-rtos/ -- Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


    Enough for a badge!

    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    https://github.com/zephyrproject-rtos/zephyr/releases


    Enough for a badge!

    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]

    Enough for a badge!

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

    https://www.zephyrproject.org/developer-resources/#current-release


  • Release notes


    Enough for a badge!

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

    example release note: https://github.com/zephyrproject-rtos/zephyr/releases


    Enough for a badge!

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

    https://github.com/zephyrproject-rtos/zephyr/releases


  • Bug-reporting process


    Enough for a badge!

    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    Project has both GitHub Issues and public mailing lists. https://github.com/zephyrproject-rtos/zephyr/issues , lists.zephyrproject.org


    Enough for a badge!

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

    https://github.com/zephyrproject-rtos/zephyr/issues


    Enough for a badge!

    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    The project has a Technical steering committee that works on reviewing and prioritizing the development work. There is a security subcommittee to address security issues.


    Enough for a badge!

    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    The project has a Technical steering committee that works on reviewing and prioritizing the development work.


    Enough for a badge!

    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    Mailing lists have public archives and the GitHub instance. https://github.com/zephyrproject-rtos/zephyr/issues


  • Vulnerability report process


    Enough for a badge!

    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    Has a security issues and reporting in the readme.rst -- https://github.com/zephyrproject-rtos/zephyr/ http://docs.zephyrproject.org/security/security-overview.html


    Enough for a badge!

    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    https://docs.zephyrproject.org/latest/security/reporting.html#introduction

    Private vulnerability reports are supported and encouraged, bellow is one report done by NCCgroup https://research.nccgroup.com/wp-content/uploads/2020/05/NCC_Group_Zephyr_MCUboot_Research_Report_2020-05-26_v1.0.pdf


    Enough for a badge!

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

    We have a security working group that receives the reports and the team is supposed to respond within 7 days.


  • Working build system


    Enough for a badge!

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

    The project provides SDK -- https://github.com/zephyrproject-rtos/sdk-ng/releases


    Enough for a badge!

    It is SUGGESTED that common tools be used for building the software. [build_common_tools]

    We provide SDK -- https://github.com/zephyrproject-rtos/sdk-ng And Documentation for developers to get started at https://docs.zephyrproject.org/latest/index.html


    Enough for a badge!

    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    This is open source project build with and on open source development tools. Here are the instructions to getting setup with your development environment: https://docs.zephyrproject.org/latest/getting_started/index.html


  • Automated test suite


    Enough for a badge!

    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    Twister tool that's part of the source code,runs all the test for the supported boards and platforms. The build system also runs this sanity check. https://github.com/zephyrproject-rtos/zephyr/tree/main/tests


    Enough for a badge!

    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    python script that is called to run test cases written in standard C. see https://github.com/zephyrproject-rtos/zephyr/blob/main/CONTRIBUTING.rst (twister)


    Barely enough for a badge.

    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    This is a work in progress


    Enough for a badge!

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

    https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml?query=branch%3Amain


  • New functionality testing


    Enough for a badge!

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

    This process is established by the core development team and outlined in the documentation. http://docs.zephyrproject.org/index.html


    Enough for a badge!

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

    This is documented in the commit logs and pull requests. https://github.com/zephyrproject-rtos/zephyr/issues


    Enough for a badge!

    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    https://github.com/zephyrproject-rtos/zephyr/blob/main/CONTRIBUTING.rst


  • Warning flags


    Enough for a badge!

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

    Yes, Uses gcc warning - defaults to ----, build system supports 3 levels of warnings make W=1, -W=2, W=3.


    Enough for a badge!

    The project MUST address warnings. [warnings_fixed]

    Build system generates warnings and fails until it's fixed.


    Enough for a badge!

    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    Build system statically compiles and fails when met with warnings. CI also catch potential issues before being accepted into the code.


  • Secure development knowledge


    Enough for a badge!

    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]

    We have a security sub committee dedicated to monitoring and ensuring security best practices are followed.


    Enough for a badge!

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

    We have a security team comprising of experts in the space.


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

    Application uses PSA Crypto or mbedTLS libraries to manage cryptography with members of security working group actively participating in these projects.


    Enough for a badge!

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

    Uses mbedTLS https://github.com/ARMmbed/mbedtls


    Enough for a badge!

    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    Enough for a badge!

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

    SHA-256: Type of primitive: Hash function. Standard Specification: NIST FIPS PUB 180-4. Requires: – HMAC-SHA256: Type of primitive: Message authentication code. Standard Specification: RFC 2104. Requires: SHA-256 HMAC-PRNG: Type of primitive: Pseudo-random number generator. Standard Specification: NIST SP 800-90A. Requires: SHA-256 and HMAC-SHA256. AES-128: Type of primitive: Block cipher. Standard Specification: NIST FIPS PUB 197. Requires: – AES-CBC mode: Type of primitive: Encryption mode of operation. Standard Specification: NIST SP 800-38A. Requires: AES-128. AES-CTR mode: Type of primitive: Encryption mode of operation. Standard Specification: NIST SP 800-38A. Requires: AES-128. AES-CMAC mode: Type of primitive: Message authentication code. Standard Specification: NIST SP 800-38B. Requires: AES-128. AES-CCM mode: Type of primitive: Authenticated encryption. Standard Specification: NIST SP 800-38C. Requires: AES-128. ECC-DH: Type of primitive: Key exchange. Standard Specification: RFC 6090. Requires: ECC auxiliary functions (ecc.h/c). ECC-DSA: Type of primitive: Digital signature. Standard Specification: RFC 6090. Requires: ECC auxiliary functions (ecc.h/c).


    Enough for a badge!

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

    Enough for a badge!

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

    There are no default usages for weak crypto, SSH is not being used and is not supported.


    Enough for a badge!

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

    Enough for a badge!

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

    Statically compiled binary, no user login.


    Enough for a badge!

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

    In embedded environment, there is a dependency on hardware entropy sources.
    Our sample applications show how to leverage the drivers.


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


    Enough for a badge!

    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    Uses Git and hashes. Project pages https.


    Enough for a badge!

    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

  • Publicly known vulnerabilities fixed


    Enough for a badge!

    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    https://docs.zephyrproject.org/latest/security/vulnerabilities.html


    Enough for a badge!

    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    We have well documented survivability plan for the zephyr project and SDK. This will be part of the security working groups process.


  • Other security issues


    Enough for a badge!

    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    The Zephyr Project does not distribute any credentials, but does work with MCUboot. The MCUboot bootloader is distributed with a small number of development keys that are checked into the project’s repository. The instructions (https://mcuboot.com/imgtool.html) in the project clearly state that these keys are only for development, and private keys used for production need to be protected.


  • Static code analysis


    Enough for a badge!

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

    We use Coverity tied to weekly builds. Security working group will determine future process that will include static analysis.


    Enough for a badge!

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

    Coverity (https://www.synopsys.com/software-integrity/security-testing/static-analysis-sast.html) is used for static code analysis.


    Enough for a badge!

    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]

    They are logged as issues and resolved before release.


    Enough for a badge!

    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    We don't do daily builds. Builds are completed on a weekly basis as part of CI, and run through coverity.


  • Dynamic code analysis


    Enough for a badge!

    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    GCOV and ASAN are used.


    Enough for a badge!

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

    Software is not application-level.


    Enough for a badge!

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

    Assertions are enabled during test builds. There are "many" assertions in the code that are checked by this.


    Enough for a badge!

    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]

    Software is not application-level. Any CVEs found via static code analysis or responsible disclosure channels are dealt with promptly.



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 Brett Preston and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Brett Preston.
Entry created on 2016-03-10 17:42:23 UTC, last updated on 2024-06-05 17:27:55 UTC. Last lost passing badge on 2018-03-10 20:49:56 UTC. Last achieved passing badge on 2018-03-10 20:50:26 UTC.

Back