Sentry secure embedded kernel for Outpost Operating system

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 9667 is silver Here is how to embed it:

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

        

 Basics 4/5

  • Identification

    The Sentry kernel is a high security level micro-kernel implementation made for high security embedded systems that include micro-controllers in association with dedicated Secure Element component for security cryptographic functions.

  • Prerequisites


    The project MUST achieve a silver level badge. [achieve_silver]

  • Project oversight


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

    The project MUST have at least two unassociated significant contributors. (URL required) [contributors_unassociated]

  • Other


    The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file]

    SPDX required everywhere, tested through REUSE


  • Public version-controlled source repository


    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.



    The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks]


    The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. [require_2FA]

    2FA is imposed at organisation level



    The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. [secure_2FA]

    2FA is Security-key based only


  • Coding standards


    The project MUST document its code review requirements, including how code review is conducted, what must be checked, and what is required to be acceptable. (URL required) [code_review_standards]


    The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion [two_person_review]

    Any pull request is reviewed by at least one owner (required by repository configuration). The PR author can't be the reviewer.


  • Working build system


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

    reproductible build is imposed with meson. RO sources, no usage of unreproductible patterns or values. See https://mesonbuild.com/Reproducible-builds.html for description


  • Automated test suite


    A test suite MUST be invocable in a standard way for that language. (URL required) [test_invocation]

    As meson is used, test targets are generated through meson build system in the way test manipulation is defined. See https://github.com/outpost-os/sentry-kernel/blob/main/kernel/tests/meson.build for root automatic test definition for standard test target



    The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. (URL required) [test_continuous_integration]

    autotest and formal proofness is made in ordrer to cover all the kernel through its runtime inputs (entrypoint, syscall, interrupts handlers, etc.) so that the kernel is covered with various inputs values including corrupted one, using the Frama-C evaluated values model (https://frama-c.com/fc-plugins/eva.html).



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

    Coverage through formal proofness noRTE & UB detection delivers coverage. Coverage has reached 90% coverage of kernel entrypoints (reset, syscalls, ticker)



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

    Coverage through formal proofness noRTE & UB detection delivers coverage. Coverage has reached 90% coverage of kernel entrypoints (reset, syscalls, ticker). Formal proof coverage considers instruction level coverage.


  • 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.

    The software produced by the project MUST support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 MUST be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    This is a micro-kernel, no cryptographic related implementation



    The software produced by the project MUST, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    This is a micro-kernel, no cryptographic related implementation


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


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

    both https://outpost-sentry.readthedocs.io/en/latest/index.html and https://github.com/outpost-os/sentry-kernel/tree/main are HTTPS based with proper configuration // One or more of the required security hardening headers is missing.


  • Other security issues


    The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. [security_review]

    A complete security review of the specifications has been made. Security design has been published to a security conference (SSTIC'24) and Ledger Donjon team regularly check the source code.



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

    A lot of hardening principle has been added, as defined in https://outpost-sentry.readthedocs.io/en/latest/concepts/security.html and has already published article defining all security-related properties: https://www.sstic.org/2024/presentation/once_upon_a_time_in_iot_an_industry-grade_os_perspective_for_iot_security/


  • Dynamic code analysis


    The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. [dynamic_analysis]

    Kernel autotest mode (see https://outpost-sentry.readthedocs.io/en/latest/tests/autotest.html) is used for dynamic testing.



    The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. [dynamic_analysis_enable_assertions]

    autotest is an assertion-based dynamic testing tool for the micro-kernel.



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Philippe Thierry and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Philippe Thierry.
Entry created on 2024-11-06 08:11:36 UTC, last updated on 2024-11-06 13:14:47 UTC. Last achieved passing badge on 2024-11-06 10:20:04 UTC.

Back