heimdall

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 7738 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 2/5

  • Identification

    A cloud native Identity Aware Proxy and Access Control Decision service

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

    Not given as there is mainly just one main contributor to the project. Nevertheless care is taken to establish a community around it. So, hopefully the situation will change in the near future.



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

    Unfortunately not yet given


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

    Each source code file has a copyright header including the SPDX-License-Identifier


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

    Planned tasks are available under https://github.com/dadrus/heimdall/issues Other topics and ideas can be discussed in Discord or via GitHub Discussions, which can result in new tasks.



    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]

    This is enforced by GitHub used to host the project



    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]

    Actually depends on the options offered by GitHub. As of today a TOTP and Fido2 based factors are used in addition to a password


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

    This is part of the PR template: https://raw.githubusercontent.com/dadrus/heimdall/main/.github/pull-request-template.md The actual review is automated by running all test and analysis tools on one hand incl automated comments if issues are detected. On the other hand all PRs are reviewed manually by the project owner and if possible by the main contributors.



    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]

    The PRs are only merged if approved by the project owner. Contribution author cannot merge into main or create new releases.


  • 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]
  • Automated test suite


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

    Part of the code base. So, look for files ending with _test.go in the repository (https://github.com/dadrus/heimdall/tree/main/internal)



    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]

    This is automated via PRs. See the CI configuration of the project: https://github.com/dadrus/heimdall/blob/main/.github/workflows/ci.yaml



    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]

    Current coverage is 90% See: https://codecov.io/gh/dadrus/heimdall



    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]

    Given. The current coverage is 90% See: https://codecov.io/gh/dadrus/heimdall


  • 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 software is for HTTP(s) related use cases only. As such it supports TLS, but does not allow usage of TLS versions prior to v1.2. For TLSv1.2 only the usage of secure PFS TLS ciphers is possible



    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]

    Only TLSv1.2 and TLSv1.3 are supported with only a handful PFS based ciphers considered secure.


  • 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 possible hardening headers are set by GitHub, respectively Docker Hub. Since all published artifacts are signed, this introduces an additional measure against MITM attacks. See also https://dadrus.github.io/heimdall/dev/docs/operations/security/#_verifying_heimdall_binaries_and_container_images // 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]

    This is met on the level of used SAST and SCA tools and actually also by those, who contribute to the project, respectively use it. Nevertheless, no separate/independent review has been performed. Note however that the owner of the project does such reviews professionally.



    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]

    This is achieved by following the secure by default principles, delivering a container image configured to not run the process as root and providing deployment options which drop all privileges.

    Warning: URL required, but no URL found.


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

    The configuration of dast tools highly depends on the end usage scenarios. It is almost impossible to cover all possible cases related to integration options.



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

Project badge entry owned by: Dimitrij Drus.
Entry created on 2023-08-12 01:23:38 UTC, last updated on 2025-03-04 23:10:11 UTC. Last achieved passing badge on 2023-08-12 20:23:06 UTC.

Back