Grid eXchange Fabric (GXF): formerly known as the Open Smart Grid Platform

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 4104 is silver 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

    Grid eXchange Fabric (GXF) allows to monitor and control hardware in the public space. It's an open, generic, scalable and independent IoT platform!

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

    Documentation on code guidelines can be found here: https://documentation.gxf.lfenergy.org/opensourcecommunity/contributing-to-the-code.html


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

    We ask each of our contributors to sign our contributor license agreement (CLA). For more information see: https://documentation.gxf.lfenergy.org/opensourcecommunity/contributing-to-the-code.html


    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]

    The project has a governance structure in place. For more information see: https://documentation.gxf.lfenergy.org/opensourcecommunity/governance.html


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    The project has a code of conduct. For more information see: https://documentation.gxf.lfenergy.org/opensourcecommunity/code-of-conduct.html


    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]

    The project has a governance structure in place with cleary discribed roles. For more information see: https://documentation.gxf.lfenergy.org/opensourcecommunity/governance.html & https://wiki.lfenergy.org/display/HOME/GXF+Community+Council


    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]

    The project has a governance structure in place with each key role filled in by at least two people. For more information see: https://documentation.gxf.lfenergy.org/opensourcecommunity/governance.html & https://wiki.lfenergy.org/display/HOME/GXF+Community+Council


    Enough for a badge!

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

    The project has a governance structure in place with each key role filled in by at least two people. For more information see: https://documentation.gxf.lfenergy.org/opensourcecommunity/governance.html & https://wiki.lfenergy.org/display/HOME/GXF+Community+Council


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

    The project has a documented roadmap. For more details see: https://wiki.lfenergy.org/display/HOME/GXF+Roadmap


    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]

    The project has a documented high level architecture. For more details see: https://wiki.lfenergy.org/display/HOME/GXF+Architecture & https://documentation.gxf.lfenergy.org/architecture/index.html


    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]

    The project has documented the security aspects. For more details see: https://documentation.gxf.lfenergy.org/architecture/non-functional-overview/security.html


    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]

    The project has a user guide. For more details see: https://documentation.gxf.lfenergy.org/userguide/index.html


    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]

    There is project in place for contributing to documentation. For more details see: https://documentation.gxf.lfenergy.org/opensourcecommunity/contributing-to-documentation.html


    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]

    The project repository and organisation page (https://github.com/OSGP) contain reference to the Best Practices Badge. So changes in the badge will become available right away.


  • 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 website is hosted by LF Energy and the documentation is hosted by gitbook. They should fully follow the best practices for accessibility.


    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]

    The GXF project isn't intented for end-users and doesn't contain a GUI.


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

    We use github and that meets this criterion.


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

    We use forward-only releases and create release versions only for hotfix deployments. We use gitflow branching strategy to support this methodology.


  • Bug-reporting process


    Enough for a badge!

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

    More information on this can be found here: https://documentation.opensmartgridplatform.org/Opensourcecommunity/Communication-and-contact.html


  • Vulnerability report process


    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]

    There has no vulnerabilities reported by external contributors.


    Enough for a badge!

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

    The project has process in place for reporting security issues. For more details see: https://documentation.gxf.lfenergy.org/opensourcecommunity/communication-and-contact.html


  • 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 has code guideslines in place. For more details see: https://documentation.gxf.lfenergy.org/opensourcecommunity/contributing-to-the-code.html


    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]

    Yes, the project uses a plugin in the Maven build to enfore the coding style.


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

    The project only has JVM 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]

    This is a standard part of the JVM bytecode.


    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 project uses Maven as build system where we explicit define what needs to be built.


    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]

    As long as the build enviroment stays the same, the build system that consists of Maven will produce the same result.


  • 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 developer guidelines are described in the gitbook on how to easily install the software. This should be sufficient to get started on the project.

    In the near future we will improve this by providing helm charts and/or a docker images as a way to easily install the GXF project based on containers.


    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]

    There is no installation system.


    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]

    There is a virtual box available for potential developers.


  • Externally-maintained components


    Enough for a badge!

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

    The dependencies are defined in project’s manifest files: https://github.com/OSGP/open-smart-grid-platform/network/dependencies


    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]

    The projects uses DependaBot and OWASP Dependency-Check.


    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]

    The project uses Maven and Maven clearly states all the dependencies (including versioning information).


    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]

    Due to SonarCloud scans and security scans within our CI/CD environment depricated code is identified very easlity. And are being resolved as a result.


  • 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 project uses Unit Tests and Cucumber. The results are reported during the build proces.


    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 part of the way of working of the project.


    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]

    Automated test suite is available and in use, but the requirement of 80% coverage is not met. Additional end-to-end tests (Cucumber) are in place where the code coverage is part of the business cases (FlexOVL, SMHE, DA) we build on top of GXF. The complete amount of tests lead to a very healty coverage for each business case.

    80% coverage is therefor not a realistic goal for GXF to achieve!


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

    These goals are part of the Gitbook documentation, see https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/contributing-to-the-code#guidelines.


    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]

    Documentation on code tests can be found here: https://documentation.opensmartgridplatform.org/Opensourcecommunity/ToolsguidelinesCI.html


  • Warning flags


    Enough for a badge!

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

    The project doesn't supress any warning on the java compiler and warning are visable in SonarCloud.


  • Secure development knowledge


    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]

    The project has a core principle: Secure-by-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]

    The network connections are TLS secure and enscryption is used for sensative information.


    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 cryptographic hash algorithm that is used is configurable.


    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]

    The project stores the authentication credentials and keys in separate and they can be updated wihout code recomplilation.


    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]

    The project uses TLS1.2 or later.


    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 uses TLS1.2 or later.


    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]

    The project uses TLS certificate verification 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]

    This depends on HTTPD by Apache.


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

    Release are not published publically. User can download the source code and build the release by following the instructions on gitbook (https://grid-exchange-fabric.gitbook.io/gxf/)


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

    This is not met yet.


  • Other security issues


    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]

    The interfaces require the existence of a server side certificate and all input is validated for the correct data format and that they don't contain any scripting.


    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]

    Vulnerability checks are part of the build process to validate vulnerabilities in used libraries. Code is being validated by SonarCloud. The used container images are also validated for all kinds of vulnerabilities. As we don't deploy VM's


    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]

    This is part of the scan executed by SonarCloud. Additionally there are several security related scan being executed, by LF Energy (https://security.lfx.linuxfoundation.org/#/a092M00001JWs7KQAT/overview) and our internal SIG measurements en SonalCloud scans (https://sonarcloud.io/project/overview?id=OSGP_open-smart-grid-platform)


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

    Documentation on used static code analysis: https://documentation.opensmartgridplatform.org/Architecture/Technical-overview/Technologystack.html


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

    Dynamic code analysis is not implemented.



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 Jonas van den Bogaard and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Jonas van den Bogaard.
Entry created on 2020-06-29 15:28:15 UTC, last updated on 2023-09-29 14:20:48 UTC. Last achieved passing badge on 2020-12-16 15:39:31 UTC.

Back