egeria

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 3044 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 5/5

  • Identification

    Open Metadata and Governance

  • Prerequisites


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

  • Project oversight


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

    The project has a core team of 10 + contributors who have been with the project since its inception. There is a good span of modules that have multiple contributors who can maintain the code. https://github.com/odpi/egeria/graphs/contributors



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

    The community is pretty collaborative so there are no separate factions. However there are major contributions from people employed by IBM, ING and SAS: https://github.com/odpi/egeria/graphs/contributors


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

    We use SPDX tags to show license


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

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



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

    The project uses the label "good first issue" when these types of tasks are identified. See https://github.com/odpi/egeria/labels/good%20first%20issue



    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]

    GitHub enforces this ...



    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]

    Github enforces this ...


  • Coding standards


    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]

    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]

    We have a code owners who are notified when changes are made to the code. Significant changes are discussed on the developer calls. Many maintainers always ask for a review when they are making changes.


  • 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 project uses maven to probide a reproducible build: https://github.com/odpi/egeria/blob/master/pom.xml


  • Automated test suite


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

    It is invokable as part of a standard Maven build process. https://github.com/odpi/egeria/blob/master/pom.xml



    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 CI/CD pipeline that triggers a build on each commit and tests are automatic run. See: https://github.com/odpi/egeria/pulls



    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]

    Egeria modules go through a lifecycle that has 4 levels: In Development Technical Preview (optional) Released Deprecated

    See https://egeria.odpi.org/open-metadata-publication/website/content-status/

    While a module is in in-development status there are no test requirements. This is to ensure that new code capability is share quickly and often, allowing ongoing review of code.

    As the module matures and moves to tech-preview, there is an expectation that it is reasonably well tested with UT and FVT automated tests running in the build.

    At the released status, our modules have test cases that take them to 90% statement coverage. However we do not have an automated way to run both the Conformance Test Suite and the labs. These tests are run manually at each release (one per month). Because of this, we do not have a systematic capture of covernance statistics at the moment.



    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]

    Egeria modules go through a lifecycle that has 4 levels: In Development Technical Preview (optional) Released Deprecated

    See https://egeria.odpi.org/open-metadata-publication/website/content-status/

    While a module is in in-development status there are no test requirements. This is to ensure that new code capability is share quickly and often, allowing ongoing review of code.

    As the module matures and moves to tech-preview, there is an expectation that it is reasonably well tested with UT and FVT automated tests running in the build.

    At the released status, our modules have test cases that take them to 80% statement coverage. However we do not have an automated way to run both the Conformance Test Suite and the labs. These tests are run manually at each release (one per month). Because of this, we do not have a systematic capture of covernance statistics at the moment.


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

    HTTPS is the default communication protocol



    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]

    TLS is at latest available level - not sure what link to show this?


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

    The project content such as source code and website are delivered by well-known secure GitHub services. In regards to the static website, we have applied security hardening where possible: (1) Configured "Content-Security-Policy" via http-equiv meta directive for the static index.html page; (2) Configured "Strict-Transport-Security" response header on the GitHub Pages web server. // X-Content-Type-Options was not set to "nosniff".


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

    The project has a security team that meets each week and reviews security scans. The Egeria code was subject to a penetration test when ING started running it in production.



    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]

    Lint is enabled in both in Java and JS. Also CodeQL is run for every change. https://github.com/odpi/egeria/security


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

    This is the description of the texting conducted by the project: https://github.com/odpi/egeria/blob/master/CodeQualitySecurity.md



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

    The code has runtime assertions for testing parameters - these call our exception and audit log framework. The developers also use IntelliJ that is continually performing analysis on the code and detecting null pointer exceptions etc



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 Mandy Chessell and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Mandy Chessell.
Entry created on 2019-08-08 14:24:18 UTC, last updated on 2022-12-20 12:06:18 UTC. Last achieved passing badge on 2020-08-20 09:29:41 UTC.

Back