NativeLink

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

    An extremely fast RBE-compatible cache and remote executor.

    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]

    The project's README at https://github.com/TraceMachina/nativelink/blob/main/README.md contains descriptions of Native Link's current functionality.



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

    The project's README at https://github.com/TraceMachina/nativelink/blob/main/README.md contains information on building Native Link. Additional deployment examples are at https://github.com/TraceMachina/nativelink/tree/main/deployment-examples.

    We use GitHub issues for feedback and bug reports.



    La información sobre cómo contribuir DEBE explicar el proceso de contribución (por ejemplo, ¿se utilizan "pull requests" en el proyecto?) (URL required) [contribution]

    Non-trivial contribution file in repository: https://github.com/TraceMachina/nativelink/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]

    Details on acceptable contributions are in the contribution guidelines at https://github.com/TraceMachina/nativelink/blob/main/CONTRIBUTING.md.


  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_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]

    Non-trivial license location file in repository: https://github.com/TraceMachina/nativelink/blob/main/LICENSE.


  • Documentation


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

    The documentation for all configuration options is in the https://github.com/TraceMachina/nativelink/tree/main/nativelink-config directory.



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

    The external interface is mostly governed by the remote execution protocol (see https://github.com/bazelbuild/remote-apis/blob/main/build/bazel/remote/execution/v2/remote_execution.proto and related APIs).

    Configuration options specific to turbo-cache are at https://github.com/TraceMachina/nativelink/tree/main/config.


  • Other


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

    Given only https: URLs.



    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]

    At the moment all documentation is written in english.



    The project MUST be maintained. [maintained]

    You can view the current commit history at https://github.com/TraceMachina/nativelink/commits/main.



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



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


    El proyecto DEBE tener un repositorio público para el control de versiones de código fuente que sea legible públicamente y tenga URL. [repo_public]

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



    El repositorio fuente del proyecto DEBE rastrear qué cambios se realizaron, quién realizó los cambios y cuándo se realizaron los cambios. [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]

    You can view the current project history at https://github.com/TraceMachina/native-link/commits/main.



    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.


  • Numeración única de versión


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

    NativeLink uses SemVer as version scheme. Releases are tagged on github at https://github.com/TraceMachina/nativelink/releases.



    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]

    Releases are tagged. The list of tags is at https://github.com/TraceMachina/nativelink/tags.


  • Notas de lanzamiento


    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]

    Release notes are published with releases at https://github.com/TraceMachina/nativelink/releases. Additional extensive changelogs are at https://github.com/TraceMachina/nativelink/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]

    This hasn't happened yet.


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

    Please use GitHub issues https://github.com/TraceMachina/nativelink/issues for bug reports.



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

    The issue tracker is GitHub issues https://github.com/TraceMachina/nativelink/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]

    Bug reports at https://github.com/TraceMachina/nativelink/issues are generally swiftly addressed.



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

    The project is still young. Enhancements at https://github.com/TraceMachina/nativelink/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement are being addressed at the moment. Note that we might dismiss feature requests if they're out of scope for the project. In such cases, we'll provide a rationale behind the rejection.



    El proyecto DEBE tener un archivo públicamente disponible para informes y respuestas para búsquedas posteriores. (URL required) [report_archive]
  • Proceso de informe de vulnerabilidad


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

    Please see https://github.com/TraceMachina/nativelink/blob/main/SECURITY.md for the vulnerability reporting process and contact information.

    Prefer GitHub's private vulnerability reporting at https://github.com/TraceMachina/nativelink/security. Otherwise, the security policy contains contact emails for reports.



    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]

    You can use GitHub's vulnerability reporting at https://github.com/TraceMachina/nativelink/security or contact the emails in the security policy directly.



    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]

    This is met.


  • Working build system


    Si el software generado por el proyecto requiere ser construido para su uso, el proyecto DEBE proporcionar un sistema de compilación que pueda satisfactoriamente reconstruir automáticamente el software a partir del código fuente. [build]

    The project supports Bazel, Cargo and Nix. See https://github.com/TraceMachina/nativelink/blob/main/README.md for build instructions.



    Se SUGIERE que se utilicen herramientas comunes para construir el software. [build_common_tools]

    Bazel, Cargo and Nix are standard tools to build Rust projects.



    El proyecto DEBERÍA ser construible usando solo herramientas FLOSS. [build_floss_tools]

    Bazel, Cargo and Nix are FLOSS software.


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

    Unit tests are contained in subdirectories. There is an additional integration test suite at https://github.com/TraceMachina/nativelink/tree/main/integration_tests.

    The project uses GitHub actions. You can review the current CI at https://github.com/TraceMachina/nativelink/tree/main/.github/workflows.



    Un conjunto de pruebas DEBERÍA ser invocable de forma estándar para ese lenguaje. [test_invocation]

    You can use Bazel or Cargo to run the testsuite. See https://github.com/TraceMachina/nativelink/tree/main/.github/workflows for invocation examples.



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

    This is not yet met. Branch-based coverage is under construction.



    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]

    The project uses GitHub actions. You can review the current CI at https://github.com/TraceMachina/nativelink/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]

    Contributions that contain new features are required to be tested. This is ensured during code review.



    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]

    You can view the past commit history for examples.



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

    The testing requirement is part of the contribution guidelines at https://github.com/TraceMachina/nativelink/blob/main/CONTRIBUTING.md and in the pull request template at https://github.com/TraceMachina/nativelink/blob/main/.github/pull_request_template.md.


  • Banderas de advertencia


    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]

    It is a requirements for the Rust code to not emit warnings during compilation.



    El proyecto DEBE abordar las advertencias. [warnings_fixed]

    The Rust codebase is required to not raise any compiler warnings. External dependencies may emit warnings that are addressed on a best-effort basis.



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

    Additionally to regular warnings from the Rust compiler we use clippy to increase strictness.


  • Conocimiento de desarrollo seguro


    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]

    A number of developers are working full-time on the codebase. The team has extensive knowledge about distributed architectures, cloud, CI and build system design.

    Turbo-cache's design aims to follow best practices and secure defaults wherever possible. However, mistakes can always happen. If something doesn't look right, please file an issue on GitHub.



    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]

    In addition to the team's experience, turbo-cache uses automated vulnerability scanning and enforcement of security best practices to minimize the risk of vulnerabilities occurring. However, if you spot any vulnerabilities or notice problematic design flaws, please reach out as described in the security policy.


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

    Some features establish network connections to external sources, such as cloud storage providers. In such cases, well-known crates are used to implement those connections.

    Turbo-cache uses SHA2 and BLAKE3 internally, as well as various hashing algorithms for in-memory hash maps. The implementations of those algorithms are not guaranteed to be secure since they're used to index build artifacts where performance is the primary concern. The occurrences of these algorithms are irrelevant to network-related functionality.



    Si el software producido por el proyecto es una aplicación o una librería, y su propósito principal no es implementar criptografía, entonces DEBE SOLAMENTE invocar un software específicamente diseñado para implementar funciones criptográficas; NO DEBERÍA volver a implementar el suyo. [crypto_call]

    Turbo-cache strongly prefers well-known dependencies. It does not implement it's own hashing algorithms.



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

    All dependencies are open source. The full SBOM is available at https://github.com/TraceMachina/nativelink/network/dependencies.



    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]

    Turbo-cache sources security mechanisms from well-known, maintained crates and keeps those up to date.



    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]

    Turbo-cache sources security mechanisms from well-known, maintained crates and keeps those up to date.



    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]

    On a "to the best of our knowledge" basis, Nativelink does not use outdated cryptographic 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]

    The SDKs of some external stores, such as cloud storage providers don't yet implement the functionality needed to support these use-cases. This is planned to change.



    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]

    The project does not produce passwords or authentication credentials.



    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]

    To the best of the author's knowledge, the dependencies that implement such functionality are widely used and considered secure.


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


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

    GitHub implements HTTPS and SSH access.



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

    This is handled by GitHub.


  • Vulnerabilidades públicamente conocidas corregidas


    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]

    At the moment there are no known vulnerabilities.



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

    There were no known critical vulnerabilities yet.


  • Otros problemas de seguridad


    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]

    This is met and additionally checked with the detect-private-key pre-commit hook. Keys tracked in the repository for testing are clearly labeled as such.


  • Análisis estático de código


    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]

    Clippy is used for static analysis: https://github.com/rust-lang/rust-clippy.



    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]

    This is part of clippy's warnings.



    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]

    There were no such vulnerabilities yet.



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

    Clippy is enforced in CI on every commit.


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

    The project does not yet use fuzzing. It is planned to add fuzzing in the future. At the moment there would be limited use for it as the project does not yet have branch based coverage.



    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]

    The project has a dedicated ASAN workflow that runs the sanitizeds testsuite on every commit.



    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]

    Fuzzing is not yet implemented. Tests are deliberately designed to run over the public API of the internal libraries. Clippy is quite strict and enabled during test builds, covering a lot of what assertions in other languages would cover.



    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]

    There were no known issues yet.



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

Project badge entry owned by: Aaron Mondal.
Entry created on 2023-11-08 17:18:50 UTC, last updated on 2024-08-01 16:18:08 UTC. Last achieved passing badge on 2023-12-20 06:07:56 UTC.

Back