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 Passing level criteria. You can also view the Silver or Gold level criteria.

        

 Basics 13/13 ●

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

    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]

    Complete concepts and considerations are defined.


    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]

    The CONTRIBUTING and CODE_OF_CONDUCT files are complete and define the xway to obtain and provide feedbacks


    Enough for a badge!

    Habari juu ya jinsi ya kuchangia LAZIMA ieleze mchakato wa uchangiaji (kwa mfano, je! Maombi ya kuvuta yanatumika?) (URL required) [contribution]

    Projects on GitHub by default use issues and pull requests, as encouraged by documentation such as https://guides.github.com/activities/contributing-to-open-source/.


    Enough for a badge!

    Habari juu ya jinsi ya kuchangia INAPASWA kujumuisha mahitaji ya michango inayokubalika (k.m., rejeleo la kiwango chochote kinachohitajika cha usimbaji). (URL required) [contribution_requirements]

    https://github.com/outpost-os/sentry-kernel/blob/main/CONTRIBUTING.md

    The contribution requirements are explicitly defined.


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


    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]

    Non-trivial licenses directory file in repository: https://github.com/pthierry-ledger/sentry-kernel/tree/main/LICENSES.


  • Documentation


    Enough for a badge!

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

    Some documentation basics file contents found.


    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]

    The project being a kernel, the external interface is syscall-based. All syscalls are defined in https://outpost-sentry.readthedocs.io/en/latest/uapi/syscalls.html#syscall-definition The documentation build also delivers a man page for each syscall based on the corresponding UAPI interface documentation of the readthedoc format.


  • Other


    Enough for a badge!

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

    Given only https: URLs.


    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]

    GitHub supports discussions on issues and pull requests. Discord channel 'OutpostOS' dedicated to OutpostOS (including the Sentry kernel) is also ready.


    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]

    Overall project concepts, architecture and principles are defined in https://outpost-sentry.readthedocs.io/en/latest/index.html The documentation is written in English.


    Enough for a badge!

    The project MUST be maintained. [maintained]

    The project is actively maintained by Ledger SA for its next-level products, leaving the overall Operating System (including the kernel) as a fully Open-Source project.



(Advanced) What other users have additional rights to edit this badge entry? Currently: []



