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

        

 Basics 17/17 ●

  • Identification

    A cloud native Identity Aware Proxy and Access Control Decision service

  • Prerrequisitos


    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]

    The requirements are provided in the contributing guide (https://github.com/dadrus/heimdall/blob/main/CONTRIBUTING.md), e.g. that the usage of golangci is mandatory. The corresponding checks are also part of the ci pipeline


  • Supervisión del proyecto


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

    This is not yet in place


    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]

    The project owner and lead makes all final decisions This is basically said in https://github.com/dadrus/heimdall/blob/main/CONTRIBUTING.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]

    https://github.com/dadrus/heimdall/blob/main/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]

    As of today, this is the project owner, which is also obvious from the code of conduct: https://github.com/dadrus/heimdall/blob/main/CODE_OF_CONDUCT.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 is an OSS project licensed under Apache 2.0 This way everybody can just fork the project and continue it. There are no key, passwords or alike required to do that. See also the Apache 2 license statement: https://github.com/dadrus/heimdall?tab=Apache-2.0-1-ov-file#readme


    Barely enough for a badge.

    The project SHOULD 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.


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

    The entire planning happens using GH FRs organized in milestones, with those FRs being of most interest addressed in first: https://github.com/dadrus/heimdall/milestones


    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]

    The first two sections of the documentation deal with architectural topics. The entry point is https://dadrus.github.io/heimdall/dev/docs/getting_started/discover_heimdall/, followed by the chapters in the "Concept" section: https://dadrus.github.io/heimdall/dev/docs/concepts/pipelines/


    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]

    There are multiple areas, where security is addressed: * The security policy addressing how to report vulnerabilities and when to expect related updates: https://github.com/dadrus/heimdall?tab=security-ov-file#readme * How to operate heimdall securely. This is addressed in the documentation mainly in: https://dadrus.github.io/heimdall/dev/docs/operations/security/


    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]

    https://dadrus.github.io/heimdall/dev/docs/getting_started/protect_an_app/

    In addition, there are examples showcasing some setups with Docker and Kubernetes: https://github.com/dadrus/heimdall/tree/main/examples


    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]

    A new documentation version is released together with each version of the project. Care is taken to have the documentation consistent with the available functionality. All PRs are expected to update the documentation if required (which is also part of the PR template).


    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]

    Available badges are shown on https://github.com/dadrus/heimdall, respectively in the displayed README.md


  • 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 is an API only software, which does not have any UIs.


    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]

    The project does not have any texts/UI intended for the end-users.


  • 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 project site does not store any password.


  • Versiones anteriores


    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]

    Older versions are not yet maintained due to the age of the project. The documentation of the upgrade path is addressed on PRs with breaking changes, which always describe, what has been changed and how to adopt these changes. This information is then available in the project change log, respectively on the release page: https://github.com/dadrus/heimdall/releases


  • Bug-reporting process


    Enough for a badge!

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

    https://github.com/dadrus/heimdall/issues


  • Proceso de informe de vulnerabilidad


    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]

    No vulnerabilities have been reported, respectively discovered manually so far. In general vulnerability management is automated by making use of corresponding SCA tools included into the security analysis and build pipelines


    Enough for a badge!

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

    https://github.com/dadrus/heimdall#security-ov-file


  • 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 addressed by making use of a special set of linters, which are required to be used by the contributors. This is described in the contribution guide (https://github.com/dadrus/heimdall/blob/main/CONTRIBUTING.md) and enforced in the build pipeline as soon as a PR is submitted (see also the configuration of the CI pipeline: https://github.com/dadrus/heimdall/blob/ecc1b33f5ff4f13d1c17afd24e388cf403d15053/.github/workflows/ci.yaml#L97)


    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]

    See the configuration of the CI pipeline: https://github.com/dadrus/heimdall/blob/ecc1b33f5ff4f13d1c17afd24e388cf403d15053/.github/workflows/ci.yaml#L97


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

    Addressed in the CI/CD pipeline, and also for local builds


    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]

    Debug information is removed from the resulting binaries as it is not required for productive use. There are however options in place to increase the log level to have more insights if required. A custom build with debug information preserved is however possible as well


    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]

    There are no cross-dependencies in subdirectories


    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's build setup for local, as well as for automated builds follows the https://reproducible-builds.org requirements by making us of corresponding compiler flags and does not include any data, like time stamps, which would lead to a different bit-by-bit result.


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

    There are two available options: * just download the binary, which is self contained and does not have any dependencies, or * use the available container image, available on DockerHub and also in GitHub packages. See also the options described in https://dadrus.github.io/heimdall/dev/docs/getting_started/installation/


    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]

    See the description for the "Installation System" above


    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]

    See https://dadrus.github.io/heimdall/dev/docs/getting_started/installation/, which describes everything related


  • Externally-maintained components


    Enough for a badge!

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

    This is part of the project dependency document: https://github.com/dadrus/heimdall/blob/main/go.mod There is also an SBOM available with each published artifact. See also https://dadrus.github.io/heimdall/dev/docs/operations/security/#_software_bill_of_material_sbom


    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]

    Part of the CI build and analysis pipelines, running with each build, respectively periodically


    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]

    This is part of the standard dependency management system and also automated as already mentioned in multiple places in this report


    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]

    All deprecated or obsolete functions are removed from code with each release.


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

    All available tests are executed for each PR targeting the main branch if there were code changes. This is also true for the main branch itself.


    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]

    These are part of the regular tests and are always executed


    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]

    Achieved by making use of CodeCov. Current coverage is 89%. See also https://codecov.io/gh/dadrus/heimdall


  • 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 addressed in the contributing guide, the PR template and the review process of each and every PR.


    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]

    The policy requires an adequate test coverage wich is not allowed to reduce the existing coverage by more than 0.5%


  • Banderas de advertencia


    Enough for a badge!

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

    This is achieved by making use of many different static analysis tools which are also enforced by the automated CI pipeline


  • Conocimiento de desarrollo seguro


    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]

    The project does not only follow the corresponding principles, it is there to solve related problems and allows teams / other projects implement such principles, as deny by default, least privilege principle, define required security mechanisms once and reuse them many times, and much more.


  • Use buenas prácticas criptográficas

    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 project does not only not use insecure algorithms, it does not even allow usage of such while configuring the resulting software.


    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]

    This is supported in all places dealing with cryptography algorithms or protocols.


    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 have any cryptographic key material compiled in. Everything related must be configured and can even be managed externally


    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]

    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


    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]

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


    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]

    If certificates are used, certificate verification is enforced and cannot be disabled


    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]

    This is given by the standard go implementation used by the project


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

    Cosign with keyless signing is used while releasing the artifacts. Verification procedure is described in https://dadrus.github.io/heimdall/dev/docs/operations/security/#_verifying_heimdall_binaries_and_container_images


    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]

    Every commit is required to be signed. Each and every release artifact is signed as well. See https://dadrus.github.io/heimdall/dev/docs/operations/security/#_verifying_heimdall_binaries_and_container_images for details


  • Otros problemas de seguridad


    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]

    By default, everything, which could cause harm is dropped and must be explicitly configured, respectively enabled by those people, who are responsible for heimdall's operation


    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]

    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.


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

    Not yet in place for the actual project, but for its usage: https://dadrus.github.io/heimdall/dev/docs/operations/security/


  • Análisis estático de código


    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]

    Multiple SAST tools are part of the CI build. Some of them are also running periodically and independent of the actual builds


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

    The application is written in a memory safe language (go)



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