DebOps

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 237 is in_progress Here is how to embed it:

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

        

 Basics 0/5 ●

  • Identification

    Your Debian-based data center in a box

    A collection of Ansible playbooks, scalable from one container to an entire data center.

  • Prerrequisitos


    Not enough for a badge.

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

  • Supervisión del proyecto


    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


    Unknown required information, not 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]

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


    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


    Not 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 DebOps project can be thought of as a build system which does not need to be build in order to use the project itself. Reproducible builds for configuration management frameworks (like this project) could be interpreted as being able to produce two identical VM or container images by stripping out all non-deterministic/changing peaces. This is currently out of scope for this project because of the huge work which would be required:

    The time (offset) of the build(s) is the biggest problem. It would be required to ensure that all external resources return exactly the same response regardless of the time of the request (be timeless). A related problem is that such a image also includes the file system which includes timestamps which would need to be faked.

    If someone wants to work on this, let us know. (Ref: https://github.com/debops/debops/issues/154#issuecomment-230996509)


  • 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 DebOps test suite can be invoked using the make test command with included Makefile. Specific parts of the test can also be executed by selecting them from a list of available tests, accessible by the make help command. The same tests are performed on each pull requests via Travis CI.


    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]

    Travis CI and GitLab CI are used to perform continuous integration services used to maintain DebOps. The project includes an extensive test suite, with Travis-CI builds as well as GitLab CI builds available for public review.


    Unknown required information, 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]

    Unknown required information, 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]

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

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

    This criteria is currently not met for all parts of the project but is a work in progress:

    The project allows to use unencrypted network communication protocols but the user has to decide to enable them:


    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]

    Applies for debops.nginx and other parts of the project dealing with TLS.


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


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

    debops.nginx has support for HTTP security headers (ref: #118) and enables such options by default. One or more of the required security hardening headers is missing. // One or more of the required security hardening headers is missing. // X-Content-Type-Options was not set to "nosniff". // One or more of the required security hardening headers is missing.


  • Otros problemas de seguridad


    Unknown required information, not 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]

    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]

    Work in progress. Examples:

    Already supported:

    [and more]


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

    The DebOps Developers are not aware of any dynamic analysis tool for Ansible configuration management code.


    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]

    Run-time assertions are a good thing but are currently not widely used in the project.



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

Project badge entry owned by: Robin Schneider.
Entry created on 2016-07-05 19:59:19 UTC, last updated on 2024-12-17 19:23:45 UTC.

Back