This project is relatively young, but aim to be a critical part of the overall highly secured Open-Source operating system that targets micro-controllers exclusively for high security products such as Ledger's ones.

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

    Repository on GitHub, which provides public git repositories with URLs.


    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]

    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]

    Milestoning is considered with respect for the semvers concept. New releases are made only when a milestone is reached, leaving interim version separated. Release publication requires test-farm based complete non-regression testing on multiple hardware targets.


    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]

    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]

    version numbering is using the semantic versioning model. While being in 0.x version, ABI violation is allowed, but starting with v1.0.0, any ABI violation will require a major number update. feature update and patches already respects semvers in the 0.x consecutive deliveries.


    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]

    releases are based on git tags through the github releasing model.


  • 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 : https://github.com/outpost-os/sentry-kernel/releases/tag/v0.2.2 Releases notes are based on automatic github release changelog generation, with proper formatting configured.


    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]

    The github security report model is activated. Any PR related to a CVE patch must be denoted "cve:" as defined in the CONTRIBUTING.md file. Moreover, the cve and security labels exists so that the release changelog generation automatically instanciate the CVE chapter with the corresponding updates


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

    https://github.com/outpost-os/sentry-kernel/blob/main/CONTRIBUTING.md As defined in the CONTRIBUTING file, bug reports can be submitted through github issues (or github discussions if needed)


    Enough for a badge!

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

    The Github issue tracker is used for tracking individual 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 being relatively young as an Open-Source project, no external bug reports has been delivered yet. Although all bug reports published are: - fixed through PR - associated to a milestone if moved forward to next release


    Barely 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 being relatively young as an Open-Source project, only a few months are covered.


    Enough for a badge!

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

    The usage of Github issues and security report allows archive of such events (https://github.com/outpost-os/sentry-kernel/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]

    The project describes the vulnerability reporting process (Github based) in https://github.com/outpost-os/sentry-kernel/blob/main/.github/SECURITY.md Security reporting is activated.


    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]

    All informations are defined in https://github.com/outpost-os/sentry-kernel/blob/main/.github/SECURITY.md


    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]

    The project has defined the usual 90 days embargo, as defined by projectzero for security reporing, and as such considers interact as soon as possible with the reporter.


  • Working build system


    Enough for a badge!

    Ikiwa programu iliyotengenezwa na mradi inahitaji ujenzi wa matumizi, mradi LAZIMA utoe mfumo wa kujenga ambao unaweza kujenga programu kiotomatiki kutoka kwa chanzo-msimbo. [build]

    Project is based on meson build system. Overall build and build options are considered at CI level and rebuilt for each PR.


    Enough for a badge!

    INAPENDEKEZWA kuwa zana za kawaida zitumike kujenga programu. [build_common_tools]

    We use standard tooling: - meson as a build system - Kconfig as a configuration system


    Enough for a badge!

    Mradi UNAPASWA kujengwa kwa kutumia zana za FLOSS pekee yake. [build_floss_tools]

    Only FLOSS are used for building.


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

    Bot unit testing and autotest build profile exists in order to validate the kernel behavior. The testing model is fully defined in https://outpost-sentry.readthedocs.io/en/latest/tests/index.html


    Enough for a badge!

    A test suite SHOULD be invocable in a standard way for that language. [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


    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]

    Multiple testing consideration are made: - unit testing with mocking of various kernel subcomponents : through the meson test target - autotest-based dynamic testing directly on-target (ARM thumb7(e)m and thumbv8m) : through the autotest profile build and run - noRTE and some behabior analysis using Frama-C formal proofness and contracts definition : through the meson test target


    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]

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


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

    Any new functionalty requires testing inclusion, starting with autotest fuzzer updates. formal proofness coverage is made automatical through fully random-based kernel inputs forge. Autotest aim to validate the requested behavior of the kernel, while Frama-C detect any newly included RTE.


    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]

    Any new functionality must have the autotest testing suite being updated accordingly. This is defined in the CONTRIBUTING document.


    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]

    test policy is fully documented in https://outpost-sentry.readthedocs.io/en/latest/tests/index.html (for unit testing and autotest) and in https://outpost-sentry.readthedocs.io/en/latest/proof/index.html for formal proofness.


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

    The project uses the meson build system warning_level=3


    Enough for a badge!

    The project MUST address warnings. [warnings_fixed]

    The project must not build with warnings (Werror usage). Only unit tests builds accept such case.


    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]

    No warning allowed for any target-related components (kernel, autotest, production-related tooling, Rust UAPI library)


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

    The overall secure software designed is controlled by: - previous French ANSSI embedded security expert - Ledger Dungeon laboratory (https://donjon.ledger.com/), responsible for product security design


    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]

    The same developers and security reviewers do hold this part of the security analysis.


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

    Programu iliyotengenezwa na mradi LAZIMA itumie, kwa chaguo-msingi, tu itifaki za kriptografia na mifumbo ambazo zimechapishwa hadharani na kukaguliwa na wataalam (ikiwa itifaki za kriptografia na mafumbo imetumika). [crypto_published]

    The sentry kernel itself, being a micro-kernel, do not hold cryptographic algorithm.


    Enough for a badge!

    Ikiwa programu iliyotengenezwa na mradi ni programu au maktaba, na kusudi lake la msingi sio kutekeleza usimbuaji, basi INAPASWA tu kuita programu iliyoundwa kihususa kutekeleza kazi za kielelezo; HAIPASWI kutekeleza-upya shughuli hiyo. [crypto_call]

    The sentry kernel itself, being a micro-kernel, do not hold cryptographic algorithm.


    Enough for a badge!

    Utendaji wote katika programu iliyotengenezwa na mradi ambayo inategemea usimbuaji LAZIMA iweze kutekelezwa kwa kutumia FLOSS. [crypto_floss]

    No cryptographically-related mechanism is stored in the kernel local tooling. the cryptography that is responsible for ensuring global project security (not being kernel-relative) is leaved to the Operating System SDK.


    Enough for a badge!

    Mifumo ya usalama ndani ya programu inayozalishwa na mradi LAZIMA itumie kwa msingi keylengths ambazo angalau zinakidhi mahitaji ya chini ya NIST kufikia mwaka wa 2030 (kama ilivyoelezwa mnamo 2012). LAZIMA iwe rahisi kusanidi programu ili keylengths ndogo zimezimwa kabisa. [crypto_keylength]

    The sentry kernel itself, being a micro-kernel, do not hold cryptographic algorithm.


    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]

    The sentry kernel itself, being a micro-kernel, do not hold cryptographic algorithm.


    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]

    The sentry kernel itself, being a micro-kernel, do not hold cryptographic algorithm.


    Enough for a badge!

    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi INAPASWA kutekeleza kwa ukamilifu usiri wa umbele ya itifaki za makubaliano ya funguo ili funguo la kipindi kilicho tokana na kikao cha vifungo muda-mrefu haziwezi kuridhi mabaya ikiwa mojawapo ya vifunguo vya muda-mrefu imeridhi mabaya katika usoni. [crypto_pfs]

    There is no forward secrecy notion as the software is for very small embedded systems only.


    Enough for a badge!

    Ikiwa programu iliyotengenezwa na mradi imesababisha uhifadhi wa nywila kwa minajili ya uthibitishaji ya watumiaji wa kutoka nje, nywila LAZIMA zihifadhiwe kwa mficho uliorudiarudia na chumvi kwa kila-mtumiaji kwa kutumia kanuni ya upanuaji (rudiarudia) wa funguo (k.m., Argon2id, Bcrypt, Scrypt, or PBKDF2). Ona pia Kurasadogo ya Uhifadhi wa Nywila la OWASP). [crypto_password_storage]

    There is no user (and thus password) notion as the kernel target small embedded systems.


    Enough for a badge!

    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi LAZIMA itoe funguo zote za kriptologia na nonces kwa kutumia kitengeneza cha nambari za bahati kuptia kriptologia salama, na ISIWEZE kufanya hivo kutumia vitengenezi zisizo salama kikriptologia. [crypto_random]

    The kernel delivers a rng API that do respects the FIPS-140-2 requirements, that include verification of the TRNG hardware backend output. This verification is verified through formal contracts that validate the FIPS-140-2 specific software-level verifications over KRNG hardware output.


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

    sources and documentation are using https. There is no SSH notion on-target


    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]

    Only https is used for both sources and website.


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

    No unpatched public vulnerability by now.


    Enough for a badge!

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

    We aim to fix as soon as possible any vulnerability as it is a major requirement in the usage of the kernel. Pro-active RTE research and behavior validation is also controlled through formal proofness and autotesting using test farm.


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

    GitGuardian is used in order to verify any credential leak


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

    Frama-C (https://frama-c.com/index.html) is used in order to cover overall kernel code, for UB, RTE and invalid functional behavior. Frama-C delivers coverage results. Typically, syscall coverage reaches approx. 92%.


    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]

    Through formal proofness, all UB and RTE are searched, Frama-C being a sound tool.


    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]

    All Frama-C relative red-alarm (effective RTE or UB) not being a false positive are fixed. Any autotest-related kernel fuzzing that do not match expected behavior is fixed as soon as found. No delivered vulnerability report received by now.


    Enough for a badge!

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

    static analysis is spawned in the CI each time a commit is made on any PR, and in the main branch push events.


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

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


    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]

    C RTE and UB are catched through formal proffness value analysis with Frama-C. There is no dynamic memory at micro-kernel level. UAPI is written in Rust.


    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]

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


    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]

    Any invalid dynamic autotest assertion requires fixes so that overall test suite is valid.



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