Home Edge Project in LF Edge (edge-home-orchestration-go)

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

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

        

 Basics 17/17 ●

  • Identification

    Home Edge Project, the seed codes will be contributed by Samsung Electronics, concentrates on driving and enabling a robust, reliable, and intelligent home edge computing open source framework, platform and ecosystem running on a variety of devices at daily home lives. To accelerate the deployment of the edge computing services ecosystem successfully, the Home Edge Project will provide users with an interoperable, flexible, and scalable edge computing services platform with a set of APIs that can also run with libraries and runtimes.

  • Prerrequisitos


    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://github.com/lf-edge/edge-home-orchestration-go/blob/master/.github/CONTRIBUTING.md https://github.com/lf-edge/edge-home-orchestration-go/blob/master/.github/PULL_REQUEST_TEMPLATE.md


  • Supervisión del proyecto


    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]

    The use of the contribution signature is documented in the contribution rules https://github.com/lf-edge/edge-home-orchestration-go/blob/master/.github/CONTRIBUTING.md#8-commit-your-changes and is also checked at each PR.


    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]

    Project governance model is described https://wiki.lfedge.org/pages/viewpage.action?pageId=1671336


    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://github.com/lf-edge/edge-home-orchestration-go/blob/master/.github/CODE_OF_CONDUCT.md


    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.lfedge.org/pages/viewpage.action?pageId=1671336


    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]

    There is no secret or similar owned by any single individual that risks hurting the project in case absent for a lot of time. We officially list up the delegates not as an individual, but a team rosters and this information is accessible in public with the proper email thread and documents in Wiki. More on that, we have a dedicate operator supported from Linux Foundation Edge team, who properly channel and handle any community items to be resolved in time.

    https://wiki.lfedge.org/pages/viewpage.action?pageId=1671336 https://github.com/lf-edge/edge-home-orchestration-go#quick-start-guides-for-supported-platforms


    Enough for a badge!

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

    We're having everything extensively documented and tested. There are no secrets. Referring to the different forms (one of: https://www.process.st/bus-factor/#how ) of calculating "bus factor" can be said with certainty that it is not less than 2.


  • 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.lfedge.org/display/HOME/Roadmap+and+Release+Notes


    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]

    https://wiki.lfedge.org/display/HOME/Home+Edge+Platform+Architecture


    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://github.com/lf-edge/edge-home-orchestration-go/blob/master/.github/SECURITY.md https://github.com/lf-edge/edge-home-orchestration-go/blob/master/docs/secure_manager.md


    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://github.com/lf-edge/edge-home-orchestration-go/blob/master/docs/platforms/x86_64_linux/x86_64_linux.md (for others platforms:https://github.com/lf-edge/edge-home-orchestration-go/blob/master/docs/platforms/)


    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]

    We constantly monitor all changes in the project and try to immediately adapt the documentation.


    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]

    https://github.com/lf-edge/edge-home-orchestration-go#readme


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

    The web site and documentation are plain text-based and don't require complexly UI things.


    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]

    This software is intended for IT-professionals for whom knowledge of the English language is not a problem.


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

    The project doesn't store any passwords.


  • Versiones anteriores


    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]

    Project always backwards compatible at all times.


  • Bug-reporting process


    Enough for a badge!

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

    We use the embedded issue tracker provided from GitHub. https://github.com/lf-edge/edge-home-orchestration-go/issues


  • Proceso de informe de vulnerabilidad


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    We have completed to resolve all the detected vulnerability from CodeQL and LGTM services and in the last 12 months, there have been no vulnerabilities resolved as of September 3rd, 2021.


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    https://github.com/lf-edge/edge-home-orchestration-go/blob/master/.github/SECURITY.md


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

    The project uses standard formatting for the Go language. It is also recommended for the user to run make fmt command that automatically fixes coding style errors. https://golang.org/doc/effective_go


    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]

    For each PR, the CI runs a coding style check (utilities are used: gofmt, vet, golint, staticcheck)


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

    We honor the relevant compiler and linker variables in our build script in https://github.com/lf-edge/edge-home-orchestration-go/blob/master/Makefile.


    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]

    debugging information isn't generated


    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]

    This is clearly configured in our build script in https://github.com/lf-edge/edge-home-orchestration-go/blob/master/Makefile.


    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]

    During the build, the date and time of its creation are included in the binary file. Hence the binary file will be different.


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

    The product is a docker image, hence the installation is done in a standard way for docker.


    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]

    The docker container can be launched from anywhere, and the configuration has a fixed location, since it is access control sensitive.


    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]

    Quick start guidance from: (with and without build option on various target platforms) https://github.com/lf-edge/edge-home-orchestration-go/blob/master/README.md


  • Externally-maintained components


    Enough for a badge!

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

    All dependencies are listed in the go.mod https://github.com/lf-edge/edge-home-orchestration-go/blob/master/go.mod


    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 monitor dependency updates carefully and update them as needed. (Ex. https://github.com/lf-edge/edge-home-orchestration-go/pull/357 )


    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]

    Using the go mod utility we can easily track external 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]

    We try to use new versions of components and that they comply with the FLOSS (Ex. https://github.com/lf-edge/edge-home-orchestration-go/pull/357 )


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

    The test suite is run for each PR https://github.com/lf-edge/edge-home-orchestration-go/actions/workflows/test-suite.yml


    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]

    This is usually procedure.


    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]

    Due to the multi-platform nature of project, it is very hard to reach. We're at 73.73% Total Coverage


  • New functionality testing


    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]

    "When adding or changing functionality, the main requirement is to include new tests as part of your contribution" from https://github.com/lf-edge/edge-home-orchestration-go/blob/master/docs/testing_policy.md#1-introduction


    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]

    "When adding or changing functionality, the main requirement is to include new tests as part of your contribution" from https://github.com/lf-edge/edge-home-orchestration-go/blob/master/docs/testing_policy.md#1-introduction


  • Banderas de advertencia


    Enough for a badge!

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

    The project includes code verification using many utilities (Sonar, lint, vet, staticcheck) that provide a high level of detection of remarks.


  • Conocimiento de desarrollo seguro


    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]

    We have a strong focus on open secure design principles


  • Use buenas prácticas criptográficas

    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]

    Security mechanisms that used in the project are independent of algorithms with known severe vulnerabilities.


    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]

    The project uses standard crypto-components that support a large number of algorithms.


    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]

    Authentication data and private keys that are generated during operation are stored separately from configuration files, logs and databases.


    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]

    SSHv2 and TLS 1.2 are used in the project. Normal (unsecure) mode (using http) is for beginner-level development and testing only.


    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]

    The project supports TLS 1.2 version


    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]

    In secure mode, the TLS certificate is checked by default


    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]

    In secure mode, the TLS certificate is checked by default


  • Secure release


    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]

    All our 5 releases are signed releases. And meets the OpenSSF ScoreCard project requirement.

    Updated status of ScoreCard: |---------|------------------------|--------------------------------| | 7 / 10 | CII-Best-Practices | badge detected: silver |

    |----------|------------------------|-------------------------------------| | 10 / 10 | Signed-Releases | 5 out of 5 artifacts are | | | | signed -- score normalized to | | | | 10 |


    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]

    All tags in the project are signed. https://github.com/lf-edge/edge-home-orchestration-go/tags


  • Otros problemas de seguridad


    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]

    A critical incoming parameter is a launched container, to control it there is a white list of containers (the key is a container hash). Only admin can to modify this white list.


    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]

    The features of the Go language, as well as the use of the compiler settings, have given the opportunity to get the following results after analysis by the hardering-check program. $ hardening-check edge-orchestration - edge-orchestration: Position Independent Executable: no, normal executable! Stack protected: yes Fortify Source functions: yes


    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]

    https://github.com/lf-edge/edge-home-orchestration-go/blob/master/.github/SECURITY.md


  • Análisis estático de código


    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]

    SonarCloud and vet are used.


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

    We use SonarCloud, CodeQL Analysis, golint, govet and Staticcheck as a stopgap. And are interested in implementing the above as it becomes available for 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 Peter Moonki Hong and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Peter Moonki Hong.
Entry created on 2020-10-13 10:36:31 UTC, last updated on 2022-05-27 06:08:33 UTC. Last achieved passing badge on 2021-02-08 02:43:12 UTC.

Back