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

        

 Basics 16/17 ●

  • 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


    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://wiki.edgexfoundry.org/display/FA/Contributor%27s+Guide The EdgeX project technical community has adopted the Google Style Guides for all programming languages.


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

    https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Guide#Contributor'sGuide-SubmissionDCO


    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]

    https://wiki.edgexfoundry.org/display/FA/Technical+Charter


    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://lfprojects.org/policies/code-of-conduct/ (EdgeX Foundry is a LF Edge subproject)


    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]

    https://wiki.edgexfoundry.org/display/FA/Technical+Work+in+the+EdgeX+Foundry+Project and https://wiki.edgexfoundry.org/display/FA/Release+Tsar and https://wiki.edgexfoundry.org/display/FA/Product+Manager


    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]

    https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=21823860 ("Contributors, Committers & Maintainers")


    Enough for a badge!

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

    AR: Bryon: Run the assessment tool and provide evidence. https://wiki.edgexfoundry.org/display/FA/Repository+creation%2C+ownership+and+access+rights


  • 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://wiki.edgexfoundry.org/display/FA/Roadmap and https://wiki.edgexfoundry.org/display/FA/Backlog


    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]

    Process: https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=73663048 ("Project Design/Architectural Decisions") Documentation: https://docs.edgexfoundry.org/2.2/ and https://docs.edgexfoundry.org/2.2/design/


    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://docs.edgexfoundry.org/2.2/security/Ch-Security/


    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://docs.edgexfoundry.org/2.2/getting-started/quick-start/


    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]

    Documentation is updated and versioned with each release.


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

    Pending work item: https://github.com/edgexfoundry/cd-management/issues/231


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

    Have run the Windows Narrator tool https://support.microsoft.com/en-us/windows/complete-guide-to-narrator-e4397a0d-ef4f-b386-d8ae-c172f109bdb1 on EdgeX documentation and project sites and the tool is able to successfully narrate the contents of the pages.


    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]

    China users agree that i18n support for device names is not important. edgex-ui is localizable, but has not yet been localized. EdgeX is a middleware framework and not an end user tool.


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

    Project uses github and for other authentication needs uses Linux Foundation SSO.


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

    See the EdgeX Foundry Long Term Support Policy https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=69173332


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

    https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Guide#Contributor'sGuide-CodeStyleGuides


    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]

    We run "go vet" and "go fmt" as part of CI process as well as a number of optional linters. Mandatory code reviews enforced by GitHub.


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

    While EdgeX does not meet the letter of the law, EdgeX C binaries use CMake, which has a special setting, CMAKE_BUILD_TYPE to specify debug or release builds. The guidance given here is not applicable for Golang binaries.


    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]

    We do not strip binaries prior to including them in our snaps or containers.


    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]

    Recursive make is not used in EdgeX Foundry and golang builds from source and doesn't depend on intermediate build artifacts.


    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]

    Golang binaries use best practices of using -trimpath to strip path information from resulting binaries. C binaries will produce same bits if compiled twice in a row, but some path info is still included.


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

    Snaps provide for clean install and uninstall. Docker releases use standard docker mechanisms to manage containers images.


    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]

    See standard conventions for snaps and docker.


    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]

    Snap build use standard snap build and test tools. Docker builds provide ready-to-run "make dev" infrastructure (https://github.com/edgexfoundry/edgex-compose). Project supports native "make test" test harness.


  • Externally-maintained components


    Enough for a badge!

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

    https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=21823866


    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 run Snyk regularly.


    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]

    Use Dependabot to flag out of date dependencies and partially automate updates. Project has a defined vetting process for 3rd party components. https://wiki.edgexfoundry.org/display/FA/Vetting+Process+for+3rd+Party+Dependencies


    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]

    Project uses linters that should catch deprecated usages.


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

    Each PR or each repository triggers automated builds and tests. There are tests on both x86/64 as well as ARM64 platforms. An example of the process inclusive of tests can be seen on each Jenkins pipeline log (https://jenkins.edgexfoundry.org/blue/organizations/jenkins/edgexfoundry%2Fedgex-go/detail/PR-4050/1/pipeline). The test results are then made available on line (example: https://jenkins.edgexfoundry.org/blue/organizations/jenkins/edgexfoundry%2Fedgex-go/detail/PR-4050/1/pipeline/185)


    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]

    The project runs Test Automation Framework (TAF) tests run nightly - providing 100% regression tests nightly. See https://github.com/edgexfoundry/edgex-taf.


    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]

    Test Automation Framework (TAF) tests provided automated functional, integration, and performance tests on both Go and C language code. Tests for GUI Javascript code (constituting less than 5% of the code base) have been developed but require manual kick off at this time, but will be automated in this release cycle. See https://github.com/edgexfoundry/edgex-taf/blob/main/docs/edgex-taf.md


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

    We don't have this today. It is unwritten rule, but we should and it should be added in this area of the Wiki: https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Guide


    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]

    https://wiki.edgexfoundry.org/display/FA/Committing+Code+Guidelines


  • Warning flags


    Enough for a badge!

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

    In Golang, all warnings are errors.


  • Secure development knowledge


    Unknown required information, not 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]

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

    Met via manual inspection.


    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]

    Where applicable, the project uses security suites with flexible algorithm negotiation methods, e.g. TLSv1.3.


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

    Can't currently replace e.g. redis password with one of your own choice later on. Can be handled with an enhancement.


    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]

    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/


    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]

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


    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]

    Where TLS server authentication is supported, EdgeX configuration files provide the ability to supply an appropriate CA certificate.


    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]

    Project assumes that the Golang TLS implementation behaves this way.


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

    Snaps are currently signed (Canonical has the key). Docker images are currently unsigned.


    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]

    Git labels are currently signed.


  • Other security issues


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

    Use built-in Golang JSON parsing validation for most objects/DTOs. Don't have any input fuzzing tests to confirm we don't have escapes. Unsure of field-level data validation (e.g. string formatted integers or floats on readings)


    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]

    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


    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]

    Was done a long time ago by Dell, but needs updating.


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

    https://sonarcloud.io/dashboard?id=edgexfoundry_edgex-go


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

    EdgeX is primarily written in Go



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