TUF (The Update Framework)

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

    A framework for securing software update systems.

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

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

    The project has multiple unassociated significant contributors from NYU and VMware. https://github.com/theupdateframework/python-tuf/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]

    The project includes a license statement in all source files.


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

    The project uses git https://github.com/theupdateframework/python-tuf 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]

    The project uses the "good first issue" label for small tasks on the issue tracker. https://github.com/theupdateframework/tuf/labels/good%20first%20issue



    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 lead developer and maintainer of the project, https://github.com/awwad, signs all his commits and transmits them to GitHub, under an account requiring 2FA. @awwad is responsible for merging PRs.



    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]

    Enabled on GitHub


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

    We have code style guidelines: https://github.com/secure-systems-lab/code-style-guidelines and code review policies: https://github.com/secure-systems-lab/lab-guidelines/blob/master/code-review.md that are enforced in the organization.



    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]

    Code review by another party is mandatory for the project for all but the least of changes (e.g. typos in documentation).


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

    The project is implemented in a scripting language where the source code is used directly.


  • Automated test suite


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

    The project's tests are written using Python's standard unittest module. The test suite also uses Tox, a popular way of invoking a project's test suite. https://github.com/theupdateframework/python-tuf/blob/develop/tox.ini https://github.com/theupdateframework/python-tuf/blob/develop/tests/aggregate_tests.py



    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]

    The project uses a FLOSS automated test suite that enforces at least 97% statement 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]

    The project uses a FLOSS automated test suite that provides at least 80% branch 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]

    The project supports TLS for all of its network communications.



    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]

    The project supports at TLS version 1.2, as provided by standard Python.


  • 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 website is hosted on netlify and uses custom hardened headers. GitHub (source code repo) uses them by default.

    http://theupdateframework.io/ https://github.com/theupdateframework/python-tuf


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

    The project has had several security reviews, also within the last 5 years. https://theupdateframework.io/audits/



    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]

    The project tries to use hardening mechanisms whenever possible. Given that the software is a security product, developers and reviewers have a focus on secure programming. Reviewing guidelines are documented in: https://github.com/secure-systems-lab/lab-guidelines/blob/master/code-review.md


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

    The project's automated test suite ensures 97% code coverage: https://coveralls.io/r/theupdateframework/python-tuf?branch=develop



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

    The project's codebase does not include run-time assertions. However, the unit tests (which we consider separate from the codebase) do make use of assertions. The project's code style guidelines recommend limited use of assertions.



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

Project badge entry owned by: Justin Cappos.
Entry created on 2017-10-26 19:09:52 UTC, last updated on 2022-02-09 14:13:41 UTC. Last lost passing badge on 2017-11-17 17:46:04 UTC. Last achieved passing badge on 2017-11-20 19:26:07 UTC.

Back