OperatorFabric Core

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 4806 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 3/5 ●

  • Identification

    OperatorFabric is a modular, extensible, industrial-strength platform for use in electricity, water, and other utility operations. It aims to facilitate operational activities for utilities in two ways: - Centralize real time business events in a single place to avoid having multiple screens/software solutions - Facilitate interactions between operational control centers

    This repository contains the OperatorFabric core program.

  • Prerequisites


    Not enough for a badge.

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

  • Project oversight


    Enough for a badge!

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

    Bus factor of 2 using https://github.com/JetBrains-Research/bus-factor-explorer


    Unknown required information, not enough for a badge.

    Mradi LAZIMA uwe na angalau wachangiaji wawili wasiohusika. (URL required) [contributors_unassociated]

  • Other


    Enough for a badge!

    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]

    The SPDX tags are included in the copyright templates (https://github.com/opfab/operatorfabric-core/tree/develop/src/main/headers)


  • Public version-controlled source repository


    Enough for a badge!

    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


    Enough for a badge!

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

    We use a "Good first issue" label on issues (https://github.com/opfab/operatorfabric-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Coding standards


    Unknown required information, not enough for a badge.

    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]

    Enough for a badge!

    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]

    See https://opfab.github.io/documentation/current/security/#_code_analysis


  • Working build system


    Enough for a badge!

    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]

    Information to build locally the application --> https://opfab.github.io/documentation/current/dev_env/ The application is as well build via github actions


  • Automated test suite


    Enough for a badge!

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

    The tests are invoked by the appropriate Gradle task for the subproject or the corresponding Angular cli command.

    See https://github.com/opfab/operatorfabric-core/blob/develop/build.gradle


    Enough for a badge!

    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 builds including tests running on Travis CI (https://travis-ci.com/github/opfab/operatorfabric-core).


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

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

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Secured delivery against man-in-the-middle (MITM) attacks


    Not enough for a badge.

    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".


  • Other security issues


    Enough for a badge!

    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]

    A security audit has be conducted on 2024 on behaf of OSTIF The results are available here : https://ostif.org/wp-content/uploads/2024/08/24-06-1685-REP_OSTIF-OperatorFabric-2.pdf


    Enough for a badge!

    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]

    The following hardening mechanism are available : - Automatic Security tests - Access control mechanism - Input validation - Security analysis via sonarCloud : https://sonarcloud.io/summary/overall?id=org.lfenergy.operatorfabric%3Aoperatorfabric-core - Dependency vulnerability check via Mend Bolt for GitHub - Container scanning via Anchore


  • Dynamic code analysis


    Not enough for a badge.

    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]

    We do not have any dynamic analysis tool. We have an automated test suite with around 80% code coverage and 70% branch coverage, and the inputs used in tests are random when possible.


    Unknown required information, not enough for a badge.

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

    Warning: Requires lengthier justification.



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Alexandra Guironnet and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Alexandra Guironnet.
Entry created on 2021-04-15 15:12:01 UTC, last updated on 2024-11-06 16:22:49 UTC. Last achieved passing badge on 2023-11-29 14:32:24 UTC.

Back