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

        

 Basics 17/17 ●

  • Identification

    Open Metadata and Governance

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

    https://egeria.odpi.org/Community-Guide.html links to the developer resources page - https://egeria.odpi.org/developer-resources/Developer-Guidelines.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]

    The project uses the DCO. It is enforced in the PR process. See developer guide https://github.com/odpi/egeria/blob/master/developer-resources/why-the-dco.md


    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]

    This is defined in the Operations Guide: https://github.com/odpi/egeria/blob/master/Operations-Guide.md


    Enough for a badge!

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

    This is the link to the code of conduct: https://github.com/odpi/egeria/blob/master/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]

    This is defined in the Community Guide: https://github.com/odpi/egeria/blob/master/Community-Guide.md


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


    Enough for a badge!

    The project SHOULD have a "bus factor" of 2 or more. (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


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

    This is the roadmap: https://egeria.odpi.org/open-metadata-publication/website/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]

    This is the link to the documentation: https://egeria.odpi.org/. Key modules have their own design pages. This is an example of the repository serivces: https://egeria.odpi.org/open-metadata-implementation/repository-services/


    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 security defined at multiple levels. The metadata security module shows how this is set up and implemented: https://egeria.odpi.org/open-metadata-implementation/common-services/metadata-security/. There is also information on customising the platform itself which inclides security settings https://egeria.odpi.org/open-metadata-implementation/server-chassis/server-chassis-spring/


    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 tutorials including a 3 day course for new consumers/contributors: https://egeria.odpi.org/open-metadata-resources/open-metadata-tutorials/ This is linked to from the home page.


    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]

    The project uses GitHub pages to manage its documentation. This means the documentation is located with the code. The developer guide explains the responsiblity to maintain the documentation. There is a steady stream of doc updates in line with new code function. See the file index.md at the top of the git hub repository for Egeria. https://github.com/odpi/egeria. It is the file that creates the home page found at this URL https://egeria.odpi.org/


    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 documents new releases and badges on its website: * https://github.com/odpi/egeria * https://egeria.odpi.org/release-notes/

    New releases are announced on Slack as soon as they are ready and the LF publicises the release soon after it is available (but not guaranteed to be in 48 hours).

    All contributions are visible through the public git repositories


  • 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 project repository website is GitHub and the project website is gnerated from GitHub pages. The documentation is primarily text however there are images. These are labelled and include ALT text. There is also a text description accompanying the diagrams.

    All of Egeria's diagnostics use our Audit Log Framework (ALF) which is internationalized.
    https://egeria.odpi.org/open-metadata-publication/website/diagnostic-guide/

    We do not provide translations. However each log message and exception includes an English formatted message along with the parameter values and the message's unique message id. The unique Id points to an externalized message specification which includes a description to the system action and user response. This means a third party agent receiving these messages can translate them into another language if they have created the translated message specification.

    This section is not marked complete because Egeria has 2 UIs and there has been no accessibility testing on them.


    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]

    All messages go through the audit log framework that externalizes messages both for the audit log and for messages in exceptions. Every message has a unique identifier. Values that are inserted in the messages are stored in the exception or audit log record to allow the message to be reformatted in multiple languages. The project uses US-English as the default language.


  • 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 only store of passwords and certificates that the project holds is in our configuration documents. These are manged by a plug-in connector. The supplied default connector uses encryption for the whole document.


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

    The project has monthly releases. Modules go through a lifecycle. Released modules maintain backward compatibility to allow easy upgrading of the software. Modules in development may change and the work progresses but they are not available for production use.


  • Bug-reporting process


    Enough for a badge!

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

    The team use GitHub issues with labels and milestones to track issues - and their fixes: https://github.com/odpi/egeria/issues


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

    Vulnerability reporting is done through github issues: https://github.com/odpi/egeria/labels/security


    Enough for a badge!

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

    See https://github.com/odpi/egeria/blob/master/CodeQualitySecurity.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]

    This is described in the developer guidelines: https://github.com/odpi/egeria/blob/master/developer-resources/Developer-Guidelines.md


    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]

    The coding style is selected by the module owner.


  • 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 uses maven https://github.com/odpi/egeria/blob/master/pom.xml


    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]

    Developer debug support the log4j format is available for the buiild and runtime environment


    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]

    Dependency management is enabled in Maven.


    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]

    The project has a fully automated build using maven https://github.com/odpi/egeria/blob/master/pom.xml


  • 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 software is a standard Java Jar file. There is also a docker image on docker hub that provides a container environment: https://hub.docker.com/search?q=egeria&type=image


    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 installtion process - iti s installed by copying the files into the directory where the installer chooses.


    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]

    The project uses maven to build which meets this criteria. https://github.com/odpi/egeria/blob/master/pom.xml


  • Externally-maintained components


    Enough for a badge!

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

    This is the list of third party software https://github.com/odpi/egeria/blob/master/THIRD_PARTY.md


    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]

    This is a daily process. We run dependabot that constantly looks for potential upgrades - these are acted upon within a few days.


    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 is built on a connector framework that allows external dependencies to be swapped in and out through the configuration document. This is the link to the connector framework: https://github.com/odpi/egeria/tree/master/open-metadata-implementation/frameworks/open-connector-framework


    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 have an active program of dependency management: https://github.com/odpi/egeria/blob/master/developer-resources/Dependency-Management.md


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

    Automated UT and FVT are run on each PR request and daily on master.


    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]

    The appropriate test suite is updated when issues are found.


    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]

    Egeria supported a distributed ecosystem of metadata exchange. This means we need to have layers of testing. Our UTs focus on small components, the FVTs on client server interaction. However most of the coverage comes from larger test suites that run multiple communicating servers. These tests are not yet automated to run in the build because they take too long to run. This means we only have periodic checks of the code coverage. Once the larger tests are automated then the official code coverage will improve. At the moment iti s only covering UT and FVT.


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

    This is described in the developer guide. https://github.com/odpi/egeria/blob/master/developer-resources/Developer-Guidelines.md. We do not insist that the test cases are includes in the function PR. However they must be in place before the module moves to released status.


    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]

    https://github.com/odpi/egeria/blob/master/developer-resources/Developer-Guidelines.md


  • Warning flags


    Enough for a badge!

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

    We are using the maximum level for spotbugs.


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

    See https://github.com/odpi/egeria/blob/master/CodeQualitySecurity.md


  • 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 encryption used for the configuration documents is in a pluggable connector which can be switched through configuration if a vulnerability is detected. At this time of writing the mechanism in use by default is current.


    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 encryption used for the configuration documents is in a pluggable connector which can be switched through configuration if a vulnerability is detected.


    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 does not store end user/server credentials - they are managed by external key stores. There is some optionally configured authentication credentials in the configuration documents that may be needed by external plugin components.


    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]

    HTTPS is the default communication protocol


    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]

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


    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]

    Egeria's OMAG Server Platform uses certificates to send and receive requests. The project provides sample certificates to be used to simplify the developer experience. These should not be used in a production environment and we also provide a sample script to create certifciates for a specific deployment.

    https://egeria.odpi.org/open-metadata-implementation/admin-services/docs/user/omag-server-platform-transport-level-security.html


    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]

    The project does not send private information in the HTTP headers. Even when the tokens are sent in the header, this is after the certificate verification.


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

    Our release process is automated and the signing is embedded in that. The keys are private.


    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 how we mark our releases - see https://egeria.odpi.org/release-notes/ and https://github.com/odpi/egeria/releases


  • 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 project has standard input validation functions that are used on REST API calls.


    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]

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


    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]

    The threat model is largely determined by the deployment scenario and the consuming organization - however, as a project we are providing examples of threats and how to mitigate against them for organizations wishing to deploy Egeria. (https://egeria-project.org/guides/planning/security/overview/)

    A single assurance case would be misleading.


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

    FindSecBugs (OSS) plus SonarCloud


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



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