logging-operator

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 7941 is gold Here is how to embed it:

These are the Gold level criteria. You can also view the Passing or Silver level criteria.

        

 Basics 5/5

  • Identification

    Logging operator for Kubernetes

  • Prerrequisitos


    El proyecto DEBE lograr una insignia de nivel plata. [achieve_silver]

  • Supervisión del proyecto


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

    Everyone from the maintainers are entirely familiar with the project: https://github.com/kube-logging/.github/blob/main/MAINTAINERS.md, among other contributors who are frequently contributing. Also there is a company (Axoflow) who provides commerical support for this project.



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

    We have more than two unassociated contrbutors: https://github.com/kube-logging/logging-operator/graphs/contributors


  • Other


    The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file]

    This is implemented and checked in CI runs, with the help of Licensei.


  • Repositorio público para el control de versiones de código fuente


    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]

    We use Github labels: "Good first issue" to signify that an issue is suitable for new or casual contributors.

    see also:



    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]

    We do require 2FA enabled for developers.



    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]

    The project enforces using a TOTP app.


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

    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]

    All maintainers are asked for reviews all the time, if a proposed modification is a major one, then 2-3 person must review it!


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

    Our operator implements a reproducible build process using Go modules with go.mod and go.sum files that lock all dependency versions. Our CI pipeline verifies reproducibility by comparing hashes of builds from different environments. All build configuration is committed to the repository.

    See: https://github.com/kube-logging/logging-operator/blob/master/.github/workflows/artifacts.yaml


  • Automated test suite


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

    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]

    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]

    Our total e2e test coverage is above: 75% with additional unit and shell-based tests. In total the project is most probably well above 90% coverage.



    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]

    Our total e2e test coverage is above: 75% with additional unit and shell-based tests. In total the project is most probably well above 80% coverage.


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

    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]

    All network communications in our operator use secure protocols. We utilize the Kubernetes API which requires TLS, and any external communications implement TLS 1.2+. No insecure protocols are enabled by default. (Only for development purposes!)



    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]

    Our operator exclusively uses TLS 1.2+ for all secure communications. We enforce this minimum version through our client configurations when making external API calls.


  • Entrega garantizada contra ataques de hombre en el medio (MITM)


    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 GitHub repository implement security headers including strict Content-Security-Policy, X-Content-Type-Options: nosniff, X-Frame-Options: DENY, Strict-Transport-Security with long max-age, and Referrer-Policy: strict-origin. URL: https://github.com/kube-logging/logging-operator


  • Otros problemas de seguridad


    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]

    Security is #1 priority for us, meaning that we regularly do security review on our project.



    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]

    There are several hardening mechanisms implemented, on various layers of the project:

    Input validation: All inputs are validated, especially those from external sources Least privilege: The operator runs with minimal required permissions and by default it uses the least required Kubernetes RBAC. Secure defaults: We provide sensible and secure default settings, especially in cases when the user would use a potentially risky feature. Resource constraints: Resource limits are set for all types of deployments.

    There is not a single URL we can paste here, since this is implemented in various layers of the project: https://github.com/kube-logging/logging-operator


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

    End-to-end tests are running against each PR that tests the software using various inputs dynamically.



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

    Our operator includes extensive runtime assertions through Go's built-in mechanisms. We use require and assert functions in tests, implement error checking in all critical code paths, and leverage Go's panic/recover for unexpected conditions.



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 Márk Sági-Kazár and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Márk Sági-Kazár.
Entry created on 2023-10-10 11:47:44 UTC, last updated on 2025-03-18 09:39:31 UTC. Last achieved passing badge on 2023-12-06 15:10:07 UTC.

Back