Flux

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 4782 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 and extensible continuous delivery solution for Kubernetes. Powered by GitOps Toolkit.

  • 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://github.com/fluxcd/flux2/blob/main/CONTRIBUTING.md#acceptance-policy


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

    We require each contributor to sign-off their commits in agreement with the DCO: https://github.com/fluxcd/flux2/blob/main/CONTRIBUTING.md#certificate-of-origin. All repositories of the project have a required CI check in place to check for sign-offs.


    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]

    As a graduated CNCF project, defined project governance is mandatory. All processes and roles are defined in https://github.com/fluxcd/community/, specifically https://github.com/fluxcd/community/blob/main/GOVERNANCE.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]

    All project members and contributors must adhere to the CoC: https://github.com/fluxcd/community/blob/main/GOVERNANCE.md#code-of-conduct.


    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]

    All roles and processes are defined in https://github.com/fluxcd/community/blob/main/GOVERNANCE.md#roles-and-process-in-the-flux-community


    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]

    Flux is managed by a team of core maintainers (https://github.com/fluxcd/community/blob/main/CORE-MAINTAINERS) who have equal privileges. In addition, a team of org admins (https://github.com/fluxcd/community/blob/main/ORG-ADMINS) has additional privileges necessary to govern the organization as a whole (create/delete repositories etc.)


    Enough for a badge!

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

    https://github.com/fluxcd/community/blob/main/CORE-MAINTAINERS


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

    https://fluxcd.io/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]

    https://fluxcd.io/flux/ https://fluxcd.io/flux/concepts/


    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]

    https://fluxcd.io/flux/security/ https://github.com/fluxcd/flux2/security/policy


    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://fluxcd.io/flux/get-started/


    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]

    https://fluxcd.io/flux/ is always kept up to date to reflect the latest Flux version.


    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]

    https://github.com/fluxcd/flux2/blob/a3f2b1d829ede2fa49fdd121aedd4ab1ac75fcfa/README.md?plain=1#L4


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

    Flux consists of mostly Kubernetes controllers running in the background with no direct user interaction. The Flux 2 CLI is accessible as-is by being 100% keyboard-controlled.


    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 Flux documentation website at https://fluxcd.io/flux/ uses Hugo (https://gohugo.io/) which is internationalized using a simple directory structure per 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]

    No passwords are stored anywhere on the project sites.


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

    An archive of Flux releases is available at https://github.com/fluxcd/flux2/releases and each release is accompanied by clear upgrade instructions if applicable. Upgrades skipping versions are also supported most of the times (if not, this is also documented).


  • Bug-reporting process


    Enough for a badge!

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

    https://github.com/fluxcd/flux2/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]

    Policy: https://github.com/fluxcd/flux2/security/policy

    All advisories are publicly accessible at https://github.com/fluxcd/flux2/security/advisories with proper attribution (if the submitted allowed it).


    Enough for a badge!

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

    Policy: https://github.com/fluxcd/flux2/security/policy


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

    We have automation in place to automatically fmt (https://github.com/fluxcd/flux2/blob/a3f2b1d829ede2fa49fdd121aedd4ab1ac75fcfa/Makefile#L23) and vet (https://github.com/fluxcd/flux2/blob/a3f2b1d829ede2fa49fdd121aedd4ab1ac75fcfa/Makefile#L26) code.

    The acceptance policy at https://github.com/fluxcd/flux2/blob/main/CONTRIBUTING.md#acceptance-policy clearly defines coding styles.


    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 above; CI checks are in place in all repositories.


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

    We use Goreleaser (https://github.com/fluxcd/flux2/blob/main/.goreleaser.yml) to build the Flux 2 CLI and to release all controllers. Container images are built for different architectures.


    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]

    Binaries are distributed as-is, users don't need to build them on their own. Otherwise, all code is built using the standard Go compiler orchestrated through Make. Example: https://github.com/fluxcd/flux2/blob/main/Makefile


    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]

    All code is written in Go and uses Go's dependency mechanism which is deterministic.


    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]

    All Flux binaries are build using pinned dependencies, our build process does not involve scripting languages, all components are build GO with CGO disabled.


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

    installation is documented at https://fluxcd.io/flux/installation/ and consists of two steps: (1) install the Flux CLI and (2) install Flux on a cluster using flux install.


    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]

    The Flux CLI consists of a single binary which can be downloaded and placed anywhere. We provide common package managers such as brew, yay (for Arch), nix and chocolatey (for Windows) as well as a custom Shell script. All of them install the Flux CLI in standard paths.


    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]

    All repositories have instructions for contributing (https://github.com/fluxcd/flux2/blob/main/CONTRIBUTING.md) which are aligned across repositories, making it simple to get started. E.g. running tests is as simple as running make test. Prerequisites are always listed, e.g. at https://github.com/fluxcd/flux2/blob/main/CONTRIBUTING.md#how-to-run-the-test-suite.


  • Externally-maintained components


    Enough for a badge!

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

    All artifacts ship with a software bill of materials: https://fluxcd.io/flux/security/#software-bill-of-materials


    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]

    We have dependabot enabled across all repositories (e.g. https://github.com/fluxcd/source-controller/security/dependabot?q=is%3Aclosed) to notify the maintainers of vulnerabilities in any of the third-party dependencies.


    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]

    External dependencies are maintained in the go.mod file (e.g. https://github.com/fluxcd/source-controller/blob/main/go.mod) and updates are usually single-line changes of the affected library.


    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 external dependencies are regularly upgraded as can be seen in the go.mod files in any of the project's repositories, e.g. https://github.com/fluxcd/source-controller/blob/main/go.mod


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

    Required CI checks are enabled in all repositories, e.g. https://github.com/fluxcd/source-controller/actions/workflows/tests.yaml and run on each PR.


    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]

    Bugfixes are usually accompanied by regression tests. For some projects we automatically generate coverage reports, e.g. https://app.codecov.io/github/fluxcd/go-git-providers?branch=main. Others facilitate tracking coverage locally by enabling coverage reports, e.g. https://github.com/fluxcd/source-controller/blob/9c5c89c3e8d06ed19185735441820708d7c711f8/Makefile#L77


    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]

    We're tracking coverage in CI using GitHub Action and Go coverage tooling.


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

    Our acceptance policy at https://github.com/fluxcd/flux2/blob/main/CONTRIBUTING.md#acceptance-policy requires that tests be added for new and old code in any change to the codebase.


    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]

    Our acceptance policy at https://github.com/fluxcd/flux2/blob/main/CONTRIBUTING.md#acceptance-policy requires that tests be added for new and old code in any change to the codebase.


  • Warning flags


    Enough for a badge!

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

    The default logging level of all controllers is "info". All controllers have documentation in place that shows how to change the log level, e.g. https://fluxcd.io/flux/components/source/options/#flags.


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

    The projects has a clear policy on security that's spelled out at https://fluxcd.io/flux/security/. We also continually blog on how we incorporate security best practices into the project at https://fluxcd.io/tags/security/.


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

    We continually review and evaluate the cryptographic algorithms used within Flux and improve where necessary, e.g. https://github.com/fluxcd/flux2/blob/main/rfcs/0005-artifact-revision-and-digest/README.md. Most cryptographic functionality is user-driven, e.g. the algorithms used for SSH or HTTPS to communicate with remote Git repositories.


    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]

    Most of the cryptographic functionality is user-driven, e.g. the transport encryption used to communicate with remote Git repositories or container registries. Most functionality is offloaded to 3rd-party libraries such as https://pkg.go.dev/crypto/tls.


    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]

    Flux itself doesn't store any authentication credentials but rather consumes these from Kubernetes Secrets or environment variables passed to the Pods. This provides a very flexible system for users to provide these credentials in a secure manner. Flux itself never stores these in the filesystem of the containers (those are read-only by default) and removes them from memory as soon as they are no longer needed.


    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]

    Flux supports all secure protocols to communicate with remote Git repositories (HTTPS and SSH) and container registries.


    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 1.2 and 1.3 are both supported by way of Go's crypto/tls library.


    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]

    Flux verifies all certificates by default. Certificates signed by a custom CA are never ignored and the CA's certificates need to be provided to Flux in such cases.


    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]

    Using HTTPS this is always the case. Other TLS communication is not used.


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

    All container images are always signed (see https://fluxcd.io/flux/security/#signed-container-images). Private keys used to create signatures are only available to org admins (see above).


    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]

    All tags are always signed (e.g. https://github.com/fluxcd/flux2/releases/tag/v2.0.0-rc.5) with the committer's public key. The verification is performed and indicated by GitHub.


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

    Flux APIs are Kubernetes CRDs, all input fields are validated by Kubernetes builtin validation webhook and invalid inputs are rejected before reaching the Flux controllers. For example https://github.com/fluxcd/kustomize-controller/blob/main/config/crd/bases/kustomize.toolkit.fluxcd.io_kustomizations.yaml


    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]

    All Flux components are compiled with Go. To protect against defects we run all tests with race detection. Flux is part of Google's oss fuzz program which provides continuous fuzzing https://github.com/google/oss-fuzz/blob/master/projects/fluxcd/project.yaml


    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]

    We provide users with extensive security related documentation, SLSA Build L3, CVE disclosure, etc. See https://fluxcd.io/flux/security/


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

    https://github.com/fluxcd/flux2/blob/main/.github/workflows/scan.yaml


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

    Flux is using Google's OSS Fuzz project for fuzzing (see https://fluxcd.io/blog/2022/02/security-more-confidence-through-fuzzing/).



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

Project badge entry owned by: Daniel Holbach.
Entry created on 2021-04-07 10:33:49 UTC, last updated on 2024-05-09 09:42:44 UTC. Last achieved passing badge on 2021-04-07 11:07:59 UTC.

Back