gittuf

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 7789 is passing Here is how to embed it:

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

        

 Basics 13/13

  • Identification

    gittuf embeds key distribution, revocation, and other security controls such as access control policies in Git repositories. It provides an extensible security layer that can be leveraged to add other security features such as support for SLSA attestations and more!

    What programming language(s) are used to implement the project?
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    https://gittuf.dev provides a description of gittuf.



    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    This webpage details how to contribute: https://gittuf.dev/contribute.html

    The repository also has a contributing guide: https://github.com/gittuf/gittuf/blob/main/CONTRIBUTING.md



    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]

    Non-trivial contribution file in repository: https://github.com/gittuf/gittuf/blob/main/CONTRIBUTING.md.



    The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    https://github.com/gittuf/gittuf/blob/main/CONTRIBUTING.md details the contributor workflow and the automated checks and code review required to accept a changeset.


  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_license]

    gittuf uses the Apache-2.0 license: https://github.com/gittuf/gittuf/blob/main/LICENSE The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]
  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    gittuf's CLI includes help documentation. The design of gittuf is also documented here: https://github.com/gittuf/gittuf/blob/main/docs/design-document.md



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]

    gittuf is developed using the following document as a reference: https://github.com/gittuf/gittuf/blob/main/docs/design-document.md


  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]


    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    GitHub supports discussions on issues and pull requests.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    Currently, all documentation is written in English and the language is the default for contributions.



    The project MUST be maintained. [maintained]


(Advanced) What other users have additional rights to edit this badge entry? Currently: []



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    All development happens on the "main" branch, and releases are created from this branch using Git tags.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    The project's releases follow semantic versioning, combining the gittuf design document and the implementation.



    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    gittuf repository includes a changelog that tracks changes between releases. https://github.com/gittuf/gittuf/blob/main/CHANGELOG.md



    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]

    gittuf is in an early state and currently has not been audited. No known CVEs are present, but advisories will be issued on the repository when the time comes.


  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    gittuf uses an issue tracker: https://github.com/gittuf/gittuf/issues



    The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    gittuf uses an issue tracker: https://github.com/gittuf/gittuf/issues



    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    The project is actively maintained and maintainers respond / track issues in the tracker.



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    Feature requests in the specified time frame are tracked in the issue tracker and are under active development.



    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    All bug reports and feature requests are tracked publicly and can be searched: https://github.com/gittuf/gittuf/issues


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    The repository includes a security policy file: https://github.com/gittuf/gittuf/blob/main/SECURITY.md



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    https://github.com/gittuf/gittuf/blob/main/README.md details how to use GitHub's disclosure form and provides encrypted emails as an alternative.



    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]

    No vulnerability reports have been reported so far.


  • Working build system


    If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build]

    gittuf provides a Makefile that uses Go's toolchain to build and install the project.



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]

    Non-trivial build file in repository: https://github.com/gittuf/gittuf/blob/main/Makefile.



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    The project's build tool chain uses Make and Go.


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    The contributing guide discusses automated testing. gittuf also uses GitHub Actions CI to run automated tests for all new changes. Finally, the project Makefile also runs all unit tests prior to installation.



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    The test suite is invoked using standard go tooling: go test ./...

    https://github.com/gittuf/gittuf/blob/main/Makefile#L8



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    Unit tests currently cover most testable branches and inputs. The project has plans to increase test coverage using integration testing semantics to interface with third party services like Sigstore.



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

    GitHub Actions is used as a CI system for all new changes.

    https://github.com/gittuf/gittuf/tree/main/.github/workflows


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]

    All new features must be accompanied by tests.



    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]

    Recent major feature additions include corresponding tests. These chanegsets were not merged into the main branch until tests passed.



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    The contributing guide includes this requirement.


  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]

    gittuf uses golangci-lint.



    The project MUST address warnings. [warnings_fixed]

    Issues flagged by the linter block changesets from being merged. All changesets are merged once the linter execution detects no issues. The Go compiler is strict and typically does not issue warnings as a language policy.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    The Go compiler is strict and typically does not issue warnings as a language policy.


  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]

    The core developers have experience building software in security critical domains. Some developers are also security researchers. As gittuf is first and foremost a security tool, we take great care to ensure it is inherently designed to be secure.



    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

  • 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 use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]

    gittuf has not created new cryptographic primitives.



    If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. [crypto_call]

    gittuf uses standard libraries and other widely used dependencies for cryptographic functions like hashing and signing.



    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]


    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]

    gittuf does not create new keys, rather it uses keys created by other systems like GPG, Sigstore, etc.



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]

    Where gittuf can choose cryptographic algorithms, strong options are chosen.



    The default security mechanisms within the software produced by the project SHOULD NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]

    gittuf explicitly does not depend on SHA-1 for security. However, Git uses SHA-1 extensively and gittuf uses some Git semantics but hardens them using signatures created with stronger underlying hash algorithms.



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    gittuf does not implement key agreement protocols.



    If the software produced by the project causes the storing of passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]

    gittuf does not store passwords.



    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]

    gittuf does not generate cryptographic keys.


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


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    gittuf is distributed over HTTPS.



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

    gittuf releases are signed using Git tag signing. These are also distributed with the repository over HTTPS.


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    No known vulnerabilities exist.



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    gittuf is a security project and employs a policy of fixing security vulnerabilities as soon as possible when discovered.


  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    gittuf does not embed any credentials or access tokens.


  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    golangci-lint is used in addition to the Go compiler's results to gate gittuf releases.



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]

    golangci-lint is used to flag common issues in Go code.



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]

    gittuf's security policy is to fix vulnerabilities as soon as possible when they are discovered.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    All changesets undergo linting. In addition, we have automated dependency updates for the linter itself, ensuring that the linter runs from time to time and with the latest rules.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    No dynamic analysis tools are currently used.



    It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]

    gittuf is written in Go, a memory safe language.



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]

    No dynamic analysis tools are currently used.



    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]

    Currently, no dynamic analysis tools are currently used. When they are employed, the vulnerabilities they unearth will be handled like other reported vulnerabilities in a timely manner.



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 Aditya Sirish A Yelgundhalli and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Aditya Sirish A Yelgundhalli.
Entry created on 2023-08-31 14:38:20 UTC, last updated on 2024-10-29 14:27:18 UTC. Last achieved passing badge on 2023-08-31 15:26:34 UTC.

Back