in-toto

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 1523 is gold Here is how to embed it:

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

        

 Basics 17/17 ●

  • Identification

    in-toto is a framework to protect supply chain integrity.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

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

    What is expected of contributions is covered in the README and GOVERNANCE documents.

    https://github.com/in-toto/in-toto/blob/develop/GOVERNANCE.md https://github.com/in-toto/in-toto#instructions-for-contributors


  • Project oversight


    Enough for a badge!

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    The main software implementation of the project requires contributors to accept a DCO as per the governance file and contributor instructions:

    https://github.com/in-toto/in-toto/blob/develop/GOVERNANCE.md https://github.com/in-toto/in-toto#instructions-for-contributors

    Compliance is verified using the Probot DCO GitHub app: https://probot.github.io/


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    https://github.com/in-toto/in-toto/blob/develop/GOVERNANCE.md


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    https://github.com/in-toto/in-toto/blob/develop/CODE-OF-CONDUCT.md


    Enough for a badge!

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    The key roles are defined in GOVERNANCE.md, including details about maintainer, consensus builder and contributor: https://github.com/in-toto/in-toto/blob/develop/GOVERNANCE.md Detailed information about current consensus builder and maintainers can be found in: https://github.com/in-toto/in-toto/blob/develop/MAINTAINERS.txt


    Enough for a badge!

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    Three people mentioned in the MAINTAINERS.txt file have full ownership access to the in-toto GitHub Organization: https://github.com/in-toto/in-toto/blob/develop/MAINTAINERS.txt https://github.com/orgs/in-toto/people


    Enough for a badge!

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

    Three people mentioned in the MAINTAINERS.txt file have full ownership access to the in-toto GitHub Organization: https://github.com/in-toto/in-toto/blob/develop/MAINTAINERS.txt https://github.com/orgs/in-toto/people


  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    The project provides detailed 1-year roadmaps for the organization and for the reference implementation: https://github.com/in-toto/docs/blob/master/ROADMAP.md https://github.com/in-toto/in-toto/blob/develop/ROADMAP.md


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    A high-level design of the software produced by the project is prescribed by its specification: https://github.com/in-toto/docs/blob/master/in-toto-spec.md


    Enough for a badge!

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    The security properties of the produced software are defined in the specification, most notably, in section 1.5 Goals https://github.com/in-toto/docs/blob/master/in-toto-spec.md#15-goals


    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    A quick start guide can be found in the README.md file in the "Getting Started" section: https://github.com/in-toto/in-toto/blob/develop/README.md#getting-started


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    The project makes an effort to keep documentation up to date and encourages contributors to verify that any pull requests also update documentation for things that are modified. https://github.com/in-toto/in-toto/blob/develop/.github/PULL_REQUEST_TEMPLATE.md


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    Updated achievements, including CI/CD build status (2x), code coverage and cii best practice badge can be found at the top of the README.md file https://github.com/in-toto/in-toto#in-toto----


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    The project website is based on the renown Slate Jekyll theme for GitHub Pages, has a custom mobile-friendly site navigation, and does not require JavaScript: https://in-toto.io https://github.com/pages-themes/slate

    The software produced by the project has a command-line interface, based on Python's argparse, and includes extensive input validation and help and usage messages. It is "fairly accessible as-is": https://github.com/in-toto/in-toto/blob/develop/README.md#in-toto-run https://github.com/in-toto/in-toto/blob/develop/README.md#in-toto-record https://github.com/in-toto/in-toto/blob/develop/README.md#verification


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    The in-toto framework is intended to be included into existing software tools to generate metadata for arbitrary activities of arbitrary software supply chains, whose final products may be verified by a client eventually. Both, generation and verification of metadata, may be performed transparently to the "functionaries" carrying out activities of the supply chain and the end-user verifying the final product. That is, neither generates text intended to be read by the end-user. As such the requirement is not applicable.

    https://github.com/in-toto/docs/blob/master/in-toto-spec.md#21-involved-parties-and-their-roles


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store 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). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    GitHub meets this criterion.


  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    The project uses semantic versioning and all releases are available on GitHub and PyPi, clearly identifying the most recent version. https://semver.org/ https://github.com/in-toto/in-toto/releases https://pypi.org/project/in-toto/#history


  • Bug-reporting process


    Enough for a badge!

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

    The project uses GitHub's issue tracker to track individual issues.

    https://github.com/in-toto/in-toto/issues


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    There have been no vulnerability reports submitted in the last 12 months.


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    Guidelines for submitting vulnerability reports can be found in the README.md file's Security Issues and Bugs section https://github.com/in-toto/in-toto/blob/develop/README.md#security-issues-and-bugs


  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]

    README.md has a section "Instructions for Contributors" that links to development guidelines and code style guidelines. The code guidelines are for the primary programming language Python and are based on PEP8. https://github.com/in-toto/in-toto/blob/develop/README.md#instructions-for-contributors https://github.com/secure-systems-lab/code-style-guidelines https://www.python.org/dev/peps/pep-0008/

    The used GitHub Pull Request template also encourages contributors to follow the coding style guidelines https://github.com/in-toto/in-toto/blob/develop/.github/PULL_REQUEST_TEMPLATE.md


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]

    Pylint is used to automatically check code style https://github.com/in-toto/in-toto/blob/develop/pylintrc https://github.com/in-toto/in-toto/blob/develop/tox.ini#L20


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]

    No native binaries are generated.


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]

    Debugging information is provided using Python's logging facilities, which is preserved.


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]

    The project does not recursively build subdirectories. All of its dependencies are external to its installation. https://github.com/in-toto/in-toto/blob/develop/setup.py


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    No true building occurs since the project uses Python. https://github.com/in-toto/in-toto/blob/develop/setup.py


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    The software may be installed an uninstalled using commonly used Python tooling (setuptools, pip): https://github.com/in-toto/in-toto/blob/develop/setup.py


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    By using Python installation tooling (setuptools, pip), standard installation locations, which are also customizable, are honored: https://github.com/in-toto/in-toto/blob/develop/setup.py


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]

    Installation for development follows the same procedure as installation as end-user. Python installation tooling (setuptool, pip) provides develop and editable modes for development installation.


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    External dependencies are listed in the setup.py file and in the requirements.txt file, a common practice for Python projects: https://github.com/in-toto/in-toto/blob/develop/setup.py https://github.com/in-toto/in-toto/blob/develop/requirements.txt


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]

    Pinned external dependencies are used for automated testing and monitored periodically using the Dependabot GitHub app. https://github.com/in-toto/in-toto/pull/294 https://github.com/in-toto/in-toto/issues/270


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    The project uses the standard components provided by the programming language to update external dependencies. https://github.com/in-toto/in-toto/blob/develop/requirements.txt


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    The project makes an honest attempt to make sure that it doesn't use deprecated or obsolete functions. Python versions that are marked as no longer maintained are also unsupported.


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]

    Automated tests are run on Travis CI and Appveyor: https://github.com/in-toto/in-toto/blob/develop/.travis.yml https://travis-ci.org/in-toto/in-toto https://github.com/in-toto/in-toto/blob/develop/appveyor.yml https://ci.appveyor.com/project/in-toto/in-toto/branch/develop


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    The project makes an honest effort to make sure that tests are added for all bugs that are fixed. It enforces at least 99% test coverage. https://github.com/in-toto/in-toto/blob/develop/tox.ini#L41


    Enough for a badge!

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]

    The used automated test suite currently provides 100% coverage. The coverage report is publicly accessible on coveralls.io. https://coveralls.io/github/in-toto/in-toto?branch=develop


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    The project provides a formal written policy on testing of new functionality. https://github.com/in-toto/in-toto/blob/develop/GOVERNANCE.md#contributions https://github.com/in-toto/in-toto/blob/develop/.github/PULL_REQUEST_TEMPLATE.md


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]

    The project's pull request template documents the policy of verifying that tests have been added to the change. https://github.com/in-toto/in-toto/blob/develop/.github/PULL_REQUEST_TEMPLATE.md


  • Warning flags


    Enough for a badge!

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    The project is strict with warnings and requires that pull requests emit no linter warnings, i.e. that CI builds pass. https://travis-ci.org/in-toto/in-toto


  • Secure development knowledge


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

    The primary developers, i.e. the maintainers, are well aware of secure software design and principles, as well as common kinds of errors that lead to vulnerabilities. They have received formal education in computer science (at least master's degree) and several years of experience working in a security-focused research lab. As per the project's governance process, all contributions must be reviewed by one or more maintainers in order to be integrated.

    An in-toto security self-assessment is available in the CNCF Special Interest Group for Security (cncf/sig-security) GitHub repository. The self-assessment includes a section about the secure development practices applied.

    https://ssl.engineering.nyu.edu/people#santiago_torres https://ssl.engineering.nyu.edu/people#lukas_p%C3%BChringer https://github.com/in-toto/in-toto/blob/develop/GOVERNANCE.md#contributions https://github.com/cncf/sig-security/blob/master/assessments/projects/in-toto/self-assessment.md#secure-development-practices


  • 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 default security mechanisms within the software produced by the project MUST 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]

    The project's default security mechanisms do not depend on weak algorithms or modes.

    https://github.com/secure-systems-lab/securesystemslib


    Enough for a badge!

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    Diversity of cryptographic algorithms is provided by using securesystemslib (RSA, ECDSA, Ed25519) and GnuPG (RSA and DSA)

    https://github.com/secure-systems-lab/securesystemslib https://github.com/in-toto/in-toto/tree/develop/in_toto/gpg


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    The project supports the storage of private cryptographic keys.


    Enough for a badge!

    The software produced by the project SHOULD 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 SHOULD 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 does not employ network protocols.


    Enough for a badge!

    The software produced by the project SHOULD, 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 software produced by the project does not use TLS.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    The software produced by the project does not use TLS.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    The software produced by the project does not use TLS.


  • Secure release


    Enough for a badge!

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    Releases are signed with maintainer keys and the signatures are available on the software repository release page. https://github.com/in-toto/in-toto/releases


    Enough for a badge!

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    Tags are signed with GitHub verified keys. https://github.com/in-toto/in-toto/releases


  • Other security issues


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    The software produced by the projects strives to validate all input to commands or functions, using different tools: - argparse type definitions for command line arguments https://docs.python.org/3/library/argparse.html#type - two validation libraries for custom metadata loaded from files https://github.com/in-toto/in-toto/blob/develop/in_toto/models/common.py#L27 https://github.com/in-toto/in-toto/blob/develop/in_toto/formats.py


    Enough for a badge!

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    The software produced by the project uses hardening mechanisms such as input validation (see above) and the Python-style EAFP error handling paradigm for library functions, translated to POSIX-style exit codes for command lines tools.

    https://docs.python.org/3/glossary.html#term-eafp


    Enough for a badge!

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

    An in-toto security self-assessment is available in the CNCF Special Interest Group for Security (cncf/sig-security) GitHub repository. The self-assessment includes threat modeling and trust boundary descriptions (see security analysis) and evidence that common security weaknesses have been countered (see known issues over time).

    https://github.com/cncf/sig-security/blob/master/assessments/projects/in-toto/self-assessment.md#security-analysis https://github.com/cncf/sig-security/blob/master/assessments/projects/in-toto/self-assessment.md#known-issues-over-time


  • Static code analysis


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]

    The project uses the security linter for Python source code Bandit, which is executed as part of Continuous Integration testing.

    https://github.com/PyCQA/bandit https://github.com/in-toto/in-toto/blob/v0.3.0/tox.ini#L22-L36 https://github.com/in-toto/in-toto/blob/v0.3.0/.travis.yml#L27


  • Dynamic code analysis


    Enough for a badge!

    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) MUST 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]

    The project does not produce software written in a memory-unsafe language.



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

Project badge entry owned by: Lukas Puehringer.
Entry created on 2018-01-03 16:15:50 UTC, last updated on 2022-11-02 15:08:49 UTC. Last achieved passing badge on 2018-01-05 21:31:54 UTC.

Back