EdgeX Foundry

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 1226 is passing 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

    EdgeX Foundry™ is a vendor-neutral open source project building a common open framework for IoT edge computing. At the heart of the project is an interoperability framework hosted within a full hardware- and OS-agnostic reference software platform to enable an ecosystem of plug-and-play components that unifies the marketplace and accelerates the deployment of IoT solutions.

  • Prerequisites


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

  • Project oversight


    Mradi LAZIMA uwe na "bus factor" ya 2 au zaidi. (URL required) [bus_factor]

    Mradi LAZIMA uwe na angalau wachangiaji wawili wasiohusika. (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]

    Met via manual inspection.


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

    Using Git and GitHub



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

    EdgeX Foundry uses the default "good first issue" label. For example: https://github.com/edgexfoundry/edgex-go/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+



    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 required for edgexfoundry organization on GitHub



    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 with TOTP is supported by GitHub, but GitHub does not provide a mechanism to disallow SMS.


  • Coding standards


    Mradi LAZIMA uandike mahitaji yake ya kukagua msimbo, pamoja na jinsi ukaguzi wa nambari unafanywa, nini lazima ichunguzwe, na nini kinachohitajika ili ikubalike. (URL required) [code_review_standards]

    Should update the PR checklist to formalize code review guidelines. https://wiki.edgexfoundry.org/display/FA/Committing+Code+Guidelines



    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]

    Exceeds. EdgeX Foundry currently requires peer review of one person besides the author.


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

    Using vendoring for LTS. Blocked on validating silver level criteria for binary reproducibility. Need to devise a way to test of our Jenkins build system is deterministic (can test this but will overwrite the old nexus image need to save a copy)


  • Automated test suite


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

    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]

    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]

    go test --cover currently gets 47% on edgex-go. Will probably never meet this goal.



    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]

    go test --cover. Less than 80% branch 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]

    EdgeX Foundry supports secure protocols for network communication, but does not REQUIRE them for on-box communication. See the following architectural decision record: https://docs.edgexfoundry.org/2.2/design/adr/security/0015-in-cluster-tls/



    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]

    In places where TLS is used (Kong), TLSv1.3 is required.


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

    X-Content-Type-Options was not set to "nosniff". // X-Content-Type-Options was not set to "nosniff". // 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]

    Never yet done at a whole project level.



    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]

    Binaries: CGO binaries are compiled with linkmode external, PIC enabled, and fortify options (https://github.com/edgexfoundry/edgex-go/blob/main/Makefile) edgex-ui: Embedded web server sets browser security headers including Content Security Policy (CSP) General: Project uses dependabot to automatically upgrade dependencies


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

    Project is currently soliciting a contribution to add REST API fuzzing.



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

    Project is currently soliciting a contribution to add REST API fuzzing.



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 2017-08-30 18:34:37 UTC, last updated on 2022-11-15 16:56:19 UTC. Last achieved passing badge on 2022-04-21 22:53:08 UTC.

Back