MOAC

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 5227 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 0/5

  • Identification

    Analyze and generate passwords using physical limits of computation

  • Prerequisites


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

  • Project oversight


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

    The project is small and forkable. Distribution maintainers can handle the process of switching upstreams. Good documentation can also help others familiarize themselves with the codebase.



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

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

  • Public version-controlled source repository


    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]

    Uses Git



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

    Ticket tracker includes "good first issue" labels: https://todo.sr.ht/~seirdy/MOAC



    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]


    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


    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]

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

    Reproducible build info/instructions are in the README: https://git.sr.ht/~seirdy/moac/tree/master/README.md


  • Automated test suite


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

    The Makefile contains test jobs that wrap "go test": https://git.sr.ht/~seirdy/moac/tree/master/item/Makefile



    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]

    CI build manifests that run on every commit are included in https://git.sr.ht/~seirdy/moac/tree/master/item/.builds



    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]

    One of the build VMs measures statement coverage during tests; test coverage is currently over 90%.



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

    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]


    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]

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


    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]

    // X-Content-Type-Options was not set to "nosniff".


  • Other security issues


    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]


    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]
    • Project is written in a memory-safe language (Go)
    • Project uses memory and race sanitizers in tests
    • When linking against C libraries (using CGO), project uses strongly hardened CFLAGS by default.

    These mechanisms are found in the Makefile: https://git.sr.ht/~seirdy/moac/tree/master/item/Makefile


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

    Tests run with memory/address sanitizers on every commit in CI and as a pre-push hook. Tests without those sanitizers are a pre-commit hook.



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

    Can build with sanitizers and delegates assertions to unit tests.



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

Project badge entry owned by: Seirdy.
Entry created on 2021-09-19 05:42:24 UTC, last updated on 2021-10-13 00:18:56 UTC. Last achieved passing badge on 2021-09-19 06:14:48 UTC.

Back