Cluster Management Toolkit for Kubernetes

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

    Toolkit for managing and monitoring Kubernetes clusters; includes a Curses-based console UI as well as a few command-line tools.

  • Prerequisites


    Not enough for a badge.

    The project MUST achieve a silver level badge. [achieve_silver]

  • Project oversight


    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

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

  • Other


    Enough for a badge!

    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]

    All source files have SPDX statements.


  • Public version-controlled source repository


    Enough for a badge!

    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.


    Unknown required information, not enough for a badge.

    The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Coding standards


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Working build system


    Enough for a badge!

    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]

    The project is implemented in Python.


  • Automated test suite


    Enough for a badge!

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

    The test suites can be run using make tests to test general code or make iotests to test I/O functions. https://github.com/intel/cluster-management-toolkit/blob/main/Makefile (make checks).


    Not enough for a badge.

    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 currently does not use CI. This will be implemented later.


    Not enough for a badge.

    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]

    There is now a test suite in place that currently tests about 44% statement coverage for *.py; more test cases are added pretty much on a daily basis.


    Not enough for a badge.

    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]

    There is now a test suite in place that currently tests about 34% branch coverage for *.py; more test cases are added pretty much on a daily basis.


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

    CMT uses ssh/Ansible (over ssh) for communication with hosts and HTTPS to communicate with the Kubernetes API server.


    Enough for a badge!

    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]

    Minimum required TLS version is v1.2.


  • Secured delivery against man-in-the-middle (MITM) attacks


    Enough for a badge!

    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]

    Found all required security hardening headers.

    https://github.com/intel/cluster-management-toolkit


  • Other security issues


    Enough for a badge!

    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]

    Reviewed in internal security review before publishing, 2023.


    Unknown required information, not enough for a badge.

    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]

  • Dynamic code analysis


    Not enough for a badge.

    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]

    No command line fuzzing is done at the moment.


    Barely enough for a badge.

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

    No dynamic analysis in use currently.



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

Project badge entry owned by: David Weinehall.
Entry created on 2024-01-03 11:35:49 UTC, last updated on 2024-03-25 03:21:50 UTC. Last achieved passing badge on 2024-03-25 03:06:38 UTC.

Back