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

        

 Basics 4/5

  • 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


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

  • Project oversight


    The project MUST 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



    The project MUST have at least two unassociated significant contributors. (URL required) [contributors_unassociated]

    Currently there are several different projects that contribute to the GXF code base. These projects are:

    • FlexOVL (Alliander)
    • Smart Meter Head-End (Alliander)
    • Low Voltage Measurements (Alliander)
    • Cathodic Protection (Alliander) - in development

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

    License statement is added to all source code files and all other files as well.


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

    Source code is available on github (https://github.com/OSGP)



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

    Not public available, but part of our backlog on a closed Jira account.



    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 all github repo users - Not yet effectuated



    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 is required for all github repo users - Not yet effectuated SMS is still available


  • Coding standards


    The project MUST document its code review requirements, including how code review is conducted, what must be checked, and what is required to be acceptable. (URL required) [code_review_standards]

    The coding standards are part of our open source documentation, see https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/toolsguidelinesci



    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]

    In our standard Way of Work all code is being reviewed by another developer than the one that created the code. four-eyes principle is always in place.


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

    The build is available for Alliander employees only. The current continuous build environment (https://jenkins.fdp.osgp.cloud/view/Nightly%20Build/) is currently closed for the rest of the world. We are currently using Jenkins as our build environment, but we are moving to Github Packages and than it will become available to the rest of the community as well.


  • Automated test suite


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

    The test suit uses unit test to test the components and uses integration tests build with Cucumber to test end-to-end functionality as well. Build results are currently not publically available: https://jenkins.fdp.osgp.cloud/view/Nightly%20Build/



    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]

    We have a CICD build environment: https://jenkins.fdp.osgp.cloud/view/Nightly%20Build/ and all source code is also checked by SonarCloud: https://sonarcloud.io/project/overview?id=OSGP_open-smart-grid-platform



    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]

    Tool is available. No 90% coverage, but lower amount.



    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]

    Tool is available. No 80% coverage, but lower amount.


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

    The project uses TLS1.2 or later.



    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]

    The project uses TLS1.2 or later.


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

    All websites used by GXF are github (https://github.com/OSGP), gitbook (https://grid-exchange-fabric.gitbook.io/gxf/) en LF Energy (https://lfenergy.org/projects/gxf/). These websites seem to meet this requirement.


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

    Around 5 years ago the GXF software has been auditted by the Software Improvement Group (SIG) and currently Alliander is implementing the toolset of SIG in our CI/CD environment to execute the SIG tooling on a structural way.



    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]

    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


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

    Dynamic code analysis is not implemented.



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

    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